imported>CheckNineEight: /* Parameters */ add TemplateData

2025-10-18T12:55:29Z

Parameters: add TemplateData

New page

{{Documentation subpage}}
{{tsh|pri}}

This template transcludes [[Special:PrefixIndex]], which can be done with {{tla|Wikipedia:Special:PrefixIndex|Special:PrefIndex}}, but adds formatting. It can split the list into multiple columns, remove redirects, and strip the output of the prefix.

== Usage ==
This template transcludes [[Special:PrefixIndex]] (yes, you can do that!) along with some extra stuff, to produce a list of pages with names beginning with a certain prefix. Enter the prefix in the first unnamed parameter. To split the list into multiple columns, enter the column width (e.g. 15em, or 30em) in the <code>|colwidth=</code> parameter. To hide redirects from the list, enter anything in the <code>|redr=</code> parameter and to strip the given prefix from all the page names, enter anything <code>|stripprefix=</code> parameter.

You can do ''most'' of this stuff (except for the {{para|columns}} and {{para|colwidth}} part) by directly transcluding the special page. Its documentation and talk can be seen at the (bizarrely located due to technical reasons) pages [[Wikipedia:Special:PrefixIndex]] and [[Wikipedia talk:Special:PrefixIndex]].

Like, for example: <code><nowiki>{{Special:PrefixIndex/Dogs of|stripprefix=1|hideredirects=1}}</nowiki></code>
{{Special:PrefixIndex/Dogs of|stripprefix=1|hideredirects=1}}

The main thing this template adds is the ability to specify columns and column width.

Compare this to the equivalent usage with {{tl|PrefixIndex}}:

Like, for example: <code><nowiki>{{PrefixIndex|Dogs of|stripprefix=1|hideredirects=1|colwidth=12em}}</nowiki></code>
{{PrefixIndex|Dogs of|stripprefix=1|hideredirects=1|colwidth=12em}}

== Syntax ==
Vertical format that takes up a lot of space and is easy to read:
<nowiki>{{PrefixIndex</nowiki>
<nowiki> | prefix = </nowiki>
<nowiki> | stripprefix = </nowiki>
<nowiki> | hideredirects = </nowiki>
<nowiki> | colwidth = </nowiki>
<nowiki>}}</nowiki>
Horizontal format:
<nowiki>{{PrefixIndex||stripprefix=|hideredirects=|colwidth=}}</nowiki>
===Parameters===
{{TemplateData header}}
<templatedata>
{
"params": {
"1": {
"aliases": [
"prefix"
],
"label": "Prefix",
"description": "The prefix to list or search from; defaults to the current page that the template is transcluded from.",
"type": "string",
"required": true
},
"colwidth": {
"label": "Column width",
"description": "Width of columns to use, in em units.",
"example": "30em",
"type": "string"
},
"redr": {
"aliases": [
"hideredirects"
],
"label": "Hide redirects",
"description": "If set, does not display redirects.",
"type": "boolean"
},
"stripprefix": {
"label": "Strip prefix",
"description": "If set, strip the prefix value from displayed list items. ",
"type": "boolean"
}
},
"description": "This template transcludes Special:PrefixIndex, with added formatting controls."
}
</templatedata>

=== See also ===
* [[Special:PrefixIndex]]
* [[Wikipedia:Special:PrefixIndex]]
* [[Wikipedia talk:Special:PrefixIndex]]
* {{tl|Look from}} to create a link to a list of all page names which begin with a given word or words
* {{tl|In title}} to create a link to a list of all page names which contain a given word or words
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |

[[Category:Special page templates]]
[[Category:Search templates]]
[[Category:Wikipedia formatting templates]]
[[Category:Internal link templates]]
[[Category:Wikipedia subpage templates]]
}}</includeonly>

Template:PrefixIndex/doc - Revision history

imported>CheckNineEight: /* Parameters */ add TemplateData