Typographical Conventions - Plone Documentation

Textual Elements

Headings- Use pre-defined headings as appropriate. ( kupu)
Text Justification- Text should normally be left justified with a ragged right edge.
White Space- Use white space to separate information so that readers can easily identify section and to provide a frame for graphics.
Abbreviations- Use abbreviations sparingly. Spell out the acronym or abbreviation with first time it is used in the text and follow in parenthesis with the abbreviation.
Bulleted list- Use the standard formatting in kupu. Start each list with a stem sentence that introduces the list in some way; use a colon at the end of the stem sentence.
Links- use standard formatting
Result or Example Text- When you include a result after a step, the text should appear as such: Result: blah blah blah.

Note, Tip, Caution, or Warning

Item	Description	Format
Note	use for content for which users should take special note.
Tip	use for content that user may find helpful or nice to know, such as a shortcut or best practice.
Caution	Use for content that users should know to avoid minor frustration or inconvenience (like losing data).
Warning	Use for content that users should know to avoid serious, irreversible damage, or loss of data.

Term	Use
Arrow Keys	Use to collectively refer to the left, right, up or down arrow keys on the keyboard.
Browse	use browse through a list (database, document, and so on) not browse a list.
Click	Use Click rather than choose or select, to refer to a user choosing or selecting a command or option. Do not use click on or click at; however, click in the window is acceptable.
Close	use close for windows, documents, and dialog boxes. For programs or network connections, use end or quit.
Deselect	do not use. instead, use cancel the selection or clear.
Dialog box	always use dialog box and no just dialog or pop-up window.
Highlight	do not use. instead, use select. refer to the selected material as the selection.
Icon	use to describe a graphic representation of an object that a user can select and open.
Install	use install when referring to hardware such as device drivers. Use set up when referring to software or components.
Key combinations	use a plus sign to indicate key combinations such as shortcut keys and access keys.
Press	use when pressing a key initiates an action within the program or moves the user's position.
Enter	do not use enter as a synonym for type, except to indicate that a user can either type of click a selection, such as from a list in a box.
Type	use type, not enter, to direct a user to type information that will appear on the screen.
Use	use in situations when press might be confusing, such as when referring to a type of key such as the arrow keys or function keys.