Difference between revisions of "Template:Archiving/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Vanisaac
m (→‎See also: clean up per WP:CAT#T and WP:AWBREQ add template:Sandbox other)
blackwiki>NYKevin
(Modernize documentation, add Wikipedia:TemplateData)
Line 3: Line 3:
  
 
=== Usage ===
 
=== Usage ===
Use this template on a talk page when you are archiving it to prevent [[Help:Edit conflict|edit conflicts]] (like {{tl2|in use}}).
+
Use this template on a talk page when you are archiving it to prevent [[Help:Edit conflict|edit conflicts]] (like {{tl2|in use}}). This is only necessary if you are doing something complicated, such as [[Help:Archiving a talk page/Other procedures|move archival]] or archiving multiple sections one at a time. This template is merely a polite request; if left in place for an extended period of time, other editors should feel free to remove it.
  
If archiving a section (e.g. via cut and paste), do
+
If archiving a section, use:
 
  {{tnull|archiving|2=section=yes}}
 
  {{tnull|archiving|2=section=yes}}
(actually, you can set section to anything, but yes makes the most sense)
 
  
Please do not [[WP:SUBST|substitute]] this template, as it uses [[Help:ParserFunctions|ParserFunctions]].
+
This template should not be [[WP:SUBST|substituted]].
 +
 
 +
=== TemplateData ===
 +
{{TemplateData header}}
 +
<TemplateData>{
 +
  "description": "Inserts a banner asking users not to edit a discussion page for a short time while it is being archived.",
 +
  "params": {
 +
    "section": {
 +
      "label": "Section",
 +
      "description": "If nonempty, banner will say 'section' instead of 'page.'",
 +
      "required": false,
 +
      "type": "string"
 +
    }
 +
  }
 +
}</TemplateData>
  
 
=== See also ===
 
=== See also ===

Revision as of 18:16, 8 July 2020

Usage

Use this template on a talk page when you are archiving it to prevent edit conflicts (like {{in use}}). This is only necessary if you are doing something complicated, such as move archival or archiving multiple sections one at a time. This template is merely a polite request; if left in place for an extended period of time, other editors should feel free to remove it.

If archiving a section, use:

{{archiving|section=yes}}

This template should not be substituted.

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Archiving

Inserts a banner asking users not to edit a discussion page for a short time while it is being archived.

Template parameters

ParameterDescriptionTypeStatus
Sectionsection

If nonempty, banner will say 'section' instead of 'page.'

Stringoptional

See also

Template:Warchivenav