Template:Todo/doc
This page is a template. It contains some standardized, often used text, which can be transcluded inside other pages. As this template is widely used in our wiki, it may be protected in which case only staff members can change it. Use the discussion page to propose enhancements or fixes, or to voice your opinion.
Use this template for adding todo lists to articles.
Articles using this template are added to Category:Todo articles. Do not confuse Category:Todo articles with Category:Todo, which lists all the areas of the wiki that have been flagged as needing work.
Parameters
Use this template for adding todo lists to articles.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Id | id | Add link text (HTML id attribute). Note: This can conflict with other ids on the page, so make it unique. Using a unique date string such as YYYYMMDDHHMM for the todo item should work fine. A UUID is probably a bit overkill, but could work too. | String | optional |
| Header | header | Add the heading. Be aware that special characters for templates include = and |, so they will need to be escaped with {{=}} or {{!}} respectively if used in the header. Default value is 'Todo:'. | Unbalanced wikitext | optional |
| 1 | 1 | First todo list item. This parameter is required since every todo list should have at least one item. Be aware that special characters for templates include = and |, so they will need to be escaped with {{=}} or {{!}} respectively if used in the header. | Unbalanced wikitext | required |
| 2 | 2 | Second todo list item. Be aware that special characters for templates include = and |, so they will need to be escaped with {{=}} or {{!}} respectively if used in the header. | Unbalanced wikitext | optional |
| 3 | 3 | Third todo list item. Be aware that special characters for templates include = and |, so they will need to be escaped with {{=}} or {{!}} respectively if used in the header. | Unbalanced wikitext | optional |
| 4 | 4 | Fourth todo list item. Be aware that special characters for templates include = and |, so they will need to be escaped with {{=}} or {{!}} respectively if used in the header. | Unbalanced wikitext | optional |
| 5 | 5 | Fifth todo list item. Be aware that special characters for templates include = and |, so they will need to be escaped with {{=}} or {{!}} respectively if used in the header. | Unbalanced wikitext | optional |
| 6 | 6 | Sixth todo list item. Be aware that special characters for templates include = and |, so they will need to be escaped with {{=}} or {{!}} respectively if used in the header. | Unbalanced wikitext | optional |
| 7 | 7 | Seventh todo list item. Be aware that special characters for templates include = and |, so they will need to be escaped with {{=}} or {{!}} respectively if used in the header. | Unbalanced wikitext | optional |
| 8 | 8 | Eighth todo list item. Be aware that special characters for templates include = and |, so they will need to be escaped with {{=}} or {{!}} respectively if used in the header. | Unbalanced wikitext | optional |
| 9 | 9 | Ninth todo list item. Be aware that special characters for templates include = and |, so they will need to be escaped with {{=}} or {{!}} respectively if used in the header. | Unbalanced wikitext | optional |
Usage
See the template's testcases:
| No parameter | |
|---|---|
| Wiki code | {{Todo}}
|
| Main version |
Todo:
|
| Sandbox version |
Todo:
|
| Parameter: 1 | |
|---|---|
| Wiki code | {{Todo|1=First todo item.}}
|
| Main version |
Todo:
|
| Sandbox version |
Todo:
|
| Parameter: header, 1 | |
|---|---|
| Wiki code | {{Todo|header=My todo list:|1=First todo item.}}
|
| Main version |
My todo list:
|
| Sandbox version |
My todo list:
|
| Parameter: id, header, 1, 2, ... | |
|---|---|
| Wiki code | {{Todo|id=20211007|header=My todo list:|1=First todo item.|2=Second todo item.}}
|
| Main version |
My todo list:
|
| Sandbox version |
My todo list:
|
| Parameter: id, header, 1, 2, 3, 4... | |
|---|---|
| Wiki code | {{Todo|id=20211007|header=My todo list:|1=First todo item.|2=Second todo item.|3=Third todo item.|4= ...}}
|
| Main version |
My todo list:
|
| Sandbox version |
My todo list:
|
See also
- Category:Maintenance templates — provide information on the status or quality of articles, or add other meta-information to pages or sections
- {{Archived}} - mark an article as archived, as in of a previous time and may be useful for informational purposes only
- {{Dated}} - mark an article as outdated and encourage other readers to improve its contents
- {{Delete}} - mark an article as a candidate for deletion
- {{Deprecated}} - mark an article as deprecated
- {{Dirty}} - mark an article as dirty, i.e. not conforming to the wiki Guidelines
- {{Stale}} - mark an article as stale, as in while not clearly outdated, may have some elements suspected of not being in line with current practices
- {{Stub}} - mark an article as a stub, in need of expanding
- {{WIP}} - mark an article as a work in progress