Template:Uw template doc

Description

This is a pre-written warning message, intended for user talk pages.

Usage

First, before using this template, read the warning message carefully to make sure that you are using the correct template for the job. If the template doesn't seem quite suited for the current situation, either find another warning template to use, or leave a handwritten message rather than using a template.

If you have decided to use this warning template, edit the user talk page of the user. Create a Level 2 heading with the current month, followed by the current year. If one already exists, do not create a new heading, and instead file all additional warnings under that heading.

If your calendar is broken, here's the current month and year: May 2024. (Update)

If you're using the source editor, here's the wikitext (Update):

==May 2024==

Then, substitute the template. You substitute a template by adding subst: between the initial curly brackets and the template name. For example, to substitute this template, do the following:

{{subst:Uw template doc}}

If you want to reference a specific page the user edited, you can add the full page title of the the page in question to the first optional parameter. For example, to reference the page Foo:

{{subst:Uw template doc | Foo }}

Do not wikilink; this template will do it for you.

If the template message isn't enough, you can also append an additional optional comment.

{{subst:Uw template doc | Foo | Your custom message here }}

Important

Do not insert characters used in template parameter usage, such as = (equal signs) or | (pipes). This includes URLs, such as the URLs of diffs. Doing so will break the template, and your custom message may not appear. Use Special:Diff to link to diffs, or replace = and | with {{=}} and {{!}}, respectively.

If you want to leave a custom message without linking to a page, do the following:

{{subst:Uw template doc | 2 = Your custom message here}}

You may now save your edit. You do not need to insert your signature, as this template will do it for you.

Complete template code

{{subst:Uw template doc | Full page title of affected page | 2 = Your custom message here}}

Template documentation (View · Edit · History · Purge)

Description

Documentation template for user warning templates. (So technically this is a documentation page for a documentation page)

Usage

This template is transcluded onto the /doc subpage of user warning templates. The following parameters are available, all of which are optional:

|description= Used to add a custom description; otherwise it will show a general descriptive message.

|shortcut= Use this field to add the {{Shortcut}} template to the documentation page. Details on how to use said template can be found at its documentation page.

|usage= Use this field to specify a custom usage section; otherwise it will show a general usage guideline that should apply to most user warning templates.

Visit Template:Uw template doc/doc to edit this text! (How does this work?) (Refresh this text - why?)