Site Tools


style_guidelines

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

Layout/Formatting Guidelines

  • Following these guidelines makes the wiki easier to understand, and easier and more pleasant to read.
  • Add a meaningful title for each WIKI page, and format it with the Heading1 format.
  • Indicate menu paths using notation like this: “navigate to Administration/Admin Access.” (use / to separate italicized menu nodes).
  • Use the standard Tomato theme for screenshots.
  • Avoid using quotation marks except where absolutely appropriate. Quotation marks are generally only appropriate when quoting something someone said or wrote, 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@192.168.10.1
style_guidelines.1632272883.txt.gz · Last modified: 2021/09/22 02:08 by hogwild