Template:Archives
|
| Archives |
|---|
| no archives yet (create) |
| About archives |
Template documentation | This template employs intricate features of template syntax.
You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages. You can conduct experiments, and should test all major changes, in either this template's sandbox, the general template sandbox, or your user space before changing anything here. |
 | This template is called by Template:Archive box. Please ensure that any changes do not break the legacy functionality of archive box. |
{{archives}} can be used to add a box containing links to archived discussions.
It will automatically detect archived pages by default if they are named appropriately; this means that it doesn't need to be manually updated when a new archive is created.
Usage
{{archives
|archivelist=/archivelist
|auto=<short|long|no>
|index=/Archive index
|search=<yes|no>
}}
Parameters
- archivelist
- Specifies a subpage containing the archive list. See "Archive list" below.
- index
- Adds an "Index" link to the box title, to the specified subpage, which should be a subject index to all archived discussions. HBC Archive Indexerbot can automatically generate such indexes.
- auto=<short|long|no>
- Specifies the format of the auto-generated archive list. See "Archive list" below. If unspecified, the default is "long"; any other word (except "no") will result in "short". "no" disables auto-detection.
- search
- If specified, the
searchparameter adds a search box to the template. - list
- Inline list of archives. This is unneeded if the pages are named "Archive 1", "Archive 2" and so on, in which case automatic archiving works, but can be used in addition to automatic archiving if additional pages with other names are available.
- collapsible
- Makes the list collapsible.
- collapsed
- Makes the list collapsed.
- style
- Arbitrary string of CSS to be applied to the box; use with care.
- title
- The bolded archive title, defaults to "Archive".
- image
- The archive image to be used, defaults to "[[Image:Replacement filing cabinet.svg|40px|]]"
Archive list
By default (with no explicit parameters), the archive list presented in the box is determined automatically. If a subpage called "{{PAGENAME}}/archivelist" exists, it will be used as the central content of the box (for an example, see Talk:Evolution, which draws from Talk:Evolution/archivelist).
If no archivelist subpage is detected, numbered archive subpages will be listed in long format. Such pages must be named as "/Archive #". Other naming styles will not be detected. If no subpages are found, the archivebox will contain only the "About" and "Edit" links, with the Edit link targeted at "{{PAGENAME}}/archivelist" (which can then be used to begin manually populating the list, if desired).
If the "auto" parameter is explicitly specified, the "Edit" link is removed. The "long" auto format (the default) indicates "Archive 1", "Archive 2", and so on. The "short" auto format indicates only the archive number. See examples below.
If you specify an archive list explicitly, the name of the subpage is changed, but otherwise, the behavior is the same.
Using "auto=no" will disable archive auto-detection. Manually specified archives will still be shown.
Additional notes
The "auto" and "archivelist" parameters are not intended to be used together. (Doing so removes the edit link, but will still use the specified archive list page if it exists.)
The auto-generated archive list requires subpages to use the common naming convention. That is, "{{PAGENAME}}/Archive 1", "{{PAGENAME}}/Archive 2", and so on. The letter "A" must be capitalized, there must be a single space between the word "Archive" and the number, and there must be no leading zeros. If archive subpages do not conform to this convention, they can be renamed to conform, or a manual list can be maintained.
Specifying "auto" with any right-hand-side value other than "long" or "no" results in the short-format list; the use of "short" as the value just makes things more obvious to others.
The short and long auto lists are generated by {{archive list}} and {{archive list long}}, respectively. They are limited to a maximum of 100 and 36 subpages, respectively. Beyond those limits, additional subpages will not be listed. In such cases, a manually generated archive list subpage would need to be created and maintained.
Examples
- Defaults
{{archives}}
|
|
| Archives |
|---|
| no archives yet (create) |
| About archives |
- Short, index
{{archives
|auto=short
|index=/Archive index
}}
|
|
| Archives (Index) |
|---|
no archives yet (create)
|
| About archives |
See also
- Template:Archives (edit | talk | history | links | watch | logs)
- Template:Archive box (edit | talk | history | links | watch | logs)
- Template:Archive box collapsible (edit | talk | history | links | watch | logs)
- Template:Talkarchive (edit | talk | history | links | watch | logs)
- Template:Archive-nav (edit | talk | history | links | watch | logs)
- Help:Archiving a talk page