Overviewintro/doc

<noinclude>{{Documentationpage}}</noinclude>
Template for standardized intro text on overview pages.

Based on {{tl|Intro}}.

==Usage==
The only required parameters are below:
<pre>
{{overviewintro
|subject      =
|game         =
}}
</pre>

However, if the default layout is unsatisfactory, the optional parameters (with grey stars) may be used to give more control over the template.

===Parameters===
{{Docparam|name=description|req=no|default=<code>scope</code> <code>plural</code>/<code>subjects</code>|desc=
Affects the top line. Used when the page is not a list, in order to insert custom intro text between "This page" and "in <code>game</code>".
}}

{{Docparam|name=details|req=no|default=yes|desc=
Affects the first bullet point. Used when the subject is described in full (eg with subheadings) rather than listed in a table. Allows for hiding the entire bullet point (line): "The content is not described in full detail...". Can be set to "yes" or "no". 
}}

{{Docparam|name=game ++ game2|req=yes|default=|desc=
Affects the top line, as well as the second and third bullet points. Abbreviation of the game(s) this overview page is for (eg [[Fallout 2|FO2]], [[Fallout: New Vegas|FNV]], [[Fallout: Brotherhood of Steel|FOBOS]]): see {{tl|Abb}} for a full list of valid inputs.
}}

{{Docparam|name=gameoverview|req=no|default=Portal:game|desc=
Affects the third bullet point. Used when the central overview page does not match the given game. Creates a link to a specified page. Defaults to the respective [[:Category:Portals|portal]] or main game article for <code>game</code>, if not specified. 
}}

{{Docparam|name=plural|req=no|default=<code>subject</code>s|desc=
Affects the second bullet point. Only necessary if the plural of the subject is irregular (different than -s). Replaces the plural of the subject of this overview page.
}}

{{Docparam|name=scope|req=no|default=<code>all</code>|desc=
Affects the first bullet point. Used if this overview page is not a list. Describes what scope of the listed subjects is addressed.  Defaults to "all".
}}

{{Docparam|name=subject|req=yes|default=|desc=
Affects the top line, and second bullet point. Subject of this overview page (in singular). It should be similar to the title of the page (without the game title): eg the subject of '''Fallout SPECIAL''' would be <code>SPECIAL</code>.
}}

{{Docparam|name=typeoverview|req=no|default=<code>subject</code>|desc=
Affects the second bullet point. Only necessary if the subject is not the same as the central overview page for the type. Changes the overview page link at the end of the line to the parameter (e.g. "Armor and clothing" if this template was used on a game-specific armor and clothing overview page). Automatically linked.
}}