asciidoctor-pdf 1.5.0.alpha.1

data/data/themes/default-theme.yml

@@ -0,0 +1,182 @@
+font:
+  catalog:
+    NotoSerif:
+      normal: notoserif-regular-latin.ttf
+      bold: notoserif-bold-latin.ttf
+      italic: notoserif-italic-latin.ttf
+      bold_italic: notoserif-bolditalic-latin.ttf
+    # NOTE currently, callout numbers don't work with LiberationMono
+    #LiberationMono:
+    #  normal: liberationmono-regular-latin.ttf
+    #  bold: liberationmono-bold-latin.ttf
+    #  italic: liberationmono-italic-latin.ttf
+    #  bold_italic: liberationmono-bolditalic-latin.ttf
+    Mplus1mn:
+      normal: mplus1mn-regular-ascii-conums.ttf
+      bold: mplus1mn-bold-ascii.ttf
+      italic: mplus1mn-italic-ascii.ttf
+      bold_italic: mplus1mn-bolditalic-ascii.ttf
+    #Mplus1pMultilingual:
+    #  normal: mplus1p-regular-multilingual.ttf
+    #FontAwesome:
+    #  normal: fontawesome-regular.ttf
+  # FIXME using fallbacks breaks use of custom font styles (fixed in Prawn 1.2.1!)
+  #fallbacks:
+  #  - Mplus1pMultilingual
+brand:
+  primary_color: 428bca
+page:
+  background_color: ffffff
+  layout: portrait
+  # multiply inches by 72 to get pt values
+  margin: [0.5 * 72, 0.67 * 72, 0.67 * 72, 0.67 * 72]
+  size: Letter
+base:
+  font_color: 333333
+  font_family: NotoSerif
+  # choose one of these font_size/line_height_length combinations
+  #font_size: 14
+  #line_height_length: 20
+  #font_size: 11.25
+  #line_height_length: 18
+  #font_size: 11.2
+  #line_height_length: 16
+  font_size: 10.5
+  #line_height_length: 15
+  # correct line height for NotoSerif metrics
+  line_height_length: 12
+  #font_size: 11.25
+  #line_height_length: 18
+  line_height: $base_line_height_length / $base_font_size
+  font_size_large: round($base_font_size * 1.25)
+  font_size_small: round($base_font_size * 0.85)
+  font_style: normal
+  align: justify
+  border_radius: 4
+  border_width: 0.5
+  border_color: eeeeee
+# FIXME vertical_rhythm is weird; we should think in terms of ems
+#vertical_rhythm: $base_line_height_length * 2 / 3
+# correct line height for NotoSerif metrics
+vertical_rhythm: $base_line_height_length
+horizontal_rhythm: $base_line_height_length
+link_font_color: $brand_primary_color
+heading:
+  font_color: $base_font_color
+  font_family: $base_font_family
+  # h1 is used for document title
+  font_size_h1: floor($base_font_size * 2.6)
+  # h2 is used for chapter title
+  font_size_h2: floor($base_font_size * 2.15)
+  font_size_h3: round($base_font_size * 1.7)
+  font_size_h4: $base_font_size_large
+  font_size_h5: $base_font_size
+  font_size_h6: $base_font_size_small
+  font_style: bold
+  #line_height: 1.4
+  # correct line height for NotoSerif metrics
+  line_height: 1.2
+  margin_top: $vertical_rhythm * 0.2
+  margin_bottom: $vertical_rhythm * 0.8
+#prose:
+#  margin_top: 0
+#  margin_bottom: $vertical_rhythm 
+block:
+  #margin_top: 0
+  #margin_bottom: $vertical_rhythm
+  padding: [$vertical_rhythm, $vertical_rhythm * 1.25, $vertical_rhythm, $vertical_rhythm * 1.25]
+# code is used for source blocks (perhaps change to source or listing?)
+code:
+  font_color: $base_font_color
+  #font_family: LiberationMono
+  #font_size: floor($base_font_size * 0.9)
+  #font_size: 10
+  #padding: [9.5, 9.5, 9.5, 9.5]
+  # LiberationMono carries extra gap below line
+  #padding: [10, 10, 7.5, 10]
+  #line_height: 1.45
+  font_family: Mplus1mn
+  font_size: ceil($base_font_size)
+  #padding: [$base_font_size, $code_font_size, $base_font_size, $code_font_size]
+  padding: $code_font_size
+  line_height: 1.25
+  background_color: f5f5f5
+  border_color: cccccc
+  border_radius: $base_border_radius
+  border_width: 0.75
+# literal is currently used for inline monospaced in prose and table cells
+literal:
+  #font_color: c7254e
+  font_color: b12146
+  font_family: $code_font_family
+blockquote:
+  font_color: $base_font_color
+  font_size: $base_font_size_large
+  border_width: 5
+  border_color: $base_border_color
+  cite_font_size: $base_font_size_small
+  cite_font_color: 999999
+sidebar:
+  border_color: ffffff
+  border_radius: $base_border_radius
+  border_width: $base_border_width
+  background_color: eeeeee
+  title_font_color: $heading_font_color
+  title_font_family: $heading_font_family
+  title_font_size: $heading_font_size_h4
+  title_font_style: $heading_font_style
+  title_align: center
+example:
+  border_color: $base_border_color
+  border_radius: $base_border_radius
+  border_width: 0.75
+  background_color: transparent
+admonition:
+  border_color: $base_border_color
+  border_width: $base_border_width
+caption:
+  font_style: italic
+  align: left
+  # FIXME perhaps set line_height instead of / in addition to margins?
+  margin_inside: $vertical_rhythm * 0.25
+  margin_outside: 0
+conum:
+  font_family: Mplus1mn
+  font_color: $literal_font_color
+  font_size: $code_font_size
+image:
+  align_default: left
+  scaled_width_default: 0.5
+lead:
+  # QUESTION what about $base_font_size_large?
+  #font_size: floor($base_line_height_length * 0.8)
+  #font_size: floor($base_font_size * 1.15)
+  #line_height: 1.3
+  font_size: $base_font_size_large
+  line_height: 1.4
+abstract:
+  #font_color: 404040
+  font_color: 5c6266
+  font_size: $lead_font_size
+  line_height: $lead_line_height
+  font_style: italic
+thematic_break:
+  border_color: $base_border_color
+  margin_top: $vertical_rhythm * 0.5
+  margin_bottom: $vertical_rhythm * 1.5
+description_list:
+  term_font_style: italic
+  description_indent: $horizontal_rhythm * 1.25
+outline_list:
+  indent: $horizontal_rhythm * 1.25
+table:
+  background_color: transparent
+  background_color_alt: f9f9f9
+  border_color: dddddd
+  border_width: $base_border_width
+  # HACK accounting for line-height
+  cell_padding: [3, 3, 6, 3]
+footer:
+  font_size: $base_font_size_small
+  font_color: $base_font_color
+  border_color: dddddd

