Document! X and HelpStudio 2019
Authoring Content / Topic Fundamentals / Custom Topic Properties
In This Topic
    Custom Topic Properties
    In This Topic

    Custom Topic Properties are topic specific items of information that you would like to manage as part of the Topic Properties. An example of a Custom Topic Property might be "Author" or "Review Date". Custom Topic Properties that you define can be viewed and edited alongside standard Topic Properties in the Properties Window when one or more Topics are selected on the Project Explorer.

    Custom Topic Properties can be referenced from anywhere in Topic content using a %% prefix and suffix. e.g. If you defined a custom project property called Author, in which you defined the current Topics author, you could include the property in Topic content as follows:

    This Topic was authored by %%Author%%.

    At runtime, this would be filled out with the value you provide for the Author property in the Properties Window.

    This Topic was authored by John Smith.

    To define a new Topic Property

    1. Click the Project Settings button on the Project Ribbon Tab;
    2. Click Topic Properties on the Page Menu;
    3. Click the New toolbar button to define a new Topic Property, including the default value.

    Once the new Topic Property is defined, select one or more Topics in the Project Explorer and then define the value of your custom Topic Property in the Properties Window.

    You can use the Topic Property anywhere in the Topic Content by surrounding the Property Name with %% characters - e.g. %%MyCustomProperty%%. When the Topic is output, the %%MyCustomProperty%% placeholder will be replaced with the current value defined against the Topic for that property.