asciidoctor-pdf 1.5.0.alpha.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0d25db647f4e7f34a63b63d2a09c5986b519f59a
+  data.tar.gz: a574664f50ad919a6f9472a8977fb0ee94f510cd
+SHA512:
+  metadata.gz: 3b8e6ccb9e7492587c046a195386170683c4609a567270e2b7233338075400e1715e6a1b125a4eb14390df2130ff6720becc43f9c1afe6ac9d64fab0aea71730
+  data.tar.gz: a431f5501e7fd364ab272310a18613bc3203b025bfd13103750930af5177763c18fc157096a79cbc40190fb8a082f126434d14dfe44ace690943b6dc3f0bb909

data/LICENSE.adoc

@@ -0,0 +1,22 @@
+.The MIT License
+....
+Copyright (C) 2014 OpenDevise Inc. and the Asciidoctor Project
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+....

data/NOTICE.adoc

@@ -0,0 +1,76 @@
+= Asciidoctor PDF
+OpenDevise Inc.; Asciidoctor Project
+
+Copyright (C) 2014 OpenDevise Inc. and the Asciidoctor Project.
+
+Please visit the Asciidoctor project site for more information:
+
+  - http://asciidoctor.org
+
+OpenDevise Inc. and the Asciidoctor Project licenses this product to you under the MIT License (the "License").
+You may not use this product except in compliance with the License.
+You may obtain a copy of the License at:
+
+   http://opensource.org/licenses/MIT
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and limitations under the License.
+
+== Third-party licensed work
+
+M+ OUTLINE FONTS (M+ TESTFLIGHT 058)::
+  The M+ OUTLINE FONTS are used for section titles, literal text and code annotation numbers and bundled in the EPUB3 archive.
+  These fonts are free software and are designed and maintained by Coji Morishita.
+  Unlimited permission is granted to use, copy, and distribute them, with or without modification, either commercially or noncommercially.
+  THESE FONTS ARE PROVIDED "AS IS" WITHOUT WARRANTY.
+
+  - http://mplus-fonts.sourceforge.jp/mplus-outline-fonts/index-en.html
+
+Noto Serif Font (v2014-01-30)::
+  Noto is font family developed by the Google Internationalization Team that aims to support all the world's languages.
+  The Noto Serif font is used for body copy and bundled in the EPUB3 archive.
+  The Noto fonts are licensed under the Apache 2.0 License.
+  You may obtain a copy of the license at:
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+  - https://code.google.com/p/noto/
+
+Font Awesome Icon Font (v4.0.3)::
+  Font Awesome (@fontawesome), the iconic font designed for Bootstrap by David Gandy (@davegandy), is used for the admonition icons and other icons in author's content and bundled in the PDF file.
+  Font Awesome is fully open source and GPL compatible.
+  The font is licensed under the SIL Open Font 1.1 License (OFL).
+  You may obtain a copy of the license at:
+
+  http://scripts.sil.org/OFL
+
+  - http://fontawesome.io
+
+Liberation Fonts (v2.00.1)::
+  The Liberation(tm) Fonts 2.00.1, which are used by default, are licensed under the SIL Open Font License, Version 1.1.
+  You may obtain a copy of the license at:
+
+  http://scripts.sil.org/OFL
+
+  - https://fedorahosted.org/liberation-fonts 
+
+RomanNumeral class::
+  The RomanNumeral class, which is used for numbering of ordered lists, is borrowed from the roman-numerals RubyGem and modified for the purpose of this application.
+  The original RomanNumerals class was written by Andrew Vos and is licensed under the MIT License.
+
+  http://opensource.org/licenses/MIT
+
+  - https://github.com/AndrewVos/roman-numerals
+
+PrawnCodeRayEncoder class::
+  The PrawnCodeRayEncoder class, which is used for syntax highlighting source code for use with Prawn, is borrowed from the Prawn project and modified for the purpose of this application.
+  The PrawnEncoder was written by Felipe Doria and is licensed under the GPLv3 license.
+
+  http://www.gnu.org/licenses/gpl-3.0.html 
+
+  - https://github.com/prawnpdf/prawn
+
+Bootstrap (v3.0.3)::
+  The default theme is based on Bootstrap 3.0.3.
+
+  - http://getbootstrap.com

data/README.adoc

