Fallout Wiki
Fallout Wiki
No edit summary
(transcluding section)
(48 intermediate revisions by 16 users not shown)
Line 1: Line 1:
{{Games|Wiki}}{{Wiki policies and guidelines}}{{shortcut|VA:LAY|VA:LAYOUT}}
+
{{Navbox wiki policies and guidelines}}
  +
{{shortcut|FW:LAY|FW:LAYOUT}}
   
{{policyintro|type=guideline|summary=content organization within articles, i.e. how articles should be structured as well as how standard content and sections should be named and ordered}}
+
{{policyintro|type=guideline|summary=content organization within articles, such as how articles should be structured as well as how standard content and sections should be named and ordered}}
   
 
==On structure==
 
==On structure==
One of the most important parts of wiki editing is how to structure an article. Structure dictates what information the reader reads and when he or she reads it. It can influence what people contribute, where they put it and how it is written. Good structure is likely to produce high quality articles.
+
One of the most important parts of wiki editing is how to structure an article. Structure dictates what information the reader reads and when they read it. It can influence what people contribute, where they put it and how it is written. Good structure is likely to produce high-quality articles.
   
 
Organize sections in an article in a hierarchical structure like you would an outline. Try using a shallow structure rather than a deep one. Having too many nested sections usually leads to a confusing or unreadable article.
 
Organize sections in an article in a hierarchical structure like you would an outline. Try using a shallow structure rather than a deep one. Having too many nested sections usually leads to a confusing or unreadable article.
   
 
==Section order and naming==
 
==Section order and naming==
The following table is a short overview of The Vault's standard article layout. Its purpose is to provide a quick reference for order and naming of standard layout items. This does not mean every article needs to have all of these layout items.
+
The following table is a short overview of ''Fallout'' Wiki's standard article layout. Its purpose is to provide a quick reference for the correct order and naming of standard layout items. This does not mean every article needs to have all of these layout items. A headline refers to the title of a section.
   
  +
==Examples==
* {{yes}} in the "headline" column means that the article should have a headline of that name if you want to include such a layout item.<br />{{no}} in the "headline" column means that this layout item should not have a headline.
 
  +
:{{yes}} in the "headline" column means that if you want to include such a layout item, it should have its own headline within the article.<br />
  +
:{{no}} in the "headline" column means that this layout item should not have a headline.
   
