====== Hidden Comment ======

---- plugin ----
description: Add comments / notes to your wiki source that won't be shown on the page (previous authors: Esther Brunner)
author     : Gina Häußge, Michael Klier
email      : dokuwiki@chimeric.de
type       : syntax
lastupdate : 2008-02-11
compatible : >= 2006-11-06
depends    : 
conflicts  : 
similar    : commentsrc
tags       : comment, hidden
----

^ Download | [[http://www.chimeric.de/_src/plugin-comment.tgz|plugin-comment.tgz]] |

This tiny [[plugins|plugin]] allows you to leave notes to yourself (and other authors of your wiki) in the wiki source code that won't be shown on the wiki page. The syntax is like C and PHP:

**Example:**
<code>
The text /* between the slash-asterik and asterisk-slash */ is hidden
</code>
**Becomes:**
  The text is hidden
\\

You can also have multi-line comments:
  /**
   * @todo: rewrite this section to reflect changes made recently
   *
   * this is a longer note
   */

But this single line example works too:

  /********** added by Esther **********/

===== Installation =====
Extract the contents of the .zip or .tgz file to <your_dokuwiki_path>/lib/plugins and it should work.


===== Further Resources =====
  * [[http://darcs.chimeric.de/darcsweb.cgi?r=comment|Darcs Repository]]
  * [[http://dev.chimeric.de/codereference/nav.html?plugins/comment/index.html|Source code]]