Document! X & HelpStudio Bundle 2022.1
Configure Build Profile and Build Flags / Build Flags
In This Topic
    Build Flags
    In This Topic

    Build Flags, used in combination with Build Profiles, allow you to generate different versions of the same Help System from a single project. The easiest way to understand how Build Flags can be used is to view the movie below or the written worked example of how they might be used.

    Build Flag Fundamentals

    Show All
    Hide All

    Create a new Build Flag

    1. On the Project ribbon tab, select New Build Flag option.
    2. Enter name in the Name: field and select the color.

    Apply a Build Flag to Content

    1. In a content editor, select the content you want to mark with a Build Flag.
    2. Right-click on the selected content and choose the Build Flags you wish to apply from the picker that appears just above the displayed context menu.
    3. The selected content is highlighted with the selected Build Flag(s).

    Remove Build Flags Applied to Content

    1. In a content editor, select the content that you want to remove the applied Build Flags.
    2. Right-click on the selected content and select Clear Build Flags from the displayed context menu.
    3. The Build Flags are cleared from the selected content. 

    Apply a Build Flag to a Topic

    1. In the Project Explorer, select the Topic or Topics you want to mark with a Build Flag.
    2. In the Properties window, click the Build Flags you want to apply.
    3. The applied Build Flags are shown as small colored blocks next to the Topic entry on the Project Explorer to indicate which Build Flags are applied. 

    Apply a Build Flag to a Topic Keyword

    1. Open the Topic containing the keyword that you want to apply a Build Flag to.
    2. Click Index Keywords on the View Strip at the bottom of the Topic Editor to display the Index Keywords editor.
    3. Using the Build Flag Picker in the Index Keywords list, select the Build Flags you want to apply.
    If you mark a Topic with a Build Flag, the Index Keywords related to it are implicitly marked with the Topic Build Flags (as they are included / excluded with the parent Topic). So you don't need to mark individual Index Keywords with a flag that is already applied to the Topic.

    Apply a Build Flag to a Topic See Also Link

    1. Open the Topic containing that keyword that you would like to apply a Build Flag to.
    2. Click See Also Links on the View Strip at the bottom of the Topic Editor to display the See Also Links editor.
    3. Using the Build Flag Picker in the See Also Links list, select the Build Flags you want to apply.
    If you mark a Topic with a Build Flag, the See Also links related to it are implicitly marked with the Topic Build Flags (as they are included / excluded with the parent Topic). So you don't need to mark individual See Also links with a flag that is already applied to the Topic.

    Apply a Build Flag to a reference documentation item

    You can apply Build Flags to reference documentation items (e.g. a particular method in a .NET class). By flagging items and defining a Build Flag Rule on the Rules page in the Build Profile editor you can selectively exclude or include flagged items.

    1. Open the Content File for edit.
    2. Select the item you wish to mark with a Build Flag from the Content File Explorer.
    3. Select the Build Flags Content Item type on the right hand side of the Content File Editor.
    4. The Build Flag Picker will be displayed allowing you to select the Build Flags you wish to apply to this item.
    5. Build Flags applied to the item will be shown as small colored blocks adjacent to the item in the Content File Explorer tree so you can easily spot items with Build Flags applied. 

    Apply a Build Flag to a Table of Contents Node

    If you have flagged a Topic you do not need to also flag its related Table of Contents node - the Table of Contents node will be automatically excluded if the item it points to is excluded.
    1. In the Table of Contents Editor, select the Table of Contents Node(s) that you wish to mark with a Build Flag.
    2. In the Properties window, use the Build Flag Picker to select the Build Flags you want to apply.
    3. The applied Build Flags are shown as small colored blocks adjacent to the Table of Contents node on the Table of Contents Editor to indicate which Build Flags have been applied. 

    Apply a Build Flag to a Glossary Entry

    1. Open the Glossary Editor.
    2. Select the Glossary Item that you want to mark with a Build Flag.
    3. Using the Build Flag Picker on the right hand side of the Glossary Editor, select the Build Flags you want to apply.
    See Also
    Single Sourcing
    Build Profiles
    Rules Overview

     

     

    © 2023 Innovasys. All Rights Reserved.

    Send Feedback