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.
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:
- 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
- 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
- U+2713 ✓ check mark
- U+2714 ✔ heavy check mark
- U+2610 ☐ ballot box
- U+2611 ☑ ballot box with check
- U+2717 ✗ BALLOT X (cross)
- U+2718 ✘ HEAVY BALLOT X (bold cross)
- U+2610 ☐ BALLOT BOX (square)
- U+2612 ☒ BALLOT BOX WITH X (square with cross)
- unicode DB
- wikipedia:Arrow (symbol)
- wikipedia:Letterlike Symbols
- 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.