Template:Archive box: Difference between revisions

From Citizendium
Jump to navigation Jump to search
imported>Chris day
No edit summary
imported>Chris day
No edit summary
Line 7: Line 7:
</div>
</div>
<noinclude>
<noinclude>
== 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.


== Usage ==
== Usage ==
Line 13: Line 17:


{| class="wikitable"
{| class="wikitable"
!width="500"|Wikitext
!Wikitext!!Appearance
!width="250"|Appearance
|-
|-
|<pre>{{Archive box|
|<pre>{{Archive box|
Line 26: Line 29:
==Parameters==
==Parameters==
The different variable parameters available for this template include:
The different variable parameters available for this template include:
:[[#Approved article archives|approved =]]
 
:[[#Automatic links|auto =]]
:[[#Automatic links|auto =]] (for automatic archiving)
:[[#Box and image parameters|image =]]
:[[#Approved article archives|approved =]] (for archiving talk pages from approved articles)
:[[#Box and image parameters|box-width =]]
:[[#Box and image parameters|box-width =]] (for adjusting box width)
:[[#Box and image parameters|image-width =]]
:[[#Box and image parameters|image-width =]] (for adjusting image width)
:[[#Box and image parameters|image =]] (for customizing the image)
 
These parameters can be used in combination and are described more fully with examples below.
These parameters can be used in combination and are described more fully with examples below.


== Placement ==
=== Automatic links ===
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 (<tt>/Archive 1</tt>, <tt>/Archive 2</tt> etc.), you can use the <tt>auto</tt> parameter to display links to them all automatically. Choosing the '''''yes''''' option will list the archives with numbers only:
If all the archives of a talk page are numbered (<tt>/Archive 1</tt>, <tt>/Archive 2</tt> etc.), you can use the <tt>auto</tt> parameter to display links to them all automatically. Choosing the '''''yes''''' option will list the archives with numbers only:
Line 44: Line 46:
The list will update itself when new archives are added. If there are also named archives, you can add links to these as well. See the additional links shown in the third archive box option below.
The list will update itself when new archives are added. If there are also named archives, you can add links to these as well. See the additional links shown in the third archive box option below.
{| class="wikitable"
{| class="wikitable"
!width="500"|Wikitext
!Wikitext!!Appearance
!width="250"|Appearance
|-
|-
|style="background-color:white"|This example uses the '''yes''' option for numbers.<br>
|style="background-color:white"|This example uses the '''yes''' option for numbers.<br>
Line 64: Line 65:
|}
|}


== Box and image parameters ==
===Approved article archives===


For approved articles the talk pages are redirected to the associated draft article talk page at ''Talk:ArticleName/Draft''. To ensure that the archive box directs to the correct ''current talk page'' the article needs to be designated as approved in the archive box template.
{| class="wikitable"
{| class="wikitable"
!width="500"|Wikitext
!Wikitext!!Appearance
!width="250"|Appearance
|-
|The '''Current talk page''' hyperlinks to '''''Talk:ArticleName/Draft'''''.
:This template has the '''approved=yes''' added to indicate that this archive box is used in asociation with an approved article
<pre>{{Archive box|auto=long|approved=yes}}</pre>
|{{Archive box|auto=long|approved=yes}}
|-
|The '''Current talk page''' hyperlinks to '''''Talk:ArticleName'''''.
:Any parameter other than yes, in this case no, or the absence of the approved parameter, will direct the current talk page link to ''Talk:ArticleName''. This default can be used for user pages and articles that have not been approved.
<pre>{{Archive box|auto=long|approved=no}}</pre>
|{{Archive box|auto=long|approved=no}}
|-
|The '''Current talk page''' hyperlinks to '''''Talk:ArticleName/Draft'''''.
:This template has the '''approved=yes''' added to indicate that this archive box is used in asociation with an approved article.  In this case not used with the automatice archiving parameter.
<pre>{{archive box|approved=yes|
[[{{TALKSPACE}}:{{BASEPAGENAME}}/Archive 1|Archive 1]]}}</pre>
|{{archive box|approved=yes|
[[{{TALKSPACE}}:{{BASEPAGENAME}}/Archive 1|Archive 1]]}}
|}
 
=== Box and image parameters ===
 
{| class="wikitable"
!Wikitext!!Appearance
|-
|-
|The image can be changed from the default, [[:Image:Logo200gr.jpg]], for example:
|The image can be changed from the default, [[:Image:Logo200gr.jpg]], for example:
Line 89: Line 113:
|image-width=35px
|image-width=35px
|[[{{TALKSPACE}}:{{BASEPAGENAME}}/Archive 1|Archive 1]]}}
|[[{{TALKSPACE}}:{{BASEPAGENAME}}/Archive 1|Archive 1]]}}
|}
==Approved article archives==
For approved articles the talk pages are redirected to the associated draft article talk page at ''Talk:ArticleName/Draft''. To ensure that the archive box directs to the correct ''current talk page'' the article needs to be designated as approved in the archive box template.
{| class="wikitable"
!width="500"|Wikitext
!width="250"|Appearance
|-
|The '''Current talk page''' hyperlinks to '''''Talk:ArticleName/Draft'''''.
:This template has the '''approved=yes''' added to indicate that this archive box is used in asociation with an approved article
<pre>{{Archive box|auto=long|approved=yes}}</pre>
|{{Archive box|auto=long|approved=yes}}
|-
|The '''Current talk page''' hyperlinks to '''''Talk:ArticleName'''''.
:Any parameter other than yes, in this case no, or the absence of the approved parameter, will direct the current talk page link to ''Talk:ArticleName''. This default can be used for user pages and articles that have not been approved.
<pre>{{Archive box|auto=long|approved=no}}</pre>
|{{Archive box|auto=long|approved=no}}
|-
|The '''Current talk page''' hyperlinks to '''''Talk:ArticleName/Draft'''''.
:This template has the '''approved=yes''' added to indicate that this archive box is used in asociation with an approved article.  In this case not used with the automatice archiving parameter.
<pre>{{archive box|approved=yes|
[[{{TALKSPACE}}:{{BASEPAGENAME}}/Archive 1|Archive 1]]}}</pre>
|{{archive box|approved=yes|
[[{{TALKSPACE}}:{{BASEPAGENAME}}/Archive 1|Archive 1]]}}
|}
|}


Revision as of 19:22, 25 February 2007


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.


Usage

Include the archive box in the articles talk page by adding it 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 further #Examples below.

Wikitext Appearance 
{{Archive box|
[[{{TALKSPACE}}:{{BASEPAGENAME}}/Archive 1|Archive 1]]}}

This template can also be placed on all the archive pages to make it convenient to toggle between the different archives, the current talk page and the main article. For an example, see this pages talk page and the four example archives associated with this template.

Parameters

The different variable parameters available for this template include:

auto = (for automatic archiving)
approved = (for archiving talk pages from approved articles)
box-width = (for adjusting box width)
image-width = (for adjusting image width)
image = (for customizing the image)

These parameters can be used in combination and are described more fully with examples below.

Automatic links

If all the archives of a talk page are numbered (/Archive 1, /Archive 2 etc.), you can use the auto parameter to display links to them all automatically. Choosing the yes option will list the archives with numbers only:

Alternatively, if you want longer and more visible links, try:setting the auto parameter to long since this will give a prose version; all other parameter values will trigger the numerical yes format above.

The list will update itself when new archives are added. If there are also named archives, you can add links to these as well. See the additional links shown in the third archive box option below.

Wikitext Appearance
This example uses the yes option for numbers.
{{archive box|auto=yes}}
1, 2, 3, 4
This example uses the long option for prose and numbers.
{{archive box|auto=long}}
This example uses the long option for prose and numbers. In addition, archives that have a non standard name can be added to the bottom.
{{archive box|auto=long|
[[{{TALKSPACE}}:{{BASEPAGENAME}}/Archive1|December 2005 - January 2006]] and
[[{{TALKSPACE}}:{{BASEPAGENAME}}/Deletion discussion|Deletion discussion]]}}

Approved article archives

For approved articles the talk pages are redirected to the associated draft article talk page at Talk:ArticleName/Draft. To ensure that the archive box directs to the correct current talk page the article needs to be designated as approved in the archive box template.

Wikitext Appearance
The Current talk page hyperlinks to Talk:ArticleName/Draft.
This template has the approved=yes added to indicate that this archive box is used in asociation with an approved article
{{Archive box|auto=long|approved=yes}}
The Current talk page hyperlinks to Talk:ArticleName.
Any parameter other than yes, in this case no, or the absence of the approved parameter, will direct the current talk page link to Talk:ArticleName. This default can be used for user pages and articles that have not been approved.
{{Archive box|auto=long|approved=no}}
The Current talk page hyperlinks to Talk:ArticleName/Draft.
This template has the approved=yes added to indicate that this archive box is used in asociation with an approved article. In this case not used with the automatice archiving parameter.
{{archive box|approved=yes|
[[{{TALKSPACE}}:{{BASEPAGENAME}}/Archive 1|Archive 1]]}}

Box and image parameters

Wikitext Appearance
The image can be changed from the default, Image:Logo200gr.jpg, for example: 
{{Archive box
|image=Image:Heckert_GNU_white.jpg
|[[{{TALKSPACE}}:{{BASEPAGENAME}}/Archive 1|Archive 1]]}}
The box and image widths can be adjusted from the default settings by adding their widths as parameters: 
{{Archive box
|box-width=13em
|image-width=35px
|image=Image:Heckert_GNU_white.jpg
|[[{{TALKSPACE}}:{{BASEPAGENAME}}/Archive 1|Archive 1]]}}

Examples

Here are several different examples of how hyperlinks to talk page archives can be displayed in the archive box.

Wikitext Appearance 
{{archive box|
[[{{TALKSPACE}}:{{BASEPAGENAME}}/Archive 1|Archive 1]], 
[[{{TALKSPACE}}:{{BASEPAGENAME}}/Archive 2|Archive 2]], 
[[{{TALKSPACE}}:{{BASEPAGENAME}}/Archive 3|December 2005 - January 2006]] and
[[{{TALKSPACE}}:{{BASEPAGENAME}}/Deletion discussion|Deletion discussion]]}}
 
{{archive box|
[[{{TALKSPACE}}:{{BASEPAGENAME}}/Archive 1|Archive 1]]<br>
[[{{TALKSPACE}}:{{BASEPAGENAME}}/Archive 2|Archive 2]]<br>
[[{{TALKSPACE}}:{{BASEPAGENAME}}/Archive 3|December 2005 - January 2006]]<br>
[[{{TALKSPACE}}:{{BASEPAGENAME}}/Deletion discussion|Deletion discussion]]}}
 
{{archive box|
:[[{{TALKSPACE}}:{{BASEPAGENAME}}/Archive 1|Archive 1]]
:[[{{TALKSPACE}}:{{BASEPAGENAME}}/Archive 2|Archive 2]]
:[[{{TALKSPACE}}:{{BASEPAGENAME}}/Archive 3|December 2005 - January 2006]]
:[[{{TALKSPACE}}:{{BASEPAGENAME}}/Deletion discussion|Deletion discussion]]}}
 
{{archive box|
:*[[{{TALKSPACE}}:{{BASEPAGENAME}}/Archive 1|Archive 1]]
:*[[{{TALKSPACE}}:{{BASEPAGENAME}}/Archive 2|Archive 2]]
:*[[{{TALKSPACE}}:{{BASEPAGENAME}}/Archive 3|December 2005 - January 2006]]
:*[[{{TALKSPACE}}:{{BASEPAGENAME}}/Deletion discussion|Deletion discussion]]}}
 
{{archive box|
#[[{{TALKSPACE}}:{{BASEPAGENAME}}/Archive 1|Archive 1]]
#[[{{TALKSPACE}}:{{BASEPAGENAME}}/Archive 2|Archive 2]]
#[[{{TALKSPACE}}:{{BASEPAGENAME}}/Archive 3|December 2005 - January 2006]]
#[[{{TALKSPACE}}:{{BASEPAGENAME}}/Deletion discussion|Deletion discussion]]}}
Retrieved from "https://citizendium.org/wiki/index.php?title=Template:Archive_box&oldid=153487"