Some new templates for the wiki

6 views
Skip to first unread message

Alex Stewart

unread,
Jul 27, 2015, 4:05:53 PM7/27/15
to esp82...@googlegroups.com
FYI, I've added a couple of new templates for use (where appropriate) in wiki pages:

{{cleanup}}

This can be placed at the top of any page that needs organizational/textual cleanup (i.e. it's got conflicting or duplicated information, confusingly organized, badly worded, etc).

{{todo|blah blah blah}}

This can be stuck anywhere in a page to indicate tasks that, well, still need to be done (by anybody who has the time/inclination).

{{inprogress|blah blah blah|~~~~}

This can be used like "todo", but to indicate something you're actually actively working on and will be continuing to update in the near future (so other people don't duplicate your effort or trample over your changes).. Note that the second parameter (after the second "|") is intended to have the username and date of the person adding the tag, so in general you'll probably just want to use the four-tilde shortcut for the second parameter, as shown above, which will insert all the necessary details.  (the date stamp is because this is intended to be used only for things which are current and actively being worked on, and should be removed as soon as folks are done, so if you come across one of these dated substantially in the past, it should probably be considered outdated and removed)

{{idea|blah blah blah}}

This is for suggesting something which might be a good idea to try, or would be useful but might or might not work, etc.

I've also created several "auto category" pages corresponding to these tags, which pages will be automatically added to if they make use of the corresponding template:

Category:Cleanup
Category:Todo
Category:InProgress
Category:Ideas

(You can currently see some examples of these new templates in use on the "Memory Map", "Hardware", and "SPI Flash Format" pages)

--Alex
Reply all
Reply to author
Forward
0 new messages