It's better when it's simple

User Tools

Site Tools


HTML Comment Plugin

Compatible with DokuWiki

  • 2024-02-06 "Kaos" unknown
  • 2023-04-04 "Jack Jackrum" unknown
  • 2022-07-31 "Igor" yes
  • 2020-07-29 "Hogfather" yes

plugin Enables HTML comments

Last updated on
Conflicts with

Similar to comment, commentsrc, wrap

Tagged with annotations, hide

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.


This plugin is based on the comment plugin by Esther Brunner.


Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.


New in version 1.1:

  • Incorporated changes made by Esther Brunner (see Discussion).
  • Defined constant HTMLCOMMENT_SAFE to allow to switch back to old behaviour.
  • Removed version number from plugin archive, since the extension manager can't handle versioned archives.


Please feel free to add comments, suggestions and questions here. Please sign them with your signature. — 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 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? — ChristopherArndt 2005-10-01 03:24
Ok, I incorporated the changes into the distribution archive as well (see above). — 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. — danny0838 2013/03/19 08:54

plugin/htmlcomment.txt · Last modified: 2023-01-09 08:22 by

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki