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:31] – [Layout/Formatting Guidelines] hogwild | style_guidelines [2021/09/22 04:52] – [Text Content Guidelines] hogwild | ||
---|---|---|---|
Line 7: | Line 7: | ||
===== Text Content Guidelines ===== | ===== Text Content Guidelines ===== | ||
+ | * Many wiki readers aren't fluent in English. Choose your words carefully. | ||
* 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 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 non-standard abbreviations/ | + | * Avoid non-standard abbreviations/ |
* Avoid using the word " | * Avoid using the word " | ||
- | * Avoid using underlining. It's obsolete. | + | * Avoid using underlining. It's obsolete and inappropriate. |
- | * Please use the standard formatting conventions used for type, such as \\ (sub)Heading levels | + | * Please |
- | * Please | + | * Please use a spell checker. Firefox' |
- | * Please use a spell checker. Firefox' | + | * When referring to FreshTomato' |
- | * When referring to menus, please | + | * Avoid using quotation marks. |
- | * Avoid using quotation marks. | + | * Please use rounded brackets () . Square brackets are generally not \\ appropriate here. |
- | * Please use rounded brackets () and not square brackets. Square brackets are generally not appropriate here. | + | |
Line 32: | Line 31: | ||
* 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. | * Avoid using dividing lines. Better spacing, and other formatting methods work better. | ||