Wiki Code Style

This page describes the suggested Code Style for contributing to the Wiki. It heavily follows the Wikipedia's Manual of Style.

Why have a Code Style?

Code Style is important for a number of reasons:

• For a page, the vast majority of its lifetime-cost goes into maintenance.
• We have many contributors working on the Wiki. Consistent code style makes shared ownership easier.
• Code Style improves the readability, allowing contributors to understand the structure quicker and better.

Headers

As shown in the official Wikipedia guide, please put a space between the header-characters `=` and the name itself:

== Chapter name ==      CORRECT

==Chapter name==        AVOID

Do not use H1 as the section header because H1 is as big as the page title:

== Main Section ==      CORRECT

= Main Section =        AVOID

Lists

As shown in the official Wikipedia guide, please put a space between the list character and the list item:

* Item 1
# Item 1     CORRECT

*Item 1
#Item 1      AVOID

Changing the Code Style

This page is intended to be a living document to be updated as the needs of the community change.

If your change to this page is considerable, it would be a good idea to discuss it with the team before applying. For instance by creating a thread in the section Forum General with the subject "Code Style Proposal: your_proposal".

After the discussion is done and you've updated this page, please inform others about it in the main wiki thread.