Template:Template parameter value/doc: Difference between revisions

Revision as of 01:02, 23 June 2018

Latest revision as of 13:44, 18 August 2025

(24 intermediate revisions by 9 users not shown)

Line 6:

== Usage ==

The purpose of this template is to gain the value of a template's parameter (named parameteror numbered) in an article, for usage elsewhere. For example, gaining the value of the {{para|num_episodes}} parameter in the {{tl|Infobox television}} template in an article, to use in another article.

This template is case-sensitive; i.e. setting {{para|Viewers}} will not match {{para|viewers}}. This template also only works with named or numbered parameters; i.e. it cannotcan get the first parameter of {{tl|Start date}} (the year). This template is case-sensitive; i.e. setting {{para|Viewers}} will not match {{para|viewers}}. Make sure that you are listing the article where the template exists, not where it's transcluded to.

=== Basic Syntax ===

: <code><nowikisyntaxhighlight lang="wikitext" inline>{{Template parameter value|ARTICLE|TEMPLATE|TEMPLATE-COUNT|PARAMETER|PARAMETER-COUNT}}</nowiki></codesyntaxhighlight>

=== Examples ===

; 24th usage of |OriginalAirDate= in the 3rd usage of {<nowiki />{Episode table}} in [[List of Lucifer episodes]]

: <code><nowikisyntaxhighlight lang="wikitext" inline>{{Template parameter value|List of Lucifer episodes|Episode table|3|OriginalAirDate|24}}</nowiki></codesyntaxhighlight>

: {{Template parameter value|List of Lucifer episodes|Episode table|3|OriginalAirDate|24}}

; 2nd usage of |archiveurl= in the 1st usage of {<nowiki />{Series overview}} in [[List of Agents of S.H.I.E.L.D. episodes]]

: <code><nowikisyntaxhighlight lang="wikitext" inline>{{Template parameter value|List of Agents of S.H.I.E.L.D. episodes|Series overview||archiveurlarchive-url|2}}</nowiki></codesyntaxhighlight>

: {{Template parameter value|List of Agents of S.H.I.E.L.D. episodes|Series overview||archiveurlarchive-url|2}}

; 1st usage of |LineColor= in the 2nd usage of {<nowiki />{Episode list/sublist}} in [[Vikings (season 4)]]

: <code><nowikisyntaxhighlight lang="wikitext" inline>{{Template parameter value|Vikings (season 4)|Episode list/sublist|2|LineColor}}</nowiki></codesyntaxhighlight>

: {{Template parameter value|Vikings (season 4)|Episode list/sublist|2|LineColor}}

; 1st usage of |num_episodes= in the 1st usage of {<nowiki />{Infobox television}} in [[12 Monkeys (TV series)]]

: <code><nowikisyntaxhighlight lang="wikitext" inline>{{Template parameter value|12 Monkeys (TV series)|Infobox television||num_episodes}}</nowiki></codesyntaxhighlight>

: {{Template parameter value|12 Monkeys (TV series)|Infobox television||num_episodes}}

; 3rd parameter in the 8th usage of {<nowiki />{Start date}} in [[The Big Bang Theory]]

== Parameters==

: <syntaxhighlight lang="wikitext" inline>{{Template parameter value|The Big Bang Theory|Start date|8|3}}</syntaxhighlight>

{| class="wikitable"

: {{Template parameter value|The Big Bang Theory|Start date|8|3}}

! colspan="2" | Parameter

! Description

! Type

! style="width:15%" | Status

|-

! 1

| Article

| The article where the template and value exist.<br />''Example:'' List of Lucifer episodes

| Text

| Required

|-

! 2

| Template

| The template where the value is held in the form of a named parameter.<br />''Example:'' Episode table

| Text

| Required

|-

! 3

| Numbered usage of template

| How many usages of the above template are counted. Setting to blank sets the value to 1; do ''not'' exclude this parameter.<br />Exclusion means that the third parameter will become the named parameter, which will cause the template to not work (return blank).<br />''Example:'' 24

| Number

| Optional setting<br />Required inclusion (see examples above)

|-

! 4

| Named parameter

| The named parameter in the template that holds the required value.<br />''Example:'' OriginalAirDate

| Text

| Required

|-

! 5

| Numbered usage of parameter

| How many usages of the above parameter are counted within the found template. Setting to blank or excluding (exclusion allowed) sets the value to 1.<br />''Example:'' 3

| Number

| Optional (see examples above)

|}

; 1st parameter in the last usage of {<nowiki />{date tabke sorting}} in [[List of Falcon 9 and Falcon Heavy launches]]

: <syntaxhighlight lang="wikitext" inline>{{Template parameter value|List of Falcon 9 and Falcon Heavy launches|date table sorting|-1|1}}</syntaxhighlight>

: {{Template parameter value|List of Falcon 9 and Falcon Heavy launches|date table sorting|-1|1}}

== Template data ==

<templatedata>

{

"params": {

"1": {

"label": "Page",

"description": "The page to grab templates from",

"type": "wiki-page-name",

"required": true

},

"2": {

"label": "Template",

"description": "The template to look for in the target page",

"type": "string",

"required": true

},

"3": {

"label": "Template index",

"description": "Which occurrence of the template to check for parameters in. Set to -1 for last occurrence (other negative numbers not supported).",

"type": "number"

},

"4": {

"label": "Parameter",

"description": "The name of the parameter to check for",

"type": "string",

"required": true

},

"5": {

"label": "Parameter index",

"description": "Which occurrence of the parameter to check for in the template. Does not apply if \"Ignore subtemplates\" is used",

"type": "number"

},

"ignore_subtemplates": {

"aliases": [

"ist"

],

"label": "Ignore subtemplates",

"description": "Giving this a value will make the template ignores subtemplates and their parameters when looking for a value in a template. Can be used for more precise grabbing of parameters as opposed to using a parameter index",

"type": "boolean",

"default": "no"

},

"ignore_blank": {

"label": "Ignore blank values",

"description": "Ignores keys with blank values when deciding which index of a parameter to use. This option does nothing when using ignore_subtemplates",

"type": "boolean",

"default": "no"

},

"only_subtemplates": {

"label": "Only subtemplates",

"description": "The inverse to ignore_subtemplates. Only keys that are in subtemplates of the template requested will be considered. ignore_subtemplates will take precedence over this option if both are enabled",

"type": "boolean",

"default": "no"

},

"dontprocess": {

"label": "Don't process",

"description": "If enabled, the returning result won't be processed into wikitext, and will be returned as raw data.",

"type": "boolean",

"default": "no"

},

"treat_as_regex": {

"label": "Treat as regex",

"description": "Treats the Templates input as a lua regex instead of a raw string",

"type": "boolean",

"default": "no"

}

},

"description": "A template to grab the value of parameters from templates on a page",

"format": "inline",

"paramOrder": [

"1",

"2",

"3",

"4",

"5",

"ignore_subtemplates",

"ignore_blank",

"only_subtemplates",

"dontprocess",

"treat_as_regex"

]

}</templatedata>

== See also ==

* {{tl|get parameter}}, another template doing the same thing with a different set of limitations

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |

<!-- Categories below this line, please; interwikis at Wikidata -->

[[Category:String manipulation templates]]

}}</includeonly>