If an article has multiple sections, it will benefit from a table of contents (TOC). The standard format used in knowledge base articles looks like this before it is linked:
First section | Second section | Third section | Fourth section
- The section titles in the TOC should reflect the headings for the sections in the article. The heading text may be shortened for the TOC.
- Section titles are bold.
- Titles are separated by the pipe symbol (|) with a space on both sides of the pipe symbol. The pipe is located on the backslash key above the Enter key.
- The table of contents is centered.
- Click at the beginning of the TOC text to place the cursor; click the Styles dropdown, and select Special Container to create the box around the TOC.
After the anchor links are in place, clicking on a title link in the TOC will scroll the page to that section.
To create the links, anchors must be placed at the beginning of each section heading throughout the article. Anchors are markers that can be placed within an article to link to that specific section.
To place named anchors within the article:
- Click to the left of the first word of the section heading to place the cursor where the anchor should be located.
- Click the Anchor button.
- Type a name in the Anchor Name field, and click OK. A red flag will appear to indicate the location of the anchor. The flag will not be visible in the published article.
To create the anchor link:
- Select the section title in the TOC.
- Click the Link button.
- From the Link Type dropdown, select Link to anchor in the text.
- From the By anchor name dropdown, select an anchor from the list of anchors previously created, and click OK.
- Repeat this for each section title in the TOC.
For more information on creating and editing knowledge base articles, see Using the TeamDynamix editor to create accessible knowledge base articles and service descriptions.