View source for Template:R from fictional location/doc

{{Documentation subpage}}
{{Substitution|not|nor used to tag [[Wikipedia:Soft redirects|soft redirects]]}}
{{Twinkle standard installation}}
{{Lua|Module:R from fictional object multi}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

== Purpose ==
This redirect category ([[WP:RCAT|rcat]]) template is used to categorize [[Wikipedia:Redirect|redirect]]s from a [[fictional location]] to a related article to a [[Help:list|list of locations]], a type of article that is a collection of brief descriptions and covers the subject more comprehensively. This could be a formal List article, or an article with a formal bulleted list of locations, or an article to which the location is related and lists other locations informally. Links to locations should use this redirect and should {{em|not}} be [[WP:piped|piped]] with the target page name. This allows "what links here" to be used to identify the links to the individual sections. This redirect template populates {{Cat|All fictional location redirects}} and when the first parameter is not used, {{Cat|Redirects from fictional locations}} is also populated.

== Usage ==
{{Hatnote|Use this redirect category template on '''[[wp:mainspace|mainspace]] redirects only'''.}}

Use this template on any mainspace redirect from a fictional location to a related fictional article or to a list in which the location is an entry, either as a section or as non-section entries. If the redirect is to a section also use {{tl|R to section}}; if it is to an anchor (other than a "section anchor") use {{tl|R to anchor}}.

=== General usage ===
Add this redirect category to a redirect ({{em|not}} a [[Help:talk-page|talk-page]] redirect) in the following manner:

<pre>
#REDIRECT [[(target article title)]]

{{Redirect category shell|
{{R from fictional location}}
}}
</pre>

Template {{tl|Redirect category shell}} may be used to add as many appropriate redirect categories as needed. For more information see the documentation on its [[Template:Redirect category shell|template documentation]].

This redirect category may also tag a redirect individually:
<pre>
#REDIRECT [[(target article title)]]

{{R from fictional location}}
</pre>

This is in accord with instructions found at [[Wikipedia:REDCAT]].

=== Usage with creative work parameter ===
An optional unnamed parameter, {{para|1|(name of work)}}, may be used to supply the name of the creative work that includes the location. This will sort the redirect into a more specific category for that work. For example:

<pre>
{{Redirect category shell|
{{R from fictional location|1=Star Wars}}
}}
</pre>

{{em|or}}

<pre>
{{Redirect category shell|
{{R from fictional location|Star Wars}}
}}
</pre>

{{em|or}}

<pre>
{{R from fictional location|Star Wars}}
</pre>

All three of the above will populate {{Cat|Star Wars location redirects}}.

=== Usage with sort key parameter ===
A second optional unnamed parameter, {{para|2|(sort key)}} may be used to provide a [[WP:sort key|sort key]] for the fictional location that is redirected. For example:

<pre>
{{Redirect category shell|
{{R from fictional location|1=Star Trek|2=Bassen Rift, The}}
}}
</pre>

{{em|or}}

<pre>
{{Redirect category shell|
{{R from fictional location|Star Trek|Bassen Rift, The}}
}}
</pre>

{{em|or}}

<pre>
{{R from fictional location|Star Trek|Bassen Rift, The}}
</pre>

In {{Cat|Star Trek location redirects}}, all three of the above sort the location redirect, "The Bassen Rift", in alphabetical order by "Bassen" ("B") instead of by "The" ("T"). Without the second parameter, the template sort key is either the redirect page name or the [[WP:DEFAULTSORT|DEFAULTSORT]], if included.

===TemplateData===
{{TemplateData header|noheader=1}}
<templatedata>
{
	"description": "A redirect category template which is used to categorize redirects from a fictional location to a related article to a list of location.",
	"params": {
		"1": {
			"label": "Series name",
			"type": "wiki-page-name",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "The series article name."
		},
		"2": {
			"label": "Sort key",
			"type": "string",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "A sort key for the redirect entry."
		}
	},
	"format": "inline"
}
</templatedata>

=== Corresponding category ===
'''Important note:''' the very first time that a creative-work-specific subcategory is named in the first parameter, that category will appear as a [[WP:Red link|red link]] ([[Red link example|Category:Tiddlywinks location redirects]]) at the bottom of the redirect page (if this is not seen or no categories can be seen at the bottom of the page, then be sure your preferences are set to [[Template:Redirect category shell/Comparison#hidcat|see hidden categories]]). If the category link is red, it means that the category [[WP:CATEGORY#Creating category pages|must be created]] to correctly sort the fictional location.

The category name should be similar to creative work article. So if the article uses disambiguation, the category should use it as well.

<pre>
[[Category:(series name) location redirects]]
</pre>

When creating the new category, place {{tl|Fiction-based redirects to list entries category handler}} at the top as follows:
<pre>
{{Fiction-based redirects to list entries category handler|media=}}
</pre>

{{para|media}} should be the type of media the fictional work is. For example: {{para|media|Television}}, {{para|media|Film}}. If in doubt, check [[:Category:Redirects from fictional locations]] and see what categories are available.

=== Printworthiness ===
{{info|image=Stop hand nuvola.svg|Please do not alter the printworthy settings of this rcat without first notifying the '''[[WP:Version 1.0 Editorial Team|Version 1.0 Editorial Team]]''', who are responsible for any and all materials, including redirects, that go into a printed version of ''Wikipedia''.}}
* In main-article namespace, some redirects are considered unprintworthy and others printworthy, so there is no default sort for [[wp:printworthiness|printworthiness]]. In 2003, efforts were begun to support the [[Wikimedia Foundation]]'s goal of increasing access and availability of ''Wikipedia'' articles in {{diff|Wikipedia:Pushing to 1.0||1319195|printed versions}}. Some redirect category templates automatically populate either {{Cat|Printworthy redirects}} or {{Cat|Unprintworthy redirects}} by default. Others like this template, do not, and that means it is up to editors to choose which of those redirect categories, ''Printworthy'' or ''Unprintworthy'', is appropriate and should be populated. The templates that are used separately to populate those categories are:
:* {{tlx|R printworthy}}
:* {{tlx|R unprintworthy}}

Click on each one for more details and guidance.

====Usage with printworthy and unprintworthy templates====
<pre>
{{Redirect category shell|
{{R from fictional location}}
{{R printworthy}}
}}

{{Redirect category shell|
{{R from fictional location}}
{{R unprintworthy}}
}}
</pre>

=== See also ===
* {{tl|R to anchor}}
* {{tl|R to list entry}}
* {{tl|R to section}}
* [[Wikipedia:WikiProject Redirect/Style guide|WikiProject Redirect/Style guide]]

{{R template index}}

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Redirect templates|Fictional location]]
[[Category:Redirects from fictional locations| ]]
[[Category:Templates for redirects relating to fiction|Location]]
[[Category:Templates for redirects to lists|Fictional location]]

}}</includeonly> <noinclude>
[[Category:Rcat template documentation pages|Fictional location]]
</noinclude>