Template:Template other/doc: Difference between revisions

From HIBIKIFORUM
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
__NOTOC__


This is a meta-template which helps other templates detect whether they are used in the "Template:" namespace.
This is a meta-template which helps other templates detect whether they are used in the "Template:" namespace.
Line 5: Line 6:
== Usage ==
== Usage ==
This template usually takes one or two parameters:
This template usually takes one or two parameters:
: {{tlc|Template other|[result/action if on a template page] (|[result/action if on another type of page])}}
: {{tlc|template other|[result/action if on a template page] (|[result/action if on another type of page])}}


For example, if {{tlf|Template other |On template page |Not on template page}} were on a "Template:" page, it would return:
For example, if {{tji|template other|On template page|Not on template page}} were on a "Template:" page, it would return:
: {{Template other |On template page |Not on template page}}
: {{Template other |On template page |Not on template page}}
On any other type of page (e.g. "Wikipedia:", "User:") it would return:
On any other type of page (e.g. "Wikipedia:", "User:") it would return:
: {{Template other|demospace=other |On template page |Not on template page}}
: {{Template other|demospace=other |On template page |Not on template page}}


A typical use is to manage the categorization of template pages. Adding {{tlf|Template other | |{{!((}}Category:''[category name]''{{))!}}}} to a template, for instance, means it would only categorize a page when that page isn't a template page. (The first parameter consists of nothing, so no action taken if/when the template is on a template page.)
A typical use is to manage the categorization of template pages. Adding the example below to a template, for instance, means it would only categorize a page when that page isn't a template page. (The first parameter consists of nothing, so no action taken if/when the template is on a template page.)
 
: {{Pre|width=50%|{{{{fcb|#4169e1|template other}}||{{!((}}{{fcb|#2e8b57|Category}}:{{font color|#933|Some not template category}}]]}} }}


== Demospace ==
== Demospace ==
Line 20: Line 23:


For example:
For example:
{{tj|Template other
 
   | demospace: template
{{Pre|width=25%|{{{{fcb|#4169e1|template other}}
  | Template page text  
   | {{font color|#933|Template pages text}}
   | Other pages text  
   | {{font color|#933|Other pages text}}
}}
  | {{fcb|#2e8b57|demospace}} = {{font color|#933|template}}
}} }}


No matter on what kind of page the code above is used, it returns:
No matter on what kind of page the code above is used, it returns:
Line 35: Line 39:
You can make it so your template also understands the '''demospace''' parameter. That means you can demonstrate the different appearances of your template in the documentation for your template. Then do like this:
You can make it so your template also understands the '''demospace''' parameter. That means you can demonstrate the different appearances of your template in the documentation for your template. Then do like this:


{{tj|Template other  
{{Pre|width=25%|{{{{fcb|#4169e1|template other}}
   | Template page text  
   | {{font color|#933|Template pages text }}
   | Other pages text  
   | {{font color|#933|Other pages text }}
   | demospace: {{(((}}demospace{{!}}{{)))}}
   | {{fcb|#2e8b57|demospace}} = {{font color|#933|<nowiki>{{{demospace|}}}</nowiki>}}
}}
}} }}


==Technical details==
== Technical details ==
This template detects "Template talk:" pages as type '''other'''.
This template detects "Template talk:" pages as type '''other'''.
== TemplateData ==
<templatedata>
{
"params": {
"1": {
"label": "If template",
"description": "Content if page is located on a template page.",
"type": "content"
},
"2": {
"label": "If not template",
"description": "Content if page is not located on a template page",
"type": "content"
}
}
}
</templatedata>


<includeonly>{{sandbox other||{{testcases other||
<includeonly>{{sandbox other||{{testcases other||

Revision as of 01:54, 19 June 2023

Light bulb.png }}
It contains usage information, categories and other content that is not part of the original template page.


This is a meta-template which helps other templates detect whether they are used in the "Template:" namespace.

Usage

This template usually takes one or two parameters:

{{template other|[result/action if on a template page] (|[result/action if on another type of page])}}

For example, if {{template other|On template page|Not on template page}} were on a "Template:" page, it would return:

On template page

On any other type of page (e.g. "Wikipedia:", "User:") it would return:

Not on template page

A typical use is to manage the categorization of template pages. Adding the example below to a template, for instance, means it would only categorize a page when that page isn't a template page. (The first parameter consists of nothing, so no action taken if/when the template is on a template page.)

{{template other||[[Category:Some not template category]]}}

Demospace

The parameter |demospace= can be used to demonstrate or test this template. By default, it is undefined and has no effect on the template's action, but:

  • when set as "template" (|demospace=template), it prompts the template to return the first result/action above (i.e. to behave as if on a "Template:" page) even if the template is on a different type of page;
  • when set as "other" (|demospace=other), it prompts the template to return the second result/action above (i.e. to behave as if not on a "Template:" page) even if the template is on a "Template:" page.

For example:

{{template other
  | Template pages text
  | Other pages text
  | demospace = template
}}

No matter on what kind of page the code above is used, it returns: Template page text

You can make it so your template also understands the demospace parameter. That means you can demonstrate the different appearances of your template in the documentation for your template. Then do like this:

{{template other
  | Template pages text
  | Other pages text
  | demospace = {{{demospace|}}}
}}

Technical details

This template detects "Template talk:" pages as type other.

TemplateData

No description.

Template parameters

ParameterDescriptionTypeStatus
If template1

Content if page is located on a template page.

Contentoptional
If not template2

Content if page is not located on a template page

Contentoptional