Template:Ns detect - Revision history

Gorgon: Missed a space.

2017-02-03T06:57:49Z

Missed a space.

← Older revision		Revision as of 06:57, 3 February 2017
Line 248:		Line 248:
	If you intend to use <span class="plainlinks">[http://www.mediawiki.org/wiki/Help:Tables wikitables]</span> as parameter values in this template, then you need to know this:		If you intend to use <span class="plainlinks">[http://www.mediawiki.org/wiki/Help:Tables wikitables]</span> as parameter values in this template, then you need to know this:

	<span class="plainlinks">[http://www.mediawiki.org/wiki/Help:Templates Templates]</span> have a problem handling parameter data that contains pipes "<code>\|</code>", unless the pipe is inside another template <code><nowiki>{{name \| param1 }}</nowiki></code>, or inside a piped link <code><nowiki>[[Help:Template\|help]]</nowiki></code>. Therefore templates can not handle wikitables as input, unless you escape them by using the '''<nowiki>{{!}}</nowiki>''' magic word (parser function - see: <span class="plainlinks">[http://www.mediawiki.org/wiki/Help:Magic_words#Other Help:Magic words#Other]</span>). This makes it hard to use wikitables as parameters in templates. Instead, the usual solution is to use [[Wikipedia:Help:Table#Other_table_syntax \| HTML wikimarkup]] for the table code, which is more robust.		<span class="plainlinks">[http://www.mediawiki.org/wiki/Help:Templates Templates]</span> have a problem handling parameter data that contains pipes "<code>\|</code>", unless the pipe is inside another template <code><nowiki>{{name \| param1 }}</nowiki></code>, or inside a piped link <code><nowiki>[[Help:Template \| help]]</nowiki></code>. Therefore templates can not handle wikitables as input, unless you escape them by using the '''<nowiki>{{!}}</nowiki>''' magic word (parser function - see: <span class="plainlinks">[http://www.mediawiki.org/wiki/Help:Magic_words#Other Help:Magic words#Other]</span>). This makes it hard to use wikitables as parameters in templates. Instead, the usual solution is to use [[Wikipedia:Help:Table#Other_table_syntax \| HTML wikimarkup]] for the table code, which is more robust.

	'''''Note:''' [[Template:!]] functionality was replaced in MediaWiki version 1.24 by the '''<nowiki>{{!}}</nowiki>''' magic word, and the template is ignored when using it.''		'''''Note:''' [[Template:!]] functionality was replaced in MediaWiki version 1.24 by the '''<nowiki>{{!}}</nowiki>''' magic word, and the template is ignored when using it.''

	{{ns detect \| template = [[Category:Templates \|{{PAGENAME}}]] }}</noinclude>		{{ns detect \| template = [[Category:Templates \|{{PAGENAME}}]] }}</noinclude>

Gorgon: Updated HTML wikimarkup link to markup specific to wikitables and tweaked example spacing.

2017-02-03T06:37:08Z

Updated HTML wikimarkup link to markup specific to wikitables and tweaked example spacing.

← Older revision		Revision as of 06:37, 3 February 2017
Line 66:		Line 66:
	'''Note:''' The following examples use multiple lines for improved readability. All of them can be written as single lines as well.		'''Note:''' The following examples use multiple lines for improved readability. All of them can be written as single lines as well.

	E.g., <code><nowiki>{{ns detect \| main = Article text \| talk = Talk page text \| other = Other pages text}}</nowiki></code> for the first example below.		E.g., <code><nowiki>{{ns detect \| main = Article text \| talk = Talk page text \| other = Other pages text }}</nowiki></code> for the first example below.


Line 197:		Line 197:
	E.g., A sandbox page in a userspace <code>User:Example/sandbox</code> for testing your template '''<nowiki>{{mytemplate}}</nowiki>''' as if it was in the main namespace:		E.g., A sandbox page in a userspace <code>User:Example/sandbox</code> for testing your template '''<nowiki>{{mytemplate}}</nowiki>''' as if it was in the main namespace:

	:'''Code in User:Example/sandbox:''' <code><nowiki>{{mytemplate \| demospace = main}}</nowiki></code> or <code><nowiki>{{mytemplate \| page = Example page}}</nowiki></code>		:'''Code in User:Example/sandbox:''' <code><nowiki>{{mytemplate \| demospace = main }}</nowiki></code> or <code><nowiki>{{mytemplate \| page = Example page }}</nowiki></code>

	:'''Note:''' There is no "Main:" prefix on pages in the main namespace, so only the <code>Example page</code> "pagename" is required.		:'''Note:''' There is no "Main:" prefix on pages in the main namespace, so only the <code>Example page</code> "pagename" is required.
Line 248:		Line 248:
	If you intend to use <span class="plainlinks">[http://www.mediawiki.org/wiki/Help:Tables wikitables]</span> as parameter values in this template, then you need to know this:		If you intend to use <span class="plainlinks">[http://www.mediawiki.org/wiki/Help:Tables wikitables]</span> as parameter values in this template, then you need to know this:

	<span class="plainlinks">[http://www.mediawiki.org/wiki/Help:Templates Templates]</span> have a problem handling parameter data that contains pipes "<code>\|</code>", unless the pipe is inside another template <code><nowiki>{{name\|param1}}</nowiki></code>, or inside a piped link <code><nowiki>[[Help:Template\|help]]</nowiki></code>. Therefore templates can not handle wikitables as input, unless you escape them by using the '''<nowiki>{{!}}</nowiki>''' magic word (parser function - see: <span class="plainlinks">[http://www.mediawiki.org/wiki/Help:Magic_words#Other Help:Magic words#Other]</span>). This makes it hard to use wikitables as parameters in templates. Instead, the usual solution is to use [[Wikipedia:Help:~~HTML_in_wikitext~~ \| HTML wikimarkup]] for the table code, which is more robust.		<span class="plainlinks">[http://www.mediawiki.org/wiki/Help:Templates Templates]</span> have a problem handling parameter data that contains pipes "<code>\|</code>", unless the pipe is inside another template <code><nowiki>{{name \| param1 }}</nowiki></code>, or inside a piped link <code><nowiki>[[Help:Template\|help]]</nowiki></code>. Therefore templates can not handle wikitables as input, unless you escape them by using the '''<nowiki>{{!}}</nowiki>''' magic word (parser function - see: <span class="plainlinks">[http://www.mediawiki.org/wiki/Help:Magic_words#Other Help:Magic words#Other]</span>). This makes it hard to use wikitables as parameters in templates. Instead, the usual solution is to use [[Wikipedia:Help:Table#Other_table_syntax \| HTML wikimarkup]] for the table code, which is more robust.

	'''''Note:''' [[Template:!]] functionality was replaced in MediaWiki version 1.24 by the '''<nowiki>{{!}}</nowiki>''' magic word, and the template is ignored when using it.''		'''''Note:''' [[Template:!]] functionality was replaced in MediaWiki version 1.24 by the '''<nowiki>{{!}}</nowiki>''' magic word, and the template is ignored when using it.''

	{{ns detect \| template = [[Category:Templates \|{{PAGENAME}}]] }}</noinclude>		{{ns detect \| template = [[Category:Templates \|{{PAGENAME}}]] }}</noinclude>

Gorgon: Template:Ns detect (Namespace detect) - for helping other templates and pages detect what type of namespace they are used in, and can return different results when used in them.

2017-02-02T15:47:37Z

Template:Ns detect (Namespace detect) - for helping other templates and pages detect what type of namespace they are used in, and can return different results when used in them.

New page

{{#switch:
{{lc: 

{{#if:{{{demospace|}}}
| {{{demospace}}}
| {{#if:{{{page|}}}
| 
{{#ifeq:{{NAMESPACE:{{{page}}} }}|{{TALKSPACE:{{{page}}} }}
| talk
| {{SUBJECTSPACE:{{{page}}} }}
}}
| 
{{#ifeq:{{NAMESPACE}}|{{TALKSPACE}}
| talk
| {{SUBJECTSPACE}}
}}
}}
}}
}}


| main 
| = {{{main| {{{other|}}} }}}
| talk = {{{talk| {{{other|}}} }}}
| user = {{{user| {{{other|}}} }}}
| avlis wiki = {{{avlis wiki| {{{other|}}} }}}
| file
| image = {{{file| {{{image| {{{other|}}} }}} }}}
| mediawiki = {{{mediawiki| {{{other|}}} }}}
| template = {{{template| {{{other|}}} }}}
| help = {{{help| {{{other|}}} }}}
| category = {{{category| {{{other|}}} }}}
| other
| #default = {{{other|}}} 

}}<noinclude>

== Template:Ns detect (Namespace detect) ==

This template is based on [http://www.mediawiki.org/wiki/Template:Namespace_detect Template:Namespace detect].

It uses the original markup, modified for Avlis wiki namespaces. The documentation below was copied to this template, since we do not use [[Wikipedia:Wikipedia:Template_documentation#How_to_create_a_documentation_subpage | documentation sub-pages]]. It has also been modified for Avlis namespaces, and most of the [http://www.mediawiki.org/wiki/MediaWiki MediaWiki] specific information, links and sub-templates have either been removed, or modified for the Avlis wiki. It has been reformatted, and several sections modified for improved clarity.

See the [http://www.mediawiki.org/wiki/Template:Namespace_detect/doc original template documentation] for further details.

== Template documentation ==

This is the '''<nowiki>{{ns detect}}</nowiki>''' (Namespace detect) meta-template.

It helps other templates and pages detect what type of namespace they are used in, and can return different results when used in them.

It detects and groups all of the different [http://wiki.avlis.org/mediawiki/api.php?action=query&meta=siteinfo&siprop=namespaces namespaces] used on the Avlis wiki into several types:

:'''main''' = Main/article namespace, as in normal Avlis wiki articles.
:'''talk''' = Any talk namespace, such as page names that start with "Talk:", "User talk:", "File talk:" and so on.
:'''user, avlis wiki, file, mediawiki, template, help, and category''' = The other namespaces, except for talk namespace pages.
:'''other''' = Any namespaces that were not specified as a parameter to the template. ''See the '''Note:''' in the "[[#Parameters | Parameters]]" section below.''

''For backwards compatibility, this template also understands the old name '''image''' for '''file'''. But using '''image''' is now deprecated.''

=== Usage ===

'''Note:''' The following examples use multiple lines for improved readability. All of them can be written as single lines as well.

E.g., <code><nowiki>{{ns detect | main = Article text | talk = Talk page text | other = Other pages text}}</nowiki></code> for the first example below.

This template takes one or more parameters, named after the different namespace types listed above. Like this:

<pre style="white-space: pre">
{{ns detect
| main = Article text
| talk = Talk page text
| other = Other pages text
}}
</pre>

If the template is in a main (article) namespace page, it will return this:

:{{ns detect | demospace = main
| main = Article text
| talk = Talk page text
| other = Other pages text
}}

If the template is used in any other namespace page than a main (article), or a talk page, it will return this:

:{{ns detect
| main = Article text
| talk = Talk page text
| other = Other pages text
}}

The example above made the template return something for all other namespace page types. But if we don't use the '''other''' parameter, or leave it empty, then it will not return anything for the other namespace page types. Like this:

<pre style="white-space: pre">
{{ns detect
| file = File page text
| category = Category page text
| other =
}}
</pre>

In any pages, other than file and category namespace pages, the code above will render nothing.

:{{ns detect
| file = File page text
| category = Category page text
| other =
}}

By using an empty parameter, you can make it so the template doesn't render anything for a specific namespace type page. Like this:

<pre style="white-space: pre">
{{ns detect
| main =
| other = Other pages text
}}
</pre>

The code above will render nothing when in main (article) namespace pages, but will return this when in other namespace type pages:

:{{ns detect
| main =
| other = Other pages text
}}

As an extended example of empty parameter usage, if you need to assign the same value to more than one namespace type parameter as a result, and the value is a larger block of code, it is inefficient to duplicate the same code for multiple parameter values. Instead, you can use empty parameters to return nothing for namespace type pages that you don't want the value used in (all except the ones you need), and then use the '''other''' parameter value to return the result of your block of code for the namespace type pages that you do want it in. Like this:

<pre style="white-space: pre">
{{ns detect
| talk = | avlis wiki = | file = | mediawiki = | help = | category =
| other = {{{|Result of large, multi-line block of code.}}}
}}
</pre>

For the result below, when in main (article), user and template namespace pages, the code above will use the '''other''' parameter value, since those 3 namespace types weren't included as parameters. When in all other namespace type pages, nothing is returned, since they all have empty values:

:{{ns detect
| talk = | avlis wiki = | file = | mediawiki = | help = | category =
| other = {{{|Result of large, multi-line block of code.}}}
}}

=== Demospace and page ===

For testing and demonstration purposes, this template can take two parameters, named '''demospace''' and '''page'''. Only assign a value to one of these in your template. If both have values assigned, then only the '''demospace''' parameter will be used.

'''Demospace''' understands any of the namespace type names used by this template, including the '''other''' namespace type. It tells the template to behave like it is in a specific namespace type page. Like this:

<pre style="white-space: pre">
{{ns detect
| main = Article text
| other = Other pages text
| demospace = main
}}
</pre>

No matter what namespace the code above is used in, it will return this:

:{{ns detect
| main = Article text
| other = Other pages text
| demospace = main
}}

The '''page''' parameter instead takes a "namespace:pagename" value. It makes this template behave as if rendered in that page's namespace type. The page name doesn't have to be an existing page. Like this:

<pre style="white-space: pre">
{{ns detect
| user = User page text
| other = Other pages text
| page = User:Example
}}
</pre>

No matter what namespace the code above is used in, it will return this:

:{{ns detect
| user = User page text
| other = Other pages text
| page = User:Example
}}

'''Note:''' The value of '''page''' is only used to determine the namespace type of that page. The "pagename" part of the "namespace:pagename" value isn't used for anything, but is required by the '''<nowiki>{{NAMESPACE}}</nowiki>''', '''<nowiki>{{TALKSPACE}}</nowiki>''' and '''<nowiki>{{SUBJECTSPACE}}</nowiki>''' magic words that are used by the '''<nowiki>{{ns detect}}</nowiki>''' template (see: [http://www.mediawiki.org/wiki/Help:Magic_words#Namespaces Help:Magic words#Namespaces]). The '''demospace''' parameter is usually a better choice for setting an alternate namespace type in testing, unless you need to use a "namespace:pagename" value.

It may be convenient to define the '''demospace''' and/or '''page''' parameters as (optional) named parameters by the page using your template, and send them on to the '''<nowiki>{{ns detect}}</nowiki>''' template.

E.g., A sandbox page in a userspace <code>User:Example/sandbox</code> for testing your template '''<nowiki>{{mytemplate}}</nowiki>''' as if it was in the main namespace:

:'''Code in User:Example/sandbox:''' <code><nowiki>{{mytemplate | demospace = main}}</nowiki></code> or <code><nowiki>{{mytemplate | page = Example page}}</nowiki></code>

:'''Note:''' There is no "Main:" prefix on pages in the main namespace, so only the <code>Example page</code> "pagename" is required.

:''This also allows testing other namespaces types from the same sandbox page by changing the parameter values, even using preview mode.''

Then in your '''<nowiki>{{mytemplate}}</nowiki>''' template, do like this:

<pre style="white-space: pre">
{{ns detect
| main = Article text
| other = Other pages text
| demospace = {{{demospace|}}}
| page = {{{page|}}}
}}
</pre>

These parameters will be used by the template only if defined by the page using your template. If both the '''demospace''' and '''page''' parameters are empty, or undefined, then the template will detect namespace types as usual for the page. As described above, if both the '''demospace''' and '''page''' parameters have values assigned, then only the '''demospace''' parameter will be used.

=== Parameters ===

List of all parameters:

<pre style="white-space: pre">
{{ns detect
| main =
| talk =
| user =
| avlis wiki =
| file =
| mediawiki =
| template =
| help =
| category =
| other =
| demospace = {{{demospace|}}}
One of: main, talk, user, avlis wiki,
file, mediawiki, template,
help, category, other
| page = {{{page|}}} E.g., User:Example
}}
</pre>

'''Note:''' Empty values for the '''main''' through '''category''' parameters are different than not including (defining) them. An undefined parameter (i.e, one you do not include in your template usage) will use the result of the '''other''' parameter when in that namespace type. Any that are defined, but not assigned a value (i.e, included in the template usage, but nothing after the = ) will render nothing when used in that namespace type.

=== Technical details ===

If you intend to use [http://www.mediawiki.org/wiki/Help:Tables wikitables] as parameter values in this template, then you need to know this:

[http://www.mediawiki.org/wiki/Help:Templates Templates] have a problem handling parameter data that contains pipes "<code>|</code>", unless the pipe is inside another template <code><nowiki>{{name|param1}}</nowiki></code>, or inside a piped link <code><nowiki>[[Help:Template|help]]</nowiki></code>. Therefore templates can not handle wikitables as input, unless you escape them by using the '''<nowiki>{{!}}</nowiki>''' magic word (parser function - see: [http://www.mediawiki.org/wiki/Help:Magic_words#Other Help:Magic words#Other]). This makes it hard to use wikitables as parameters in templates. Instead, the usual solution is to use [[Wikipedia:Help:HTML_in_wikitext | HTML wikimarkup]] for the table code, which is more robust.

'''''Note:''' [[Template:!]] functionality was replaced in MediaWiki version 1.24 by the '''<nowiki>{{!}}</nowiki>''' magic word, and the template is ignored when using it.''

{{ns detect | template = [[Category:Templates |{{PAGENAME}}]] }}</noinclude>