Template:Editing advice/doc

This template uses Lua:

Module:Editing advice

This is a documentation subpage for Template:Editing advice.
It may contain usage information, categories and other content that is not part of the original template page.

Usage[edit]

Use {{subst:Editing advice}} to give editors helpful advice about:

The use of the Show preview button.
The use of the summary editing form field.
The use of sandboxes.

Parameters[edit]

Specifically calling for or omitting advice

All the above mentioned advice will be provided by default, but specifying particular advice is possible. In this use case, omitted parameters will not be provided i.e.

{{subst:Editing advice|about=sandbox}} will omit advice about preview and summary.

{{subst:Editing advice|about=preview summary}} will omit advice about sandbox.

The order in which these params are written is not important, but using lower case is.

Inserting links to specific pages

If preview advice is being given, up to 3 pipe separated ( e.g. this is separated from | this ) pages may be mentioned as examples of where this feature seems like it might have been useful.

{{subst:Editing advice|Example|Foobar}} will link to Example and Foobar in the preview advice text, and also advise about summary and sandbox.

{{subst:Editing advice|about=preview|Example}} will omit summary and sandbox advice, and link to Example.

The order in which these params are written is not important, but using The correct case is i.e.

{{subst:Editing advice|Foobar|about=preview sandbox|Example}} will produce the same advice as {{subst:Editing advice|Foobar|Example|about=preview sandbox}}

The order in which the pages are given is the order they will appear in the advice i.e.

{{subst:Editing advice|Foobar|Example}} is not the same as {{subst:Editing advice|Example|Foobar}}

The talk page section heading

By default, the template will create a level 2 ( e.g. == This == ) section heading of "Some general editing advice", which can be disabled or changed i.e.

{{subst:Editing advice|section=no}} will disable the automatic section heading.

{{subst:Editing advice|section=Some things you might like to know}} will create a level 2 section heading of "Some things you might like to know".

{{subst:Editing advice|section=Some things you might like to know|Example|about=preview sandbox}} will:

create a level 2 section heading of "Some things you might like to know",
show advice about the use of sandboxes and the Show preview button and link to Example.

The order in which the params are written is not important.

Different advice for registered vs. IP editors: sandbox advice will automatically change depending on the use case.; IP editors will be guided to Wikipedia:Sandbox, whilst registered editors will be advised to create their own, or if they already have, they'll be guided to it.

Automatic signature: The template will automatically sign for you. The template must always be substituted, and is specifically for use on user talk pages and may give unexpected results ( by design ) in other namespaces.

Usage[edit]

Parameters[edit]

See also[edit]