Advent of Ascension Wiki:Editing guide
The following editing guide lists rules in effect for all Advent Of Ascension Wiki articles to follow.
Advent of Ascension is a complex mod, and therefore it is important that all articles are clear and concise, so that new readers will immediately be able to understand the information being read.
If you wish to request changes to this style guide, please request them on the talk page.
- 1 What is allowed as an article
- 2 How to name an article
- 3 Redirects
- 4 Formatting
- 5 Writing
- 6 Media
- 7 Citations
- 8 Exceptions
What is allowed as an article
Generally, all articles in the main namespace must be related to Advent of Ascension, whether it be an actual in-game feature, or an article talking about the mod's history or future. Articles that document fanmade content are not allowed on the mainspace and must be limited to the userspace.
Articles in languages other than english are allowed as long as the article's title is the same as the english one with the language's special code attached to the end (e.g.: Candyland/fr).
Pages for upcoming versions should not be created, nor added to the versions template, until said version is released. Pages for upcoming features should be limited to being documented on planned features, and an article should not be made until either an official release or a public beta build (snapshot) is released. Features that were removed should be documented on removed features, for now. Unused features are to be documented solely on unused features.
How to name an article
The name of the article should be what the article is about. If the article documents in-game content, then the name of the content in-game should be used as the article's name, same casing and all. For example, Stone Bowl is excepted as an article name, because the item in-game is called "Stone Bowl", however, Stone bowl is not accepted as an article name.
If the article is going to contain information that has no in-game name, then the following procedures must take place:
- If the article is about an in-game feature that has no obvious in-game name, such as an event, or structure, then the name is taken from the mod's files, or if possible, from a cited source.
- If the article is not about something in-game, but instead about the overall history, future, or some other out of game feature relating to the mod (e.g.: Planned features), then the article can take on a conjectural name. If the article takes on a conjectural name, one must state so at the top of the article.
If several different things or ideas are merged into a single article, the article's title must relate to all of them.
Articles in a language other than english on the english wiki must be named their english name with
/<language tag> added to the end (e.g.:Chomper/de).
A redirect serves as a way to point people to the correct article that may have multiple names associated with it. All redirects on the wiki are to be relevant to the pages they point to. When creating a redirect, it must abide to the rules set forth in the above section and following section. Redirects in other languages besides english, pointing to a language page, are not preferred. Redirects that are profane/obscene are not allowed under any circumstances.
Redirects that contain different capitalization are allowed - for example: Mending table.
All headers should be written in sentence-case, where every other word following the first word starts with a lowercase letter (e.g.: This is sentence case).
When writing for a header, it is preferable if there is a space between the = signs and the words making up the header. For example:
this is preferred:
== Text ==
but this is not:
If an article name is based on the name of something in-game, it should take the exact same spelling, casing and all, when made the article title.
If the article title is not taken from the game, it should follow all of the rules provided in the Headers section above.
When writing a wiki article:
Wiki articles should be written so that they are easy to understand and follow. Articles should be structured so that new readers can find the information they need without doing too much searching, and are otherwise accessible to new readers.
For example: articles about individual weapons and armor are purposely kept on separate pages, instead of being combined into a bigger page, for new reader accessibility. The following reasons support why this is a good idea:
- If they were combined into one big page, it might make page-loading slower on some devices.
- If the weapons/armor were to be compressed into a table, then readers will have to dig through the table to find a specific piece of information.
- A table is not ideal to display all of the information necessary for a specific weapon/armor (e.g.: an armor's full set bonus may be too complex for a table).
In the case of merging two articles together, if the merged article looks too cluttered, than the articles should ideally remain split unless a solution to the clutteredness is found.
In some cases, it is okay to be redundant. For example, many editors are under the impression that since no mob drops in Advent of Ascension are affected by Looting, this information should be omitted from articles. However, not all new readers will be aware of this, and expecting them to go searching through the wiki to find it is not good practice. Therefore, Looting information should be included in articles so new readers with no experience will understand.
Articles about a similar topic should have some sort of consistency between them.
Articles should be written in sentence case. Names of a species or type of items should be written with all lowercase letters (e.g.: "diamond bowl" not "Diamond Bowl") when in the middle of a sentence and not at the beginning. If a species names consists of multiple words, only the first word should be capitalized at the beginning of a sentence.
Trivia sections are for information that does not fit into the article anywhere. Trivia sections are to only be added if the information to be put there is not place able anywhere else in the article. If one wishes to add what a particular article's content is based off of, a source must be provided with it. If a source is not provided, the information will be removed without notice. Note that the sources have to come from a mod developer, just because a particular article's content resembles something else does not make it a source.
Avoid the usage of personal pronouns (I, you, we, etc). When writing an article, try to refer to the player as 'the player' as much as possible.
Short forms and alternative names
If something has multiple names and/or shortforms, then a single name and/or shortform should be chosen to describe it consistently, preferably a name that is most commonly used, if possible. The following examples are in-effect for this wiki, which can be used as examples for future cases:
- Advent of Ascension is also known as Nevermine, Nevermine 2: Advent of Ascension, or simply AoA. For wiki purposes, all wiki articles should refer to the mod as 'Advent of Ascension' or whenever one wishes to omit the name, as 'the mod'.
- Experience should be refered to as either 'Experience' or 'XP'.
- If the word 'Level' is to be shortformed, it should be written as 'Lvl'.
When talking about the mod, refer to it as 'Advent of Ascension' or as 'the mod', but do not refer to it as 'Nevermine' or 'AoA'. New readers may not recognize other names for the mod, and potentially get confused.
The mention of other mods in mainspace articles (e.g.: suggesting to use a modded feature in a situation, comparing something to another mod, etc) is not allowed.
- The only exception is if a mod conflicts with another/produces a fatal crash (e.g.: Battlegear crashing with Quickpockets).
Other things to avoid
The following should be avoided when writing an article:
- Do not put smiley faces/emojis in articles.
- Do not use exclamation or question marks unless the in-game feature uses it.
- Avoid referring to something as "early-game","mid-game","late-game", or "end-game". These terms are ambiguous, and mean different things to different people.
All media uploaded to the wiki should be related to Advent of Ascension in some way. This includes pictures of in-game content, sound files of in-game sound effects, or teaser screenshots. Media not-related to Advent of Ascension may be quickly deleted without notice.
For consistency, all images uploaded to the wiki should be in the png or gif file format, while sounds should be in ogg or mp3 file format.
Advent of Ascension Wiki currently has no video media. As no official video media content has been produced, this means that there is no reason for a video of any kind to be implemented on a mainspace article. All videos should be exclusive to the userspace.
Information in articles that cannot be found in the game itself must cite an official source. Examples of information that must have cite a source:
- Upcoming content should cite a source when appropriate (see exception).
- Information regarding updates to the mod, such as release dates or alternate names, should have a source, especially if the information is not present in the mod itself.
- Anything stating that a part of the mod is based off something else must have a source to support it.
If information added to an article is found to be unverifiable, it may be removed without notice.
Official sources that may be cited include:
If one wishes to cite the official Minecraft Forum thread, the cite link must be obtained when the user is logged out for consistency - the link can lead to different places depending on whether the user is logged in or out.
Any information added by Scimiguy, is an exception to the above rule. Being the mod developer, Scimiguy may add information regarding upcoming content (see here for example) that has not been shown nor seen anywhere else. In this case, the above rules do not apply.
Any information previously added by Xolova is also excluded unless Scimiguy changes it.
If content in an article is found to be difficult to fit within the boundaries of this style guide, a proposal can be made to make an exception or potentially rework the style guide for the content to allow as is. Proposals should be made on the relevant article's talk page.