@@ -0,0 +1,263 @@
+= Asciidoctor PDF: A _native_ PDF converter for AsciiDoc
+Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]>
+// Settings:
+:compat-mode!:
+:experimental:
+:idprefix:
+:idseparator: -
+// Aliases:
+:project-name: Asciidoctor PDF
+:project-handle: asciidoctor-pdf
+// URIs:
+:uri-project: https://github.com/asciidoctor/asciidoctor-pdf
+:uri-project-repo: https://github.com/asciidoctor/asciidoctor-pdf
+:uri-project-issues: {uri-project-repo}/issues
+:uri-prawn: http://prawn.majesticseacreature.com
+:uri-rvm: http://rvm.io
+:uri-asciidoctor: http://asciidoctor.org
+:repo-base-uri: {uri-project-repo}/blob/master/
+ifdef::env-github[:repo-base-uri: link:]
+:uri-notice: {repo-base-uri}NOTICE.adoc
+:uri-license: {repo-base-uri}LICENSE.adoc
+:uri-worklog: {repo-base-uri}WORKLOG.adoc
+
+_Lo and behold_, a native PDF converter for AsciiDoc built with {uri-asciidoctor}[Asciidoctor] and {uri-prawn}[Prawn]! +
+_No more DocBook toolchain._ +
+_No more middleman._ +
+It's just AsciiDoc straight to PDF!
+
+.Project status
+CAUTION: {project-name} is currently _alpha_ software.
+Use accordingly.
+Though the bulk of AsciiDoc content is converter, there's still work needed to fill in gaps where conversion is incomplete, incorrect or not implemented.
+Once it's ready, the project will be moved into the Asciidoctor organization on GitHub.
+
+== Prawn, the majestic PDF generator
+
+{uri-project}[{project-name}] is made possible by the amazing Prawn RubyGem.
+_What a gem it is!_
+
+{uri-prawn}[Prawn] is a nimble PDF writer for Ruby.
+More important, it's a hackable platform that offers both high level APIs for the most common needs and low level APIs for bending the document model to accomodate special circumstances.
+
+With Prawn, you can write text, draw lines and shapes and place images _anywhere_ on the page and add as much color as you like.
+In addition, it brings a fluent API and aggressive code re-use to the printable document space.
+
+To give you a picture, here's an example that shows how to use Prawn to create a basic PDF document.
+
+.Create a basic PDF document using Prawn
+[source,ruby]
+----
+require 'prawn'
+
+Prawn::Document.generate 'example.pdf' do
+  text 'Hello, PDF creation!'
+end
+----
+
+It's that easy.
+And it's just the beginning.
+
+Simply put, *Prawn is the killer library for PDF generation* we've needed to close this critical gap in Asciidoctor.
+It absolutely takes the pain out of creating printable documents.
+Picking up from there, {project-name} takes the pain out of creating printable documents _from AsciiDoc_.
+
+== Notable Features
+
+* Direct AsciiDoc to PDF conversion
+* Configuration-driven style and layout
+* PDF document outline (i.e., bookmarks)
+* Document metadata (title, authors, subject, keywords, etc)
+* Internal cross reference links
+* Syntax highlighting with CodeRay or Pygments
+* Page breaks avoided in block content
+* Orphan section titles avoided
+* Table border settings honored
+
+=== Missing Features
+
+See {uri-worklog}[WORKLOG].
+
+== Prerequisites
+
+All that's needed is Ruby 1.9.3 or better (2.1.2 recommended) and a few RubyGems, which we explain how to install in the next section.
+
+To check you have Ruby available, use the +ruby+ command to query the version installed:
+
+ $ ruby --version
+
+If you're using {uri-rvm}[RVM], we recommend creating a new gemset to work with Asciidoctor and {project-name}:
+
+ $ rvm use 2.1@asciidoctor-pdf --create
+
+We like RVM because it keeps the dependencies required by various projects isolated.
+
+== Getting Started
+
+The {project-name} project is published in pre-release on RubyGems.org.
+You can either install the pre-release version using the following command:
+
+ $ gem install --pre asciidoctor-pdf
+
+Assuming all the required gems install properly, verify you can run the +asciidoctor-pdf+ script:
+
+ $ asciidoctor-pdf -v
+
+If you see the version of Asciidoctor PDF printed, you're ready to use {project-name}!
+
+Skip ahead to the <<example-asciidoc-document>> section to start putting {project-name} to use.
+Alternatively, you can follow the steps below to install the project from source.
+
+=== Retrieve the source code
+
+You can retrieve the {project-name} project in one of two ways:
+
+. Clone the git repository
+. Download a zip archive of the repository
+
+==== Option 1: Fetch using git clone
+
+If you want to clone the git repository, simply copy the {uri-project-repo}[GitHub repository URL] and pass it to +git clone+ command:
+
+ $ git clone https://github.com/asciidoctor/asciidoctor-pdf
+
+Next, change to the project directory:
+
+ $ cd asciidoctor-pdf
+
+==== Option 2: Download the archive
+
+If you want to download a zip archive, click the btn:[Download Zip] button on the right-hand side of the repository page on GitHub.
+Once the download finishes, extract the archive, open a console and change to that directory.
+
+TIP: Instead of working out of the {project-handle} directory, you can simply add the absolute path of the [path]_bin_ directory to your +PATH+ environment variable.
+
+We'll leverage the project configuration to install the necessary dependencies.
+
+=== Install the Dependencies
+
+The dependencies needed to use {project-name} are defined in the [file]_Gemfile_ at the root of the project.
+We can use Bundler to install the dependencies for us.
+
+To check you have Bundler available, use the +bundle+ command to query the version installed:
+
+ $ bundle --version
+
+If it's not installed, use the +gem+ command to install it.
+
+ $ gem install bundler
+
+Then use the +bundle+ command to install the project dependencies:
+
+ $ bundle
+
+Assuming all the required gems install properly, verify you can run the +asciidoctor-pdf+ script using Ruby:
+
+ $ ruby ./bin/asciidoctor-pdf -v
+
+If you see the version of Asciidoctor PDF printed, you're ready to use {project-name}!
+
+Let's grab an AsciiDoc document to distill.
+
+=== Example AsciiDoc document
+
+If you don't already have an AsciiDoc document, you can use the [file]_example.adoc_ file found in the examples directory of this project.
+
+.example.adoc
+[source,asciidoc]
+....
+= Document Title
+Doc Writer <doc@example.com>
+:doctype: book
+:source-highlighter: coderay
+:listing-caption: Listing
+
+A simple http://asciidoc.org[AsciiDoc] document.
+
+== Introduction
+
+A paragraph followed by a simple list with square bullets.
+
+[square]
+* item 1
+* item 2
+
+Here's how you say "`Hello, World!`" in Prawn:
+
+.Create a basic PDF document using Prawn
+[source,ruby]
+----
+require 'prawn'
+
+Prawn::Document.generate 'example.pdf' do
+  text 'Hello, World!'
+end
+----
+....
+
+It's time to convert the AsciiDoc document directly to PDF.
+
+=== Convert AsciiDoc to PDF
+
+Converting to PDF is a simple as running the +./bin/asciidoctor-pdf+ script using Ruby and passing our AsciiDoc document as the first argument.
+
+ $ ruby ./bin/asciidoctor-pdf example.adoc
+
+When the script completes, you should see the file [file]_example.pdf_ in the same directory.
+Open that file with a PDF viewer to see the result.
+
+.Example PDF document rendered in a PDF viewer
+image::examples/example-pdf-screenshot.png[Screenshot of PDF document,width=800,scaledwidth=100%]
+
+You're also encouraged to try converting this link:README.adoc[README] as well as the documents in the examples directory to see more of what {project-name} can do.
+Another good example is the https://github.com/cdi-spec/cdi/tree/master/spec[CDI Specification].
+
+The pain of the DocBook toolchain should be melting away about now.
+
+== Themes
+
+The layout and styling of the PDF is driven by a YAML configuration file.
+
+See the files [file]_default-theme.yml_ and [file]_asciidoctor-theme.yml_ found in the [file]_data/themes_ directory for examples.
+
+== Optional Scripts
+
+{project-name} also provides a shell script that invokes GhostScript (+gs+) to optimize and compress the generated PDF with minimal impact on quality.
+You must have Ghostscript installed to use it.
+
+Here's an example usage:
+
+ $ ./bin/optimize-pdf example.pdf
+
+The command will generate the file [file]_example-optimized.pdf_ in the current directory.
+
+WARNING: The +optimize-pdf+ script currently requires a Bash shell (Linux, OSX, etc).
+We plan to rewrite the script in Ruby so it works across platforms (see https://github.com/asciidoctor/asciidoctor-pdf/issues/1[issue #1])
+
+IMPORTANT: The +optimize-pdf+ script relies on Ghostscript >= 9.10.
+Otherwise, it may actually make the PDF larger.
+Also, you should only consider using it if the file size of the original PDF is > 5MB.
+
+If a file is found with the extension +.pdfmarks+ and the same rootname as the input file, it is used to add metadata to the generated PDF document.
+This file is necessary to preserve the document metadata since Ghostscript will otherwise drop it.
+That's why Asciidoctor PDF always creates this file in addition to the PDF.
+
+== Contributing
+
+In the spirit of free software, _everyone_ is encouraged to help improve this project.
+
+To contribute code, simply fork the project on GitHub, hack away and send a pull request with your proposed changes.
+
+Feel free to use the {uri-project-issues}[issue tracker] or http://discuss.asciidoctor.org[Asciidoctor mailing list] to provide feedback or suggestions in other ways.
+
+== Authors
+
+{project-name} was written by https://github.com/mojavelinux[Dan Allen] and https://github.com/graphitefriction[Sarah White] of OpenDevise Inc. on behalf of the Asciidoctor Project.
+
+== Copyright
+
+Copyright (C) 2014 OpenDevise Inc. and the Asciidoctor Project.
+Free use of this software is granted under the terms of the MIT License.
+
+For the full text of the license, see the {uri-license}[LICENSE] file.
+Refer to the {uri-notice}[NOTICE] file for information about third-party Open Source software in use.

data/Rakefile

@@ -0,0 +1,78 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('lib/asciidoctor-pdf/version', File.dirname(__FILE__))
+
+require 'rake/clean'
+
+default_tasks = []
+
+begin
+  require 'bundler/gem_tasks'
+
+  task :commit_release do
+    Bundler::GemHelper.new.send :guard_clean
+    sh %(git commit --allow-empty -a -m 'Release #{Asciidoctor::Pdf::VERSION}')
+  end
+
+  # Enhance the release task to create an explicit commit for the release
+  Rake::Task[:release].enhance [:commit_release]
+rescue LoadError
+end
+
+begin
+  require 'rdoc/task'
+  Rake::RDocTask.new do |t|
+    t.rdoc_dir = 'rdoc'
+    t.title = %(Asciidoctor EPUB3 #{Asciidoctor::Pdf::VERSION})
+    t.main = %(README.adoc)
+    t.rdoc_files.include 'README.adoc', 'LICENSE.adoc', 'NOTICE.adoc', 'lib/**/*.rb', 'bin/**/*'
+  end
+rescue LoadError
+end
+
+=begin NOT CURRENTLY IN USE
+begin
+  require 'rake/testtask'
+  Rake::TestTask.new do |t|
+    t.libs << 'test'
+    t.pattern = 'test/**/*_test.rb'
+    t.verbose = true
+    t.warning = true
+    if RUBY_VERSION >= '2'
+      t.options = '--tty=no'
+    end
+  end
+  default_tasks << :test
+rescue LoadError
+end
+
+begin
+  require 'cucumber'
+  require 'cucumber/rake/task'
+  CUKE_RESULTS_FILE = 'feature-results.html'
+  ARUBA_TMP_DIR = 'tmp'
+  CLEAN << CUKE_RESULTS_FILE if File.file? CUKE_RESULTS_FILE
+  CLEAN << ARUBA_TMP_DIR if File.directory? ARUBA_TMP_DIR
+  desc 'Run features'
+  Cucumber::Rake::Task.new :features do |t|
+    opts = %(features --format html -o #{CUKE_RESULTS_FILE} --format progress -x --tags ~@pending)
+    opts = %(#{opts} --tags #{ENV['TAGS']}) if ENV['TAGS']
+    t.cucumber_opts = opts
+    t.fork = false
+  end
+
+  desc 'Run features tagged as work-in-progress (@wip)'
+  Cucumber::Rake::Task.new 'features:wip'  do |t|
+    #t.cucumber_opts = %(features --format html -o #{CUKE_RESULTS_FILE} --format pretty -x -s --tags @wip)
+    t.cucumber_opts = %(features --format html -o #{CUKE_RESULTS_FILE} --format progress -x --tags @wip)
+    t.fork = false
+  end
+
+  default_tasks << :features
+  task :cucumber => :features
+  task 'cucumber:wip' => 'features:wip'
+  task :wip => 'features:wip'
+rescue LoadError
+end
+=end
+
+task :default => default_tasks unless default_tasks.empty?