Skip to main content
MindTouch Success Center

Add articles to a Guide (MT4)

This page applies to:MindTouch 4


This article reviews how to add different article types to a User Guide and how to add content.
 

User Guide Article Types

 User Guides are comprised of Topics, How-To articles, and Reference articles:

  • Topic: reviews features of a product or persona.
    • appears in "Guide Contents" User Guide tab.
  • How-To: reviews how to use a feature.
    • appears in "How-To" User Guide tab.
  • Reference: supplemental content such as a glossary or appendix.
    • appears in "Reference" User Guide tab.

NOTE: Articles will be organized in the guide by these article types. Changing the page URL will not move articles up or down in the guide. 

Guide Navigation

Any article that contains an Article Type set to Topic, How-To, or Reference will display previous / next navigation links allowing users to be guided through a User Guide:

While Semi-Private pages are hidden from the navigation bar in MindTouch, Semi-Private pages will be discoverable when using the previous/next options in User Guides. This allows users to break up longer articles into shorter articles while hiding the smaller articles from the navigation bar. More details about the Semi-Private restriction can be found within the page restrictions article.

Adding Articles to a Guide

Adding a Topic

To add a new Topic to a Guide click "Add Topic":

A new page will open in our editor which has been pre-populated with our Topic template. Choose a Page Title and then add details to the Overview, and Feature section:

After clicking Save in the editor, you'll see your new Topic. Note that the Article Type is preselected as "Topic" since the default Topic template was utilized here:

Alternative Method

You can also create a new Topic page by choosing the "Topic Page" template from our New Page gallery:

Adding a How-To Article

To create a How-To article, click on "New Page":

Then choose the "How-To" template option:

A new page will open in our editor which has been prepopulated with our How-To template. Choose a Page Title and then add details to the Overview, Goal, and What's Next sections:

After clicking Save in the editor, you'll see your new How-To article. Note that the Article Type is preselected as "How-To" since the default How-To template was utilized here:

Adding a Reference Article

To create a Reference article, click on "New Page":

new page.png

Then choose the "Reference" template option:

 

A new page will open in our editor which has been prepopulated with our Reference template. Choose a Page Title and then add details to the Overview and Details sections:

Our Reference template includes several areas to add Details, Definitions, code snippets, and examples for your needs.

After clicking Save in the editor, you'll see your new Reference article. Note that the Article Type is preselected as "Reference" since the default How-To template was utilized here:

What's next

Continue reading for more details on how to edit a page.

  • Was this article helpful?