Bandit Style Guide
From Bandit-project.org
Please adhere to the following guidelines when creating or editing articles in this Wiki.
Contents |
Article Titles
The name of your article is also its headline. Make it clear, do not use cryptic abbreviations, and do not use CamelCase. Do not repeat the title in the text with a heading. Do not create your own namespaces. Use title-style capitalization.
Headings
- Use the = (Heading) markup, not the ''' (bold) markup to create a heading. This way, the table of contents is automatically generated from the headings.
- Start with just one = and not the double ==. For example:
=heading 1= ==subheading 1.1== ==subheading 1.2== =heading 2= ==subheading 2.2== ===subheading 2.2.1=== ====subheading 2.2.1.1===
- Heading markups make it easier to get to the part people want to read and skip parts that are not interesting.
- If your text becomes too long, see if it is possible to divide it into subheadings.
- Use title-style capitalization for the headings.
Mark Up Your Text
Use the MediaWiki formatting and markup features to make your text easier to read. Set filenames and shell commands in a fixed font:
<tt>fixed font</tt>
Exploit MediaWiki's Feature Set
Do not use HTML formatting unless you absolutely have to. Using MediaWiki formatting gives articles a consistent look and feel and makes their source code easier to write, read, and edit. Have a look at the MediaWiki editing help to find out what formatting and markup tools you can use. You may also want to have a look at the source code of a few Wikipedia articles.
Comments
As a reader, use the article's discussion page for your comments. Do not clutter the article text.
As a writer, avoid highlighting that the article is incomplete and in need of further work within the article, except with the use of the {{Expand}} template.
Similarly, there is little benefit to the reader in seeing headings and tables without content.
If you want to communicate with other potential editors, make comments invisible to the ordinary article reader. To do so, enclose the text that you intend to be read only by editors within <!-- and -->.
For example, the following:
hello <!--This is a comment.--> world
is displayed as:
- hello world
So the comment can be seen when viewing the HTML or wiki source.
No Artificial Bloating
Do not create articles that do not contain at least a minimum of relevant information. The Wiki way to suggest that somebody should write an article is to create a link to it. If there are at least two links to the same nonexistent article, it appears on Wanted Pages.
