Template:R template index/doc

This is a documentation subpage for Template:R template index.
It may contain usage information, categories and other content that is not part of the original template page.

When editing this navbox template itself

Avoid double redirects in the navbox

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.

When looking through this navbox or adding its template to other pages

Purpose of this navbox template

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 WV:REDCAT.

For an expanded index (not a navbox) with examples and a complete alphanumerical listing of redirect category templates, see Wikiversity: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

How to manage this template's initial visibility

To manage this template's visibility when it first appears, add the parameter:

|state=collapsed to show the template in its collapsed state, i.e. hidden apart from its titlebar – e.g. {{R template index |state=collapsed}}

|state=expanded to show the template in its expanded state, i.e. fully visible – e.g. {{R template index |state=expanded}}

|state=autocollapse to show the template in its collapsed state but only if there is another template of the same type on the page – e.g. {{R template index |state=autocollapse}}

Unless set otherwise (see the |state= parameter in the template's code), the template's default state is collapsed.