Re: [jakarta.ee-spec.committee] Asciidoctor PDF reference

["Kevin Sutter" <sutter@xxxxxxxxxx>]

We use Asciidoctor in all of our MicroProfile
components.  It can generate both PDF and HTML (following David's
example):
https://github.com/eclipse/microprofile-jwt-auth/blob/master/spec/pom.xml#L56
https://github.com/eclipse/microprofile-jwt-auth/blob/master/spec/pom.xml#L71

It also has the ability to name the
resulting file.  We use this feature on the MicroProfile platform
spec so that the version of the doc is easily recognizeable:
https://github.com/eclipse/microprofile/blob/master/spec/pom.xml#L70

And, we inserted some cover page graphics
on our latest MP 2.2-RC1 release:  :-)
https://github.com/eclipse/microprofile/releases/download/2.2-RC1/microprofile-spec-2.2-RC1.pdf

---------------------------------------------------
Kevin Sutter 
STSM, MicroProfile and Java EE architect
e-mail:  sutter@xxxxxxxxxx     Twitter:  @kwsutter
phone: tl-553-3620 (office), 507-253-3620 (office)    
LinkedIn: https://www.linkedin.com/in/kevinwsutter



From:      
 David Blevins <dblevins@xxxxxxxxxxxxx>
To:      
 Jakarta specification
committee <jakarta.ee-spec.committee@xxxxxxxxxxx>
Date:      
 02/05/2019 08:39 PM
Subject:    
   [jakarta.ee-spec.committee]
Asciidoctor PDF reference
Sent by:    
   jakarta.ee-spec.committee-bounces@xxxxxxxxxxx

---

I've got a TODO to send out a reference on how to use
the Asciidoctor PDF plugin.  Here's an example ultimately taken from
CDI:

 - https://github.com/eclipse/microprofile-jwt-auth/blob/master/spec/pom.xml#L45

Here's where you say what the "main" asciidoc
file is:

 - https://github.com/eclipse/microprofile-jwt-auth/blob/master/spec/pom.xml#L87

This must be a file in src/main/asciidoc/.  This
file typically is filled with includes and cover information:

 - https://raw.githubusercontent.com/eclipse/microprofile-jwt-auth/master/spec/src/main/asciidoc/microprofile-jwt-auth-spec.asciidoc

Here's how the spec looks in the end:

 - https://github.com/eclipse/microprofile-jwt-auth/releases/download/1.1.1/microprofile-jwt-auth-spec.pdf

Though we don't use it, you can actually supply a template
the adds fancy covers and branding on the pages.


-- 
David Blevins
http://twitter.com/dblevins
http://www.tomitribe.com
310-633-3852
_______________________________________________
jakarta.ee-spec.committee mailing list
jakarta.ee-spec.committee@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe
from this list, visit
https://www.eclipse.org/mailman/listinfo/jakarta.ee-spec.committee