Template:Todo/doc: Difference between revisions
todo self-categorizes based on subpage and namespace; todos placed on documentation will categorize the transcluding page, not the doc subpage |
m since this template is demoing itself on its own docpage, it should turn off its own categories |
||
| Line 5: | Line 5: | ||
Just write something like <code><nowiki>{{Todo|inline=1| expand }}</nowiki></code> and get this: | Just write something like <code><nowiki>{{Todo|inline=1| expand }}</nowiki></code> and get this: | ||
{{Todo|inline=1| expand }} | {{Todo|inline=1| expand | debug=1}} | ||
You can specify up to eight notes as unnamed arguments. <code><nowiki>{{Todo|inline=1| add color name | expand | unify precision }}</nowiki></code> gives: | You can specify up to eight notes as unnamed arguments. <code><nowiki>{{Todo|inline=1| add color name | expand | unify precision }}</nowiki></code> gives: | ||
{{Todo|inline=1| add color name | expand | unify precision }} | {{Todo|inline=1| add color name | expand | unify precision | debug=1}} | ||
Each unnamed argument adds the article to the same-name category. Make sure to check out [[:Category: Todo]] for a catalogue of defined tasks. If you do not find a category the todo fits in, use this template without arguments: <code><nowiki>{{Todo}}</nowiki></code>. | Each unnamed argument adds the article to the same-name category. Make sure to check out [[:Category: Todo]] for a catalogue of defined tasks. If you do not find a category the todo fits in, use this template without arguments: <code><nowiki>{{Todo}}</nowiki></code>. | ||
| Line 17: | Line 17: | ||
:<code><nowiki>{{Todo|inline=1| unify precision | comment=An occasionally appearing surplus decimal place <code>5</code> gives a deceptive impression of higher accuracy. }}</nowiki></code> | :<code><nowiki>{{Todo|inline=1| unify precision | comment=An occasionally appearing surplus decimal place <code>5</code> gives a deceptive impression of higher accuracy. }}</nowiki></code> | ||
{{Todo|inline=1| unify precision | comment=An occasionally appearing surplus decimal place <code>5</code> gives a deceptive impression of higher accuracy. }} | {{Todo|inline=1| unify precision | comment=An occasionally appearing surplus decimal place <code>5</code> gives a deceptive impression of higher accuracy. | debug=1}} | ||
Note: placing this template on a template or module's documentation (/doc) will categorize that page when transcluded, but not the actual documentation page. | Note: placing this template on a template or module's documentation (/doc) will categorize that page when transcluded, but not the actual documentation page. | ||
Revision as of 23:58, 22 October 2025
| This template should not be substituted. |
This template applies up to eight Todo: categories to the page, or the main Category: Todo itself. When inline is present, it additionally places a visible notice in the page text. With or without that, you mark the specific place in need of attention.
Usage
Just write something like {{Todo|inline=1| expand }} and get this:
You can specify up to eight notes as unnamed arguments. {{Todo|inline=1| add color name | expand | unify precision }} gives:
Each unnamed argument adds the article to the same-name category. Make sure to check out Category: Todo for a catalogue of defined tasks. If you do not find a category the todo fits in, use this template without arguments: {{Todo}}.
You can add a comment, which appears with inline=1, using an optional argument comment, description, or text. You may want to end it with a full stop, which is not added automatically for this one.
{{Todo|inline=1| unify precision | comment=An occasionally appearing surplus decimal place <code>5</code> gives a deceptive impression of higher accuracy. }}
| Todo: unify precision
An occasionally appearing surplus decimal place |
Note: placing this template on a template or module's documentation (/doc) will categorize that page when transcluded, but not the actual documentation page.