Document! X and HelpStudio 2019
Editions and Versions / Editions And Versions Fundamentals
In This Topic
    Editions And Versions Fundamentals
    In This Topic

    Define Editions for multiple Browser Help Outputs (e.g. for Free, Standard and Professional variants of a software product)

    If you are using Single Sourcing features to generate multiple Browser Help outputs from your project, you should define an Edition for each Build Profile that generates Browser Help output to enable your users to switch between the different Browser Help outputs:

    1. Right click on the Editions and Versions node in the Project Explorer and select Edit from the Context Menu;
    2. The Editions and Versions Editor will open;
    3. Select the Editions page;
    4. Click the  toolbar button to add a new Edition;
    5. Define an appropriate Id and Caption for the Edition. Note that the Id value will be used in generated help urls;
    6. Select the Build Profile that generates the Browser Help output for this Edition.

    When Building and Publishing, the Browser Help output for each Edition will be published to a url specific to the Edition. When your Browser Help outputs are built and published, end users of the Browser Help will be able to use the "Edition" selector to switch between the documentation for the different Editions.

    If you are not already using Publishing features to publish your generated outputs, it is highly recommended that you do so when using the Editions and Versions functionality. Using the built in Publishing features will ensure that your Browser Help output is published to the correct path necessary for the Editions and Functionality to work correctly.

    Define an initial Version if you want end users in future to be able to switch between documentation versions (e.g for a 1.0 version of a software product)

    If you would like to publish multiple chronological versions of your documentation (e.g. to support multiple different versions of an application), you should define a new Version entry each time you publish a new version of the related application:

    For the initial published version of the documentation:

    1. Right click on the Editions and Versions node in the Project Explorer and select Edit from the Context Menu;
    2. The Editions and Versions Editor will open;
    3. Select the Versions page;
    4. Click the  toolbar button to add the first Version;
    5. Type an Id and Caption for the new Version (e.g. 1.0);
    6. Tick the This is the current Version option.

    When building and Publishing, the Browser Help output for each Edition will be published to a url specific to Version 1.0. At this point, with just a single published version of the documentation, users will not see a "Version" selector in the documentation. But you still need to define the initial Version entry so that the Versions functionality is enabled in the generated output for the future (see below).

           


    Define a new Version (e.g. for a 2.0 version of a software product)

    1. Right click on the Editions and Versions node in the Project Explorer and select Edit from the Context Menu;
    2. The Editions and Versions Editor will open;
    3. Select the Versions page;
    4. Click the  toolbar button to add the new Version.
    5. Type an Id and Caption for the new Version (e.g. 2.0);
    6. Tick the This is the current Version option;
    7. Select the previous Version from the list (e.g. 1.0) and tick the This Version is locked for publishing option; this will prevent you from inadvertently republishing the 1.0 copy of the documentation in future.

    When building and Publishing, the Browser Help output for each Edition will be published to a url specific to Version 2.0.

    Users of the 2.0 documentation will now see a "Version" selector allowing them to switch between the 1.0 and 2.0 Version documentation.

    Users of the 1.0 documentation will now also see a "Version" selector. This happens automatically thanks to the updated Editions and Versions configuration file shared by both 1.0 and 2.0, and does not require that the 1.0 documentation is modified or republished.