Difference between revisions of "Template:ArchiveNotice/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Pauli133
m (fixing lint errors)
blackwiki>Trialpears
(Redirected per TfD)
Line 1: Line 1:
{{Documentation subpage}}
+
#REDIRECT [[Template:Auto archiving notice/doc]]
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
+
{{R with history}}
== Usage ==
 
This is the {{tl|ArchiveNotice}} message box.
 
 
 
It can be placed at the top of pages being archived. But some users like to place it both at the top and the bottom of the pages being archived.
 
 
 
'''Note!''' Do not [[Wikipedia:Template substitution|subst]] this template!
 
 
 
Usually this template needs no parameters. But you can add optional parameters to specify a different link to the "archive", for instance in cases of page renames/moves. Like this:
 
:<code>{{ArchiveNotice&#124;archive=Archive/2016}}</code>
 
 
 
If you want to specify a period after which content is being archived, you can use <code>|period = 90 days</code> (as an example) as an optional parameter. The period parameter is freeform so you can use whatever format you like.
 
 
 
If you want to specify a different style for the box, you can use <code>|style = CSS values</code>.
 
 
 
==Example==
 
A full example would therefore be:
 
<pre>{{ArchiveNotice
 
&#124;archive=Archive/2016
 
&#124;period=90 days
 
&#124;style = background-color:#eaa;border:1px solid #aaa;}}
 
</pre>
 
and would yield:
 
{{ArchiveNotice
 
|archive=Archive/2016
 
|period=90 days
 
|style = background-color:#eaa;border:1px solid #aaa;}}
 
 
 
==TemplateData==
 
<templatedata>
 
{
 
    "params": {
 
        "period": {
 
            "label": "Period",
 
            "description": "Period after which content is archived.",
 
            "example": "7 days",
 
            "type": "string"
 
        },
 
        "archive": {
 
            "label": "Archive link",
 
            "description": "To specify a different link to the \"archive\", for instance in cases of page renames/moves.",
 
            "example": "Talk:Example/Past Discussions",
 
            "type": "string"
 
        },
 
    },
 
    "description": "A message box that can be placed on pages being archived",
 
    "format": "block"
 
}
 
</templatedata>
 
 
 
<includeonly>{{sandbox other||
 
<!-- Categories below this line, please; interwikis at Wikidata -->
 
[[Category:Archival templates|{{PAGENAME}}]]
 
[[Category:Talk header templates|{{PAGENAME}}]]
 
}}</includeonly>
 

Revision as of 21:34, 22 August 2019

  • With history: This is a redirect from a page containing substantive page history. This page is kept as a redirect to preserve its former content and attributions. Please do not remove the tag that generates this text (unless the need to recreate content on this page has been demonstrated), nor delete this page.
    • This template should not be used for redirects having some edit history but no meaningful content in their previous versions, nor for redirects created as a result of a page merge (use {{R from merge}} instead), nor for redirects from a title that forms a historic part of Wikipedia (use {{R with old history}} instead).