Qtopia Home - Classes - Hierachy - Annotated - Functions - Qt Embedded |

# Qtopia Style Guide: Online Help

## Purpose

The purpose of this document is to set out how the online help for Qtopia is to be formatted. This includes the positioning of tags, use of headings, images, and the rules governing when such pointer hyperlinks as See Alsos should be used.

## Layout

This section explains when different terms, methods of sectioning, and images should be used.

Term | Usage
--- | ---
Index | Applied to a topic page that lists subordinate pages.
See Also: | Used when a topic outside the current one is of direct relevance and does not have an in-text link (these are preferred).
Icons | Only to be used when of direct benefit, never to be used for merely decorative purposes.
Fullstops in lists | Use a fullstop if the list item is a complete sentence. May be used for significant sentence fragments.
Hyphenate | Always hyphenate the following: pop-up, check-box, combo-box,
Do not hyphenate | Do not hyphenate the following: email,

Bold

Use

     <b>

tags for the following: menu options, screen names, key / button names, fields,

Screen or Dialog | Use the term dialog when referring to a message directed at the user that requires a response (a dialog between device and user) all others are screens (even though they collect input in fields etc).
Window | Do not use this term. Instead use the term screen or dialog (see above for clarification).

## Rules on Pointer Hyperlinks

Item | Rule
--- | ---
See Also | This should only be used if the link cannot be placed neatly within the text.
Back to | Should not be used since Qtopia has a 'Back' function and since most pages can be reached in a variety of ways (resulting in an unclear return path).
Go to | Avoid using this if possible. Used for main topic pages that can be reached via more than one parent. This does not include links from child-pages belonging to another main topic.