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:21] – [Text Content Guidelines] hogwild | style_guidelines [2022/02/03 16:22] – [Text Content Guidelines] hogwild | ||
---|---|---|---|
Line 8: | Line 8: | ||
===== Text Content Guidelines ===== | ===== Text Content Guidelines ===== | ||
- | * Avoid using specialized abbreviations that aren't standard | + | |
- | * Avoid non-standard abbreviations/ | + | |
- | * Avoid using the word " | + | * Avoid non-standard abbreviations/ |
- | * something is unusually important. Using it constantly makes the text | + | * Avoid using the word " |
- | * lose its impact, and makes it more jarring to read. We' | + | * Avoid using underlining. It' |
- | * some guiidelines/ | + | * Please |
- | * Avoid using underlining. Underlining is considered obsolete. It' | + | * Please use a spell checker. Firefox' |
- | * Please | + | * When referring to FreshTomato' |
- | * Standard formatting conventions include which words are capitalized and which use lower case. | + | * Avoid using quotation marks. |
- | * Please use a spell checker. Firefox' | + | * Please use rounded brackets () . Square brackets |
- | * When referring to menus, please | + | |
- | * Avoid using quotation marks. | + | |
- | * Please use rounded brackets () and not square brackets. Square brackets | + | |
===== Layout/ | ===== Layout/ | ||
- | Following guidelines makes pages easier to understand, more pleasant to read, and eaiser | + | Following |
* 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: " | ||
* Always use the standard Tomato theme when taking screenshots. \\ {{: | * Always use the standard Tomato theme when taking screenshots. \\ {{: | ||
Line 33: | Line 32: | ||
* Avoid underlining. It was considered obsolete since the 1980s. | * Avoid underlining. It was considered obsolete since the 1980s. | ||
* Avoid using the word “NOTE”. We are considering adding a NOTES section at the bottom of each page formatted with Heading2. | * Avoid using the word “NOTE”. We are considering adding a NOTES section at the bottom of each page formatted with Heading2. | ||
- | * Command | + | * Unless they are in a code window, command |
* Variables should be italicized. | * Variables should be italicized. | ||
+ | * Avoid using dividing lines. Better spacing, and other formatting methods work better. | ||