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/03/09 18:32] – [Layout/Formatting Guidelines] clarity djk44883 | style_guidelines [2023/05/22 18:39] – [Wiki Editing Rights] -add @ to rs232 username 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" |
===== 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 also 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' | + | * When referring to FreshTomato menus, please indicate as: //Menu///Submenu// . // For example: //"Administration///Admin access"// |
- | * Avoid using quotation marks. They' | + | * Avoid using quotation marks. They' |
* 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 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. | + | 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: "// | + | * Indicate web interface menu paths like this: "// |
* 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 quotation marks. They are rarely appropriate, |
- | * Avoid using quotation marks except where absolutely appropriate. | + | * Avoid underlining. It' |
- | * They are rarely appropriate, | + | * Avoid using the word “NOTE”. There is a section titled: "< |
- | * Avoid underlining. It has been considered | + | |
- | * 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 '' | ||
* Variables should be italicized. | * Variables should be italicized. | ||
- | * Process/ | + | * 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. | + | |