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

- Do NOT use abbreviations that aren't common/standard

in the industry.

Not everyone

e.g. “wl” does not equal wireless to anyone who

1) doesn't use Linux or

2) doesn't use open source

e.g. Don't use “FT” when not everyone will recognize it.

Anyways, the whole wiki is about FreshTomato, sot there's no need

to write “FT”.

- Avoid use of the word “Note”. It's being 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 most of its impact, and it makes it more jarring to read.

We will eventually decide on a standard for formatting

for different levels of information, warnings, etctera.

- Avoid using any underlining. Underlining is consider by those

in the print, web and type industries to be mostly obsolete. It was

appropriate when typewriters still existed, but now that we have

all the tools of digital layout/type, there's almost never a need for it.

And it makes things harder to read.

- Please keep with the standard formatting conventions being

used for type, such as (sub)Heading levels and body text. Changing things

from standard formatting makes things confusing and harder to read.

It will also make future changes to formatting more difficult and time-consuming.

- Please be careful to spell words properly, or if you just can't be bothered,

use a browser-based spellchecker, such as the one in Firefox.

There's no reason at all for spelling errors these days.

-Please, no underlining. As I mentioned upthread, underlining comes from the

typewrite age, and is now considered almost completely obsolete. Almost

any standard type of formatting works better.

- Please avoid writing “NOTE” or similar, as it's used way too often.

Better formatting (which I'm working on)Seeing

the word note is supposed to make something stand out, but when it's

used so often, it just does the opposite. Sort of like the way some people

bold constantly. I loses its effect. Eventually, better formatting will make

this obsolete anyways.

When referring to menus, we've mostly been using frontslashes.

For example,

“navigate to Administration/Admin access.”

I think this works fairly well, and is easy to read.

There's no need to use quotation marks.

- As rs232 was always reminding us, please remember to

take screenshots with the Tomato style active, so we have consistency.

Also, black screens of different resolution are sometimes really hard

to read, at least on my monitor.

Please use quotation marks only when necessary/appropriate.

Quotation marks are used for something someone said, something

that is an expression, slang and similar. They're not needed and make

no sense for common terminology. For example, the word keypair

doesn't need quotation marks, because it's a common expression

in encryption. There's no need for quotation marks 99.9% of the

time. If you're not sure, please leave them out.

- If you're not going to do much formatting, please at least

try to use Heading1 for the title so the page has a proper title on the top.

Please use rounded brackets () instead of squared brackets. They

are more appropriate, with limited exceptions that I won't discuss

here.

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.1632273070.txt.gz · Last modified: 2021/09/22 02:11 by hogwild