Template:R template index/doc
 |
This template should not be  substituted. |
 |
This is a documentation subpage for Template:R template index. It contains usage information, categories and other content or metadata that is not part of the original template. |
Wikipedia:Redirect#Bypass redirects in navigational templates]]As with all navbox templates, if you edit the contents of the nest box template itself, please do not use aliases (titles of redirects) Use a direct link to the title, in either plain or piped format. In any navbox, redirects are not any audience's friend.
If the title of the target page of the redirect page, that is, the title of the non-redirect subject page is used in the navbox, then the title will appear not as a link, but as a bold, unclickable entry that's easy to find when the navbox is placed on that entry's page.
However, a redirect listed in the same navbox on the same page will not appear in unclickable bold text but as a link, which could send an editor on a confusing runaround if they click the redirect's title.
You can use this navbox (navigation box) template to quickly find the redirect category templates (rcats or, much more rarely, redcats) to add near the bottom of a redirect page that you are creating or editing. The rcats are organized by function. For information on placing these rcats on redirects (redirect pages; a Wikipedia page that sends the browser to a different article, project page, or other type of English Wikipedia page), see the rcat's own documentation page or WP:REDCAT.
For an expanded index (not a navbox) with examples and a complete alphanumerical listing of redirect category templates, see {{Wikipedia|Wikipedia:Template index/Redirect pages. The links on this page's navbox template lead either to sections on that expanded index page or less often to other explanatory pages associated with rcats.
Usage
This navbox belongs at the bottom of template documentation pages (above the categories). Add either {{R template index}} or its shortcut, {{Rcats}}, in the following manner:
{{R template index}}
Visibility parameter |state= and its options
Initial visibility: currently defaults to collapsed
To set this template's initial visibility, the |state = parameter may be used:
- |state = collapsed:
{{R template index|state=collapsed}}to show the template collapsed, i.e., hidden apart from its title bar - |state = expanded:
{{R template index|state=expanded}}to show the template expanded, i.e., fully visible - |state = autocollapse:
{{R template index|state=autocollapse}}
If the |state = parameter in the template on this page is not set, the template's initial visibility is taken from the |default = parameter in the Collapsible option template. For the template on this page, that currently evaluates to collapsed.
See also
- Wikipedia:Template index/Redirect pages#List of redirects by function § Notes, a functional index that is composed of each and every rcat (Redirect CATegory) template in this navbox.