Module:Pagetype/doc: Difference between revisions

Revision as of 06:31, 9 November 2013

Latest revision as of 18:47, 5 August 2025

(24 intermediate revisions by 14 users not shown)

Line 1:

{{high-risk|5,350,000+ use}}

{{module rating|betaprotected}}

{{cascade-protected template|page=module}}

{{Lua|Module:Pagetype/config|Module:Arguments|Module:Disambiguation|Module:Namespace detect|Module:Wikitext Parsing|Module:Yesno}}

This module is used to detect the page type of a given page. It detects [[WP:REDIRECT|redirect pages]] automatically and is highly customisable. It can be used on its own or as a meta-module to create other page-type-detection templates. This module can also be accessed using {{tl|pagetype}}.

== Syntax ==

Line 30 ⟶ 32:

| category =

| portal =

| book draft =

| education program =

| timedtext =

| module =

| topic =

| special =

| media =

| talk =

| redirect =

| soft_redirect =

| dab =

| na =

| other =

| sia =

| nonexistent =

| plural =

}}

</pre>

Line 66 ⟶ 72:

|-

| Module namespace || <code>module</code>

|-

| Book namespace || <code>book</code>

|-

| Other namespaces || <code>page</code>

Line 105 ⟶ 109:

| <code><nowiki>{{#invoke:pagetype|main|page=Wikipedia:Namespace}}</nowiki></code> || {{#invoke:pagetype|main|page=Wikipedia:Namespace}}

|-

| <code><nowiki>{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt}}</nowiki></code> || {{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt}}

|}

Line 120 ⟶ 124:

| help = ''yes''

| portal = ''yes''

| educationdraft program = ''yes''

| timedtext = ''yes''

| booktopic = ''noyes''

| special = ''yes''

| media = ''yes''

Line 143 ⟶ 148:

| Portal namespace || <code>portal</code>

|-

| Education programDraft namespace || <code>education program pagedraft</code>

|-

| Timed Text namespace || <code>Timed Text page</code>

|-

| BookTopic namespace || <code>booktopic</code>

|-

| Special namespace || <code>special page</code>

Line 160 ⟶ 167:

| category = ''no''

| module = ''no''

| book = ''no''

}}

Line 183 ⟶ 189:

| <code><nowiki>{{#invoke:pagetype|main|page=United Kingdom|main=no}}</nowiki></code> || {{#invoke:pagetype|main|page=United Kingdom|main=no}}

|-

| <code><nowiki>{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt}}</nowiki></code> || {{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt}}

|-

| <code><nowiki>{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt|timedtext=Yes}}</nowiki></code> || {{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt|timedtext=Yes}}

|}

Line 266 ⟶ 272:

| portal

|-

| BookDraft

| style="text-align: center;" | {{cross}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{tick}}

| book

|-

| Education Program

| style="text-align: center;" | {{cross}}

| style="text-align: center;" | {{cross}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{cross}}

| draft

| education program page

|-

| TimedText

Line 293 ⟶ 292:

| style="text-align: center;" | {{tick}}

| module

|-

| Topic (Flow boards)

| style="text-align: center;" | {{tickcross}}

| style="text-align: center;" | {{cross}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{cross}}

| topic

|-

| All talk namespaces

Line 338 ⟶ 344:

| <code><nowiki>{{#invoke:pagetype|main|page=Wikipedia:Namespace|defaultns=extended}}</nowiki></code> || {{#invoke:pagetype|main|page=Wikipedia:Namespace|defaultns=extended}}

|-

| <code><nowiki>{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt|defaultns=extended}}</nowiki></code> || {{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt|defaultns=extended}}

|-

| <code><nowiki>{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt|defaultns=all}}</nowiki></code> || {{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt|defaultns=all}}

|}

Line 360 ⟶ 366:

| category = ''custom text''

| portal = ''custom text''

| book draft = ''custom text''

| education program = ''custom text''

| timedtext = ''custom text''

| module = ''custom text''

| educationtopic program = ''custom text''

| special = ''custom text''

| media = ''custom text''

Line 386 ⟶ 392:

| <code><nowiki>{{#invoke:pagetype|main|page=United Kingdom|main=custom text}}</nowiki></code> || {{#invoke:pagetype|main|page=United Kingdom|main=custom text}}

|-

| <code><nowiki>{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt}}</nowiki></code> || {{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt}}

|-

| <code><nowiki>{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt|timedtext=custom text}}</nowiki></code> || {{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt|timedtext=custom text}}

|}

Line 431 ⟶ 437:

|-

! Class !! Class values !! Output

|-

| Disambiguation page || <code>disambiguation</code>, <code>disambig</code>, <code>disamb</code>, <code>dab</code> || <code>page</code>

|-

| No applicable class || <code>na</code>, <code>n/a</code> || <code>page</code>

Line 444 ⟶ 448:

It is also possible to specify a custom value for the main namespace classes:

&#123;{#invoke:pagetype|main|''class''|dab=''yes''|na=''yes''}}

