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/11/12 13:54] – removed forced line breaks djk44883 | style_guidelines [2022/02/03 16:58] – [Layout/Formatting Guidelines] 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 @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 ===== | ||
- | * Many wiki readers aren't fluent in English. | + | * Many wiki readers aren't fluent in English. |
- | * 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/ |
* Avoid using the word " | * Avoid using the word " | ||
- | * Avoid using underlining. It's obsolete and inappropriate. | + | * Avoid using underlining. It's obsolete and inappropriate. Research shows it also makes things harder to read. |
* Please view other pages to see what text is capitalized and what is written in lower case (small letters). | * Please view other pages to see what text is capitalized and what is written in lower case (small letters). | ||
* Please use a spell checker. Firefox' | * Please use a spell checker. Firefox' | ||
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. |
- | * Avoid using quotation marks except where absolutely appropriate. Quotation marks are rarely 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. Quotation marks are rarely appropriate, | ||
+ | * Avoid underlining. It has been considered obsolete since the 1980s. | ||
+ | * 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. | ||