View source for Template:Archive/doc

{{Documentation subpage}}
{{#ifeq:{{SUBPAGENAME}}|sandbox||{{High-use}}}}
{{Template shortcut|aan|AAN}}
{{Lua|Module:Archive}}

{{tlb|Archive}} adds a banner to the top of [[Help:Archiving a talk page|archive]] pages. The template suppresses section editing and the new section button on the page to discourage editors from posting comments to archived pages where they won't be seen.{{efn|Edit buttons are suppressed by emitting <code><nowiki>__NONEWSECTIONLINK__</nowiki></code> and <code><nowiki>__NOEDITSECTION__</nowiki></code> into the wikitext.}}

== Usage ==
No parameters are needed for this template to work; just place {{tlx|Archive}} near the top of each archive page.{{efn|Alternatively, if a page is using [[User:Lowercase sigmabot III]] to automatically archive the page, you can add {{para|archiveheader|<nowiki>{</nowiki><nowiki>{</nowiki>Archive<nowiki>}</nowiki><nowiki>}</nowiki>}} For details see [[User:Lowercase sigmabot III/Archive HowTo|archive header]].}} It will automatically add a row of links to navigate through numbered archive pages that are named in the standard "Archive n" format. Some ''optional'' parameters are detailed below.

All archives from <code>Archive 1</code> to <code>Archive {{var|n}}</code>, must exist consecutively. If there is a gap in numbering, where some archive pages don't exist, the template may not display the links to the higher numbered archives. The header shows the previous 3 and next 3 pages in the archives (only if they exist). The first and last navigable links intelligently search out pages 5 back or ahead and, if they do not exist, show the next nearest.

Archives must also be named in standard "Archive n" form. If they are not, you can move them to the appropriate names first; see [[Wikipedia:Moving a page]] for more information. Alternatively, you can use the {{para|prefix}} parameter to let the module know what prefix it should use.

== Optional parameters ==
* {{para|omit|banner/archives}} - Use {{para|omit|banner}} to display only the navigation bar links with no message text, or use {{para|omit|archives}} to display only the message box text with no archive links. Example: <code><nowiki>{{Archive|omit=banner}}</nowiki></code>.
* {{para|prefix|{{var|archive prefix}}}} - Manually specifies the prefix of the archive page for archives in a non-standard naming format. For example, for [[Wikipedia:Administrators' noticeboard/IncidentArchive902]], you would use {{para|prefix|IncidentArchive}}. [[List of XML and HTML character entity references|HTML entities]] are decoded for this parameter; for example, to insert a space at the end of the prefix, you can use <code>&amp;#32;</code>.
* {{para|links|{{var|n}}}} - Specifies the maximum number of links to be used. The default is 7.
* {{para|noredlinks|yes / no}} - Normally, the template does not display red links. To display the first red link after the highest archive, you can use {{para|noredlinks|no}}.
* {{para|image|none / <nowiki>[[File:Some image.svg|40px]]</nowiki>}}
* {{para|imageright|<nowiki>[[File:Some image.svg|40px]]</nowiki>}} - Use your own image, or none, as the logo in the navigation bar. Alternatively, you can place an image on the right hand side or have images on both sides.
* {{para|text|{{var|alternative message text}}}} - Replaces the header message with your own message.
* {{para|period|{{var|date range}}}} - Specifies a date range for the period covered, e.g. {{para|period|March 2006 to April 2007}}. This parameter is free-form, so you can use whatever format you like.
* {{para|style|{{var|[[CSS]] box style settings}}}}
* {{para|textstyle|{{var|CSS text style settings}}}} - Formats the box and text in any way you prefer. You may find the guidance at [[MOS:COLORCODING]] helpful.
* {{para|type|index}} - Only for manually-curated indexes, this will offer alternate blurb text. If this template is added to an index curated by a bot, it will be removed on the next update to that index.

===TemplateData===
{{Collapse top|title=[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
{{TemplateData header|noheader=1}}
<templatedata>
{
	"params": {
		"1": {
			"label": "Suppress message",
			"description": "This will suppress displaying the message within in the box, only if it's value is \"1\". Any other value will have no effect.",
			"type": "number"
		},
		"prefix": {
			"label": "Prefix",
			"description": "The prefix used instead of \"Archive\" in the expected naming system of \"Archive n\".",
			"example": "IncidentArchive",
			"type": "string"
		},
		"links": {
			"label": "Links",
			"description": "Maximum of navigation links to display below banner. Default is 7.",
			"type": "number"
		},
		"noredlinks": {
			"label": "Final red link",
			"description": "Defaults to \"yes\" and does not display a final red link. To display the first red link after the highest archive, use \"no\".",
			"type": "string"
		},
		"style": {
			"label": "Box style",
			"description": "CSS properties for the box/banner.",
			"type": "string"
		},
		"image": {
			"label": "Image",
			"description": "Use a custom image in the banner, or \"none\" for no image.",
			"type": "string"
		},
		"imageright": {
			"label": "Image right",
			"description": "Displays an image on the right side of the banner. Defaults to \"none\".",
			"type": "string"
		},
		"text": {
			"label": "Text",
			"description": "Replaces the default message in the banner.",
			"type": "string"
		},
		"period": {
			"label": "Time period",
			"description": "Specifies a covered time period to display in the banner.",
			"type": "string"
		},
		"textstyle": {
			"label": "Text style",
			"description": "CSS properties for the text style.",
			"type": "string"
		},
		"omit": {
			"label": "Omit",
			"description": "Use 'omit=banner' to display only the links with no banner, or use 'omit=archive' to display only the banner with no links to archives."
		},
        "index": {
            "label": "Index",
            "description": "Changes the blurb text for a manually-curated index pages. Do not use for bot-curated index pages."
        }
	},
	"description": "This template adds a banner to the top of archive pages.",
	"paramOrder": [
		"omit",
		"prefix",
		"links",
		"noredlinks",
		"image",
		"imageright",
		"text",
		"period",
		"style",
		"textstyle",
        "index",
		"1"
	]
}
</templatedata>
{{Collapse bottom}}

== Examples ==
Examples of archived talk pages using this template:
* [[Talk:2009 swine flu pandemic/Archive 5]] 
* [[WT:WikiProject College football/Archive 5]]

== Tracking category ==
* {{clc|Archive pages whose parent page is a redirect}} tracks pages where archive subpages weren't properly moved together with the parent page.

==Notes==
{{Notelist}}

== See also == 
*{{tl|Archives}} for including links to the talk page's archive(s) on the talk page itself.
*{{tl|Webarchive}} for linking to web archiving services such as the [[Wayback Machine]], [[WebCite]] and [[List of Web archiving initiatives|all other web archiving services]].
*{{tl|Oldid}}

{{Templates for archiving|state=expanded}}

<includeonly>{{sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Archival templates]]
[[Category:Talk header templates]]

}}</includeonly>