Template:Inuse/doc: Difference between revisions

Latest revision as of 16:00, 2 August 2024

This is the documentation page for Template:Inuse.

When it is viewed directly, links using variables may appear broken; do not replace these with hardcoded page names or URLs.

Informs visitors that an article is undergoing major changes.

See also: Template:Underconstruction

Usage

The in use template should be placed at the top of an article you are actively editing for a short period of time (a few hours at most). It should be removed when the article is no longer actively being edited. Otherwise, it unnecessarily discourage others from contributing to the article.

All pages that use this template are placed in the articles actively undergoing a major edit category.

Visitors should avoid making changes to pages that are in use, to avoid edit conflicts.

The template should be placed at the top of the page (before the article content). This ensures that the sign is immediately visible to visitors. An optional message can be added to inform visitors about specific sections being changed and the estimated time until the article is available again. Specifying periods of several days or longer for this template goes against the spirit of simply avoiding edit conflicts; please only use it for sessions where you are actively editing the article (e.g., major rewrite or overhaul).

If you wish to indicate that an article is being rebuilt over a longer period of time consider the {{underconstruction}} template.

Examples

{{inuse}}

{{inuse|5 minutes}}

{{inuse|30 minutes to fix the information in the History section}}

@@ Line 1: / Line 1: @@
-<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>
+<noinclude>{{documentation subpage}}</noinclude>
-<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
+Informs visitors that an article is undergoing major changes.
-:{{MainBold|Wikipedia:How to edit a page|Wikipedia:Template messages|Wikipedia:Template messages/Maintenance}}
+{{See also|Template:Underconstruction}}
-{{See also|Template:Inuse-section/doc|Template:Underconstruction}}
 == Usage ==
-The '''Inuse''' [[Wikipedia:Template messages|template message]] is placed at the top of a page you are actively editing for a short period of time. The tag is intended to inform people that someone is currently working on the article, thereby reducing edit conflicts. Please do not leave it in place for more than the few hours at most that should be necessary, as doing so may unnecessarily discourage others from contributing to the article. If it has been up for more than two hours since the last edit, it should be removed. Specifying periods of several days or longer for this template goes against the spirit of simply avoiding edit conflicts; please only use it for sessions where you are actively editing the article.
+The '''in use''' template should be placed at the top of an article you are actively editing for a short period of time (a few hours at most). It should be removed when the article is no longer actively being edited. Otherwise, it unnecessarily discourage others from contributing to the article.
-If you wish to indicate that an article is being rebuilt over a longer period of time consider the <nowiki>{{</nowiki>[[:Template:underconstruction|underconstruction]]<nowiki>}}</nowiki> template. That template encourages others to edit the article while indicating that it is a [[Wikipedia:Editing policy|work in progress]].
+All pages that use this template are placed in the [[:Category:articles actively undergoing a major edit|articles actively undergoing a major edit]] category.
-To use, just add  <code><nowiki>{{inuse}}</nowiki></code> at the top of the article you want to work on. If you want to reserve it for a specific length of time and optionally, a message, use <code><nowiki>{{inuse|time (message)}}</nowiki></code>.
+Visitors should avoid making changes to pages that are in use, to avoid edit conflicts.
-'''Please remember to remove the Inuse note''' as soon as you're finished editing.
+The template should be placed at the top of the page (before the article content). This ensures that the sign is immediately visible to visitors. An optional message can be added to inform visitors about specific sections being changed and the estimated time until the article is available again. Specifying periods of several days or longer for this template goes against the spirit of simply avoiding edit conflicts; please only use it for sessions where you are actively editing the article (e.g., major rewrite or overhaul).
+If you wish to indicate that an article is being rebuilt over a longer period of time consider the {{tlx|underconstruction}} template.
 === Examples ===
-<code><nowiki>{{inuse}}</nowiki></code>
+{{tlx|inuse}}
 {{inuse|category=no}}
-<code><nowiki>{{inuse|5 minutes}}</nowiki></code>
+{{tlx|inuse|5 minutes}}
 {{inuse|5 minutes|category=no}}
-<code><nowiki>{{inuse|30 minutes to fix the information in the History section}}</nowiki></code>
+{{tlx|inuse|30 minutes to fix the information in the History section}}
 {{inuse|30 minutes to fix the information in the History section|category=no}}
 <includeonly>
-<!-- ADD CATEGORIES BELOW THIS LINE -->
 [[Category:Under-construction templates|{{PAGENAME}}]]
 </includeonly>