Help
From OXIDwiki
| View this page in:
English • Deutsch |
The OXIDforge Wiki is the main place for collecting all information relevant to the OXID developer community. It's an openly accessible Wiki where everyone can read and edit content.
Contents |
How to register
Before you can contribute, you are kindly asked to register yourself.
On top of the Wiki, there is a link titled "Log in / create account". Follow this link and click on "Create an account", where you need to supply your e-mail address and choose yourself a username. Bear in mind that the username can not be changed afterwards, so choose it wisely, as all your modifications to the wiki will be tagged with it. Entering your real name is highly recommended, but not mandatory.
Shortly thereafter, you will automatically receive an e-mail that contains a link to verify your e-mail address. Click on it to finish registration. That's it!
If you don't receive that e-mail within some hours, please check your spam folder. If that doesn't help, please contact us.
How to edit existing pages
As soon as the registration process is finished and you are logged on to the Wiki, you can edit any page by clicking on the "edit" button on top of the page. For your convenience, we have installed a rich editor that looks similar to word processing software. Simply type your text in the window and apply formattings like bold, italics and underlined. You can format paragraphs, apply colors and insert links. If you want the classical way of editing wiki entries, simply click on "Disable rich editor" and you see the article in the MediaWiki markup language.
Before saving your changes, click on "Show preview" to see how the final page will look like. If you're comfortable with your edits, save the changes and add a short summary of what you've done (like: "Inserted paragraph about LinuxTag" or "Added new names to contributor list").
Some articles like security bulletins are protected to prevent unauthorized modifications. This limitation is only in effect for very few pages. If you try to edit such a page, a notice will appear. Protections of pages can only be made by Wiki administrators.
Where can I test this out?
Before editing public Wiki pages, we strongly recommend you make yourself familiar with the editor and the Wiki interface. If you click on your username on top of the page, you will be presented with your personal page which you can edit freely just like any other user page. Consider this as your private testbed and notepad.
Your personal page can be seen like any other wiki page, so be careful on what you actually publish there.
How to create new pages
As soon as you are ready, you can also add completely new pages to the Wiki structure. Simply type in the URL of the desired page in your browser, like http://www.oxidforge.org/wiki/Templates/Spring2009. Instead of an "edit" link, you will find an item called "create" on top of the page. Click on it, and then edit the page as described in the paragraph above. After you've saved your work, it will be immediately visible to all Wiki visitors.
Uploading files
To uplad files like videos or images, click the "Upload file" link in the toolbox area on the left side of the screen. There are some limits in file size and file types you can upload, which are displayed on the page itself. As soon as a file has been uploaded to the Wiki, it will be available for linking inside articles and can be accessed by everyone.
Please note that also for file uploads, the Wiki license applies (see below).
Applying categories
To add a category, click the "[C]" button in the rich text editor and choose the desired items, or use the Category markup tag respectively. Please choose your categories wisely to prevent cluttering of the Wiki. You can see a list of existing categories at http://www.oxidforge.org/wiki/Special:Categories If in doubt, please contact us.
How to delete pages
Pages can only be deleted by Wiki administrators. If you want to request a deletion, please contact us.
Personal settings and special pages
The Wiki contains so-called "special pages" that are linked at http://www.oxidforge.org/wiki/Special:SpecialPages. Amongst them are tracking features for recent changes and newly added pages, an overview of the categories, version and extension information on the wiki software and much more.
The most interesting part, however, is the personal settings page that you can reach by clicking the link "my preferences" after you've logged on. You can configure various aspects of your profile, like time zone, e-mail address, real name, signature, date and time format and much more. This is also the right place to change your password.
Licensing information
All content in the OXIDforge Wiki is licensed under an open license called "Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License". By adding your content to the Wiki, by uploading files and videos or by modifying existing articles, you agree to make your content available under this license as well. Detailed licensing information can be found at http://creativecommons.org/licenses/by-nc-sa/3.0/.
Please ensure that you only use content you are eligible to and that is free from third-party rights.
More information
You can get detailed information beyond the scope of this short introduction at the official MediaWiki help site at http://www.mediawiki.org/wiki/Help:Contents (MediaWiki is the software that powers our wiki.)
