Template:Todo/doc: Difference between revisions
ArrowHead294 (talk | contribs) No edit summary |
ArrowHead294 (talk | contribs) mNo edit summary |
||
Line 3: | Line 3: | ||
=== Usage === | === Usage === | ||
Just write something like <code | Just write something like <code>{{((}}Todo{{!}} expand {{!}}inline{{=}}1{{))}}</code> and get this: | ||
{{ | {{{{ROOTPAGENAME}}| expand |inline=1}} | ||
You can specify several notes, up to seven, adding them as additional arguments: <code | You can specify several notes, up to seven, adding them as additional arguments: <code>{{((}}Todo{{!}} add color name {{!}} expand {{!}} unify precision {{!}}inline{{=}}1{{))}}</code> which gives: | ||
{{ | {{{{ROOTPAGENAME}}| add color name | expand | unify precision |inline=1}} | ||
You can add a comment, using an optional argument named (alternatively) <code>comment</code>, <code>description</code>, or <code>text</code>. You may want to end it with a full stop, it’s not added automatically for this one. | You can add a comment, using an optional argument named (alternatively) <code>comment</code>, <code>description</code>, or <code>text</code>. You may want to end it with a full stop, it’s not added automatically for this one. | ||
:<code | :<code>{{((}}Todo{{!}} unify precision {{!}} comment{{=}}An occasionally appearing surplus decimal place <code>5</code> gives a deceptive impression of higher accuracy. {{!}}inline{{=}}1{{))}}</code> | ||
{{ | {{{{ROOTPAGENAME}}| unify precision | comment=An occasionally appearing surplus decimal place <code>5</code> gives a deceptive impression of higher accuracy. |inline=1}} | ||
All the unnamed parameters add the article to the same-name category. See [[:Category:Todo]] for a catalogue of already defined tasks. | All the unnamed parameters add the article to the same-name category. See [[:Category:Todo]] for a catalogue of already defined tasks. | ||
Line 23: | Line 23: | ||
If you use <code>inline=1</code> add a short description in the <code>text</code> parameter: | If you use <code>inline=1</code> add a short description in the <code>text</code> parameter: | ||
: <code | : <code>{{((}}Todo{{!}}inline=1{{!}}text{{=}}What has to be done{{))}}</code> | ||
{{ | {{{{ROOTPAGENAME}}|inline=1|text=What has to be done}} |
Revision as of 11:05, 13 September 2024
This template applies up to seven 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| expand |inline=1}}
and get this:
You can specify several notes, up to seven, adding them as additional arguments: {{Todo| add color name | expand | unify precision |inline=1}}
which gives:
You can add a comment, using an optional argument named (alternatively) comment
, description
, or text
. You may want to end it with a full stop, it’s not added automatically for this one.
{{Todo| unify precision | comment=An occasionally appearing surplus decimal place
5
gives a deceptive impression of higher accuracy. |inline=1}}
![]() |
Todo: unify precision An occasionally appearing surplus decimal place |
All the unnamed parameters add the article to the same-name category. See Category:Todo for a catalogue of already defined tasks.
Finally, if you don't find a category the todo fits in, use this template without arguments: {{Todo}}
, this way invisible.
If you use inline=1
add a short description in the text
parameter:
{{Todo|inline=1|text=What has to be done}}