Difference between revisions of "Template:Editing advice/doc"
Jump to navigation
Jump to search
imported>Fred Gandt (added to see also + added categories) |
imported>Zyxw m (Since <tt> is obsolete in HTML5, replace it with <kbd> – see HTML element#tt, Wikipedia:HTML5, and mw:Help:Extension:Linter/obsolete-tag. using AWB) |
||
| Line 17: | Line 17: | ||
; Inserting links to specific pages | ; Inserting links to specific pages | ||
| − | : If <code>preview</code> advice is being given, up to < | + | : If <code>preview</code> advice is being given, up to <kbd>3</kbd> ''pipe separated'' ( ''e.g.'' <kbd>this is separated from | this</kbd> ) pages may be mentioned as examples of where this feature seems like it might have been useful. |
:: <code>{{tlsc|Editing advice|Example|Foobar}}</code> will link to [[Example]] and [[Foobar]] in the preview advice text, and also advise about <code>summary</code> and <code>sandbox</code>. | :: <code>{{tlsc|Editing advice|Example|Foobar}}</code> will link to [[Example]] and [[Foobar]] in the preview advice text, and also advise about <code>summary</code> and <code>sandbox</code>. | ||
:: <code>{{tlsc|Editing advice|about{{{|=}}}preview|Example}}</code> will omit <code>summary</code> and <code>sandbox</code> advice, and link to [[Example]]. | :: <code>{{tlsc|Editing advice|about{{{|=}}}preview|Example}}</code> will omit <code>summary</code> and <code>sandbox</code> advice, and link to [[Example]]. | ||
| Line 26: | Line 26: | ||
; The talk page section heading | ; The talk page section heading | ||
| − | : By default, the template will create a level < | + | : By default, the template will create a level <kbd>2</kbd> ( ''e.g.'' == This == ) section heading of ''"Some general editing advice"'', which can be disabled or changed ''i.e.'' |
:: <code>{{tlsc|Editing advice|section{{{|=}}}no}}</code> will disable the automatic section heading. | :: <code>{{tlsc|Editing advice|section{{{|=}}}no}}</code> will disable the automatic section heading. | ||
| − | :: <code>{{tlsc|Editing advice|section{{{|=}}}Some things you might like to know}}</code> will create a level < | + | :: <code>{{tlsc|Editing advice|section{{{|=}}}Some things you might like to know}}</code> will create a level <kbd>2</kbd> section heading of ''"Some things you might like to know"''. |
:: <code>{{tlsc|Editing advice|section{{{|=}}}Some things you might like to know|Example|about{{{|=}}}preview sandbox}}</code> will: | :: <code>{{tlsc|Editing advice|section{{{|=}}}Some things you might like to know|Example|about{{{|=}}}preview sandbox}}</code> will: | ||
| − | ::# create a level < | + | ::# create a level <kbd>2</kbd> section heading of ''"Some things you might like to know"'', |
::# show advice about the use of sandboxes and the {{key press|Show preview}} button and link to [[Example]]. | ::# show advice about the use of sandboxes and the {{key press|Show preview}} button and link to [[Example]]. | ||
::: The order in which the ''params'' are written is not important. | ::: The order in which the ''params'' are written is not important. | ||
Revision as of 15:40, 5 August 2018
| This template uses Lua: |
| This is a documentation subpage for Template:Editing advice. It contains usage information, categories and other content that is not part of the original template page. |
| This template should always be substituted (i.e., use {{subst:Editing advice}}). Any accidental transclusions will be automatically substituted by a bot. |
Usage
Use Template:Tlsc 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
- 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.
Template:Tlscwill omit advice aboutpreviewandsummary.Template:Tlscwill omit advice aboutsandbox.- The order in which these params are written is not important, but using lower case is.
- Inserting links to specific pages
- If
previewadvice 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.Template:Tlscwill link to Example and Foobar in the preview advice text, and also advise aboutsummaryandsandbox.Template:Tlscwill omitsummaryandsandboxadvice, and link to Example.- The order in which these params are written is not important, but using The correct case is i.e.
Template:Tlscwill produce the same advice asTemplate:Tlsc
- The order in which the pages are given is the order they will appear in the advice i.e.
Template:Tlscis not the same asTemplate:Tlsc
- The order in which these params are written is not important, but using The correct case is i.e.
- 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.
Template:Tlscwill disable the automatic section heading.Template:Tlscwill create a level 2 section heading of "Some things you might like to know".Template:Tlscwill:- 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
sandboxadvice 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.
See also
- {{subst:PleaseCite}} - Advice about the importance of citations.
- {{subst:Warn}} - Advice about when, why and how to warn vandals.
- {{subst:Welcome to Wikipedia}} - A cornucopia of welcoming advice for registered or IP editors, in a friendly layout.
- {{subst:Sofixit}} - Advice to be bold.
- Wikipedia:Template messages/User talk namespace - Tables of templates for the User talk namespace.