Actions

Template

Difference between revisions of "Archived"

From Joomla! Documentation

(new template {{archived}})
 
m (update to wording for links referred)
Line 5: Line 5:
 
{{#if:{{{reason|}}}|{{{reason|}}}|This page has not been maintained in some time, or no longer contains information relevant or current. It may also contain information which is duplicated or contains historical content.}}
 
{{#if:{{{reason|}}}|{{{reason|}}}|This page has not been maintained in some time, or no longer contains information relevant or current. It may also contain information which is duplicated or contains historical content.}}
 
{{#if:{{{2|}}}|<br />
 
{{#if:{{{2|}}}|<br />
The following alternatives are available:
+
Please refer to the following alternative(s) which are available here:
 
* [[{{{2}}}|{{{2}}}]]{{#if:{{{3|}}}|
 
* [[{{{2}}}|{{{2}}}]]{{#if:{{{3|}}}|
 
* [[{{{3}}}|{{{3}}}]]
 
* [[{{{3}}}|{{{3}}}]]

Revision as of 23:22, 25 November 2012

[view] [edit] [history]

Template-info.pngTemplate documentation

Contents

Easily archive pages no longer needed or of duplicated content. Options include adding links to relevant page(s) - limited to 2 and archive categories inclusions. Should not be used as a substitute for a page in need of actual deletion.

Functions/Features

  • Information box
    • Generic message or stated reason for the page being archived
    • Page links to more relevant or current page
    • Link to view the page's last state with content before being archived
  • Automated category inclusion or creation

Usage

{{archived|(revision ###)}} - default categorisation will be [[Category:Archived pages]]
Example: 
{{archived|77774}} will show this documentation's pages last revision if you
                   click the link to see the page before archival.
Include more information with:
|Page called Foo - parameter {{{2|}}
|Page called Foo2 - parameter {{{3|}}}
|reason=This page has not been maintained since 2007
|cat=Foo,Foo2,Foo3 (use an array, comma separated to include archive categories
Example: 
{{archived|77774|Foo|Foo2|reason=Showing how to use this template.|cat=Foo,Foo2,Foo3}}

Parameters

Parameter Parameter description req./opt.
{{{1}}} Revision ID of the last page state required
{{{2}}} 1st link to relevant page optional
{{{3}}} 2nd link to relevant page optional
{{{reason}}} Override default reason: This page has not been maintained in some time, or no longer contains information relevant or current. It may also contain information which is duplicated or contains historical content. optional
{{{cat}}} categorisation using array format - Foo,Foo1,Foo2 optional

Known Issues

Dependencies:

  • You must retrieve the REVISION ID of the page before use, otherwise the link to the archived version WILL NOT work.

To find the REVISION ID, use the page's View history link, then choose the page to show as the last known state. This will generally be the one at the top, which is the current version of the page. Then click the link shown with time and date.

(cur | prev) 23:04, 25 November 2012‎ AnyUser(Talk | contribs | block)‎ . . (+1,438)‎ . . (doc page, will improve) 
                      / \
                       |
                  click here 

This will show a page in historical REVISION ID format. The REVISION ID is at the very end of your bowser's address bar shown as &oldid= some number.

http://docs.joomla.org/index.php?title=Template:Archived/doc&oldid=77774