User Tools
style_guidelines
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revision | Next revisionBoth sides next revision | ||
| style_guidelines [2022/02/03 16:23] – [Wiki Editing Rights]-removed @ sign from rs232-not appropriate here hogwild | style_guidelines [2022/02/03 16:28] – [Layout/Formatting Guidelines]-added process/module names changed code formatting hogwild | ||
|---|---|---|---|
| Line 27: | Line 27: | ||
| * 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: "navigate to // | + | * 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 34: | Line 34: | ||
| \\ | \\ | ||
| - | * 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 has been considered obsolete since the 1980s. |
| - | * Avoid using the word “NOTE”. | + | * Avoid using the word “NOTE”. |
| - | * Unless they are in a code window, command strings should be emboldened, like this: **ssh root@192.168.10.1** | + | * Unless they are in a code window, command strings should be set in the '' |
| * Variables should be italicized. | * Variables should be italicized. | ||
| + | * Process/ | ||
| * Avoid using dividing lines. Better spacing, and other formatting methods work better. | * Avoid using dividing lines. Better spacing, and other formatting methods work better. | ||
style_guidelines.txt · Last modified: 2023/07/16 18:10 by hogwild
Page Tools
