Difference between revisions of "Help:Editing"

From PC-BSD Wiki
Jump to: navigation, search
m
m (Some special characters)
Line 21: Line 21:
 
:use '''web''' ''search'' instead of '''''Google''' search''
 
:use '''web''' ''search'' instead of '''''Google''' search''
  
===Some special characters===
+
===Special Characters===
 
;Traversal of menus/windows
 
;Traversal of menus/windows
 
:use an arrow (➜) as in the example: PC-BSD control panel ➜ System manager ➜ System packages {tab}
 
:use an arrow (➜) as in the example: PC-BSD control panel ➜ System manager ➜ System packages {tab}

Revision as of 23:37, 30 January 2012

Contents

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

Special Characters

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

Reference

  • → ➿ ➙ ➜ arrows pointing to the right
  • ← arrow pointing to the left
  • ™ Trademark
  • © Copyright
  • ® Registered