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/21 19:07] – twincam | style_guidelines [2022/02/03 16:28] – [Layout/Formatting Guidelines]-added process/module names changed code formatting 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 ===== |
- | \\ {{: | + | * Many wiki readers aren't fluent in English. Please choose your words carefully. |
+ | * Avoid using specialized abbreviations that aren't standard across the technology industry or in common English. For example, anyone unfamiliar with Linux/Unix will not know that " | ||
+ | * Avoid non-standard abbreviations/ | ||
+ | * Avoid using the word " | ||
+ | * Avoid using underlining. It's obsolete and inappropriate. Research shows it also makes things harder to read. | ||
+ | * 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' | ||
+ | * When referring to FreshTomato' | ||
+ | * Avoid using quotation marks. They' | ||
+ | * 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 | + | * Add a meaningful title for each wiki page, and format it with the Heading1 format. |
+ | * Subheadings use the Heading2 format. | ||
+ | * Subheadings below that use the Heading3 format. | ||
+ | * Indicate web interface menu paths like this: "// | ||
+ | * Always use the standard Tomato theme when taking screenshots. | ||
+ | |||
+ | \\\\ {{: | ||
+ | |||
+ | \\ | ||
+ | |||
+ | * Avoid using quotation marks except where absolutely appropriate. Quotation marks are rarely appropriate, | ||
+ | | ||
+ | | ||
+ | * Unless they are in a code window, command strings should be set in the '' | ||
+ | | ||
+ | | ||
+ | * Avoid using dividing lines. Better spacing, and other formatting methods work better. | ||