Difference between revisions of "Template:Chronological/doc"

From blackwiki
Jump to navigation Jump to search
imported>BoBoMisiu
(Created page, moved existing documentation from revision 587896694 of Template:Chronological.)
 
imported>Jdaloner
m ("{{temp" --> "{{tl")
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
 
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
 +
__NOTOC__
 +
== Purpose ==
 +
The purpose of this template is to notify editors that the article or section within the article may describe a sequence of events in an ambiguous, backward, or otherwise incorrect order of occurrence.
 +
 +
This template is a wrapper for {{tl|Ambox}}.
 +
 
== Usage ==
 
== Usage ==
The purpose of this template is to notify editors that the sections within the article may not be in the proper order of when they occurred.
+
{{TemplateData header}}
This template can be used
+
<templatedata>
 +
{
 +
"description": "Creates an article message box to indicate that the article or section chronology is ambiguous or out of order.",
 +
"params": {
 +
"sect": {
 +
"label": "sect",
 +
"description": "Whether the template applies to section instead of article",
 +
"type": "string",
 +
"required": false,
 +
"suggested": false,
 +
"deprecated": false,
 +
"aliases": [
 +
"1",
 +
"section"
 +
],
 +
"example": "yes"
 +
},
 +
"small": {
 +
"description": "Whether the box is displayed as a small box on the left or full width.",
 +
"example": "left, no",
 +
"default": "no",
 +
"type": "line"
 +
},
 +
"talk": {
 +
"description": "Talk page section",
 +
"type": "line"
 +
},
 +
"date": {
 +
"description": "Date template was added. ",
 +
"example": "February 2016",
 +
"suggested": true,
 +
"type": "line"
 +
}
 +
},
 +
"format": "inline"
 +
}
 +
</templatedata>
 +
 
 +
== Example ==
 +
{{markup
 +
|<nowiki>{{Chronological|date=</nowiki>{{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki>}}</nowiki>
 +
|{{Chronological|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
 +
|<nowiki>{{Chronological|sect=yes|date=</nowiki>{{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki>}}</nowiki>
 +
|{{Chronological|sect=yes|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
 +
}}
  
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |

Latest revision as of 22:56, 3 August 2020

Purpose

The purpose of this template is to notify editors that the article or section within the article may describe a sequence of events in an ambiguous, backward, or otherwise incorrect order of occurrence.

This template is a wrapper for {{Ambox}}.

Usage

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 Chronological

Creates an article message box to indicate that the article or section chronology is ambiguous or out of order.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
sectsect 1 section

Whether the template applies to section instead of article

Example
yes
Stringoptional
Smallsmall

Whether the box is displayed as a small box on the left or full width.

Default
no
Example
left, no
Lineoptional
Talktalk

Talk page section

Lineoptional
Datedate

Date template was added.

Example
February 2016
Linesuggested

Example

Markup Renders as
{{Chronological|date=January 2026}}
{{Chronological|sect=yes|date=January 2026}}