Configurations Guide
Last updated
Last updated
The Writer and plugins config file is a .json file, so when reading the file an add-on for json-formatting is a good help.
A object in json consists of {"key":"value"} pair. The objects in the config file are separated by curly brackets, the {-sign.
The object can consist of the {"key":"value"} pair in different levels and also of a list of objects. The list are written with the straight brackets[xx]
``
“newsitemTemplateId”
From the top of the writer-config.json file you find “newsitemTemplateId”, which stores the article template that is stored in Open Content. There is only one template. The template is presented with a UUID, and can be viewed in Open Content, if you search via the UUID.
Example:
The "language" and "labellanguage" sets the Writer language for the plugins, not the language to be used when you write the content.
"conceptServiceConfig" is the service for the Concept plugin that sets the configuration for Open Content. The searches in Open Content are run through the BA-proxy and the "PropertyMap"-key sets the Writer property to map Open Contents properties.
The "tabOrder" is defining the order in sidebar's tab to the right.
The plugin section contain a list of all the plugins that are included in the Writer setup. To be able to find if a certain plugin/function is included in the configuration, a search in the browser is recommended.
The Link plugin as an example of a simple plugin configuration:
Explanation of the keys in the example plugin above.
Id: only uniqe names (if there is duplicates, only the first one will be read, see example below)
Name: name of the plugin
Url: check the plugin version (there can be different versions dev (higher), stage, prod)
Style: the ux for the plugin (please, observe it also follows the version)
Enabled: enable the plugin or not (true or false)
Mandatory: if true, it is a mandatory plugin
The plugins are listed after each other, in an unspecified order. It is important to notice that the config is read from top to bottom. As they are read from top to bottom the plugin that is read first will be the one that execute a task. If two plugins can do the same operation, the first will do the task. An example is configuration of the Iframely plugin and the social embed plugin, where Iframely then will manage the instagram etc, video etc, instead of the social media embed plugin if that is placed below.
This is a general configuration guide and each configuration must be tested in a test environment before it is implemented in any production environment.
When you want learn more about config, the user guide is a start. The functions are described for a normal set up of Writer. In most cases the configuration documentation is found in the documentation of each plugin and the Writer User Guide provides you with links to each plugin documentation.
The Writer version has dependencies to the plugin versions (or vice versa). This dependency is stated in the so called manifest-part of the plugin documentation of each plugin. This must be checked carefully.
