====== HTML Comment Plugin ======

---- plugin ----
description: Enables HTML comments
author     : Christopher Arndt
email      : chris@chrisarndt.de
type       : syntax
lastupdate : 2013-03-19
compatible : Rincewind, Angua, Adora Belle, Weatherwax, Binky, Ponder Stibbons, Greebo, Hogfather, Igor
depends    : 
conflicts  : ckgedit
similar    : comment, commentsrc
tags       : annotations, hide

downloadurl: https://github.com/danny0838/dokuwiki-plugin-htmlcomment/archive/master.zip
sourcerepo : https://github.com/danny0838/dokuwiki-plugin-htmlcomment/
bugtracker : https://github.com/danny0838/dokuwiki-plugin-htmlcomment/issues
----

This is a very simple plugin that allows HTML style comments to be used in the [[:wikitext]]. They will show up unchanged in the XHTML output. They will not be rendered by the browser, but can be viewed with "View source code" command. The syntax is exactly like in HTML:

  <!-- This is a HTML comment -->

This can be useful, if you're post-processing the HTML output in some way, e.g. to produce PDF documents. Some converters can use special HTML comments to steer the conversion process.

===== Acknowledgments =====

This plugin is based on the [[plugin:comment]] plugin by [[esther@kaffeehaus.ch|Esther Brunner]].

===== Installation =====

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

===== Changes =====

{{rss>https://github.com/danny0838/dw-htmlcomment/commits/master.atom date}}

New in version 1.1:

  * Incorporated changes made by [[esther@kaffeehaus.ch|Esther Brunner]] (see [[#Discussion]]).
  * Defined constant ''HTMLCOMMENT_SAFE'' to allow to switch back to old behaviour.
  * Removed version number from plugin archive, since the [[plugin:extension]] manager can't handle versioned archives.

===== Discussion =====

Please feel free to add comments, suggestions and questions here. Please sign them with your [[features:signature]].  --- //[[chris@chrisarndt.de|ChristopherArndt]] 2005-09-30 18:12//

> Hi Christopher, I've taken the liberty to fix a possible security issue. Before it was possible to include for example JavaScript in a HTML comment. Now XML Entities are escaped. If the old behaviour was what you intended for your plugin, restore the old version, but make clear it's a possible security risk. --- //[[esther@kaffeehaus.ch|Esther Brunner]] 2005-10-01 02:12//

>> I had tested the following with the original version:

  <!-- This is a HTML comment <script type="text/javascript"> window.alert('Gotcha!'); document.write("Vulnerable!");</script> -->

>> No dialog, no output. So the browser (Firefx) doesn't handle script tags inside HTML comments. Am I missing something here? Do other browser behave different? --- //[[chris@chrisarndt.de|ChristopherArndt]] 2005-10-01 03:24//

>>> Ok, I incorporated the changes into the distribution archive as well (see [[#changes|above]]). --- //[[chris@chrisarndt.de|ChristopherArndt]] 2005-10-09 00:07//

> Hi! One short question: Commented text is displayed in search results. Is there a method to prevent this? --- //[[orinoco]] 2011-03-09 9:20//

It should be no problem to embed the unescaped code into the html comment, so I removed the escape feature. The code is slight changed and is replaced into a git repo. Already informed the original author.  --- [[user>danny0838|danny0838]] //2013/03/19 08:54//