When do I use references pages?
The reference page in MindTouch is an effective way to present information to users who seek detailed answers to specific feature questions or who want to gain a greater understanding of a particular task related to your product or service. Treat topics as you would chapters in a book. Use topics to describe your product or service, use cases and benefits. To emphasize a concept and to more deeply connect with your users and to provide more value, add visual elements and notes or tips. References often consist of best practices, FAQs, code samples, system requirements, or any other informative content that would allow your users to become your brand experts.
How to add reference pages
Choose the reference template
- On the MindTouch toolbar, click New.
The Add new page dialog may present page types that do not conform with proper site structure. Be sure to select only page types appropriate to the current position in the hierarchy. Contact email@example.com if you would like MindTouch to present only structure-appropriate article types in the Add new page dialog.
- Select the Reference template.
- Depending on whether you want to create the page live or as a draft, select either the Create live or Create draft radio button (you will be able to publish the draft to your live site later) and click Create.
Add content to your reference page
- Title your page.
- Replace text with your content.
Both the DekiScript code at the top of the page, and any references to article type tags (such as the line "Tags recommended by the template…") determine how the page behaves. If you see these lines on newly created pages, do not remove them.
- If applicable, add images, videos or tables to enhance your content.
- Click Save.
The MindTouch editor is similar to other document creation applications you've used in the past. Use the editor to bold, italicize or edit your text as you normally would with any other text editors.
Configure reference page settings
- Expand Page Settings (above your new title).
- Hover over the Add page summary field to display the page summary icon .
- Click the page summary icon and enter a page summary.
The page summary is not only the first paragraph that is displayed on your page, it also is the description that is displayed in MindTouch and Google search results, so make sure to include valuable keywords.
- Make sure that Article type is set to Reference.
- If you have not yet set up any custom classifications, set a Stage value to help you later identify articles in certain stages of your workflow.
- Apply appropriate Tags to your article. (You must hit Enter after entering each tag.)
Keep tags consistent. Tags help determine the articles MindTouch recommends at the bottom of each page. Articles with common tags are more likely to be considered related when MindTouch determines page recommendations.
Publish your reference page (if a draft)
If you created your page in draft mode and are ready to publish the page to your live site, click Publish.
You created a page and realize you want to make some changes to your content. Click here to get tips on editing your page.