Template:Todo/doc: Difference between revisions

Line 2:

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 |inline=1}}</nowiki></code> and get this:

Line 14:

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.

<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><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. |inline=1}}

Line 22:

Line 21:

Finally, if you don't find a category the todo fits in, use this template without arguments: <code><nowiki>{{Todo}}</nowiki></code>, this way invisible.

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><nowiki>{{Todo|inline=1|text=~~what~~ has to be done}}</nowiki></code>

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

@@ Line 2: / Line 2: @@
 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 |inline=1}}</nowiki></code> and get this:
@@ Line 14: / 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.
-<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><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. |inline=1}}
@@ Line 22: / Line 21: @@
 Finally, if you don't find a category the todo fits in, use this template without arguments: <code><nowiki>{{Todo}}</nowiki></code>, this way invisible.
-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><nowiki>{{Todo|inline=1|text=what has to be done}}</nowiki></code>
+: <code><nowiki>{{Todo|inline=1|text=What has to be done}}</nowiki></code>
-{{Todo|inline=1|text=what has to be done}}
+{{Todo|inline=1|text=What has to be done}}