This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
style_guidelines [2021/09/22 02:11] – [Text Content Guidelines]-Added text content guidelines hogwild | style_guidelines [2023/07/16 18:10] (current) – [Layout/Formatting Guidelines] -add that variables should be italicized hogwild | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Style Guidelines (Wiki Edits) ====== | + | ====== 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 " | ||
- | 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 ===== | ===== Text Content Guidelines ===== | ||
- | - Do NOT use abbreviations that aren't common/ | + | * Some wiki readers are not fluent in English. Please, choose your words carefully. \\ \\ |
+ | * Avoid abbreviations that aren' | ||
+ | * Avoid the word " | ||
+ | * Avoid underlining. It's obsolete and inappropriate. 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' | ||
+ | * When referring to FreshTomato menus, please indicate as: // | ||
+ | * Avoid using quotation marks, except around filenames. They' | ||
+ | * Please surround filenames with double quotation marks. For example, " | ||
+ | * Please use rounded brackets () . Square brackets are generally not appropriate here. \\ \\ | ||
- | in the industry. | ||
- | Not everyone | + | ===== Layout/ |
- | e.g. " | + | Following style guidelines makes pages easier |
- | 1) doesn' | + | The FreshTomato wiki uses [[https:// |
- | 2) doesn' | + | Focus on content. |
- | e.g. Don't use " | + | \\ |
- | Anyways, the whole wiki is about FreshTomato, sot there's no need | + | * Add a meaningful title to each wiki page. Format it with the Heading1 format. \\ \\ |
+ | * Subheadings use the Heading2 format. \\ \\ | ||
+ | * Subheadings below that use the Heading3 format. \\ \\ | ||
+ | * Indicate web interface menu paths using the name of the menu, unless | ||
+ | * For example, you can refer to the Admin Access menu. However... | ||
+ | * You should add a "/" | ||
+ | * Always use the " | ||
- | to write " | + | \\ {{: |
- | + | ||
- | - Avoid use of the word " | + | |
- | + | ||
- | 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, | + | |
- | + | ||
- | - 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/ | + | |
- | + | ||
- | 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, | + | |
- | + | ||
- | There' | + | |
- | + | ||
- | -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 " | + | |
- | + | ||
- | 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, | + | |
- | + | ||
- | " | + | |
- | + | ||
- | I think this works fairly well, and is easy to read. | + | |
- | + | ||
- | There' | + | |
- | + | ||
- | - As rs232 was always reminding us, please remember to | + | |
- | + | ||
- | take screenshots with the Tomato | + | |
- | + | ||
- | Also, black screens of different resolution are sometimes really hard | + | |
- | + | ||
- | to read, at least on my monitor. | + | |
- | + | ||
- | Please use quotation marks only when necessary/ | + | |
- | + | ||
- | Quotation marks are used for something someone said, something | + | |
- | + | ||
- | that is an expression, slang and similar. They' | + | |
- | + | ||
- | no sense for common terminology. For example, the word keypair | + | |
- | + | ||
- | doesn' | + | |
- | + | ||
- | in encryption. There' | + | |
- | + | ||
- | 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, | + | |
- | + | ||
- | here. | + | |
- | + | ||
- | + | ||
- | ===== Layout/ | + | |
- | * Following these guidelines makes the wiki easier to understand, and easier and more pleasant to read.\\ | + | * Avoid quotation marks. In the context of this wiki, they should be used only: |
- | * Add a meaningful title for each WIKI page, and format it with the Heading1 format. | + | * When slang is used. |
- | * Indicate menu paths using notation like this: " | + | * When expressing, |
- | * Use the standard Tomato theme for screenshots. | + | * Avoid underlining. It's been obsolete since the 1980s. |
- | * {{: | + | * Avoid using the word “NOTE”. |
- | * Avoid using quotation marks except where absolutely appropriate. Quotation marks are generally only appropriate when quoting | + | * Unless they are in a code window, command |
- | * Avoid underlining. It was considered | + | |
- | * Avoid using the word “NOTE”. | + | |
- | * Command | + | * Avoid using dividing lines. They are mostly obsolete. Better spacing, and modern formatting methods work better. \\ \\ |
- | * | + | |