Maven Asciidoctor Archetype available for review

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
4 messages Options
Jmm
Reply | Threaded
Open this post in threaded view
|

Maven Asciidoctor Archetype available for review

Jmm
Hello,

Today I pushed on Github my Asciidoctor Maven Archetype project.

It can be used to simplify the setup of a Maven document project to produce PDFs based on asciidoc sources. It uses a sample document that, besides showing several useful asciidoc(tor) features, documents how the demo build pipeline works and where to start to customise it. It shows how to integrate PlantUML and UMLet graphs.

It is available at https://github.com/jmMeessen/asciidoctor-maven-archetype

Comments and advise most welcomed.

Jmm
Reply | Threaded
Open this post in threaded view
|

Re: Maven Asciidoctor Archetype available for review

mojavelinux
Administrator

Awesome news Jmm! I can't wait to check it out!

-Dan

On Feb 4, 2014 2:16 PM, "Jmm [via Asciidoctor :: Discussion]" <[hidden email]> wrote:
Hello,

Today I pushed on Github my Asciidoctor Maven Archetype project.

It can be used to simplify the setup of a Maven document project to produce PDFs based on asciidoc sources. It uses a sample document that, besides showing several useful asciidoc(tor) features, documents how the demo build pipeline works and where to start to customise it. It shows how to integrate PlantUML and UMLet graphs.

It is available at https://github.com/jmMeessen/asciidoctor-maven-archetype

Comments and advise most welcomed.

Jmm


If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Maven-Asciidoctor-Archetype-available-for-review-tp1350.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML
Reply | Threaded
Open this post in threaded view
|

Re: Maven Asciidoctor Archetype available for review

mojavelinux
Administrator
In reply to this post by Jmm
Jmm,

I had a chance to test out your archetype. Amazing! You really pulled a lot of tricky technologies together in a concise stack (as concise as Maven can afford us). I had heard about docbkx but never tried it until now. It seems much simpler to use than the jDocBook plugin.

Once I tested out the archetype from scratch, I integrated the build logic into the Golo programming language guide to try it on an existing project. It wasn't hard to follow your setup at all. You can see the result on the asciidoctor-docbkx branch:


Here's a link to the PDF output:


There are a few things I noticed that were missing that perhaps you could add:

* callout icons (for source listings)
* the remaining admonition icons (important, caution, warning, tip)
* outline / bookmarks (i.e., sidebar navigation)
* make the "Internal" label in footer optional (for open source projects)

If you haven't already, you might want to comb through the fo stylesheets from fopub (https://github.com/asciidoctor/asciidoctor-fopub/blob/master/src/dist/docbook-xsl/fo-pdf.xsl), which have a lot of these features.

Finally, when you are ready and interested, we'd be glad to welcome the archetype into the Asciidoctor organization on GitHub.

Again, great work!

-Dan


On Tue, Feb 4, 2014 at 5:33 PM, Dan Allen <[hidden email]> wrote:

Awesome news Jmm! I can't wait to check it out!

-Dan

On Feb 4, 2014 2:16 PM, "Jmm [via Asciidoctor :: Discussion]" <[hidden email]> wrote:
Hello,

Today I pushed on Github my Asciidoctor Maven Archetype project.

It can be used to simplify the setup of a Maven document project to produce PDFs based on asciidoc sources. It uses a sample document that, besides showing several useful asciidoc(tor) features, documents how the demo build pipeline works and where to start to customise it. It shows how to integrate PlantUML and UMLet graphs.

It is available at https://github.com/jmMeessen/asciidoctor-maven-archetype

Comments and advise most welcomed.

Jmm


If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Maven-Asciidoctor-Archetype-available-for-review-tp1350.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



--
Jmm
Reply | Threaded
Open this post in threaded view
|

Re: Maven Asciidoctor Archetype available for review

Jmm
Thank you for your comments and sorry for a late acknowledgement (had a very busy WE).

I will definitely follow the improvement recommendations. A new version should be available soon. Some features, like title page customisation, take more time then expected.

Jmm


2014-02-07 4:35 GMT+01:00 mojavelinux [via Asciidoctor :: Discussion] <[hidden email]>:
Jmm,

I had a chance to test out your archetype. Amazing! You really pulled a lot of tricky technologies together in a concise stack (as concise as Maven can afford us). I had heard about docbkx but never tried it until now. It seems much simpler to use than the jDocBook plugin.

Once I tested out the archetype from scratch, I integrated the build logic into the Golo programming language guide to try it on an existing project. It wasn't hard to follow your setup at all. You can see the result on the asciidoctor-docbkx branch:


Here's a link to the PDF output:


There are a few things I noticed that were missing that perhaps you could add:

* callout icons (for source listings)
* the remaining admonition icons (important, caution, warning, tip)
* outline / bookmarks (i.e., sidebar navigation)
* make the "Internal" label in footer optional (for open source projects)

If you haven't already, you might want to comb through the fo stylesheets from fopub (https://github.com/asciidoctor/asciidoctor-fopub/blob/master/src/dist/docbook-xsl/fo-pdf.xsl), which have a lot of these features.

Finally, when you are ready and interested, we'd be glad to welcome the archetype into the Asciidoctor organization on GitHub.

Again, great work!

-Dan


On Tue, Feb 4, 2014 at 5:33 PM, Dan Allen <[hidden email]> wrote:

Awesome news Jmm! I can't wait to check it out!

-Dan

On Feb 4, 2014 2:16 PM, "Jmm [via Asciidoctor :: Discussion]" <[hidden email]> wrote:
Hello,

Today I pushed on Github my Asciidoctor Maven Archetype project.

It can be used to simplify the setup of a Maven document project to produce PDFs based on asciidoc sources. It uses a sample document that, besides showing several useful asciidoc(tor) features, documents how the demo build pipeline works and where to start to customise it. It shows how to integrate PlantUML and UMLet graphs.

It is available at https://github.com/jmMeessen/asciidoctor-maven-archetype

Comments and advise most welcomed.

Jmm


If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Maven-Asciidoctor-Archetype-available-for-review-tp1350.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



--



If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Maven-Asciidoctor-Archetype-available-for-review-tp1350p1358.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML