|Title|Support Commenting In Wiki Content
|Date|01-Sep-2005 19:47:50 EEST
|JSPWiki version|2.2.28
|Submitter|GregorHagedorn
|[Idea Category]|MarkupIdea
|Reference|
|[Idea Status]|ConsideredIdea

Occasionally, wiki content writers find it useful to make a note to themselves that is only shown during editing. Examples are a marker how far refactoring of a page has progressed, commenting on the use of plugins for automation, etc.

I propose to overload the existing plugin syntax by defining:
{{{
[{-- comment in wiki notation, not rendered at all --}] 
}}}

I do not think it necessary to render these as html comments, but if for some reason desired I have no objections either.


-----
However, if content is rendered as HTML comment, it should contain valid wiki syntax only (or be rendered as if it was regular Wiki-Content), e.g. whoever picks up the idea should take care not to enable HTML/script injection by adding {{{ [{-- <script>alert("hello");</script> --}] }}} using this syntax... 

-- OlafKock

I think it's okay if it just gets the standard entity escaping treatment.  Putting WikiMarkup in something that never gets rendered is kinda redundant ;-)

-- JanneJalkanen