User Tools
style_guidelines
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| style_guidelines [2023/06/11 18:09] – [Layout/Formatting Guidelines] -condense 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 45: | Line 46: | ||
| * 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. They are mostly obsolete. Better spacing, and modern formatting methods work better. \\ \\ | * Avoid using dividing lines. They are mostly obsolete. Better spacing, and modern formatting methods work better. \\ \\ | ||
style_guidelines.1686503394.txt.gz · Last modified: 2023/06/11 18:09 by hogwild
Page Tools
