Formatting rules
From Doomtech
| Table of contents |
|
|
Overview
This document describes the formating rules used on this wiki. You should use this document as a template if you are unsure on how to format your article. If you have content that doesn't fit into the template, create your own sections and subsections. It is important that you use the headers right, because it is what mediawiki uses to create the table of contents.
The overview should contain a brief description of the article.
Errors
Errors and notices should be in a red box!
Setup
The setup of the system you describe.
Installation
The first point in the setup should be the installation.
Code examples should be in a box like this. All text in the box will be monospaced.
If you have a config file and don't want to put a space before every line manullay, you can use this regular expression in vim to let the computer to some dirty work for you.
%s/^/ /g
Numbered list
If you have a point for point list of instructions, use a numbered list.
- Do this.
- Do this and that.
- This.
- That.
- Then do this.
Bulleted list
If you have a list of things that is in no particular order, use a bulleted list.
- Something.
- Some other thing.
- Something that is related to the parent thing.
- Some other thing that is related to the parent thing.
- Something completely different.
Definitions
If you have to define words, use mediawikis built in definition style.
- Something
- This thing is very important because it is responsible for important things.
- Something else
- This isn't that important, but yet an essential part of the setup.
Links
There are two types of links used in Mediawiki.
- Internal links. The text behind the divider is what appears.
- External links. The text after the space is what appears. (http://www.google.com)
Services
The next point should be a description of each services in the system. What they do and how they are configured.
Service
A service should have it own subsection.
Resources
All the references in your article should be compiled here.
