Template:To do/doc: Difference between revisions
mNo edit summary |
Funandtrvl (talk | contribs) add category |
||
(40 intermediate revisions by 25 users not shown) | |||
Line 1: | Line 1: | ||
{{ |
{{Documentation subpage}} |
||
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> |
|||
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> |
|||
{{distinguish|text=template: {{tlp|ToDo}}}} |
|||
{{high-use}} |
|||
This template adds a ''' |
This template adds a '''to do list''' to a ''talk page''. If you place this template, for example, on {{Fakelink|Talk:''Article name''}}, then type in the to do items on a {{Fakelink|Talk:''Article name''/to do}} page, then this template will automatically display them. |
||
'''Note''': Please do not spam this template speculatively to talk pages, as it should only be added when editors are actually going to use it. Unused templates may be removed by any editor without warning. |
|||
== Usage == |
=== Usage === |
||
<!-- Abstract usage of the template --> |
<!-- Abstract usage of the template --> |
||
* {{ |
* {{Tlx|To do}} – the normal, default to do list |
||
* {{ |
* {{Tlx|To do|collapsed{{=}}yes}} – collapses the list |
||
* {{Tlx|To do|for{{=}}<nowiki>[[Wikipedia:WikiProject Foo|WikiProject Foo]]</nowiki>}} – allows alternative page name reference (e.g. a project) instead of the default (which will be the non-talk pagename of the current page). |
|||
* {{tlx|todo|inner=Blah Blah Blah}}{{ndash}} uses the contents of 'inner' as the todo list |
|||
* {{Tlx|To do|inner{{=}}Blah Blah Blah}} – uses the contents of 'inner' as the to do list |
|||
* {{tlx|todo|list=./TODO}}{{ndash}} uses the subpage <code>./TODO</code> as the todo list, instead of subpage <code>./to do</code> |
|||
* {{ |
* {{Tlx|To do|list{{=}}./TODO}} – uses the subpage <code>./TODO</code> as the to do list, instead of subpage <code>./to do</code> |
||
* {{Tlx|To do|maxheight{{=}}{{var|h}}}} – sets the maximum height <code>''h''</code> (number with suffix <code>px</code>, <code>em</code> or <code>%</code>; e.g. 200px) of the to do list before vertical scroll bars appear. Keep in mind that this doesn't work for all browsers (they must support the max-height and overflow CSS attributes working together). If no height is given, the to do list's height will depend on its contents. |
|||
* {{tlx|todo|nocats=yes}}{{ndash}} doesn't include categories |
|||
* {{Tlx|To do|''N''}} – where <code>''N''</code> is a number from 1 to 9, defining its priority. (1 is the highest) |
|||
* {{tlx|todo|nopreload=yes}}{{ndash}} doesn't include preloaded text |
|||
* {{Tlx|To do|nocats{{=}}yes}} – doesn't include page in [[:Category:Wikipedia pages with to-do lists]] |
|||
* {{tlx|todo|small=yes}}{{ndash}} formats the todo list as the 'small' version |
|||
* {{ |
* {{Tlx|To do|nopreload{{=}}yes}} – clicking the ''edit'' link takes you to a blank page instead of a preloaded one |
||
* {{Tlx|To do|small{{=}}yes}} – formats the to do list as the 'small' version |
|||
** Use the <code>target</code> parameter for accessing another article's todo list, e.g., from a [[Wikipedia:WikiProject|WikiProject]] page (can be seen in action at [[WP:TBA]]) |
|||
* {{Tlx|To do|target{{=}}Foo}} – uses the to do list of page <code>Foo</code> instead |
|||
* {{Tlx|To do|To-do{{=}}{{var|Alternative title}}}} – changes the "To-do" title of the displayed box to something else, e.g.: {{Tlx|To do|To-do{{=}}Log of RfCs}}. This allows repurposing this template for other-than-"to-do" purposes. |
|||
** Can also be given as {{para|to-do}} without capital ''T''. |
|||
** Use the {{Para||target}} parameter for accessing another article's to do list, e.g., from a [[Wikipedia:WikiProject|WikiProject]] page (can be seen in action at [[WP:TBT]]) |
|||
* {{Tlx|To do|lmd{{=}}no}} – do not output the ''last modified date'' - the date that the To do list was updated |
|||
===Parameters=== |
====Parameters==== |
||
General parameters: |
|||
Parameters for use as a meta-template: |
|||
<pre> |
<pre> |
||
{{To do |
|||
|collapsed= |
|||
|for= |
|||
|inner= |
|||
|list= |
|||
|maxheight= |
|||
|nocats= |
|||
|nopreload= |
|||
|small= |
|||
|target= |
|||
}}</pre> |
|||
Parameters for use as a meta-template: |
|||
<pre> |
|||
{{To do |
|||
... |
|||
|above= |
|above= |
||
|below= |
|below= |
||
Line 28: | Line 51: | ||
|inner= |
|inner= |
||
|smallfor= (if the |for= parameter should be displayed when small) |
|smallfor= (if the |for= parameter should be displayed when small) |
||
|To-do= (change the wording "To-do" to something else) |
|||
</pre> |
|||
}}</pre> |
|||
== Examples == |
=== Examples === |
||
<!-- for the documentation don't subst the result --> |
<!-- for the documentation don't subst the result --> |
||
* {{ |
* {{Tlx|To do}} |
||
{{ |
{{To do|nocats=yes}} |
||
{{clear}} |
|||
{{-}} |
{{-}} |
||
* {{tlx|todo|9}} |
|||
{{ |
* {{Tlx|To do|9}} |
||
{{To do|nocats=yes|9}} |
|||
{{clear}} |
|||
{{-}} |
{{-}} |
||
* {{tlx|todo|small=yes}} |
|||
{{ |
* {{Tlx|To do|small{{=}}yes}} |
||
{{To do|nocats=yes|small=yes}} |
|||
{{clear}} |
|||
{{-}} |
{{-}} |
||
* {{tlx|todo|small=yes|9}} |
|||
{{ |
* {{Tlx|To do|small{{=}}yes|9}} |
||
{{To do|nocats=yes|small=yes|9}} |
|||
{{clear}} |
|||
{{-}} |
{{-}} |
||
* {{tlx|todo|collapsed=yes|9}} |
|||
{{ |
* {{Tlx|To do|collapsed{{=}}yes|9}} |
||
{{To do|nocats=yes|collapsed=yes|9}} |
|||
{{clear}} |
|||
{{-}} |
{{-}} |
||
* {{tlx|todo|inner=<nowiki><div></nowiki><br><nowiki> |
|||
* To |
* {{Tlx|To do|inner{{=}}<br /><nowiki> |
||
* |
* To Prepare this article for FA status.</nowiki><br /><nowiki> |
||
* Addition of pictures and/or photographs to illustrate the relevant topics/sections.</nowiki><br />}} |
|||
{{todo|nocats=yes|inner=<div> |
|||
{{To do|nocats=yes|inner= |
|||
* To Prepare this article for FA status. |
* To Prepare this article for FA status. |
||
* Addition of pictures and/or photographs to illustrate the relevant topics/sections. |
* Addition of pictures and/or photographs to illustrate the relevant topics/sections. |
||
}} |
|||
{{clear}} |
|||
{{-}} |
{{-}} |
||
* {{tlx|todo|list=./to do2}} |
|||
{{ |
* {{Tlx|To do|list{{=}}./to do2}} |
||
{{To do|nocats=yes|list=./to do2}} |
|||
{{clear}} |
|||
{{-}} |
|||
* {{Tlx|To do|target{{=}}Talk:Britney Spears|1}} |
|||
{{To do|nocats=yes|target=Talk:Britney Spears|1}} |
|||
{{-}} |
{{-}} |
||
* {{tlx|todo|target=Talk:Britney Spears|1}} |
|||
{{todo|nocats=yes|target=Talk:Britney Spears|1}} |
|||
{{clear}} |
|||
==See also== |
|||
* {{tl|tasks}} |
|||
===See also=== |
|||
<includeonly> |
|||
* {{Tl|Tasks}} |
|||
[[Category:To-do list templates|{{PAGENAME}}]] |
|||
* Post-it templates |
|||
** {{Tl|Post-it small}} |
|||
** {{Tl|Post-it medium}} |
|||
** {{Tl|Post-it large}} |
|||
* {{Tl|Refideas}} |
|||
<includeonly>{{sandbox other|| |
|||
[[da:Skabelon:Huskeliste]] |
|||
<!-- Categories below this line; interwikis at Wikidata --> |
|||
[[es:Plantilla:Porhacer]] |
|||
{{DEFAULTSORT:To Do}} |
|||
[[fr:Modèle:À faire]] |
|||
[[Category:To-do list templates]] |
|||
[[hu:Sablon:Todo]] |
|||
[[Category:Talk header templates]] |
|||
[[ja:Template:Todo]] |
|||
[[Category:Generic WikiProject templates]] |
|||
[[ml:ഫലകം:Todo]] |
|||
}}</includeonly> |
|||
[[nl:Sjabloon:Actieprioriteit]] |
|||
[[pl:Szablon:DoZrobienia]] |
|||
[[pt:Predefinição:Por fazer]] |
|||
[[ru:Шаблон:To-do]] |
|||
[[vi:Tiêu bản:Cần làm]] |
|||
[[zh:Template:To-do]] |
|||
</includeonly> |
Latest revision as of 21:33, 20 August 2021
This is a documentation subpage for Template:To do. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 7,600 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
This template adds a to do list to a talk page. If you place this template, for example, on Talk:Article name, then type in the to do items on a Talk:Article name/to do page, then this template will automatically display them.
Note: Please do not spam this template speculatively to talk pages, as it should only be added when editors are actually going to use it. Unused templates may be removed by any editor without warning.
Usage
[edit]{{To do}}
– the normal, default to do list{{To do|collapsed=yes}}
– collapses the list{{To do|for=[[Wikipedia:WikiProject Foo|WikiProject Foo]]}}
– allows alternative page name reference (e.g. a project) instead of the default (which will be the non-talk pagename of the current page).{{To do|inner=Blah Blah Blah}}
– uses the contents of 'inner' as the to do list{{To do|list=./TODO}}
– uses the subpage./TODO
as the to do list, instead of subpage./to do
{{To do|maxheight=h}}
– sets the maximum heighth
(number with suffixpx
,em
or%
; e.g. 200px) of the to do list before vertical scroll bars appear. Keep in mind that this doesn't work for all browsers (they must support the max-height and overflow CSS attributes working together). If no height is given, the to do list's height will depend on its contents.{{To do|N}}
– whereN
is a number from 1 to 9, defining its priority. (1 is the highest){{To do|nocats=yes}}
– doesn't include page in Category:Wikipedia pages with to-do lists{{To do|nopreload=yes}}
– clicking the edit link takes you to a blank page instead of a preloaded one{{To do|small=yes}}
– formats the to do list as the 'small' version{{To do|target=Foo}}
– uses the to do list of pageFoo
instead{{To do|To-do=Alternative title}}
– changes the "To-do" title of the displayed box to something else, e.g.:{{To do|To-do=Log of RfCs}}
. This allows repurposing this template for other-than-"to-do" purposes.- Can also be given as
|to-do=
without capital T. - Use the
|target
parameter for accessing another article's to do list, e.g., from a WikiProject page (can be seen in action at WP:TBT)
- Can also be given as
{{To do|lmd=no}}
– do not output the last modified date - the date that the To do list was updated
Parameters
[edit]General parameters:
{{To do |collapsed= |for= |inner= |list= |maxheight= |nocats= |nopreload= |small= |target= }}
Parameters for use as a meta-template:
{{To do ... |above= |below= |category= |image= |inner= |smallfor= (if the |for= parameter should be displayed when small) |To-do= (change the wording "To-do" to something else) }}
Examples
[edit]{{To do}}
To-do list for Template:To do/doc: To-do list is empty: remove {{To do}} tag or click on edit to add an item. |
{{To do|9}}
To-do list for Template:To do/doc: To-do list is empty: remove {{To do}} tag or click on edit to add an item. Priority 9
|
{{To do|small=yes}}
To-do list is empty: remove {{To do}} tag or click on edit to add an item. |
{{To do|small=yes|9}}
{{To do|collapsed=yes|9}}
To-do list for Template:To do/doc: To-do list is empty: remove {{To do}} tag or click on edit to add an item. Priority 9 |
{{To do|inner=
* To Prepare this article for FA status.
* Addition of pictures and/or photographs to illustrate the relevant topics/sections.
}}
To-do list for Template:To do/doc:
|
{{To do|list=./to do2}}
To-do list for Template:To do/doc: To-do list is empty: remove {{To do}} tag or click on edit to add an item. |
{{To do|target=Talk:Britney Spears|1}}
To-do list for Talk:Britney Spears:
Priority 1 (top)
|
See also
[edit]- {{Tasks}}
- Post-it templates
- {{Post-it small}}
- {{Post-it medium}}
- {{Post-it large}}
- {{Refideas}}