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 02:00] – hogwild | style_guidelines [2022/02/03 16:54] – [Layout/Formatting Guidelines] hogwild | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Style Guidelines (Wiki Edits) ====== | ====== Style Guidelines (Wiki Edits) ====== | ||
- | * WIKI editing rights | + | ===== Wiki Editing Rights ===== |
- | | + | |
- | * \\ Add a meaningful | + | 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", including your email address and preferred username. |
- | * \\ Indicate menu paths using notation | + | |
- | * \\ Use the standard Tomato theme for screenshots. | + | |
- | | + | ===== Text Content Guidelines ===== |
- | * \\ Avoid using quotation marks where possible. | + | |
- | * \\ Avoid underlining. | + | * Many wiki readers aren't fluent in English. Please choose your words carefully. |
- | * \\ Avoid using “NOTE”. | + | * 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 " |
- | * \\ Command | + | * 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. | ||
+ | |||
+ | |||
+ | ===== Layout/ | ||
+ | |||
+ | Following style guidelines makes pages easier to understand, more pleasant to read, and easier on the brain and eyes. | ||
+ | |||
+ | * 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 | ||
+ | * Always use the standard Tomato theme when taking | ||
+ | |||
+ | \\ {{: | ||
+ | |||
+ | * Avoid using quotation marks except | ||
+ | * Avoid underlining. It has been considered obsolete since the 1980s. | ||
+ | * Avoid using the word “NOTE”. There is a section titled "< | ||
+ | * Unless they are in a code window, command | ||
+ | | ||
+ | | ||
+ | * Avoid using dividing lines. Better spacing, and other formatting methods work better. | ||