[JSPWIKI-1040] Add new markup (%%% ... /%) for marking plain-text sections

• Type: Improvement
• Status: Open
• Priority: Minor
• Resolution: Unresolved
• Component/s: Core & storage
• Assignee: Unassigned
• Reporter: Dirk Frederickx
• Created: 18/Dec/16 22:09
• Updated: 05/Apr/19 21:29

Description

JSPWiki uses the following pattern to mark a block of text, to apply different styles (eg. %%info) or as a trigger for a javascript handler adding certain behaviour (eg. %%viewer)

%%<some-marker>    ...   /%  

Note that the text inside the %% block continues to be parsed as regular JSPWiki text. (eg. [links] are properly converted to <a>; explicit line-breaks, etc...)

For some use-cases, it would be convenient to be able to mark certain sections in a page indicating that the text inside the section should NOT be parsed by JSPWiki.
This is similar to a pre-formatted text block enclosed in triple curly braces but then with different styling.
Today's workaround is to try to escape any possible markup conflict (with tilde character) or to combine both syntaxes like this:

%%<some-marker>
{{{
...
}}}
/%

Both solutions are cumbersome and not trivial to the user.

---

The proposed syntax is to use a triple % sign:

%%%<some-marker>
.... plain vanilla text, remains unparsed by jsp-wiki
/%

Example use-case:

• mark a block of Tex/LaTeX syntax, and have some JS to render the math
• add an exotic markup language converter written in javascript (markdown, pod, ...)
• etc.