Difference between revisions of "BattleMaster Wiki:Article example"
m (Meta:Article structure moved to Meta:Article example) |
|||
| Line 1: | Line 1: | ||
| − | + | == Overview == | |
| + | 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, which means you must manually add the TOC using the "magic name" below. Alternatively we could modify the TOC so that it floats to the right. That's something we should discuss. | |
| − | |||
| − | |||
| + | __TOC__ | ||
| + | == 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. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | Don't forget the categories at the bottom. Remember that an article can be in multiple categories. | |
| − | + | [[Category: Help]] | |
| + | [[Category: Editors]] | ||
Revision as of 15:27, 20 July 2005
Overview
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, which means you must manually add the TOC using the "magic name" below. Alternatively we could modify the TOC so that it floats to the right. That's something we should discuss.
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.
Don't forget the categories at the bottom. Remember that an article can be in multiple categories.
