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:36] – [Text Content Guidelines] hogwild | style_guidelines [2023/05/22 19:43] – [Layout/Formatting Guidelines] -Add that wiki is based on dokuwiki ad Prosemirror, add links for both 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" on the [[https:// |
===== Text Content Guidelines ===== | ===== Text Content Guidelines ===== | ||
- | | + | |
- | * Avoid using specialized | + | |
- | * Avoid non-standard abbreviations/ | + | * Avoid abbreviations that aren't standard across the industry or in common English. |
- | * Avoid using the word " | + | * Avoid the word " |
- | * Avoid using underlining. It's obsolete. | + | * Avoid underlining. It's obsolete |
- | * Please use the standard formatting conventions used for type, such as \\ (sub)Heading levels and body text. | + | * 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 which text portions | + | * Please use a spell checker. Firefox' |
- | * Please use a spell checker. Firefox' | + | * When referring to FreshTomato menus, please |
- | * When referring to FreshTomato menus, please | + | * Avoid using quotation marks. |
- | * Avoid using quotation marks. | + | * Please use rounded brackets () . Square brackets are generally not appropriate here. \\ \\ |
- | * Please use rounded brackets () and not square brackets. Square brackets are generally not appropriate here. | + | |
===== Layout/ | ===== Layout/ | ||
+ | |||
+ | The FreshTomato wiki uses [[https:// | ||
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. |
- | * Subheadings use the Heading2 format. | + | |
- | * Subheadings below that use the Heading3 format. | + | |
- | * Indicate web interface menu paths like this: "navigate to // | + | * Subheadings use the Heading2 format. |
- | * 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, | + | * Indicate web interface menu paths like this: "// |
- | * Avoid underlining. It was considered | + | * Always use the standard Tomato theme when taking screenshots. |
- | * 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** | + | \\ {{: |
- | * Variables should be italicized. | + | |
- | * Avoid using dividing lines. Better spacing, and other formatting methods work better. | + | * Avoid quotation marks. |
+ | * Avoid underlining. It's been 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. | ||
+ | * Process/ | ||
+ | * Avoid using dividing lines. Better spacing, and other formatting methods work better. | ||