Difference between revisions of "Help:Editing"
From PC-BSD Wiki
Tigersharke (Talk | contribs) m |
Tigersharke (Talk | contribs) m (→Special Characters) |
||
| Line 94: | Line 94: | ||
* [[wikipedia:Letterlike Symbols]] | * [[wikipedia:Letterlike Symbols]] | ||
* [[wikipedia:dingbat]] | * [[wikipedia:dingbat]] | ||
| − | |||
* [http://www.asd-ste100.org/faq.htm Technical Writing rules FAQ] - related to highly technical assembly/maintenance manuals but we can take note of a few useful points from the FAQ. | * [http://www.asd-ste100.org/faq.htm Technical Writing rules FAQ] - related to highly technical assembly/maintenance manuals but we can take note of a few useful points from the FAQ. | ||
* [http://simple.wikipedia.org/wiki/E_Prime E Prime] - would likely reduce the challenge to translations. | * [http://simple.wikipedia.org/wiki/E_Prime E Prime] - would likely reduce the challenge to translations. | ||
* [[wikipedia:E-Prime#Discouraged_forms_and_rationale_for_typical_replacements]] | * [[wikipedia:E-Prime#Discouraged_forms_and_rationale_for_typical_replacements]] | ||
| + | ---- | ||
| + | ====[http://meta.wikimedia.org/wiki/Help:Editing Wikimedia: Help:Editing]==== | ||
Revision as of 01:26, 31 January 2012
|
| Help:Editing |
|
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.
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
- 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
