Template:Archive-box/manual
Usage[edit]
Include the archive box in the article by adding
{{Archive-box|[[/Archive]]}}
to where you want the archive box to appear. 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. Notes:
- 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.
- If subpages are disabled in the namespace where the template is used, you may need to spell out the full archive path, such as:
{{Archive-box|[[{{NAMESPACE}}:{{PAGENAME}}/Archive|Archive name]]}}
If using the full page, it is suggested that you include the optional "|Archive name" shown above, using an appropriate name.
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.
Advanced usage options[edit]
The template contains multiple parameter variables that are intended to give the user additional customization and flexibility when using the template.
- title
- Alter the title of the box. Default is "Archive". Selecting
noneresults in no title below the image. - alt-title
- Alternate title location above the image. Default is no content.
- header
- Another alternate title, formatted in a header block. Default is not shown / no content.
- header-color
- Modify the header block color. Default is #ddd. No effect if no header text is specified.
- width
- Alter the width. Default is 16em.
- font
- Modify the font face. Default is none.
- border-color
- Modify the color of the border. Default is #EA3 (applied with CSS).
- background-color
- Modify the color of the background. Default is #FFC (applied with CSS).
- color
- Modify the font color. Default is #000 (applied with CSS).
- image
- Choose which image you'd like as your archive icon. Default is File:Vista-file-manager.png. Selecting
noneresults in no image. - image-size
- Alter the size of the image. Default is 48px.
- link
- Image link. Default is unlinked.
- class
- Optional. Add a CSS class to the box.
Examples[edit]
For actual examples of the use of this template, use the what links here link 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|
[[/Archive 1]],
[[/Archive 2|titled link]],
[[/December 2005 - January 2006]] and
[[/Deletion discussion]]}}
|
|
{{archive-box|
[[/Archive 1]]<br />
[[/Archive 2|titled link]]<br />
[[/December 2005 - January 2006]]<br />
[[/Deletion discussion]]}}
|
|
{{archive-box|
: [[/Archive 1]]
: [[/Archive 2|titled link]]
: [[/December 2005 - January 2006]]
: [[/Deletion discussion]]}}
|
|
{{archive-box|
* [[/Archive 1]]
* [[/Archive 2|titled link]]
* [[/December 2005 - January 2006]]
* [[/Deletion discussion]]}}
|
|
{{archive-box|
# [[/Archive 1]]
# [[/Archive 2|titled link]]
# [[/December 2005 - January 2006]]
# [[/Deletion discussion]]}}
|
|
{{archive-box
|width=200px
|border-color=red
|image-size=75px
|title=My talk archive
|
* [[/Archive 1]]
* [[/Archive 2|titled link]]
* [[/December 2005 - January 2006]]
* [[/Deletion discussion]]}}
|
|
{{archive-box
|background-color=white
|image=none
|title=Archive by subject
|
* [[/Archive 1]]
* [[/Archive 2|titled link]]
* [[/December 2005 - January 2006]]
* [[/Deletion discussion]]}}
|
Archive by subject |
{{archive-box
|title=none
|alt-title=Resolved issues
|
* [[/Archive 1]]
* [[/Archive 2|titled link]]
* [[/December 2005 - January 2006]]
* [[/Deletion discussion]]}}
|
Resolved issues |
{{archive-box
|title=none
|header=Older discussions
|header-color=LightSteelBlue
|background-color=AliceBlue
|border-color=MidnightBlue
|
* [[/Archive 1]]
* [[/Archive 2|titled link]]
* [[/December 2005 - January 2006]]
* [[/Deletion discussion]]}}
|
See also[edit]
- {{archived}} = a template for flagging that the page contents are an archive and should not be edited.
