Site Tools


This is an old revision of the document!

Style Guidelines (Wiki Edits)

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.

Text Content Guidelines

  • Avoid using specialized abbreviations that aren't standard across the tech/IT industry unless necessary.
  • For example, no one unfamiliar with Linux/Unix will know that “wl” denotes a wireless interface.
  • On the other hand, Wi-Fi is a standard term across computing, and society in general, and is therefore okay to use.
  • Avoid non-standard abbreivations/short forms. For example, don't use “FT” for FreshTomato. Using LAN is okay, as it's commonly known.
  • Avoid use of the word “Note”. It's used way too often. It should be used only when something is unusually important. Using it constantly is like using underlining constantly, it causes the text to lose its impact, and makes it more jarring to read. We will soon decide on a standard for formatting notes, so there will be no need for this an.
  • Avoid using underlining. Underlining is consider by those in the print, web and typesetting industries to be obsolete. It's a throwback to from typewriter.
  • Please keep with the standard formatting conventions being used for type, such as (sub)Heading levels and body text.
  • Please use a spell checker. Firefox's browser-based spellchecker works well for this purpose.
  • When referring to menus, please write the text as Menu/Submenu . For example, Administration/Admin access .
  • Avoid using quotation marks. Most of the time, they aren't appropriate. So if you're not sure, leave them out.
  • Please use rounded brackets () and not square brackets. Square brackets have special purposes which don't apply here.

Layout/Formatting Guidelines

  • Following guidelines makes the wiki
    • Easier to understand
    • Easier and more pleasant to read
  • Add a meaningful title for each wiki page, and format it with the Heading1 format.
  • Indicate web interface menu paths like this: “navigate to Administration/Admin Access.” (Use / to separate italicized menu nodes).
  • Use the standard Tomato theme for screenshots for consistency and ease of viewing.
  • Avoid using quotation marks except where absolutely appropriate. Quotation marks are rarely appropriate, and shoudl generally only be used when quoting someone/ something directly, or when slang/colloquialisms are used.
  • Avoid underlining. It was considered obsolete since the 1980s.
  • Avoid using the word “NOTE”. A NOTES section can be added using Heading2 at the bottom of a page.
  • Command strings should be emboldened, like this: ssh root@
style_guidelines.1632275025.txt.gz · Last modified: 2021/09/22 02:43 by hogwild