Mapdev:WikiGuide: Difference between revisions
From Spring
Jump to navigationJump to search
m added categories |
m added more information to style etc. |
||
| Line 1: | Line 1: | ||
= Style and format guide for mapdev wiki pages = | = Style and format guide for mapdev wiki pages = | ||
== Style == | |||
use the infobox template for tips and cautions | use the infobox template for tips and cautions | ||
eg. | eg. | ||
| Line 14: | Line 15: | ||
{{Infobox|title=Caution|color=rgba(255,0,0,0.1)|icon-size=48|icon=icon-caution.png | {{Infobox|title=Caution|color=rgba(255,0,0,0.1)|icon-size=48|icon=icon-caution.png | ||
|body=blah blah blah}} | |body=blah blah blah}} | ||
== Technical Pages == | |||
the structure of a technical page should be thus: | |||
* title | |||
* short description of the pages content | |||
* pretty Images | |||
* Specification | |||
: this means the exact format for text, images, file locations, naming, etc | |||
* (optional)implementation | |||
: engine details on how its put into the game if relevant, also if there are multiple ways to use the information, most of the time i expect this section will be removed | |||
* (optional)History | |||
: relevant history as to why the feature is how it is, i expect this section to be removed in most cases | |||
* (optional)additional Information | |||
: for curiosity's sake if someone has more information on the subject they wish to add, such as with the terrain additional information regarding ROAM algorithms, etc.. i expect this section to be removed in most cases | |||
* (optional)forum discussion | |||
: forum links relating to the feature that are useful | |||
== Howto's == | |||
Should attempt to deal with one thing at a time, and not try to be a "how to make the best map ever" type thing, keep it focused on one thing, keep it neat. | |||
== Common Problems == | |||
if the description and solution to the problem can be fit into a couple of paragraphs, there is no need to make a new page for it, just chuck it under the heading on the main page. | |||
[[Category:Development]] | [[Category:Development]] | ||
[[Category:Mapdev]] | [[Category:Mapdev]] | ||
Revision as of 07:39, 14 December 2012
Style and format guide for mapdev wiki pages
Style
use the infobox template for tips and cautions
eg.
{{Infobox|title=Tip|color=rgba(255,255,0,0.1)|icon-size=48|icon=icon-tip.png
|body=blah blah blah}}
|
Tip |
|---|---|
| blah blah blah |
{{Infobox|title=Caution|color=rgba(255,0,0,0.1)|icon-size=48|icon=icon-caution.png
|body=blah blah blah}}
|
Caution |
|---|---|
| blah blah blah |
Technical Pages
the structure of a technical page should be thus:
- title
- short description of the pages content
- pretty Images
- Specification
- this means the exact format for text, images, file locations, naming, etc
- (optional)implementation
- engine details on how its put into the game if relevant, also if there are multiple ways to use the information, most of the time i expect this section will be removed
- (optional)History
- relevant history as to why the feature is how it is, i expect this section to be removed in most cases
- (optional)additional Information
- for curiosity's sake if someone has more information on the subject they wish to add, such as with the terrain additional information regarding ROAM algorithms, etc.. i expect this section to be removed in most cases
- (optional)forum discussion
- forum links relating to the feature that are useful
Howto's
Should attempt to deal with one thing at a time, and not try to be a "how to make the best map ever" type thing, keep it focused on one thing, keep it neat.
Common Problems
if the description and solution to the problem can be fit into a couple of paragraphs, there is no need to make a new page for it, just chuck it under the heading on the main page.
