View source for Template:To do/doc

{{Documentation subpage}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{distinguish|text=template: {{tlp|ToDo}}}}
{{high-use}}

This template adds a '''to do list''' to a ''talk page''. If you place this template, for example, on {{Fakelink|Talk:''Article&nbsp;name''}}, then type in the to do items on a {{Fakelink|Talk:''Article&nbsp;name''/to&nbsp;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 ===
<!-- 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|To do|inner{{=}}Blah Blah Blah}} – uses the contents of 'inner' as the to do list
* {{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|To do|''N''}} – where <code>''N''</code> is a number from 1 to 9, defining its priority. (1 is the highest)
* {{Tlx|To do|nocats{{=}}yes}} – doesn't include page in [[:Category:Wikipedia pages with to-do lists]]
* {{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
* {{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====
General parameters:
<pre>
{{To do
|collapsed=
|for=
|inner=
|list=
|maxheight=
|nocats=
|nopreload=
|small=
|target=
}}</pre>

Parameters for use as a meta-template:
<pre>
{{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)
}}</pre>

=== Examples ===
<!-- for the documentation don't subst the result -->
* {{Tlx|To do}}
{{To do|nocats=yes}}
{{-}}

* {{Tlx|To do|9}}
{{To do|nocats=yes|9}}
{{-}}

* {{Tlx|To do|small{{=}}yes}}
{{To do|nocats=yes|small=yes}}
{{-}}

* {{Tlx|To do|small{{=}}yes|9}}
{{To do|nocats=yes|small=yes|9}}
{{-}}

* {{Tlx|To do|collapsed{{=}}yes|9}}
{{To do|nocats=yes|collapsed=yes|9}}
{{-}}

* {{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 />}}
{{To do|nocats=yes|inner=
* To Prepare this article for FA status.
* Addition of pictures and/or photographs to illustrate the relevant topics/sections.
}}
{{-}}

* {{Tlx|To do|list{{=}}./to do2}}
{{To do|nocats=yes|list=./to do2}}
{{-}}

* {{Tlx|To do|target{{=}}Talk:Britney Spears|1}}
{{To do|nocats=yes|target=Talk:Britney Spears|1}}
{{-}}


===See also===
* {{Tl|Tasks}}
* Post-it templates
** {{Tl|Post-it small}}
** {{Tl|Post-it medium}}
** {{Tl|Post-it large}}
* {{Tl|Refideas}}

<includeonly>{{sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
{{DEFAULTSORT:To Do}}
[[Category:To-do list templates]]
[[Category:Talk header templates]]
[[Category:Generic WikiProject templates]]
}}</includeonly>