MarioWiki:Navigation templates: Difference between revisions

m
no edit summary
mNo edit summary
mNo edit summary
(19 intermediate revisions by 4 users not shown)
Line 13: Line 13:
Most of the time, every relevant article can fit into a navigation template. However, sometimes random items that do not easily fit into one of the sections are left out, or in the case of RPGs, minor things like NPCs (non-playable characters) are omitted because they would make the template almost unusably large. In these cases, users must rely on categories to get to the unlisted pages. However, it should be noted that while the subjects aren't part of the templates, the templates should still be present on their articles.
Most of the time, every relevant article can fit into a navigation template. However, sometimes random items that do not easily fit into one of the sections are left out, or in the case of RPGs, minor things like NPCs (non-playable characters) are omitted because they would make the template almost unusably large. In these cases, users must rely on categories to get to the unlisted pages. However, it should be noted that while the subjects aren't part of the templates, the templates should still be present on their articles.


Another situation is when one or more of the subjects has been taken out of the main game template and given their own template. For example, {{tem|NSMB2 Levels}} and {{tem|MPDS Minigames}} are separate from the main {{tem|NSMB2}} and {{tem|MPDS}} templates, respectively. This partitioning should generally be avoided except for levels, and other cases where including the subject would greatly increase the size of the template, as in the case of ''Mario Party'' series minigames (which are too major and require too much organization to simply put in categories like NPCs). These auxiliary game-specific templates only need to go on the articles of subjects that concern them (e.g. the ''NSMB2'' level articles) and the game page itself. Like the main game-specific templates, auxiliary templates are color-coded based on series.
Another situation is when one or more of the subjects has been taken out of the main game template and given their own template. For example, {{tem|NSMB2 levels}} and {{tem|MPDS minigames}} are separate from the main {{tem|NSMB2}} and {{tem|MPDS}} templates, respectively. This partitioning should generally be avoided except for levels, and other cases where including the subject would greatly increase the size of the template, as in the case of ''Mario Party'' series minigames (which are too major and require too much organization to simply put in categories like NPCs). These auxiliary game-specific templates only need to go on the articles of subjects that concern them (e.g. the ''NSMB2'' level articles), without the main template; and the game page itself. Like the main game-specific templates, auxiliary templates are color-coded based on series.


===Series-wide templates===
===Series-wide templates===
There are two types of series-wide templates, both of which are color-coded like the game templates. The first type simply lists all the games in a series, usually subdivided into sub-series, such as in {{tem|WarioGames}}. Non-game series can also have templates, such as {{tem|Club Nintendo}}, which lists the comics by year. Console-based templates like {{tem|SNES}}, {{tem|Consoles}} and {{tem|Game & Watch}} (which is both console- and series-based) are also considered to be series-specific templates.
There are two types of series-wide templates, both of which are color-coded like the game templates. The first type simply lists all the games in a franchise, usually subdivided into series, such as in {{tem|Wario games}}. Non-game series can also have templates, such as {{tem|Club Nintendo}}, which lists the comics by year. Console-based templates like {{tem|SNES}}, {{tem|Systems}} and {{tem|Game & Watch}} are also considered to be series-specific templates.


