Template:Archives

From Wikipedia, the free encyclopedia

Archives

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.

Remember that you can conduct experiments, and should test all improvements, in either the general Template sandbox or your user space before changing anything here.

[edit]

Template documentation

This documentation is transcluded from Template:Archives/doc. (edit | history)

{{archives}} — Adds a box containing links to archived discussions. It will automatically detect archives by default.

1 Usage
2 Examples
- 2.1 Defaults
- 2.2 Small, short, index
3 See also

Usage

Synopsis

{{archives
  |archivelist=/archivelist
  |auto=<short|long>
  |index=/Archive index
  |small=yes
}}

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.
small=yes: This option causes the archive box to take on the same color scheme as other talk page templates, and to have a slightly smaller size.
auto=<short|long>: Specifies the format of the auto-generated archive list. See "Archive list" below.

Archive list

By default (with no explicit parameters), the archive list presented in the box is determined automatically. If a subpage called "./archivelist" exists, it will be used as the central content of the box. Otherwise, numbered archive subpages will be listed in long format. If neither exist, the box will contain only the "About" and "Edit" links, with the Edit link targeted at "./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.

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, "./Archive 1", "./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" 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.