Template:Todo/doc: Difference between revisions

Line 3:

=== Usage ===

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

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~~><nowiki~~>{{Todo| add color name | expand | unify precision |inline=1}}~~</nowiki>~~</code> which gives:

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:

{{~~Todo~~| add color name | expand | unify precision |inline=1}}

{{{{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.

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

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

{{~~Todo~~| 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}}

All the unnamed parameters add the article to the same-name category. See [[:Category:Todo]] for a catalogue of already defined tasks.

Line 23:

If you use <code>inline=1</code> add a short description in the <code>text</code> parameter:

: <code~~><nowiki~~>{{Todo|inline=1|text=What has to be done}}~~</nowiki>~~</code>

: <code>{{((}}Todo{{!}}inline=1{{!}}text{{=}}What has to be done{{))}}</code>

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

@@ Line 3: / Line 3: @@
 === Usage ===
-Just write something like <code><nowiki>{{Todo| expand |inline=1}}</nowiki></code> and get this:
+Just write something like <code>{{((}}Todo{{!}} expand {{!}}inline{{=}}1{{))}}</code> and get this:
-{{Todo| expand |inline=1}}
+{{{{ROOTPAGENAME}}| 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 |inline=1}}</nowiki></code> which gives:
+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:
-{{Todo| add color name | expand | unify precision |inline=1}}
+{{{{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.
-:<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>
+:<code>{{((}}Todo{{!}} unify precision {{!}} comment{{=}}An occasionally appearing surplus decimal place <code>5</code> gives a deceptive impression of higher accuracy. {{!}}inline{{=}}1{{))}}</code>
-{{Todo| 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}}
 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:
-: <code><nowiki>{{Todo|inline=1|text=What has to be done}}</nowiki></code>
+: <code>{{((}}Todo{{!}}inline=1{{!}}text{{=}}What has to be done{{))}}</code>
-{{Todo|inline=1|text=What has to be done}}
+{{{{ROOTPAGENAME}}|inline=1|text=What has to be done}}