The second type is similar to the auxiliary game-specific templates in that it focuses on a single subject, but as its name suggests, follows it all across a series, rather than within a single game. These types of templates are highly discouraged except in cases where listing them apart from the game templates would help streamline navigation. For example, {{tem|MK Race Courses}} lists all the ''Mario Kart'' racecourses by game, but does not re-list courses when they reappear in later titles, whereas the game-specific templates do re-list retro courses; this means the at-a-glance list of racecourses is more compact than a simple assemblage of the game-specific templates' lists. It is also quite likely that readers will want to browse the courses across the entire spin-off series, whereas something more specialized like the Karts do not need a series-wide template. Please note that even in cases where a series-wide template is used, this should not be a substitute for a corresponding section in the game-specific templates: as mentioned before, the specific ''Mario Kart'' game templates also listed the courses (i.e. {{tem|MK64}}). Series-wide templates should not be created to replace game-specific templates: they should merely be supplemental templates. The only exception is when a subject is so numerous and minor, it would not be included in a game-specific template, and would likely only be given a category, in which case, the series-wide template would be standing in as an auxiliary game-specific template in itself, and provide sufficient organization for the minor subject. {{tem|Recipes}} is an example of this.
The second type is similar to the auxiliary game-specific templates in that it focuses on a single subject, but as its name suggests, follows it all across a series, rather than within a single game. These types of templates are highly discouraged except in cases where listing them apart from the game templates would help streamline navigation. For example, {{tem|MK race courses}} lists all the ''Mario Kart'' racecourses by game, but does not re-list courses when they reappear in later titles, whereas the game-specific templates do re-list retro courses; this means the at-a-glance list of racecourses is more compact than a simple assemblage of the game-specific templates' lists. It is also quite likely that readers will want to browse the courses across the entire spin-off series, whereas something more specialized like the Karts do not need a series-wide template. Please note that even in cases where a series-wide template is used, this should not be a substitute for a corresponding section in the game-specific templates: as mentioned before, the specific ''Mario Kart'' game templates also listed the courses (i.e. {{tem|MK64}}). Series-wide templates should not be created to replace game-specific templates: they should merely be supplemental templates. The only exception is when a subject is so numerous and minor, it would not be included in a game-specific template, and would likely only be given a category, in which case, the series-wide template would be standing in as an auxiliary game-specific template in itself, and provide sufficient organization for the minor subject. {{tem|Recipes}} is an example of this.


===Species templates===
===Species templates===
Species templates organize subjects based on what they are, rather than what game they come from. Most of these templates are built around a group of related species, listing all the species and characters within that group, as in {{tem|Koopa Troopas}}. Generally, differentiating between the species and the characters is all the subdivision that is found in these templates, although there are exceptions, such as {{tem|Humans}}, where separating major series and alternate media is necessary for navigating the large list. As they are not game- or series-based, species templates are not bound by the same color-coding setup as the other two types of templates, and should instead be given colors befitting of their subject matter (i.e. brown for {{tem|Monty Moles}} and yellow for {{tem|Pokeys}}).
Species templates organize subjects based on what they are, rather than what game they come from. Most of these templates are built around a group of related species, listing all the species and characters within that group, as in {{tem|Koopa Troopas}}. Generally, differentiating between the species and the characters is all the subdivision that is found in these templates, although there are exceptions, such as {{tem|Humans}}, where separating major series and alternate media is necessary for navigating the large list. As they are not game- or series-based, species templates are not bound by the same color-coding setup as the other two types of templates, and should instead be given colors befitting of their subject matter (i.e. brown for {{tem|Monty Moles}} and yellow for {{tem|Pokeys}}).


