lib/plugin/Comment.php

   1 <?php
   2
   3 /*
   4  * Copyright (C) 2003 Martin Geisler
   5  * Copyright (C) 2003-2004 $ThePhpWikiProgrammingTeam
   6  * Copyright (C) 2009 Marc-Etienne Vargenau, Alcatel-Lucent
   7  *
   8  * This file is part of PhpWiki.
   9  *
  10  * PhpWiki is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * PhpWiki is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
  22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  23 */
  24
  25 /**
  26  * A WikiPlugin for putting comments in WikiPages
  27  *
  28  * Usage:
  29  * <<Comment
  30  *
  31  * == My Secret Text
  32  *
  33  * This is some WikiText that won't show up on the page.
  34  *
  35  * >>
  36  */
  37
  38 class WikiPlugin_Comment
  39     extends WikiPlugin
  40 {
  41     function getDescription()
  42     {
  43         return _("Embed hidden comments in WikiPages.");
  44     }
  45
  46     // No arguments here.
  47     function getDefaultArguments()
  48     {
  49         return array();
  50     }
  51
  52     function run($dbi, $argstr, &$request, $basepage)
  53     {
  54         return HTML::raw('');
  55     }
  56 }
  57
  58 // Local Variables:
  59 // mode: php
  60 // tab-width: 8
  61 // c-basic-offset: 4
  62 // c-hanging-comment-ender-p: nil
  63 // indent-tabs-mode: nil
  64 // End: