• Home
  • Random
  • Nearby
  • Log in
  • Settings
Donate Now If Wikipedia is useful to you, please give today.
  • About Wikipedia
  • Disclaimers
Wikipedia

Template:Archive

  • Template
  • Talk
  • Language
  • Watch
  • View source
(Redirected from Template:Automatic archive navigator)
This is an archive of past discussions about Template:Archive. Do not edit the contents of this page. If you wish to start a new discussion or revive an old one, please do so on the current main page.
Template documentation[view] [edit] [history] [purge]
WarningThis template is used on approximately 327,000 pages, or roughly 1% of all pages.
To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.
Shortcuts
  • {{aanTemplate:Aan}}
  • {{AANTemplate:AAN}}
This template uses Lua:
  • Module:Archive (sandbox)

{{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]

Contents

  • 1 Usage
  • 2 Links
    • 2.1 Standard navigation
    • 2.2 Annual archives
    • 2.3 Arbitrary names
  • 3 Optional parameters
    • 3.1 TemplateData
  • 4 Examples
  • 5 Tracking category
  • 6 Notes
  • 7 See also

Usage

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.

Links

Standard navigation

The template creates navigational links below the banner. 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.

Annual archives

The template will check for annual archives based on the title of the page where it is invoked. For archives ending in a plausible year (20XX), the template will check for other years with the same formatting and create a list of annual archives using {{yearly archive list}}.

For example, if used on User talk:Example/Archive 2025, the template will check for User talk:Example/Archive 2024 but not User:Example/Archive/2024.

Arbitrary names

The template can also point to any archive by using the |prev= and |next= parameters, for situations where:

  • Some archives have a descriptive name.
  • The archives switched from one format to another.
  • The archives have an idiosyncratic naming scheme.

Optional parameters

  • |omit=banner/archives - Use |omit=banner to display only the navigation bar links with no message text, or use |omit=archives to display only the message box text with no archive links. Example: {{Archive|omit=banner}}.
  • |prefix=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 |prefix=IncidentArchive. HTML entities are decoded for this parameter; for example, to insert a space at the end of the prefix, you can use  .
  • |links=n - Specifies the maximum number of links to be used. The default is 7.
  • |noredlinks=yes / no - Normally, the template does not display red links. To display the first red link after the highest archive, you can use |noredlinks=no.
  • |image=none / [[File:Some image.svg|40px]]
  • |imageright=[[File:Some image.svg|40px]] - 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.
  • |text=alternative message text - Replaces the header message with your own message.
  • |period=date range - Specifies a date range for the period covered, e.g. |period=March 2006 to April 2007. This parameter is free-form, so you can use whatever format you like.
  • |style=CSS box style settings
  • |textstyle=CSS text style settings - Formats the box and text in any way you prefer. You may find the guidance at MOS:COLORCODING helpful.
  • |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.
  • |next= - Specify the next archive ___location. Use the full page title, not just a number. This suppresses the automatically generated navigation links.
  • |prev= - Specify the previous archive ___location. Use the full page title, not just a number. This suppresses the automatically generated navigation links.

TemplateData

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 template adds a banner to the top of archive pages.

Template parameters[Edit template data]

ParameterDescriptionTypeStatus
Omitomit

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.

Unknownoptional
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
Indexindex

Changes the blurb text for a manually-curated index pages. Do not use for bot-curated index pages.

Unknownoptional
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

Examples

Examples of archived talk pages using this template:

  • Talk:2009 swine flu pandemic/Archive 5
  • WT:WikiProject College football/Archive 5

Tracking category

  • Category:Archive pages whose parent page is a redirect (5,384) tracks pages where archive subpages weren't properly moved together with the parent page.

Notes

  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.

See also

  • {{Archives}} for including links to the talk page's archive(s) on the talk page itself.
  • {{Webarchive}} for linking to web archiving services such as the Wayback Machine, WebCite and all other web archiving services.
  • {{Oldid}}
  • v
  • t
  • e
Templates for archiving
  • Archiving (simple)
  • Archiving (technical)
  • Choosing the right bot
Recommended
  • {{Archives}} (very configurable side box or banner for main talk page)
  • {{Archive}} (banner placed on archive pages with navigation)
  • {{Talk header}} (banner with talk page guidelines and archives)
  • {{Archive top}} / {{Atop}} (archives/closes discussion)
  • lowercase sigmabot III (MiszaBot) (most popular auto archiving bot) {{subst:Setup auto archiving}} (quick setup script)
  • Wikipedia:One click archiving (archiver scripts)
Headers
With
navigation
  • {{Annual archive}}
  • {{Archived annually}}
  • {{Archive}} (does not need parameter)
  • {{Archives by months}}
  • {{Month-year archive nav}}
  • {{Monthly archived talk}}
Without
navigation
  • {{Archiving}}
With
search
  • {{Talk header}} (contains an automatically appearing archive search box and nav)
Content
formatting
  • {{Archive top}} / {{atop}}
  • {{Archive top green}} / {{atopg}}
  • {{Archive top red}} / {{atopr}}
  • {{Archive top yellow}} / {{atopy}}
  • {{Archive bottom}} / {{abot}}
  • {{Closed rfc top}}
  • {{Collapse}}
  • {{Collapse top}} / {{cot}}
  • {{Collapse bottom}} / {{cob}}
  • {{Collapse AI top}} / {{cait}}
  • {{Hidden archive top}} / {{hat}}
  • {{Hidden archive bottom}} / {{hab}}
  • {{Poll top}}
  • {{Poll bottom}}
Lists
  • {{Archive list}} (numbered archives usually the default)
  • {{Archive list alpha}}
  • {{Monthly archive list}}
  • {{Yearly archive list}}
Discussion
  • {{Archive request}}
  • {{Please archive}}
  • {{uw-archive}}
Automatic
archiving
systems
lowercase
sigmabot III

(MiszaBot)
  • {{subst:Setup auto archiving}}
  • {{User:MiszaBot/config}}
ClueBot III
  • {{subst:Setup cluebot archiving}}
  • {{subst:Archive now}}
  • {{User:ClueBot III/ArchiveThis}}
other
  • HBC Archive Indexerbot (Legobot)
general
  • {{Archive basics}}
  • {{subst:Bump}}
  • {{subst:Do not archive until}}
  • {{subst:Pin section}}
  •  Category:Archival templates
The above documentation is transcluded from Template:Archive/doc. (edit | history)
Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages.
Add categories to the /doc subpage. Subpages of this template.
Retrieved from "https://en.wikipedia.org/w/index.php?title=Template:Archive&oldid=1288420840"
Last edited on 2 May 2025, at 14:29

Languages

    • العربية
    • Azərbaycanca
    • Basa Bali
    • বাংলা
    • Беларуская
    • Беларуская (тарашкевіца)
    • भोजपुरी
    • Català
    • Čeština
    • Chavacano de Zamboanga
    • Corsu
    • Cymraeg
    • Español
    • فارسی
    • Gaeilge
    • Galego
    • 한국어
    • Ilokano
    • Bahasa Indonesia
    • Interlingua
    • IsiZulu
    • עברית
    • Jawa
    • Kernowek
    • Latina
    • Magyar
    • Македонски
    • മലയാളം
    • Bahasa Melayu
    • Nederlands
    • नेपाली
    • 日本語
    • ଓଡ଼ିଆ
    • پښتو
    • Polski
    • Shqip
    • සිංහල
    • Simple English
    • سنڌي
    • Slovenščina
    • کوردی
    • Српски / srpski
    • Srpskohrvatski / српскохрватски
    • Suomi
    • తెలుగు
    • ไทย
    • Українська
    • اردو
    • Tiếng Việt
    • ייִדיש
    • ꠍꠤꠟꠐꠤ
    Wikipedia
    • Wikimedia Foundation
    • Powered by MediaWiki
    • This page was last edited on 2 May 2025, at 14:29 (UTC).
    • Content is available under CC BY-SA 4.0 unless otherwise noted.
    • Privacy policy
    • About Wikipedia
    • Disclaimers
    • Contact Wikipedia
    • Code of Conduct
    • Developers
    • Statistics
    • Cookie statement
    • Terms of Use
    • Desktop