Document! X & HelpStudio Bundle 2022.1
Project and Topic Fundamentals / Create a New Topic and Topic Category
In This Topic
    Create a New Topic and Topic Category
    In This Topic

    Create and Manage Topics and Topic Categories 

    Create a New Topic

    Select keyboard shortcut Ctrl+T to create a new topic.

      or

    Click the  New Topic button on the Project tab.

      or

    Click the  New Topic and Table of Contents Node button on the Table of Contents Layout editor toolbar to create a topic and a related table of contents node in one operation.

      or

    Select an existing topic on the Project Explorer and click  Clone on the context menu to create a new topic that is a copy of that existing topic.

      or

    Right-click on a specific topic category and click  New Topic from the context menu to add a topic to that category.

    New topics created using the HotKey or Ribbon button are added to the currently selected topic category. If no topic category is selected, the new topic is added to the (Un-categorized) category.

    Change Topic Properties (Name, Status, Title, Page Type etc.)

    1. Select the topic or topics in the project explorer.
    2. In the properties window, edit the required properties. The changes take effect immediately.

    Create a New Topic Category

    1. If you want to add a new topic category below an existing topic category, first select the topic category in the Project Explorer.
    2. Click the  New Topic Category button on the Project tab.
    3. The New Topic Category is created and selected on the project explorer. The new project explorer entry is now in edit mode, you can change the name of the new topic category.

    Rename a Topic Category

    1. Select the topic category on the project explorer.
    2. In the properties window, type the new Name for the topic category.

    Move a Topic or Topic Category

    1. Select the item or items you want to move.
    2. Drag and drop them to the new required location on the project explorer. A drop indicator highlight appears as you drag the items around the project explorer, indicating where the items are moved to if dropped.

         - or -

    1. Use the Move Up and Move Down buttons to re-order topics within a topic category, or topic categories within the parent topic category.

    Find a Topic or Topic Category

    1. Click the  Find button on the project explorer.
    2. Enter part of the name or title of the topic or topic category you are looking for and press enter or click the find button in the edit box.
    3. The first match is selected on the project explorer. Press enter or click the find button in the edit box again to find more matches.
    You can also perform more advanced searches, including searching in the Topic Content, using the Project Find and Replace tool (Tools tab).

    Topic Links, Images, See Also Links, and Keywords 

    Add a Hyperlink to Topic Content

    1. Move the edit cursor to the point in the Topic content where you want the hyperlink to appear.
    2. Select the existing text that you want to use as the link caption for the new hyperlink.
    3. On the Content Authoring tab, select the Hyperlink button  
        or  
      Use the Hyperlink HotKey (Ctrl+K).
    4. In the Link Designer dialog, select the target and enter the link caption for the new hyperlink.

    Insert an Image in Topic Content

    1. Position the edit cursor at the point in the Topic content where you want to insert image.
    2. On the Content Authoring tab, select the Image... button.
    3. In the Select Image dialog, select the image you want to insert.

    If the image you select is a thumbnail (e.g. the filename without the extension ends with _thumb), the image is inserted as a dynamic image widget so that users of your content can enlarge the image in place.

    You can easily create a thumbnail for an existing full size image by right clicking the image in the project explorer and selecting Create Thumbnail.

    Add a See Also link

    Select See Also Links on the topic editor View bar and click the  New toolbar button.

      or

    Click the New button next to the see also section at the end of the topic content in the topic editor.

    The link designer dialog displays allowing you to choose the target and caption for the new see also link.

    Add an Index Keyword

    Select Index Keywords on the topic editor view bar and click the  New toolbar button.

    You can easily create keywords directly from content in the topic editor by highlighting the necessary text and selecting Add as Keyword from the right-click context menu.

    Creating Hierarchical Keywords

    By default, keywords appear at the top level of the generated Index. You can create hierarchical keywords by using the | character. As an example, the following keyword:

    Customer|Editing|Editing Customer Details

    Appears in the generated Help System index as:

    Customer

    Editing

    Editing Customer Details

    You can include the same prefixes in multiple keywords. For example, the following two keywords, which could be defined in different Topics:

    Customer|Editing|Editing Customer Details

    Customer|Editing|Recording a Call

    Appears in the generated Help System as:

    Customer

    Editing

    Editing Customer Details

    Recording a Call

    Microsoft Help 2.x Links

    When creating Microsoft Help 2.x systems, you can create two additional types of Index keywords in addition to those in the visible Index.

    Associative Keywords allow you to assign keywords to Topics that you can use to create links from other Topics. As an example, you could assign an associative keyword to each Topic related to a specific concept in your Help System. You would then be able to create a Help 2 link using that keyword; at runtime the Help System would show a list of Topics matching the associative keyword when the link is clicked.

    You create associative keywords by prefixing the keyword with the @ character.

    Context (F1) Keywords are used by Visual Studio to find Topics for the Dynamic Help window matching the current Visual Studio context. If you are developing Add-Ins, Designers, or Components for the Visual Studio IDE, you can contribute help context keywords. By defining matching Context Keywords in your Help System, you can provide your users with F1 or Dynamic Help content based on context.

    You create context keywords by prefixing the keyword with the ! character.

    To Enable or Disable Automatically Generated Index Keywords for a Topic

    By default, Document! X and HelpStudio Bundle generates an index keyword for each Topic using the Topic Title.

    Disabling the Automatic Index Keyword for all Topics

    You can disable this behavior throughout the whole project on the Topic Settings page in the Build Profile Editor.

    Disabling the Automatic Index Keyword for a Specific Topic

    You can also disable the automatic keyword generation for individual Topics as follows:

    1. On the Project Explorer, select the Topic that you want to prevent an index keyword from being automatically generated for.
    2. In the Properties Window, clear the Auto Index check box.

    Enabling Additional Automatically Generated Categorized Keywords

    In addition to the automatic keyword generated from the Topic Title, Document! X and HelpStudio Bundle can also generate an additional hierarchical keyword based on the Topic Category. When this option is enabled (on the Topic Settings page in the Build Profile Editor), a top level keyword is generated for the Topic Category which contains a child keyword for each Topic in that Category.

    You can enable and disable the automatic additional keyword generation for individual Topic Categories as follows:

    1. On the Project Explorer, select the Topic Category that you want to prevent additional categorized index keywords from being automatically generated for.
    2. In the Properties Window, clear the Auto Index property.

    Custom Properties, Table of Contents, and Tasks 

    Create a Custom Topic Property

    1. Click the Project Settings button on the Project tab.
    2. Under the Custom Properties section on Project Settings page, select Topic Properties.
    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 is replaced with the current value defined against the Topic for that property.

    Add a Topic to the Table of Contents

    Click the Add Sibling Node or Add Child Node toolbar button on the Table of Contents Editor. When the Project Link Designer dialog appears, select the Topic you want the new Table of Contents node to link to;

      or

    Select the Topic or Topics that you want to add to the Table of Contents on the Project Explorer. Drag and drop the Topics on to the Table of Contents editor in the desired location.

    Mark a Topic as New in the Table of Contents

    Highlighting new Topics in the Table of Contents makes it easy for users of your Help System to identify new content when you issue a new version of your Help Systems. Document! X and HelpStudio Bundle provides a structured way to mark Topics as new in the Table of Contents.

    By establishing (in the Build Profile Editor) a date after which Topics are considered new, Document! X and HelpStudio Bundle can automatically identify new or changed Topics and mark them as new in the generated Table of Contents.

    To Mark Topics as New using the Topic Creation Date

    1. Open the Build Profile Editor.
    2. Select the New Content Highlighting page.
    3. Select the Automatically highlight new items check box.
    4. Select the Date after which items are considered new at which Document! X and HelpStudio Bundle should consider Topics as new.
    5. Select the Use the Topic Creation Date option to automatically identify Topics changed or created since the date value you specified.

    To Mark Topics as New using a Custom Topic Property

    Configure the Build Profile to use the Custom Topic Property

    1. Open the Build Profile Editor.
    2. Select the New Content Highlighting page.
    3. Select the Automatically highlight new items check box.
    4. Select the Date after which items are considered new at which Document! X and HelpStudio Bundle should consider Topics as new.
    5. Select the Use a custom Topic property option.
    6. Click the New Property button. On the displayed dialog set the Property Name to "Change Date" and a Property Type of "Date".
    7. The modification date to be used in determining new Topics can now be set using the Change Date property that appears in Topic Properties.

    Add a Task to a Topic

    Select Tasks on the Topic Editor View bar and click the  New button.

    The Task that is created is now associated with the current Topic and is listed on the Task list in the current Topic.

    You can view a project wide list of Tasks from the Tasks editor (Tools tab).