Site Tools


style_guidelines

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
style_guidelines [2021/09/22 03:16]
hogwild [Text Content Guidelines]
style_guidelines [2021/11/12 13:54] (current)
djk44883 removed forced line breaks
Line 8: Line 8:
 ===== Text Content Guidelines ===== ===== Text Content Guidelines =====
  
-  * Avoid using specialized abbreviations that aren't standard \\ across the tech industry or in common English unless necessary.\\ For example, no one unfamiliar with Linux/Unix will know that "wl" \\ indicates a wireless interface. \\ However, Wi-Fi is a standard term across computing, and society \\ in general, and is therefore safe to use. +  * Many wiki readers aren't fluent in English. 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 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 itor use it only where relevant. Wi-Fi, however, is a standard term across computing, and society in general, and is safer to use. 
-  * Avoid use of the word "Note". It's overused and should be used \\ only when something is unusually important. \\ Using it constantly is like using underlining constantly, it causes the text to lose its impact, and makes it more jarring to read. We will soon decide on a standard for formatting notes, so there will be no need for this an+  * Avoid non-standard abbreviations/short forms. For example, don't use "FT" for FreshTomato. Using LAN is okay, as it's commonly known. 
-  * Avoid using underlining. Underlining is considered obsolete. It'a throwback from typewriter times+  * 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 guidelines/standards for writing and formatting notes. 
-  * Please keep with the standard formatting conventions being used for type, such as (sub)Heading levels and body text.  +  * Avoid using underlining. It'obsolete and inappropriate
-  * Standard formatting conventions include which words are capitalized and which use lower case.  +  * 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'browser-based spellchecker works well for this purpose+  * Please use a spell checker. Firefox's spellchecker works well for this. 
-  * When referring to menus, please write the text as //Menu/Submenu . //For example, //Administration/Admin access .// +  * When referring to FreshTomato'menus, please indicate as//Menu/Submenu . //  For example, //Administration/Admin access .// 
-  * Avoid using quotation marks. Most of the time, they aren'appropriate. So if you're not sure, leave them out+  * Avoid using quotation marks. They're almost never appropriate. If you're not sure, don't use them. 
-  * Please use rounded brackets () and not square brackets. Square brackets have special purposes which don't apply here.+  * Please use rounded brackets () . Square brackets are generally not appropriate here.
  
  
 ===== Layout/Formatting Guidelines ===== ===== Layout/Formatting Guidelines =====
  
-Following guidelines makes pages easier to understand, more pleasant to read, and eaiser on the brain and eyes.+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.   * 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 web interface menu paths like this: "navigate to //Administration/Admin Access//." (Use / to separate //italicized// menu nodes).   * 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}}   * Always use the standard Tomato theme when taking screenshots. \\ {{:pasted:20210921-184547.png}}
Line 30: Line 32:
   * Avoid underlining. It was considered obsolete since the 1980s.   * Avoid underlining. It was considered obsolete since the 1980s.
   * Avoid using the word “NOTE”. We are considering adding a NOTES section at the bottom of each page formatted with Heading2.   * Avoid using the word “NOTE”. We are considering adding a NOTES section at the bottom of each page formatted with Heading2.
-  * Command strings should be emboldened, like this: **ssh root@192.168.10.1**+  * Unless they are in a code window, command strings should be emboldened, like this: **ssh root@192.168.10.1**
   * Variables should be italicized.   * Variables should be italicized.
 +  * Avoid using dividing lines. Better spacing, and other formatting methods work better.
  
  
style_guidelines.1632276969.txt.gz · Last modified: 2021/09/22 03:16 by hogwild