This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revision | Next revisionBoth sides next revision | ||
style_guidelines [2023/04/22 20:48] – [Layout/Formatting Guidelines] - formatting hogwild | style_guidelines [2023/05/22 18:14] – [Layout/Formatting Guidelines] -condense, grammar hogwild | ||
---|---|---|---|
Line 24: | 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. | + | Focus on content. |
* Add a meaningful title for each wiki page, and format it with the Heading1 format. | * Add a meaningful title for each wiki page, and format it with the Heading1 format. | ||
* 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: "// | + | * Indicate web interface menu paths like this: "// |
* Always use the standard Tomato theme when taking screenshots. This is set in the [[admin-access|Admin Access]] menu. | * Always use the standard Tomato theme when taking screenshots. This is set in the [[admin-access|Admin Access]] menu. | ||
\\ {{: | \\ {{: | ||
- | * Avoid using quotation marks except where absolutely appropriate. They are rarely appropriate, | + | * Avoid using quotation marks. They are rarely appropriate, |
- | * Avoid underlining. It's been considered | + | * 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. Better spacing, and other formatting methods work better. | ||