While species make up the vast majority of this final type of template, there are a few cases where other, non-species-based notable or complex subjects are granted these templates. Basically, if a template is not a game-specific or series-wide template, it is a species template, in structure if not in name. For example, {{tem|Mario family}} is about Mario's family, yet it is designed like the humans category, with the game and alternate media characters separated. {{tem|Earth}} is another example of a non-species "species" template. Generally, these templates should provide some level of organization, and templates that are merely categories in template form, without any subdivisions, will usually be deleted. However, sometimes major subjects (items or objects) will be granted templates in order to bring them more attention than categories alone would, effectively doing for them what proper species templates do for characters and enemies. This is the reason for the existence of {{tem|Blocks}} and {{tem|Mushrooms}} (while the latter is now divided into mushrooms and mushroom recipes, it started out as a simple category-template).
While species make up the vast majority of this final type of template, there are a few cases where other, non-species-based notable or complex subjects are granted these templates. Basically, if a template is not a game-specific or series-wide template, it is a species template, in structure if not in name. For example, {{tem|Mario and Luigi's family}} is about Mario's family, yet it is designed like the humans category, with the game and alternate media characters separated. {{tem|Earth}} is another example of a non-species "species" template. Generally, these templates should provide some level of organization, and templates that are merely categories in template form, without any subdivisions, will usually be deleted. However, sometimes major subjects (items or objects) will be granted templates in order to bring them more attention than categories alone would, effectively doing for them what proper species templates do for characters and enemies. This is the reason for the existence of {{tem|Blocks}} and {{tem|Mushrooms}} (while the latter is now divided into mushrooms and mushroom recipes, it started out as a simple category-template).


For the most part, however, major subjects that deserve templates have already been given templates, and users should carefully assess the situation before creating more. This applies to species as well as miscellaneous subjects: if a group of species only has a few members, a template might be excessive, especially if it is only a minor assortment of species and characters. Conversely, very loose (and often large) groupings such as [[:Category:Fish|fish]] or [[:Category:Undead|undead]] should be saved for categories, not templates, as the need for such templates is far less than for specific species groupings like {{tem|Koopas}} or {{tem|Thwomps}}, and creating too many overlapping templates can clutter up pages.
For the most part, however, major subjects that deserve templates have already been given templates, and users should carefully assess the situation before creating more. This applies to species as well as miscellaneous subjects: if a group of species only has a few members, a template might be excessive, especially if it is only a minor assortment of species and characters. Conversely, very loose (and often large) groupings such as [[:Category:Fish|fish]] or [[:Category:Undead|undead]] should be saved for categories, not templates, as the need for such templates is far less than for specific species groupings like {{tem|Koopas}} or {{tem|Thwomps}}, and creating too many overlapping templates can clutter up pages.
Line 35: Line 35:


===Listing the links===
===Listing the links===
The lists of links should be grouped in a way that makes finding entries simple; generally this means alphabetical order should be used, however worlds and levels should be sequential, and characters are usually arranged by descending order of importance (i.e. Mario first, followed by Luigi, then Peach, then Bowser, etc.). Places and bosses can be organized alphabetically, like in {{tem|Super Mario RPG}}, or sequentially like in {{tem|SPM}}, depending on what makes sense given the structure of the game (i.e. do the places correspond to the levels?), the length of the sections (longer lists are better served by alphabetical order), and the personal taste of whoever made the template. If a high level of organization is needed, many templates make liberal use of subheaders, creating many small lists rather than a few big ones, such as {{tem|M&LBIS}}. Other templates use symbols to denote specific subjects in a list, such as {{tem|SM64}}'s use of asterisks to mark ''SM64DS''-exclusive content. {{tem|M&SATOWG}} uses both subheaders and symbols to help organize its content, whereas {{tem|SPP}} uses different types of dividers to group vibe-infused enemies with their regular counterparts which provides the overall alphabetical order. Some templates even color-code their lists, such as {{tem|Yoshis}}, although this is more about aesthetic appeal than organization.
The lists of links should be grouped in a way that makes finding entries simple; generally this means alphabetical order should be used, however worlds and levels should be sequential, and characters are usually arranged by descending order of importance (i.e. Mario first, followed by Luigi, then Peach, then Bowser, etc.). Places and bosses can be organized alphabetically, like in {{tem|SMRPG}}, or sequentially like in {{tem|SPM}}, depending on what makes sense given the structure of the game (i.e. do the places correspond to the levels?), the length of the sections (longer lists are better served by alphabetical order), and the personal taste of whoever made the template. If a high level of organization is needed, many templates make liberal use of subheaders, creating many small lists rather than a few big ones, such as {{tem|M&LBIS}}. Other templates use symbols to denote specific subjects in a list, such as {{tem|SM64}}'s use of asterisks to mark ''SM64DS''-exclusive content. {{tem|M&SATOWG}} uses both subheaders and symbols to help organize its content, whereas {{tem|SPP}} uses different types of dividers to group vibe-infused enemies with their regular counterparts which provides the overall alphabetical order. Some templates even color-code their lists, such as {{tem|Yoshis}}, although this is more about aesthetic appeal than organization.


===Headers===
===Headers===
Line 42: Line 42:
Both styles have their pros and cons when it comes to functionality, but while horizontal headers used to be the only method used by the Super Mario Wiki, vertical headers have become the more common choice. This is mainly because they take up less space than horizontal bars, resulting in more compact templates. Unlike horizontal headers, they also lend themselves to header-subheader formatting, with subheaders nested within the column of headers, like in {{tem|LM}}.
Both styles have their pros and cons when it comes to functionality, but while horizontal headers used to be the only method used by the Super Mario Wiki, vertical headers have become the more common choice. This is mainly because they take up less space than horizontal bars, resulting in more compact templates. Unlike horizontal headers, they also lend themselves to header-subheader formatting, with subheaders nested within the column of headers, like in {{tem|LM}}.


Horizontal headers generally only appear in complex templates that require an extra level of structure beyond the regular two-tier header-subheader system, such as {{tem|quotes}}, which uses one to separate the two different sets of pages it covers. Very large templates like {{tem|galleries}} can also use the show/hide function made possible with horizontal headers to collapse individual sections and makes the overall template more manageable. Finally, as seen in the aforementioned {{tem|SM64}} and {{tem|M&SATOWG}}, horizontal headers can be repurposed to create unique footnote sections in which symbol legends or comments can be placed.
Horizontal headers generally only appear in complex templates that require an extra level of structure beyond the regular two-tier header-subheader system, such as {{tem|Quotes}}, which uses one to separate the two different sets of pages it covers. Very large templates like {{tem|Galleries}} can also use the show/hide function made possible with horizontal headers to collapse individual sections and makes the overall template more manageable. Finally, as seen in the aforementioned {{tem|SM64}} and {{tem|M&SATOWG}}, horizontal headers can be repurposed to create unique footnote sections in which symbol legends or comments can be placed.


===Coloration===
===Coloration===
{| border="0" style="float:right;text-align:center;margin: 0 1em 0.3em 1em;" cellpadding="2px" cellpadding="2px" width="280px"
{| border="0" style="float:right;text-align:center;margin: 0 1em 0.3em 1em;" cellpadding="2px" cellpadding="2px" width="280px"
|-
!colspan=1 bgcolor=#D4D4D4| Series
!colspan=1 bgcolor=#D4D4D4| Series
!colspan=1 bgcolor=#D4D4D4| Footer color
!colspan=1 bgcolor=#D4D4D4| Footer color
Line 76: Line 75:
|bgcolor=#E9E9E9|Consoles
|bgcolor=#E9E9E9|Consoles
|bgcolor=#C5C5C5|#C5C5C5
|bgcolor=#C5C5C5|#C5C5C5
|-
|}
|}
Series-wide and game-specific templates are color-coded by series. When designing a new template, specify which of the predefined color schemes to use by adding the relevant class (listed in the chart below) to the template code. For example, the first line of {{tem|SMB}} would be <code><nowiki>{| class="mw-collapsible mw-collapsed navbox mario"</nowiki></code>, while {{tem|LM}} would have the class of <code><nowiki>"navbox lm"</nowiki></code>, {{tem|DKC}} would have the <code><nowiki>"navbox dk"</nowiki></code>, etc. These classes automatically color the alternating background stripes, however the banner and header colors need to be added manually using the color codes in the chart and the format: <code><nowiki>style=background:#FF2400</nowiki></code> (using the "Super Mario" banner color as an example). If no color is specified, the banner and headers will receive default grey tones. Please note that the code <code><nowiki>bgcolor=#FF2400</nowiki></code> will not override the default colors.
Series-wide and game-specific templates are color-coded by series. When designing a new template, specify which of the predefined color schemes to use by adding the relevant class (listed in the chart below) to the template code. For example, the first line of {{tem|SMB}} would be <code><nowiki>{| class="mw-collapsible mw-collapsed navbox mario"</nowiki></code>, while {{tem|LM}} would have the class of <code><nowiki>"navbox lm"</nowiki></code>, {{tem|DKC}} would have the <code><nowiki>"navbox dk"</nowiki></code>, etc. These classes automatically color the alternating background stripes, however the banner and header colors need to be added manually using the color codes in the chart and the format: <code><nowiki>style=background:#FF2400</nowiki></code> (using the "Super Mario" banner color as an example). If no color is specified, the banner and headers will receive default grey tones. Please note that the code <code><nowiki>bgcolor=#FF2400</nowiki></code> will not override the default colors.


Line 93: Line 92:
!colspan=1 width="10%"| Class name
!colspan=1 width="10%"| Class name
|-bgcolor=#E9E9E9
|-bgcolor=#E9E9E9
|colspan=2|Super Princess Peach
|colspan=2|Peach games
|bgcolor=#FF3EAF|#FF3EAF
|bgcolor=#FF3EAF|#FF3EAF
|bgcolor=#FF90D0 colspan=2|#FF90D0
|bgcolor=#FF90D0 colspan=2|#FF90D0
|bgcolor=pink|<font color=blue>pink</font>
|bgcolor=pink|<font color=blue>pink</font>
|bgcolor=mistyrose|<font color=blue>mistyrose</font>
|bgcolor=mistyrose|<font color=blue>mistyrose</font>
|bgcolor=#F9F9F9|<code>spp</code>
|bgcolor=#F9F9F9|<code>peach</code>
|-bgcolor=#E9E9E9
|-bgcolor=#E9E9E9
|rowspan=3|Wario||width="23%"|Wario Land
|rowspan=3|Wario||width="23%"|Wario Land
Line 117: Line 116:
|bgcolor=orchid colspan=2|orchid
|bgcolor=orchid colspan=2|orchid
|-bgcolor=#E9E9E9
|-bgcolor=#E9E9E9
|rowspan=3|Mario||general/misc
|rowspan=2|Mario||general/misc
|bgcolor=#CC0000|<font color=white>#CC0000</font>
|bgcolor=#CC0000|<font color=white>#CC0000</font>
|bgcolor=#FF4433|#FF4433
|bgcolor=#FF4433|#FF4433
|bgcolor=coral|coral
|bgcolor=coral|coral
|bgcolor=bisque rowspan=3|<font color=blue>bisque</font>
|bgcolor=bisque rowspan=2|<font color=blue>bisque</font>
|bgcolor=#FFF5EE rowspan=3|<font color=blue>#FFF5EE</font>
|bgcolor=#FFF5EE rowspan=2|<font color=blue>#FFF5EE</font>
|bgcolor=#F9F9F9 rowspan=2|<code>mario</code>
|bgcolor=#F9F9F9 rowspan=2|<code>mario</code>
|-bgcolor=#E9E9E9
|-bgcolor=#E9E9E9
Line 129: Line 128:
|bgcolor=#FF7733|#FF7733
|bgcolor=#FF7733|#FF7733
|bgcolor=#FFAA50|#FFAA50
|bgcolor=#FFAA50|#FFAA50
|-bgcolor=#E9E9E9
|Super Mario Land
|bgcolor=darkorange|darkorange
|bgcolor=orange colspan=2|orange
|bgcolor=#F9F9F9|<code>mario-sml</code>
|-bgcolor=#E9E9E9
|-bgcolor=#E9E9E9
|rowspan=4|Donkey Kong||Mario vs. Donkey Kong
|rowspan=4|Donkey Kong||Mario vs. Donkey Kong
Line 268: Line 262:


==Order on pages==
==Order on pages==
In most articles, species templates should come first, followed by game-specific and series-wide templates, which are arranged in pure chronological order. This means that rather than being grouped into series, games will be listed separately according to their individual release dates, with their coloration being used to find all the members of a given series. Subject-based series-wide templates (the second type, like {{tem|MK Race Courses}}) will be placed directly under the first game template from that series. Auxiliary game-specific templates should come after the main game template. Above the game- and series-based templates, any family templates (i.e. {{tem|Mario family}} and {{tem|Koopa}}) should come first, followed by the actual species template, and then any other non-species-based species templates, in order of decreasing importance. Usually, however, only the actual species template (or the equivalent item- or place-based template) will be present.
In most articles, species templates should come first, followed by game-specific and series-wide templates, which are arranged in pure chronological order. This means that rather than being grouped into series, games will be listed separately according to their individual release dates, with their coloration being used to find all the members of a given series. Subject-based series-wide templates (the second type, like {{tem|MK race courses}}) will be placed directly under the first game template from that series. Auxiliary game-specific templates should come after the main game template. Above the game- and series-based templates, any family templates (i.e. {{tem|Mario and Luigi's family}} and {{tem|Bowser's family}}) should come first, followed by the actual species template, and then any other non-species-based species templates, in order of decreasing importance. Usually, however, only the actual species template (or the equivalent item- or place-based template) will be present.


While that is the order for most subjects' articles, games and series are slightly different. Games should have their game-specific template come first, followed by the overall series-wide template (the first type, like {{tem|DK games}}), and then the console-based templates, such as {{tem|SNES}} or {{tem|VirtualConsole}}. Series pages should simply have their corresponding series-wide template.
While that is the order for most subjects' articles, games and series are slightly different. Games should have their game-specific template come first, followed by the overall series-wide template (the first type, like {{tem|Donkey Kong games}}), and then the console-based templates, such as {{tem|SNES}} or {{tem|Virtual Console}}. Series pages should simply have their corresponding series-wide template.


Additionally, there are a number of specialized classes of pages, most of which have (or will eventually have) corresponding navigation templates. They are as follows:
Additionally, there are a number of specialized classes of pages, most of which have (or will eventually have) corresponding navigation templates. They are as follows:
*Galleries should all contain {{tem|galleries}}
*Galleries should all have {{tem|Galleries}}
*"List of ... quotes" pages should have {{tem|quotes}}
*"List of ... quotes" pages should have {{tem|Quotes}}
*"List of ... glitches" pages should have {{tem|glitches}}
*"List of ... glitches" pages should have {{tem|Glitches}}
*"List of ... media" pages should have {{tem|media nav}}
*"List of ... media" pages should have {{tem|Media nav}}
*"List of ... in-game music" pages should have {{tem|in-game music}}
*"List of ... in-game music" pages should have {{tem|In-game music}}
*"List of ... profiles and statistics" pages should have {{tem|profiles and statistics}}
*"List of ... profiles and statistics" pages should have {{tem|Profiles and statistics}}
*"List of ... pre-release and unused content" pages should have {{tem|pre-release and unused content}}
*"List of ... pre-release and unused content" pages should have {{tem|Pre-release and unused content}}
*The references pages should all have {{tem|references}}
*"List of ... names in other languages" pages should have {{tem|Names in other languages}}
*Game bestiaries should have {{tem|bestiaries}}
*The references and culture lists should all have {{tem|Culture}}
*Staff pages should have {{tem|staff}}
*Game bestiaries should have {{tem|Bestiaries}}
*Staff pages should have {{tem|Staff}}


Finally, only mainspace articles can have navigation templates. Categories, other templates, Help pages, MarioWiki pages, user pages, talk pages and PipeProject pages should not have nav templates. While The 'Shroom has templates it uses for internal navigation, these should not be categorized as actual nav templates.
Finally, only mainspace articles can have navigation templates. Categories, other templates, Help pages, MarioWiki pages, user pages, talk pages and PipeProject pages should not have nav templates. While The 'Shroom has templates it uses for internal navigation, these should not be categorized as actual nav templates.
Line 296: Line 291:


{{MarioWiki}}
{{MarioWiki}}
{{Shortcut|MW:NAV}}
{{Shortcut|SMW:NAV}}
[[Category:Writing guidelines]]
[[Category:Writing guidelines]]