Difference between revisions of "Template:ArchiveNotice/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Kb.au
(formatting)
blackwiki>Kb.au
(removed blank)
Line 33: Line 33:
 
{
 
{
 
     "params": {
 
     "params": {
        "icon": {},
 
        "style": {
 
            "label": "Style",
 
            "description": "CSS values to specify a different style for the box.",
 
            "type": "string"
 
        },
 
 
         "period": {
 
         "period": {
 
             "label": "Period",
 
             "label": "Period",
Line 51: Line 45:
 
             "type": "string"
 
             "type": "string"
 
         },
 
         },
        "category": {}
 
 
     },
 
     },
 
     "description": "A message box that can be placed on pages being archived",
 
     "description": "A message box that can be placed on pages being archived",

Revision as of 19:22, 9 January 2018

Usage

This is the {{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 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:

{{ArchiveNotice|archive=Archive/2016}}

If you want to specify a period after which content is being archived, you can use |period = 90 days (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 |style = CSS values.

Example

A full example would therefore be:

{{ArchiveNotice
|archive=Archive/2016
|period=90 days
|style = background-color:#eaa;border:1px solid #aaa;}}

and would yield:

TemplateData

Syntax error in JSON.