lib/plugin/Comment.php

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