Creating branches

There are many ways to use branching for parallel versions, but here is a typical workflow:

  1. Start by creating a branch of the publication.

    This may be for starting work on a coming version of your product, for instance.


    A new branch is created, and will be given the number 1, designated by a branch icon branchicon.png and the number. For consecutive branching (set in the System Settings), the numbering will also show the origin branch number in parentheses:


    Main branches will be uncolored and unnumbered, and other branches will be colored green and have a number.


    You can give your branch a label. Click the options menu for the branch in the Content Manager, and select Edit label. This may be anything you need to identify the branch your own way. For example it could be your internal product version number, or "Experimental branch" or whatever you want.

  2. You can now start working on branch 1. For instance if it needs restructuring it in the Structure View by adding, removing or changing topics. 

  3. If you want to change a topic in the branch, you have two alternatives:

    • Change it as is, and have the change reflected in both branches.

    • Create a topic branch for a specific topic. You do this in the exactly same way as you did when creating a publication branch in step 1.


    While you can create a branch from the origin topic in the Content Manager, the recommended practice is to always create the branch topic from the topic reference (also called the "fork") in the publication:


    This has several technical benefits, but also the new branch will immediately replace the original topic in that publication.

    You will end up with two different projects, but they have a relationship to each other. This means that you can keep track of two separate but related versions, and you can choose to merge content if you want.


    If you have created a branch, but you don't really want to merge it into any other branch, but rather continue working on it completely separately from the other branch, you can select Convert to main branch. This will disconnect it from the original branching relation, and it will now live on its own.