Template:TESTSelfDocumenting

    Summary

    Documentation URL
    http://I-haven't-done-this-yet.com/
    Description

    This template demonstrates "self-documentation": the ability to put the most critical bits of documentation directly into the template itself, and enable the following:

    1. Documentation page for the template just pulls the data out of the template itself.  This eliminates the need to maintain two identical copies of things like version history, argument descriptions, etc.
    2. Automatic usage summaries for templates on a wiki, plus linkage to official documentation.  How are users supposed to figure out how to use the templates on a wiki???
    Note that this documentation will not appear when you use the template.  It will not even show up in the HTML!
    Requirements none

    Version History (newest on top!)

    Version Date Author Description
    0.2 6-March-2010 neilw tweaked
    0.1 25-Feb-2010 neilw First experiment

    Template Parameters

    Name Type Default Description
    N.A.     This template doesn't take any parameters
    Put your code below the line
    // UNSAFECONTENT PERMISSION CHECK
    // This code checks if the template is properly installed for unsafe content execution,
    // and may be removed if this check is not desired.  If you leave this here, add your new code
    // in a new DekiScript block below this one.
    var chkunsafe = wiki.inclusions()[-1];
    if (!wiki.pagepermissions(chkunsafe.id, chkunsafe.author.id).unsafecontent)
      <div style="color:red; width:75%; padding:5px; border:1px solid red;">
        "WARNING: The page '"..chkunsafe.path.."' must be re-saved by a user with UNSAFECONTENT permission in order to work correctly. ";
        <a href="http://developer.mindtouch.com/en/kb/Using_templates_which_require_UNSAFECONTENT_permission"> "See this" </a>;
        " for more info."; 
      </div>;
    
    // Your code here
    "Here I am!";
    
    Tag page
    You must login to post a comment.

    Copyright © 2011 MindTouch, Inc. Powered by