Version 1

Plugin Help Pages Source

One Possible Scenario

Created by: Lee LaMont Bell Jr., Last modification: 08 Mar 2006 (05:40 UTC) by Lee LaMont Bell Jr.
  1. Every Plugin Help Page should be Categorized. Select the Categorize Tab and check "Documentation ยป Plugins". This allows all of the Plugin Help Pages to be displayed at the bottom of the page under Related Items
  2. All of the Plugin Help Pages should have a Description - I use: The Plugin xxx Help Page
  3. Most of the following should be included on every Plugin Help Page.


Provide a short Introduction. This should briefly state what the plugin does. I also like to include a link to the page DataPlugins.


Most of the Plugins originally came from TikiWiki but check the source file (I made sure that all of the Authors and their email address were correct). Lets give credit where it is due.
If it does come from TikiWiki - then search TikiWiki or the TikiWiki Doc Site for information on it. Do Not rely too heavily on that source though. Veryify that it is still correct. The original idea and source may have came from TikiWiki - but every Plugins was rewritten for bitweaver and many operational changes were made! The largest change was the inclusion of the variable $pluginParams['requires_pair'] => FALSE which allows Plugins to use a single Code Block. Most Plugins that don't operate on data placed between Code Blocks were changed. Some parameters name were also changed - although I did try to minimize those changes.
Again - Check the Code!


Provide a more detailed explanation of what the Plugin Does.

How It Works?

Check the Source Code
If the variable $pluginParams['requires_pair'] => TRUE then include:
This Plugin operates on the data placed between the Code Blocks - see the Heading Between The Code Blocks
If the variable $pluginParams['requires_pair'] => FALSE then include:
This Plugin operates with a single Code Blocks. That is - only a single call to the Plugin is required

A brief explanation should also be provided to explain how the Plugin operates. That should include when and where it should be used.

The Plugin's Help


Between the Code Blocks

Note: This heading should only be included when a Plugins has the variable $pluginParams['requires_pair'] => TRUE
For those of you who don't know - when we say the word Code Block - we are referring to the way you call a Plugin. Some Plugins only use a single Code Block to operate while others need two. Examples are:
  • {AGENTINFO info= } requires a Single Code Block
  • {CODE source= num= }Sorce Code{/CODE} requires Two Code Blocks. The first is {CODE source= num= } and the second is {/CODE}.
Nearly all Plugins that require 2 Code Blocks do so because they expect a lot of data and are designed to work on it.

Note: Some Plugins use Key-Words or some other device between the Code Blocks. If this one does - Specify what it is and how it works like this:
The Data between the Code Blocks falls into three Classifications: Class A / Class B / & Class C.
  • A Character Sequence is used to separate that Data into their appropriate Classes. By Default Character Sequence is *** but can be redefined with the Parameter SomeParameterName.
  • Class A does this.
  • Class B does that.
  • Class C does the other thing.


Most of the examples demonstrate what the Plugin does by setting Parameters and explaining what they are there for. When there are a lot of parameters - this becomes difficult. One method to do it is using a build-up scheme. Each Example adds a single parameter to those used in the previous Example.

At any rate - be sure that each Example shows exactly what is happening by showing the parameters being set. This is easily done by coping the WikiSyntax that calls the Plugin and placing it inside {np{ blocks like this: __{np{{AGENTINFO info= }~123123~__ With some plugins this does not work. When it doesn't - try replacing the each __{__ character with the tilde (~) character / the numbers 123 / and another tilde character. The trailing __}__ characters can be replaced as well with a tilde the number 125 and another tilde character. The trailing __}__ characters don't normally cause any problem though. Because we get a link out of all capitalized words - add a double ) and double ( around the Plugins Name to prevent the link. See the example in the code. !!- Example 1 - Different Ways To Show Parameters Using np - ^__~np~{CODE }Sorce Code{CODE}

Sorce Code

Replacing the { } Characters -
{))CODE(( }Sorce Code{CODE}^

Sorce Code

Page History
18 May 2008 (20:45 UTC)
Current • Source
Lee LaMont Bell Jr.
View • Compare • Difference • Source
Lee LaMont Bell Jr.
View • Compare • Difference • Source
Lee LaMont Bell Jr.
View • Compare • Difference • Source