Guidelines for editing the CentOS Wiki

This page contains some basic guidelines for editing the Wiki. Since these guidelines are still in flux, check this page once in a while.

If you are looking for general syntax help (how to write the wiki markup language), refer to http://moinmo.in/HelpOnMoinWikiSyntax .

1. Guidelines considering Wiki markup

• Use relative links rather than absolute or free links. Relative links have the following form: [:Path:Linked text] For instance, to link the subpage "Bar" from this page, one could use: [:/Bar:This text will appear as the link]

• If your page gets long, think about adding sections to the wiki via Headings. = Title 1 =, == Title 2 == ... ===== Title 5 =====

• If your page gets really long, please add the macro [[TableOfContents]] to the top of your page. This expands to a page index for this page.

2. Guidelines considering style

• Avoid the use of the first person singular ("I", "mine" etc.) in pages, since it is of little use to the reader, and it looks a tad unprofessional. If you have to refer to yourself or someone else, refer to his/her Wiki page with contact information (or just the full name if that person does not have a page on this Wiki).

3. Guidelines considering general editing

• Put a "DRAFT" warning on pages which are under construction, so people do not think that this page is complete yet. For example "This page is still under CONSTRUCTION, Section 'foo' and section 'bar' are still missing".

4. Guidelines considering external references

• URL and links to external ( not on this wiki ) pages should be clearly marked at the bottom of the wiki page, not embedded inside the page content itself. Ideally create a 'references' section and add them all to the list there. Relevant information from these external sources should be pulled into the wiki page, depending on content licensing.

5. Guidelines considering translations

If you want to translate a page on this wiki use the following url form:

http://wiki.centos.org/$Lang/PageName

Where:

• $Lang: is a two-letters code representing the language you're going to make the translation for. (See ISO_3166-1 standard).

• PageName: is the equivalent English page name you are taking the information to translate from. That's it, just add the language code before the English page you want to translate. In this case the language code should be the first element after http://wiki.centos.org/.

---

In order to translate a page that doesn't exist yet you'll need to add the string ?action=edit at the end of the url. For example, if the page you want to translate is the Spanish version of:

• http://wiki.centos.org/HowTos/SomePage

then your url should look like:

• http://wiki.centos.org/es/HowTos/SomePage?action=edit

Please put a line at the bottom of the translated page which states which version of the original page you have translated.

6. Make yourself 'contactable'

Please assist people examining the revision history of a wiki page in finding you, so that they may suggest revisions when a page is unclear or stale. Add a Personal Homepage with (at a minimum): your WikiName, a mailto link email address, and the needed category indexing link footer:

----
CategoryHomepage

7. Adding Graphical Alerts and Admonitions

Admonitions help us to remark notes, ideas or important messages around the content. Use the following markup to build admonitions in this wiki:

Available icons to use in admonitions: