Template:Automatic archive navigator/doc
 | This is a documentation subpage for Template:Automatic archive navigator. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
 | This template uses Lua: |
Template:Automatic archive navigator provides a convenient banner for the top of archive pages that also helps with navigation. It also suppresses section editing and the new section button on the page by emitting __NONEWSECTIONLINK__ and __NOEDITSECTION__ into the wikitext.
Appearance
Live working examples, using this template:
Usage
This Automatic Archive Navigator template header allows you to navigate through numbered archive pages that are named in the standard "Archive n" format. 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.
No parameters are needed for this template to work; just place {{Automatic archive navigator}} near the top of each archive page . It will automatically create a navigation bar. Some optional parameters are detailed below, if you want to have more control.
The template relies on all archives from Archive 1 to Archive n, to 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.
For this template to work, the archives must also be named in standard "Archive n" form. If they are not, move them to the appropriate names first. Alternatively, you can use the |prefix= parameter to let the module know what prefix it should use.
Optional parameters
| 1
- Option to use the navigation bar with no message text (this displays the number one, not a lower case letter L). Example:
{{Automatic archive navigator|1}}.
| prefix = archive prefix
- Manually specifies the prefix of the archive page. This is useful for archives in a non-standard format. 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.
| style (minor warning) / notice (messages)
- These are the same types as used by {{tmbox}} and automatically change the logo and box style. If left undefined, then the logo will default to the archives icon.
| 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.
Tracking category
- Category:Archive pages whose parent page is a redirect (0) tracks pages where archive subpages weren't properly moved together with the parent page.