Manual of Style
From OPU Wiki
In order to try to achieve a uniform look of the manual we would like to set up a layout guide to help you towards that goal.
Useful tutorials
- Text Editing syntax in MediaWiki (http://meta.wikimedia.org/wiki/Help:Editing)
- Extended image syntax (http://en.wikipedia.org/wiki/Wikipedia:Extended_image_syntax)
- Editing Tables (http://meta.wikimedia.org/wiki/Help:Table)
What will this layout look like?
- If you make a complex layout, ALWAYS test your wiki in multiple browsers if possible!
As you can probably see I am writing this Wiki in the proposed layout format. I will discuss it below in greater detail:
| SubHeading | Each section should start with, again, a short question, or catchphrase of the text below and be enclosed by ==What am I doing?== |
| SubSubHeadings | Each lower heading should use a heading constant, Starting from H2 (==), go down to H6. Do not use bold for menu headings |
| Tables | Always use tables to show relevant data together or structure information about a given feature. Use wiki pipe style tables. That means {|, | and |-, etc. Only make really complex tables with html layout.
To make the table look nicer, you can include the Prettytable template, like so: {| {{Prettytable}} ... |
| Images | Images should mostly be centered. If you want you can give your pictures a subscript/title. You should then put the picture in a table. If you have subscripts give them meaningful descriptions and an index telling which picture it is on the current page. The following code will achieve that: <center>[[Image:Orders-3.png|center|none|frame|3. - I am a subscript!]]</center>If you have many small pictures, consider putting more of them next to eachother to have a more structured feeling. An excellent tutorial to pictures is Picture tutorial (http://en.wikipedia.org/wiki/Wikipedia:Picture_tutorial) If you don't have a subscript/caption (You should always have one!) put your picture down like below. The important part is the last '|' after center. This will make sure that when you hover over the image, it will not say center but the picture's name. [[Image:longerbridges.png|center|]] |
| Wiki Links | Put Wiki links for keywords that you feel should be explained further. Only put the Wiki link in one place. Either the first one, or the one that you think has the biggest importance in your page. For example if I talk about Non-Stop, I'd probably will want a Wiki there. But if later on I explain in a greater detail what Non-Stop is, put the link there. |
| Lists |
*list item **list item second level #numbered list item |
| Code |
Blocks of code, etc are written like this: <pre><nowiki>
printf("Hello, world!\r\n");
</pre></nowiki>
|
| Various |
|
| Redirects |
Use redirects to point from e.g. waypoints to checkpoints #REDIRECT [[checkpoints]] |
| Categories |
Please try to add new pages (and uncategorized ones) to the corresponding category. [[Category:Outpost 2]] If you are not sure what category to put a page in, just start a discussion in the Talk part of the page. |
Examples
An example of a picture with subscript (caption):
