Template:Todo/doc: Difference between revisions

(7 intermediate revisions by 3 users not shown)

Line 1:

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.

This template applies up to eight [[: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|inline=1| expand }}</nowiki></code> and get this:

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

{{{{ROOTPAGENAMEE}}|inline=1| expand }}

You can specify up to eight notes as unnamed arguments. <code><nowiki>{{Todo|inline=1| add color name | expand | unify precision }}</nowiki></code> 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:~~

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

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

Each unnamed argument adds the article to the same-name category. Make sure to check out [[:Category: Todo]] for a catalogue of defined tasks. If you do not find a category the todo fits in, use this template without arguments: <code><nowiki>{{Todo}}</nowiki></code>.

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, which appears with <code>inline=1</code>, using an optional argument <code>comment</code>, <code>description</code>, or <code>text</code>. You may want to end it with a full stop, which is 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|inline=1| unify precision | comment=An occasionally appearing surplus decimal place <code>5</code> gives a deceptive impression of higher accuracy. }}</nowiki></code>

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

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

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

=== See also ===

* [[Template:Expert needed]]

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

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

~~{{Todo|inline=1|text=what has to be done}}~~

@@ 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. 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.
+{{Dochead}}{{substitute|no}}
+This template applies up to eight [[: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|inline=1| expand }}</nowiki></code> and get this:
-Just write something like <code><nowiki>{{Todo| expand |inline=1}}</nowiki></code> and get this:
+{{{{ROOTPAGENAMEE}}|inline=1| expand }}
-{{Todo| expand |inline=1}}
+You can specify up to eight notes as unnamed arguments. <code><nowiki>{{Todo|inline=1| add color name | expand | unify precision }}</nowiki></code> 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:
+{{{{ROOTPAGENAMEE}}|inline=1| add color name | expand | unify precision }}
-{{Todo| add color name | expand | unify precision |inline=1}}
+Each unnamed argument adds the article to the same-name category. Make sure to check out [[:Category: Todo]] for a catalogue of defined tasks. If you do not find a category the todo fits in, use this template without arguments: <code><nowiki>{{Todo}}</nowiki></code>.
-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, which appears with <code>inline=1</code>, using an optional argument <code>comment</code>, <code>description</code>, or <code>text</code>. You may want to end it with a full stop, which is 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|inline=1| unify precision | comment=An occasionally appearing surplus decimal place <code>5</code> gives a deceptive impression of higher accuracy. }}</nowiki></code>
-{{Todo| unify precision | comment=An occasionally appearing surplus decimal place <code>5</code> gives a deceptive impression of higher accuracy. |inline=1}}
+{{{{ROOTPAGENAMEE}}|inline=1| unify precision | comment=An occasionally appearing surplus decimal place <code>5</code> gives a deceptive impression of higher accuracy. }}
-All the unnamed parameters add the article to the same-name category. See [[:Category:Todo]] for a catalogue of already defined tasks.
+=== See also ===
+* [[Template:Expert needed]]
-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.
- <code><nowiki>{{Todo|inline=1|text=what has to be done}}</nowiki></code>
-{{Todo|inline=1|text=what has to be done}}