Multiple versions
If you need to maintain documentation for different product versions, you can publish them next to each other and add a version switcher to the header.
When creating a new instance, you can optionally set a version for it. This adds the version attribute to the <instance> element in writerside.cfg, for example:
In this case, the version will be displayed in the header of your help instance next to the instance name. If you do not want to render any version in the header, you do not have to set the version when creating the instance, or you can remove the version
attribute from the existing instance declaration.
Add multiple versions
You can build and publish the documentation for multiple versions of a product next to each other and add a version switcher to the header. For example, you can build from separate instances or from different branches of the same instance and publish each help website output under the following URLs:
https://my.company.com/help/1.0/
https://my.company.com/help/2.0/
Both published instances need to know the location of a special JSON file that defines the versions and their relative URLs. You specify it using the <versions-switcher>
variable in buildprofiles.xml, for example:
You will need to maintain this JSON file accessible by both of your published help instances at the specified location. This file defines a list of versions with URLs relative to the website root:
If you enable the version switcher as described here, it will render instead of the version number in the header. This means it will not matter what is the value of the version attribute of the <instance> element in writerside.cfg.