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 03:05] – [Layout/Formatting Guidelines] hogwild | style_guidelines [2021/09/22 04:29] – [Text Content Guidelines] hogwild | ||
---|---|---|---|
Line 8: | Line 8: | ||
===== Text Content Guidelines ===== | ===== Text Content Guidelines ===== | ||
- | * 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 considered obsolete. It' | + | * Please keep consistent with other pages on which words are capitalized and which use lower case. |
- | * Please | + | |
- | * Standard formatting conventions include | + | |
* 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 easier to understand, | + | Following guidelines makes pages easier to understand, more pleasant to read, and eaiser on the brain and eyes. |
* 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. | ||
* Indicate web interface menu paths like this: " | * Indicate web interface menu paths like this: " | ||
- | * Always use the standard Tomato theme when taking screenshots. | + | * Always use the standard Tomato theme when taking screenshots. |
- | * {{: | + | |
* 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. |