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 03:16] – [Text Content Guidelines] hogwild | style_guidelines [2022/03/13 01:06] – :) djk44883 | ||
---|---|---|---|
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 of the word " | + | * Avoid non-standard abbreviations/ |
- | * Avoid using underlining. Underlining is considered obsolete. It' | + | * Avoid using the word " |
- | * Please | + | * Avoid using underlining. It' |
- | * Standard formatting conventions include which words are capitalized and which use lower case. | + | * 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 | + | * Please use rounded brackets () . Square brackets |
===== Layout/ | ===== Layout/ | ||
- | Following guidelines makes pages easier to understand, more pleasant to read, and eaiser | + | Following |
+ | |||
+ | 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. | ||
- | * Indicate web interface menu paths like this: "navigate to // | + | |
- | * Always use the standard Tomato theme when taking screenshots. | + | * Subheadings below that use the Heading3 format. |
- | * Avoid using quotation marks except where absolutely appropriate. Quotation marks are rarely appropriate, | + | |
- | * Avoid underlining. It was considered obsolete since the 1980s. | + | * Always use the standard Tomato theme when taking screenshots. |
- | * Avoid using the word “NOTE”. We are considering adding a NOTES section at the bottom of each page formatted with Heading2. | + | |
- | * Command strings should be emboldened, like this: **ssh root@192.168.10.1** | + | |
- | * Variables should be italicized. | + | |
+ | \\ {{: | ||
+ | \\ | ||
+ | | ||
+ | * 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”. There is a section titled "< | ||
+ | * Unless they are in a code window, command strings should be set in the '' | ||
+ | * Variables should be italicized. | ||
+ | * Process/ | ||
+ | * Avoid using dividing lines. Better spacing, and other formatting methods work better. | ||
+ | * Avoid excessive unnecessary blank lines. | ||
+ | * If you've read this far you've noticed several points just repeat from one section to the next. Been like this since the beginning, but this isn't as important as nit-picking and minor nonsense editing. any one notice? | ||