Difference between revisions of "Template:Editing advice/doc"
Jump to navigation
Jump to search
imported>Fred Gandt (added {{lua|Module:Editing advice}}) |
imported>Fred Gandt m (→Parameters: fix another equals sign) |
||
| Line 13: | Line 13: | ||
: 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.'' | : 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.'' | ||
:: <code>{{tlsc|Editing advice|about{{{|=}}}sandbox}}</code> will omit advice about <code>preview</code> and <code>summary</code>. | :: <code>{{tlsc|Editing advice|about{{{|=}}}sandbox}}</code> will omit advice about <code>preview</code> and <code>summary</code>. | ||
| − | :: <code>{{tlsc|Editing advice|about=preview summary}}</code> will omit advice about <code>sandbox</code>. | + | :: <code>{{tlsc|Editing advice|about{{{|=}}}preview summary}}</code> will omit advice about <code>sandbox</code>. |
::: The order in which these ''params'' are written is not important, but using '''lower case''' is. | ::: The order in which these ''params'' are written is not important, but using '''lower case''' is. | ||
| Line 19: | Line 19: | ||
: If <code>preview</code> advice is being given, up to <tt>3</tt> ''pipe separated'' ( ''e.g.'' <tt>this is separated from | this</tt> ) pages may be mentioned as examples of where this feature seems like it might have been useful. | : If <code>preview</code> advice is being given, up to <tt>3</tt> ''pipe separated'' ( ''e.g.'' <tt>this is separated from | this</tt> ) 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]]. |
::: The order in which these ''params'' are written is not important, but using '''The correct case''' is ''i.e.'' | ::: The order in which these ''params'' are written is not important, but using '''The correct case''' is ''i.e.'' | ||
:::: <code>{{tlsc|Editing advice|Foobar|about{{{|=}}}preview sandbox|Example}}</code> will produce the same advice as <code>{{tlsc|Editing advice|Foobar|Example|about{{{|=}}}preview sandbox}}</code> | :::: <code>{{tlsc|Editing advice|Foobar|about{{{|=}}}preview sandbox|Example}}</code> will produce the same advice as <code>{{tlsc|Editing advice|Foobar|Example|about{{{|=}}}preview sandbox}}</code> | ||
Revision as of 03:57, 22 March 2016
| 30px | This template uses Lua: |
| 40px | 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. |
| 40x40px | This template should always be substituted. |
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.