Template:Work in progress/doc
This Template allows you to notify others that you will be working on a page for a extended amount of time. It is intended to stop others from editing the page when you are working on it to prevent edit conflicts. If you will not be constantly updating the page in a short period of time, or if you will take longer than 6 hours to complete the job, you should not use this template. In the first case, use Template:Incomplete
instead; in the second case, you might want to take a break anyways, right?
You may also use the shortcut {{WIP}}
.
Syntax
{{Work in progress |user= |time= |until= |reason= |timenow= |poster= }}
Only timenow
is required. You may use timenow=~~~~~
to leave the time of posting, and poster={{subst:REVISIONUSER}}
to signify the poster.
Recommended Syntax: {{Work in progress}}
|
---|
{{Work in progress |user= |time= |until= |reason= |timenow=~~~~~ |poster={{subst:REVISIONUSER}} }} |
Or, you can use the shorthand {{subst:Work in progress/auto}}
instead, which automatically fills in timenow
and poster
.
Syntax: {{subst:Work in progress/auto}}
|
---|
{{subst:Work in progress/auto |user= |time= |until= |reason= }} |
Detailed Syntax
Argument | Explanation | Type | Default |
---|---|---|---|
user | The user performing the edits. | string; the name of a user | {{{REVISIONUSER}}}, i.e. the user adding this notice |
time | The time you estimate it will take to finish the job. | string | none |
until | The time you estimate when your job will be finished. | string | none |
reason | Any note you wish to leave within the notice. | string | none |
timenow | The time you posted the notice.
Nonexistent in |
string | Required field. ~~~~~ recommended.
|
poster | The user posting the notice.
Nonexistent in |
string; name of a user | none;
The user posting the notice if |
User
user
specifies which user is performing the edits. The default is the user posing this notice (i.e. you); but if you are posting this for someone else, you may change this argument to their username.
If you want to make clear who left the notice, you may add |poster={{subst:REVISIONUSER}}
to the arguments.
Duration
You may specify how long you will be working by using either the time
or the until
argument.
Use time
to specify how long you will be working:
{{Work in progress |user=Example |time= 1 hour |timenow=~~~~~ |poster={{subst:REVISIONUSER}} }}
Gives
This page, Template:Work in progress/doc, is being worked on by Example for about 1 hour. Editing now might cause edit conflicts. In the worst case, both you and the other user might lose their edits. We strongly recommend you to wait about 1 hour. If you have any suggestions, please post it at the aforementioned user's talk page. If it has well passed 1 hour, you may remove this notice and proceed with your edits. |
use until
to specify when you will stop working:
{{Work in progress |user=Example |until=May 4, 2019 |timenow=~~~~~ |poster={{subst:REVISIONUSER}} }}
Gives
This page, Template:Work in progress/doc, is being worked on by Example until May 4, 2019. Editing now might cause edit conflicts. In the worst case, both you and the other user might lose their edits. We strongly recommend you to wait until May 4, 2019. If you have any suggestions, please post it at the aforementioned user's talk page. If it has well passed May 4, 2019, you may remove this notice and proceed with your edits. |
The two may not be used together, and time
will override until
.
If no arguements are provide regarding the duration, the template guesses that 4 hours should be enough.
It is courteous to not block out more than 6 hours of time.
Notes
You may leave notes as to what you will be working on and why you are blocking out this time, etc. by using reason
.
{{Work in progress |user=Example |reason=Will be expanding definitions |timenow=~~~~~ |poster={{subst:REVISIONUSER}} }}
Gives
This page, Template:Work in progress/doc, is being worked on by Example for about 4 hours. Editing now might cause edit conflicts. In the worst case, both you and the other user might lose their edits. We strongly recommend you to wait a little while.
If it has well passed 4 hours, you may remove this notice and proceed with your edits. |
Combination
You may combine any arguments above except time
and until
. Again, use the expanded syntax and fill in any required field.