Template:Todo: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
Arseniiv (talk | contribs)
m bug in the example
Arseniiv (talk | contribs)
move docs out bye bye
Line 13: Line 13:


</div></includeonly><noinclude>
</div></includeonly><noinclude>
This template applies up to seven [[:Category:Todo|<code>Todo:</code> categories]] to the page, or the main [[:Category:Todo]] itself, as well as places a notice so you can mark the specific place in need of attention.
{{/Doc}}
 
[[Category:Templates]]
== Usage ==
 
<!-- Don’t forget to change the name in the example if migrated to the templates namespace -->
 
Just write something like <code><nowiki>{{</nowiki>{{FULLPAGENAME}}<nowiki>| expand }}</nowiki></code> and get this:
 
{{ {{FULLPAGENAME}} | expand }}
 
You can specify several notes, up to seven, adding them as additional arguments: <code><nowiki>{{</nowiki>{{FULLPAGENAME}}<nowiki>| add color name | expand | unify precision }}</nowiki></code> which gives:
 
{{ {{FULLPAGENAME}} | add color name | expand | unify precision }}
 
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>{{</nowiki>{{FULLPAGENAME}}<nowiki>| unify precision | comment=An occasionally appearing surplus decimal place <code>5</code> gives a deceptive impression of higher accuracy. }}</nowiki></code>
 
{{ {{FULLPAGENAME}} | unify precision | comment=An occasionally appearing surplus decimal place <code>5</code> gives a deceptive impression of higher accuracy. }}
 
Finally, if you deem obvious what is there to do, use this template without arguments: <code><nowiki>{{</nowiki>{{FULLPAGENAME}}<nowiki>}}</nowiki></code> leaves us with laconic
 
{{ {{FULLPAGENAME}} }}
 
<!-- [[Category:Templates]] -->
</noinclude>
</noinclude>

Revision as of 12:00, 8 November 2020

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