Please remove this {{Draft}}template, when you're sure the page is complete and correct.
|
Contents
Wiki Page Layout - a Guide
This is a short guide for new wiki page editors that tries to explain how a Mageia wiki page works and what ABSOLUTE MINIMAL elements are required so that it is visible to the correct user community and looks right. The language is deliberately aimed at people more used to HTML and word-processing. Like me!
Smarts
A "Smart" is any element on a page that does something automatically. The user need not know HOW it works, just that it works.
Special Tags
The special tag you'll use most is a Category tag:
[[Category:Doc]]
The wiki is configured so that if you place that tag anywhere in your markup, a link to the Doc Category index page appears automatically at the BOTTOM of your wiki page enclosed in a pretty box. Your page also automatically appears in the "Doc" index page. No extra work on your part. We use "Doc" for internal Doc Team documents, "Documentation" for general public documents and there are also several sub-categories. It is best to always use "Doc" or "Documentation" and add other Categories as required.
| Note: Whilst it is possible to place the Category tags anywhere, it is best to place them at the very top - yes, the TOP of the document, with a bit of white space before you start writing the page. This is important as it avoids the tags being accidentally deleted when the page content is edited and makes it easier to find them when you have a long wiki page. |
A short list of available Categories can be found here.
There are plenty of other Categories in use, but try to stick to the official ones. If you want a particular Category to be considered "Official", then you should contact the Doc Team Team Leader and ask.
Templates
In wiki-speak, a Template is a snippet of code that can be picked up and used in a wiki page. The Template you're most likely to want to use is the DRAFT Template.
To use this Template, which, if you follow the above link, puts a yellow box at the top of the page with a link to other draft pages you may wish to contribute to.
Simply place {{Draft}} at the top of the page and the rest is automatic.
Sample Page Header code
This is a simple sample of what the top of your wiki page should look like (assuming you're writing a document for the Doc Team (Category:Doc) and it's a Draft.
When page name and page title don't match:
[[Category:Doc]]
{{Draft}}
= Page Title =
When page name and title do match
[[Category:Doc]]
{{Draft}}
= First Paragraph =
In our wiki the name of the page automatically appears as title to the page (currently as "Wiki » Page Name"). However, if you want a (somewhat) different title, like was done for the page you're reading, then limit the use of a 1st level Paragraph "=" to the page title only. In that case, use 2nd level "==" and below for your page content instead of 1st level "=" and below. It's up to you if you use white space between the tags and the content. I do. It's just a habit and I think it looks tidier and is easier on the eye when reviewing the markup. The wiki will ignore the spaces when rendering the page.
For more information and lists of Categories and Templates used by other wiki editors, try looking at the following special pages:
Most used Categories - Try to stick to the official ones, though!
Most used Templates
The main wiki overview
ALSO: When you're editing a page, look for "Editing Help", which appears as a link next to the "Show Changes" button. It's good to have that open in another tag for reference purposes.
Have fun! simonnzg 11:04, 2 March 2012 (UTC)
There's actually no need to sign a page as it's all in the edit history, but sometimes you may wish to sign something off. Just use ~~~~ and your signature and date stamp will appear automatically on the page. It's also a convenient way to link to your own User: page which you can use to test your pages before unleashing them on the wiki.