data/examples/chronicles.adoc

@@ -0,0 +1,429 @@
+= The Dangerous and Thrilling Documentation Chronicles
+Kismet Chameleon; Lazarus het_Draeke
+v1.0, 2014-01-01: The first incarnation of {doctitle}
+:description: This story chronicles the inexplicable hazards and vicious beasts a +
+team must surmount and vanquish on the journey to finding their open source +
+project's true power.
+:doctype: book
+:title-logo: sample-title-logo.jpg
+// Settings:
+:compat-mode:
+:experimental:
+:icons: font
+:listing-caption: Listing
+:sectnums:
+:toc:
+:toclevels: 3
+ifdef::backend-pdf[]
+:pagenums:
+:pygments-style: bw
+:source-highlighter: pygments
+endif::[]
+// URIs:
+:wolper-uri: http://en.wikipedia.org/wiki/Wolpertinger
+
+[abstract]
+{description}
+
+== It's a City Under Siege
+
+This journey begins one late Monday afternoon at http://www.devoxx.be/#/[Devoxx].
+Our team needs coffee, _desperately_, but none of us dare open the theater doors...
+
+During the first workshop, a script-happy warlock inadvertently released a legion of Wolpertingers!
+To leave now would mean *code dismemberment and certain death*.
+
+Behold, the horror!
+
+.Wolpertinger, stuffed
+[.left.thumb]
+image::wolpertinger.jpg[Wolpertinger,width=100%,scaledwidth=55%]
+
+You may not be familiar with these {wolper-uri}[ravenous beasts].
+Trust us, they'll eat your shorts and suck loops from your code.
+In light of this danger, we've searched high and wide for the security crew's defensive operations manual.
+We can't find it and the DefOps{empty}footnote:[a portmanteau of “defensive” and “operations”] werewolves haven't returned from their rendezvous at Bier Central.
+They've either eaten each other or fallen victim to the Wolpertingers roaming the streets of Antwerp.
+Quick, hit kbd:[Ctrl,Alt,Backspace] or select menu:File[Quit] and let's bail out of here!
+
+WARNING: Working with werewolves leads to howling and trying to train aggressive regular expressions with Pavlovian reinforcement.
+
+_Weak light from the hallway trickled across the theater, chased by a distant scream._
+
+=== Rendezvous Point
+
+Come on, _Bier Central_.
+Did you have to ask?
+If you beat me there, I'll take a http://www.sintbernardus.be/stbernardusabt12.php?l=en[St. Bernardus Abt 12].
+
+[[ravages]]
+== The Ravages of Writing
+
+Crystalline XML tags relentlessly bombarded the theater.
+
+.XML tags
+[source,xml]
+----
+<author id="1">
+  <personname>
+    <firstname>Lazarus</firstname>
+    <surname>het Draeke</surname>
+  </personname>
+</author>
+----
+
+Despite the assault, we were still attempting to draft an example of a defensive operation.
+
+.DefOps Plan
+====
+Click btn:[Download Zip] to download the defensive operation plan bundle.
+
+OMG!
+Somebody please save us now!
+I want my mum...and an extra-large double macchiato, please.
+====
+
+Unfortunaly, Lazarus and I had both come to the conclusion that we weren't going to get out of this without corrupted hardrives if we didn't locate caffeine within the next few hours.
+
+=== A Recipe for Potion
+
+This potion for a sample document contains the following ingredients, which are listed in a very random, chaotically nested order.
+
+* all the headings
+** syntax highlighted source code
+*** non-syntax highlighted source code or just a listing block
+* quote block
+** verse block
+*** table with some cell formatting
+**** sequential paragraphs
+***** admonition (at least one)
+*** bullet list with nesting
+** numbered list with nesting
+** definition list
+*** sidebar
+* example block
+** block image (no inline images)
+*** inline formatting in a paragraph
+**** two fresh Burdockian leaves
+***** They must be harvested by the light of the teal moons.
+
+Got square?
+
+[square]
+* one
+* two
+* three
+
+==== Searching for Burdockian
+
+.Steps for finding and preparing Burdockian leaves
+. Locate dusty botany
+.. Sneeze
+... Sneeze some more
+. Find section on Burdockian
+.. Review its characteristics
+... Take a picture of the diagram of its leaves
+.... Don't rip out the picture like a troglodyte
+..... Don't do it, I'm watching you
+. Put on your hiking boots
+. Freeze your butt off on the side of a mountain at midnight
+.. By the way, you can't see toes by the light of the teal moons.
+
+Let's start counting from 10.
+
+[start=10]
+. arabic (2)
+.. loweralpha (a)
+... lowerroman (i)
+... lowerroman (ii)
+... lowerroman (iii)
+... lowerroman (iv)
+.... upperalpha (A)
+. arabic (2)
+
+===== Are You Still Here?
+
+.Move, move, move!
+[CAUTION]
+====
+The Wolpertingers can smell your procrastination.
+It's not their fault you can't find your boots.
+====
+
+====== Sigh...
+
+TIP: Your boots are in your closet.
+
+== Dawn on the Plateau
+
+Lazarus was hanging from the bottom limb of a Burdockian tree, licking the bark.
+
+[quote, Mark Tobey]
+On pavements and the bark of trees I have found whole worlds.
+
+``If there are whole worlds on that bark, he just swallowed them.'' Kizmet replied.
+
+[verse,The documentation attorneys]
+____
+No bark was harmed in the making of this potion.
+    We're not so sure about a couple ants though.
+
+        Nor those worlds...
+
+     Crap, I smell an injunction.
+____
+
+We'd retrieved the leaves, but we'd obviously lost our minds in the process.
+
+[verse]
+Roses are +++<span style="color: #FF0000">red</span>+++.
+Violets are +++<span style="color: #0000FF">blue</span>+++__-ish__.
+
+== Words Seasoned with Power
+
+_To tame_ the wild wolpertingers we needed to build a *charm*.
+But **u**ltimate victory could only be won if we divined the *_true name_* of the __war__lock.
+
+``What kind of charm?'' Lazarus asked. ``An odoriferous one or a mineral one?''
+Kizmet shrugged. ``The note from Olaf's desk says `wormwood and licorice,' but these could be normal groceries for werewolves.''
+
+``Well the H~2~O written on the security whiteboard could be part of a shopping list, but I don't think the local bodega also sells e = mc^2^.'' Lazarus replied.
+
+``Wait!'' Indigo plucked a small vial from her desk's top drawer and held it toward us.
+The vial's label read `+e = mc^2^+ +*_the scent of science_*+ +_smells like a genius_+'.
+
+=== Can I Get Some +Code+?
+
+[%hardbreaks]
+Sure.
+Have a listing block.
+
+----
+This is an example of a listing block.
+The content inside is rendered as <pre> text.
+----
+
+But I'm not giving you any highlighting shazam just yet.
+
+.What is a listing block?
+****
+Like literal blocks, the content in listing blocks is displayed exactly as you entered it.
+Listing block content is rendered as +<pre>+ text.
+
+The +listing+ style is applied to an element, such as a paragraph, by setting the +listing+ attribute on that element.
+****
+
+Let's get our highlighting on!
+
+<<<
+
+Install Prawn:
+
+ $ gem install prawn
+
+Then create your first PDF document in Ruby!
+
+.Generates a basic PDF document using Prawn
+```ruby
+require 'prawn' # <1>
+
+Prawn::Document.generate 'output.pdf' do # <3>
+  text 'Hello, World!' # <2>
+end
+```
+<1> Imports Prawn library
+<2> Adds text “Hello, World!” to first page
+<3> Writes PDF to [file]_output.pdf_ after executing all statements
+
+How about some source code that styles code? So meta!
+
+```css
+code {
+  padding: 2px 4px;
+  font-size: 90%;
+  color: #c7254e;
+  white-space: nowrap !important;
+  background-color: #f9f2f4;
+  border-radius: 4px;
+}
+```
+
+Where could we go without some Java?
+
+```java
+package org.javaee7.cdi.events;
+
+import javax.enterprise.context.SessionScoped;
+import javax.enterprise.event.Observes;
+import java.io.Serializable;
+
+/**
+ * @author The Duke
+ */
+@SessionScoped
+public class GreetingReceiver implements EventReceiver, Serializable {
+    private String greet = "Willkommen";
+
+    void receive(@Observes String greet) {
+        this.greet = greet;
+    }
+
+    @Override
+    public String getGreet() {
+        return greet;
+    }
+}
+```
+
+We already showed you an XML example in <<ravages>>.
+
+I'll trade you a little table for some of that bark.
+
+[cols=3,frame=topbot,grid=rows]
+|===
+|Name of Column 1 |Name of Column 2 |Name of Column 3
+
+^m|Prefix the +{vbar}+ with +{caret}+ to center content horizontally
+.<|Prefix the +{vbar}+ with a +.+ and +<+ to align the content to the top of the cell
+>|Prefix the +{vbar}+ with +>+ to align the content to the right horizontally
+
+3+^.^e|This content spans three columns (+3{plus}+) and is centered horizontally (+{caret}+) and vertically (+.{caret}+) within the cell.
+|===
+
+Wait.
+What?
+Where is this story going?
+
++<span>+:: an html tag that makes me crazy
+
+align:: something I never get going in the right direction.
+Also has to do with my poor verbal communication skills
+
+float::
+style::
+don't make me laugh
+
+Does anyone have the time?
+
+Tg lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
+Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborumj.
+
+== Keeping It Together
+
+On this page we have nested ``keep together'' logic.
+The combined block will be shifted to the next page if there isn't room available on this one.
+
+[verse]
+First,
+we
+need
+to
+waste
+several
+lines
+using
+a
+verse
+to
+push
+it
+to
+the
+breaking
+point.
+
+[NOTE]
+.What happens if there is both a field and a method with the same name?
+====
+Back to the previous example, suppose that we have both a field and a method with the same name, as in:
+
+.Java class with a field and method that share the same name
+[source,java]
+----
+public class Foo {
+  public String bar;
+
+  public String bar() {
+    return bar;
+  }
+}
+----
+
+*Golo resolves methods first, fields last.*
+Hence, the following Golo code will resolve the +bar()+ method, not the +bar+ field:
+
+.Golo picks the method over the field with the same name
+----
+let foo = Foo()
+
+# Write the field
+foo: bar("baz")
+
+# Calls the bar() method
+println(foo: bar())
+----
+====
+
+<<<
+
+Here's a preview of how each heading level is rendered.
+
+[discrete]
+= Heading 1 (Level 0)
+
+filler content
+
+[discrete]
+== Heading 2 (Level 1)
+
+filler content
+
+[discrete]
+=== Heading 3 (Level 2)
+
+filler content
+
+[discrete]
+==== Heading 4 (Level 3)
+
+filler content
+
+[discrete]
+===== Heading 5 (Level 4)
+
+filler content
+
+[discrete]
+====== Heading 6 (Level 5)
+
+filler content
+
+---
+
+--
+Here's some content inside an open block.
+--
+
+<<<
+
+== Credits
+
+.Brought to you by OpenDevise
+[%header,cols="1,1s,1",grid=rows,frame=topbot]
+|===
+|Name
+|Title
+|Alias
+
+|Sarah White
+|President
+|http://twitter.com/carbonfray[@carbonfray]
+
+|Dan Allen
+|Vice President
+|http://twitter.com/mojavelinux[@mojavelinux]
+
+3+^.e|Powered by Open Source
+|===