{| class="fallout-table fallout-table-align-top collapsible" style="width:100%; margin-top: 1em;"
+
{| class="va-table" style="width:100%; margin-top: 1em;"
 
! colspan="3" | '''Standard layout'''
 
! colspan="3" | '''Standard layout'''
 
|-
 
|-
 
! style="width:12em" | Layout item
 
! style="width:12em" | Layout item
! style="width:5em" | Headline
+
! style="width:5em" | Headline
 
! style="width:12em" | Explanation<section begin="topsections" />
! Explanation
 
<section begin="topsections" />
 
 
|-
 
|-
| '''Article management boxes'''
+
| '''Page management boxes'''
 
| style="text-align: center;" | {{no}}
 
| style="text-align: center;" | {{no}}
 
<includeonly>| style="text-align: center;" | {{no}}</includeonly>
 
<includeonly>| style="text-align: center;" | {{no}}</includeonly>
| Article management templates are used if you notice that something is out of order with a certain article or section and want to bring it to the attention of other editors or administrators. If the issue affects the whole article, these boxes should be placed at the very top of an article; if only a section is affected, they should be placed just below the headline of the respective section. The only exception are stub templates; see [[#Stub templates|Stub templates]] below.<br /><br />For a list of article management boxes, please refer to [[The Vault:Templates#Article management|our template overview]] or directly to [[:Category:Article management templates]].
+
| Page management templates are used if you notice that something is out of order with a certain article or section and want to bring it to the attention of other editors or administrators. If the issue affects the whole article, these boxes should be placed at the very top of an article; if only a section is affected, they should be placed just below the headline of the respective section. The only exception are [[:Category:Stub|stub]] templates.<br /><br />For a list of page management boxes, please refer to [[Fallout Wiki:Templates#Page management|template overview]] or directly to [[:Category:Page management templates]].
 
|-
 
|-
 
| '''Project tags'''
 
| '''Project tags'''
 
| style="text-align: center;" | {{no}}
 
| style="text-align: center;" | {{no}}
 
<includeonly>| style="text-align: center;" | {{no}}</includeonly>
 
<includeonly>| style="text-align: center;" | {{no}}</includeonly>
| [[The Vault:Projects|Projects]] are joint efforts of editors who work together to improve a set of articles that cover a certain area of interest. Some of these projects have tags or boxes which are placed on the pages which the project affects; these should be placed below the article management boxes.
+
| [[Fallout Wiki:Projects|Projects]] are joint efforts of editors who work together to improve a set of articles that cover a certain area of interest. Some of these projects have tags or boxes which are placed on the pages which the project affects; these should be placed below the article management boxes.
 
|-
 
|-
 
| '''"For" template'''
 
| '''"For" template'''
 
| style="text-align: center;" | {{no}}
 
| style="text-align: center;" | {{no}}
 
<includeonly>| style="text-align: center;" | {{no}}</includeonly>
 
<includeonly>| style="text-align: center;" | {{no}}</includeonly>
| {{tl|for}} is used to make a reader aware of other articles he or she may have been looking for when entering the title of the current page.
+
| {{tl|for}} is used to make a reader aware of other articles they may have been looking for when entering the title of the current page.
 
|-
 
|-
 
| '''Infobox'''
 
| '''Infobox'''
 
| style="text-align: center;" | {{no}}
 
| style="text-align: center;" | {{no}}
 
<includeonly>| style="text-align: center;" | {{yes}}</includeonly>
 
<includeonly>| style="text-align: center;" | {{yes}}</includeonly>
| The purpose of infoboxes is to summarize data relating to the article. Infoboxes should appear in the top-right corner of an article. For a list of infobox templates, please refer to [[The Vault:Templates#Infobox templates|our template overview]] or directly to [[:Category:Infobox templates]].
+
| The purpose of infoboxes is to summarize data relating to the article. Infoboxes should appear in the top-right corner of an article. For a list of infobox templates, please refer to [[Fallout Wiki:Templates#Infobox templates|template overview]] or directly to [[:Category:Infobox templates]].<section end="topsections" />
|-
 
| '''"Games" template'''
 
| style="text-align: center;" | {{no}}
 
<includeonly>| style="text-align: center;" | {{yes}}</includeonly>
 
| {{tl|Games}} should be placed just below the infobox (if there is one). It produces small icons in the top right corner of an article which allow the reader to see "at a glance" what games or sources the article relates to or is based on. The template should be used in every article; almost no exceptions exist.
 
<section end="topsections" />
 
 
|-
 
|-
 
| '''Lead section'''
 
| '''Lead section'''
 
| style="text-align: center;" | {{no}}
 
| style="text-align: center;" | {{no}}
| Articles should generally start with a lead section which is not more than a few sentences. Its purpose is to provide a short definition or overview of the article itself; after reading it, a reader should know what the article is about.<br /><br />If possible, the article title should be the subject of the first sentence; alternative titles should be mentioned in the lead section as well.
+
| Articles should generally start with a lead section which is not more than a few sentences. Its purpose is to provide a short definition or overview of the article itself; after reading it, a reader should know what the article is about.<br /><br />If possible, the article title should be the subject of the first sentence; alternative titles should be mentioned in the lead section as well. Use {{<kbd>in FO76</kbd>}} for all ''Fallout 76'' articles.
 
|-
 
|-
 
| '''Table of contents (TOC)'''
 
| '''Table of contents (TOC)'''
Line 55: Line 51:
 
| The table of contents (TOC) will automatically appear in articles with a minimum of four headings, just above the first headline. This behaviour can be changed by using <code><nowiki>__TOC__</nowiki></code> or <code><nowiki>__NOTOC__</nowiki></code>. <code><nowiki>__TOC__</nowiki></code> forces a table of contents to appear wherever it is placed in an article, no matter how many headlines the article has. <code><nowiki>__NOTOC__</nowiki></code> results in no table of contents ever being shown.
 
| The table of contents (TOC) will automatically appear in articles with a minimum of four headings, just above the first headline. This behaviour can be changed by using <code><nowiki>__TOC__</nowiki></code> or <code><nowiki>__NOTOC__</nowiki></code>. <code><nowiki>__TOC__</nowiki></code> forces a table of contents to appear wherever it is placed in an article, no matter how many headlines the article has. <code><nowiki>__NOTOC__</nowiki></code> results in no table of contents ever being shown.
 
|-
 
|-
| colspan="3" style="background: #DDD; padding-top: 1em; padding-bottom: 1em; text-align: center;"|'''Article content'''<br />For information on writing the article itself, see [[The Vault:Editing guideline|our general editing guidelines]].
+
! colspan="3" style="padding-top: 1em; padding-bottom: 1em; text-align: center;"|'''Article content'''<br />For information on writing the article itself, see [[Fallout Wiki:Editing guideline|general editing guidelines]].
 
<section begin="bottomsections" />
 
<section begin="bottomsections" />
 
|-
 
|-
Line 61: Line 57:
 
| style="text-align: center;" | {{yes}}
 
| style="text-align: center;" | {{yes}}
 
<includeonly>| style="text-align: center;" | {{no}}</includeonly>
 
<includeonly>| style="text-align: center;" | {{no}}</includeonly>
| "Behind the scenes" is the place for information relating to game development and [[cultural references]]. See [[The Vault:Content policy#Behind the scenes]] for additional information.
+
| "Behind the scenes" is the place for information relating to game development and [[cultural reference]]s. See [[Fallout Wiki:Content policy#Behind the scenes|Fallout Wiki:Content policy#Behind the scenes]] for additional information.
 
|-
 
|-
 
| '''Bugs'''
 
| '''Bugs'''
 
| style="text-align: center;" | {{yes}}
 
| style="text-align: center;" | {{yes}}
 
<includeonly>| style="text-align: center;" | {{no}}</includeonly>
 
<includeonly>| style="text-align: center;" | {{no}}</includeonly>
| Game glitches, short "bugs", relating to the article subject should be here. See [[The Vault:Content policy#Bugs]] for additional information.
+
| Game glitches or "bugs" relating to the article subject. See [[Fallout Wiki:Content policy#Bugs|bugs policy]] for additional information.
 
|-
 
|-
 
| '''Gallery'''
 
| '''Gallery'''
 
| style="text-align: center;" | {{yes}}
 
| style="text-align: center;" | {{yes}}
 
<includeonly>| style="text-align: center;" | {{no}}</includeonly>
 
<includeonly>| style="text-align: center;" | {{no}}</includeonly>
| If an article contains a lot of images, it is often better to place them in an own gallery section than to have them clutter the article. Please see [[Help:Gallery]] on how to use galleries and [[The Vault:Image and video policy#Images|our image policy]].
+
| If an article contains a lot of images, it is often better to place them in an own gallery section than to have them clutter the article. Please see [[Help:Gallery]] on how to use galleries and [[Fallout Wiki:Image policy|our image policy]].
 
|-
 
|-
 
| '''Videos'''
 
| '''Videos'''
 
| style="text-align: center;" | {{yes}}
 
| style="text-align: center;" | {{yes}}
 
<includeonly>| style="text-align: center;" | {{no}}</includeonly>
 
<includeonly>| style="text-align: center;" | {{no}}</includeonly>
| If an article contains embedded videos, they are to be placed here. See [[The Vault:Image and video policy#Videos|our video policy]] for which kind of videos are eligible to be placed in articles.
+
| If an article contains embedded videos, they are placed here. See [[Fallout Wiki:Video policy|video policy]] for which kind of videos are eligible to be placed in articles.
 
|-
 
|-
 
| '''See also'''
 
| '''See also'''
Line 86: Line 82:
 
| style="text-align: center;" | {{yes}}
 
| style="text-align: center;" | {{yes}}
 
<includeonly>| style="text-align: center;" | {{no}}</includeonly>
 
<includeonly>| style="text-align: center;" | {{no}}</includeonly>
| Links to external (i.e. off-wiki) sites which are not references should be just above "References".
+
| Links to external (off-wiki) sites which are not references should be just above "References."
 
|-
 
|-
 
| '''References'''
 
| '''References'''
 
| style="text-align: center;" | {{yes}}
 
| style="text-align: center;" | {{yes}}
 
<includeonly>| style="text-align: center;" | {{no}}</includeonly>
 
<includeonly>| style="text-align: center;" | {{no}}</includeonly>
| If [[Help:Cite|references]] have been used in an article, {{tl|references}} should be placed here.
+
| If [[Fallout Wiki:Reference formatting guideline|references]] have been used in an article, they should be placed here.
 
|-
 
|-
 
| '''Stub templates'''
 
| '''Stub templates'''
 
| style="text-align: center;" | {{no}}
 
| style="text-align: center;" | {{no}}
 
<includeonly>| style="text-align: center;" | {{no}}</includeonly>
 
<includeonly>| style="text-align: center;" | {{no}}</includeonly>
| Stub templates mark an article as being too short to provide more than rudimentary information about a subject. All stub templates can be found in [[:Category:Stub templates]], only the most specific should be used.
+
| Stub templates mark an article as being too short to provide more than rudimentary information about a subject. All stub templates can be found in [[:Category:Stub]], only the most specific should be used.
 
|-
 
|-
 
| '''Navboxes'''
 
| '''Navboxes'''
 
| style="text-align: center;" | {{no}}
 
| style="text-align: center;" | {{no}}
 
<includeonly>| style="text-align: center;" | {{no}}</includeonly>
 
<includeonly>| style="text-align: center;" | {{no}}</includeonly>
| Navboxes are navigational aids which allow easy access to other articles in a group the current article belongs to. They should be placed at the end of an article, just above the categories. The most article-specific navboxes should be highest and the least-specific lowest. <br /><br />A list of navboxes can be found in [[:Category:Navbox templates]]. New navboxes can be constructed using {{tl|Navbox}}, {{tl|Navbox group}} or {{tl|Navbox collapsible group}} depending on the amount of content or its desired organization.
+
| Navboxes are navigational aids which allow easy access to other articles in a group the current article belongs to. They should be placed at the end of an article, just above the categories. The most article-specific navboxes should be highest and the least-specific lowest. <br /><br />A list of navboxes can be found in [[:Category:Navbox templates]]. New navboxes can be constructed with {{tl|Navbox}}.
 
|-
 
|-
 
| '''Categories and interwiki links'''
 
| '''Categories and interwiki links'''
 
| style="text-align: center;" | {{no}}
 
| style="text-align: center;" | {{no}}
 
<includeonly>| style="text-align: center;" | {{yes}}</includeonly>
 
<includeonly>| style="text-align: center;" | {{yes}}</includeonly>
| Categories and [[Help:Interwiki link|interwiki links]] should be added at the very end of an article. A full list of categories can be found on [[Special:Categories]]. For additional information, please see [[The Vault:Content organization guideline#Categorization|our categorization guideline]].
+
| Categories and [[Fallout_Wiki:Help/Interwiki_links|interwiki links]] should be added at the very end of an article. A full list of categories can be found on [[Special:Categories]]. For additional information, please see [[Fallout Wiki:Content policy#Categorization|categorization guideline]].<section end="bottomsections" />
<section end="bottomsections" />
 
 
|}
 
|}
   
 
==Layouts for specific types of content==
 
==Layouts for specific types of content==
  +
* [[Fallout Wiki:Article layout guideline/Character article|Character articles]]
There are more detailed standard layouts for certain types of articles. These are:
 
* [[The Vault:Article layout guideline/Character article|Character articles]]
+
* [[Fallout Wiki:Article layout guideline/Creature article|Creature articles]]
* [[The Vault:Article layout guideline/Item article|Item articles]]
+
* [[Fallout Wiki:Article layout guideline/Item article|Item articles]]
* [[The Vault:Article layout guideline/Location article|Location articles]]
+
* [[Fallout Wiki:Article layout guideline/Location article|Location articles]]
* [[The Vault:Article layout guideline/Quest article|Quest articles]]
+
* [[Fallout Wiki:Article layout guideline/Quest article|Quest articles]]
   
 
The ordering and naming for standard sections outlined here applies to these layouts as well. They only contain more detailed instructions for the ordering of the actual article content.
 
The ordering and naming for standard sections outlined here applies to these layouts as well. They only contain more detailed instructions for the ordering of the actual article content.
Line 123: Line 118:
   
 
As an example, an article describes the various drugs which are known to exist in the ''Fallout'' universe. It has sections for ''Fallout'', ''Fallout 2'', ''Fallout Tactics'' and ''Fallout 3''. In this case, the ''Fallout'' section would come first, then the ''Fallout 2'' one, then ''Fallout 3'' and ''Fallout Tactics'' last.
 
As an example, an article describes the various drugs which are known to exist in the ''Fallout'' universe. It has sections for ''Fallout'', ''Fallout 2'', ''Fallout Tactics'' and ''Fallout 3''. In this case, the ''Fallout'' section would come first, then the ''Fallout 2'' one, then ''Fallout 3'' and ''Fallout Tactics'' last.
 
 
==See also==
 
==See also==
* [[The Vault:Content organization guideline]]
+
* [[Fallout Wiki:Editing guideline]]
* [[The Vault:Editing guideline]]
+
* [[Fallout Wiki:Content policy]]
* [[The Vault:Image and video policy]]
+
* [[Fallout Wiki:User conduct guideline]]
  +
* [[Fallout Wiki:Templates]]
  +
  +
{{transcludesection|Fallout Wiki:Policies and guidelines/Forum archive|article layout|options=nointro}}
   
[[Category:Policies and guidelines|{{PAGENAME}}]]
+
[[Category:Policies and guidelines]]

Revision as of 13:03, 7 June 2022

On structure

One of the most important parts of wiki editing is how to structure an article. Structure dictates what information the reader reads and when they read it. It can influence what people contribute, where they put it and how it is written. Good structure is likely to produce high-quality articles.

Organize sections in an article in a hierarchical structure like you would an outline. Try using a shallow structure rather than a deep one. Having too many nested sections usually leads to a confusing or unreadable article.

Section order and naming

The following table is a short overview of Fallout Wiki's standard article layout. Its purpose is to provide a quick reference for the correct order and naming of standard layout items. This does not mean every article needs to have all of these layout items. A headline refers to the title of a section.

Examples

Yes in the "headline" column means that if you want to include such a layout item, it should have its own headline within the article.
No in the "headline" column means that this layout item should not have a headline.
Standard layout
Layout item Headline Explanation
Page management boxes No Page management templates are used if you notice that something is out of order with a certain article or section and want to bring it to the attention of other editors or administrators. If the issue affects the whole article, these boxes should be placed at the very top of an article; if only a section is affected, they should be placed just below the headline of the respective section. The only exception are stub templates.

For a list of page management boxes, please refer to template overview or directly to Category:Page management templates.
Project tags No Projects are joint efforts of editors who work together to improve a set of articles that cover a certain area of interest. Some of these projects have tags or boxes which are placed on the pages which the project affects; these should be placed below the article management boxes.
"For" template No {{for}} is used to make a reader aware of other articles they may have been looking for when entering the title of the current page.
Infobox No The purpose of infoboxes is to summarize data relating to the article. Infoboxes should appear in the top-right corner of an article. For a list of infobox templates, please refer to template overview or directly to Category:Infobox templates.
Lead section No Articles should generally start with a lead section which is not more than a few sentences. Its purpose is to provide a short definition or overview of the article itself; after reading it, a reader should know what the article is about.

If possible, the article title should be the subject of the first sentence; alternative titles should be mentioned in the lead section as well. Use {{in FO76}} for all Fallout 76 articles.
Table of contents (TOC) No The table of contents (TOC) will automatically appear in articles with a minimum of four headings, just above the first headline. This behaviour can be changed by using __TOC__ or __NOTOC__. __TOC__ forces a table of contents to appear wherever it is placed in an article, no matter how many headlines the article has. __NOTOC__ results in no table of contents ever being shown.
Article content
For information on writing the article itself, see general editing guidelines.
Behind the scenes Yes "Behind the scenes" is the place for information relating to game development and cultural references. See Fallout Wiki:Content policy#Behind the scenes for additional information.
Bugs Yes Game glitches or "bugs" relating to the article subject. See bugs policy for additional information.
Gallery Yes If an article contains a lot of images, it is often better to place them in an own gallery section than to have them clutter the article. Please see Help:Gallery on how to use galleries and our image policy.
Videos Yes If an article contains embedded videos, they are placed here. See video policy for which kind of videos are eligible to be placed in articles.
See also Yes The purpose of this section is to list links to related topics on this wiki which may not have been linked within the article content.
External links Yes Links to external (off-wiki) sites which are not references should be just above "References."
References Yes If references have been used in an article, they should be placed here.
Stub templates No Stub templates mark an article as being too short to provide more than rudimentary information about a subject. All stub templates can be found in Category:Stub, only the most specific should be used.
Navboxes No Navboxes are navigational aids which allow easy access to other articles in a group the current article belongs to. They should be placed at the end of an article, just above the categories. The most article-specific navboxes should be highest and the least-specific lowest.

A list of navboxes can be found in Category:Navbox templates. New navboxes can be constructed with {{Navbox}}.
Categories and interwiki links No Categories and interwiki links should be added at the very end of an article. A full list of categories can be found on Special:Categories. For additional information, please see categorization guideline.

Layouts for specific types of content

The ordering and naming for standard sections outlined here applies to these layouts as well. They only contain more detailed instructions for the ordering of the actual article content.

Section ordering in multi-game articles

In articles whose subject spans multiple Fallout games, the sections for the various games should always be ordered by canonicity.

As an example, an article describes the various drugs which are known to exist in the Fallout universe. It has sections for Fallout, Fallout 2, Fallout Tactics and Fallout 3. In this case, the Fallout section would come first, then the Fallout 2 one, then Fallout 3 and Fallout Tactics last.

See also



Policy vote forum overview
GuidelineArticle layout guideline
Amendment 1Creature article layout · Discussion · Vote · 22 March 2011 · 8-0-0
Amendment 2Character article layout · Vote · 7 June 2011 · 20--0
Amendment 3Notable specimens · Vote · 18 June 2016 · 9-0-1