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” on the FreshTomato Forum, including your email address and preferred username.

Text Content Guidelines

  • Some wiki readers are not fluent in English. Please, choose your words carefully.

  • Avoid abbreviations that aren't standard across the industry or in common English.
    For example, anyone unfamiliar with Linux/Unix will not know that “wl” indicates a wireless interface. If it's not standard across the industry, explain it. Using “LAN”, for example, is okay. It's common terminology.

  • Avoid the word “Note”. It's overused and rarely appropriate. If the content isn't a critical warning, consider putting it in the <WikiPageName Notes> section at the bottom of the page. We are developing guidelines/standards for writing and formatting notes.

  • Avoid underlining. It's obsolete and inappropriate. Also, research shows it makes things harder to read.

  • Please view other pages to see which types of text are capitalized and which are written in lower case.

  • Please use a spell checker. Firefox's spellchecker works well for this.

  • When referring to FreshTomato menus, please indicate as: Menu/Submenu . For example: “Administration/Admin access” .

  • Avoid using quotation marks. They're almost never appropriate. If you're unsure, don't use them.

  • Please use rounded brackets () . Square brackets are generally not appropriate here.

Layout/Formatting Guidelines

The FreshTomato wiki uses dokuwiki as its underlying software. It uses ProseMirror as its editor.

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. Some use a mobile device or laptop to access the wiki.
Different browsers and accessibility also affect how formatting appears (for example, with line breaks).

  • 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 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 quotation marks. They are rarely appropriate, and should be used only when quoting someone/ something directly, or when slang is used.

  • Avoid underlining. It's been 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. Put notes there.

  • 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 distinguish them from the main text.

  • Avoid using dividing lines. Better spacing, and other formatting methods work better.

style_guidelines.txt · Last modified: 2023/05/22 19:43 by hogwild