Difference between revisions of "Help:Editing"
From PC-BSD Wiki
Tigersharke (Talk | contribs) m (→Reference) |
Tigersharke (Talk | contribs) m (→Reference) |
||
| Line 24: | Line 24: | ||
;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} | ||
| − | |||
| − | |||
| − | |||
---- | ---- | ||
| Line 87: | Line 84: | ||
*trademark ( ™ ) | *trademark ( ™ ) | ||
|} | |} | ||
| + | |||
| + | * → ➿ ➙ ➜ arrows pointing to the right | ||
| + | * ← arrow pointing to the left | ||
| + | |||
---- | ---- | ||
* [http://unicode.org/cldr/utility/character.jsp unicode DB] | * [http://unicode.org/cldr/utility/character.jsp unicode DB] | ||
Revision as of 01:18, 31 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
Special Characters
- Traversal of menus/windows
- use an arrow (➜) as in the example: PC-BSD control panel ➜ System manager ➜ System packages {tab}
|
|
|
- → ➿ ➙ ➜ arrows pointing to the right
- ← arrow pointing to the left
- unicode DB
- wikipedia:Arrow (symbol)
- wikipedia:Letterlike Symbols
- wikipedia:dingbat
- Wikimedia: Help:Editing
- Technical Writing rules FAQ - related to highly technical assembly/maintenance manuals but we can take note of a few useful points from the FAQ.
- E Prime - would likely reduce the challenge to translations.
- wikipedia:E-Prime#Discouraged_forms_and_rationale_for_typical_replacements