You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by mi...@apache.org on 2023/01/09 11:30:39 UTC
[maven-doxia] branch DOXIA-685 created (now f6677aca)
This is an automated email from the ASF dual-hosted git repository.
michaelo pushed a change to branch DOXIA-685
in repository https://gitbox.apache.org/repos/asf/maven-doxia.git
at f6677aca Draft
This branch includes the following new commits:
new f6677aca Draft
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[maven-doxia] 01/01: Draft
Posted by mi...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
michaelo pushed a commit to branch DOXIA-685
in repository https://gitbox.apache.org/repos/asf/maven-doxia.git
commit f6677acab889c9f263fa98e2aacf2fbec18c8870
Author: Michael Osipov <mi...@apache.org>
AuthorDate: Mon Jan 9 12:30:28 2023 +0100
Draft
---
.../org/apache/maven/doxia/macro/EchoMacro.java | 3 +-
.../maven/doxia/macro/snippet/SnippetMacro.java | 13 ++++++-
.../maven/doxia/parser/Xhtml5BaseParser.java | 14 +++----
.../maven/doxia/sink/impl/RandomAccessSink.java | 7 ++++
.../apache/maven/doxia/sink/impl/SinkAdapter.java | 10 ++++-
.../doxia/sink/impl/SinkEventAttributeSet.java | 11 +++++-
.../maven/doxia/sink/impl/Xhtml5BaseSink.java | 17 +++++----
.../maven/doxia/sink/impl/AbstractSinkTest.java | 8 ++--
.../doxia/sink/impl/SinkEventAttributeSetTest.java | 18 ++++-----
.../doxia/sink/impl/SinkEventTestingSink.java | 6 +++
.../maven/doxia/sink/impl/SinkTestDocument.java | 8 ++--
.../maven/doxia/sink/impl/SinkUtilsTest.java | 6 +--
.../org/apache/maven/doxia/sink/impl/TextSink.java | 12 ++++--
.../sink/impl/WellformednessCheckingSink.java | 6 +++
.../maven/doxia/sink/impl/Xhtml5BaseSinkTest.java | 16 ++++----
.../apache/maven/doxia/module/apt/AptMarkup.java | 16 ++++----
.../apache/maven/doxia/module/apt/AptParser.java | 8 ++--
.../org/apache/maven/doxia/module/apt/AptSink.java | 26 ++++++-------
.../maven/doxia/module/apt/AptParserTest.java | 44 +++++++++++-----------
.../apache/maven/doxia/module/apt/AptSinkTest.java | 6 +--
.../maven/doxia/module/fml/FmlContentParser.java | 2 +-
.../doxia/module/markdown/MarkdownMarkup.java | 8 ++--
.../doxia/module/markdown/MarkdownParser.java | 5 +--
.../maven/doxia/module/markdown/MarkdownSink.java | 4 +-
.../doxia/module/markdown/MarkdownParserTest.java | 4 +-
.../doxia/module/markdown/MarkdownSinkTest.java | 6 +--
.../apache/maven/doxia/module/xdoc/XdocParser.java | 2 +-
.../apache/maven/doxia/module/xdoc/XdocSink.java | 20 +++++-----
.../maven/doxia/module/xdoc/XdocSinkTest.java | 6 +--
.../maven/doxia/module/xhtml5/Xhtml5Parser.java | 18 ++++-----
.../maven/doxia/module/xhtml5/Xhtml5SinkTest.java | 4 +-
.../java/org/apache/maven/doxia/sink/Sink.java | 9 ++++-
.../maven/doxia/sink/SinkEventAttributes.java | 2 +-
33 files changed, 201 insertions(+), 144 deletions(-)
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/macro/EchoMacro.java b/doxia-core/src/main/java/org/apache/maven/doxia/macro/EchoMacro.java
index 0cacafbf..3f9bf37e 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/macro/EchoMacro.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/macro/EchoMacro.java
@@ -23,7 +23,6 @@ import javax.inject.Named;
import javax.inject.Singleton;
import org.apache.maven.doxia.sink.Sink;
-import org.apache.maven.doxia.sink.impl.SinkEventAttributeSet;
/**
* A simple macro that prints out the key and value of some supplied parameters.
@@ -36,7 +35,7 @@ public class EchoMacro
/** {@inheritDoc} */
public void execute( Sink sink, MacroRequest request )
{
- sink.verbatim( SinkEventAttributeSet.BOXED );
+ sink.verbatim();
sink.text( "echo" + EOL );
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetMacro.java b/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetMacro.java
index 01a718b2..442c8794 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetMacro.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetMacro.java
@@ -108,6 +108,15 @@ public class SnippetMacro
verbatim = Boolean.valueOf( verbatimParam );
}
+ boolean source = false;
+
+ String sourceParam = (String) request.getParameter( "source" );
+
+ if ( sourceParam != null && !"".equals( sourceParam ) )
+ {
+ source = Boolean.valueOf( sourceParam );
+ }
+
String encoding = (String) request.getParameter( "encoding" );
URL url;
@@ -157,9 +166,9 @@ public class SnippetMacro
throw new MacroExecutionException( "Error reading snippet", e );
}
- if ( verbatim )
+ if ( verbatim || source )
{
- sink.verbatim( SinkEventAttributeSet.BOXED );
+ sink.verbatim( source ? SinkEventAttributeSet.SOURCE : null );
sink.text( snippet.toString() );
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/parser/Xhtml5BaseParser.java b/doxia-core/src/main/java/org/apache/maven/doxia/parser/Xhtml5BaseParser.java
index c3c8a3d7..03f54061 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/parser/Xhtml5BaseParser.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/parser/Xhtml5BaseParser.java
@@ -1133,17 +1133,17 @@ public class Xhtml5BaseParser
private boolean handleDivStart( XmlPullParser parser, SinkEventAttributeSet attribs, Sink sink )
{
- String divclass = parser.getAttributeValue( null, Attribute.CLASS.toString() );
+ String divClass = parser.getAttributeValue( null, Attribute.CLASS.toString() );
- this.divStack.push( divclass );
+ this.divStack.push( divClass );
- if ( "content".equals( divclass ) )
+ if ( "content".equals( divClass ) )
{
SinkEventAttributeSet atts = new SinkEventAttributeSet( attribs );
atts.removeAttribute( SinkEventAttributes.CLASS );
sink.content( atts );
}
- if ( "source".equals( divclass ) )
+ if ( "verbatim".equals( divClass ) || "verbatim source".equals( divClass ) )
{
return false;
}
@@ -1157,13 +1157,13 @@ public class Xhtml5BaseParser
private boolean handleDivEnd( Sink sink )
{
- String divclass = divStack.pop();
+ String divClass = divStack.pop();
- if ( "content".equals( divclass ) )
+ if ( "content".equals( divClass ) )
{
sink.content_();
}
- if ( "source".equals( divclass ) )
+ if ( "verbatim".equals( divClass ) || "verbatim source".equals( divClass ) )
{
return false;
}
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/RandomAccessSink.java b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/RandomAccessSink.java
index 4663af25..9604e5e9 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/RandomAccessSink.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/RandomAccessSink.java
@@ -1287,6 +1287,13 @@ public class RandomAccessSink
currentSink.unknown( name, requiredParams, attributes );
}
+ /** {@inheritDoc} */
+ @Override
+ public void verbatim()
+ {
+ currentSink.verbatim();
+ }
+
/** {@inheritDoc} */
@Override
public void verbatim( SinkEventAttributes attributes )
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/SinkAdapter.java b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/SinkAdapter.java
index f0cc09ae..f889313b 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/SinkAdapter.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/SinkAdapter.java
@@ -814,6 +814,14 @@ public class SinkAdapter
{
// nop
}
+
+ /** {@inheritDoc} */
+ @Override
+ public void verbatim()
+ {
+ // nop
+ }
+
/** {@inheritDoc} */
@Override
public void head( SinkEventAttributes attributes )
@@ -1160,7 +1168,7 @@ public class SinkAdapter
@Override
public void verbatim( SinkEventAttributes attributes )
{
- // nop
+ verbatim();
}
/** {@inheritDoc} */
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/SinkEventAttributeSet.java b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/SinkEventAttributeSet.java
index afd33eb6..24af955a 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/SinkEventAttributeSet.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/SinkEventAttributeSet.java
@@ -54,9 +54,18 @@ public class SinkEventAttributeSet
/**
* An unmodifiable attribute set containing only a boxed attribute.
+ *
+ * @deprecated use {@link source} for source code
*/
+ @Deprecated
public static final SinkEventAttributes BOXED;
+ /**
+ * An unmodifiable attribute set containing only a source attribute.
+ */
+ public static final SinkEventAttributes SOURCE;
+
+
/**
* An unmodifiable attribute set containing only a bold attribute.
*/
@@ -92,13 +101,13 @@ public class SinkEventAttributeSet
*/
public static final SinkEventAttributes JUSTIFY;
-
static
{
UNDERLINE = new SinkEventAttributeSet( DECORATION, "underline" ).unmodifiable();
OVERLINE = new SinkEventAttributeSet( DECORATION, "overline" ).unmodifiable();
LINETHROUGH = new SinkEventAttributeSet( DECORATION, "line-through" ).unmodifiable();
BOXED = new SinkEventAttributeSet( DECORATION, "boxed" ).unmodifiable();
+ SOURCE = new SinkEventAttributeSet( DECORATION, "source" ).unmodifiable();
BOLD = new SinkEventAttributeSet( STYLE, "bold" ).unmodifiable();
ITALIC = new SinkEventAttributeSet( STYLE, "italic" ).unmodifiable();
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/Xhtml5BaseSink.java b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/Xhtml5BaseSink.java
index e35cd901..c471c080 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/Xhtml5BaseSink.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/Xhtml5BaseSink.java
@@ -1272,7 +1272,7 @@ public class Xhtml5BaseSink
}
/**
- * The default class style for boxed is <code>source</code>.
+ * The default class style is <code>verbatim</code>, for source is {@code verbatim source}.
*
* {@inheritDoc}
* @see javax.swing.text.html.HTML.Tag#DIV
@@ -1292,28 +1292,31 @@ public class Xhtml5BaseSink
verbatimFlag = true;
MutableAttributeSet atts = SinkUtils.filterAttributes(
- attributes, SinkUtils.SINK_VERBATIM_ATTRIBUTES );
+ attributes, SinkUtils.SINK_VERBATIM_ATTRIBUTES );
if ( atts == null )
{
atts = new SinkEventAttributeSet();
}
- boolean boxed = false;
+ boolean source = false;
if ( atts.isDefined( SinkEventAttributes.DECORATION ) )
{
- boxed =
- "boxed".equals( atts.getAttribute( SinkEventAttributes.DECORATION ).toString() );
+ source =
+ "source".equals( atts.getAttribute( SinkEventAttributes.DECORATION ).toString() );
}
SinkEventAttributes divAtts = null;
+ String divClass = "verbatim";
- if ( boxed )
+ if ( source )
{
- divAtts = new SinkEventAttributeSet( Attribute.CLASS.toString(), "source" );
+ divClass += " source";
}
+ divAtts = new SinkEventAttributeSet( Attribute.CLASS.toString(), divClass );
+
atts.removeAttribute( SinkEventAttributes.DECORATION );
writeStartTag( HtmlMarkup.DIV, divAtts );
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/AbstractSinkTest.java b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/AbstractSinkTest.java
index e642459a..ba2cf54e 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/AbstractSinkTest.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/AbstractSinkTest.java
@@ -828,7 +828,7 @@ public abstract class AbstractSinkTest
}
/**
- * Checks that the sequence <code>[verbatim( SinkEventAttributeSet.BOXED ), text( text ),
+ * Checks that the sequence <code>[verbatim( SinkEventAttributeSet.SOURCE ), text( text ),
* verbatim_()]</code>, invoked on the current sink, produces the
* same result as {@link #getVerbatimBlock getVerbatimBlock}( text ).
*/
@@ -836,14 +836,14 @@ public abstract class AbstractSinkTest
public void testVerbatim()
{
String text = "Text";
- sink.verbatim( SinkEventAttributeSet.BOXED );
+ sink.verbatim( SinkEventAttributeSet.SOURCE );
sink.text( text );
sink.verbatim_();
sink.flush();
sink.close();
String actual = testWriter.toString();
- String expected = getVerbatimBlock( text );
+ String expected = getVerbatimSourceBlock( text );
assertEquals( expected, actual, "Wrong verbatim!" );
}
@@ -1414,7 +1414,7 @@ public abstract class AbstractSinkTest
* @return The result of invoking a Verbatim block on the current sink.
* @see #testVerbatim()
*/
- protected abstract String getVerbatimBlock( String text );
+ protected abstract String getVerbatimSourceBlock( String text );
/**
* Returns a HorizontalRule block generated by this sink.
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/SinkEventAttributeSetTest.java b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/SinkEventAttributeSetTest.java
index 99cedd74..ba8739fa 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/SinkEventAttributeSetTest.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/SinkEventAttributeSetTest.java
@@ -89,7 +89,7 @@ public class SinkEventAttributeSetTest
sinkEventAttributeSet.addAttributes( SinkEventAttributeSet.BOLD );
assertEquals( 1, sinkEventAttributeSet.getAttributeCount() );
- sinkEventAttributeSet.removeAttributes( SinkEventAttributeSet.BOXED );
+ sinkEventAttributeSet.removeAttributes( SinkEventAttributeSet.SOURCE );
assertEquals( 1, sinkEventAttributeSet.getAttributeCount() );
sinkEventAttributeSet.removeAttributes( SinkEventAttributeSet.BOLD );
assertEquals( 0, sinkEventAttributeSet.getAttributeCount() );
@@ -102,7 +102,7 @@ public class SinkEventAttributeSetTest
public void testIsDefined()
{
assertFalse( sinkEventAttributeSet.isDefined( SinkEventAttributes.DECORATION ) );
- sinkEventAttributeSet.addAttributes( SinkEventAttributeSet.BOXED );
+ sinkEventAttributeSet.addAttributes( SinkEventAttributeSet.SOURCE );
assertTrue( sinkEventAttributeSet.isDefined( SinkEventAttributes.DECORATION ) );
}
@@ -115,7 +115,7 @@ public class SinkEventAttributeSetTest
SinkEventAttributes instance = new SinkEventAttributeSet( SinkEventAttributeSet.BOLD );
sinkEventAttributeSet.addAttributes( SinkEventAttributeSet.BOLD );
assertTrue( instance.isEqual( sinkEventAttributeSet ) );
- instance.addAttributes( SinkEventAttributeSet.BOXED );
+ instance.addAttributes( SinkEventAttributeSet.SOURCE );
assertFalse( instance.isEqual( sinkEventAttributeSet ) );
}
@@ -133,7 +133,7 @@ public class SinkEventAttributeSetTest
SinkEventAttributes instance = new SinkEventAttributeSet( SinkEventAttributeSet.BOLD );
sinkEventAttributeSet.addAttributes( SinkEventAttributeSet.BOLD );
assertTrue( instance.equals( sinkEventAttributeSet ) );
- instance.addAttributes( SinkEventAttributeSet.BOXED );
+ instance.addAttributes( SinkEventAttributeSet.SOURCE );
assertFalse( instance.equals( sinkEventAttributeSet ) );
}
@@ -190,7 +190,7 @@ public class SinkEventAttributeSetTest
{
sinkEventAttributeSet.addAttributes( SinkEventAttributeSet.JUSTIFY );
assertTrue( sinkEventAttributeSet.containsAttributes( SinkEventAttributeSet.JUSTIFY ) );
- assertFalse( sinkEventAttributeSet.containsAttributes( SinkEventAttributeSet.BOXED ) );
+ assertFalse( sinkEventAttributeSet.containsAttributes( SinkEventAttributeSet.SOURCE ) );
}
/**
@@ -259,7 +259,7 @@ public class SinkEventAttributeSetTest
result = sinkEventAttributeSet.clone();
assertEquals( sinkEventAttributeSet, result );
- sinkEventAttributeSet.setResolveParent( SinkEventAttributeSet.BOXED );
+ sinkEventAttributeSet.setResolveParent( SinkEventAttributeSet.SOURCE );
//assertFalse( sinkEventAttributeSet.equals( result ) );
}
@@ -289,12 +289,12 @@ public class SinkEventAttributeSetTest
String expected = "";
assertEquals( expected, sinkEventAttributeSet.toString() );
- sinkEventAttributeSet.addAttributes( SinkEventAttributeSet.BOXED );
- expected = " decoration=boxed";
+ sinkEventAttributeSet.addAttributes( SinkEventAttributeSet.SOURCE );
+ expected = " decoration=source";
assertEquals( expected, sinkEventAttributeSet.toString() );
sinkEventAttributeSet.addAttributes( SinkEventAttributeSet.CENTER );
- expected = " decoration=boxed align=center";
+ expected = " decoration=source align=center";
assertEquals( expected, sinkEventAttributeSet.toString() );
}
}
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/SinkEventTestingSink.java b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/SinkEventTestingSink.java
index a4a4e5c8..03b626a3 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/SinkEventTestingSink.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/SinkEventTestingSink.java
@@ -959,6 +959,12 @@ public class SinkEventTestingSink
addEvent( "division", new Object[] {attributes} );
}
+ @Override
+ public void verbatim()
+ {
+ addEvent( "verbatim" );
+ }
+
@Override
public void verbatim( SinkEventAttributes attributes )
{
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/SinkTestDocument.java b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/SinkTestDocument.java
index f11d9172..87cdf221 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/SinkTestDocument.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/SinkTestDocument.java
@@ -86,8 +86,8 @@ public class SinkTestDocument
generateList( sink );
- sink.verbatim( SinkEventAttributeSet.BOXED );
- sink.text( "Verbatim text not contained in list item 3" );
+ sink.verbatim( SinkEventAttributeSet.SOURCE );
+ sink.text( "Verbatim source text not contained in list item 3" );
sink.verbatim_();
generateNumberedList( sink );
@@ -267,8 +267,8 @@ public class SinkTestDocument
sink.definedTerm_();
sink.definition();
sink.text( "of definition list." );
- sink.verbatim( SinkEventAttributeSet.BOXED );
- sink.text( "Verbatim text" + eol + " in a box " );
+ sink.verbatim( SinkEventAttributeSet.SOURCE );
+ sink.text( "Verbatim source text" + eol + " in a box " );
sink.verbatim_();
sink.definition_();
sink.definitionListItem_();
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/SinkUtilsTest.java b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/SinkUtilsTest.java
index 3eb8a7c5..9853e6f1 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/SinkUtilsTest.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/SinkUtilsTest.java
@@ -43,14 +43,14 @@ public class SinkUtilsTest
{
assertEquals( "", SinkUtils.getAttributeString( null ) );
- AttributeSet att = new SinkEventAttributeSet( SinkEventAttributeSet.BOXED );
- String expResult = " decoration=\"boxed\"";
+ AttributeSet att = new SinkEventAttributeSet( SinkEventAttributeSet.SOURCE );
+ String expResult = " decoration=\"source\"";
String result = SinkUtils.getAttributeString( att );
assertEquals( expResult, result );
SinkEventAttributes at = new SinkEventAttributeSet( SinkEventAttributeSet.BOLD );
at.addAttributes( att );
- expResult = " style=\"bold\" decoration=\"boxed\"";
+ expResult = " style=\"bold\" decoration=\"source\"";
result = SinkUtils.getAttributeString( at );
assertEquals( expResult, result );
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/TextSink.java b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/TextSink.java
index d00b7b46..3741ee1c 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/TextSink.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/TextSink.java
@@ -963,18 +963,24 @@ public class TextSink
division();
}
+ @Override
+ public void verbatim()
+ {
+ verbatim( null );
+ }
+
@Override
public void verbatim( SinkEventAttributes attributes )
{
- boolean boxed = false;
+ boolean source = false;
if ( attributes != null && attributes.isDefined( SinkEventAttributes.DECORATION ) )
{
- boxed = "boxed".equals(
+ source = "source".equals(
attributes.getAttribute( SinkEventAttributes.DECORATION ).toString() );
}
- write( "begin:verbatim, boxed: " + boxed );
+ write( "begin:verbatim, source: " + source );
}
@Override
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/WellformednessCheckingSink.java b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/WellformednessCheckingSink.java
index ebd864a9..60feb87d 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/WellformednessCheckingSink.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/WellformednessCheckingSink.java
@@ -1006,6 +1006,12 @@ public class WellformednessCheckingSink
division();
}
+ @Override
+ public void verbatim()
+ {
+ startElement( "verbatim" );
+ }
+
@Override
public void verbatim( SinkEventAttributes attributes )
{
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/Xhtml5BaseSinkTest.java b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/Xhtml5BaseSinkTest.java
index 79bf6fe9..3e533815 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/Xhtml5BaseSinkTest.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/Xhtml5BaseSinkTest.java
@@ -963,7 +963,7 @@ public class Xhtml5BaseSinkTest
{
sink = new Xhtml5BaseSink( writer );
- sink.verbatim( SinkEventAttributeSet.BOXED );
+ sink.verbatim( SinkEventAttributeSet.SOURCE );
sink.verbatim_();
}
finally
@@ -971,22 +971,22 @@ public class Xhtml5BaseSinkTest
sink.close();
}
- assertEquals( "<div class=\"source\">" + LS + "<pre></pre></div>", writer.toString() );
+ assertEquals( "<div class=\"verbatim source\">" + LS + "<pre></pre></div>", writer.toString() );
- checkVerbatimAttributes( attributes, "<div>" + LS + "<pre style=\"bold\"></pre></div>" );
+ checkVerbatimAttributes( attributes, "<div class=\"verbatim\">" + LS + "<pre style=\"bold\"></pre></div>" );
final SinkEventAttributes att =
new SinkEventAttributeSet( SinkEventAttributes.ID, "id" );
- checkVerbatimAttributes( att, "<div>" + LS + "<pre id=\"id\"></pre></div>" );
+ checkVerbatimAttributes( att, "<div class=\"verbatim\">" + LS + "<pre id=\"id\"></pre></div>" );
att.addAttribute( Attribute.CLASS, "class" );
- checkVerbatimAttributes( att, "<div>" + LS + "<pre id=\"id\" class=\"class\"></pre></div>" );
+ checkVerbatimAttributes( att, "<div class=\"verbatim\">" + LS + "<pre id=\"id\" class=\"class\"></pre></div>" );
- att.addAttribute( SinkEventAttributes.DECORATION, "boxed" );
- checkVerbatimAttributes( att, "<div class=\"source\">" + LS + "<pre id=\"id\" class=\"class\"></pre></div>" );
+ att.addAttribute( SinkEventAttributes.DECORATION, "source" );
+ checkVerbatimAttributes( att, "<div class=\"verbatim source\">" + LS + "<pre id=\"id\" class=\"class\"></pre></div>" );
att.removeAttribute( Attribute.CLASS.toString() );
- checkVerbatimAttributes( att, "<div class=\"source\">" + LS + "<pre id=\"id\"></pre></div>" );
+ checkVerbatimAttributes( att, "<div class=\"verbatim source\">" + LS + "<pre id=\"id\"></pre></div>" );
}
private void checkVerbatimAttributes( final SinkEventAttributes att, final String expected )
diff --git a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptMarkup.java b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptMarkup.java
index b8b8182a..ff636103 100644
--- a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptMarkup.java
+++ b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptMarkup.java
@@ -83,8 +83,8 @@ public interface AptMarkup
/** Syntax for the bold style start: "<<" */
String BOLD_START_MARKUP = StringUtils.repeat( String.valueOf( LESS_THAN ), 2 );
- /** Syntax for the boxed verbatim start: "+------+" */
- String BOXED_VERBATIM_START_MARKUP = PLUS + StringUtils.repeat( String.valueOf( MINUS ), 6 ) + PLUS;
+ /** Syntax for the verbatim source start: "+------+" */
+ String VERBATIM_SOURCE_START_MARKUP = PLUS + StringUtils.repeat( String.valueOf( MINUS ), 6 ) + PLUS;
/** Syntax for the header start: " -----" */
String HEADER_START_MARKUP = SPACE + StringUtils.repeat( String.valueOf( MINUS ), 5 );
@@ -119,8 +119,8 @@ public interface AptMarkup
/** Syntax for the mono-spaced style start: "<<<" */
String MONOSPACED_START_MARKUP = StringUtils.repeat( String.valueOf( LESS_THAN ), 3 );
- /** Syntax for the non boxed verbatim start: "------" */
- String NON_BOXED_VERBATIM_START_MARKUP = StringUtils.repeat( String.valueOf( MINUS ), 6 );
+ /** Syntax for the verbatim start: "------" */
+ String VERBATIM_START_MARKUP = StringUtils.repeat( String.valueOf( MINUS ), 6 );
/** Syntax for the non breaking space: "\ " */
String NON_BREAKING_SPACE_MARKUP = String.valueOf( BACKSLASH ) + SPACE;
@@ -149,9 +149,9 @@ public interface AptMarkup
/** Syntax for the table row start: "*--" */
String TABLE_ROW_START_MARKUP = STAR + StringUtils.repeat( String.valueOf( MINUS ), 2 );
- /** Syntax for the boxed verbatim end: "+------+" */
- String BOXED_VERBATIM_END_MARKUP = BOXED_VERBATIM_START_MARKUP;
+ /** Syntax for the verbatim source end: "+------+" */
+ String VERBATIM_SOURCE_END_MARKUP = VERBATIM_SOURCE_START_MARKUP;
- /** Syntax for the non boxed verbatim end: "------" */
- String NON_BOXED_VERBATIM_END_MARKUP = NON_BOXED_VERBATIM_START_MARKUP;
+ /** Syntax for the verbatim end: "------" */
+ String VERBATIM_END_MARKUP = VERBATIM_START_MARKUP;
}
diff --git a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParser.java b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParser.java
index 81dae4f1..8359cf2f 100644
--- a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParser.java
+++ b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParser.java
@@ -2176,8 +2176,8 @@ public class AptParser
private class Verbatim
extends Block
{
- /** boxed. */
- private boolean boxed;
+ /** source. */
+ private boolean source;
/**
* Constructor.
@@ -2195,7 +2195,7 @@ public class AptParser
StringBuilder buffer = new StringBuilder();
char firstChar = firstLine.charAt( 0 );
- boxed = ( firstChar == PLUS );
+ source = ( firstChar == PLUS );
while ( AptParser.this.line != null )
{
@@ -2257,7 +2257,7 @@ public class AptParser
public void traverse()
throws AptParseException
{
- AptParser.this.sink.verbatim( boxed ? SinkEventAttributeSet.BOXED : null );
+ AptParser.this.sink.verbatim( source ? SinkEventAttributeSet.SOURCE : null );
AptParser.this.sink.text( text );
AptParser.this.sink.verbatim_();
}
diff --git a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSink.java b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSink.java
index 6273e16b..e02d17de 100644
--- a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSink.java
+++ b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSink.java
@@ -89,8 +89,8 @@ public class AptSink
/** verbatimFlag. */
private boolean verbatimFlag;
- /** boxed verbatim. */
- private boolean isBoxed;
+ /** verbatim source. */
+ private boolean isSource;
/** gridFlag for tables. */
private boolean gridFlag;
@@ -176,7 +176,7 @@ public class AptSink
this.bufferFlag = false;
this.itemFlag = false;
this.verbatimFlag = false;
- this.isBoxed = false;
+ this.isSource = false;
this.gridFlag = false;
this.cellCount = 0;
this.cellJustif = null;
@@ -631,23 +631,23 @@ public class AptSink
{
MutableAttributeSet atts = SinkUtils.filterAttributes( attributes, SinkUtils.SINK_VERBATIM_ATTRIBUTES );
- boolean boxed = false;
+ boolean source = false;
if ( atts != null && atts.isDefined( SinkEventAttributes.DECORATION ) )
{
- boxed = "boxed".equals( atts.getAttribute( SinkEventAttributes.DECORATION ).toString() );
+ source = "source".equals( atts.getAttribute( SinkEventAttributes.DECORATION ).toString() );
}
verbatimFlag = true;
- this.isBoxed = boxed;
+ this.isSource = source;
write( EOL );
- if ( boxed )
+ if ( source )
{
- write( EOL + BOXED_VERBATIM_START_MARKUP + EOL );
+ write( EOL + VERBATIM_SOURCE_START_MARKUP + EOL );
}
else
{
- write( EOL + NON_BOXED_VERBATIM_START_MARKUP + EOL );
+ write( EOL + VERBATIM_START_MARKUP + EOL );
}
}
@@ -656,15 +656,15 @@ public class AptSink
*/
public void verbatim_()
{
- if ( isBoxed )
+ if ( isSource )
{
- write( EOL + BOXED_VERBATIM_END_MARKUP + EOL );
+ write( EOL + VERBATIM_SOURCE_END_MARKUP + EOL );
}
else
{
- write( EOL + NON_BOXED_VERBATIM_END_MARKUP + EOL );
+ write( EOL + VERBATIM_END_MARKUP + EOL );
}
- isBoxed = false;
+ isSource = false;
verbatimFlag = false;
}
diff --git a/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptParserTest.java b/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptParserTest.java
index 00f1f99a..2185002b 100644
--- a/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptParserTest.java
+++ b/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptParserTest.java
@@ -164,11 +164,11 @@ public class AptParserTest
}
@Test
- public void testBoxedVerbatim()
+ public void testVerbatimSource()
throws Exception
{
- String text = "+--" + EOL + "boxed verbatim" + EOL + "+--" + EOL
- + "---" + EOL + "un-boxed verbatim" + EOL + "---" + EOL;
+ String text = "+--" + EOL + "verbatim source" + EOL + "+--" + EOL
+ + "---" + EOL + "verbatim" + EOL + "---" + EOL;
SinkEventTestingSink sink = new SinkEventTestingSink();
@@ -177,7 +177,7 @@ public class AptParserTest
Iterator<SinkEventElement> it = sink.getEventList().iterator();
assertSinkStartsWith( it, "head", "head_", "body" );
- assertSinkEquals( it.next(), "verbatim", SinkEventAttributeSet.BOXED );
+ assertSinkEquals( it.next(), "verbatim", SinkEventAttributeSet.SOURCE );
assertSinkStartsWith( it, "text", "verbatim_" );
assertSinkEquals( it.next(), "verbatim", new Object[] { null } );
@@ -222,7 +222,7 @@ public class AptParserTest
assertSinkStartsWith( it, "tableCell_", "tableCell" );
assertSinkEquals( it.next(), "text", "cell 2,3" );
-
+
assertSinkStartsWith( it, "tableCell_", "tableRow_", "tableRow", "tableCell" );
assertSinkEquals( it.next(), "text", "cell 3,1" );
@@ -316,23 +316,23 @@ public class AptParserTest
assertSinkAttributeEquals( it.next(), "tableCell", SinkEventAttributeSet.ALIGN, "center" );
assertSinkEquals( it.next(),"text", "Centered" );
assertEquals( it.next().getName(), "tableCell_" );
-
+
assertSinkAttributeEquals( it.next(), "tableCell", SinkEventAttributeSet.ALIGN, "center" );
assertSinkEquals( it.next(),"text", "Centered" );
assertEquals( it.next().getName(), "tableCell_" );
-
+
assertSinkAttributeEquals( it.next(), "tableCell", SinkEventAttributeSet.ALIGN, "center" );
assertSinkEquals( it.next(),"text", "Centered" );
assertSinkStartsWith( it, "tableCell_", "tableRow_", "tableRow" );
-
+
assertSinkAttributeEquals( it.next(), "tableCell", SinkEventAttributeSet.ALIGN, "center" );
assertSinkEquals( it.next(),"text", "Centered" );
assertEquals( it.next().getName(), "tableCell_" );
-
+
assertSinkAttributeEquals( it.next(), "tableCell", SinkEventAttributeSet.ALIGN, "left" );
assertSinkEquals( it.next(),"text", "Left-aligned" );
assertEquals( it.next().getName(), "tableCell_" );
-
+
assertSinkAttributeEquals( it.next(), "tableCell", SinkEventAttributeSet.ALIGN, "right" );
assertSinkEquals( it.next(),"text", "Right-aligned" );
assertSinkEquals( it, "tableCell_", "tableRow_", "tableRows_", "table_", "body_" );
@@ -418,14 +418,14 @@ public class AptParserTest
public void testTableHeaders() throws Exception
{
// DOXIA-404
- String text = "*-----------+-----------+" + EOL +
- "|| Header 1 || Header 2 |" + EOL +
- "*-----------+-----------+" + EOL +
- " Cell 1 | Cell 2 |" + EOL +
- "*-----------+-----------+" + EOL +
- " Cell 3 | Cell 4 |" + EOL +
- "*-----------+-----------+" + EOL;
-
+ String text = "*-----------+-----------+" + EOL +
+ "|| Header 1 || Header 2 |" + EOL +
+ "*-----------+-----------+" + EOL +
+ " Cell 1 | Cell 2 |" + EOL +
+ "*-----------+-----------+" + EOL +
+ " Cell 3 | Cell 4 |" + EOL +
+ "*-----------+-----------+" + EOL;
+
SinkEventTestingSink sink = new SinkEventTestingSink();
parser.parse( text, sink );
@@ -446,10 +446,10 @@ public class AptParserTest
public void testEscapedPipeInTableCell() throws Exception
{
// DOXIA-479
- String text="*---+---+" + EOL +
- "| cell \\| pipe | next cell " + EOL +
- "*---+---+" + EOL;
-
+ String text="*---+---+" + EOL +
+ "| cell \\| pipe | next cell " + EOL +
+ "*---+---+" + EOL;
+
SinkEventTestingSink sink = new SinkEventTestingSink();
parser.parse( text, sink );
diff --git a/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptSinkTest.java b/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptSinkTest.java
index 108d369d..740275be 100644
--- a/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptSinkTest.java
+++ b/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptSinkTest.java
@@ -237,10 +237,10 @@ public class AptSinkTest extends AbstractSinkTest
}
/** {@inheritDoc} */
- protected String getVerbatimBlock( String text )
+ protected String getVerbatimSourceBlock( String text )
{
- return EOL + EOL + AptMarkup.BOXED_VERBATIM_START_MARKUP + EOL + text + EOL
- + AptMarkup.BOXED_VERBATIM_START_MARKUP + EOL;
+ return EOL + EOL + AptMarkup.VERBATIM_SOURCE_START_MARKUP + EOL + text + EOL
+ + AptMarkup.VERBATIM_SOURCE_START_MARKUP + EOL;
}
/** {@inheritDoc} */
diff --git a/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlContentParser.java b/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlContentParser.java
index 2912298c..32246a44 100644
--- a/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlContentParser.java
+++ b/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlContentParser.java
@@ -60,7 +60,7 @@ public class FmlContentParser
{
verbatim();
- sink.verbatim( SinkEventAttributeSet.BOXED );
+ sink.verbatim( SinkEventAttributeSet.SOURCE );
}
else if ( !baseStartTag( parser, sink ) )
{
diff --git a/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownMarkup.java b/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownMarkup.java
index 13142d20..74474261 100644
--- a/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownMarkup.java
+++ b/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownMarkup.java
@@ -103,8 +103,8 @@ public interface MarkdownMarkup
/** Syntax for the mono-spaced style start: "`" */
String MONOSPACED_START_MARKUP = "`";
- /** Syntax for the non boxed verbatim start: "```" */
- String NON_BOXED_VERBATIM_START_MARKUP = "```";
+ /** Syntax for the verbatim start: "```" */
+ String VERBATIM_START_MARKUP = "```";
/** Syntax for the non breaking space: "\ " */
String NON_BREAKING_SPACE_MARKUP = String.valueOf( BACKSLASH ) + SPACE;
@@ -130,6 +130,6 @@ public interface MarkdownMarkup
/** Syntax for the table row end: "|" */
String TABLE_ROW_SEPARATOR_MARKUP = String.valueOf( PIPE );
- /** Syntax for the non boxed verbatim end: "```" */
- String NON_BOXED_VERBATIM_END_MARKUP = "```";
+ /** Syntax for the verbatim end: "```" */
+ String VERBATIM_END_MARKUP = "```";
}
diff --git a/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownParser.java b/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownParser.java
index 5f161165..7c4c3f76 100644
--- a/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownParser.java
+++ b/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownParser.java
@@ -267,9 +267,8 @@ public class MarkdownParser
* 2 special things:
* <ul>
* <li> DIV elements are translated as Unknown Sink events
- * <li> PRE elements are all considered as boxed
* </ul>
- * PRE elements need to be "boxed" because the Xhtml5Sink will surround the
+ * PRE elements need to be "source" because the Xhtml5Sink will surround the
* corresponding verbatim() Sink event with a DIV element with class="source",
* which is how most Maven Skin (incl. Fluido) recognize a block of code, which
* needs to be highlighted accordingly.
@@ -287,7 +286,6 @@ public class MarkdownParser
protected void init()
{
super.init();
- super.boxed = true;
}
@Override
@@ -314,7 +312,6 @@ public class MarkdownParser
if ( parser.getName().equals( HtmlMarkup.DIV.toString() ) )
{
handleUnknown( parser, sink, TAG_TYPE_START );
- super.boxed = true;
visited = true;
}
}
diff --git a/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownSink.java b/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownSink.java
index 97200029..67ccd07d 100644
--- a/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownSink.java
+++ b/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownSink.java
@@ -601,7 +601,7 @@ public class MarkdownSink
{
write( EOL );
verbatimFlag = true;
- write( EOL + NON_BOXED_VERBATIM_START_MARKUP + EOL );
+ write( EOL + VERBATIM_START_MARKUP + EOL );
}
/**
@@ -609,7 +609,7 @@ public class MarkdownSink
*/
public void verbatim_()
{
- write( EOL + NON_BOXED_VERBATIM_END_MARKUP + EOL );
+ write( EOL + VERBATIM_END_MARKUP + EOL );
verbatimFlag = false;
}
diff --git a/doxia-modules/doxia-module-markdown/src/test/java/org/apache/maven/doxia/module/markdown/MarkdownParserTest.java b/doxia-modules/doxia-module-markdown/src/test/java/org/apache/maven/doxia/module/markdown/MarkdownParserTest.java
index efcab9a0..9674aeeb 100644
--- a/doxia-modules/doxia-module-markdown/src/test/java/org/apache/maven/doxia/module/markdown/MarkdownParserTest.java
+++ b/doxia-modules/doxia-module-markdown/src/test/java/org/apache/maven/doxia/module/markdown/MarkdownParserTest.java
@@ -190,11 +190,11 @@ public class MarkdownParserTest
assertFalse( it.hasNext() );
// PRE element must be a "verbatim" Sink event that specifies
- // BOXED = true
+ // SOURCE = false
SinkEventElement pre = eventList.get( 7 );
assertEquals( "verbatim", pre.getName() );
SinkEventAttributeSet preAtts = (SinkEventAttributeSet) pre.getArgs()[0];
- assertTrue( preAtts.containsAttribute( SinkEventAttributes.DECORATION, "boxed" ) );
+ assertFalse( preAtts.containsAttribute( SinkEventAttributes.DECORATION, "source" ) );
// * CODE element must be an "inline" Sink event that specifies:
// * SEMANTICS = "code" and CLASS = "language-java"
diff --git a/doxia-modules/doxia-module-markdown/src/test/java/org/apache/maven/doxia/module/markdown/MarkdownSinkTest.java b/doxia-modules/doxia-module-markdown/src/test/java/org/apache/maven/doxia/module/markdown/MarkdownSinkTest.java
index cdd3b488..99bbd9a3 100644
--- a/doxia-modules/doxia-module-markdown/src/test/java/org/apache/maven/doxia/module/markdown/MarkdownSinkTest.java
+++ b/doxia-modules/doxia-module-markdown/src/test/java/org/apache/maven/doxia/module/markdown/MarkdownSinkTest.java
@@ -242,10 +242,10 @@ public class MarkdownSinkTest extends AbstractSinkTest
}
/** {@inheritDoc} */
- protected String getVerbatimBlock( String text )
+ protected String getVerbatimSourceBlock( String text )
{
- return EOL + EOL + MarkdownMarkup.NON_BOXED_VERBATIM_START_MARKUP + EOL + text + EOL
- + MarkdownMarkup.NON_BOXED_VERBATIM_START_MARKUP + EOL;
+ return EOL + EOL + MarkdownMarkup.VERBATIM_START_MARKUP + EOL + text + EOL
+ + MarkdownMarkup.VERBATIM_START_MARKUP + EOL;
}
/** {@inheritDoc} */
diff --git a/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocParser.java b/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocParser.java
index e7f84a51..7b04acd9 100644
--- a/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocParser.java
+++ b/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocParser.java
@@ -199,7 +199,7 @@ public class XdocParser
{
verbatim();
- attribs.addAttributes( SinkEventAttributeSet.BOXED );
+ attribs.addAttributes( SinkEventAttributeSet.SOURCE );
sink.verbatim( attribs );
}
diff --git a/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocSink.java b/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocSink.java
index 47f6cad8..0d1b5727 100644
--- a/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocSink.java
+++ b/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocSink.java
@@ -49,8 +49,8 @@ public class XdocSink
// Instance fields
// ----------------------------------------------------------------------
- /** An indication on if we're inside a box (verbatim). */
- private boolean boxedFlag;
+ /** An indication on if we're inside verbatim source. */
+ private boolean sourceFlag;
private String encoding;
@@ -114,7 +114,7 @@ public class XdocSink
{
super.init();
- boxedFlag = false;
+ sourceFlag = false;
}
/**
@@ -394,24 +394,24 @@ public class XdocSink
setVerbatimFlag( true );
MutableAttributeSet atts = SinkUtils.filterAttributes(
- attributes, SinkUtils.SINK_VERBATIM_ATTRIBUTES );
+ attributes, SinkUtils.SINK_VERBATIM_ATTRIBUTES );
if ( atts == null )
{
atts = new SinkEventAttributeSet();
}
- boolean boxed = false;
+ boolean source = false;
if ( atts.isDefined( SinkEventAttributes.DECORATION ) )
{
- boxedFlag = boxed =
- "boxed".equals( atts.getAttribute( SinkEventAttributes.DECORATION ) );
+ sourceFlag = source =
+ "source".equals( atts.getAttribute( SinkEventAttributes.DECORATION ) );
}
atts.removeAttribute( SinkEventAttributes.DECORATION );
- if ( boxed )
+ if ( source )
{
writeStartTag( SOURCE_TAG, atts );
}
@@ -429,7 +429,7 @@ public class XdocSink
*/
public void verbatim_()
{
- if ( boxedFlag )
+ if ( sourceFlag )
{
writeEndTag( SOURCE_TAG );
}
@@ -440,7 +440,7 @@ public class XdocSink
setVerbatimFlag( false );
- boxedFlag = false;
+ sourceFlag = false;
}
/**
diff --git a/doxia-modules/doxia-module-xdoc/src/test/java/org/apache/maven/doxia/module/xdoc/XdocSinkTest.java b/doxia-modules/doxia-module-xdoc/src/test/java/org/apache/maven/doxia/module/xdoc/XdocSinkTest.java
index 9c950bf2..7a7501d9 100644
--- a/doxia-modules/doxia-module-xdoc/src/test/java/org/apache/maven/doxia/module/xdoc/XdocSinkTest.java
+++ b/doxia-modules/doxia-module-xdoc/src/test/java/org/apache/maven/doxia/module/xdoc/XdocSinkTest.java
@@ -276,7 +276,7 @@ public class XdocSinkTest
}
/** {@inheritDoc} */
- protected String getVerbatimBlock( String text )
+ protected String getVerbatimSourceBlock( String text )
{
return "<source>" + text + "</source>";
}
@@ -382,7 +382,7 @@ public class XdocSinkTest
* Test verbatim.
*/
@Test
- public void testBoxedVerbatim()
+ public void testVerbatimSource()
{
Writer writer = new StringWriter();
XdocSink sink = null;
@@ -393,7 +393,7 @@ public class XdocSinkTest
sink.verbatim( null );
sink.verbatim_();
- sink.verbatim( SinkEventAttributeSet.BOXED );
+ sink.verbatim( SinkEventAttributeSet.SOURCE );
sink.verbatim_();
}
finally
diff --git a/doxia-modules/doxia-module-xhtml5/src/main/java/org/apache/maven/doxia/module/xhtml5/Xhtml5Parser.java b/doxia-modules/doxia-module-xhtml5/src/main/java/org/apache/maven/doxia/module/xhtml5/Xhtml5Parser.java
index 2db0db14..8fa99612 100644
--- a/doxia-modules/doxia-module-xhtml5/src/main/java/org/apache/maven/doxia/module/xhtml5/Xhtml5Parser.java
+++ b/doxia-modules/doxia-module-xhtml5/src/main/java/org/apache/maven/doxia/module/xhtml5/Xhtml5Parser.java
@@ -55,8 +55,8 @@ public class Xhtml5Parser
{
private static final Logger LOGGER = LoggerFactory.getLogger( Xhtml5Parser.class );
- /** For boxed verbatim. */
- protected boolean boxed;
+ /** For verbatim source . */
+ protected boolean source;
/** Empty elements don't write a closing tag. */
private boolean isEmptyElement;
@@ -128,11 +128,11 @@ public class Xhtml5Parser
}
else if ( parser.getName().equals( DIV.toString() ) )
{
- String divclass = parser.getAttributeValue( null, Attribute.CLASS.toString() );
+ String divClass = parser.getAttributeValue( null, Attribute.CLASS.toString() );
- if ( "source".equals( divclass ) )
+ if ( "verbatim source".equals( divClass ) )
{
- this.boxed = true;
+ this.source = true;
}
baseStartTag( parser, sink ); // pick up other divs
@@ -149,9 +149,9 @@ public class Xhtml5Parser
*/
else if ( parser.getName().equals( PRE.toString() ) )
{
- if ( boxed )
+ if ( source )
{
- attribs.addAttributes( SinkEventAttributeSet.BOXED );
+ attribs.addAttributes( SinkEventAttributeSet.SOURCE );
}
verbatim();
@@ -203,7 +203,7 @@ public class Xhtml5Parser
}
else if ( parser.getName().equals( DIV.toString() ) )
{
- this.boxed = false;
+ this.source = false;
baseEndTag( parser, sink );
}
else if ( !baseEndTag( parser, sink ) )
@@ -324,7 +324,7 @@ public class Xhtml5Parser
{
super.init();
- this.boxed = false;
+ this.source = false;
this.isEmptyElement = false;
}
diff --git a/doxia-modules/doxia-module-xhtml5/src/test/java/org/apache/maven/doxia/module/xhtml5/Xhtml5SinkTest.java b/doxia-modules/doxia-module-xhtml5/src/test/java/org/apache/maven/doxia/module/xhtml5/Xhtml5SinkTest.java
index a6e4dfdf..3499be62 100644
--- a/doxia-modules/doxia-module-xhtml5/src/test/java/org/apache/maven/doxia/module/xhtml5/Xhtml5SinkTest.java
+++ b/doxia-modules/doxia-module-xhtml5/src/test/java/org/apache/maven/doxia/module/xhtml5/Xhtml5SinkTest.java
@@ -277,9 +277,9 @@ public class Xhtml5SinkTest
}
/** {@inheritDoc} */
- protected String getVerbatimBlock( String text )
+ protected String getVerbatimSourceBlock( String text )
{
- return "<div class=\"source\">\n<pre>" + text + "</pre></div>";
+ return "<div class=\"verbatim source\">\n<pre>" + text + "</pre></div>";
}
/** {@inheritDoc} */
diff --git a/doxia-sink-api/src/main/java/org/apache/maven/doxia/sink/Sink.java b/doxia-sink-api/src/main/java/org/apache/maven/doxia/sink/Sink.java
index 6eb57d50..7322adaf 100644
--- a/doxia-sink-api/src/main/java/org/apache/maven/doxia/sink/Sink.java
+++ b/doxia-sink-api/src/main/java/org/apache/maven/doxia/sink/Sink.java
@@ -1318,6 +1318,13 @@ public interface Sink
*/
void division_();
+ /**
+ * Starts a verbatim block, ie a block where whitespace has semantic relevance.
+ *
+ * @see #verbatim(SinkEventAttributes)
+ */
+ void verbatim();
+
/**
* Starts a verbatim block, ie a block where whitespace has semantic relevance.
*
@@ -1336,7 +1343,7 @@ public interface Sink
* Supported attributes are the {@link SinkEventAttributes base attributes} plus:
* </p>
* <blockquote>
- * {@link SinkEventAttributes#DECORATION DECORATION} (value: "boxed"),
+ * {@link SinkEventAttributes#DECORATION DECORATION} (values: "source"),
* {@link SinkEventAttributes#ALIGN ALIGN}, {@link SinkEventAttributes#WIDTH WIDTH}.
* </blockquote>
*
diff --git a/doxia-sink-api/src/main/java/org/apache/maven/doxia/sink/SinkEventAttributes.java b/doxia-sink-api/src/main/java/org/apache/maven/doxia/sink/SinkEventAttributes.java
index a3b5b8a2..9429439e 100644
--- a/doxia-sink-api/src/main/java/org/apache/maven/doxia/sink/SinkEventAttributes.java
+++ b/doxia-sink-api/src/main/java/org/apache/maven/doxia/sink/SinkEventAttributes.java
@@ -354,7 +354,7 @@ public interface SinkEventAttributes
* Specifies a decoration for an element.
*
* <p>
- * Generally accepted values are "underline", "overline", "line-through", "boxed".
+ * Generally accepted values are "underline", "overline", "line-through", "source".
* </p>
*/
String DECORATION = "decoration";