Differences

This shows you the differences between two versions of the page.

--- style_guidelines [2021/09/22 04:29] – [Text Content Guidelines] hogwild
+++ style_guidelines [2023/05/22 19:43] (current) – [Layout/Formatting Guidelines] -Add that wiki is based on dokuwiki ad Prosemirror, add links for both 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://www.linksysinfo.org/index.php?forums/tomato-firmware.33/|FreshTomato Forum]], including your email address and preferred username.
 ===== Text Content Guidelines =====
-  * 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 "wl" \\ indicates a wireless interface. Explain it, or use it only where relevant.\\ Wi-Fi, however, is a standard term across computing, and society \\ in general, and is safer to use.
+  * Some wiki readers are not fluent in English. Please, choose your words carefully. \\   \\
-  * Avoid non-standard abbreviations/short forms. For example, don't use "FT" \\ for FreshTomato. Using LAN is okay, as it's commonly known.
+  * Avoid abbreviations that aren't standard across the industry or in common English.   \\ For example, anyone unfamiliar with Linux/Unix will not know that "wl" indicates a wireless interface. If it's not standard across the industry, explain it. Using "LAN", for example, is okay. It's common terminology. \\ \\
-  * Avoid using the word "Note". It's overused and should be used only when \\ something is unusually important. Using it constantly makes the text \\ lose its impact, and makes it more jarring to read. We'll develop \\ some guiidelines/standards for writing and formatting notes.
+  * Avoid the word "Note". It's overused and rarely appropriate. If the content isn't a critical warning, consider putting it in the <WikiPageName Notes> section at the bottom of the page. We are developing guidelines/standards for writing and formatting notes. \\ \\
-  * Avoid using underlining. It's obsolete.
+  * Avoid underlining. It's obsolete and inappropriate. Also, research shows it makes things harder to read. \\ \\
-  * Please use the standard formatting conventions used for type, such as \\ (sub)Heading levels and body text.
+  * Please view other pages to see which types of text are capitalized and which are written in lower case. \\ \\
-  * Please keep consistent with other pages on which words are capitalized and which use lower case.
+  * Please use a spell checker. Firefox's spellchecker works well for this. \\ \\
-  * Please use a spell checker. Firefox's browser-based spellchecker works well for this purpose.
+  * When referring to FreshTomato menus, please indicate as: //Menu///Submenu// . //  For example: //"Administration///Admin access"// . //\\ \\
-  * When referring to menus, please write the text as //Menu/Submenu . //For example, //Administration/Admin access .//
+  * Avoid using quotation marks. They're almost never appropriate. If you're unsure, don't use them. \\ \\
-  * Avoid using quotation marks. Most of the time, they aren't appropriate. So if you're not sure, leave them out.
+  * Please use rounded brackets () . Square brackets are generally not appropriate here. \\ \\
-  * Please use rounded brackets () and not square brackets. Square brackets are generally not appropriate here.
 ===== Layout/Formatting Guidelines =====
-Following guidelines makes pages easier to understand, more pleasant to read, and eaiser on the brain and eyes.
+The FreshTomato wiki uses [[https://www.dokuwiki.org/dokuwiki|dokuwiki]] as its underlying software. It uses [[https://prosemirror.net/|ProseMirror]] as its editor.
-  * Add a meaningful title for each wiki page, and format it with the Heading1 format.
+Following style guidelines makes pages easier to understand, more pleasant to read, and easier on the brain and eyes.
-  * Indicate web interface menu paths like this: "navigate to //Administration/Admin Access//." (Use / to separate //italicized// menu nodes).
-  * Always use the standard Tomato theme when taking screenshots. \\ {{:pasted:20210921-184547.png}}
+Focus on content.  Not everyone will use the same size monitor or resolution. Some use a mobile device or laptop to access the wiki. \\ Different browsers and accessibility also affect how formatting appears (for example, with line breaks).
-  * Avoid using quotation marks except where absolutely appropriate. Quotation marks are rarely appropriate, and should generally only be used when quoting someone/ something directly, or when slang/colloquialisms are used.
-  * Avoid underlining. It was considered obsolete since the 1980s.
+  * Add a meaningful title for each wiki page, and format it with the Heading1 format. \\ \\
-  * Avoid using the word “NOTE”. We are considering adding a NOTES section at the bottom of each page formatted with Heading2.
+  * Subheadings use the Heading2 format. \\ \\
-  * Command strings should be emboldened, like this: **ssh root@192.168.10.1**
+  * Subheadings below that use the Heading3 format. \\ \\
-  * Variables should be italicized.
+  * Indicate web interface menu paths like this: "//Administration///Admin Access" (Use / to separate menu nodes). \\ \\
+  * Always use the standard Tomato theme when taking screenshots. This is set in the [[admin-access|Admin Access]] menu.
+\\ {{:pasted:20210921-184547.png|A screenshot in the Standard Tomato theme}}  \\   \\
+  * Avoid quotation marks. They are rarely appropriate, and should be used only when quoting someone/ something directly, or when slang is used. \\ \\
+  * Avoid underlining. It's been obsolete since the 1980s. It makes text harder to read. \\ \\
+  * Avoid using the word “NOTE”. There is a section titled: "<Menu name> Notes" at the bottom of most pages. Put notes there. \\ \\
+  * Unless they are in a code window, command strings should be set in the ''monospace'' font, or in a callout box. \\ \\
+  * Variables should be italicized. \\ \\
+  * Process/Module names should be italicized to distinguish them from the main text. \\ \\
+  * Avoid using dividing lines. Better spacing, and other formatting methods work better. \\ \\

FreshTomato Wiki

User Tools

Site Tools

Differences

Page Tools