&#123;{#invoke:pagetype|main|''class''|dab=''custom text''|na=''custom text''}}

This works the same way that it does for the custom namespace page types. Possible parameters are:

* '''dab''': a custom value for disambiguation-class pages. If set to "<code>yes</code>", "<code>y</code>", "<code>true</code>" or "<code>1</code>", this produces "disambiguation page". If set to "<code>no</code>", "<code>n</code>", "<code>false</code>" or "<code>0</code>", no custom value is produced. If set to any other value it produces that text.

* '''na''': a custom value for NA-class pages. It works in the same way as the <code>dab</code> parameter. The default value for "<code>yes</code>" etc. is "page".

; Examples

Line 458 ⟶ 462:

|-

| <code><nowiki>{{#invoke:pagetype|main|page=United Kingdom}}</nowiki></code> || {{#invoke:pagetype|main|page=United Kingdom}}

|-

| <code><nowiki>{{#invoke:pagetype|main|page=United Kingdom|dab}}</nowiki></code> || {{#invoke:pagetype|main|page=United Kingdom|dab}}

|-

| <code><nowiki>{{#invoke:pagetype|main|page=United Kingdom|dab|dab=custom text}}</nowiki></code> || {{#invoke:pagetype|main|page=United Kingdom|dab|dab=custom text}}

|-

| <code><nowiki>{{#invoke:pagetype|main|page=United Kingdom|na}}</nowiki></code> || {{#invoke:pagetype|main|page=United Kingdom|na}}

Line 488:

| <code><nowiki>{{#invoke:pagetype|main|page=UK|redirect=custom text}}</nowiki></code> || {{#invoke:pagetype|main|page=UK|redirect=custom text}}

|}

== Disambiguation pages ==

By default, the module uses [[Module:Disambiguation]] to detect [[WP:DAB|disambiguation pages]] in the main namespace. If you want, you can turn this detection off, or use a custom value for disambiguation pages.

&#123;{#invoke:pagetype|main|dab=''no''}}

&#123;{#invoke:pagetype|main|dab=''custom text''}}

; Examples

{| class="wikitable"

|-

! Code !! Result

|-

| <code><nowiki>{{#invoke:pagetype|main|page=Mercury}}</nowiki></code> || {{#invoke:pagetype|main|page=Mercury}}

|-

| <code><nowiki>{{#invoke:pagetype|main|page=Mercury|dab=no}}</nowiki></code> || {{#invoke:pagetype|main|page=Mercury|dab=no}}

|-

| <code><nowiki>{{#invoke:pagetype|main|page=United Kingdom|dabMercury|dab=custom text}}</nowiki></code> || {{#invoke:pagetype|main|page=United Kingdom|dabMercury|dab=custom text}}

|}

== Set index articles ==

Documentation pending.

== Soft redirects ==

Documentation pending.

== Non-existent pages ==

Documentation pending.

== Other namespaces ==

Line 506 ⟶ 535:

|-

| <code><nowiki>{{#invoke:pagetype|main|page=Wikipedia:Namespace|other=custom text|wikipedia=wikipedia-space text}}</nowiki></code> || {{#invoke:pagetype|main|page=Wikipedia:Namespace|other=custom text|wikipedia=wikipedia-space text}}

|}

== Plurals ==

By default the module returns the name of the namespace in the singular. Adding the parameter {{para|plural|y}} returns the plural form.

{| class="wikitable"

|-

! Code !! Result

|-

| <code><nowiki>{{#invoke:pagetype|main|page=United Kingdom|dab}}</nowiki></code> || {{#invoke:pagetype|main|page=United Kingdom|dab}}

|-

| <code><nowiki>{{#invoke:pagetype|main|page=United Kingdom|plural=y}}</nowiki></code> || {{#invoke:pagetype|main|page=United Kingdom|plural=y}}

|-

| <code><nowiki>{{#invoke:pagetype|main|page=Category:Books}}</nowiki></code> || {{#invoke:pagetype|main|page=Category:Books}}

|-

| <code><nowiki>{{#invoke:pagetype|main|page=Category:Books|plural=y}}</nowiki></code> || {{#invoke:pagetype|main|page=Category:Books|plural=y}}

|}

The rules for pluralisation can be customised in [[Module:Pagetype/config]] to allow localisation.

== Capitalisation ==

By default the module returns the page type in lowercase. Adding the parameter {{para|caps|y}} returns a version with a capital letter at the start.

{| class="wikitable"

|-

! Code !! Result

|-

| <code><nowiki>{{#invoke:pagetype|main|page=United Kingdom}}</nowiki></code> || {{#invoke:pagetype|main|page=United Kingdom}}

|-

| <code><nowiki>{{#invoke:pagetype|main|page=United Kingdom|caps=y}}</nowiki></code> || {{#invoke:pagetype|main|page=United Kingdom|caps=y}}

|-

| <code><nowiki>{{#invoke:pagetype|main|page=United Kingdom|plural=y|caps=y}}</nowiki></code> || {{#invoke:pagetype|main|page=United Kingdom|plural=y|caps=y}}

|}