Difference between revisions of "Template:Climate change/doc"

From blackwiki
Jump to navigation Jump to search
imported>Paine Ellsworth
(update /doc)
imported>Paine Ellsworth
(→‎Template Data: include unnamed and named parameters in TemplateData)
Line 20: Line 20:
 
"description": "A navbox on climate change",
 
"description": "A navbox on climate change",
 
"params": {
 
"params": {
"state": {
+
                "1": { "label":      "(text)",
"description": "Determines whether the navbox should be collapsed, expanded or autocollapsed",
+
"description": "Will expand a single section where appropriate",
 
"type": "string",
 
"type": "string",
"default": "autocollapse",
+
"default": "all sections collapsed",
"suggested": true
+
                        "required":    false
 +
},
 +
                "expanded": {  "label":      "(text)",
 +
      "description": "Will expand a single section where appropriate",
 +
      "type": "string",
 +
      "default": "all sections collapsed",
 +
                              "required":    false
 +
},
 +
"state": {  "label":      "(text)",
 +
      "description": "Determines whether the navbox should be collapsed, expanded or autocollapsed",
 +
    "type": "string",
 +
    "default": "autocollapse",
 +
                            "required":   false
 
}
 
}
 
}
 
}

Revision as of 20:20, 9 October 2018

Place this template at the end of the article. It may be used in place of the "See also".

Parameters

Initial visibility: currently defaults to autocollapse

To set this template's initial visibility, the |state= parameter may be used:

  • |state=collapsed: {{Climate change|state=collapsed}} to show the template collapsed, i.e., hidden apart from its title bar
  • |state=expanded: {{Climate change|state=expanded}} to show the template expanded, i.e., fully visible
  • |state=autocollapse: {{Climate change|state=autocollapse}}
    • shows the template collapsed to the title bar if there is a {{navbar}}, a {{sidebar}}, or some other table on the page with the collapsible attribute
    • shows the template in its expanded state if there are no other collapsible items on the page

If the |state= parameter in the template on this page is not set, the template's initial visibility is taken from the |default= parameter in the Collapsible option template. For the template on this page, that currently evaluates to autocollapse.

Example

How to manage this template's collapsible groups/sections option
  • This template includes collapsible groups/sections. When it first appears, one of these groups/sections may be set to be visible ("expanded") while the others remain hidden ("collapsed") apart from their titlebars. To achieve this, include the parameter |name where name is one of the following words that identify the groups/sections (omit any speech or quotation marks):
    • Temperatures
    • Causes
    • History
    • Opinion
    • Politics
    • Effects
    • Mitigation
    • Adaptation
  • For example: {{Climate change/doc |Temperatures}}

(Click [show] to see example)

Template Data

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 Climate change

A navbox on climate change

Template parameters

ParameterDescriptionTypeStatus
(text)1

Will expand a single section where appropriate

Default
all sections collapsed
Stringoptional
(text)expanded

Will expand a single section where appropriate

Default
all sections collapsed
Stringoptional
(text)state

Determines whether the navbox should be collapsed, expanded or autocollapsed

Default
autocollapse
Stringoptional

See also