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:43] – [Layout/Formatting Guidelines]-clarity hogwild | style_guidelines [2023/06/11 15:51] – [Layout/Formatting Guidelines] -format hogwild | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Style Guidelines (Wiki Edits) ====== | + | ====== Style Guidelines (Wiki Editing) ====== |
- | ===== | + | ===== 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 user " | ||
- | 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. | ||
===== Text Content Guidelines ===== | ===== Text Content Guidelines ===== | ||
- | * Avoid using specialized | + | |
- | * For example, | + | |
- | * On the other hand, Wi-Fi is a standard | + | * Avoid the word " |
- | * Avoid non-standard abbreivations/ | + | * Avoid underlining. It' |
- | * Avoid use of the word " | + | * Please |
- | * Avoid using underlining. Underlining is consider by those in the print, web and typesetting industries to be obsolete. It' | + | * Please use a spell checker. Firefox' |
- | * Please | + | * When referring to FreshTomato |
- | * Please use a spell checker. Firefox' | + | * Avoid using quotation marks. |
- | * When referring to menus, please | + | * Please use rounded brackets () . Square brackets |
- | * Avoid using quotation marks. | + | |
- | * Please use rounded brackets () and not square brackets. Square brackets | + | |
===== Layout/ | ===== Layout/ | ||
- | * Following guidelines makes the wiki | + | Following |
- | * Easier | + | |
- | * Easier and more pleasant to read | + | The FreshTomato wiki uses [[https:// |
- | * Add a meaningful title for each wiki page, and format it with the Heading1 format. | + | |
- | * Indicate web interface menu paths like this: "navigate | + | Focus on content. |
- | * Use the standard | + | |
- | | + | \\ |
- | * Avoid using quotation marks except where absolutely appropriate. Quotation marks are rarely appropriate, | + | |
- | * Avoid underlining. It was considered | + | * Add a meaningful title for each wiki page, and format it with the Heading1 format. |
- | * Avoid using the word “NOTE”. | + | * Subheadings use the Heading2 format. \\ \\ |
- | * Command | + | * 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 '' | ||
+ | * Always use the "Tomato" | ||
+ | |||
+ | \\ {{: | ||
+ | |||
+ | * 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 | ||
+ | | ||
+ | | ||
+ | * Avoid using dividing lines. Better spacing, and other formatting methods work better. \\ \\ | ||