Difference between revisions of "BattleMaster Wiki:Article example"

From BattleMaster Wiki
Jump to navigation Jump to search
m
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Basic rules for how an article should look like. Not yet fixed rule, discuss, please.
+
{{RightTOC}}
 +
Some text that gives a basic overview of Example, including all the information that is important to those readers who want only a basic overview. No details, but make sure nothing terribly important is missing.
  
* TOC (automatically inserted by Mediawiki once the article has a certain length)
+
The Overview comes ''before'' the table of contents, but if you want a right-floating TOC like we do here, use the <nowiki>{{RightTOC}}</nowiki> template manually. Otherwise, the Wiki will automatically insert a table of contents when there are three or more sections.
* Every article starts with an overview or abstract that sums up the content in an easy-to-understand language (this could be a template, and the quickstart manual could consist of only these templates, without the full articles)
 
* every article covers its subject completely, using links to more information if necessary, so that someone going to the XYZ article can find ''everything'' about XYZ there, or at least links to it.
 
  
  
== Example ==
+
== Aspect A ==
 +
Describe one aspect of Example here, if necessary with subsections...
  
== XYZ ==
+
=== subsection ABC ===
__TOC__
+
Subsections improve structure and readability. Consider opening a new subsection for any continuing though that spans more than a few short paragraphs. Remember that more often than not the wiki will not be read like a book but like a reference and people should be able to find that piece of information they are looking for without much searching and without reading an entire article.
  
XYZ is a bla bla bla, and it is useful for bla bla bla.
 
(This would be a template, so the text has to be able to stand on its own, without the below details. That does make editing more difficult, yes. :-( )
 
  
 +
== Aspect B ==
 +
Another aspect of Example, if it is sufficiently different from Aspect A, it deserves it's own section. For example, when discussing the ruling class of a realm, every position (ruler, banker, etc.) should get his own section, while the various parts of every job have subsections.
  
== ABC ==
 
An ABC in an XYZ is bla bla bla, text, text, text
 
=== Subchapter ===
 
More details about ABC, possibly with more sub-subchapters if really necessary. Don't go too deep, there ''is'' such as thing as having too much structure.
 
  
 +
== And So On... ==
 +
Until you run out of stuff...
  
== CDE ==
+
 
bla bla bla bla
+
== See Also ==
 +
Whenever there are other places that a reader interested in additional and/or related information should be visiting, group them in this section, which should always be at the end of the article. Do repeat links here that you already have in the main article text.
 +
* Use lists
 +
* for the "see also" links
 +
* it really makes a difference
 +
 
 +
 
 +
Don't forget the categories at the bottom. Remember that an article can be in multiple categories.
 +
[[Category: Meta]]
 +
[[Category: Editors]]

Latest revision as of 20:47, 11 March 2009

Some text that gives a basic overview of Example, including all the information that is important to those readers who want only a basic overview. No details, but make sure nothing terribly important is missing.

The Overview comes before the table of contents, but if you want a right-floating TOC like we do here, use the {{RightTOC}} template manually. Otherwise, the Wiki will automatically insert a table of contents when there are three or more sections.


Aspect A

Describe one aspect of Example here, if necessary with subsections...

subsection ABC

Subsections improve structure and readability. Consider opening a new subsection for any continuing though that spans more than a few short paragraphs. Remember that more often than not the wiki will not be read like a book but like a reference and people should be able to find that piece of information they are looking for without much searching and without reading an entire article.


Aspect B

Another aspect of Example, if it is sufficiently different from Aspect A, it deserves it's own section. For example, when discussing the ruling class of a realm, every position (ruler, banker, etc.) should get his own section, while the various parts of every job have subsections.


And So On...

Until you run out of stuff...


See Also

Whenever there are other places that a reader interested in additional and/or related information should be visiting, group them in this section, which should always be at the end of the article. Do repeat links here that you already have in the main article text.

  • Use lists
  • for the "see also" links
  • it really makes a difference


Don't forget the categories at the bottom. Remember that an article can be in multiple categories.