Ohia:Archive box/doc

This is a documentation subpage for Ohia:Archive box.
It contains usage information, categories, and other content that is not part of the original ohia page.

[[Category:Documentation subpages without corresponding pages{{#translation:}}]]

Usage

Include the archive box in the article by adding

{{Archive box non-auto|[[/Archive]]}}

to where you want the archive box to appear. Make sure to add the forward slash '/' to the archive name to make it a subpage of the page where the archive box is placed. How you present a list of archive pages is up to you. You can separate them with commas, pipes (vertical lines: '|') or as lists. See #Examples below.

Placement

The box uses a style that makes it float to the right. This means that where it appears in the page it will be aligned to the right edge of the page (more accurately: the containing box, but that is an unnecessary detail) and all following content will flow around it.

Automatic links

If all the archives of a talk page are numbered (like /Archive 1 or /Archive 2) or dated (like /2023 or /2024), you can use Template:Archive box auto to display links to them all automatically. The list will update itself when new archives are added.

 {{archive box auto}}
 -or-
 {{archive box auto|auto=dated}}

If there are also named archives, you can add links to these as well:

 {{archive box auto|auto=dated|
* [[/Some archive/]]}}

When using numbered archives with less than 20 archive pages, you can generate a larger two-column output with auto=long.

Box width and image

The box and image widths can be set by passing their widths as parameters:

{{Archive box non-auto|box-width=13em|image-width=35px|[[/Archive]]}}

The image can also be changed from the default, File:Filing cabinet icon.svg, for example:

{{Archive box non-auto|image=Breathe-system-file-manager.svg}}

Examples

For actual examples of the use of these template, use the "what links here" links Special:Whatlinkshere/Template:Archive box non-auto and Special:Whatlinkshere/Template:Archive box in the toolbox on the sidebar, near the top on the left side of this page (unless you are using an unconventional skin … in which case you probably know what you are doing).

Wikitext

Appearance

{{archive box auto|auto=dated}}

{{Archive box non-auto|
[[/Archive 1]],
[[/Archive 2]],
[[/December 2005 - January 2006]] and
[[/Deletion discussion]]}}

{{Archive box non-auto|
[[/Archive 1]]<br />
[[/Archive 2]]<br />
[[/December 2005 - January 2006]]<br />
[[/Deletion discussion]]}}

{{Archive box non-auto|
: [[/Archive 1]]
: [[/Archive 2]]
: [[/December 2005 - January 2006]]
: [[/Deletion discussion]]}}

Archives /Archive 1 /Archive 2 /December 2005 - January 2006 /Deletion discussion

{{Archive box non-auto|
* [[/Archive 1]]
* [[/Archive 2]]
* [[/December 2005 - January 2006]]
* [[/Deletion discussion]]}}

Archives /Archive 1 /Archive 2 /December 2005 - January 2006 /Deletion discussion

{{Archive box non-auto|
# [[/Archive 1]]
# [[/Archive 2]]
# [[/December 2005 - January 2006]]
# [[/Deletion discussion]]}}

Archives /Archive 1 /Archive 2 /December 2005 - January 2006 /Deletion discussion

{{Archive box non-auto|box-width=14em|image-width=20px|
* [[/Archive 1]]
* [[/Archive 2]]
* [[/December 2005 - January 2006]]
* [[/Deletion discussion]]}}

Archives /Archive 1 /Archive 2 /December 2005 - January 2006 /Deletion discussion

No description.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
1	`1`	no description	Unknown	optional
translated	`translated`	no description	Unbalanced wikitext	optional
uselang	`uselang`	no description	Unknown	optional
auto	`auto`	no description	Unknown	optional
box-width	`box-width`	no description	Unknown	optional
image	`image`	no description	Unknown	optional
image-width	`image-width`	no description	Unknown	optional
base	`base`	no description	Unknown	optional
title	`title`	Changing the title of box. Default Archives	Unbalanced wikitext	optional
archive link	`archive-link`	no description Default Special:MyLanguage/Standard archival system	Page name	optional
search	`search`	searchbox will not display if set to "no"	String	optional