Template:Todo/doc: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
← Older edit
VisualWikitext
ArrowHead294 (talk | contribs)
15,215 edits
m ArrowHead294 moved page Template:Todo/Doc to Template:Todo/doc: Keep case consistent across documentation pages
Ganaram inukshuk (talk | contribs)
autopatrolled, emailconfirmed
6,211 edits
mNo edit summary
 
(13 intermediate revisions by 4 users not shown)
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:
{{Todo|inline=1| expand | debug=1}}


{{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:
{{Todo|inline=1| add color name | expand | unify precision | debug=1}}


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


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


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.
=== See also ===
 
* [[Template:Category handler]], which prevents this template from categorizing /doc pages, when added to a template or module's /doc page.
If you use <code>inline=1</code> add a short description in the <code>text</code> parameter.
* [[Template:Expert needed]]
<code><nowiki>{{Todo|inline=1|text=what has to be done}}</nowiki></code>
 
{{Todo|inline=1|text=what has to be done}}

Latest revision as of 23:52, 23 October 2025

This template should not be substituted.

This template applies up to eight Todo: categories to the page, or the main Category: Todo itself. When inline 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

Just write something like {{Todo|inline=1| expand }} and get this:

Todo: expand


You can specify up to eight notes as unnamed arguments. {{Todo|inline=1| add color name | expand | unify precision }} gives:

Todo: add color name, expand, unify precision


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: {{Todo}}.

You can add a comment, which appears with inline=1, using an optional argument comment, description, or text. You may want to end it with a full stop, which is not added automatically for this one.

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

An occasionally appearing surplus decimal place 5 gives a deceptive impression of higher accuracy.


See also

Retrieved from "https://en.xen.wiki/index.php?title=Template:Todo/doc&oldid=214289"