• Wiki Spaces - for Translations
• Page Names - for Context Sensitive Help
• Parent / Child Pages - for Table of Contents

Wiki Spaces - for Translations

Our online help is captures in a number of wiki spaces; the page structure (parent pages and child pages) is used to determine the table of contents.

Page Names - for Context Sensitive Help

Context Sensitive Help is avialable in the application by press F1.

We don't have any special integration with context sensitive help at this time. Just press F1 and a dynamic search will usually figure out that the Catalog view page is what should be displayed when the catalog view has focus.

Parent / Child Page Name - for Table of Contents

We use page parent / child relationships to capture the table of contents structure for our online help. Child pages are sorted by title; so if you have pages that should be listed in a specific order you may wish to start the page name with a number.

Example Parent

Contents:
{children:sort=title}

{related}concepts{related}
* [A Concept Page]

{related}reference{related}
* [Eclipse Help|http://help.eclipse.org/help30]

We have made use of the following macros:

• {children:sort=title} used to list child pages

Alternatives:

• {children:sort=title|excerpt=true} used to list child pages with a short description.

Example Child

Some content {excerpt}with a short description{excerpt}. Try not to include many links in your content,
Save it for the related sections.

{related}concepts{related}
* [What is a Feature]

{related}tasks{related}
* [How to create a Feature]

{related}reference{related}
* [Export wizard]

We have used the following macro:

• {related} provide to correct (language specific) images for reference, concepts and tasks.
• {excerpt} used to isolate a couple of words as a short description for the page

The convention is to list the related information at the bottom of the page, rather the overload the documented with numerous in-line links. The macros are to be used in the order: concepts, tasks, reference.