View source for Module:Protected edit request/doc

<noinclude>{{pp|small=yes}}</noinclude>
{{Lua|Module:Arguments|Module:Message box|Module:No globals|Module:Protected edit request/active|Module:Yesno|noprotcat=yes}}
{{module rating|release}}
{{module rating|protected}}
{{high use|25,000}}

This module produces a message box used to [[SW:PER|request edits]] to [[SW:PROTECT|protected]] pages. Edit requests can be made for fully protected, template-protected and semi-protected pages, and it is possible to request edits to multiple pages at once.

This module should be used on the talk page of the page to be edited. If you are not able to place it directly on this talk page, then you can specify the page to be edited with the positional parameters. You can also specify multiple pages to be edited, if this is more convenient than making multiple edit requests in different locations.

== Syntax ==

The module has five functions, one for each available protection level:

{| class="wikitable"
|-
! Function !! Protection level !! Template
|-
| <code>interface</code> || [[SW:IADMIN|CSS/JS protection]] || {{tl|edit interface-protected}}
|-
| <code>full</code> || [[SW:FULL|Full protection]] || {{tl|edit fully-protected}}
|-
| <code>template</code> || [[SW:TPROT|Template protection]] || {{tl|edit template-protected}}
|-
| <code>extended</code> || [[SW:EC-P|Extended confirmed protection]] || {{tl|edit extended-protected}}
|-
| <code>semi</code> || [[SW:SEMI|Semi-protection]] || {{tl|edit semi-protected}}
|}

; Basic usage

 &#123;{#invoke:protected edit request|''function''}}

; Specify pages to be edited

 &#123;{#invoke:protected edit request|''function''|''First page to be edited''|''Second page to be edited''|...}}

; Deactivate a request

 &#123;{#invoke:protected edit request|''function''|answered=''yes''}}

; Force a request's protection level rather than allowing auto-detection:

 &#123;{#invoke:protected edit request|''function''|force=''yes''}}

; Override the "must only be on a talk page" check:

 &#123;{#invoke:protected edit request|''function''|skiptalk=''yes''}}

; All parameters

 &#123;{#invoke:protected edit request|''function''
 | ''First page to be edited''|''Second page to be edited''|''Third page to be edited''|...
 | answered = 
 | ans      = 
 | demo     = 
 | force    = 
 | skiptalk =
 }}

== Categories ==

The template categorises the page depending on the protection level of the pages to be edited.

{| class="wikitable"
|-
! Function !! Category
|-
| <code>interface</code> || [[:Category:Stiles.casa Wiki interface-protected edit requests]]
|-
| <code>full</code> || [[:Category:Stiles.casa Wiki fully-protected edit requests]]
|-
| <code>template</code> || [[:Category:Stiles.casa Wiki template-protected edit requests]]
|-
| <code>extended</code> || [[:Category:Stiles.casa Wiki extended-confirmed-protected edit requests]]
|-
| <code>semi</code> || [[:Category:Stiles.casa Wiki semi-protected edit requests]]
|}

The module attempts to detect the protection level of the pages used. If one or more of the pages are unprotected, or multiple pages with different protection levels are specified, the page is categorized in [[:Category:Stiles.casa Wiki edit requests possibly using incorrect templates]]. Otherwise, if the force parameter is not set, it is automatically categorized in the correct protection level.