====== Comment Plugin ======

---- plugin ----
description: Add comments / notes to your wiki source that won't be shown on the page.
author     : Dokufreaks (previous author: Gina Häußge, Michael Klier, Esther Brunner)
email      : freaks@dokuwiki.org
type       : syntax
lastupdate : 2023-08-18
compatible : Rincewind, Angua, Adora Belle, Binky, Ponder Stibbons, Hrun, Detritus, Elenor Of Tsort, Frusterick Manners, Greebo, Hogfather, Igor, Jack Jackrum
depends    : 
conflicts  : fckg
similar    : commentsrc, commentsyntax, htmlcomment
tags       : annotations, hide, comment

downloadurl: https://github.com/dokufreaks/plugin-comment/archive/master.zip
bugtracker : https://github.com/dokufreaks/plugin-comment/issues
sourcerepo : https://github.com/dokufreaks/plugin-comment
----

This tiny 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:**

  The text /* between the slash-asterisk and asterisk-slash */ is hidden

**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 =====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

===== Bugs / Feature Requests =====

Please report bugs or feature requests at the [[https://github.com/dokufreaks/plugin-comment/issues|Bug tracker]].

===== Further Resources =====

  * [[https://github.com/dokufreaks/plugin-comment/tree/master|Git Repository]]
  * [[https://github.com/dokufreaks/plugin-comment/issues|Bug Tracker]]

===== Changes =====

{{rss>https://github.com/dokufreaks/plugin-comment/commits/master.atom date}}

===== Comments =====

  * Email address is wrong
  * This doesn't work on 2013-12-08 "Binky"
  * Does not filter out comments within [[plugin:data|data plugin]] entries - they are shown. [[https://github.com/dokufreaks/plugin-comment/issues/9|Bugreport]]
  * For the current Dokuwiki version, use the 'comment syntax' plugin
    * Which version is meant with 'current Dokuwiki'? The 'comment' plugin is marked as 'compatible' for Frusterick Manners (which is the current version as of the writing of this question), while 'comment syntax' is marked as 'probably'  --- [[user>Dralli72|Dralli72]] //2018-03-07 00:43//
  * Could this feature be controlled with a boolean value whether it should be shown or not? 

.