4 Copyright 1999, 2000, 2001, 2002 $ThePhpWikiProgrammingTeam
6 This file is part of PhpWiki.
8 PhpWiki is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 PhpWiki is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with PhpWiki; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 * A simple demonstration WikiPlugin.
27 * <?plugin HelloWorld?>
29 * salutation="Greetings, "
32 * <?plugin HelloWorld salutation=Hi ?>
33 * <?plugin HelloWorld name=WabiSabi ?>
36 // Constants are defined before the class.
37 if (!defined('THE_END'))
38 define('THE_END', "!");
40 class WikiPlugin_HelloWorld
43 // Five required functions in a WikiPlugin.
46 return _("HelloWorld");
49 function getDescription () {
50 return _("Simple Sample Plugin");
54 function getVersion() {
55 return preg_replace("/[Revision: $]/", '',
59 // Establish default values for each of this plugin's arguments.
60 function getDefaultArguments() {
61 return array('salutation' => "Hello,",
65 function run($dbi, $argstr, &$request, $basepage) {
66 extract($this->getArgs($argstr, $request));
68 // Any text that is returned will not be further transformed,
69 // so use html where necessary.
70 $html = HTML::tt(fmt('%s: %s', $salutation, WikiLink($name, 'auto')),
76 // $Log: not supported by cvs2svn $
77 // Revision 1.12 2003/01/18 21:41:02 carstenklapp
79 // Reformatting & tabs to spaces;
80 // Added copyleft, getVersion, getDescription, rcs_id.
88 // c-hanging-comment-ender-p: nil
89 // indent-tabs-mode: nil