[
https://issues.apache.org/jira/browse/JSPWIKI-1040?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
brushed updated JSPWIKI-1040:
-----------------------------
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)
{noformat}
%%<some-marker> ... /%
{noformat}
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:
{noformat}
%%<some-marker>
{{{
...
}}}
/%
{noformat}
Both solutions are cumbersome and not trivial to the user.
----
The proposed syntax is to use a triple % sign:
{noformat}
%%%<some-marker>
.... plain vanilla text, remains unparsed by jsp-wiki
/%
{noformat}
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.
was:
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)
{noformat}
%%<some-marker> ... /%
{noformat}
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:
{noformat}
%%<some-marker>
{{{
...
}}}
/%
{noformat}
Both solutions are cumbersome and not trivial to the user.
----
The proposed syntax is to use a triple % sign:
{noformat}
%%%<some-marker>
.... plain vanilla text, remains unparsed by jsp-wiki
/%%
{noformat}
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.
> Add new markup (%%% ... /%%) for marking plain-text sections
> -------------------------------------------------------------
>
> Key: JSPWIKI-1040
> URL: https://issues.apache.org/jira/browse/JSPWIKI-1040
> Project: JSPWiki
> Issue Type: Improvement
> Components: Core & storage
> Reporter: brushed
> Priority: Minor
>
> 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)
> {noformat}
> %%<some-marker> ... /%
> {noformat}
> 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:
> {noformat}
> %%<some-marker>
> {{{
> ...
> }}}
> /%
> {noformat}
> Both solutions are cumbersome and not trivial to the user.
> ----
> The proposed syntax is to use a triple % sign:
> {noformat}
> %%%<some-marker>
> .... plain vanilla text, remains unparsed by jsp-wiki
> /%
> {noformat}
> 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.
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
