Template:Todo/doc

From Gentoo Wiki
Jump to:navigation Jump to:search
Note
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.

Parameters

Use this template for adding todo lists to articles.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Idid

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.

Stringoptional
Headerheader

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 wikitextoptional
11

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 wikitextrequired
22

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 wikitextoptional
33

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 wikitextoptional
44

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 wikitextoptional
55

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 wikitextoptional
66

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 wikitextoptional
77

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 wikitextoptional
88

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 wikitextoptional
99

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 wikitextoptional

Usage

See the template's testcases:


No parameter
Wiki code {{Todo}}

Main version







Sandbox version

Todo:







Parameter: 1
Wiki code {{Todo|1=First todo item.}}

Main version
  • First todo item.







Sandbox version

Todo:

  • First todo item.






Parameter: header, 1
Wiki code {{Todo|header=My todo list:|1=First todo item.}}

Main version
  • First todo item.







Sandbox version

My todo list:

  • First todo item.






Parameter: id, header, 1, 2, ...
Wiki code {{Todo|id=20211007|header=My todo list:|1=First todo item.|2=Second todo item.}}

Main version
  • First todo item.
  • Second todo item.






Sandbox version

My todo list:

  • First todo item.
  • Second todo item.






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
  • First todo item.
  • Second todo item.
  • Third todo item.
  • ...





Sandbox version

My todo list:

  • First todo item.
  • Second todo item.
  • Third todo item.
  • ...