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 [2022/02/03 17:00] – [Layout/Formatting Guidelines] -changed quotes usage to new bullet point hogwild | style_guidelines [2023/04/22 20:48] – [Layout/Formatting Guidelines] - formatting hogwild | ||
---|---|---|---|
Line 3: | Line 3: | ||
===== Wiki Editing Rights ===== | ===== Wiki Editing Rights ===== | ||
- | To be able to edit the Wiki, you will need to get new user credentials. To request access, please send a personal message to user " | + | To be able to edit the Wiki, you will need to get new user credentials. To request access, please send a personal message to user " |
===== Text Content Guidelines ===== | ===== Text Content Guidelines ===== | ||
- | * Many wiki readers | + | * There may be wiki readers |
* 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/ | ||
Line 23: | Line 23: | ||
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. | ||
* 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. | ||
Line 30: | Line 32: | ||
* 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 except where absolutely appropriate. | + | * Avoid underlining. It' |
- | * They are rarely appropriate, | + | |
- | * Avoid underlining. It has been considered obsolete since the 1980s. | + | |
* 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 '' |