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
Next revisionBoth sides next revision
style_guidelines [2022/03/13 01:06] – :) djk44883style_guidelines [2023/04/22 20:48] – [Layout/Formatting Guidelines] - formatting hogwild
Line 3: Line 3:
 ===== Wiki Editing Rights ===== ===== 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 user "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.
  
  
Line 24: Line 24:
 Following style guidelines makes pages easier to understand, more pleasant to read, and easier on the brain and eyes. Following style guidelines makes pages easier to understand, more pleasant to read, and easier on the brain and eyes.
  
-Focus on content.  Not everyone will use the same size monitor or resolution. It's possible users may have mobile devices or various models of laptops to access the wiki. Users may click Toggle theme changing the entire appearance from what you see.  Different browsers and accessibility come into play as well. +Focus on content.  Not everyone will use the same size monitor or resolution. It's possible users may have mobile devices or various models of laptops to access the wiki. Users may click Toggle theme changing the entire appearance from what you see.  Different browsers and accessibility come into play as well.
  
   * 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.
Line 32: Line 32:
   * Always use the standard Tomato theme when taking screenshots. This is set in the [[admin-access|Admin Access]] menu.   * 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}} +\\ {{:pasted:20210921-184547.png|A screenshot in the Standard Tomato theme}}  \\   \\ 
- \\ + 
- \\   +  * Avoid using quotation marks except where absolutely appropriate. They are rarely appropriate, and should only be used when quoting someone/ something directly, or when slang/colloquialisms are used. 
-  * Avoid using quotation marks except where absolutely appropriate.  +  * Avoid underlining. It'been considered obsolete since the 1980s. It makes text harder to read.
-  * They are rarely appropriate, and should only be used when quoting someone/ something directly, or when slang/colloquialisms are used. +
-  * Avoid underlining. It has been considered 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.   * Avoid using the word “NOTE”. There is a section titled "<Menu name> Notes" at the bottom of most pages.
   * 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.
Line 43: Line 41:
   * Process/Module names should be italicized to set them off from the main text.    * Process/Module names should be italicized to set them off from the main text. 
   * Avoid using dividing lines. Better spacing, and other formatting methods work better.   * Avoid using dividing lines. Better spacing, and other formatting methods work better.
-  * Avoid excessive unnecessary blank lines.  These just needlessly increases page length. +
-  * If you've read this far you've noticed several points just repeat from one section to the next.  Been like this since the beginning, but this isn't as important as nit-picking and minor nonsense editing. any one notice?+
  
style_guidelines.txt · Last modified: 2023/07/16 18:10 by hogwild