[
https://issues.apache.org/jira/browse/DOXIA-685?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Herve Boutemy updated DOXIA-685:
--------------------------------
Description:
Currently, verbatim text is inconsistently handled in the Sink API
([verbatim(SinkEventAttribute)|https://maven.apache.org/doxia/doxia-archives/doxia-2.0.0-M4/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html#verbatim-org.apache.maven.doxia.sink.SinkEventAttributes-])
and formats apt, xhtml5, xdoc, fml and markdown.
{{BOXED}} implies that some box should be rendered in the output, but it
actually (since skin addition of code highlighting, a long time ago, with
[jQuery](https://github.com/apache/maven-fluido-skin/commit/b41e581f858690296bce561207eb449ebdbf01f3)
and [prettify.js and
.css](https://github.com/apache/maven-fluido-skin/commit/4e2869b19469af17e008e6b7ee50ca49fc8f3a47))
indicates that this is source code to be likely highlighted.
In other words, from the API one does not know this and about the look and feel
at the end the output format and styling should decide/guess rather than the
sink. For those reasons the following change is proposed:
* {{BOXED}} as original name will be deprecated and then removed w/o replacement
* {{Sink#verbatim()}} and {{Sink#verbatim(null)}} will print verbatim text w/o
any implications
* The {{Xhtml5Sink}} will make add to every verbatim block {{<div
class="verbatim">}} instead of no class
* {{SinkEventAttributes#SOURCE}} to explicitly denotimate verbatim source code,
{{Xhtml5Sink}} will add {{<div class="verbatim source">}}, the {{Apt}} format
will turn {{+--...--+}} to verbatim source as well.
* The {{EchoMacro}} and {{SnippetMacro}} won't use {{BOXED}} anymore
* The {{SnippetMacro}} will have a {{source=true}} attribute which denotes
source code, but IF {{verbatim=true}}
was:
Currently, verbatim text is inconsistently handled in the Sink API
([verbatim(SinkEventAttribute)|https://maven.apache.org/doxia/doxia-archives/doxia-2.0.0-M4/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html#verbatim-org.apache.maven.doxia.sink.SinkEventAttributes-])
and formats apt, xhtml5, xdoc, fml and markdown.
{{BOXED}} implies that some box should be rendered in the output, but it
actually (since skin addition of code highlighting, [a long time
ago|http://svn.apache.org/viewvc/maven/skins/trunk/maven-fluido-skin/src/main/resources/META-INF/maven/site.vm?r1=1305528&r2=1305527&pathrev=1305528])
indicates that this is source code to be likely highlighted.
In other words, from the API one does not know this and about the look and feel
at the end the output format and styling should decide/guess rather than the
sink. For those reasons the following change is proposed:
* {{BOXED}} as original name will be deprecated and then removed w/o replacement
* {{Sink#verbatim()}} and {{Sink#verbatim(null)}} will print verbatim text w/o
any implications
* The {{Xhtml5Sink}} will make add to every verbatim block {{<div
class="verbatim">}} instead of no class
* {{SinkEventAttributes#SOURCE}} to explicitly denotimate verbatim source code,
{{Xhtml5Sink}} will add {{<div class="verbatim source">}}, the {{Apt}} format
will turn {{+--...--+}} to verbatim source as well.
* The {{EchoMacro}} and {{SnippetMacro}} won't use {{BOXED}} anymore
* The {{SnippetMacro}} will have a {{source=true}} attribute which denotes
source code, but IF {{verbatim=true}}
> Replace SinkEventAttributes#BOXED and clearly separate between regular
> verbatim and verbatim source (code)
> ----------------------------------------------------------------------------------------------------------
>
> Key: DOXIA-685
> URL: https://issues.apache.org/jira/browse/DOXIA-685
> Project: Maven Doxia
> Issue Type: Improvement
> Components: Core
> Affects Versions: 2.0.0-M4
> Reporter: Michael Osipov
> Assignee: Michael Osipov
> Priority: Major
> Fix For: 2.0.0-M5
>
>
> Currently, verbatim text is inconsistently handled in the Sink API
> ([verbatim(SinkEventAttribute)|https://maven.apache.org/doxia/doxia-archives/doxia-2.0.0-M4/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html#verbatim-org.apache.maven.doxia.sink.SinkEventAttributes-])
> and formats apt, xhtml5, xdoc, fml and markdown.
> {{BOXED}} implies that some box should be rendered in the output, but it
> actually (since skin addition of code highlighting, a long time ago, with
> [jQuery](https://github.com/apache/maven-fluido-skin/commit/b41e581f858690296bce561207eb449ebdbf01f3)
> and [prettify.js and
> .css](https://github.com/apache/maven-fluido-skin/commit/4e2869b19469af17e008e6b7ee50ca49fc8f3a47))
> indicates that this is source code to be likely highlighted.
> In other words, from the API one does not know this and about the look and
> feel at the end the output format and styling should decide/guess rather than
> the sink. For those reasons the following change is proposed:
> * {{BOXED}} as original name will be deprecated and then removed w/o
> replacement
> * {{Sink#verbatim()}} and {{Sink#verbatim(null)}} will print verbatim text
> w/o any implications
> * The {{Xhtml5Sink}} will make add to every verbatim block {{<div
> class="verbatim">}} instead of no class
> * {{SinkEventAttributes#SOURCE}} to explicitly denotimate verbatim source
> code, {{Xhtml5Sink}} will add {{<div class="verbatim source">}}, the {{Apt}}
> format will turn {{+--...--+}} to verbatim source as well.
> * The {{EchoMacro}} and {{SnippetMacro}} won't use {{BOXED}} anymore
> * The {{SnippetMacro}} will have a {{source=true}} attribute which denotes
> source code, but IF {{verbatim=true}}
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
