Single Sourcing means using a single project to create multiple outputs.

In HelpStudio you can leverage Build Profiles, Build Flags, Rules and a range of filter options to create multiple outputs from a single project source.

Example Single Sourcing Scenario

• Stellar software is developing a Help System using HelpStudio for its product, Night Sky.
• Night Sky comes in three versions: Lite, Standard, and Professional.

Defining the Build Flags

1. In HelpStudio, three Build Flags are defined: 'Lite', 'Standard' and 'Professional'.

Applying the Build Flags

1. Any Topics that describe features specific to a particular version or versions are marked with the relevant Build Flag. e.g. The 'Features in the Lite Version' Topic is marked with the 'Lite' Build Flag. Topic Build Flags are set using the Properties window, or from the Project Explorer Context Menu.
2. Any Other Files (Stylesheets, Images, Scripts) that are specific to a particular version can also be marked with the relevant Build Flag.
3. Any Table of Contents nodes specific to a particular version are marked with the relevant Build Flag. e.g. 'Professional version support page' is marked with the 'Professional Only' Build Flag.
   
   Table of Contents nodes that point to a Topic already marked with a Build Flag don't need the flag applied again - it is inherited from the target Topic.
4. Any paragraphs, images or other content specific to a particular version (in Topics not specifically marked with a Build Flag) are marked with the relevant Build Flag. e.g., a paragraph 'Click the Detailed Map toolbar button' that describes a feature that is only available in the Professional Edition can be marked with the 'Professional Only' Build Flag.
   
   Build Flags can also be applied to See Also Links and Index Keywords.

Creating the Build Profiles

1. A Build Profile is created for each required version of the Help System.
2. In this case, a 'Lite', 'Standard' and 'Professional' Build Profiles are created.
3. In each Build Profile, a Build Flag Rule is added to the Rules page to specify which Build Flags to include in that output. This ensures that only content marked with no Build Flags or marked with one or more of the selected Build Flags will be included in the Help System generated by that Build Profile.
4. A different output filename is specified for each Build Profile.

Building the 'Night Sky' HelpStudio project will create three different Help Systems. Each Help System contains content that is common to all three versions plus content relevant to the specific version.

See Also

Top of page