writerside.cfg

<api-specifications>

Specify the designated directory for API specifications.

Parent elements

<ihp>

Attributes:

dir

Specify the name of the directory where API specification files are stored. By default, it is specifications/.

<build-config>

Specify the name of the directory for build configuration files, such as buildprofiles.xml and build-script.xml. By default, it is set to cfg/.

Parent elements

<ihp>

Attributes:

dir

Specify the build configuration directory in the module root, that is, on the same level as writerside.cfg. For example: <build-config dir="custom-cfg-dir"/>.

<caps>

Specify in which capitalization style to display titles.

In this case, titles in the table of contents will be rendered in title case.

Parent elements

<settings>

Attributes:

for

Specify the elements for which you want to apply the capitalization style, such as toc-element, topic, or chapter.

style

Choose between sentence, title, and aswritten.

<categories>

Specify the name of the file where you put the list of categories for grouping related links in the seealso section. By default, it is c.list.

Parent elements

<ihp>

Attributes:

src

Specify the name of the file.

<default-property>

Specify the default properties for the particular markup elements. This setting is applied to all topics unless you explicitly override it by defining it on the topic level.

Parent elements

<settings>

Attributes:

element-name

Specify which elements the attribute will be applied to.

property-name

Specify the attribute name to which this default value will be applied.

value

Specify the default attribute value.

<disable-web-name-preprocessing>

Specify whether web file names should be normalized. By default, Writerside replaces all special characters with hyphens and lowercases all other characters in the topic file name to produce a normalized web file name. For example, My___Awesome.topic becomes my-awesome.html.

If you want to keep the web file names similar to topic file names (only replace characters that are not allowed in URLs), set <disable-web-name-preprocessing>true</disable-web-name-preprocessing>.

Parent elements

<settings>

<ihp>

This is the root element.

Child elements

<api-specifications> <build-config> <categories> <images> <instance> <instance-groups> <module> <settings> <snippets> <topics> <vars>

Attributes:

version

Set the global version for all help instances in this help module.

<images>

Specify the image directory settings.

Parent elements

<ihp>

Attributes:

dir

Specify the name of the directory where media files (images, GIFs, and videos) are stored. By default, it is images/.

version

Specify the image set version.

web-path

Specify the path where images should be located once the help instance is built.

<instance>

Specify the settings for a help instance.

Parent elements

<ihp>

Attributes:

keymaps-mode

Specify the mode for the keymap file:

• none if there is no keymap file

• generated if the keymap file is automatically generated

• provided if the keymap file is configured manually

src

Specify the .tree file name of the help instance.

version

Specify the help instance version displayed in the website header.

web-path

Specify the path that will be the last part of the URL for a particular help instance after it is built.

<instance-groups>

Specify the name of a file where instance groups are declared, e.g., instance-groups.xml.

Parent elements

<ihp>

Attributes:

src

Specify the name of a file in the module root, that is, on the same level as writerside.cfg.

<module>

Specify settings for the help module.

Parent elements

<ihp>

Attributes:

name

Specify the name of the help module.

<settings>

Specify additional help module settings.

Parent elements

<ihp>

Child elements

<caps> <default-property> <disable-web-name-preprocessing> <smart-ignore-vars> <webstats-cache> <wrs-supernova>

<smart-ignore-vars>

Do not interpolate variables in code blocks and URLs.

By default, Writerside resolves %var% variables in code blocks, links to URLs, and external image references, unless the user sets ignore-vars="true".

Set <smart-ignore-vars>true</smart-ignore-vars> to change the default behavior and insert variables literally without interpolating them. In this case, you can set ignore-vars="false" on code blocks, external links, and image references where you want to resolve the variables.

Parent elements

<settings>

<snippets>

Specify the name of the directory where you put code snippets.

Parent elements

<ihp>

Attributes:

src

Specify a directory in the help module root.

<topics>

Specify the name of the directory where topic files are located. By default, it is topics/.

Parent elements

<ihp>

Attributes:

dir

Specify a directory in the help module root.

<vars>

Specify the name of the file where you put variables and their values. By default, it is v.list.

Parent elements

<ihp>

Attributes:

src

Specify the file in the help module root.

<webstats-cache>

Specify the webstats cache configuration. This allows you to show the view statistic for each topic.

The enabled attribute enables or disables the feature. The location attribute specifies the location of the webstats data. This can be a path to a file or a versioned resource.

Parent elements

<settings>

Attributes:

enabled

Enable or disable the webstats cache.

location

Specify the location of the webstats data.

<wrs-supernova>

Specify the version of the Docker help builder in the 'use-version' attribute. Your CI/CD scripts can use this value to determine which builder version should be used. For example:

Parent elements

<settings>

Attributes:

use-version

Specify the version of the help builder.