m (→Sample) |
(update doc) |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
==Description== | ==Description== | ||
This template allows you to "claim" pages you want to edit for up to 72 hours (3 days). | |||
This template allows you to "claim" pages you want to edit for up to | |||
==Syntax== | ==Syntax== | ||
<pre>{{subst:claim|Username}}</pre> | <pre>{{subst:claim|Username}}</pre> | ||
<pre>{{subst:claim|Username|Hours}}</pre> | <pre>{{subst:claim|Username|Hours}}</pre> | ||
'''You ''must'' [ | '''You ''must'' [[wikipedia:Help:Substitution|substitute]] this template. Transcluding it normally will not work.''' | ||
==Usage== | ==Usage== | ||
The claim warning is used to prevent [[wikipedia:Help: | The claim warning is used to prevent [[wikipedia:Help:Edit conflict|edit conflicts]]. It places a box explaining that a user (''should be yourself'') is wanting to edit a page, and is wanting to be the only editor until a specified time. The template hides itself after this time. | ||
It is best to use this template at the very start of a page. The idea is for people to see it then wait for your submission before they start editing. | |||
The purpose of limiting the time is that the claim template is supposed to be used directly before the user starts typing out the actual edit. The maximum time is 72 hours, but keep the time at a minumum. | |||
==Parameters== | ==Parameters== | ||
<templatedata>{ "description": "","params": { | <templatedata>{ "description": "Put a box warning users that you are editing the page.","params": { | ||
"1": { | "1": { | ||
"label": "Username", | "label": "Username", | ||
| Line 20: | Line 25: | ||
"label": "Hours claimed", | "label": "Hours claimed", | ||
"type": "number", | "type": "number", | ||
"description": "The length of the claim in hours. Can be any number 1- | "description": "The length of the claim in hours. Can be any number 1-72.", | ||
"example": "5", | "example": "5", | ||
"default": "1 hour" | "default": "1 hour" | ||
}}}</templatedata> | }}}</templatedata> | ||
==Sample== | ==Sample== | ||
The following input: | The following input: | ||
<pre>{{subst:claim| | |||
<pre>{{subst:claim|ZASNK}}</pre> | |||
Produces: | Produces: | ||
{{#if: | <span style="display:none;"></span> | |||
|{{#ifexpr: 0 < 20240612074611|{{Claim/1|ZASNK}} 2024-06-12 at 07:46 UTC. {{Claim/2|ZASNK}}}} | |||
| | }}<!--This was for Template:Claim - please delete if invisible or showing an error--> | ||
1}} | |||
Note: this example is rigged to never disappear, despite it being out of date. | |||
<!-- | |||
<noinclude>__NOTOC__ [[Category:Template documentation]]</noinclude> | |||
<noinclude>__NOTOC__ [[Category:Template | |||
<includeonly>__NOEDITSECTION__</includeonly> | <includeonly>__NOEDITSECTION__</includeonly> | ||
Latest revision as of 06:50, 12 June 2024
Description
This template allows you to "claim" pages you want to edit for up to 72 hours (3 days).
Syntax
{{subst:claim|Username}}
{{subst:claim|Username|Hours}}
You must substitute this template. Transcluding it normally will not work.
Usage
The claim warning is used to prevent edit conflicts. It places a box explaining that a user (should be yourself) is wanting to edit a page, and is wanting to be the only editor until a specified time. The template hides itself after this time.
It is best to use this template at the very start of a page. The idea is for people to see it then wait for your submission before they start editing.
The purpose of limiting the time is that the claim template is supposed to be used directly before the user starts typing out the actual edit. The maximum time is 72 hours, but keep the time at a minumum.
Parameters
Put a box warning users that you are editing the page.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Username | 1 | Your username. Your user page and user talk page will both be linked in the template.
| Line | required |
| Hours claimed | 2 | The length of the claim in hours. Can be any number 1-72.
| Number | optional |
Sample
The following input:
{{subst:claim|ZASNK}}
Produces:
Planned to be edited by User:ZASNK until 2024-06-12 at 07:46 UTC. Editing now could cause an edit conflict. If you still wish to edit, it's best to speak with them first. RefreshNote: this example is rigged to never disappear, despite it being out of date.