Template:ArchiveBox: Difference between revisions

From Step Mods | Change The Game
(Created page with "<div style="float: right; margin: 0 0 .5em .5em; width: {{{width|150px}}}; {{ #if: {{{font|}}} | font-family: {{{font}}}; }} border: 1px solid {{ #if: {{{color|}}} | {{{color}...")
 
m (Removed protection from "Template:ArchiveBox")
 
(28 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<div style="float: right; margin: 0 0 .5em .5em; width: {{{width|150px}}}; {{ #if: {{{font|}}} | font-family: {{{font}}}; }} border: 1px solid {{ #if: {{{color|}}} | {{{color}}} | {{{border-color|#EA3}}} }}; background: {{{background-color|#FFC}}}; padding: .5em 1em;">
<includeonly><div style="float:right; margin:0 0 .5em .5em; width:{{{width|200px}}}; border:2px solid {{{color | {{{border-color|#3F550F}}} }}}; background:{{{background-color|#2B3C2B}}}; padding:.5em 1em;">
{{ #if: {{{header|}}} | <div style="padding:0.1em; font-size:0.9em; background-color:{{{header-color|#FF8}}}; text-align:center;">'''{{{header}}}'''</div> }}
<div class="archive-header" style="text-align:center;">
<div class="archive-header" style="text-align: center;">
{{ #ifeq: {{{image}}} | none | | [[File:{{{image|Vista-file-manager.png}}}|{{{image-size|64px}}}]]<br /> }}{{ #ifeq: {{{title}}} | none | | '''{{{title|Archive}}}''' }}
{{ #if: {{{alt-title|}}} | '''{{{alt-title}}}'''<br /> }}{{ #ifeq: {{{image}}} | none | | [[Image:{{{image|Vista-file-manager.png}}}|{{{image-size|64px}}}]]<br /> }}{{ #ifeq: {{{title}}} | none | | '''{{{title|Archive}}}''' }}
----
----
</div>
</div>
Line 8: Line 7:
{{{1|}}}
{{{1|}}}
</div>
</div>
</div>
</div></includeonly><noinclude>__NOTOC__[[Category:Administrative Templates]]
<noinclude>
 
 
 
== Usage ==


Include the archive box in the article by adding
==Purpose & Usage==
{{AlertSmall‏‎|text=If the intent is to archive an ENTIRE page (i.e., it's outdated) rather than to split off older or extended content on the page, use [[:Template:Archived]] instead of this Template!}}
This facilitates breaking potentially long pages to which content can be added over time (like Talk Pages) into subpages. Include the archive box in the article by adding:
<pre>{{ArchiveBox|[[/Archive]]}}</pre>
<pre>{{ArchiveBox|[[/Archive]]}}</pre>
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.
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:
Notes:
*Move the content to be replaced to a subpage of the page on which the ArchiveBox will appear (preferable in most cases ... otherwise, move to any page).
*At top of the page to which the content was moved, add <code><nowiki>{{Archived}}</nowiki></code> Template call (for consistency of all pages under [[:Category:Archives]])
*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.
*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:
*If subpages are disabled in the namespace where the template is used, you may need to spell out the full archive path, such as:
Line 26: Line 24:
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.
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==
=== Advanced usage options===
The template contains multiple parameter variables that are intended to give the user additional customization and flexibility when using the template.
The template contains multiple parameter variables that are intended to give the user additional customization and flexibility when using the template.


'''title'''  
'''title'''  
:Alter the title of the box. Default is "Archive". Selecting <code>none</code> results in no title below the image.
:Alter the title of the box. Default is "Archive". Selecting <code>none</code> results 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'''  
'''width'''  
:Alter the width. Default is 16em.  
:Alter the width. Default is 16em.
'''font'''
:Modify the font face. Default is none.
'''border-color'''  
'''border-color'''  
:Modify the color of the border. Default is #aaa
:Modify the color of the border. Default is #3F550F
'''background-color'''  
'''background-color'''  
:Modify the color of the background. Default is #eee.
:Modify the color of the background. Default is #2B3C2B
'''image'''  
'''image'''  
:Choose which image you'd like as your archive icon. Default is [[:File:Vista-file-manager.png]]. Selecting <code>none</code> results in no image.
:Choose which image you'd like as your archive icon. Default is [[:File:Vista-file-manager.png]]. Selecting <code>none</code> results in no image.
Line 50: Line 40:
:Alter the size of the image. Default is 48px.
:Alter the size of the image. Default is 48px.


== Examples ==
==Examples==
 
For actual examples of the use of this template, use the [https://stepmodifications.org/wiki/Special:WhatLinksHere/Template:ArchiveBox 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).
For actual examples of the use of this template, use the [[Special:Whatlinkshere/Template:Archive_box|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).


{|
{|
Line 154: Line 143:
|<pre>{{ArchiveBox
|<pre>{{ArchiveBox
  |title=none
  |title=none
|alt-title=Resolved issues
  |
  |
* [[/Archive 1]]
* [[/Archive 1]]
Line 162: Line 150:
|{{ArchiveBox
|{{ArchiveBox
  |title=none
  |title=none
|alt-title=Resolved issues
  |
  |
* [[/Archive 1]]
* [[/Archive 1]]
Line 171: Line 158:
|<pre>{{ArchiveBox
|<pre>{{ArchiveBox
  |title=none
  |title=none
|header=Older discussions
|header-color=LightSteelBlue
  |background-color=AliceBlue
  |background-color=AliceBlue
  |border-color=MidnightBlue
  |border-color=MidnightBlue
Line 182: Line 167:
|{{ArchiveBox
|{{ArchiveBox
  |title=none
  |title=none
|header=Older discussions
|header-color=LightSteelBlue
  |background-color=AliceBlue
  |background-color=AliceBlue
  |border-color=MidnightBlue
  |border-color=MidnightBlue
Line 193: Line 176:
|}
|}


==See also==
== See Also ==
*{{tl|Archived}} = a template for flagging that the page contents are an archive and should not be edited.
*[[:Template:Archived|Archived]] - Used to archive an ENTIRE page rather than content into subpages.
(copied from https://wiki.guildwars2.com/wiki/Template:Archive-box)
 
</noinclude>

Latest revision as of 16:31, June 11, 2021


Purpose & Usage[edit source]

Info-Logo.png
NOTE:
If the intent is to archive an ENTIRE page (i.e., it's outdated) rather than to split off older or extended content on the page, use Template:Archived instead of this Template!

This facilitates breaking potentially long pages to which content can be added over time (like Talk Pages) into subpages. Include the archive box in the article by adding: 

{{ArchiveBox|[[/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:

  • Move the content to be replaced to a subpage of the page on which the ArchiveBox will appear (preferable in most cases ... otherwise, move to any page).
  • At top of the page to which the content was moved, add {{Archived}} Template call (for consistency of all pages under Category:Archives)
  • 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:
{{ArchiveBox|[[{{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 source]

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 none results in no title below the image.

width

Alter the width. Default is 16em.

border-color

Modify the color of the border. Default is #3F550F

background-color

Modify the color of the background. Default is #2B3C2B

image

Choose which image you'd like as your archive icon. Default is File:Vista-file-manager.png. Selecting none results in no image.

image-size

Alter the size of the image. Default is 48px.

Examples[edit source]

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 
{{ArchiveBox|
[[/Archive 1]],
[[/Archive 2|titled link]],
[[/December 2005 - January 2006]] and
[[/Deletion discussion]]}}
 
{{ArchiveBox|
[[/Archive 1]]<br />
[[/Archive 2|titled link]]<br />
[[/December 2005 - January 2006]]<br />
[[/Deletion discussion]]}}
 
{{ArchiveBox|
: [[/Archive 1]]
: [[/Archive 2|titled link]]
: [[/December 2005 - January 2006]]
: [[/Deletion discussion]]}}
 
{{ArchiveBox|
* [[/Archive 1]]
* [[/Archive 2|titled link]]
* [[/December 2005 - January 2006]]
* [[/Deletion discussion]]}}
 
{{ArchiveBox|
# [[/Archive 1]]
# [[/Archive 2|titled link]]
# [[/December 2005 - January 2006]]
# [[/Deletion discussion]]}}
 
{{ArchiveBox
 |width=200px
 |border-color=red
 |image-size=75px
 |title=My talk archive
 |
* [[/Archive 1]]
* [[/Archive 2|titled link]]
* [[/December 2005 - January 2006]]
* [[/Deletion discussion]]}}
 
{{ArchiveBox
 |background-color=white
 |image=none
 |title=Archive by subject
 |
* [[/Archive 1]]
* [[/Archive 2|titled link]]
* [[/December 2005 - January 2006]]
* [[/Deletion discussion]]}}
 
{{ArchiveBox
 |title=none
 |
* [[/Archive 1]]
* [[/Archive 2|titled link]]
* [[/December 2005 - January 2006]]
* [[/Deletion discussion]]}}
 
{{ArchiveBox
 |title=none
 |background-color=AliceBlue
 |border-color=MidnightBlue
 |
* [[/Archive 1]]
* [[/Archive 2|titled link]]
* [[/December 2005 - January 2006]]
* [[/Deletion discussion]]}}

See Also[edit source]

  • Archived - Used to archive an ENTIRE page rather than content into subpages.

(copied from https://wiki.guildwars2.com/wiki/Template:Archive-box)


Retrieved from "https://stepmodifications.org/wiki/index.php?title=Template:ArchiveBox&oldid=153459"