Template:Redirect template/doc: Difference between revisions

From OSDev.wiki
Jump to navigation Jump to search
[checked revision][checked revision]
Content added Content deleted
m (improve prose)
(update documentation)
 
Line 3: Line 3:
* <code><nowiki>{{{1}}}</nowiki></code>: name of category being added.
* <code><nowiki>{{{1}}}</nowiki></code>: name of category being added.
* <code><nowiki>{{{2}}}</nowiki></code>: text to display after "this redirect".
* <code><nowiki>{{{2}}}</nowiki></code>: text to display after "this redirect".
* <code><nowiki>{{{nocat}}}</nowiki></code>: set to disable automatic categorization (should be set for templates themselves).
Templates built using this template can generate documentation using [[Template:Redirect template/doc template]] (which automatically adds [[:Category:Redirect templates]], unless <code>nocat</code> is set):
Templates built using this template can generate documentation using [[Template:Redirect template/doc template]] (which automatically adds [[:Category:Redirect templates]], unless <code>nocat</code> is set):
<syntaxhighlight lang="mediawiki">
<syntaxhighlight lang="mediawiki">
{{Redirect template|Redirects|is in the top-level redirects category!}}<noinclude>{{Documentation|Template:Redirect template/doc template|content=
{{Redirect template|Redirects|is in the top-level redirects category!|nocat={{{nocat|<noinclude>1</noinclude>}}}}}<noinclude>{{Documentation|Template:Redirect template/doc template|content=
{{Redirect template/doc template|Redirects}}
{{Redirect template/doc template|Redirects}}
}}</noinclude>
}}</noinclude>

Latest revision as of 22:55, 18 June 2024

This is a template documentation page

This template is a meta-template for redirect templates that assign a category to redirects. They are meant to be transcluded in the first positional argument of Template:Redirect page. This template takes following arguments:

  • {{{1}}}: name of category being added.
  • {{{2}}}: text to display after "this redirect".
  • {{{nocat}}}: set to disable automatic categorization (should be set for templates themselves).

Templates built using this template can generate documentation using Template:Redirect template/doc template (which automatically adds Category:Redirect templates, unless nocat is set):

{{Redirect template|Redirects|is in the top-level redirects category!|nocat={{{nocat|<noinclude>1</noinclude>}}}}}<noinclude>{{Documentation|Template:Redirect template/doc template|content=
{{Redirect template/doc template|Redirects}}
}}</noinclude>