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 04:35] – [Layout/Formatting Guidelines] hogwild | style_guidelines [2022/02/03 16:23] – [Layout/Formatting Guidelines] hogwild | ||
---|---|---|---|
Line 7: | Line 7: | ||
===== Text Content Guidelines ===== | ===== Text Content Guidelines ===== | ||
- | | + | |
- | * Avoid using specialized abbreviations that aren't standard | + | |
- | * Avoid non-standard abbreviations/ | + | * Avoid using specialized abbreviations that aren't standard across the technology industry or in common English. For example, anyone unfamiliar with Linux/Unix will not know that " |
- | * Avoid using the word " | + | * Avoid non-standard abbreviations/ |
- | * Avoid using underlining. It's obsolete. | + | * Avoid using the word " |
- | * Please use the standard formatting conventions used for type, such as \\ (sub)Heading levels | + | * Avoid using underlining. It's obsolete and inappropriate. Research shows it also makes things harder to read. |
- | * Please | + | * Please |
- | * Please use a spell checker. Firefox' | + | * Please use a spell checker. Firefox' |
- | * When referring to menus, please | + | * When referring to FreshTomato' |
- | * Avoid using quotation marks. | + | * Avoid using quotation marks. |
- | * Please use rounded brackets () and not square brackets. Square brackets are generally not appropriate here. | + | * Please use rounded brackets () . Square brackets are generally not appropriate here. |
Line 28: | Line 28: | ||
* Subheadings below that use the Heading3 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. |
+ | |||
+ | \\\\ {{: | ||
+ | |||
+ | \\ | ||
* 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. |