This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
style_guidelines [2021/09/22 02:00] – hogwild | style_guidelines [2023/07/16 18:06] – [Text Content Guidelines] -formatting hogwild | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Style Guidelines (Wiki Edits) ====== | + | ====== Style Guidelines (Wiki Editing) ====== |
- | * WIKI editing rights | + | ===== 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 "@rs232" on the [[https:// |
- | * \\ Indicate menu paths using notation like this: " | + | |
- | * \\ Use the standard Tomato theme for screenshots. //Administration/Admin Access//: | + | |
- | * \\ {{: | + | ===== Text Content Guidelines ===== |
- | * \\ Avoid using quotation marks where possible. | + | |
- | * \\ Avoid underlining. | + | * Some wiki readers are not fluent in English. Please, choose your words carefully. |
- | * \\ Avoid using “NOTE”. | + | * Avoid abbreviations that aren't standard across the industry or in common English. |
- | * \\ Command strings | + | * 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 | ||
+ | * Avoid using quotation marks, except around filenames. They' | ||
+ | * Please surround filenames with double quotation marks. For example, | ||
+ | * Please | ||
+ | |||
+ | |||
+ | ===== Layout/Formatting Guidelines ===== | ||
+ | |||
+ | Following style guidelines makes pages easier | ||
+ | |||
+ | The FreshTomato wiki uses [[https://www.dokuwiki.org/dokuwiki|dokuwiki]] as its underlying software. It 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 "/" and top node when referring to the ///Bandwidth/// | ||
+ | * Always use the " | ||
+ | |||
+ | \\ {{: | ||
+ | |||
+ | * Avoid quotation marks. | ||
+ | * When slang is used. | ||
+ | * When expressing, something precise separate from the text body, such as a filesystem path. \\ \\ | ||
+ | * Avoid underlining. | ||
+ | * Avoid using the word “NOTE”. | ||
+ | * Unless they are in a code window, command strings should be set in the '' | ||
+ | * Variables | ||
+ | | ||
+ | | ||