Publisher app allows for you to create content and maintain and collaborate on it in one place, such as a workspace, while a public copy of selected content can be updated automatically or at will on your public website.

Managing site content

Managing site contents happens mainly on the Collections screen.

In order to use the features described in this chapter, you need to have at least ‘Manage’ permissions for Publisher. The persmission settings of the Publisher are set by the system administrator in the Administrator app. Contact your system administrator if you think you may have the wrong permissions level.

Accepting content updates

Unless the box ‘Automatically accept updates’ is ticked in the collections’ settings (See the chapter ‘Starting a new site’), you will be notified when any content updates are available. Updates are made visible on the collections screen with an orange label that says how many updates are waiting for acceptance.

When you click on the updates label, you will get a list of all content objects within the collection that have updates. When you click on any of the listed documents, it will open in a new tab so that you can review the content before accepting, should you wish to do so. You can accept the changes by clicking on ‘Approve all’. After this, the updates are ready for publication. It is not possible to accept content updates of individual documents.

Publishing content updates

Content that is accepted, but not yet published, is made visible on the collections screen with a magenta label that says how many content updates are ready for publication.

When you click on the Ready for publication label, you will get a list of all content objects within the collection that are ready for publication.

It is possible to preview accepted content updates before publication in a staged version of the public website by clicking on the eye icon on the toolbar.

If all the content updates look satisfactory, then you may publish them by clicking on the button ‘Publish’. After several minutes, the changes will become visible on the public website.

In the site settings, there is an option for automatically publishing all content updates. For more information, see the chapter ‘Starting a new site’.

Starting a new site

Publisher achieves the synchronisation of public and non-public content with a concept called ‘collections’. A collection is a group of almost any kind of content that lives inside your Quaive installation.

Creating the site

A new site is created by clicking on the large tile with the plus icon on it.

You are asked to give the site a name and enter the URL of the site. The URL must start with http:// or https://.

While creating a site, or editing its settings, there is the option ‘Automatically publish changes’. When this option is ticked, all — whether or not automatically — accepted content updates will be published to the public website.

Collections

A collection is created in Publisher by clicking on the icon and then ‘Create collection’.

A dialogue panel will appear that will ask you to give the collection a name and optionally a summary and to select a group of content object which you would like to publish to a public website. Groups of content that you can select include:

• A workspace from Workspaces app
• A workspace module from a workspace in Workspaces app
• A folder from the documents module of a workspace in Workspaces app
• A contacts group from Contacts app
• A library section from Library app
• The jobs from Jobs app
• A calendar from Calendar app
• A set of images from Image bank app
• The news magazine from News app
• A news section of the news magazine from News app
• The whiteboards from Whiteboard app

You may create as many collections as you like. The developer of your public website can write filters and rules for which content of a collection is shown where and how on the website. So don’t worry that a collection might contain more unformation than what you want to disclose on the public website.

It’s recommended to align the granularity of the collections with your site developer. For instance, whether there will be a collection for the entire Library app contents, or rather individual collections for specific sections.

While creating or editing a collection there is the option ‘Automatically accept updates’. When this option is ticked, all content updates within this collection will automatically be ready for publication.

Value lists

Value lists are documents written in YAML language that can be useful for an infinite number of things. Some examples:

• A configuration for the order of swimlanes on the homepage if you want to change them regularly.
• A list of quotes that the site should cycle through upon each site generation.
• Publication of highly structured data.
• Maintaning a list of sponsors and links to their websites.
• Etc…

Basic knowledge about the YAML format is required to edit value lists. Errors in the YAML file file may lead to site generation getting stuck.

Developing a site

Sites that work together with Publisher are created in Jekyll. Some basic knowledge about Jekyll is required to set up a Publisher website. For more information about Jekyll, please visit the Jekyll website.

Git repository

Every site that is created within Publisher comes with a GIT repository. The GIT repository contains (staged version of) the entire website, including the frontend code and the published content.

You may find the repository URL in Publisher on the site settings panel, which is accessible via the More menu.

For your convenience, the folder is prepopulated with a set of files and folders that allows you to easily kickstart the project. All folders and folder names can be changed freely with exception of the folders ‘/content/’ and ‘_data/value-lists/’, which are managed by Publisher.

Content synchronisation is one directional: Publisher ➔ Public website. Any content changes made directly to content in the git reposistory will be overwritten by Publisher at some point.

Collections

Publisher will create a folder for each collection inside a folder called ‘content’ inside your Jekyll site. If a folder called ‘content’ doesn’t yet exist, then Publisher will create it.

Every collection folder reflects the name that was given to the collection in Publisher. Every collection folder has a file inside called ‘index.md’.

The front matter (metadata) of the index file contains information about the type of collection, the origin of the collection in Quaive, the title of the collection and optionally a summary.

Value lists

Publisher will create a YAML file for each created value list inside a folder called ‘value-lists’ inside the _data folder of your Jekyll site. If a folder called ‘value-lists’ doesn’t yet exist, then Publisher will create it.

Folders

Like with collections, also every folder that lives within a collection will create a folder with an index file inside your jekyll site.

The front matter of the index file contains information about the origin of the folder in Quaive, the title of the folder and optionally a summary. The parameter ‘layout’ of a folder index file is always set to ‘folder’.

Content objects

Similar to collections and folders, also content objects become folders with an index file in them. The folder contains an index files and when applicable the assets that come with the content object, such as images or videos.

The front matter of the index file contains information about the type of content object, origin of the content object in Quaive, the title of the content object and optionally a summary. The parameter ‘layout’ of a content object is always set to the document type of the content object. Always starting with document-type-. For instance a video object will have document-type-video and a contact card will have document-type-contact.

Access levels

Berechtigungsstufen