模組:Pagetype/doc

这是Module:Pagetype的文档页面

此模块文档被引用於約722,000個頁面。
為了避免造成大規模的影響，所有對此模块文档的編輯應先於沙盒或測試樣例上測試。
測試後無誤的版本可以一次性地加入此模块文档中，但是修改前請務必於討論頁發起討論。

模板引用數量會自動更新。

此模块文档已被保护。此为高度可见模块文档，其已用于大量条目或被频繁替换引用。由于破坏或失误会影响诸多页面，即便细小的改动也可能导致大量服务器负载，因此已被保护，不可编辑。

This module is used to detect the page type of a given page. It detects 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 {{pagetype}}.

語法

Basic usage

{{#invoke:pagetype|main}}

所有參數

{{#invoke:pagetype|main
| page              = 
| defaultns         = 
| main              = 
| user              = 
| wikipedia         = 
| project           = 
| wp                = 
| file              = 
| image             = 
| mediawiki         = 
| template          = 
| help              = 
| category          = 
| portal            = 
| book              = 
| draft             = 
| education program = 
| timedtext         = 
| module            = 
| topic             = 
| special           = 
| media             = 
| talk              = 
| redirect          = 
| dab               = 
| na                = 
| other             = 
}}

基本用法

For simple detection of the page type of the current page, use the default settings:

{{#invoke:pagetype|main}}

That will produce the following results, depending on the page type or the namespace:

Page type / namespace	Output
Redirects (in any namespace)	`redirect`
Main namespace	`article`
File namespace	`file`
Template namespace	`template`
Category namespace	`category`
Module namespace	`module`
Book namespace	`book`
Other namespaces	`page`

If the module is used on a talk page, it will detect the page type for the corresponding subject page.

範例

Code	Result
`{{#invoke:pagetype\|main}}`	模块

頁面參數

You can use the page parameter to make the module act as though it was called from that page.

{{#invoke:pagetype|main|page=page name}}

範例

Code	Result
`{{#invoke:pagetype\|main\|page=英国}}`	條目
`{{#invoke:pagetype\|main\|page=UK}}`	重定向
`{{#invoke:pagetype\|main\|page=Talk:英国}}`	條目
`{{#invoke:pagetype\|main\|page=File:Example.svg}}`	文件
`{{#invoke:pagetype\|main\|page=Wikipedia:Namespace}}`	重定向
`{{#invoke:pagetype\|main\|page=TimedText:Imagine.ogg.en.srt}}`	页面

增減名字空間

It is possible to specify different behaviour for each namespace than that described in the basic usage section. For example, you might want the module to display "user page" for pages in the user namespace, instead of the default "page". To do this, you can use the code |user=yes. This looks up the typical name used for pages in the user namespace, in this case "user page", and uses that text when the module is used with a page in the user namespace. To use this with other namespaces, use the namespace name in lower case as a parameter:

{{#invoke:pagetype|main
| user              = yes
| wikipedia         = yes
| project           = yes
| wp                = yes
| mediawiki         = yes
| help              = yes
| portal            = yes
| draft             = yes
| education program = yes
| timedtext         = yes
| topic             = yes
| special           = yes
| media             = yes
}}

You can use any of the following to specify the namespace: "yes", "y", "true" or "1". They can be used in any combination of upper and lower case. (These values are defined by Module:Yesno.)

The default text for these namespaces is as follows:

Page type / namespace	Output
User namespace	`user page`
Wikipedia namespace	`project page`
MediaWiki namespace	`interface page`
Help namespace	`help page`
Portal namespace	`portal`
Draft namespace	`draft`
Education program namespace	`education program page`
Timed Text namespace	`Timed Text page`
Topic namespace	`topic`
Special namespace	`special page`
Media namespace	`file`

You can use a similar process to remove any of the default namespace values as well. For example, if you use the code |template=no, then the module will display "page" when used on a template page, rather than the default "template".

{{#invoke:pagetype|main
| main     = no
| file     = no
| template = no
| category = no
| module   = no
| book     = no
}}

The following values will all work to remove namespace values: "no", "n", "false" or "0". They can be used in any combination of upper and lower case.

Examples

Code	Result
`{{#invoke:pagetype\|main\|page=Wikipedia:Namespace}}`	重定向
`{{#invoke:pagetype\|main\|page=Wikipedia:Namespace\|wikipedia=yes}}`	重定向
`{{#invoke:pagetype\|main\|page=Talk:英国}}`	條目
`{{#invoke:pagetype\|main\|page=Talk:英国\|talk=y}}`	討論頁
`{{#invoke:pagetype\|main\|page=英国}}`	條目
`{{#invoke:pagetype\|main\|page=英国\|main=no}}`	页面
`{{#invoke:pagetype\|main\|page=TimedText:Imagine.ogg.en.srt}}`	页面
`{{#invoke:pagetype\|main\|page=TimedText:Imagine.ogg.en.srt\|timedtext=Yes}}`	字幕

默認名字空間設置

As well as adding and removing individual namespaces, it is possible to specify different sets of namespaces by using the |defaultns=. There are four different sets available: all, extended, none and the default set. These sets allow you to specify many namespaces at once, without having to use all of the individual namespace parameters. Namespaces are set according to the following table:

名字空間	Value of `\|defaultns=`				輸出
名字空間	`none`	`extended`	`all`	其他值	輸出
Main	N	Y	Y	Y	條目
User	N	Y	Y	N	用戶頁
Wikipedia	N	Y	Y	N	維基百科
File	N	Y	Y	Y	文件
MediaWiki	N	Y	Y	N	MediaWiki
Template	N	Y	Y	Y	模板
Help	N	Y	Y	N	幫助
Category	N	Y	Y	Y	分類
Portal	N	Y	Y	N	主題
Book	N	Y	Y	Y	book
Draft	N	Y	Y	N	草稿
Education Program	N	N	Y	N	education program page
TimedText	N	N	Y	N	Timed Text page
Module	N	Y	Y	Y	模塊
Topic (Flow boards)	N	N	Y	N	公告
All talk namespaces	N	N	Y	N	討論頁
Special	N	N	Y	N	特殊頁面
Media	N	N	Y	N	文件

範例

Code	Result
`{{#invoke:pagetype\|main\|page=英国}}`	條目
`{{#invoke:pagetype\|main\|page=英国\|defaultns=none}}`	页面
`{{#invoke:pagetype\|main\|page=Talk:英国}}`	條目
`{{#invoke:pagetype\|main\|page=Talk:英国\|defaultns=all}}`	討論頁
`{{#invoke:pagetype\|main\|page=File:Example.svg}}`	文件
`{{#invoke:pagetype\|main\|page=File:Example.svg\|defaultns=none}}`	页面
`{{#invoke:pagetype\|main\|page=Wikipedia:Namespace}}`	重定向
`{{#invoke:pagetype\|main\|page=Wikipedia:Namespace\|defaultns=extended}}`	重定向
`{{#invoke:pagetype\|main\|page=TimedText:Imagine.ogg.en.srt\|defaultns=extended}}`	页面
`{{#invoke:pagetype\|main\|page=TimedText:Imagine.ogg.en.srt\|defaultns=all}}`	字幕

自訂名字空間值

It is possible to specify a custom value for any namespace:

{{#invoke:pagetype|main
| main              = custom text
| user              = custom text
| wikipedia         = custom text
| project           = custom text
| wp                = custom text
| file              = custom text
| image             = custom text
| mediawiki         = custom text
| template          = custom text
| help              = custom text
| category          = custom text
| portal            = custom text
| book              = custom text
| draft             = custom text
| education program = custom text
| timedtext         = custom text
| module            = custom text
| topic             = custom text
| special           = custom text
| media             = custom text
}}

範例

Code	Result
`{{#invoke:pagetype\|main\|page=Wikipedia:Namespace}}`	重定向
`{{#invoke:pagetype\|main\|page=Wikipedia:Namespace\|wikipedia=custom text}}`	重定向
`{{#invoke:pagetype\|main\|page=Talk:英国}}`	條目
`{{#invoke:pagetype\|main\|page=Talk:英国\|talk=custom text}}`	custom text
`{{#invoke:pagetype\|main\|page=英国}}`	條目
`{{#invoke:pagetype\|main\|page=英国\|main=custom text}}`	custom text
`{{#invoke:pagetype\|main\|page=TimedText:Imagine.ogg.en.srt}}`	页面
`{{#invoke:pagetype\|main\|page=TimedText:Imagine.ogg.en.srt\|timedtext=custom text}}`	custom text

討論參數

Normally, the module will treat talk pages as if they were in the corresponding subject namespace. However, if the talk parameter is set, the module will treat talk pages separately from subject pages. The talk parameter sets values for all talk pages, i.e. pages in the Talk: namespace, pages in the User talk: namespace, pages in the Wikipedia talk: namespace, and so on.

{{#invoke:pagetype|main|talk=yes}}

{{#invoke:pagetype|main|talk=custom text}}

The default value for "talk=yes" is "talk page".

範例

Code	Result
`{{#invoke:pagetype\|main\|page=Wikipedia talk:Namespace}}`	重定向
`{{#invoke:pagetype\|main\|page=Wikipedia talk:Namespace\|wikipedia=yes}}`	重定向
`{{#invoke:pagetype\|main\|page=Wikipedia talk:Namespace\|talk=yes}}`	討論頁
`{{#invoke:pagetype\|main\|page=Wikipedia talk:Namespace\|wikipedia=yes\|talk=yes}}`	討論頁
`{{#invoke:pagetype\|main\|page=Wikipedia talk:Namespace\|talk=custom text}}`	custom text
`{{#invoke:pagetype\|main\|page=Wikipedia talk:Namespace\|wikipedia=yes\|talk=custom text}}`	custom text

Main namespace classes

For pages in the main namespace, it is possible to add a class value in the first positional parameter:

{{#invoke:pagetype|main|class}}

If the class value matches one of the values in the table below, it will produce an alternative to the default output of article.

Class	Class values	Output
Disambiguation page	`disambiguation`, `disambig`, `disamb`, `dab`	`page`
No applicable class	`na`, `n/a`	`page`

You can input the class value in any combination of upper and lower case.

Custom main namespace classes

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

{{#invoke:pagetype|main|class|dab=yes|na=yes}}

{{#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 "yes", "y", "true" or "1", this produces "disambiguation page". If set to "no", "n", "false" or "0", 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 dab parameter. The default value for "yes" etc. is "page".

Examples

Code	Result
`{{#invoke:pagetype\|main\|page=United Kingdom}}`	重定向
`{{#invoke:pagetype\|main\|page=United Kingdom\|dab}}`	重定向
`{{#invoke:pagetype\|main\|page=United Kingdom\|dab\|dab=custom text}}`	重定向
`{{#invoke:pagetype\|main\|page=United Kingdom\|na}}`	重定向
`{{#invoke:pagetype\|main\|page=United Kingdom\|na\|na=custom text}}`	重定向

重定向

By default, the module automatically detects redirects in all namespace. It is not possible to specify redirect behaviour by namespace, but you can turn redirect detection off, or use a custom value for redirect pages.

{{#invoke:pagetype|main|redirect=no}}

{{#invoke:pagetype|main|redirect=custom text}}

範例

Code	Result
`{{#invoke:pagetype\|main\|page=UK}}`	重定向
`{{#invoke:pagetype\|main\|page=UK\|redirect=no}}`	條目
`{{#invoke:pagetype\|main\|page=UK\|redirect=custom text}}`	custom text

其他名字空間

By default, the module produces "page" if used from a namespace that hasn't been specified. This value can be changed with the |other= parameter:

{{#invoke:pagetype|main|other=custom text}}

範例

Code	Result
`{{#invoke:pagetype\|main\|page=Wikipedia:Namespace}}`	重定向
`{{#invoke:pagetype\|main\|page=Wikipedia:Namespace\|other=custom text}}`	重定向
`{{#invoke:pagetype\|main\|page=Wikipedia:Namespace\|other=custom text\|wikipedia=wikipedia-space text}}`	重定向