Sorry for the inconvenience.  Chance of typos in templates, the navigation header should be functional for most versions of the handbook.
Potential remains for unforeseen breakage primarily in the handbook portion of the wiki.
Notice will be up until above verified and no other troubles found from recent modifications.

Help:Editing

From PC-BSD Wiki
Revision as of 00:17, 31 January 2012 by Tigersharke (Talk | contribs)

Jump to: navigation, search

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

Reference
Punctuation
  • apostrophe ( ’ ' )
  • brackets ( [ ], ( ), { }, ⟨ ⟩ )
  • colon ( : )
  • comma ( , )
  • dash ( ‒, –, —, ― )
  • ellipsis ( …, ..., . . . )
  • exclamation mark ( ! )
  • full stop/period ( . )
  • guillemets ( « » )
  • hyphen ( ‐ )
  • hyphen-minus ( - )
  • question mark ( ? )
  • quotation marks ( ‘ ’, “ ”, ' ', " " )
  • semicolon ( ; )
  • slash/stroke ( / )
  • solidus ( ⁄ )
Word dividers
  • space ( ) ( ) ( ) (␠) (␢) (␣)
  • interpunct ( · )
General typography
  • ampersand ( & )
  • at sign ( @ )
  • asterisk ( * )
  • backslash ( \ )
  • bullet ( • )
  • caret ( ^ )
  • dagger ( †, ‡ )
  • degree ( ° )
  • ditto mark ( 〃 )
  • inverted exclamation mark ( ¡ )
  • inverted question mark ( ¿ )
  • number sign/pound/hash/octothorpe ( # )
  • numero sign ( № )
  • obelus ( ÷ )
  • ordinal indicator ( º, ª )
  • percent etc. ( %, ‰, ‱ )
  • pilcrow ( ¶ )
  • prime ( ′, ″, ‴ )
  • section sign ( § )
  • tilde ( ~ )
  • underscore/understrike ( _ )
  • vertical/broken bar, pipe ( ¦, | )
Intellectual property
  • copyright symbol ( © )
  • registered trademark ( ® )
  • sound recording copyright ( ℗ )
  • service mark ( ℠ )
  • trademark ( ™ )

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox