pluginwikitemplate

Template for wikipages describing a plugin

If you add your plugin to the wiki, please use the following template, this will give all plugin pages a consistent look. When adding your plugin you should remove all text from the template between [ and ] and replace it with the appropriate values for your plugin. If you feel some sections/value is not usefull for your plugin feel free to delete it but please document your plugin well enough! Ofcourse you are free to add as much sections as you want :)

====== NP_[PluginName].php ======

//[Description of your plugin goes here]//

^General Plugin info ^^
^Author: | [link to author's site & author name] |
^Current Version: | [Versionnumber of most current release goes here] |
^Download: |[link to a download or the code goes here] [format (mostly zip)] [size, by example 10kb] [How many files are there in the zip?]|
^Code: | [Link to the plugin-code goes here: create a new page and name it using the sufix _code, like NP_MyPlugin_code]|
^Demo: | [link to a demo of the plugin goes here] |
^Forum Thread: |[link to the forum thread about the plugin goes here]|


=====Installing=====
  - Unzip the file and upload the contents to your plugin directory
  - [[http://faq.nucleuscms.org/item/35|Install the plugin]]
  - [Plugin-specific stuff like adding skinvars to a skin, settings option etc]

=====How to use the plugin=====
[Please describe how your plugins works and how users can use it]

=====Available SkinVars and/or TemplateVars=====
  * [describe here the available skinvars and templatevars for your plugin.]

=====Options=====
  * [describe here all the available options of your plugin]

=====Tips and Tricks=====

=====Wishlist=====

=====Bugs=====

=====History=====
  * [Version 0.1, released <date> ]
    * [CHANGED: foobar]

Sample Plugin Page

FAQ

  • How plugin pages should be named?

A: Use the exactly name of the plugin main file, including caps: “NP_Online.php”. Use the sufix “_code” to place the plugin code in a separated page, like in “NP_Online_code.php”. – moraes

OK

 
pluginwikitemplate.txt · Last modified: 2009/03/16 09:52 by lengl