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 along
19 * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 * A simple demonstration WikiPlugin.
29 * salutation="Greetings, "
32 * <<HelloWorld salutation=Hi >>
33 * <<HelloWorld name=WabiSabi >>
36 // Constants are defined before the class.
37 if (!defined('THE_END'))
38 define('THE_END', "!");
40 class WikiPlugin_HelloWorld
43 // Four required functions in a WikiPlugin.
46 return _("HelloWorld");
49 function getDescription () {
50 return _("Simple Sample Plugin");
54 // Establish default values for each of this plugin's arguments.
55 function getDefaultArguments() {
56 return array('salutation' => "Hello,",
60 function run($dbi, $argstr, &$request, $basepage) {
61 extract($this->getArgs($argstr, $request));
63 // Any text that is returned will not be further transformed,
64 // so use html where necessary.
65 $html = HTML::tt(fmt('%s: %s', $salutation, WikiLink($name, 'auto')),
75 // c-hanging-comment-ender-p: nil
76 // indent-tabs-mode: nil