Site Tools


style_guidelines

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Last revisionBoth sides next revision
style_guidelines [2023/06/11 17:16] – [Layout/Formatting Guidelines] -Added note about 2 possibilities for expressing menu names, condense, formatting hogwildstyle_guidelines [2023/07/16 18:06] – [Text Content Guidelines] -formatting hogwild
Line 10: Line 10:
   * Some wiki readers are not fluent in English. Please, choose your words carefully. \\   \\    * 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.   \\ 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 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 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 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. \\ \\  
-  * Avoid underlining. It's obsolete and inappropriate. Also, research shows it makes things harder to read. \\ \\ +  * 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 view other pages to see which types of text are capitalized and which are written in lower case. \\ \\ 
   * Please use a spell checker. Firefox's spellchecker works well for this. \\ \\    * Please use a spell checker. Firefox's spellchecker works well for this. \\ \\ 
   * When referring to FreshTomato menus, please indicate 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. They're almost never appropriate. If you're unsure, don't use them. \\ \\ +  * Avoid using quotation marks, except around filenames. They're almost never appropriate. If you're unsure, don't use them. \\ \\   
 +  * Please surround filenames with double quotation marks. For example, "wg0.conf".  \\ \\ 
   * Please use rounded brackets () . Square brackets are generally not appropriate here. \\ \\   * Please use rounded brackets () . Square brackets are generally not appropriate here. \\ \\
  
Line 41: Line 42:
   * Avoid quotation marks. In the context of this wiki, they should be used only:   * Avoid quotation marks. In the context of this wiki, they should be used only:
     * When slang is used.     * When slang is used.
-    * When expressing, say, a filesystem path. \\ \\+    * When expressing, something precise separate from the text bodysuch as a filesystem path. \\ \\
   * Avoid underlining. It's been obsolete since the 1980s. It makes text harder to read. \\ \\    * 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 for notes. \\ \\    * Avoid using the word “NOTE”. There is a section titled: "<Menu name> Notes" at the bottom of most pages for notes. \\ \\ 
style_guidelines.txt · Last modified: 2023/07/16 18:10 by hogwild