1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
<?php
namespace Bitweaver\Liberty;
use Bitweaver\KernelTools;
/**
* @version $Revision$
* @package liberty
* @subpackage plugins_data
*/
// +----------------------------------------------------------------------+
// | Copyright (c) 2004, bitweaver.org
// +----------------------------------------------------------------------+
// | All Rights Reserved. See below for details and a complete list of authors.
// | Licensed under the GNU LESSER GENERAL PUBLIC LICENSE. See http://www.gnu.org/copyleft/lesser.html for details
// |
// | For comments, please use phpdocu.sourceforge.net documentation standards!!!
// | -> see http://phpdocu.sourceforge.net/
// +----------------------------------------------------------------------+
// | Author: StarRider <starrrider@users.sourceforge.net>
// | Rewritten for bitweaver by Author
// +----------------------------------------------------------------------+
// $Id$
/**
* definitions
*/
define( 'PLUGIN_GUID_DATAPLUGINHELP', 'datapluginhelp' );
global $gLibertySystem;
$pluginParams = [
'tag' => 'PLUGINHELP',
'auto_activate' => false,
'requires_pair' => false,
'load_function' => '\data_pluginhelp',
'title' => 'PluginHelp', // and Remove the comment from the start of this line
'help_page' => 'DataPluginPluginHelp',
'description' => KernelTools::tra("This plugin will display the plugin's Help."),
'help_function' => '\data_pluginhelp_help',
'syntax' => "{PLUGINHELP plugin= }",
'plugin_type' => DATA_PLUGIN,
];
$gLibertySystem->registerPlugin( PLUGIN_GUID_DATAPLUGINHELP, $pluginParams );
$gLibertySystem->registerDataTag( $pluginParams['tag'], PLUGIN_GUID_DATAPLUGINHELP );
// Help Function
function data_pluginhelp_help() {
$help =
'<table class="data help">'
.'<tr>'
.'<th>'.KernelTools::tra( "Key" ).'</th>'
.'<th>'.KernelTools::tra( "Type" ).'</th>'
.'<th>'.KernelTools::tra( "Comments" ).'</th>'
.'</tr>'
.'<tr class="odd">'
.'<td>plugin</td>'
.'<td>'.KernelTools::tra( "string").'<br />'.KernelTools::tra("(manditory)").'</td>'
.'<td>'.KernelTools::tra( "The Name of the Plugin to be displayed.")
.'<br />'.KernelTools::tra( "There is").' <strong>No</strong> '.KernelTools::tra( "Default.")
.'</td>'
.'</tr>'
.'</table>'
. KernelTools::tra("Example: ") ."{PLUGINHELP plugin='pluginhelp' } - Will display the Plugin\'s Help<br />"
. KernelTools::tra("Example: ") ."{PLUGINHELP plugin='pluginhelp' showdata=true } - Will display the Plugin\'s PluginParams";
return $help;
}
/* Load Function
function data_pluginhelp($data, $params) {
global $gLibertySystem;
extract ($params);
if (!isset($plugin)) {// Exit if the Parameter is not set
return pluginError('PluginHelp', KernelTools::tra('There was No Plugin Named for').' <strong>PluginHelp</strong> '.KernelTools::tra('to work with.'));
}
foreach (array_keys($gLibertySystem->mPlugins) as $pluginGuid) {
$pluginParams = $gLibertySystem->mPlugins[$pluginGuid];
if ($pluginParams['plugin_type'] == DATA_PLUGIN && isset($pluginParams['description']) && $pluginParams['tag'] == strtoupper($plugin))
$thisGuid = $pluginGuid;
}
if (!isset($thisGuid)) { // The Plugin was not found
$ret =
'<div class="box">'
.'<div class="error" style="text-align:center;">'
.'<h2>'.KernelTools::tra('Error in the Plugin "').'PluginHelp</h2>'
.'</div><hr />'
.'<div class="boxcontent">'
.KernelTools::tra('The Plugin Name Specified').' <strong>plugin='.$plugin.'</strong> '.KernelTools::tra('does not exist.')
.'</div>';
'</div>';
return $ret;
}
$pluginParams = $gLibertySystem->mPlugins[$thisGuid];
if (!is_array($pluginParams)) // Something is Wrong - Exit
return KernelTools::tra('The Plugin Name Given To <strong>PluginHelp "').plugin.KernelTools::tra('"</strong> Either Does Not Exist Or Is Not Active.');
$runhelp = $pluginParams['help_function'];
$runhelp = $runhelp();
$ret =
'<table class="data help" style="width: 100%;" border="2" cellpadding="4">'
.'<caption><strong><big><big>Plugin Data</big></big></strong></caption>'
.'<tr>'
.'<th colspan="4" style="text-align: center;"><strong><big><big>'.$pluginParams['title'].'</big></big></strong></th>'
.'</tr>'
.'<tr class="odd">'
.'<td title="'.KernelTools::tra('The GUID is a string used to locate the Plugins Data.').'">GUID => '.$thisGuid.'</td>'
.'<td title="'.KernelTools::tra('The Tag is the string you add to the text that calls the Plugin.').'">tag => '.$pluginParams['tag'].'</td>'
.'<td title="'.KernelTools::tra('Provides a Default value for the Administrator.').'">auto_activate => '.($pluginParams['auto_activate'] ? 'True' : 'False').'</td>'
.'<td title="'.KernelTools::tra('The Number of Code Blocks required by the Plugin. Can be 1 or 2').'">requires_pair => '.($pluginParams['requires_pair'] ? 'True' : 'False').'</td>'
.'</tr>'
.'<tr class="even">'
.'<td colspan="4" title="'.KernelTools::tra('The Description states what the Plugin does.">').'description => '.$pluginParams['description'].'</td>'
.'</tr>'
.'<tr class="odd">'
.'<td colspan="2" title="'.KernelTools::tra('This function does the work & is called by the Parser when the Tag is found.').'">load_function => '.$pluginParams['load_function'].'</td>'
.'<td colspan="2" title="'.KernelTools::tra('This function displays the Extended Help Data for the Plugin.').'">help_function => '.$pluginParams['help_function'].'</td>'
.'</tr>'
.'<tr class="even">'
.'<td colspan="4" title="'.KernelTools::tra('The Syntax to be inserted into an editor for useage.').'">syntax => '.$pluginParams['syntax'].'</td>'
.'</tr>'
.'<tr class="odd">'
.'<td colspan="4" title="'.KernelTools::tra('Provides a link to a Help Page on bitweaver.org.').'">help_page => '.$pluginParams['help_page'].'</td>'
.'</tr>';
if ($thisGuid != 'datalibrary') $ret .= // This button is not needed by the Plugin Library {LIB}
'<tr class="even">'
.'<td colspan="4" style="text-align: center;" title="'.KernelTools::tra('Click to Visit the Help Page on bitweaver.org in a new window.').'">'
.'<input type="button" value="Visit the Help Page" onclick="javascript:BitBase.popUpWin(\'http://bitweaver.org/wiki/index.php?page='.$pluginParams['help_page'].'\',\'standard\',800,800)"></input>'
.'</td>'
.'</tr>';
$ret .= '</table>'
.'<div style="text-align: center;"><strong><big><big>'.KernelTools::tra('Parameter Data').'</big></big></strong></div>'
.'<div class="help box">~np~'.$runhelp.'~/np~</div>';
return $ret;
}
*/
|
