How To Use This Wiki
From OpenRate Community Wiki
Thank you for deciding to help the OpenRate project with our documentation!
Before you contribute, please let us lay down a few ground rules.
Adding A New Document
- Pick an appropriate name
Help us find you. :)
- Go to the uncreated page
http://www.open-rate.com/wiki/index.php/New Document (replacing 'New Document' with chosen name)
Click the Edit tab at the top to begin editing. Read about Wiki syntax here.
There are multiple categories, which yours may fit under, or may not. Check the current list for something appropriate. In order for your new document to be listed, you must at least add the documentation category inside your document, like this:
...but picking something more specific from the list will make it easier to find.
Do link in external content from reputable sources. But please follow a few rules for External Links.
Categorization is VERY important to a wiki. If your new page is not categorized, it's just floating in limbo and no one will be able to find it.
Add your page to a category by placing something like this at the end of the document:
Notice that the word "Category" is capitalized, as is the first letter in every word in a category's name.
Please follow this format when adding pages to existing categories, or creating new ones.
Look here for a list of all categories. Make sure you spell the names EXACTLY as they are in the list when you categorize a page.
Users that repeatedly create uncategorized pages will be notified of the problem.
Creating New Categories
- Go to the uncreated page
http://www.open-rate.com/wiki/index.php/Category:New Category (replacing 'New Category' with appropriate name)
- Follow steps above to create your document under the new listing.
Code and Output
If your document contains shell commands, a script, terminal output, source code, or any other similar text, the text should be placed inside a text box. A text box is created by indenting the text a few spaces. We ask that you use 8 (no more, no less) spaces to create a text box, and leave a blank line before and after the text box. Like this:
<space><space><space><space><space><space><space><space>text here <space><space><space><space><space><space><space><space>next line here
...and so forth, so that it looks like this:
text here next line here
Also, putting text in a text box formats it exactly as you type it. There is no need for an extra line between text lines for line breaks.
Paragraphs and Line Breaks
Under normal circumstances, you should create submissions as paragraphs, and not with one sentence per line.
However, sometimes that does not work.
But, if you just go to the next (following) line, the text will be reformatted as a paragraph when you submit it. If you wish to avoid this, add a line break using the tag <br/> (for "break")
Headlines, Bullets and On-page Indexes
Use headlines and bullets to create on-page indexes, making it easier for readers to find the info they want.
=Level 1 Headline= gives us this:
Level 1 Headline
Please use level 1 headlines sparingly. Most of the time, level 2 headlines are those what you want.
==Level 2 Headline== gives us this:
Level 2 Headline
===Level 3 Headline=== gives us this:
Level 3 Headline
Headlines should be used for separating large sections. For smaller important things, use bullets.
* Level 1 bullet gives us this:
- Level 1 bullet
** Level 2 bullet gives us this:
- Level 2 bullet
*** Level 3 bullet gives us this:
- Level 3 bullet
You can also (sparingly, please) use a horizontal line to separate sections that don't need text to define them. Really, they're mostly used for large layout sections.
Create a horizontal line with ---- (4 dashes), so that it looks like this.
Objectionable Content and Deleting Pages
As a general rule, please do not delete pages or their contents. But feel free to edit, correct, improve, or expand any page that is editable. That's how a wiki works.
An obvious exception to this rule are pages that may contain offensive content, such as adult images, large amounts of foul language, or blatantly hateful thoughts and ideas.
If you find such a page and it still contains useful information, first try to edit the page to remove the explicit content. If this is not the case, delete the complete text of the page, and replace it with "Text removed by <your username> due to objectionable content" and add "objectionable content" to the summary: line at the bottom of the editing page. One of the wikiops (wiki operators) will shortly come along to double-check your decision, and either remove the page entirely or restore the deleted text.
Users that post explicit content (even for the first offense) or whose entries consistently contain large amounts of foul language will be banned from creating and editing pages. Please just don't do this, it's no fun.
Making Suggestions About Locked Pages
You may have noticed that several pages, such as the Main_Page, are locked from user editing.
However, we are in no way opposed to suggestions for improving these pages.
Click on the "Discussion" tab above the article page and write your suggestion to the talkpage, please. The wikiops will read it there and either say yes or no to it.
Your User Page
Each account receives a page for personal content, as well as a "discussion" section ("talk") for conversations. If you wish, you may create a little bit of information about yourself on your user page, and append it to the People category by adding [[Category:People]] to the bottom of the page.
This section is very much like a blog. You can use it to post there whatever ideas you have. Just keep it clean, and mostly related to this documentation project. It is not a LiveJournal.
The OpenRate Wiki is NOT Wikipedia
Lastly, the OpenRate Wiki is NOT Wikipedia. Neither do we want pages about such topics as south-african yellow maned spiney tree frogs, the atomic weight of bendzium, or Queen Elizabeth, nor do we expect perfectly objective how-to guides, impersonal walkthroughs, or other. We also rather do not care about stuff like "proper MLA format" (when citing), "keeping your composition in the same tense", or any other so-called standards of writing.
The only thing we ask you for, is that you make sure that you use easily understandable English and check your spelling. Obviously intentionally misspelled words, slang, and humour are okay, as long as the idea, message, and methods in your document are well-explained and understandable.
You can post content in your submissions just like you would post a how-to in the forums. Link pictures, be emphatic, whatever. This wiki is as much about community as it is about documentation. Let people get to know you through your writings. Have fun! Linux is supposed to be about having fun with your computer, at least, that's what Linus says. Let's make documentation fun, too.
If you follow these guidelines, the OpenRate Community Wiki will be a fun and helpful place for all...