Site Tools


style_guidelines

Style Guidelines (Wiki Editing)

Wiki Editing Rights

To be able to edit the Wiki, you will need to get new user credentials. You can request access by sending a personal message to user “@rs232” on the Tomato Forum. Make sure to include your email address and preferred username.

Text Content Guidelines

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

  • Add a meaningful title to every wiki page. Format it with the Heading1 format.

  • 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, since that is common terminology.

  • Avoid using the word: “Note”. It's overused, and doesn't really add meaning.
    If the content isn't a critical warning, consider putting it in the
    “Notes and Troubleshooting” section at the bottom of the page.

  • Avoid underlining. Research shows it makes things hard to read.
    In terms of design/layout, it's obsolete and inappropriate.

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

  • Check spelling with your browser's spell checker.

  • When referring to FreshTomato web interface menus:
    • If there's only one menu with that name, you can indicate menu paths using just
      the name of the menu. For example, you can refer to the “Admin Access” menu.
    • If there's more than one menu with a similar name, phrase it as: /Menu/Submenu.
      For example: “/Bandwidth Monitoring/Real-Time”.
      This prevents people from confusing it with the “/IP Traffic Monitoring-Real Time” menu.

  • Avoid using quotation marks, except around filenames or numeric variables.
    They're rarely appropriate. If you're unsure, don't use them.

  • Surround filenames with double quotation marks. For example, “wg0.conf”.

  • Use rounded brackets “()” . Square brackets generally aren't appropriate and could
    be confused with code snippets or markdown language.

Layout/Formatting Guidelines

Following style guidelines makes content easier to understand, easier to read, and reduces
stress on the brain and eyes.

The wiki uses dokuwiki as its underlying software.

It uses ProseMirror as its editor.


Focus on content. Not everyone uses the same size monitor or resolution. Some people use
a mobile device to access the wiki. Different browsers and accessibility features also affect
how formatting appears (for example, with line breaks).


  • Subheadings use the Heading2 format, and subheadings below that, Heading3.

  • When taking screenshots, always use the “Tomato” theme. This is set in the Admin Access menu.


A screenshot in the Standard Tomato theme

  • Avoid quotation marks. In the context of this wiki, they should be used only:
    • When slang is used.
    • When expressing something precise, separate from the text body, such as a filesystem path.

  • Avoid underlining. It's been obsolete since the 1980s and makes text harder to read.

  • Avoid using the word “Note”. Put notes in the “<Menu name> Notes” section
    that exists at the bottom of most pages.

  • Unless they're in a code window, command strings should be set in the monospace font,
    or in a callout box.

  • Variables should be italicized to distinguish them from the main text.

  • Process/Module names should be italicized to distinguish them from the main text.

  • Avoid using dividing lines. They're obsolete. Better spacing, and modern formatting
    methods work better.

style_guidelines.txt · Last modified: 2024/09/27 23:09 by hogwild