Once you have successfully created your project, you can add or edit the contents to your project. The Document! X and HelpStudio Bundle provides you a wide range of authoring capabilities including creating topics, adding content to the existing topic, cross-referencing, navigation, and many other elements that help you in creating an effective help output. Through Document! X and HelpStudio Bundle, you can build and publish the output immediately just after importing or adding an existing project. The following sections explain different ways of content authoring.
Authoring Conceptual Topics
You can write a conceptual topic in addition to those generated by Document! X and HelpStudio Bundle automatically using the Topic Editor. The Topic Editor allows you to manually author free format content such as tutorials, getting started guides, and task-focused help.
Conceptual information is a key part of reference documentation, providing a high level introduction, tutorials, or other conceptual information. You can easily create conceptual topics in Document! X and HelpStudio Bundle.
- Click the New Topic button on the Project tab or use the Ctrl+T shortcut key.
- The new Topic is created in the currently-selected Topic Category on the Project Explorer (or under the (Un-categorized) node if no category is selected) and opened for edit.
- Enter your conceptual content directly in the editable area of the Topic Editor.
You can find more information on Topic Editing in the Topic Editor topic.
The Create a New Topic and Topic Category covers the basics of working with Topics and using the Topic Editor.
Authoring .NET XML Source Comments
Document! X and HelpStudio Bundle includes a Visual Comment Editor integrated with Visual Studio 2017, 2019, and 2022. The Visual Comment Editor makes it easy to author, review and edit content that you want to store as Xml format source comments in .NET source code.
Authoring Additional Reference Content
If you would like to supplement the content of the pages automatically generated by Document! X and HelpStudio Bundle outside of the source code, you can do so using the Document! X and HelpStudio Bundle Content File Editor. The Content File Editor allows you to review and author content for any item for which a reference documentation page is generated.
Creating Rules based Reference Content with AutoDoc
The AutoDoc overview topic contains more information about the AutoDoc feature.
Authoring Glossary Content
Document! X and HelpStudio Bundle includes a specific tool for authoring Glossary Content.
The terms you define in the Glossary window are output to a structured glossary topic in the generated output and the terms you define can be referenced in your content by surrounding them with $ $ symbols, for eample, $ $MyGlossaryTerm$ $. Glossary references in your content are replaced in the generated output by popup definitions for the referenced term. Example: Build Flag
You can learn more about authoring Glossary Content in the Glossary Editing topic.