Template:IncludeAt

From Moegirlpedia
Jump to: navigation, search
Template-info.svg Template Documentation  [View] [Edit] [History] [Refresh]

Template Data

<templatedata> { "params": { "noinclude": { "description": "If this argument is \"true\" (the word ONLY, case insensitive), then nothing will be included, even if rules are met.", "type": "string", "label": "Don't include" }, "anytalk": { "description": "Information to be included at any talkpage.", "type": "string" }, "main": { "description": "Information to be included at (main) namespaces.", "type": "string" }, "user": { "description": "Information to be included at User namespaces.", "type": "string" }, "template": { "description": "Information to be included at Template namespaces.", "type": "string" }, "help": { "description": "Information to be included at Help namespaces.", "type": "string" }, "category": { "description": "Information to be included at Category namespaces.", "type": "string" }, "pagename": { "description": "The FULL name of a page.", "type": "string" }, "page": { "description": "Information to be included at \"pagename\".", "type": "string" }, "pagename2": { "description": "The FULL name of a page.", "type": "string" }, "page2": { "description": "Information to be included at \"pagename2\".", "type": "string" }, "pagename3": { "description": "The FULL name of a page.", "type": "string" }, "page3": { "description": "Information to be included at \"pagename3\".", "type": "string" }, "other": { "description": "Information to be included at any pages not matching any defined selections.", "type": "string", "suggested": true }, "demospaceid": { "description": "The ID of a namespace for demonstration. This \"fake\" ID will replace the actual namespace ID of the page the template is located on, leading it to act as if it is placed at the specified namespace.", "type": "number", "label": "Demonstration Namespace ID" }, "project": { "description": "Information to be included at Project namespaces.", "type": "string" } }, "format": "block", "description": "Meta template for including different information according to the namespace or the page they are included in. Common usage includes category management (e.g. do not include document page (where examples are given) into categories).", "paramOrder": [ "anytalk", "main", "user", "project", "template", "help", "category", "pagename", "page", "pagename2", "page2", "pagename3", "page3", "other", "noinclude", "demospaceid" ] } </templatedata>

Syntax

{{IncludeAt
|anytalk=
|main=
|user=
|project=
|template=
|help=
|category=
|pagename=
|page=
|pagename2=
|page2=
|pagename3=
|page3=
|other=
|noinclude=
|demospaceid=
}}

Delete unused parameters; the template sensitive to whether a parameter is defined.

Behaviour

parameters

If a parameter is defined(even if it is null or whitespaces), the template will attempt to match its case.

If a parameter is not defined, then the template will ignore that case when matching; it will usually be encompassed by the parameter other instead.

Here are some selected behaviors of IncludeAt:

Code Result in main namespace Result in template namespace Comment
<code>{{IncludeAt
|main=main namespace
|other=other namespaces
}}</code>
main namespace other namespaces The template parameter is not defined, so IncludeAt disregard it during check. Only main namespace cases are checked and template namespace cases are caught by the other parameter.
<code>{{IncludeAt
|main=main namespace
|template=template namespace
|other=other namespaces
}}</code>
main namespace template namespace The two cases here are both defined. IncludeAt checks and provide results in both cases.
<code>{{IncludeAt
|main=main namespace
|template=
|other=other namespaces
}}</code>
main namespace (empty result) Notice that both cases here are still defined: the template parameter is present but the value is an empty string. IncludeAt checks and provide results in both cases, and for template namespace cases, it faithfully reproduces the empty string.
<code>{{IncludeAt
|main=main namespace}}</code>
main namespace (empty result) IncludeAt do not mangle with the other parameter (the default case); even if it wasn't explicitly defined, it will still catch all unmatched cases. The default value of other is an empty string.
<code>{{IncludeAt}}</code> (empty result) (empty result) An IncludeAt with no defined parameters. The other parameter will always be outputted and its default is an empty string.

When a parameter is deemed undefined, the template adds NULL or NULLPAGENEVERCHECK to the comparison argument to prevent matches. This means that, in theory, if the template is placed on a page with a name like {{{pagename}}}NULLPAGENEVERCHECK, the template will misbehave.

demospaceid

demospaceid should be a positive integer. If it is not a number (including nonexistent), the template falls back on using the namspace number of the page it is located on; if it is a number but not an integer, the decimals are truncated by the template. You may use the magicword {{NAMESPACENUMBER:(the page you want to emulate)}} or refer to the MediaWiki Manual to obtain the namespace number you need.