Template:Redr/doc

From TibiaCraft
Jump to navigationJump to search
This is the documentation page. It should be transcluded into Template:Redr. See Template:Documentation for more information.

This template should be used on redirect pages to classify redirects under particular redirect categories (rcats), such as, for example, Category:Redirects from other capitalizations.

Usage

{{Redr|rcat}}. For multiple reasons, {{Redr|rcat1|rcat2}} Do not place any templates before the #REDIRECT [[Link]]. Always place the template after the #REDIRECT [[Link]], to prevent breaking the redirect. It is recommended to leave a blank line between the redirect and the template for readability.

Parameters

Named parameters

The template accepts the following named parameters:

Named Parameter Effect
|nocat=1 Prevents {{Redr/Reason}} from automatically adding any categories.
|nl=1 Prevents {{Redr/Reason}} from adding the text * From a to the start of the redirect reason. You can use this to change the formatting of the list item or the text. For example, if you need it to start with From an, To a, or any other phrase, use |nl=1.

This parameter also determines whether to put the redirect in Template:Cl or Template:Cl.

Un-named parameters get passed to {{Redr/Reason}}.

  • i.e. the parmaeters |1=, |2=, |3=, etc.

All of the examples below use un-named parameters.

Examples

{{Redr|Not all redirects are useful, but some are.}}

produces
This page is a redirect:
 

You might want to use |nl=1 to use custom reasons like the one above (see Template:Slink).



{{Redr|singular}}

produces
This page is a redirect:
 

{{Redr|case}} or {{Redr|capitalization}}

produces
This page is a redirect:
 

{{Redr|achievement|subtopic}} or {{Redr|advancement|subtopic}}

produces

List of reasons

Template:Redr/Reason/doc

Guide when to use this template

To use this template, place it AFTER the #REDIRECT [[Link]]. Do NOT place the template before the #REDIRECT [[Link]], as this breaks the redirect as a whole. Here is a general guide on what to place (on the first column) and on the second column generally states when to insert the template. Since this is a general guide, there may be exceptions or other circumstances not listed.

Guide
Template When to use
{{Redr|plural}} When the redirect name is plural, and the target page is singular
{{Redr|singular}} When the redirect name is singular, and the target page is plural
{{Redr|case}} When the capitalization of the redirect is different. For example, if the target is Zombified Piglin, Zombified piglin would be a valid redirect and adding {{R}} is useful, but Template:Fake redlink would not be a valid redirect.
{{Redr|alt}} For alternative names which the style guide allows
{{Redr|move}} When a page’s old name has been moved to a new name, usually, a redirect is left behind to prevent breaking links. Add this template to the redirect.
{{Redr|subtopic}} Usually when a notable redirect targets a specific subsection of a page, mainly because such subtopic does not warrant its own page.
{{Redr|ign|subtopic}} When an in-game name of an block, entity, or item, like Acacia Boat does not warrant its own page, and is a subtopic, place this template to indicate both the “ign” reason and the “subtopic” reason.
{{Redr|historical}} When the redirect is a historical name pointing to the up-to-date target
{{Redr|version}} When the redirect is a short-term version name, usually excluding the edition. For example, 20w51a to Java Edition 20w51a
{{Redr|diacritics}} Because readers should not be expected to type diacritics, add this template to redirects with the same name, but without diacritics.
{{Redr|subtopic|advancement}} For achievement or advancement redirects, state both the subtopic and achievement/advancement reason.

Extra examples

The |nl=1 parameter is useful for custom redirect reasons.

{{Redr|Not all redirects are useful, but some are.|nl=1}}

produces
This page is a redirect:
 

{{Redr|caps|Template:((avoid double redirect|Clay PotTemplate:))|nl=1}}

produces


See also

{{Redr/Reason}}