Difference between revisions of "BattleMaster Wiki:Style Guide"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
| − | |||
| − | |||
| − | |||
== Basics == | == Basics == | ||
| − | |||
* Use Wiki syntax wherever possible, only use HTML if necessary. | * Use Wiki syntax wherever possible, only use HTML if necessary. | ||
| − | * Use Templates | + | * Use Templates if (and only if) the same text will appear on at least two pages. |
* Most pages should be in at least one [[Special:Categories|category]], define categories ''always at the bottom of a page'' | * Most pages should be in at least one [[Special:Categories|category]], define categories ''always at the bottom of a page'' | ||
* ''Do not'' link to your personal pages from offical manual pages! The [[family|families]] page ''does not'' need links to every family in battlemaster. | * ''Do not'' link to your personal pages from offical manual pages! The [[family|families]] page ''does not'' need links to every family in battlemaster. | ||
| Line 15: | Line 11: | ||
* Links and page names should be ''plain english'' and not "CamelCase". MediaWiki does ''not'' automatically create links, you have to use the <nowiki>[[name]]</nowiki> syntax, so you can use proper titles as well. | * Links and page names should be ''plain english'' and not "CamelCase". MediaWiki does ''not'' automatically create links, you have to use the <nowiki>[[name]]</nowiki> syntax, so you can use proper titles as well. | ||
* All examples should end with the word "Example" and should be in the "Examples" category. | * All examples should end with the word "Example" and should be in the "Examples" category. | ||
| + | |||
=== Namespaces === | === Namespaces === | ||
| Line 25: | Line 22: | ||
* Meta: Stuff for the editors or people interested in contributing things. | * Meta: Stuff for the editors or people interested in contributing things. | ||
| + | |||
| + | == Article Structure Guidelines == | ||
| + | Still at [[Meta:Article Structure]], will copy that over soon. | ||
| + | |||
| + | |||
| + | == Writing Guidelines == | ||
| + | (we have not yet agreed on a writing style) | ||
| + | |||
| + | |||
| + | == Formatting Guidelines == | ||
| + | * Use wiki syntax if possible, only use HTML if it is really necessary. Don't use wiki syntax just because it looks better, consistency is more important than beauty, and improving optics via CSS is better than having it hardcoded inline. | ||
| + | * Use logical formatting - <tt><small></tt> is better than <tt><FONT SIZE=-1></tt> and the wiki double-apostrophe is better than <tt><i></tt> unless it is imperative that the text be italic and nothing else. | ||
| + | |||
| + | |||
| + | == Category Guidelines == | ||
| + | * Create a new category if there are more than 4-5 long articles belonging to a topic. Category names should be ''short'', single words if possible. | ||
| + | * Make sure there is not already a category they would fit into. | ||
| + | * Remember that articles can be in multiple categories. | ||
| + | * Categories are a ''secondary navigation layer''. They do ''not'' replace a proper navigational structure and category pages are ''not'' a replacement for a properly ordered overview or introduction page. | ||
| + | |||
| + | |||
| + | {{stub}} | ||
[[Category: Help]] | [[Category: Help]] | ||
Revision as of 15:08, 20 July 2005
Contents
Basics
- Use Wiki syntax wherever possible, only use HTML if necessary.
- Use Templates if (and only if) the same text will appear on at least two pages.
- Most pages should be in at least one category, define categories always at the bottom of a page
- Do not link to your personal pages from offical manual pages! The families page does not need links to every family in battlemaster.
Page Name Guidelines
- Avoid articles (a, an, the) in page names
- Avoid plurals. Use "Family" instead of "Families" and "Realm" instead of "Realms". Exceptions: If Battlemaster never uses the singular, use the plural. Use "Bonds" not "Bond" and "Taxes" not "Tax".
- Links and page names should be plain english and not "CamelCase". MediaWiki does not automatically create links, you have to use the [[name]] syntax, so you can use proper titles as well.
- All examples should end with the word "Example" and should be in the "Examples" category.
Namespaces
Remember that you can not define new namespaces. They syntax might make you believe you can, but "Example:XXX" only creates a page named so, it does not create an "Example" namespace. To cluster pages, use categories, not namespaces. Namespace is a meta-concept.
The namespaces we use:
- Main (or "BattleMaster Wiki") or no prefix - most pages.
- Help: For pages that help people getting around the wiki.
- Meta: Stuff for the editors or people interested in contributing things.
Article Structure Guidelines
Still at Meta:Article Structure, will copy that over soon.
Writing Guidelines
(we have not yet agreed on a writing style)
Formatting Guidelines
- Use wiki syntax if possible, only use HTML if it is really necessary. Don't use wiki syntax just because it looks better, consistency is more important than beauty, and improving optics via CSS is better than having it hardcoded inline.
- Use logical formatting - <small> is better than <FONT SIZE=-1> and the wiki double-apostrophe is better than <i> unless it is imperative that the text be italic and nothing else.
Category Guidelines
- Create a new category if there are more than 4-5 long articles belonging to a topic. Category names should be short, single words if possible.
- Make sure there is not already a category they would fit into.
- Remember that articles can be in multiple categories.
- Categories are a secondary navigation layer. They do not replace a proper navigational structure and category pages are not a replacement for a properly ordered overview or introduction page.
This article is a stub or placeholder. The BattleMaster Wiki is a collaborative effort, and you can help expand it by adding to this article.
