Nabble - Doxia - dev

Re: svn commit: r700094 - /maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/maven/doxia/DefaultConverter.java

2008-09-29T10:19:50Z

BTW I am not a docbook expert too :)

Vincent

2008/9/29 Vincent Siveton <vincent.siveton@...>:

> 2008/9/29 Hervé BOUTEMY <herve.boutemy@...>:
>> Hi Lukas,
>>
>> Thanks for pointing this out: I'm not a docbook expert neither, and did not
>> know this explanation of *Simple* Docbook.
>> This is not written in the docbook Doxia module code (or I didn't find it ;) )
>> neither.
>> I'll update the doc.
>
> Go 4 it :)
>
>> I got confused by 2 facts in the code:
>> - these elements are in the DocBookParser class (as HIER_ELEMENTS constant)
>> - test/resources/book.xml is a book, not an article
>> Should I remove these parts?
>> Or simply mark them as experimental since out of the strict scope of the
>> module?
>
> It is related to DOXIA-186. In fact, the DocBookSink uses wrong DTD
> Also, the DocbookParser and DocbookMarkup specifies some unused tags
> (like BOOK_TAG). It will be good to remove them to be sticked on the
> simplified docbook definition [1].
>
> Cheers,
>
> Vincent
>
>> Regards,
>>
>> Hervé
>>
>> Le lundi 29 septembre 2008, Lukas Theussl a écrit :
>>> Hi Herve,
>>>
>>> I haven't looked at the doxia modules for a while, and I am not a
>>> docbook expert but IIRC, the doxia docbook module is for Simplified
>>> Docbook only and in Simplified DocBook the root element is always
>>> <article>.
>>>
>>> Correct me if I'm wrong...
>>>
>>> Cheers,
>>> -Lukas
>>>
>>> hboutemy@... wrote:
>>> > Author: hboutemy
>>> > Date: Mon Sep 29 05:29:00 2008
>>> > New Revision: 700094
>>> >
>>> > URL: http://svn.apache.org/viewvc?rev=700094&view=rev
>>> > Log:
>>> > there are multiple root element values possible for Docbook format
>>> > (article, but also book, part, chapter, ...)
>>> >
>>> > Modified:
>>> >
>>> > maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/ma
>>> >ven/doxia/DefaultConverter.java
>>> >
>>> > Modified:
>>> > maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/ma
>>> >ven/doxia/DefaultConverter.java URL:
>>> > http://svn.apache.org/viewvc/maven/doxia/doxia-tools/trunk/doxia-converte
>>> >r/src/main/java/org/apache/maven/doxia/DefaultConverter.java?rev=700094&r1
>>> >=700093&r2=700094&view=diff
>>> > =========================================================================
>>> >===== ---
>>> > maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/ma
>>> >ven/doxia/DefaultConverter.java (original) +++
>>> > maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/ma
>>> >ven/doxia/DefaultConverter.java Mon Sep 29 05:29:00 2008 @@ -27,10 +27,12
>>> > @@
>>> > import java.io.Reader;
>>> > import java.io.Writer;
>>> > import java.util.HashMap;
>>> > +import java.util.HashSet;
>>> > import java.util.Iterator;
>>> > import java.util.List;
>>> > import java.util.Locale;
>>> > import java.util.Map;
>>> > +import java.util.Set;
>>> > import java.util.regex.Matcher;
>>> > import java.util.regex.Pattern;
>>> >
>>> > @@ -111,6 +113,37 @@
>>> > public static final String[] SUPPORTED_TO_FORMAT =
>>> > { APT_SINK, DOCBOOK_SINK, FO_SINK, ITEXT_SINK, LATEX_SINK,
>>> > RTF_SINK, XDOC_SINK, XHTML_SINK };
>>> >
>>> > + private static final Set DOCBOOK_ROOT_ELEMENT = new HashSet();
>>> > +
>>> > + static
>>> > + {
>>> > + DOCBOOK_ROOT_ELEMENT.add( "set" );
>>> > + DOCBOOK_ROOT_ELEMENT.add( "book" );
>>> > + DOCBOOK_ROOT_ELEMENT.add( "part" );
>>> > + DOCBOOK_ROOT_ELEMENT.add( "chapter" );
>>> > + DOCBOOK_ROOT_ELEMENT.add( "section" );
>>> > + DOCBOOK_ROOT_ELEMENT.add( "sect1" );
>>> > + DOCBOOK_ROOT_ELEMENT.add( "sect2" );
>>> > + DOCBOOK_ROOT_ELEMENT.add( "sect3" );
>>> > + DOCBOOK_ROOT_ELEMENT.add( "sect4" );
>>> > + DOCBOOK_ROOT_ELEMENT.add( "sect5" );
>>> > + DOCBOOK_ROOT_ELEMENT.add( "article" );
>>> > + DOCBOOK_ROOT_ELEMENT.add( "preface" );
>>> > + DOCBOOK_ROOT_ELEMENT.add( "partintro" );
>>> > + DOCBOOK_ROOT_ELEMENT.add( "appendix" );
>>> > + DOCBOOK_ROOT_ELEMENT.add( "bibliography" );
>>> > + DOCBOOK_ROOT_ELEMENT.add( "reference" );
>>> > + DOCBOOK_ROOT_ELEMENT.add( "bibliography" );
>>> > + DOCBOOK_ROOT_ELEMENT.add( "bibliodiv" );
>>> > + DOCBOOK_ROOT_ELEMENT.add( "glossary" );
>>> > + DOCBOOK_ROOT_ELEMENT.add( "refentry" );
>>> > + DOCBOOK_ROOT_ELEMENT.add( "refnamediv" );
>>> > + DOCBOOK_ROOT_ELEMENT.add( "refsection" );
>>> > + DOCBOOK_ROOT_ELEMENT.add( "refsect1" );
>>> > + DOCBOOK_ROOT_ELEMENT.add( "refsect2" );
>>> > + DOCBOOK_ROOT_ELEMENT.add( "refsect3" );
>>> > + }
>>> > +
>>> > /** Plexus container */
>>> > private PlexusContainer plexus;
>>> >
>>> > @@ -614,7 +647,7 @@
>>> > {
>>> > continue;
>>> > }
>>> > - else if ( firstTag.equals( "article" )
>>> > + else if ( DOCBOOK_ROOT_ELEMENT.contains( firstTag )
>>> > && supportedFromFormat.equalsIgnoreCase( DOCBOOK_PARSER
>>> > ) ) {
>>> > return supportedFromFormat;
>>
>>
>>
>

Re: svn commit: r700094 - /maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/maven/doxia/DefaultConverter.java

2008-09-29T10:15:13Z

2008/9/29 Hervé BOUTEMY <herve.boutemy@...>:
> Hi Lukas,
>
> Thanks for pointing this out: I'm not a docbook expert neither, and did not
> know this explanation of *Simple* Docbook.
> This is not written in the docbook Doxia module code (or I didn't find it ;) )
> neither.
> I'll update the doc.

Go 4 it :)

> I got confused by 2 facts in the code:
> - these elements are in the DocBookParser class (as HIER_ELEMENTS constant)
> - test/resources/book.xml is a book, not an article
> Should I remove these parts?
> Or simply mark them as experimental since out of the strict scope of the
> module?

It is related to DOXIA-186. In fact, the DocBookSink uses wrong DTD
Also, the DocbookParser and DocbookMarkup specifies some unused tags
(like BOOK_TAG). It will be good to remove them to be sticked on the
simplified docbook definition [1].

Cheers,

Vincent

> Regards,
>
> Hervé
>
> Le lundi 29 septembre 2008, Lukas Theussl a écrit :
>> Hi Herve,
>>
>> I haven't looked at the doxia modules for a while, and I am not a
>> docbook expert but IIRC, the doxia docbook module is for Simplified
>> Docbook only and in Simplified DocBook the root element is always
>> <article>.
>>
>> Correct me if I'm wrong...
>>
>> Cheers,
>> -Lukas
>>
>> hboutemy@... wrote:
>> > Author: hboutemy
>> > Date: Mon Sep 29 05:29:00 2008
>> > New Revision: 700094
>> >
>> > URL: http://svn.apache.org/viewvc?rev=700094&view=rev
>> > Log:
>> > there are multiple root element values possible for Docbook format
>> > (article, but also book, part, chapter, ...)
>> >
>> > Modified:
>> >
>> > maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/ma
>> >ven/doxia/DefaultConverter.java
>> >
>> > Modified:
>> > maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/ma
>> >ven/doxia/DefaultConverter.java URL:
>> > http://svn.apache.org/viewvc/maven/doxia/doxia-tools/trunk/doxia-converte
>> >r/src/main/java/org/apache/maven/doxia/DefaultConverter.java?rev=700094&r1
>> >=700093&r2=700094&view=diff
>> > =========================================================================
>> >===== ---
>> > maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/ma
>> >ven/doxia/DefaultConverter.java (original) +++
>> > maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/ma
>> >ven/doxia/DefaultConverter.java Mon Sep 29 05:29:00 2008 @@ -27,10 +27,12
>> > @@
>> > import java.io.Reader;
>> > import java.io.Writer;
>> > import java.util.HashMap;
>> > +import java.util.HashSet;
>> > import java.util.Iterator;
>> > import java.util.List;
>> > import java.util.Locale;
>> > import java.util.Map;
>> > +import java.util.Set;
>> > import java.util.regex.Matcher;
>> > import java.util.regex.Pattern;
>> >
>> > @@ -111,6 +113,37 @@
>> > public static final String[] SUPPORTED_TO_FORMAT =
>> > { APT_SINK, DOCBOOK_SINK, FO_SINK, ITEXT_SINK, LATEX_SINK,
>> > RTF_SINK, XDOC_SINK, XHTML_SINK };
>> >
>> > + private static final Set DOCBOOK_ROOT_ELEMENT = new HashSet();
>> > +
>> > + static
>> > + {
>> > + DOCBOOK_ROOT_ELEMENT.add( "set" );
>> > + DOCBOOK_ROOT_ELEMENT.add( "book" );
>> > + DOCBOOK_ROOT_ELEMENT.add( "part" );
>> > + DOCBOOK_ROOT_ELEMENT.add( "chapter" );
>> > + DOCBOOK_ROOT_ELEMENT.add( "section" );
>> > + DOCBOOK_ROOT_ELEMENT.add( "sect1" );
>> > + DOCBOOK_ROOT_ELEMENT.add( "sect2" );
>> > + DOCBOOK_ROOT_ELEMENT.add( "sect3" );
>> > + DOCBOOK_ROOT_ELEMENT.add( "sect4" );
>> > + DOCBOOK_ROOT_ELEMENT.add( "sect5" );
>> > + DOCBOOK_ROOT_ELEMENT.add( "article" );
>> > + DOCBOOK_ROOT_ELEMENT.add( "preface" );
>> > + DOCBOOK_ROOT_ELEMENT.add( "partintro" );
>> > + DOCBOOK_ROOT_ELEMENT.add( "appendix" );
>> > + DOCBOOK_ROOT_ELEMENT.add( "bibliography" );
>> > + DOCBOOK_ROOT_ELEMENT.add( "reference" );
>> > + DOCBOOK_ROOT_ELEMENT.add( "bibliography" );
>> > + DOCBOOK_ROOT_ELEMENT.add( "bibliodiv" );
>> > + DOCBOOK_ROOT_ELEMENT.add( "glossary" );
>> > + DOCBOOK_ROOT_ELEMENT.add( "refentry" );
>> > + DOCBOOK_ROOT_ELEMENT.add( "refnamediv" );
>> > + DOCBOOK_ROOT_ELEMENT.add( "refsection" );
>> > + DOCBOOK_ROOT_ELEMENT.add( "refsect1" );
>> > + DOCBOOK_ROOT_ELEMENT.add( "refsect2" );
>> > + DOCBOOK_ROOT_ELEMENT.add( "refsect3" );
>> > + }
>> > +
>> > /** Plexus container */
>> > private PlexusContainer plexus;
>> >
>> > @@ -614,7 +647,7 @@
>> > {
>> > continue;
>> > }
>> > - else if ( firstTag.equals( "article" )
>> > + else if ( DOCBOOK_ROOT_ELEMENT.contains( firstTag )
>> > && supportedFromFormat.equalsIgnoreCase( DOCBOOK_PARSER
>> > ) ) {
>> > return supportedFromFormat;
>
>
>

Re: svn commit: r700094 - /maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/maven/doxia/DefaultConverter.java

2008-09-29T09:49:29Z

Hi Lukas,

Thanks for pointing this out: I'm not a docbook expert neither, and did not
know this explanation of *Simple* Docbook.
This is not written in the docbook Doxia module code (or I didn't find it ;) )
neither.
I'll update the doc.

I got confused by 2 facts in the code:
- these elements are in the DocBookParser class (as HIER_ELEMENTS constant)
- test/resources/book.xml is a book, not an article
Should I remove these parts?
Or simply mark them as experimental since out of the strict scope of the
module?

Regards,

Hervé

Le lundi 29 septembre 2008, Lukas Theussl a écrit :

> Hi Herve,
>
> I haven't looked at the doxia modules for a while, and I am not a
> docbook expert but IIRC, the doxia docbook module is for Simplified
> Docbook only and in Simplified DocBook the root element is always
> <article>.
>
> Correct me if I'm wrong...
>
> Cheers,
> -Lukas
>
> hboutemy@... wrote:
> > Author: hboutemy
> > Date: Mon Sep 29 05:29:00 2008
> > New Revision: 700094
> >
> > URL: http://svn.apache.org/viewvc?rev=700094&view=rev
> > Log:
> > there are multiple root element values possible for Docbook format
> > (article, but also book, part, chapter, ...)
> >
> > Modified:
> >
> > maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/ma
> >ven/doxia/DefaultConverter.java
> >
> > Modified:
> > maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/ma
> >ven/doxia/DefaultConverter.java URL:
> > http://svn.apache.org/viewvc/maven/doxia/doxia-tools/trunk/doxia-converte
> >r/src/main/java/org/apache/maven/doxia/DefaultConverter.java?rev=700094&r1
> >=700093&r2=700094&view=diff
> > =========================================================================
> >===== ---
> > maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/ma
> >ven/doxia/DefaultConverter.java (original) +++
> > maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/ma
> >ven/doxia/DefaultConverter.java Mon Sep 29 05:29:00 2008 @@ -27,10 +27,12
> > @@
> > import java.io.Reader;
> > import java.io.Writer;
> > import java.util.HashMap;
> > +import java.util.HashSet;
> > import java.util.Iterator;
> > import java.util.List;
> > import java.util.Locale;
> > import java.util.Map;
> > +import java.util.Set;
> > import java.util.regex.Matcher;
> > import java.util.regex.Pattern;
> >
> > @@ -111,6 +113,37 @@
> > public static final String[] SUPPORTED_TO_FORMAT =
> > { APT_SINK, DOCBOOK_SINK, FO_SINK, ITEXT_SINK, LATEX_SINK,
> > RTF_SINK, XDOC_SINK, XHTML_SINK };
> >
> > + private static final Set DOCBOOK_ROOT_ELEMENT = new HashSet();
> > +
> > + static
> > + {
> > + DOCBOOK_ROOT_ELEMENT.add( "set" );
> > + DOCBOOK_ROOT_ELEMENT.add( "book" );
> > + DOCBOOK_ROOT_ELEMENT.add( "part" );
> > + DOCBOOK_ROOT_ELEMENT.add( "chapter" );
> > + DOCBOOK_ROOT_ELEMENT.add( "section" );
> > + DOCBOOK_ROOT_ELEMENT.add( "sect1" );
> > + DOCBOOK_ROOT_ELEMENT.add( "sect2" );
> > + DOCBOOK_ROOT_ELEMENT.add( "sect3" );
> > + DOCBOOK_ROOT_ELEMENT.add( "sect4" );
> > + DOCBOOK_ROOT_ELEMENT.add( "sect5" );
> > + DOCBOOK_ROOT_ELEMENT.add( "article" );
> > + DOCBOOK_ROOT_ELEMENT.add( "preface" );
> > + DOCBOOK_ROOT_ELEMENT.add( "partintro" );
> > + DOCBOOK_ROOT_ELEMENT.add( "appendix" );
> > + DOCBOOK_ROOT_ELEMENT.add( "bibliography" );
> > + DOCBOOK_ROOT_ELEMENT.add( "reference" );
> > + DOCBOOK_ROOT_ELEMENT.add( "bibliography" );
> > + DOCBOOK_ROOT_ELEMENT.add( "bibliodiv" );
> > + DOCBOOK_ROOT_ELEMENT.add( "glossary" );
> > + DOCBOOK_ROOT_ELEMENT.add( "refentry" );
> > + DOCBOOK_ROOT_ELEMENT.add( "refnamediv" );
> > + DOCBOOK_ROOT_ELEMENT.add( "refsection" );
> > + DOCBOOK_ROOT_ELEMENT.add( "refsect1" );
> > + DOCBOOK_ROOT_ELEMENT.add( "refsect2" );
> > + DOCBOOK_ROOT_ELEMENT.add( "refsect3" );
> > + }
> > +
> > /** Plexus container */
> > private PlexusContainer plexus;
> >
> > @@ -614,7 +647,7 @@
> > {
> > continue;
> > }
> > - else if ( firstTag.equals( "article" )
> > + else if ( DOCBOOK_ROOT_ELEMENT.contains( firstTag )
> > && supportedFromFormat.equalsIgnoreCase( DOCBOOK_PARSER
> > ) ) {
> > return supportedFromFormat;

Escaping characters and encoding support

2008-09-29T08:35:46Z

Hi folks,

I notified that APT sink escapes all characters (see
AptSink#escapeAPT()), so in this case, the APT sink provides only
UTF-8 writer.
Do we want to escaping characters in all sinks? In this case, UTF-8
will be the default encoding.

Cheers,

Vincent

Re: svn commit: r700094 - /maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/maven/doxia/DefaultConverter.java

2008-09-29T08:26:56Z

Hi,

Lukas has right: we handle only Simplified DocBook. Hervé could you revert this?

Cheers,

Vincent

2008/9/29 Lukas Theussl <ltheussl@...>:

> Hi Herve,
>
> I haven't looked at the doxia modules for a while, and I am not a docbook
> expert but IIRC, the doxia docbook module is for Simplified Docbook only and
> in Simplified DocBook the root element is always <article>.
>
> Correct me if I'm wrong...
>
> Cheers,
> -Lukas
>
>
> hboutemy@... wrote:
>>
>> Author: hboutemy
>> Date: Mon Sep 29 05:29:00 2008
>> New Revision: 700094
>>
>> URL: http://svn.apache.org/viewvc?rev=700094&view=rev
>> Log:
>> there are multiple root element values possible for Docbook format
>> (article, but also book, part, chapter, ...)
>>
>> Modified:
>>
>> maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/maven/doxia/DefaultConverter.java
>>
>> Modified:
>> maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/maven/doxia/DefaultConverter.java
>> URL:
>> http://svn.apache.org/viewvc/maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/maven/doxia/DefaultConverter.java?rev=700094&r1=700093&r2=700094&view=diff
>>
>> ==============================================================================
>> ---
>> maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/maven/doxia/DefaultConverter.java
>> (original)
>> +++
>> maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/maven/doxia/DefaultConverter.java
>> Mon Sep 29 05:29:00 2008
>> @@ -27,10 +27,12 @@
>> import java.io.Reader;
>> import java.io.Writer;
>> import java.util.HashMap;
>> +import java.util.HashSet;
>> import java.util.Iterator;
>> import java.util.List;
>> import java.util.Locale;
>> import java.util.Map;
>> +import java.util.Set;
>> import java.util.regex.Matcher;
>> import java.util.regex.Pattern;
>> @@ -111,6 +113,37 @@
>> public static final String[] SUPPORTED_TO_FORMAT =
>> { APT_SINK, DOCBOOK_SINK, FO_SINK, ITEXT_SINK, LATEX_SINK,
>> RTF_SINK, XDOC_SINK, XHTML_SINK };
>> + private static final Set DOCBOOK_ROOT_ELEMENT = new HashSet();
>> +
>> + static
>> + {
>> + DOCBOOK_ROOT_ELEMENT.add( "set" );
>> + DOCBOOK_ROOT_ELEMENT.add( "book" );
>> + DOCBOOK_ROOT_ELEMENT.add( "part" );
>> + DOCBOOK_ROOT_ELEMENT.add( "chapter" );
>> + DOCBOOK_ROOT_ELEMENT.add( "section" );
>> + DOCBOOK_ROOT_ELEMENT.add( "sect1" );
>> + DOCBOOK_ROOT_ELEMENT.add( "sect2" );
>> + DOCBOOK_ROOT_ELEMENT.add( "sect3" );
>> + DOCBOOK_ROOT_ELEMENT.add( "sect4" );
>> + DOCBOOK_ROOT_ELEMENT.add( "sect5" );
>> + DOCBOOK_ROOT_ELEMENT.add( "article" );
>> + DOCBOOK_ROOT_ELEMENT.add( "preface" );
>> + DOCBOOK_ROOT_ELEMENT.add( "partintro" );
>> + DOCBOOK_ROOT_ELEMENT.add( "appendix" );
>> + DOCBOOK_ROOT_ELEMENT.add( "bibliography" );
>> + DOCBOOK_ROOT_ELEMENT.add( "reference" );
>> + DOCBOOK_ROOT_ELEMENT.add( "bibliography" );
>> + DOCBOOK_ROOT_ELEMENT.add( "bibliodiv" );
>> + DOCBOOK_ROOT_ELEMENT.add( "glossary" );
>> + DOCBOOK_ROOT_ELEMENT.add( "refentry" );
>> + DOCBOOK_ROOT_ELEMENT.add( "refnamediv" );
>> + DOCBOOK_ROOT_ELEMENT.add( "refsection" );
>> + DOCBOOK_ROOT_ELEMENT.add( "refsect1" );
>> + DOCBOOK_ROOT_ELEMENT.add( "refsect2" );
>> + DOCBOOK_ROOT_ELEMENT.add( "refsect3" );
>> + }
>> +
>> /** Plexus container */
>> private PlexusContainer plexus;
>> @@ -614,7 +647,7 @@
>> {
>> continue;
>> }
>> - else if ( firstTag.equals( "article" )
>> + else if ( DOCBOOK_ROOT_ELEMENT.contains( firstTag )
>> && supportedFromFormat.equalsIgnoreCase( DOCBOOK_PARSER )
>> )
>> {
>> return supportedFromFormat;
>>
>>
>>
>

Re: svn commit: r700094 - /maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/maven/doxia/DefaultConverter.java

2008-09-29T06:15:58Z

Hi Herve,

I haven't looked at the doxia modules for a while, and I am not a
docbook expert but IIRC, the doxia docbook module is for Simplified
Docbook only and in Simplified DocBook the root element is always <article>.

Correct me if I'm wrong...

Cheers,
-Lukas

hboutemy@... wrote:

> Author: hboutemy
> Date: Mon Sep 29 05:29:00 2008
> New Revision: 700094
>
> URL: http://svn.apache.org/viewvc?rev=700094&view=rev
> Log:
> there are multiple root element values possible for Docbook format (article, but also book, part, chapter, ...)
>
> Modified:
> maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/maven/doxia/DefaultConverter.java
>
> Modified: maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/maven/doxia/DefaultConverter.java
> URL: http://svn.apache.org/viewvc/maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/maven/doxia/DefaultConverter.java?rev=700094&r1=700093&r2=700094&view=diff
> ==============================================================================
> --- maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/maven/doxia/DefaultConverter.java (original)
> +++ maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/maven/doxia/DefaultConverter.java Mon Sep 29 05:29:00 2008
> @@ -27,10 +27,12 @@
> import java.io.Reader;
> import java.io.Writer;
> import java.util.HashMap;
> +import java.util.HashSet;
> import java.util.Iterator;
> import java.util.List;
> import java.util.Locale;
> import java.util.Map;
> +import java.util.Set;
> import java.util.regex.Matcher;
> import java.util.regex.Pattern;
>
> @@ -111,6 +113,37 @@
> public static final String[] SUPPORTED_TO_FORMAT =
> { APT_SINK, DOCBOOK_SINK, FO_SINK, ITEXT_SINK, LATEX_SINK, RTF_SINK, XDOC_SINK, XHTML_SINK };
>
> + private static final Set DOCBOOK_ROOT_ELEMENT = new HashSet();
> +
> + static
> + {
> + DOCBOOK_ROOT_ELEMENT.add( "set" );
> + DOCBOOK_ROOT_ELEMENT.add( "book" );
> + DOCBOOK_ROOT_ELEMENT.add( "part" );
> + DOCBOOK_ROOT_ELEMENT.add( "chapter" );
> + DOCBOOK_ROOT_ELEMENT.add( "section" );
> + DOCBOOK_ROOT_ELEMENT.add( "sect1" );
> + DOCBOOK_ROOT_ELEMENT.add( "sect2" );
> + DOCBOOK_ROOT_ELEMENT.add( "sect3" );
> + DOCBOOK_ROOT_ELEMENT.add( "sect4" );
> + DOCBOOK_ROOT_ELEMENT.add( "sect5" );
> + DOCBOOK_ROOT_ELEMENT.add( "article" );
> + DOCBOOK_ROOT_ELEMENT.add( "preface" );
> + DOCBOOK_ROOT_ELEMENT.add( "partintro" );
> + DOCBOOK_ROOT_ELEMENT.add( "appendix" );
> + DOCBOOK_ROOT_ELEMENT.add( "bibliography" );
> + DOCBOOK_ROOT_ELEMENT.add( "reference" );
> + DOCBOOK_ROOT_ELEMENT.add( "bibliography" );
> + DOCBOOK_ROOT_ELEMENT.add( "bibliodiv" );
> + DOCBOOK_ROOT_ELEMENT.add( "glossary" );
> + DOCBOOK_ROOT_ELEMENT.add( "refentry" );
> + DOCBOOK_ROOT_ELEMENT.add( "refnamediv" );
> + DOCBOOK_ROOT_ELEMENT.add( "refsection" );
> + DOCBOOK_ROOT_ELEMENT.add( "refsect1" );
> + DOCBOOK_ROOT_ELEMENT.add( "refsect2" );
> + DOCBOOK_ROOT_ELEMENT.add( "refsect3" );
> + }
> +
> /** Plexus container */
> private PlexusContainer plexus;
>
> @@ -614,7 +647,7 @@
> {
> continue;
> }
> - else if ( firstTag.equals( "article" )
> + else if ( DOCBOOK_ROOT_ELEMENT.contains( firstTag )
> && supportedFromFormat.equalsIgnoreCase( DOCBOOK_PARSER ) )
> {
> return supportedFromFormat;
>
>
>

Re: svn commit: r697524 - in /maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook: DocBookParser.java DocBookSiteModule.java

2008-09-23T04:04:47Z

Hi Lukas,

I forgot to commit the Plexus component file. Done in r698133.

Cheers,

Vincent

2008/9/22 Lukas Theussl <ltheussl@...>:

> Hi Vincent,
>
> Is there any special reason for this 'innocent' change? I am concerned about
> backward compatibility (yes, really! ;) ). As illustrated by the problem
> that Arnaud encountered [1], these things are hard to track down...
>
> -Lukas
>
> [1] http://www.nabble.com/Adding-a-module-td14997185.html
>
>
> vsiveton@... wrote:
>>
>> Author: vsiveton
>> Date: Sun Sep 21 07:29:52 2008
>> New Revision: 697524
>>
>> URL: http://svn.apache.org/viewvc?rev=697524&view=rev
>> Log:
>> o unify docbook lookup
>>
>> Modified:
>>
>> maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookParser.java
>>
>> maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookSiteModule.java
>>
>> Modified:
>> maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookParser.java
>> URL:
>> http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookParser.java?rev=697524&r1=697523&r2=697524&view=diff
>>
>> ==============================================================================
>> ---
>> maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookParser.java
>> (original)
>> +++
>> maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookParser.java
>> Sun Sep 21 07:29:52 2008
>> @@ -42,7 +42,7 @@
>> * @author <a href="mailto:jason@...">Jason van Zyl</a>
>> * @version $Id$
>> * @since 1.0
>> - * @plexus.component role="org.apache.maven.doxia.parser.Parser"
>> role-hint="doc-book"
>> + * @plexus.component role="org.apache.maven.doxia.parser.Parser"
>> role-hint="docbook"
>> */
>> public class DocBookParser
>> extends AbstractXmlParser
>> @@ -734,10 +734,10 @@
>> /*
>> * NOTE: Don't do any whitespace trimming here. Whitespace
>> normalization has already been performed by the
>> * parser so any whitespace that makes it here is significant.
>> - */ + */
>> if ( StringUtils.isNotEmpty( text ) )
>> {
>> - // Emit separate text events for different lines, e.g. the
>> input + // Emit separate text events for different lines, e.g.
>> the input
>> // "\nLine1\n\nLine2\n\n" should deliver the event sequence
>> "\n", "Line1\n", "\n", "Line2\n", "\n".
>> // In other words, the concatenation of the text events must
>> deliver the input sequence.
>> // (according to section 2.11 of the XML spec, parsers must
>> normalize line breaks to "\n")
>>
>> Modified:
>> maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookSiteModule.java
>> URL:
>> http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookSiteModule.java?rev=697524&r1=697523&r2=697524&view=diff
>>
>> ==============================================================================
>> ---
>> maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookSiteModule.java
>> (original)
>> +++
>> maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookSiteModule.java
>> Sun Sep 21 07:29:52 2008
>> @@ -25,7 +25,7 @@
>> * @author <a href="mailto:evenisse@...">Emmanuel Venisse</a>
>> * @version $Id$
>> * @since 1.0
>> - * @plexus.component role="org.apache.maven.doxia.module.site.SiteModule"
>> role-hint="doc-book"
>> + * @plexus.component role="org.apache.maven.doxia.module.site.SiteModule"
>> role-hint="docbook"
>> */
>> public class DocBookSiteModule
>> extends AbstractSiteModule
>>
>>
>>
>

Re: svn commit: r697524 - in /maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook: DocBookParser.java DocBookSiteModule.java

2008-09-22T04:18:38Z

Hi Vincent,

Is there any special reason for this 'innocent' change? I am concerned
about backward compatibility (yes, really! ;) ). As illustrated by the
problem that Arnaud encountered [1], these things are hard to track down...

-Lukas

[1] http://www.nabble.com/Adding-a-module-td14997185.html

vsiveton@... wrote:

> Author: vsiveton
> Date: Sun Sep 21 07:29:52 2008
> New Revision: 697524
>
> URL: http://svn.apache.org/viewvc?rev=697524&view=rev
> Log:
> o unify docbook lookup
>
> Modified:
> maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookParser.java
> maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookSiteModule.java
>
> Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookParser.java
> URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookParser.java?rev=697524&r1=697523&r2=697524&view=diff
> ==============================================================================
> --- maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookParser.java (original)
> +++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookParser.java Sun Sep 21 07:29:52 2008
> @@ -42,7 +42,7 @@
> * @author <a href="mailto:jason@...">Jason van Zyl</a>
> * @version $Id$
> * @since 1.0
> - * @plexus.component role="org.apache.maven.doxia.parser.Parser" role-hint="doc-book"
> + * @plexus.component role="org.apache.maven.doxia.parser.Parser" role-hint="docbook"
> */
> public class DocBookParser
> extends AbstractXmlParser
> @@ -734,10 +734,10 @@
> /*
> * NOTE: Don't do any whitespace trimming here. Whitespace normalization has already been performed by the
> * parser so any whitespace that makes it here is significant.
> - */
> + */
> if ( StringUtils.isNotEmpty( text ) )
> {
> - // Emit separate text events for different lines, e.g. the input
> + // Emit separate text events for different lines, e.g. the input
> // "\nLine1\n\nLine2\n\n" should deliver the event sequence "\n", "Line1\n", "\n", "Line2\n", "\n".
> // In other words, the concatenation of the text events must deliver the input sequence.
> // (according to section 2.11 of the XML spec, parsers must normalize line breaks to "\n")
>
> Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookSiteModule.java
> URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookSiteModule.java?rev=697524&r1=697523&r2=697524&view=diff
> ==============================================================================
> --- maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookSiteModule.java (original)
> +++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookSiteModule.java Sun Sep 21 07:29:52 2008
> @@ -25,7 +25,7 @@
> * @author <a href="mailto:evenisse@...">Emmanuel Venisse</a>
> * @version $Id$
> * @since 1.0
> - * @plexus.component role="org.apache.maven.doxia.module.site.SiteModule" role-hint="doc-book"
> + * @plexus.component role="org.apache.maven.doxia.module.site.SiteModule" role-hint="docbook"
> */
> public class DocBookSiteModule
> extends AbstractSiteModule
>
>
>

Re: FYI

2008-08-14T07:13:35Z

I haven't work on it for a few weeks. So go ahead and do your release.
We can call what I have a different version later. I'll have no time
in the next month to push it in.

On 14-Aug-08, at 6:06 AM, Lukas Theussl wrote:

> Jason,
>
> Do you have any updates on that?
>
> Vincent is urging me to prepare a release of doxia-beta-1 which
> would be done from current trunk. There are no scheduled JIRAs left
> and everything seems ready from my viewpoint. So question: is trunk
> releas-able in your opinion or what are your plans wrt to the
> changes you discussed?
>
> Thanks,
> -Lukas
>
>
> Lukas Theussl wrote:
>> IMO these are all changes that should go into beta-1. The coupling
>> with maven/plexus has always been a major frustration, the sooner
>> this is removed, the better. The logging API was only added in
>> beta-1, so if you are going to dump it anyway, do it now. I don't
>> know what your plans are with book and maven-plugin but I do hope
>> they will survive somewhere, just not in the core?
>> In any case, I am concerned that the doxia development is getting
>> more and more away from what is currently used be maven (ie the
>> alpha branch), maybe we should think about releasing alpha-11 as
>> 1.0 final and move on with doxia 1.1 or 2.0? Opinions?
>> -Lukas
>> Jason van Zyl wrote:
>>> Hi,
>>>
>>> Just letting folks know that I've taken what's in trunk and I've
>>> been chopping it apart for a couple weeks:
>>>
>>> - removing plexus as a requirement
>>> - dumped the doxia-book module -- it doesn't belong in the core
>>> - dumped the doxia-maven-plugin module -- it doesn't belong in the
>>> core
>>> - dumped the doxia-logging-api -- I don't know who did this but
>>> it's just a bad idea
>>> - i combined the parser and sink apis. they are never used apart
>>> in practice, the separate attempt failed inside maven
>>>
>>> My ultimate goal is to extract the dependency on doxia out of
>>> Maven's core. What's happened is a terrible coupling. The plugin
>>> manager is bound to doxia because of reports which essentially
>>> look like plugins and ultimately it should just be another system
>>> that is pulled in as a set of components. That release of maven
>>> and doxia are coupled needs to be removed for Maven 2.1. I am
>>> personally interested in creating a data driven API for
>>> reporting, not a document driven API. No one needs to use what
>>> I'm making, but at the very least I will remove the dependency on
>>> Doxia from Maven's core. I'll probably put this somewhere in the
>>> next few weeks to show people, I just started one day a few weeks
>>> ago and I just ended up where I am now. Not saying anyone has to
>>> use what I'm making just giving folks a heads up.
>>>
>>> Thanks,
>>>
>>> Jason
>>>
>>> ----------------------------------------------------------
>>> Jason van Zyl
>>> Founder, Apache Maven
>>> jason at sonatype dot com
>>> ----------------------------------------------------------
>>>
>>> We know what we are, but know not what we may be.
>>>
>>> -- Shakespeare
>>>
>>>
>>>

Thanks,

Jason

----------------------------------------------------------
Jason van Zyl
Founder, Apache Maven
jason at sonatype dot com
----------------------------------------------------------

A man enjoys his work when he understands the whole and when he
is responsible for the quality of the whole

-- Christopher Alexander, A Pattern Language

Re: FYI

2008-08-14T06:05:14Z

Jason,

Do you have any updates on that?

Vincent is urging me to prepare a release of doxia-beta-1 which would be
done from current trunk. There are no scheduled JIRAs left and
everything seems ready from my viewpoint. So question: is trunk
releas-able in your opinion or what are your plans wrt to the changes
you discussed?

Thanks,
-Lukas

Lukas Theussl wrote:

> IMO these are all changes that should go into beta-1. The coupling with
> maven/plexus has always been a major frustration, the sooner this is
> removed, the better. The logging API was only added in beta-1, so if you
> are going to dump it anyway, do it now. I don't know what your plans are
> with book and maven-plugin but I do hope they will survive somewhere,
> just not in the core?
>
> In any case, I am concerned that the doxia development is getting more
> and more away from what is currently used be maven (ie the alpha
> branch), maybe we should think about releasing alpha-11 as 1.0 final and
> move on with doxia 1.1 or 2.0? Opinions?
>
> -Lukas
>
>
> Jason van Zyl wrote:
>
>> Hi,
>>
>> Just letting folks know that I've taken what's in trunk and I've been
>> chopping it apart for a couple weeks:
>>
>> - removing plexus as a requirement
>> - dumped the doxia-book module -- it doesn't belong in the core
>> - dumped the doxia-maven-plugin module -- it doesn't belong in the core
>> - dumped the doxia-logging-api -- I don't know who did this but it's
>> just a bad idea
>> - i combined the parser and sink apis. they are never used apart in
>> practice, the separate attempt failed inside maven
>>
>> My ultimate goal is to extract the dependency on doxia out of Maven's
>> core. What's happened is a terrible coupling. The plugin manager is
>> bound to doxia because of reports which essentially look like plugins
>> and ultimately it should just be another system that is pulled in as
>> a set of components. That release of maven and doxia are coupled
>> needs to be removed for Maven 2.1. I am personally interested in
>> creating a data driven API for reporting, not a document driven API.
>> No one needs to use what I'm making, but at the very least I will
>> remove the dependency on Doxia from Maven's core. I'll probably put
>> this somewhere in the next few weeks to show people, I just started
>> one day a few weeks ago and I just ended up where I am now. Not
>> saying anyone has to use what I'm making just giving folks a heads up.
>>
>> Thanks,
>>
>> Jason
>>
>> ----------------------------------------------------------
>> Jason van Zyl
>> Founder, Apache Maven
>> jason at sonatype dot com
>> ----------------------------------------------------------
>>
>> We know what we are, but know not what we may be.
>>
>> -- Shakespeare
>>
>>
>>
>

Re: FYI

2008-06-09T01:03:12Z

IMO these are all changes that should go into beta-1. The coupling with
maven/plexus has always been a major frustration, the sooner this is
removed, the better. The logging API was only added in beta-1, so if you
are going to dump it anyway, do it now. I don't know what your plans are
with book and maven-plugin but I do hope they will survive somewhere,
just not in the core?

In any case, I am concerned that the doxia development is getting more
and more away from what is currently used be maven (ie the alpha
branch), maybe we should think about releasing alpha-11 as 1.0 final and
move on with doxia 1.1 or 2.0? Opinions?

-Lukas

Jason van Zyl wrote:

> Hi,
>
> Just letting folks know that I've taken what's in trunk and I've been
> chopping it apart for a couple weeks:
>
> - removing plexus as a requirement
> - dumped the doxia-book module -- it doesn't belong in the core
> - dumped the doxia-maven-plugin module -- it doesn't belong in the core
> - dumped the doxia-logging-api -- I don't know who did this but it's
> just a bad idea
> - i combined the parser and sink apis. they are never used apart in
> practice, the separate attempt failed inside maven
>
> My ultimate goal is to extract the dependency on doxia out of Maven's
> core. What's happened is a terrible coupling. The plugin manager is
> bound to doxia because of reports which essentially look like plugins
> and ultimately it should just be another system that is pulled in as a
> set of components. That release of maven and doxia are coupled needs to
> be removed for Maven 2.1. I am personally interested in creating a data
> driven API for reporting, not a document driven API. No one needs to
> use what I'm making, but at the very least I will remove the dependency
> on Doxia from Maven's core. I'll probably put this somewhere in the
> next few weeks to show people, I just started one day a few weeks ago
> and I just ended up where I am now. Not saying anyone has to use what
> I'm making just giving folks a heads up.
>
> Thanks,
>
> Jason
>
> ----------------------------------------------------------
> Jason van Zyl
> Founder, Apache Maven
> jason at sonatype dot com
> ----------------------------------------------------------
>
> We know what we are, but know not what we may be.
>
> -- Shakespeare
>
>
>

Re: FYI

2008-06-09T00:43:59Z

Hi Jason,

On Jun 7, 2008, at 9:30 PM, Jason van Zyl wrote:

> Hi,
>
> Just letting folks know that I've taken what's in trunk and I've
> been chopping it apart for a couple weeks:
>
> - removing plexus as a requirement
> - dumped the doxia-book module -- it doesn't belong in the core
> - dumped the doxia-maven-plugin module -- it doesn't belong in the
> core
> - dumped the doxia-logging-api -- I don't know who did this but it's
> just a bad idea
> - i combined the parser and sink apis. they are never used apart in
> practice, the separate attempt failed inside maven

Sounds cool.

I'm curious about this last statement. In the design I have for
xwiki's rendering and in wikimodel too the Parser API and the Sink
(Listener in xwiki's and wikimodel's cases) are separated and this
seems to make sense. For example the Parser generates a DOM, on which
transformations can be applied (it can be cached too) and the Sink
(Listener in xwiki's and wikimodel's cases) is used to transform the
DOM's events into something else (PDF, RTF, wiki syntax, XHTML, etc).

In this context I'm not sur what "combined parser and sink apis"
means. Could you explain a bit? My chief concern is that I'm currently
wrapping Doxia into XWiki and I'd like to continue to be able to do so
in the future.

Thanks
-Vincent

>
>
> My ultimate goal is to extract the dependency on doxia out of
> Maven's core. What's happened is a terrible coupling. The plugin
> manager is bound to doxia because of reports which essentially look
> like plugins and ultimately it should just be another system that is
> pulled in as a set of components. That release of maven and doxia
> are coupled needs to be removed for Maven 2.1. I am personally
> interested in creating a data driven API for reporting, not a
> document driven API. No one needs to use what I'm making, but at the
> very least I will remove the dependency on Doxia from Maven's core.
> I'll probably put this somewhere in the next few weeks to show
> people, I just started one day a few weeks ago and I just ended up
> where I am now. Not saying anyone has to use what I'm making just
> giving folks a heads up.
>
> Thanks,
>
> Jason

FYI

2008-06-07T12:30:13Z

Hi,

Just letting folks know that I've taken what's in trunk and I've been
chopping it apart for a couple weeks:

- removing plexus as a requirement
- dumped the doxia-book module -- it doesn't belong in the core
- dumped the doxia-maven-plugin module -- it doesn't belong in the core
- dumped the doxia-logging-api -- I don't know who did this but it's
just a bad idea
- i combined the parser and sink apis. they are never used apart in
practice, the separate attempt failed inside maven

My ultimate goal is to extract the dependency on doxia out of Maven's
core. What's happened is a terrible coupling. The plugin manager is
bound to doxia because of reports which essentially look like plugins
and ultimately it should just be another system that is pulled in as a
set of components. That release of maven and doxia are coupled needs
to be removed for Maven 2.1. I am personally interested in creating a
data driven API for reporting, not a document driven API. No one needs
to use what I'm making, but at the very least I will remove the
dependency on Doxia from Maven's core. I'll probably put this
somewhere in the next few weeks to show people, I just started one day
a few weeks ago and I just ended up where I am now. Not saying anyone
has to use what I'm making just giving folks a heads up.

Thanks,

Jason

----------------------------------------------------------
Jason van Zyl
Founder, Apache Maven
jason at sonatype dot com
----------------------------------------------------------

We know what we are, but know not what we may be.

-- Shakespeare

Re: doxia logging api

2008-05-26T14:25:34Z

Not sure how a logging API cropped up, and how it extended from
Plexus. I think you're stuck now, but what I'm doing with something
I'm working on currently is to allow a set of components to be wired
up with Plexus or not and Doxia should be the same way.

On 26-May-08, at 1:04 PM, Lukas Theussl wrote:

>
> In order to test doxia-beta-1-SNAPSHOT with maven-2.0.10 and site-
> plugin-2.0-beta-7 I had to add doxia-logging-api to the Set of
> filtered artifacts in MavenArtifactFilterManager, otherwise I always
> ended up with some weird LinkageErrors. I don't know if this is
> going to be a concern or can be avoided or solved differently, but
> in any case, I'd first like to get some feedback about the cause,
> which is the way we have added logging to doxia [1]. I'm wondering
> if there is not a better way before pinning it down for beta-1.
>
> The current situation is such that both Sink and Parser extend
> doxia.logging.LogEnabled, ie the logging is implemented on the api
> level. The reason is that we want the same logger to be propagated
> from DefaultDoxia to the Parser and from each Parser to any Sink. As
> noted by Vincent [1], this is not a very natural solution, but not
> being too familiar with plexus, I didn't see another way. I'd be
> happily corrected...
>
> Btw, I have staged versions of the Maven [2] and Doxia [3] sites,
> built with doxia-beta-1-SNAPSHOT, for review. And as an encore: the
> corresponding pdfs built with the sandbox pdf plugin [4,5].
>
> Cheers,
> -Lukas
>
>
> [1] http://jira.codehaus.org/browse/DOXIA-145
> [2] http://people.apache.org/~ltheussl/maven-stage-site/
> [3] http://people.apache.org/~ltheussl/maven-stage-site/doxia/
> [4] http://people.apache.org/~ltheussl/maven-stage-site/maven.pdf
> [5] http://people.apache.org/~ltheussl/maven-stage-site/doxia/
> doxia.pdf

Thanks,

Jason

----------------------------------------------------------
Jason van Zyl
Founder, Apache Maven
jason at sonatype dot com
----------------------------------------------------------

doxia logging api

2008-05-26T13:00:05Z

In order to test doxia-beta-1-SNAPSHOT with maven-2.0.10 and
site-plugin-2.0-beta-7 I had to add doxia-logging-api to the Set of
filtered artifacts in MavenArtifactFilterManager, otherwise I always
ended up with some weird LinkageErrors. I don't know if this is going to
be a concern or can be avoided or solved differently, but in any case,
I'd first like to get some feedback about the cause, which is the way
we have added logging to doxia [1]. I'm wondering if there is not a
better way before pinning it down for beta-1.

The current situation is such that both Sink and Parser extend
doxia.logging.LogEnabled, ie the logging is implemented on the api
level. The reason is that we want the same logger to be propagated from
DefaultDoxia to the Parser and from each Parser to any Sink. As noted by
Vincent [1], this is not a very natural solution, but not being too
familiar with plexus, I didn't see another way. I'd be happily corrected...

Btw, I have staged versions of the Maven [2] and Doxia [3] sites, built
with doxia-beta-1-SNAPSHOT, for review. And as an encore: the
corresponding pdfs built with the sandbox pdf plugin [4,5].

Cheers,
-Lukas

[1] http://jira.codehaus.org/browse/DOXIA-145
[2] http://people.apache.org/~ltheussl/maven-stage-site/
[3] http://people.apache.org/~ltheussl/maven-stage-site/doxia/
[4] http://people.apache.org/~ltheussl/maven-stage-site/maven.pdf
[5] http://people.apache.org/~ltheussl/maven-stage-site/doxia/doxia.pdf

Re: Twiki Module Enhancements

2008-05-24T13:58:53Z

Abhijit,

I am really glad to hear that you guys at Yahoo are using and
contribuiting to the twiki module.

On Friday 23 May 2008, Abhijit Bagri wrote:
...
> 2. Since toc needed the whole doc source to be supplied, I had to modify
> ByLineSource implementation to have the entire source. Since changing
> the whole line based implementation was taknig too much, I just emulated
> whole source reading and supporting the getLine method in the new
> implementation.

Couldn't be the TOC be generated transversing the block tree returned by the
parser?

> 3. Enable linking of wiki words.
>
> Earlier a [[MyWikiWord]] would get likned to ./MyWikiWord. I am not sure
> why it was this way. Some light on this? I needed it to point it to
> ./MyWikiWord.html to be useful. Similarly for linking up wikiwords in
> [[][]].

This was fixed in http://jira.codehaus.org/browse/DOXIA-194.

I just added a test to my working copy in the file
http://svn.apache.org/repos/asf/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parser/WordsTest.java
(where the test cases for WikiWords links lives) and i get ./MyWikiWord.html.

public void testHtml() throws ParseException
{
final StringWriter sw = new StringWriter();
final Sink sink = new XhtmlBaseSink(sw);
twikiParser.parse("[[MyWikiWord]]", sink);
assertEquals("<p><a href=\"./MyWikiWord.html\">MyWikiWord</a></p>",
sw.toString());
}

The links are generated by the strategy WikiWordLinkResolver and can be
replaced.

...

> 5. Enabling verbatim and blockquote. verbatim did not seem to work
> properly for me.

verbatim worked well on our pages, but i think it can be more bulletproof and
more general. Don't forget to add the broken cases for regression in:

http://svn.apache.org/repos/asf/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parser/VerbatimTest.java

I wrote most of the twiki module code, so do not hesitate to send me especific
questions.

Regards,
Juan.

--
Buenos Aires, Argentina 19°C with winds at 0 km/h
http://www.zauber.com.ar/ http://juan.zauber.com.ar/

signature.asc (161 bytes) Download Attachment

Re: svn commit: r659507 - in /maven/doxia/doxia/trunk: doxia-core/src/main/java/org/apache/maven/doxia/util/ doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/

2008-05-23T05:37:17Z

Hi Lukas,

Since the code in AptUtils#isExternalLink() ==
DoxiaUtils#isExternalLink(), I suggest to remove the first one.

Cheers,

Vincent

2008/5/23, ltheussl@... <ltheussl@...>:

> Author: ltheussl
> Date: Fri May 23 04:38:39 2008
> New Revision: 659507
>
> URL: http://svn.apache.org/viewvc?rev=659507&view=rev
> Log:
> Better definition of external/internal/local links and adaptation in the apt case.
>
> Modified:
> maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/DoxiaUtils.java
> maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParser.java
> maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptUtils.java
>
> Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/DoxiaUtils.java
> URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/DoxiaUtils.java?rev=659507&r1=659506&r2=659507&view=diff
> ==============================================================================
> --- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/DoxiaUtils.java (original)
> +++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/DoxiaUtils.java Fri May 23 04:38:39 2008
> @@ -39,6 +39,9 @@
> *
> * @param link The link to check.
> * @return True if the link starts with "#".
> + *
> + * @see #isExternalLink(String)
> + * @see #isLocalLink(String)
> */
> public static boolean isInternalLink( String link )
> {
> @@ -48,13 +51,16 @@
> /**
> * Checks if the given string corresponds to an external URI,
> * ie is not a link within the same document nor a relative link
> - * to another document (a local link).
> + * to another document (a local link) of the same site.
> *
> * @param link The link to check.
> - * @return True if the link (ignoring case) starts with either of the
> - * following: "http:/", "https:/", "ftp:/", "mailto:", "file:/".
> + * @return True if the link (ignoring case) starts with either "http:/",
> + * "https:/", "ftp:/", "mailto:", "file:/", or contains the string "://".
> * Note that Windows style separators "\" are not allowed
> * for URIs, see http://www.ietf.org/rfc/rfc2396.txt , section 2.4.3.
> + *
> + * @see #isInternalLink(String)
> + * @see #isLocalLink(String)
> */
> public static boolean isExternalLink( String link )
> {
> @@ -62,14 +68,19 @@
>
> return ( text.indexOf( "http:/" ) == 0 || text.indexOf( "https:/" ) == 0
> || text.indexOf( "ftp:/" ) == 0 || text.indexOf( "mailto:" ) == 0
> - || text.indexOf( "file:/" ) == 0 );
> + || text.indexOf( "file:/" ) == 0 || text.indexOf( "://" ) != -1 );
> }
>
> /**
> - * Checks if the given string corresponds to a relative link to another document.
> + * Checks if the given string corresponds to a relative link to another document
> + * within the same site, ie it is neither an {@link #isInternalLink(String) internal}
> + * nor an {@link #isExternalLink(String) external} link.
> *
> * @param link The link to check.
> * @return True if the link is neither an external nor an internal link.
> + *
> + * @see #isExternalLink(String)
> + * @see #isInternalLink(String)
> */
> public static boolean isLocalLink( String link )
> {
>
> Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParser.java
> URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParser.java?rev=659507&r1=659506&r2=659507&view=diff
> ==============================================================================
> --- maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParser.java (original)
> +++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParser.java Fri May 23 04:38:39 2008
> @@ -25,6 +25,7 @@
> import org.apache.maven.doxia.parser.AbstractTextParser;
> import org.apache.maven.doxia.sink.Sink;
> import org.apache.maven.doxia.sink.SinkAdapter;
> +import org.apache.maven.doxia.sink.SinkEventAttributeSet;
> import org.apache.maven.doxia.util.DoxiaUtils;
>
> import org.codehaus.plexus.util.IOUtil;
> @@ -433,7 +434,7 @@
> linkAnchor = getTraversedLink( text, i + 1, end );
> }
>
> - if ( !AptUtils.isExternalLink( linkAnchor ) )
> + if ( AptUtils.isInternalLink( linkAnchor ) )
> {
> linkAnchor = "#" + linkAnchor;
> }
> @@ -2209,7 +2210,7 @@
> public void traverse()
> throws AptParseException
> {
> - AptParser.this.sink.verbatim( boxed );
> + AptParser.this.sink.verbatim( SinkEventAttributeSet.BOXED );
> // TODO: filter out lineBreak
> AptParser.this.sink.text( text );
> AptParser.this.sink.verbatim_();
>
> Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptUtils.java
> URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptUtils.java?rev=659507&r1=659506&r2=659507&view=diff
> ==============================================================================
> --- maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptUtils.java (original)
> +++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptUtils.java Fri May 23 04:38:39 2008
> @@ -54,13 +54,18 @@
>
> /**
> * Checks if the given string corresponds to an external URI,
> - * ie is not a link within the same document.
> + * ie is not a link within the same document nor a link to another
> + * document on the same filesystem.
> *
> * @param link The link to check.
> * @return True if the link (ignoring case) starts with either "http:/",
> - * "https:/", "ftp:/", "mailto:", "file:/", "../", "./" or contains the
> - * string "://". Note that Windows style separators "\" are not allowed
> + * "https:/", "ftp:/", "mailto:", "file:/", or contains the string "://".
> + * Note that Windows style separators "\" are not allowed
> * for URIs, see http://www.ietf.org/rfc/rfc2396.txt , section 2.4.3.
> + *
> + * @see org.apache.maven.doxia.util.DoxiaUtils#isExternalLink(String)
> + * @see #isInternalLink(String)
> + * @see #isLocalLink(String)
> */
> public static boolean isExternalLink( String link )
> {
> @@ -68,8 +73,40 @@
>
> return ( text.indexOf( "http:/" ) == 0 || text.indexOf( "https:/" ) == 0
> || text.indexOf( "ftp:/" ) == 0 || text.indexOf( "mailto:" ) == 0
> - || text.indexOf( "file:/" ) == 0 || text.indexOf( "../" ) == 0
> - || text.indexOf( "./" ) == 0 || text.indexOf( "://" ) != -1 );
> + || text.indexOf( "file:/" ) == 0 || text.indexOf( "://" ) != -1 );
> + }
> +
> + /**
> + * Checks if the given string corresponds to an internal link,
> + * ie it is a link to an anchor within the same document.
> + *
> + * @param link The link to check.
> + * @return True if link is neither an {@link #isExternalLink(String) external}
> + * nor a {@link #isLocalLink(String) local} link.
> + *
> + * @see org.apache.maven.doxia.util.DoxiaUtils#isInternalLink(String)
> + * @see #isExternalLink(String)
> + * @see #isLocalLink(String)
> + */
> + public static boolean isInternalLink( String link )
> + {
> + return ( !isExternalLink( link ) && !isLocalLink( link ) );
> + }
> +
> + /**
> + * Checks if the given string corresponds to a relative link to another document
> + * within the same site.
> + *
> + * @param link The link to check.
> + * @return True if the link starts with either "/", "./" or "../".
> + *
> + * @see org.apache.maven.doxia.util.DoxiaUtils#isLocalLink(String)
> + * @see #isExternalLink(String)
> + * @see #isInternalLink(String)
> + */
> + public static boolean isLocalLink( String link )
> + {
> + return ( link.startsWith( "/" ) || link.startsWith( "./" ) || link.startsWith( "../" ) );
> }
>
> /**
>
>
>