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 [2021/09/22 04:35] – [Layout/Formatting Guidelines] hogwild | style_guidelines [2022/05/01 21:28] – [Layout/Formatting Guidelines]-Delete inappropriate user comment hogwild | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Style Guidelines (Wiki Edits) ====== | + | ====== Style Guidelines (Wiki Editing) ====== |
===== 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 @rs232, including your email address and preferred username. | + | 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 "rs232", including your email address and preferred username. |
===== Text Content Guidelines ===== | ===== Text Content Guidelines ===== | ||
- | | + | |
- | * Avoid using specialized abbreviations that aren't standard | + | |
- | * Avoid non-standard abbreviations/ | + | * 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 the word " | + | * Avoid non-standard abbreviations/ |
- | * Avoid using underlining. It's obsolete. | + | * Avoid using the word " |
- | * Please use the standard formatting conventions used for type, such as \\ (sub)Heading levels | + | * Avoid using underlining. It's obsolete and inappropriate. Research shows it also makes things harder to read. |
- | * Please | + | * Please |
- | * Please use a spell checker. Firefox' | + | * Please use a spell checker. Firefox' |
- | * When referring to menus, please | + | * When referring to FreshTomato' |
- | * Avoid using quotation marks. | + | * Avoid using quotation marks. |
- | * Please use rounded brackets () and not square brackets. Square brackets are generally not appropriate here. | + | * Please use rounded brackets () . Square brackets are generally not appropriate here. |
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. | ||
* 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. |
- | * Avoid using quotation marks except where absolutely appropriate. | + | |
- | * Avoid underlining. It was considered obsolete since the 1980s. | + | \\ {{: |
- | * 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** | + | * Avoid using quotation marks except where absolutely appropriate. |
+ | * They are rarely appropriate, | ||
+ | * Avoid underlining. It has been considered obsolete since the 1980s. It makes text harder to read. | ||
+ | * Avoid using the word “NOTE”. | ||
+ | * 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. | ||
+ | * Avoid excessive unnecessary blank lines. | ||