Site Tools


Style Guidelines (Wiki Editing)

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.

Text Content Guidelines

  • There may be wiki readers not 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. 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 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 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 use a spell checker. Firefox's spellchecker works well for this.
  • When referring to FreshTomato's menus, please indicate as: Menu/Submenu . For example, Administration/Admin access .
  • Avoid using quotation marks. They're almost never appropriate. If you're not sure, don't use them.
  • Please use rounded brackets () . Square brackets are generally not appropriate here.

Layout/Formatting Guidelines

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.

  • 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: “Administration/Admin Access.” (Use / to separate italicized menu nodes).
  • Always use the standard Tomato theme when taking screenshots. This is set in the Admin Access menu.

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 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.
  • 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.
  • 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 excessive unnecessary blank lines. These just needlessly increases page length.
style_guidelines.txt · Last modified: 2022/05/01 21:28 by hogwild