This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
style_guidelines [2021/09/22 02:43] – [WIKI Editing Rights] hogwild | style_guidelines [2021/09/22 04:35] – [Layout/Formatting Guidelines] hogwild | ||
---|---|---|---|
Line 7: | Line 7: | ||
===== Text Content Guidelines ===== | ===== Text Content Guidelines ===== | ||
- | + | * For Many wiki readers, English is their second language. Choose your words carefully. | |
- | * Avoid using specialized abbreviations that aren't standard across the tech/ | + | * Avoid using specialized abbreviations that aren't standard |
- | * For example, | + | * Avoid non-standard |
- | * On the other hand, Wi-Fi is a standard term across computing, and society in general, and is therefore okay to use. | + | * Avoid using the word " |
- | * Avoid non-standard | + | * Avoid using underlining. It' |
- | * Avoid use of the word " | + | * Please |
- | * Avoid using underlining. Underlining is consider by those in the print, web and typesetting industries to be obsolete. It' | + | * Please stay consistent with other pages in terms of which words are capitalized and which use lower case. |
- | * Please | + | * Please use a spell checker. Firefox' |
- | * Please use a spell checker. Firefox' | + | |
* When referring to menus, please write the text as // | * When referring to menus, please write the text as // | ||
* Avoid using quotation marks. Most of the time, they aren't appropriate. So if you're not sure, leave them out. | * Avoid using quotation marks. Most of the time, they aren't appropriate. So if you're not sure, leave them out. | ||
- | * Please use rounded brackets () and not square brackets. Square brackets | + | * Please use rounded brackets () and not square brackets. Square brackets |
===== Layout/ | ===== Layout/ | ||
- | * Following guidelines makes the wiki | + | Following |
- | * Easier | + | |
- | * Easier and more pleasant to read | + | |
* Add a meaningful title for each wiki page, and format it with the Heading1 format. | * Add a meaningful title for each wiki page, and format it with the Heading1 format. | ||
+ | * Subheadings use the Heading2 format. | ||
+ | * Subheadings below that use the Heading3 format. | ||
* Indicate web interface menu paths like this: " | * Indicate web interface menu paths like this: " | ||
- | * Use the standard Tomato theme for screenshots | + | * Always use the standard Tomato theme when taking |
- | * {{: | + | * Avoid using quotation marks except where absolutely appropriate. Quotation marks are rarely appropriate, |
- | * Avoid using quotation marks except where absolutely appropriate. Quotation marks are rarely appropriate, | + | |
* Avoid underlining. It was considered obsolete since the 1980s. | * Avoid underlining. It was considered obsolete since the 1980s. | ||
- | * Avoid using the word “NOTE”. | + | * Avoid using the word “NOTE”. |
- | * Command | + | * Unless they are in a code window, command |
- | * | + | * Variables should be italicized. |
+ | * Avoid using dividing lines. Better spacing, and other formatting methods work better. | ||