Page Layout

Page Titles

Use Title Case for page titles - which means each word (other than 'and' 'of' 'the' etc.) should be capitalized.

Page Length

Pages should be kept as short as possible.  This allows users to easily find the information they are seeking in the Navigation Pane.  It allows content to be more easily referenced in other pages, since it is not as easy to link to page sections.  It also produces more accurate search results.

Long pages should always include a Go To Top  link to get directly to the top of the page. See MindTouch Wiki "Go to Top" Page link

Note: Such a link may be included in a template in future.

Introduction

Every page should contain an introductory paragraph or two describing the purpose of the page or introducing the topic, feature, concept or procedure described.

Do not use a Heading. (i.e. H tag) for the Introduction - the Page Title is already a heading.

Index

If you wish to include an index of sub pages of the current page, you may use the Wiki.tree extension:

1. Select Extensions (or Insert > Extensions) button on the Edit Menu,
2. Select Built in and navigate almost to the end of the list  > wiki.tree
3. path- Wiki page path (omit the root i.e. http://wiki.team-mediaportal.com)
4. depth- nesting depth for retrieving child pages (default: all)
5. reverse- reverse order of child pages

This extension is particularly useful for top level pages of a section, where you may wish to display an index of the sub pages.

(Note: we hope/plan to add Wiki.tree to the Edit Menu in future)

Section Headings

Always use Heading tags from the Edit Menu to create a heading for each section.  Headings should be entered using Title Case - which means each word (other than 'and' 'of' 'the' etc.) should be capitalized.

• Main section - Heading 1
• Subsection - Heading 2
• Sub Sub Section - Heading 3
• Etc, etc, etc...

Headings are used to automatically generate a Table of Contents for the page, so DO NOT skip levels even if you think another level looks better. Heading styles should be changed or improved in the Page template.

Pages in Series

Where pages contain a series or sequence of steps that should be followed in order, links should be included to navigate to the next and previous pages, ideally showing the Page Title, such as on the Deploy Tool > Select Options page:

If you want to choose a client or a server installation or specify more installation parameters choose Advanced Installation
If you select One Click Installation, proceed to Install.

Further Information

In general, every page should contain at least one section for further information:

• Related Wiki pages
• Related Extensions
• References - links to other websites that contain further information on the topic
• Tips

These may be added on a Right Panel or in a Tip Box:

1. Create a new page
2. Select the Blank w Rt Panel or Blank w Tip Box template

Go to top