This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
style_guidelines [2023/04/21 09:12] – [Wiki Editing Rights] rs232 | style_guidelines [2023/07/16 18:10] (current) – [Layout/Formatting Guidelines] -add that variables should be italicized 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 "@rs232" on the [[https:// |
===== Text Content Guidelines ===== | ===== Text Content Guidelines ===== | ||
- | * There may be wiki readers not fluent in English. Please choose your words carefully. | + | * Some wiki readers |
- | * Avoid using specialized | + | * Avoid abbreviations that aren't standard across the industry or in common English. |
- | * Avoid non-standard abbreviations/ | + | * Avoid the word " |
- | * Avoid using the word " | + | * Avoid underlining. It's obsolete and inappropriate. Research shows it makes things harder to read. \\ \\ |
- | * Avoid using underlining. It's obsolete and inappropriate. Research shows it also makes things harder to read. | + | * Please view other pages to see which types of text are capitalized and which are written in lower case. \\ \\ |
- | * 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' | + | * When referring to FreshTomato menus, please indicate as: //Menu///Submenu// . // For example: //"Administration///Admin access"// |
- | * When referring to FreshTomato' | + | * Avoid using quotation marks, except around filenames. They' |
- | * Avoid using quotation marks. They' | + | * Please surround filenames with double quotation marks. For example, " |
- | * Please use rounded brackets () . Square brackets are generally not appropriate here. | + | * Please use rounded brackets () . Square brackets are generally not appropriate here. \\ \\ |
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. Not everyone will use the same size monitor or resolution. It's possible users may have mobile devices or various models of laptops to access the wiki. Users may click Toggle theme changing the entire appearance from what you see. | + | The FreshTomato wiki uses [[https:// |
- | | + | Focus on content. |
- | * Subheadings use the Heading2 format. | + | |
- | * Subheadings below that use the Heading3 format. | + | \\ |
- | * Indicate web interface menu paths like this: "//Administration/Admin Access//." (Use / to separate | + | |
- | * Always use the standard | + | |
+ | * Subheadings use the Heading2 format. | ||
+ | * Subheadings below that use the Heading3 format. | ||
+ | * Indicate web interface menu paths using the name of the menu, unless there is another menu with a similar name. | ||
+ | * For example, you can refer to the Admin Access menu. However... | ||
+ | * You should add a "/" and top node when referring to the ///Bandwidth/// | ||
+ | * Always use the "Tomato" | ||
\\ {{: | \\ {{: | ||
- | * Avoid using quotation marks except where absolutely appropriate. | + | * Avoid quotation marks. |
- | * They are rarely appropriate, and should | + | * When slang is used. |
- | * Avoid underlining. It has been considered | + | * When expressing, something precise separate from the text body, such as a filesystem path. \\ \\ |
- | * Avoid using the word “NOTE”. There is a section titled "< | + | * Avoid underlining. It' |
- | * Unless they are in a code window, command strings should be set in the '' | + | * Avoid using the word “NOTE”. There is a section titled: "< |
- | * Variables should be italicized. | + | * Unless they are in a code window, command strings should be set in the '' |
- | * Process/ | + | * Variables should be //italicized |
- | * Avoid using dividing lines. Better spacing, and other formatting methods work better. | + | * Process/ |
- | * Avoid excessive unnecessary blank lines. | + | * Avoid using dividing lines. They are mostly obsolete. Better spacing, and modern |