Difference between revisions of "Help:Editing"

Revision as of 22:58, 30 January 2012

Help:Editing

Typographic Conventions

The PC-BSD Handbook uses the following typographic conventions:

bold text: represents a command written at the command line. In usage examples, the font is changed with any command output displayed in unbolded text.

italic text: used to represent device names or file name paths.

bold italic text: used to emphasize an important point.

Language usage and word choice

To facilitate future translations avoid the following:

Contractions

in place of don't, can't or won't use do not, cannot, or will not.

Avoid brand names

use web search instead of Google search

Some special characters

Traversal of menus/windows

use an arrow (➜) as in the example: PC-BSD control panel ➜ System manager ➜ System packages {tab}

Reference

This is a helpful spot to facilitate a copy/paste of these unique characters:

• wikipedia:Arrow (symbol)
• wikipedia:Letterlike Symbols
• wikipedia:dingbat
• → ➿ ➙ ➜ more arrows pointing to the right
• ← arrow pointing to the left
• ™ Trademark
• © Copyright
• ® Registered

• unicode DB