Difference between revisions of "Template:Todo"

From apm
Jump to: navigation, search
(generic todo template - as simple as possible for now)
 
(added refinement todo)
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
<span style="background:#AAAAFF">('''Todo:''' {{{1}}})</span>
+
<onlyinclude><span style="background:#AAAAFF">('''TODO:''' {{{1}}})</span><includeonly>[[Category:ContainsTodos]]</includeonly></onlyinclude>
 +
----
 +
== Usage: ==
 +
Add this template into flowing text or as bullet point on pages wherever you see that further work is needed that cant be done on the spot.currently cant be done
 +
 
 +
* <nowiki>{{todo|[short note that makes sense in the context of the usage of this template]|[optional detailed description (hidden)]}}</nowiki>
 +
 
 +
== Categorization ==
 +
 
 +
All pages that contain this template at least once will autmatically added to the category [[:Caegory:ContainsTodos]].
 +
 
 +
* {{todo|find a more fine grained method|Find a more fine grained method to make an auto-created page that collects all usages of the todo template and lists this usages sorted by the second parameter.}} produced by: <br> <nowiki>{{todo|find a more fine grained method|Find a more fine grained method to make an auto-created page that collects all usages of the todo template and lists this usages sorted by the second parameter.}}</nowiki>
 +
* {{todo|create refined todo templates: research, engineer, explore, extend-page, search and collect, illustrate, investigate, search existing research}} <br> How to demarcate against other templates like: stub biased and others? Make a guide when to use what. Link back here.
 +
 
 +
* '''observation:''' self recursive references are not evaluated in further iterations
 +
 
 +
=== The second parameter ===
 +
Hidden parameter for sorting only: {{{2=no details given}}} <br>
 +
 
 +
== Testing this template ==
 +
 +
[[Special:ExpandTemplates]] <br>
 +
To test correct behaviour in flowing text use: <nowiki>"testtext1 {{todo|foo|bar}} testtext2"</nowiki>

Latest revision as of 06:13, 1 October 2015

(TODO: {{{1}}})


Usage:

Add this template into flowing text or as bullet point on pages wherever you see that further work is needed that cant be done on the spot.currently cant be done

  • {{todo|[short note that makes sense in the context of the usage of this template]|[optional detailed description (hidden)]}}

Categorization

All pages that contain this template at least once will autmatically added to the category Caegory:ContainsTodos.

  • (TODO: find a more fine grained method) produced by:
    {{todo|find a more fine grained method|Find a more fine grained method to make an auto-created page that collects all usages of the todo template and lists this usages sorted by the second parameter.}}
  • (TODO: create refined todo templates: research, engineer, explore, extend-page, search and collect, illustrate, investigate, search existing research)
    How to demarcate against other templates like: stub biased and others? Make a guide when to use what. Link back here.
  • observation: self recursive references are not evaluated in further iterations

The second parameter

Hidden parameter for sorting only: {{{2=no details given}}}

Testing this template

Special:ExpandTemplates
To test correct behaviour in flowing text use: "testtext1 {{todo|foo|bar}} testtext2"