((Archive)) adds a banner to the top of 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.[a]

Usage

[edit]

No parameters are needed for this template to work; just place ((Archive)) near the top of each archive page.[b] 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 Archive 1 to Archive n, 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 |prefix= parameter to let the module know what prefix it should use.

Optional parameters

[edit]

TemplateData

[edit]
TemplateData documentation used by VisualEditor and other tools
See a monthly parameter usage report for Template:Archive in articles based on its TemplateData.

TemplateData for Archive

This templates adds a banner to the top of archive pages.

Template parameters

ParameterDescriptionTypeStatus
Suppress message1

This will suppress displaying the message within in the box, only if it's value is "1". Any other value will have no effect.

Numberoptional
Prefixprefix

The prefix used instead of "Archive" in the expected naming system of "Archive n".

Example
IncidentArchive
Stringoptional
Linkslinks

Maximum of navigation links to display below banner. Default is 7.

Numberoptional
Final red linknoredlinks

Defaults to "yes" and does not display a final red link. To display the first red link after the highest archive, use "no".

Stringoptional
Imageimage

Use a custom image in the banner, or "none" for no image.

Stringoptional
Image rightimageright

Displays an image on the right side of the banner. Defaults to "none".

Stringoptional
Texttext

Replaces the default message in the banner.

Stringoptional
Time periodperiod

Specifies a covered time period to display in the banner.

Stringoptional
Box stylestyle

CSS properties for the box/banner.

Stringoptional
Text styletextstyle

CSS properties for the text style.

Stringoptional

Examples

[edit]

Examples of archived talk pages using this template:

Tracking category

[edit]

Notes

[edit]
  1. ^ Edit buttons are suppressed by emitting __NONEWSECTIONLINK__ and __NOEDITSECTION__ into the wikitext.
  2. ^ Alternatively, if a page is using User:Lowercase sigmabot III to automatically archive the page, you can add |archiveheader=((Archive)) For details see archive header.
  3. ^ If the value in the first unnamed parameter or explicit |1= is anything other than "1" (the number one, not a lower case letter L), this parameter has no effect.

See also

[edit]