Template:Template parameter value/doc: Difference between revisions

Revision as of 11:10, 3 March 2023

Latest revision as of 13:44, 18 August 2025

(14 intermediate revisions by 6 users not shown)

Line 11:

=== 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]]

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

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

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

=== Module usage ===

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

The module can be used directly for other modules through the function <code>getValue(page, templates, parameters, options)</code>, which will return a success boolean and either why it failed or the resulting parameter value.

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

<code>page</code>, <code>templates</code>, and <code>parameters</code> are all required arguments. <code>options</code> is an optional table which can have the values <code>templateIndex</code>, <code>parameterIndex</code>, and <code>ignoreSubtemplates</code> (see the Template data for reference)

== Template data ==

Line 50 ⟶ 49:

},

"2": {

"label": "TemplatesTemplate",

"description": "The templatestemplate to look for in the target page. Can be provided in a comma split list to check for multiple templates",

"type": "string",

"required": true

Line 57 ⟶ 56:

"3": {

"label": "Template index",

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

"type": "number"

},

Line 68 ⟶ 67:

"5": {

"label": "Parameter index",

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

"type": "number"

},

Line 77 ⟶ 76:

"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"

}

},

Line 88 ⟶ 112:

"4",

"5",

"ignore_subtemplates",

"ignore_blank",

"only_subtemplates",

"dontprocess",

"treat_as_regex"

]

}</templatedata>

Line 96 ⟶ 124:

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

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

[[Category:String manipulation templates]]

}}</includeonly>