Skip to main content
Faster Hot Water

Learn about guide tabs

Once your content is created, it's important to ensure you're displaying your product help in a user-friendly way. Guide tabs provide a flexible way to display content in the current guide in various ways.

 

Tabs and their functions


In the previous article, we reviewed how to add tabs to your guides, but now let's understand what each tab does. Remember that have to add at least one tab.

Name of tab What does it do? Caveats
Featured articles

Displays an automatic sorting of pages based on:

  • Most Popular (Views)
  • Highest Rated
  • Recently Updated
  • Recently Added
Does not give an immediate overview of all pages
Classification Displays articles that contain a specific classification.

Only content that is classified is displayed. (When using default MindTouch templates, content is automatically classified.) 


Using a blank page (not recommended) or custom template? You can later reclassify content in the page classification manager.

Article directory Displays a list of all articles in alphabetical order. Only displays articles that are classified.
Tag directory Displays a list of articles grouped by tags. Displays same article several times, once for each tag.
Topic hierarchy

Displays content classified as a "Topic" plus any "Topic", "How-To," or "Reference" child pages.

 

Display all child pages at the same sub-level regardless of whether the child page is a 2nd, 3rd, or 4th-level child page.

 

Reorder guide tabs


Once you've added your tabs, reorder them to fit your customer's needs. Simply drag a tab to move it around:



 

Change tab names


The default names of tabs inform pro members of the tab's technical purpose. Before taking your guide live, rename the tabs to appeal to your users. This is your product documentation so get creative, but here are some examples to run with when renaming your tabs:

  • Topic hierarchy  ⇒  Contents
  • Classification  ⇒  [Name of Classification] articles
  • Tag directory  ⇒  Browse by subject


Follow these steps to rename your guide tabs:

  1.  Click the pencil icon in the tab.


 

  1. Type to rename and click the checkmark icon to save.


Recommendations


For a guide focused on getting started with your product, use the following tabs:

  • Topic hierarchy
  • Classification (focused on specific article types)
  • Tag directory


For a guide focused on troubleshooting and FAQ content (typically referred to as a knowledge base), use the following tabs:

  • Tag directory
  • Featured articles
  • Article directory

    Go here next!
     

  • Was this article helpful?