FreshTomato Wiki

User Tools

Site Tools

Trace:
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 [2021/11/12 13:54] – removed forced line breaks djk44883style_guidelines [2022/02/03 16:28] – [Layout/Formatting Guidelines]-added process/module names changed code 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 @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", including your email address and preferred username.
  
  
 ===== Text Content Guidelines ===== ===== Text Content Guidelines =====
  
-  * Many wiki readers aren't fluent in English. Choose your words carefully. +  * Many wiki readers aren't fluent in English. Please choose your words carefully. 
-  * 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. +  * 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. WiFi, however, is a standard term across computing, and society in general, and is safer to use. 
-  * Avoid non-standard abbreviations/short forms. For example, don't use "FT" for FreshTomato. Using LAN is okay, as it's commonly known.+  * Avoid non-standard abbreviations/short forms. For example, don't use "FT" for FreshTomato. Using LAN is okay, as 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 guidelines/standards for writing and formatting notes.   * 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.
-  * Avoid using underlining. It's obsolete and inappropriate.+  * Avoid using underlining. It's obsolete and inappropriate. Research shows it also makes things harder to read.
   * Please view other pages to see what text is capitalized and what is written in lower case (small letters).    * 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's spellchecker works well for this.   * Please use a spell checker. Firefox's spellchecker works well for this.
Line 27: Line 27:
   * Subheadings use the Heading2 format.   * Subheadings use the Heading2 format.
   * Subheadings below that use the Heading3 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: "//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. 
-  * 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. + \\\\ {{:pasted:20210921-184547.png}} 
-  * Avoid using the word “NOTE”. We are considering adding a NOTES section at the bottom of each page formatted with Heading2. + 
-  * Unless they are in a code window, command strings should be emboldened, like this: **ssh root@192.168.10.1**+ \\ 
 + 
 +  * 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. In general, slang has no place on a technical wiki. 
 +  * Avoid underlining. It has been considered obsolete since the 1980s. 
 +  * 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.
   * Variables should be italicized.   * Variables should be italicized.
 +  * 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.
  
  
style_guidelines.txt · Last modified: 2023/07/16 18:10 by hogwild

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki