Wikipedia>Godsy: /* Optional parameters */ -cat

2022-02-04T08:09:26Z

Optional parameters: -cat

New page

{{Documentation subpage}}

== Usage ==
This template sets the <code><nowiki>__INDEX__</nowiki></code> behavior switch, a [[Help:Magic words|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 English Wikipedia, <code><nowiki>__INDEX__</nowiki></code> and <code><nowiki>{{INDEX}}</nowiki></code> should only be used on [[Wikipedia:User pages|User and User talk pages]], where they override the default, which is not to index these pages.

===Optional parameters===
* <code>|visible = yes</code> : makes the template display a line of plain text to inform editors that the page is included in search engine indexing, e.g. {{tlx|INDEX|2=visible = yes}} shows the message:
::{{#ifeq:{{{demo}}}|yes| __INDEX__{{#ifeq:yes|yes|This page has been added to search engine indexes.}}|{{#switch:{{NAMESPACENUMBER}}
|2
|3 = __INDEX__{{#ifeq:yes|yes|This page has been added to search engine indexes.}}
|#default = <span class="error">Please use {{tl|INDEX}} only within the User and User talk: namespaces, as those are the only two in which it has an effect.</span>
}}}}

* <code>|demo = yes</code> : makes {{tl|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 – {{tlx|INDEX|2=visible = yes|3=demo = yes}} renders as:
::{{INDEX|visible=yes|demo = yes}}

==Technical details==
<code><nowiki>__INDEX__</nowiki></code> overrides [[mw:Manual:$wgNamespaceRobotPolicies|$wgNamespaceRobotPolicies]], but not <code>robots.txt</code>. It obeys the [[mw:Manual:$wgExemptFromUserRobotsControl|$wgExemptFromUserRobotsControl]] variable. On English Wikipedia, [[MediaWiki:Robots.txt]] is used in lieu of [[mw:Manual:$wgArticleRobotPolicies|$wgArticleRobotPolicies]].

On English Wikipedia, the default robot policy for the entire wiki is to index all pages. This default has been overridden in these namespaces:
* '''User talk''' is not indexed, as of September 2008
* '''[[Wikipedia:Drafts|Draft]]''' and '''Draft talk''' are not indexed, as of December 2013
* '''User''' is not indexed, as of November 2015
Additionally certain selected pages, primarily in '''Wikipedia''' and '''Wikipedia talk''', are not indexed, as defined in [[MediaWiki:Robots.txt]].

'''[[Wikipedia:Mainspace|Mainspace]]''', '''Draft''' and '''Draft talk''' are exempt from user control, so <code><nowiki>__INDEX__</nowiki></code> is disabled in these namespaces; such use is not tracked (see below), and this template consequently has no effect there.

As all other namespaces are indexed by default, and robots.txt cannot be overridden by <code><nowiki>__INDEX__</nowiki></code>, the only namespaces where it overrides the default are '''User''' and '''User talk'''; however use in other namespaces is tracked.

===Usage tracking===
This template was originally used as a tracking mechanism for <code><nowiki>__INDEX__</nowiki></code> usage; valid uses are now tracked by [[:Category:Indexed pages]].

===History===
* Added [[mw:Manual:$wgNamespaceRobotPolicies|$wgNamespaceRobotPolicies]] to allow customisation of robot policies on a per-namespace basis ([https://phabricator.wikimedia.org/rSVN14559 June 4, 2006])
* Added [[mw:Manual:$wgContentNamespaces|$wgContentNamespaces]], which allows for articles to exist in namespaces other than the main namespace, and still be counted as valid content in the site statistics ([https://phabricator.wikimedia.org/rSVN14738 June 12, 2006])
* Added [[mw:Manual:$wgArticleRobotPolicies|$wgArticleRobotPolicies]] ([https://phabricator.wikimedia.org/rSVN22615 May 31, 2007])
*:These override the per-namespace robot policies; en.wiki uses [[MediaWiki:Robots.txt]] in lieu of this configuration setting
* The default robot policy for the entire wiki is now configurable via the [[mw:Manual:$wgDefaultRobotPolicy|$wgDefaultRobotPolicy]] setting ([https://phabricator.wikimedia.org/rSVN30602 February 6, 2008])
*:The default policy is to encourage indexing and following of links: <code>$wgDefaultRobotPolicy = 'index,follow';</code>
* [http://blog.wikimedia.org/2008/04/29/robotstxt/ Wikimedia blog: robots.txt] (April 29, 2008)
* {{section link|Wikipedia:Village pump (proposals)/Archive 25|Stopping search engines from indexing the user talk namespace?}} (April 29–30, 2008)
* {{phab|T15890}}: add user talk namespace of En.Wikipedia to Robots.txt (April 30, 2008)
* Added [[mw:Manual:$wgExemptFromUserRobotsControl|$wgExemptFromUserRobotsControl]] ([https://phabricator.wikimedia.org/rSVN37973 July 23, 2008])
*: [[Wikipedia:Wikipedia Signpost/2008-07-28/Technology report|New magic words <nowiki>__INDEX__</nowiki> and <nowiki>__NOINDEX__</nowiki> control whether a page can be indexed by search engines]], ''Wikipedia Signpost'', July 28, 2008
* [[Template:NOINDEX]] is created on August 9, 2008‎
* [[Template:INDEX]] is created on August 30, 2008‎
* [[Wikipedia:Administrators' noticeboard/Archive168#Search engine indexing updates|Search engine indexing updates]] (Sept 13, 2008)
*#Control [https://en.wikipedia.org/robots.txt en.wiki's robots.txt file] from the wiki at [[MediaWiki:Robots.txt]]
*#Update [https://noc.wikimedia.org/conf/highlight.php?file=InitialiseSettings.php InitialiseSettings.php]: <code>'wgNamespaceRobotPolicies' => array('enwiki' => array(NS_USER_TALK => 'noindex,follow',))</code>, implementing {{phab|T15890}}
* [[Wikipedia:Search engine indexing]], a January 2009 proposal which failed to achieve consensus
* {{phab|T18979}}: Tracking category for the NOINDEX and INDEX behavior switches (Jan. 11, 2009)
* On [[Special:Diff/272591874|February 22, 2009]], {{tl|NOINDEX}} begins populating [[:Category:Wikipedia noindex pages]]. {{tl|INDEX}} does not populate any categories
* {{section link|Wikipedia:Village pump (proposals)/Archive 44|Require use of NOINDEX template instead of directly using magic word}} (Feb. 27–March 5, 2009)
* [https://phabricator.wikimedia.org/rSVN56688 Add tracking categories for <nowiki>__INDEX__</nowiki> and <nowiki>__NOINDEX__</nowiki>] • [https://www.mediawiki.org/wiki/Special:Code/MediaWiki/56688 code review] (Sept. 20, 2009)
* [[:Category:Noindexed pages]] is created on October 7, 2009; concurrent with [[User talk:Happy-melon/Archive 11#Category:Noindexed pages?|this discussion]]. See also: {{section link|Wikipedia:Village pump (technical)/Archive 66|Noindex categories}}
* [[:Category:Indexed pages]] is created on October 9, 2009
* Per {{section link|Wikipedia:Categories for discussion/Log/2010 June 15|Noindexed pages}}, [[:Category:Wikipedia noindex pages]] is deleted on July 18, 2010
* [https://phabricator.wikimedia.org/rOMWCa6b09501a502249a549e0b71c887c655f86ada67 Create "Draft" namespace on the English Wikipedia] (Dec 17, 2013)
* {{phab|T104797}}: prevent search engines from indexing userspace on enwiki (July 5, 2015)
* [https://phabricator.wikimedia.org/rOMWC47413794ba09cd4496c11a6db30e79d3e4a5842d noindex user namespace on en.wikipedia.org] (Nov 23, 2015)

==See also==
* [https://en.wikipedia.org/w/index.php?title=Special:Search&profile=advanced&search=insource:/__INDEX_/&fulltext=Search&ns0=1&profile=advanced Articles using the INDEX magic word]
* [https://en.wikipedia.org/w/index.php?title=Special%3ASearch&profile=advanced&search=insource%3A%2F__INDEX_%2F&fulltext=Search&ns118=1&ns119=1&profile=advanced Drafts using the INDEX magic word]
* [[Template:NOINDEX]]
* [[Wikipedia:Controlling search engine indexing]]
===MediaWiki===
* [[MediaWiki:Robots.txt]]
* [[mw:Manual:Configuration settings#Robot policies]]
* [https://github.com/wikimedia/mediawiki/blob/master/includes/DefaultSettings.php#L7112 Default robot policy] (github.com)
* [https://phabricator.wikimedia.org/diffusion/MW/browse/master/includes/DefaultSettings.php$7112 Default robot policy] (git.wikimedia.org)

<includeonly>{{Sandbox other||

[[Category:Typing-aid templates|{{PAGENAME}}]]
[[Category:Tracking templates|{{PAGENAME}}]]
}}</includeonly>

Template:INDEX/doc - Revision history

Wikipedia>Godsy: /* Optional parameters */ -cat