asciidoctor-htmlbook 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9f279f879d6126ddd879119caa51fa6fc0906f0
-  data.tar.gz: 1d55866eaf1bdcfe687d5b7a5dbac4575adf194b
+  metadata.gz: 698b27b3f58ab674d66a92098ccfff53d860e451
+  data.tar.gz: f23c83a00cd575f20102a1c46a06005b86e53649
 SHA512:
-  metadata.gz: 72f2d188d20858d64864bd6c8fe6fbdc62a3b730504ec56a551cc26b3099dd73eb848176085a291fc8c7f3b8524561dadf1784c5b3e5d54601dd162f993bb4c5
-  data.tar.gz: '08e9f93a2b96e650fc25eb0bbc33270203137fec33673ad63e366b05b115369dd7dc78a9bad725927f9f79b814b2d00b29e93bbd3a03ac5930a8bc9713b2a1b1'
+  metadata.gz: a646db7a4e9701ffefb81acff7fcbdd41e7853407690da7dbe13a35642f8fcc0ce0fe1c659dfb30bce679896a7f3e2952a6f2e10e08a2e8f4383e8b58a5d437c
+  data.tar.gz: 187c948b262edf7ecc2b10cdf03ee84ac966445311211e4994817595eb91c65c65032e8c9bd77904cbf988a95832102096ae0ef3bc9bb0b0f381378a0e654f46

data/README.adoc

@@ -0,0 +1,132 @@
+= Asciidoctor HTMLBook
+
+Asciidoctor HTMLBook is an link:http://asciidoctor.org/[Asciidoctor] backend for converting AsciiDoc documents to link:http://oreillymedia.github.io/HTMLBook/[HTMLBook] documents.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source, ruby]
+----
+gem 'asciidoctor-htmlbook'
+----
+
+And then execute:
+
+[source, console]
+----
+$ bundle
+----
+
+Or install it yourself as:
+
+[source, console]
+----
+$ gem install asciidoctor-htmlbook
+----
+
+== Usage
+
+=== CLI
+
+[source, console]
+----
+$ asciidoctor-htmlbook basic-example.adoc
+----
+
+or
+
+[source, console]
+----
+$ asciidoctor -r asciidoctor-htmlbook basic-example.adoc
+----
+
+For more options:
+
+[source, console]
+----
+$ asciidoctor-htmlbook -h
+----
+
+=== API
+
+To use Asciidoctor in your application, you first need to require the gem:
+
+[source, ruby]
+----
+require 'asciidoctor/htmlbook'
+----
+
+==== Load and Convert a File Using the API
+
+Load from file:
+
+[source, ruby]
+----
+doc = Asciidoctor.load_file 'mysample.adoc', backend: 'htmlbook'
+puts doc.convert
+----
+
+Convert file:
+
+[source, ruby]
+----
+Asciidoctor.convert_file 'mysample.adoc', backend: 'htmlbook'
+----
+
+==== Load and Convert Strings Using the API
+
+Load from string:
+
+[source, ruby]
+----
+doc = Asciidoctor.load '*This* is Asciidoctor.', backend: 'htmlbook'
+puts doc.convert
+----
+
+Render string:
+
+[source, ruby]
+----
+Asciidoctor.convert '*This* is Asciidoctor.', backend: 'htmlbook'
+----
+
+When rendering a string, the header and footer are excluded by default to make Asciidoctor consistent with other lightweight markup engines like Markdown. If you want the header and footer, just enable it using the `:header_footer` option:
+
+[source, ruby]
+----
+Asciidoctor.convert '*This* is Asciidoctor.', backend: 'htmlbook', header_footer: true
+----
+
+== Provide Custom Templates
+
+You can overwrite default templates by adding `:template_dir` option:
+
+[source, console]
+----
+$ asciidoctor-htmlbook -T path/to/templates basic-example.adoc
+----
+
+[source, ruby]
+----
+Asciidoctor.convert '*This* is Asciidoctor.', backend: 'htmlbook', template_dir: 'path/to/templates'
+----
+
+[NOTE]
+--
+asciidoctor-htmlbook template do not compatible with asciidoctor built-in template backend.
+
+View link:./templates[] for more info.
+--
+
+== Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/chloerei/asciidoctor-htmlbook. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the link:http://contributor-covenant.org[Contributor Covenant] code of conduct.
+
+== License
+
+The gem is available as open source under the terms of the link:http://opensource.org/licenses/MIT[MIT License].

