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
style_guidelines [2023/07/16 18:05] – [Text Content Guidelines] -add to surround filenames with quotation marks hogwildstyle_guidelines [2023/07/16 18:10] (current) – [Layout/Formatting Guidelines] -add that variables should be italicized hogwild
Line 15: Line 15:
   * 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, except around filenames. 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 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 46: Line 46:
   * 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. \\ \\ 
   * Unless they are in a code window, command strings should be set in the ''monospace'' font, or in a callout box. \\ \\    * 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. \\ \\ +  * Variables should be //italicized to distinguish them from the main text//. \\ \\ 
   * Process/Module names should be italicized to distinguish them from the main text. \\ \\    * Process/Module names should be italicized to distinguish them from the main text. \\ \\ 
   * Avoid using dividing lines. They are mostly obsolete. Better spacing, and modern formatting methods work better. \\ \\   * Avoid using dividing lines. They are mostly obsolete. Better spacing, and modern formatting methods work better. \\ \\
  
  
style_guidelines.txt · Last modified: 2023/07/16 18:10 by hogwild