Template:INDEX/doc

Usage[edit]

This template sets the __INDEX__ behavior switch, a magic word which instructs search engines to index the page. The only difference between the template and the magic word is that the template may optionally display a message.

On BattleTechWiki, __INDEX__ and {{INDEX}} should only be used on User and User talk pages, where they override the default, which is not to index these pages.

Optional parameters[edit]

  • |visible = yes : makes the template display a line of plain text to inform editors that the page is included in search engine indexing, e.g. {{INDEX|visible = yes}} shows the message:
This page has been added to search engine indexes.
  • Note: regardless of this parameter, if the template is used in an unsupported namespace, the following will be displayed instead:
Please use {{INDEX}} only within the User and User talk: namespaces, as those are the only two in which it has an effect.
  • |demo = yes : makes {{INDEX}} work even if it is placed in the wrong namespace so that examples of the template can function, e.g. on this doc page – {{INDEX|visible = yes|demo = yes}} renders as:
This page has been added to search engine indexes.

Usage tracking[edit]

This template was originally used as a tracking mechanism for __INDEX__ usage; valid uses are now tracked by Category:Indexed pages.

See also[edit]

MediaWiki[edit]