Difference between revisions of "Template:ToDo"

From Hitchwiki
Jump to navigation Jump to search
m
Line 11: Line 11:
 
|}<includeonly>{{#ifeq: {{{nocats}}} |yes|
 
|}<includeonly>{{#ifeq: {{{nocats}}} |yes|
 
<!-- nothing -->|
 
<!-- nothing -->|
[[Category:To do]]
+
[[Category:Personal or old to dos]]
 
}}</includeonly>
 
}}</includeonly>
 
<noinclude>
 
<noinclude>
 
==Documentation==
 
==Documentation==
{{ToDo/doc}}
+
This template adds a todo list to a '''talk page'''.
 +
 
 +
If you want to add a todo list to an article, e.g. [[Poland]], then create a todo list at [[Talk:Poland]], and then add <code><nowiki>{{toDo|target=Talk:Poland}}</nowiki></code> to the main article. But anyway, todo lists should normally be used only on talk pages, to get an overview of tasks for people who want to work on it.
 +
 
 +
If you put this template on <nowiki>[[Talk:Article]]</nowiki>, then type in the to-do items on the page <nowiki>[[Talk:Article/to do]]</nowiki>, and this template will automatically display them.
 +
 
 +
Please do not spam this template speculatively to talk pages.  It should 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 -->
 +
 
 +
:<code><nowiki>{{toDo}}</nowiki></code> gives a normal todo list
 +
:<code><nowiki>{{toDo|N}}</nowiki></code> where <tt>N</tt> is a number from 1 to 9 to define its priority
 +
:<code><nowiki>{{toDo|small&#61;yes}}</nowiki></code> formats the todo list small
 +
:<code><nowiki>{{toDo|nocats&#61;yes}}</nowiki></code> don't include categories
 +
:<code><nowiki>{{toDo|nopreload&#61;yes}}</nowiki></code> don't include preloaded text
 +
:<code><nowiki>{{toDo|list&#61;./TODO}}</nowiki></code> use the subpage ''./TODO'' as todo list instead of subpage ''./to do''
 +
:<code><nowiki>{{toDo|target&#61;Foo}}</nowiki></code> use the todo list of page ''Foo'' instead
 +
 
 +
Use the <code>target</code> parameter for accessing another article's to-do list.
 +
 
 +
== Example ==
 +
<!-- for the documentation don't subst the result -->
 +
 
 +
<code><nowiki>{{toDo}}</nowiki></code>
 +
{{toDo}}
 +
 
 +
<code><nowiki>{{toDo|N}}</nowiki></code>
 +
{{toDo|9}}
 +
 
 +
<code><nowiki>{{toDo|small&#61;yes}}</nowiki></code>
 +
{{toDo|small=yes}}
 +
 
 +
<br clear=both>
 +
 
 +
<code><nowiki>{{toDo|small&#61;yes|9}}</nowiki></code>
 +
{{toDo|small=yes|9}}
 +
<br clear=both>
 +
 
 +
<code><nowiki>{{toDo|list&#61;./to do2}}</nowiki></code>
 +
{{toDo|list=./to do2}}
 +
 
 +
<code><nowiki>{{toDo|target&#61;Talk:Britney Spears|1}}</nowiki></code>
 +
{{toDo|target=Talk:Britney Spears|1}}
 +
 
 
[[Category:Templates]]
 
[[Category:Templates]]
 
</noinclude>
 
</noinclude>

Revision as of 01:37, 5 October 2017

40px-Stock post message.png To-do list for Template:ToDo:
  • This is just a test to-do list to help editors make sure that the text
  • shows
    1. up
    2. correctly
  • Normally, the "/to do" subpage should only be created under the article's Talk page, unless it is a notice board or project page.
  • To use this template for your own project, insert {{todo}} at the top of that article's Talk discussion page.

Documentation

This template adds a todo list to a talk page.

If you want to add a todo list to an article, e.g. Poland, then create a todo list at Talk:Poland, and then add {{toDo|target=Talk:Poland}} to the main article. But anyway, todo lists should normally be used only on talk pages, to get an overview of tasks for people who want to work on it.

If you put this template on [[Talk:Article]], then type in the to-do items on the page [[Talk:Article/to do]], and this template will automatically display them.

Please do not spam this template speculatively to talk pages. It should be added when editors are actually going to use it. Unused templates may be removed by any editor without warning.

Usage

{{toDo}} gives a normal todo list
{{toDo|N}} where N is a number from 1 to 9 to define its priority
{{toDo|small=yes}} formats the todo list small
{{toDo|nocats=yes}} don't include categories
{{toDo|nopreload=yes}} don't include preloaded text
{{toDo|list=./TODO}} use the subpage ./TODO as todo list instead of subpage ./to do
{{toDo|target=Foo}} use the todo list of page Foo instead

Use the target parameter for accessing another article's to-do list.

Example

{{toDo}}

40px-Stock post message.png To-do list for Template:ToDo:
  • This is just a test to-do list to help editors make sure that the text
  • shows
    1. up
    2. correctly
  • Normally, the "/to do" subpage should only be created under the article's Talk page, unless it is a notice board or project page.
  • To use this template for your own project, insert {{todo}} at the top of that article's Talk discussion page.


{{toDo|N}}

40px-Stock post message.png To-do list for Template:ToDo:
  • This is just a test to-do list to help editors make sure that the text
  • shows
    1. up
    2. correctly
  • Normally, the "/to do" subpage should only be created under the article's Talk page, unless it is a notice board or project page.
  • To use this template for your own project, insert {{todo}} at the top of that article's Talk discussion page.
Priority 9  


{{toDo|small=yes}}

40px-Stock post message.png To-do:
  • This is just a test to-do list to help editors make sure that the text
  • shows
    1. up
    2. correctly
  • Normally, the "/to do" subpage should only be created under the article's Talk page, unless it is a notice board or project page.
  • To use this template for your own project, insert {{todo}} at the top of that article's Talk discussion page.



{{toDo|small=yes|9}}

40px-Stock post message.png To-do:
  • This is just a test to-do list to help editors make sure that the text
  • shows
    1. up
    2. correctly
  • Normally, the "/to do" subpage should only be created under the article's Talk page, unless it is a notice board or project page.
  • To use this template for your own project, insert {{todo}} at the top of that article's Talk discussion page.
Priority 9  


{{toDo|list=./to do2}}

40px-Stock post message.png To-do list for Template:ToDo:

Here are some tasks you can do:


{{toDo|target=Talk:Britney Spears|1}}

40px-Stock post message.png To-do list for Talk:Britney Spears:

Here are some tasks you can do:
Priority 1 (top)