Skip to main content

Leverage IDF templates to create structure and relationships (TCS)

 

This will review how IDF templates are structured to encourage content creation and relationship.
 

Details

IDF comes with 5 templates that are structured so you can easily build out documentation.  The 5 templates are as follows:

 

Template Name Description
User Guide The User Guide page is the main page of the IDF structure which will provide an in page navigation for all of the topics and articles that are subpages to it. 
Feature Page The Feature page is also known as a Topic Page and is a chapter or subcategory of the User Guide.  It allows you to segment out the articles into categories.
Troubleshooting Page A Troubleshooting page is an article that will most likely be used by your Support team to capture content around a user having an error or encounter an issue that has steps to resolve.
Reference Page A Reference page describes in detail the available settings and controls for a feature in the product.  This will most likely be leveraged to explain associated functions that relate to a feautre/topic.
Tutorial Page The Tutorial page is your typical article type that you'd find in a User Guide.  It has step by step instructuions that lead to an end goal.  

 

Structure

As you are building our an IDF User Guide you'll use the following hierarchy structure to ensure that IDF is properly leveraged:

  • User Guide
    • Feature Page (Same as Topic)
      • Troubleshooting Page(s)
      • Reference Page(s)
      • Tutorial Page(s)

This means that if you want to add multiple Feature (Topic) Pages, you'd go up to the User Guide page and add a new Feature page under it like so:

  • User Guide
    • Feature (Topic) Page
      • Troubleshooting Page(s)
      • Reference Page(s)
      • Tutorial Page(s)
    • Feature (Topic) Page
      • Reference Page(s)
      • Toubleshooting Page(s)
      • Reference Page(s)

As you add Feature(Topic) Pages to your User Guide, the User Guide will automatically add them to the navigation like so:

user_guide.png

Adding Articles

Once you have the User Guide in place along with the topics you can then start adding articles as subpages under the Feature/Topic pages.  You can add as many articles that you want under the Feature/Topic sections.  As you add them they will automatically be categorized on the User Guide page under the tabs: Tutorials, References, and Troubleshooting.  When you click on any of these tabs you'll be able to see all of the articles that match that category within the User Guide.  In the case of the Tutorials tab we add additional meta data that allows you to organize them based upon Begginer, Intermediate and Advanced:

tutorials.png

Considerations

Before you build out your IDF User Guide make sure you give the Topic organization some thought to ensure that you don't have too granular of a categorization but at the same time something that is easy for people to qualify as they are navigating.  

Supported Template Types

Template Type

Details

Supported?

Content

Content templates are intended for reusing page formatting through standard editor functions. While it is possible to add DekiScript to content templates, support for DekiScript is available starting at Level 2.
 
  • New Blank Templates
  • Adding content including text, images, inline comments, and bulleted lists
  • Global Variables
  • No DekiScript or JavaScript

File:User:jamesv/Templates/icon_check.png

Level 1

Branding

Branding templates are used for targeting sections of the skin to apply customizations including styling and custom objects. 
 
  • Site Header/Footer
  • PDF Header/Footer
  • Login Page
  • F1 Prepend & Append

File:User:jamesv/Templates/icon_check.png

Level 2

New Page New Page templates are those templates which appear in the New Page gallery when creating pages. While it is possible to edit the template details for custom templates, details for the following New Page templates are overwritten with each weekly MindTouch update.

 

  • Template:MindTouch/IDF2/Pages/How-To_Page
  • Template:MindTouch/IDF2/Pages/Knowledge_Base_Page
  • Template:MindTouch/IDF2/Pages/Product_Guide/Knowledge_Base
  • Template:MindTouch/IDF2/Pages/Product_Guide/User_Guide
  • Template:MindTouch/IDF2/Pages/Reference_Page
  • Template:MindTouch/IDF2/Pages/Topic_Page
icon_x.png
Not Supported

Functional

Functional templates are system required templates utilized for IDF, LightSpeed framework, F1, various integrations and the main engine that drives MindTouch TCS and MindTouch 4. Customizations for these templates are not supported, and may be overwritten by regular release updates.
 
  • Templates Controlled by MindTouch
  • Copied Functional Templates

 

All functional templates exist under /Template:MindTouch. Customizing or modifying Functional Templates is not supported.  Below is a list of the main sub-sections:

  • Template:MindTouch/Controls/
  • Template:MindTouch/Functions/
  • Template:MindTouch/IDF/
  • Template:MindTouch/IDF2/
  • Template:MindTouch/OOBE/
  • Template:MindTouch/Pages/
  • Template:MindTouch/Reports/
  • Template:MindTouch/SFDC/
  • Template:MindTouch/Views/

icon_x.png

Not Supported

  • Was this article helpful?