This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
style_guidelines [2021/09/21 18:58] – twincam | style_guidelines [2023/07/16 18:10] (current) – [Layout/Formatting Guidelines] -add that variables should be italicized hogwild | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Style Guidelines | + | ====== Style Guidelines |
- | \\ Wiki editing requires new User credentials. Please PM @rs232 specifying your email address and preferred User name to request access. | + | ===== Wiki Editing Rights ===== |
- | \\ Add a meaningful document title using Heading1 format. | + | 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 " |
- | \\ Indicate menu paths using notation like this: " | ||
- | \\ Use the standard Tomato theme for screenshots. // | + | ===== Text Content Guidelines ===== |
- | \\ {{:pasted:20210921-184547.png}} | + | * Some wiki readers are not fluent in English. Please, choose your words carefully. |
+ | * Avoid abbreviations that aren't standard across the industry or in common English. | ||
+ | * Avoid the word " | ||
+ | * Avoid underlining. It's obsolete and inappropriate. Research shows it 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 use a spell checker. Firefox' | ||
+ | * When referring to FreshTomato menus, please indicate as: // | ||
+ | * Avoid using quotation marks, except around filenames. They' | ||
+ | * Please surround filenames with double quotation marks. For example, " | ||
+ | * Please use rounded brackets () . Square brackets are generally not appropriate here. \\ \\ | ||
- | \\ Avoid using quotation marks where possible. | ||
- | \\ Avoid underlining. | + | ===== Layout/ |
- | \\ Avoid using “NOTE”. | + | Following style guidelines makes pages easier to understand, more pleasant to read, and easier on the brain and eyes. |
- | \\ Command strings | + | The FreshTomato wiki uses [[https:// |
+ | |||
+ | Focus on content. | ||
+ | |||
+ | \\ | ||
+ | |||
+ | * Add a meaningful title to each wiki page. Format it with the Heading1 format. \\ \\ | ||
+ | * 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 "/" | ||
+ | * Always use the " | ||
+ | |||
+ | \\ {{: | ||
+ | |||
+ | * Avoid quotation marks. In the context of this wiki, they should be used only: | ||
+ | | ||
+ | | ||
+ | * Avoid underlining. It's been obsolete since the 1980s. It makes text harder to read. \\ \\ | ||
+ | | ||
+ | | ||
+ | * Variables should be // | ||
+ | * Process/ | ||
+ | * Avoid using dividing lines. They are mostly obsolete. Better spacing, and modern formatting methods work better. \\ \\ | ||