MindTouch Community Portal
Logged in: Logged in as: Log in
Register
Search:
Page last modified 15:32, 6 Sep 2009 by SteveB
Template:Documentation >
Page Notifications Off

Template:Documentation

     

    page.toc

    Introduction

    Introduce your template.  Brag a little!

     

    History

    Update this section with each version and/or bug fix

    Version Date Author Description
           

    Requirements

    List any requirements needed for this template/extension to work.

    • This template requires MindTouch version:

    How do I install it?

    Be a specific about the installation as you can be.  Remember not everyone is a programmer or cares to be that will be using your template/extension.   Reference any attached files that are needed as well.

    Remember to change the Template:TemplateName to the appropriate TemplateName!

    1. Create a template, call it "Template:TemplateName" (or rename as you desire).  You must have UNSAFECONTENT permission for this to work.
    2. Create a "DekiScript" block on the template page (use the "Style" menu in the editor")
    3. Copy the code from the end of this page and paste it into the DekiScript block.  To copy, click "expand source", then mouse over the top right corner of the source code, and click the "view source" button.  This will pop up a window with the source code.  Select all, then copy to clipboard.
    4. Make sure there isn't an extra blank paragraph after the DekiScript block! Do this every time you edit!!!  
    5. Save.

     

    A quick note about the examples on this page

    For all the examples on this page, the code is shown before the working example.  The code is shown with the syntax extension, and looks like this:

    Insert an example syntax below

    TemplateName()

    This means that the actual code on the page should be enclosed in a DekiScript block.  If you want to copy the code from this page, then use the same procedure as described in steps 2-4 above. 

    How do I use it?

    Explain in as much detail that is needed to successfully use your Template/Extension.  Remember you are not just documenting your work but also creating a tutorial for others.

     

    Arguments

    Create the list of arguments according to the table below.

    Name
    		 Type
    		 Default
    		 Description
           
           

    Examples

    This is where the fun starts!  Put examples of your template/extension in action.  Show the viewers what they can do with it.  Try to make the examples as real world as possible.
    REMEMBER: Put an example of your template/extension call in a formatted block. Then follow it up with the actual example results.

     

    Place Example Here

    'Replace with actual example.'

     

    Reference(s)

    This is a place where you can place any references that may be of help to the end user.

     

    Credits/Special Thanks

    Remember your roots!  Give credit where credit is due.

     

    Template/Extension Source Code

    Place the Source code block(s) here.   If the template exists in the templates section (i.e. is an actual template) then you can use the following to insert it.    Other wise place the code in a formated block and make appropriate changes to the "How to use section above".

    syntax.dekiscript(xml.text(wiki.getpage('Template:TemplateName').xml, "//pre"), true)

     

    Disclaimers

    Place any known disclaimers here.  i.e. GPL License Agreements, Whether or not Icons are known to be freely usable, etc.

    None.

    Tag page
    What links here

    Files 0

    Attach file or image
     
    You must login to post a comment.
    MindTouch Social Knowledge Base

    Copyright © 2011 MindTouch, Inc. Powered by