Help:Editing
From PC-BSD Wiki
Revision as of 02:41, 14 July 2012 by Tigersharke (Talk | contribs)
This ought to be more about how to use the wiki markup than about style guidelines but those ought to be mentioned via link.
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
|
|
|
| Dingbats | ||||||||||||||||
| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | A | B | C | D | E | F | |
| U+270x | ✁ | ✂ | ✃ | ✄ | ✅ | ✆ | ✇ | ✈ | ✉ | ✊ | ✋ | ✌ | ✍ | ✎ | ✏ | |
| U+271x | ✐ | ✑ | ✒ | ✓ | ✔ | ✕ | ✖ | ✗ | ✘ | ✙ | ✚ | ✛ | ✜ | ✝ | ✞ | ✟ |
| U+272x | ✠ | ✡ | ✢ | ✣ | ✤ | ✥ | ✦ | ✧ | ✨ | ✩ | ✪ | ✫ | ✬ | ✭ | ✮ | ✯ |
| U+273x | ✰ | ✱ | ✲ | ✳ | ✴ | ✵ | ✶ | ✷ | ✸ | ✹ | ✺ | ✻ | ✼ | ✽ | ✾ | ✿ |
| U+274x | ❀ | ❁ | ❂ | ❃ | ❄ | ❅ | ❆ | ❇ | ❈ | ❉ | ❊ | ❋ | ❌ | ❍ | ❎ | ❏ |
| U+275x | ❐ | ❑ | ❒ | ❓ | ❔ | ❕ | ❖ | ❗ | ❘ | ❙ | ❚ | ❛ | ❜ | ❝ | ❞ | ❟ |
| U+276x | ❠ | ❡ | ❢ | ❣ | ❤ | ❥ | ❦ | ❧ | ❨ | ❩ | ❪ | ❫ | ❬ | ❭ | ❮ | ❯ |
| U+277x | ❰ | ❱ | ❲ | ❳ | ❴ | ❵ | ❶ | ❷ | ❸ | ❹ | ❺ | ❻ | ❼ | ❽ | ❾ | ❿ |
| U+278x | ➀ | ➁ | ➂ | ➃ | ➄ | ➅ | ➆ | ➇ | ➈ | ➉ | ➊ | ➋ | ➌ | ➍ | ➎ | ➏ |
| U+279x | ➐ | ➑ | ➒ | ➓ | ➔ | ➕ | ➖ | ➗ | ➘ | ➙ | ➚ | ➛ | ➜ | ➝ | ➞ | ➟ |
| U+27Ax | ➠ | ➡ | ➢ | ➣ | ➤ | ➥ | ➦ | ➧ | ➨ | ➩ | ➪ | ➫ | ➬ | ➭ | ➮ | ➯ |
| U+27Bx | ➰ | ➱ | ➲ | ➳ | ➴ | ➵ | ➶ | ➷ | ➸ | ➹ | ➺ | ➻ | ➼ | ➽ | ➾ | ➿ |
Notes
| ||||||||||||||||
- 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