data/asciidoctor-htmlbook.gemspec

@@ -9,9 +9,9 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Rei"]
   spec.email         = ["chloerei@gmail.com"]
 
-  spec.summary       = %q{}
-  spec.description   = %q{}
-  spec.homepage      = ""
+  spec.summary       = %q{Asciidoctor HTMLBook is an Asciidoctor backend for converting AsciiDoc documents to HTMLBook documents.}
+  spec.description   = %q{Asciidoctor HTMLBook is an Asciidoctor backend for converting AsciiDoc documents to HTMLBook documents.}
+  spec.homepage      = "https://github.com/chloerei/asciidoctor-htmlbook"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

data/exe/asciidoctor-htmlbook

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+if File.exist?(asciidoctor_htmlbook = (File.expand_path '../../lib/asciidoctor-htmlbook', __FILE__))
+  require asciidoctor_htmlbook
+else
+  require 'asciidoctor-htmlbook'
+end
+require 'asciidoctor/cli'
+
+options = Asciidoctor::Cli::Options.new backend: 'htmlbook', header_footer: true
+
+# FIXME provide an API in Asciidoctor for sub-components to print version information
+unless ARGV != ['-v'] && (ARGV & ['-V', '--version']).empty?
+  $stdout.write %(Asciidoctor HTMLbook #{Asciidoctor::Htmlbook::VERSION} using )
+  # NOTE the print_version method was added in Asciidoctor 1.5.2
+  if options.respond_to? :print_version
+    options.print_version
+  else
+    puts %(Asciidoctor #{::Asciidoctor::VERSION} [http://asciidoctor.org])
+  end
+  exit 0
+end
+
+# FIXME This is a really bizarre API. Please make me simpler.
+case (result = options.parse! ARGV)
+when Integer
+  exit result
+else
+  invoker = Asciidoctor::Cli::Invoker.new options
+  GC.start
+  invoker.invoke!
+  exit invoker.code
+end

data/lib/asciidoctor-htmlbook.rb

@@ -0,0 +1 @@
+require "asciidoctor/htmlbook"

data/lib/asciidoctor/htmlbook/converter.rb

@@ -7,26 +7,38 @@ module Asciidoctor
 
       def initialize(backend, options = {})
         super
+        @template_dirs = (options[:template_dirs] || []).push(DEFAULT_TEMPLATE_PATH)
         @templates = {}
       end
 
-      def get_template(node_name)
-        return @templates[node_name] if @templates[node_name]
-
-        path = File.join DEFAULT_TEMPLATE_PATH, "#{node_name}.html"
-        if File.exist?(path)
-          @templates[node_name] = Liquid::Template.parse(File.read(path))
+      def convert(node, transform = nil, options = {})
+        template = if (node.node_name == 'document' && transform == 'embedded')
+          get_template('embedded')
+        else
+          get_template(node.node_name)
         end
+
+        template.render 'node' => node_to_liquid(node)
       end
 
-      def convert(node, transform = nil, options = {})
-        template = get_template(node.node_name)
+      private
+
+      def get_template(name)
+        return @templates[name] if @templates[name]
 
-        unless template
-          raise "Template not found #{node.node_name} #{node} #{node.attributes}"
+        @template_dirs.each do |template_dir|
+          path = File.join template_dir, "#{name}.html"
+          if File.exist?(path)
+            @templates[name] = Liquid::Template.parse(File.read(path))
+            break
+          end
         end
 
-        template.render 'node' => node_to_liquid(node)
+        unless @templates[name]
+          raise "Template not found #{name}"
+        end
+
+        @templates[name]
       end
 
       def node_to_liquid(node)
@@ -67,8 +79,9 @@ module Asciidoctor
         abstract_node_to_liquid(node).merge({
           'level' => node.level,
           'title' => node.title,
-          'style' => node.style,
           'caption' => node.caption,
+          'captioned_title' => node.captioned_title,
+          'style' => node.style,
           'content' => node.content
         })
       end

data/lib/asciidoctor/htmlbook/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Htmlbook
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/templates/embedded.html

@@ -0,0 +1 @@
+{{ node.content }}

data/templates/example.html

@@ -1,4 +1,4 @@
 <div data-type="example">
-  {% if node.title %}<h5>{{ node.title }}</h5>{% endif %}
+  {% if node.title %}<h5>{{ node.captioned_title }}</h5>{% endif %}
   {{ node.content }}
 </div>

data/templates/image.html

@@ -5,7 +5,7 @@
          {% if node.attributes.width %}width="{{ node.attributes.width }}"{% endif %}
          {% if node.attributes.height %}height="{{ node.attributes.height }}"{% endif %} />
   {% if node.attributes.link %}</a>{% endif %}
-  {% if node.attributes.title %}
-    <figcaption>{{ node.attributes.title }}</figcaption>
+  {% if node.title %}
+    <figcaption>{{ node.captioned_title }}</figcaption>
   {% endif %}
 </figure>

data/templates/section.html

@@ -36,7 +36,7 @@
   </section>
 {% else %}
   <section id="{{node.id}}" data-type="{{ node.sectname }}">
-    <h1>{% if node.numbered %}{{ node.sectnum }} {% endif %}{{ node.title }}</h1>
+    <h1>{{ node.caption }}{{ node.title }}</h1>
     {{ node.content }}
   </section>
 {% endcase %}

data/templates/table.html

@@ -1,6 +1,6 @@
 <table>
   {% if node.title %}
-    <caption>{{ node.title }}</caption>
+    <caption>{{ node.captioned_title }}</caption>
   {% endif %}
   {% if node.rows.head.size > 0 %}
     <thead>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-htmlbook
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Rei
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-30 00:00:00.000000000 Z
+date: 2017-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -94,10 +94,12 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: ''
+description: Asciidoctor HTMLBook is an Asciidoctor backend for converting AsciiDoc
+  documents to HTMLBook documents.
 email:
 - chloerei@gmail.com
-executables: []
+executables:
+- asciidoctor-htmlbook
 extensions: []
 extra_rdoc_files: []
 files:
@@ -106,12 +108,14 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
-- README.md
+- README.adoc
 - Rakefile
 - asciidoctor-htmlbook.gemspec
 - bin/console
 - bin/rake
 - bin/setup
+- exe/asciidoctor-htmlbook
+- lib/asciidoctor-htmlbook.rb
 - lib/asciidoctor/htmlbook.rb
 - lib/asciidoctor/htmlbook/converter.rb
 - lib/asciidoctor/htmlbook/version.rb
@@ -120,6 +124,7 @@ files:
 - templates/colist.html
 - templates/dlist.html
 - templates/document.html
+- templates/embedded.html
 - templates/example.html
 - templates/image.html
 - templates/inline_anchor.html
@@ -145,7 +150,7 @@ files:
 - templates/ulist.html
 - templates/verse.html
 - templates/video.html
-homepage: ''
+homepage: https://github.com/chloerei/asciidoctor-htmlbook
 licenses:
 - MIT
 metadata: {}
@@ -168,5 +173,6 @@ rubyforge_project:
 rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: ''
+summary: Asciidoctor HTMLBook is an Asciidoctor backend for converting AsciiDoc documents
+  to HTMLBook documents.
 test_files: []

data/README.md

@@ -1,41 +0,0 @@
-# Asciidoctor::Htmlbook
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/asciidoctor/htmlbook`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'asciidoctor-htmlbook'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install asciidoctor-htmlbook
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/asciidoctor-htmlbook. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-