Hello all, A few months ago I was inspired by spring framework and Oliver Gierke to rewrite my whole documentation using Asciidoctor. Turned out the asciidoctor-maven plugin has some limitations so I spent some time with Herve Boutemy last weekend to discuss a few pull requests I created for the maven-asciidoctor-plugin. Basically the bottom of the problem seems to be the doxia sink API which sanitizes the produced HTML5 result and removes a lot of the attributes. This is due to the fact that doxia does not provide html5 parser so the asciidoctor plugin is forced to extend the xhtml parser. So in terms of html5 some tags have different meaning. For instance in html5 the <i> tag is considered an icon and what asciidoctor is producing:
<i class="fa icon-note" title="Note"></i> doxia sink api treats as italics tags and removes the class and title attributes to become: <i></i> The end result is that the documentation css does not style the output properly. The solution for me is to probably create an HTML5 parser in doxia. Or even better: instead of Asciidoctor plugin --- creates --> HTML5 --> give it to the HTML5Parser of doxia --> give it to the sink API --> produce whatever you want (PDF, docbook, Latex or HTML5) maybe a better solution is to get rid of the sink API and keep it only for backward compatibility, but instead allow any new plugins to directly produce the HTML5 themselves. 2015-03-19 14:02 GMT+02:00 Jeff Jensen <jeffjen...@upstairstechnology.com>: > I agree Fred... the reports are very helpful. I've always thought of it as > handling two needs: "reports" and "docs"; reports basically working OOTB > and docs as the team decides to hand-create. > > > On Wed, Mar 18, 2015 at 10:43 PM, Fred Cooke <fred.co...@gmail.com> wrote: > > > Well, if you created it, then a personal thank you from me for that. I > > would never use it for normal web stuff, but for the autogenerated stuff > > like PMD, checkstyle, findbugs, cross ref code, javadocs, etc etc it's > > GREAT at release time to give you a reference of what was. Or during dev, > > when one feels like it, to create a comprehensive detailed view of the > > state of the code that can be casually navigated through using a browser. > > It has some SVNness in it, which I hate, so I invite you to continue the > > hate for your own reasons :-D > > > > On Thu, Mar 19, 2015 at 4:32 PM, Jason van Zyl <ja...@takari.io> wrote: > > > > > Anyone interested in trying a Jekyll experiment for our website? > Extract > > > the useful documentation we believe there is and try to make working on > > the > > > site a pleasurable experience that is easy for users to contribute to? > > > > > > I'd like to try this because after this last release I'm frankly tired > of > > > looking at our pretty awful website. It's ugly, noisy, unmaintained, > hard > > > to navigate and personally just makes me not want to write anything. I > > > would like to like writing documentation again and I think a more > > standard > > > tool like Jekyll will help. I honestly dislike doing core releases > > because > > > I have to use the site plugin. I created it, I can hate it and I do > hate > > it. > > > > > > Even if no one answers I'll try this experiment because I think there's > > > only 10-15 useful documents in the whole site so it likely won't take > > long. > > > > > > Thanks, > > > > > > Jason > > > > > > ---------------------------------------------------------- > > > Jason van Zyl > > > Founder, Takari and Apache Maven > > > http://twitter.com/jvanzyl > > > http://twitter.com/takari_io > > > --------------------------------------------------------- > > > > > > There's no sense in being precise when you don't even know what you're > > > talking about. > > > > > > -- John von Neumann > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > --------------------------------------------------------------------- > > > To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org > > > For additional commands, e-mail: dev-h...@maven.apache.org > > > > > > > > > -- Regards, Petar! Karlovo, Bulgaria. --- Public PGP Key at: https://keyserver1.pgp.com/vkd/DownloadKey.event?keyid=0x19658550C3110611 Key Fingerprint: A369 A7EE 61BC 93A3 CDFF 55A5 1965 8550 C311 0611
