Template:Todo/doc: Difference between revisions

Arseniiv (talk | contribs)
will work after moving
 
Arseniiv (talk | contribs)
m add inline
Line 1: Line 1:
This template applies up to seven [[:Category:Todo|<code>Todo:</code> categories]] to the page, or the main [[:Category:Todo]] itself, as well as places a notice so you can mark the specific place in need of attention.
This template applies up to seven [[:Category:Todo|<code>Todo:</code> categories]] to the page, or the main [[:Category:Todo]] itself. When <code>inline</code> 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 ==
== Usage ==


Just write something like <code><nowiki>{{Todo| expand }}</nowiki></code> and get this:
Just write something like <code><nowiki>{{Todo| expand |inline=1}}</nowiki></code> and get this:


{{Todo| expand }}
{{Todo| expand |inline=1}}


You can specify several notes, up to seven, adding them as additional arguments: <code><nowiki>{{Todo| add color name | expand | unify precision }}</nowiki></code> which gives:
You can specify several notes, up to seven, adding them as additional arguments: <code><nowiki>{{Todo| add color name | expand | unify precision |inline=1}}</nowiki></code> which gives:


{{Todo| add color name | expand | unify precision }}
{{Todo| 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><nowiki>{{Todo| unify precision | comment=An occasionally appearing surplus decimal place <code>5</code> gives a deceptive impression of higher accuracy. }}</nowiki></code>
<code><nowiki>{{Todo| unify precision | comment=An occasionally appearing surplus decimal place <code>5</code> gives a deceptive impression of higher accuracy. |inline=1}}</nowiki></code>


{{Todo| unify precision | comment=An occasionally appearing surplus decimal place <code>5</code> gives a deceptive impression of higher accuracy. }}
{{Todo| unify precision | comment=An occasionally appearing surplus decimal place <code>5</code> gives a deceptive impression of higher accuracy. |inline=1}}


Finally, if you deem obvious what is there to do, use this template without arguments: <code><nowiki>{{Todo}}</nowiki></code> leaves us with laconic
Finally, if you deem obvious what is there to do, use this template without arguments: <code><nowiki>{{Todo|inline=1}}</nowiki></code> leaves us with laconic


{{Todo}}
{{Todo|inline=1}}