This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
style_guidelines [2023/05/22 19:27] – [Text Content Guidelines] hogwild | style_guidelines [2023/07/16 18:10] (current) – [Layout/Formatting Guidelines] -add that variables should be italicized hogwild | ||
---|---|---|---|
Line 10: | Line 10: | ||
* Some wiki readers are not fluent in English. Please, choose your words carefully. \\ | * Some wiki readers are not fluent in English. Please, choose your words carefully. \\ | ||
* Avoid abbreviations that aren't standard across the industry or in common English. | * Avoid abbreviations that aren't standard across the industry or in common English. | ||
- | * Avoid the word " | + | * Avoid the word " |
- | * Avoid underlining. It's obsolete and inappropriate. | + | * Avoid underlining. It's obsolete and inappropriate. |
* Please view other pages to see which types of text are capitalized and which are written in lower case. \\ \\ | * Please view other pages to see which types of text are capitalized and which are written in lower case. \\ \\ | ||
* Please use a spell checker. Firefox' | * Please use a spell checker. Firefox' | ||
* When referring to FreshTomato menus, please indicate as: // | * When referring to FreshTomato menus, please indicate as: // | ||
- | * Avoid using quotation marks. They' | + | * Avoid using quotation marks, except around filenames. They' |
+ | * Please surround filenames with double quotation marks. For example, " | ||
* Please use rounded brackets () . Square brackets are generally not appropriate here. \\ \\ | * Please use rounded brackets () . Square brackets are generally not appropriate here. \\ \\ | ||
Line 23: | Line 24: | ||
Following style guidelines makes pages easier to understand, more pleasant to read, and easier on the brain and eyes. | Following style guidelines makes pages easier to understand, more pleasant to read, and easier on the brain and eyes. | ||
- | Focus on content. Not everyone will use the same size monitor or resolution. Some use a mobile device or laptop to access the wiki. \\ Different browsers and accessibility also affect how formatting appears (such as line break). | + | The FreshTomato wiki uses [[https:// |
- | | + | Focus on content. |
+ | |||
+ | \\ | ||
+ | |||
+ | | ||
* Subheadings use the Heading2 format. \\ \\ | * Subheadings use the Heading2 format. \\ \\ | ||
* Subheadings below that use the Heading3 format. \\ \\ | * Subheadings below that use the Heading3 format. \\ \\ | ||
- | * Indicate web interface menu paths like this: "//Administration///Admin Access" | + | * Indicate web interface menu paths using the name of the menu, unless there is another menu with a similar name. |
- | * Always use the standard | + | * For example, you can refer to the Admin Access menu. However... |
+ | * You should add a "/" and top node when referring to the ///Bandwidth/// | ||
+ | * Always use the "Tomato" | ||
\\ {{: | \\ {{: | ||
- | * Avoid quotation marks. | + | * Avoid quotation marks. |
+ | * When slang is used. | ||
+ | * When expressing, something precise separate from the text body, such as a filesystem path. \\ \\ | ||
* Avoid underlining. It's been obsolete since the 1980s. It makes text harder to read. \\ \\ | * Avoid underlining. It's been obsolete since the 1980s. It makes text harder to read. \\ \\ | ||
- | * Avoid using the word “NOTE”. There is a section titled: "< | + | * Avoid using the word “NOTE”. There is a section titled: "< |
* Unless they are in a code window, command strings should be set in the '' | * Unless they are in a code window, command strings should be set in the '' | ||
- | * Variables should be italicized. \\ \\ | + | * Variables should be //italicized |
* Process/ | * Process/ | ||
- | * Avoid using dividing lines. Better spacing, and other formatting methods work better. \\ \\ | + | * Avoid using dividing lines. They are mostly obsolete. Better spacing, and modern |