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:08] – -Added bullets, clarity hogwild | style_guidelines [2023/07/16 18:05] – [Text Content Guidelines] -add to surround filenames with quotation marks 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 @rs232, including your email address and preferred username. | + | 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:// |
+ | |||
+ | |||
+ | ===== Text Content Guidelines ===== | ||
+ | |||
+ | * 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. \\ \\ | ||
- | ===== Text Content Guidelines | ||
===== Layout/ | ===== Layout/ | ||
- | * Following | + | Following |
- | * Add a meaningful title for each WIKI page, and format | + | |
- | * Indicate menu paths using notation like this: "navigate | + | The FreshTomato wiki uses [[https:// |
- | * Use the standard | + | |
- | | + | Focus on content. |
- | * Avoid using quotation marks except where absolutely appropriate. Quotation marks are generally only appropriate when quoting something someone said or wrote, or when slang/ | + | |
- | * Avoid underlining. It was considered | + | \\ |
- | * Avoid using the word “NOTE”. | + | |
- | * Command | + | * Add a meaningful title to each wiki page. Format |
- | * | + | * Subheadings use the Heading2 format. \\ \\ |
+ | * Subheadings below that use the Heading3 format. \\ \\ | ||
+ | * Indicate | ||
+ | * For example, you can refer to the Admin Access menu. However... | ||
+ | * You should add a "/" and top node when referring | ||
+ | * Always use the "Tomato" | ||
+ | |||
+ | \\ {{: | ||
+ | |||
+ | * Avoid quotation marks. | ||
+ | * When slang is used. | ||
+ | * When expressing, something precise separate from the text body, such as a filesystem path. \\ \\ | ||
+ | * 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. They are mostly obsolete. Better spacing, and modern formatting methods work better. \\ \\ | ||