Help:Editing

From PC-BSD Wiki
Revision as of 16:53, 2 February 2012 by Tigersharke (Talk | contribs)

Jump to: navigation, search

Contents

Objective

The purpose of defining how pages on the wiki should be written, is to help maintain consistency by having a set guideline, and to enable easier translations of the site into other languages. Since this page is easily accessible below the edit box, it (currently) contains more details of style than actual edit instruction.

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
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 ( ™ )
  • → ➿ ➙ ➜ arrows pointing to the right
  • ← arrow pointing to the left
  • U+2713 ✓ check mark
  • U+2714 ✔ heavy check mark
  • U+2610 ☐ ballot box
  • U+2611 ☑ ballot box with check


Wikimedia: Help:Editing

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox