Template:Todo/doc: Difference between revisions

ArrowHead294 (talk | contribs)
mNo edit summary
ArrowHead294 (talk | contribs)
m De-escape
Line 3: Line 3:


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


{{{{ROOTPAGENAME}}| expand |inline=1}}
{{{{ROOTPAGENAME}}| expand |inline=1}}


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:
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:


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


{{{{ROOTPAGENAME}}| unify precision | comment=An occasionally appearing surplus decimal place <code>5</code> gives a deceptive impression of higher accuracy. |inline=1}}
{{{{ROOTPAGENAME}}| unify precision | comment=An occasionally appearing surplus decimal place <code>5</code> gives a deceptive impression of higher accuracy. |inline=1}}
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>{{((}}Todo{{!}}inline=1{{!}}text{{=}}What has to be done{{))}}</code>  
: <code><nowiki>{{Todo|inline=1|text=What has to be done}}</nowiki></code>  


{{{{ROOTPAGENAME}}|inline=1|text=What has to be done}}
{{{{ROOTPAGENAME}}|inline=1|text=What has to be done}}