asciidoctor-epub3 1.0.0.alpha.1

data/lib/asciidoctor-epub3/spine_item_processor.rb

@@ -0,0 +1,72 @@
+module Asciidoctor
+module Epub3
+class SpineItemProcessor < Extensions::IncludeProcessor
+  def initialize document
+    @document = document
+  end
+
+  # NOTE only fires for includes in spine document if registered directly on the instance of the spine document
+  def process doc, reader, target, attributes
+    spine_doc = doc
+    unless ::File.exist?(include_file = (spine_doc.normalize_system_path target, reader.dir, nil, target_name: 'include file'))
+      warn %(asciidoctor: WARNING: #{reader.line_info}: include file not found: #{include_file})
+      return
+    end
+    inherited_attributes = spine_doc.attributes.dup
+    %w(spine doctitle docfile docdir docname).each {|key| inherited_attributes.delete key }
+
+    # parse header to get author information
+    spine_item_doc_meta = ::Asciidoctor.load_file include_file,
+        safe: spine_doc.safe,
+        backend: 'epub3-xhtml5',
+        doctype: :article,
+        parse_header_only: true 
+
+    # blank out author information if present in sub-document
+    # FIXME this is a huge hack...we need a cleaner way to do this; perhaps an API method that retrieves all the author attribute names
+    if spine_item_doc_meta.attr? 'author'
+      %w(author firstname lastname email authorinitials authors authorcount).each {|key| inherited_attributes.delete key }
+      idx = 1
+      while inherited_attributes.key? %(author_#{idx})
+        %W(author_#{idx} firstname_#{idx} lastname_#{idx} email_#{idx} authorinitials_#{idx}).each {|key| inherited_attributes.delete key }
+        idx += 1
+      end
+    end
+
+    # REVIEW reaching into converter to resolve document id feels like a hack; should happen in Asciidoctor parser
+    # also, strange that "id" doesn't work here
+    inherited_attributes['css-signature'] = DocumentIdGenerator.generate_id spine_item_doc_meta
+    inherited_attributes['docreldir'] = ::File.dirname target
+
+    # NOTE can't assign spine document as parent since there's too many assumptions in the Asciidoctor processor
+    spine_item_doc = ::Asciidoctor.load_file include_file,
+        # setting base_dir breaks if outdir is not a subdirectory of spine_doc.base_dir
+        #base_dir: spine_doc.base_dir,
+        # NOTE won't write to correct directory if safe mode is :secure
+        safe: spine_doc.safe,
+        backend: 'epub3-xhtml5',
+        doctype: :article,
+        header_footer: true,
+        attributes: inherited_attributes
+
+    # restore attributes to those defined in the document header
+    spine_item_doc.restore_attributes
+
+    (spine_doc.references[:spine_items] ||= []) << spine_item_doc
+    # NOTE if there are attribute assignments between the include directives,
+    # then this ordered list is not continguous, so bailing on the idea
+    #reader.replace_line %(. link:#{::File.basename(spine_item_doc.attr 'outfile')}[#{spine_item_doc.doctitle}])
+  end
+
+  # handles? should get the attributes on include directive as the second argument
+  def handles? target
+    (@document.attr? 'spine') && (ASCIIDOC_EXTENSIONS.include? ::File.extname(target))
+  end
+
+  # FIXME this method shouldn't be required
+  def update_config config
+    (@config ||= {}).update config
+  end
+end
+end
+end

data/lib/asciidoctor-epub3/version.rb

@@ -0,0 +1,5 @@
+module Asciidoctor
+module Epub3
+  VERSION = '1.0.0.alpha.1'
+end
+end

data/scripts/generate-font-subsets.pe

@@ -0,0 +1,225 @@
+#!/usr/bin/env fontforge
+
+# Run using:
+#
+# $ ./generate-font-subsets.pe <target directory>
+#
+# NOTE: Ignore "GID out of range" warnings; fontforge has to kick the tires a bit to flush out these dead references
+#
+# Use with Noto Serif fonts from https://code.google.com/p/noto/source/browse/#svn%2Ftrunk%2Ffonts%2Findividual%2Funhinted
+# Use with M+ fonts from http://mplus-fonts.sourceforge.jp/mplus-outline-fonts/download/index-en.html
+#
+# TODO: Add cjkv profile
+#
+# IMPORTANT: Must generate Apple format (0x10) or include old-fashioned 'kern' table for kerning to work in Prawn
+#
+# generate flags (additive):
+# * 0x00 - OpenType
+# * 0x10 - Apple
+# * 0x80 - OpenType and Apple
+# * 0x90 - Neither OpenType or Apple
+# * 0x800 - Generate old-style 'kern' table
+# * 0x08 - exclude TrueType instructions
+#
+# QUESTION: do we need to apply RoundToInt() after ClearInstrs()?
+# FIXME: need to generate cjk font
+
+genflags = 0x08
+#genflags = 0x18
+copy_fonts = ["NotoSerif-Regular.ttf", "NotoSerif-Bold.ttf", "NotoSerif-Italic.ttf", "NotoSerif-BoldItalic.ttf", "mplus-1p-regular.ttf", "mplus-1p-bold.ttf", "mplus-1p-light.ttf"]
+#copy_fonts = ["NotoSerif-Regular.ttf", "NotoSerif-Bold.ttf", "NotoSerif-Italic.ttf", "NotoSerif-BoldItalic.ttf"]
+#copy_fonts = ["LiberationMono-Regular.ttf", "LiberationMono-Bold.ttf", "LiberationMono-Italic.ttf", "LiberationMono-BoldItalic.ttf"]
+#copy_fonts = ["NotoSerif-Regular.ttf"]
+#copy_fonts = []
+num_copy_fonts = SizeOf(copy_fonts)
+copy_scripts = ["latin", "latin-ext", "latin-cyrillic", "multilingual"]
+#copy_scripts = ["latin"]
+num_copy_scripts = SizeOf(copy_scripts)
+code_fonts = ["mplus-1mn-light.ttf", "mplus-1mn-regular.ttf", "mplus-1mn-medium.ttf", "mplus-1mn-bold.ttf"]
+#code_fonts = []
+num_code_fonts = SizeOf(code_fonts)
+if ($argc == 2)
+  output_dir = $argv[1]
+else
+  #output_dir = "../data/fonts"
+  output_dir = "generated"
+endif
+
+fi = 0
+while (fi < num_copy_fonts)
+  new_basename = ToLower(copy_fonts[fi]:r)
+  is_mplus = Strstr(new_basename, "mplus") >= 0
+  # remove hyphen from mplus-1
+  if (is_mplus)
+    new_basename = "mplus1" + StrJoin(StrSplit(new_basename, "mplus-1"), "")
+  endif
+  si = 0
+  while (si < num_copy_scripts)
+    script = copy_scripts[si]
+    Open(copy_fonts[fi])
+    SelectAll()
+    # Remove TrueType instructions
+    ClearInstrs()
+    SelectNone()
+    # Basic Latin (e.g., English)
+    SelectMore(0u0020,0u007e)
+    # Latin-1 Supplement (covers core Western European languages)
+    SelectMore(0u00a0,0u00ff)
+    # Mathematical Operators (e.g., infinity, sum, partial differential)
+    SelectMore(0u2200,0u22ff)
+    # General Punctuation (most of it) (e.g., dashes, smart quotes, bullet)
+    SelectMore(0u2000,0u203a)
+    # Trademark sign (selected from Letterlike Symbols set)
+    SelectMore(0u2122)
+    # Geometric Shapes (e.g., list bullets)
+    SelectMore(0u25a0,0u25ff)
+    # Greek (frequently used for math and bullets)
+    SelectMore(0u0370,0u03ff)
+    # Additional Currency Symbols (QUESTION: do we need all of them in basic latin?)
+    SelectMore(0u20a0,0u20d0)
+    if (script == "latin-ext" || script == "latin-cyrillic" || script == "multilingual")
+      # Latin Extended-A, Latin Extended-B
+      SelectMore(0u0100,0u024f)
+      # IPA Extensions (i.e., core phonetics)
+      #SelectMore(0u0250,0u02af)
+      # Upside-down e (from IPA Extensions)
+      SelectMore(0u0259)
+      # Spacing Modifier Letters (e.g., diacritics)
+      SelectMore(0u02b0,0u02ff)
+      # Latin Ligatures (e.g., fi) (Noto Serif doesn't auto-detect them, so leave them off)
+      #SelectMore(0ufb00,0ufb06)
+    endif
+    if (script == "latin-cyrillic" || script == "multilingual")
+      # Cyrillic
+      SelectMore(0u0400,0u04ff)
+      # Cyrillic Supplement (QUESTION should this go in multilingual only?)
+      SelectMore(0u0500,0u052f)
+    endif
+    if (script == "multilingual")
+      # Greek Extended
+      SelectMore(0u1f00,0u1fff)
+      # Latin Extended Additional (Vietnamese, Hindi, ...)
+      SelectMore(0u1e00,0u1eff)
+    endif
+    # BOM
+    SelectMore(0ufeff)
+    # No-break space
+    SelectMore(0u00a0)
+    # Non-marking return (QUESTION do we really need this?)
+    #SelectMore(0u000d)
+    SelectInvert()
+    Clear()
+    SelectNone()
+    # Generate BOM from no-break space (for M+ fonts)
+    if (is_mplus)
+      Select(0u00a0)
+      Copy()
+      SelectNone()
+      Select(0ufeff)
+      Paste()
+      SetWidth(0)
+      SelectNone()
+    endif
+
+    # Generate line feed from no-break space (works around error "cmap format 14 is not supported" in ttfunk)
+    Select(0u00a0)
+    Copy()
+    SelectNone()
+    Select(0u000a)
+    Paste()
+    SetWidth(0)
+    SelectNone()
+
+    new_filename = new_basename + "-" + script + ".ttf"
+    new_filepath = output_dir + "/" + new_filename
+    Print("Generating " + new_filename + "...")
+    Generate(new_filepath, "", genflags)
+    Close()
+    if (is_mplus)
+      # Regenerate to drop invalid cmap format 14 table (ignore warnings)
+      Open(new_filepath)
+      Generate(new_filepath, "", genflags)
+      Close()
+    endif
+    si = si + 1
+  endloop
+  fi = fi + 1
+endloop
+
+fi = 0
+while (fi < num_code_fonts)
+  new_basename = code_fonts[fi]:r
+  # remove hyphen from mplus-1
+  new_basename = "mplus1" + StrJoin(StrSplit(new_basename, "mplus-1"), "")
+  new_suffix = "-ascii.ttf"
+  Open(code_fonts[fi])
+  SelectAll()
+  # NOTE: M+ fonts don't have hinting, so technically this is redundant
+  ClearInstrs()
+  SelectNone()
+  # Basic Latin (e.g., Code)
+  SelectMore(0u0020,0u007e)
+  # No-break space
+  SelectMore(0u00a0)
+  if (new_basename == "mplus1mn-regular")
+    # Enclosed numbers (1-20)
+    SelectMore(0u2460,0u2473)
+    new_suffix = "-ascii-conums.ttf"
+  endif
+  SelectInvert()
+  Clear()
+  SelectNone()
+  SetFontNames(new_basename, "M+ 1mn")
+  # repurpose light as italic
+  if (new_basename == "mplus1mn-light")
+    SetFontNames("mplus1mn-italic", "M+ 1mn", "M+ 1mn Italic")
+    SetOS2Value("Weight", 400)
+    SetPanose(2, 5)
+    SetTTFName(0x409, 2, "Italic")
+    SetTTFName(0x409, 16, "")
+    SetTTFName(0x409, 17, "")
+    SetTTFName(0x411, 16, "")
+    SetTTFName(0x411, 17, "")
+    new_basename = "mplus1mn-italic"
+  # repurpose medium as bold
+  elseif (new_basename == "mplus1mn-medium")
+    SetFontNames("mplus1mn-bold", "M+ 1mn", "M+ 1mn Bold")
+    SetOS2Value("Weight", 700)
+    SetPanose(2, 8)
+    SetTTFName(0x409, 2, "Bold")
+    SetTTFName(0x409, 16, "")
+    SetTTFName(0x409, 17, "")
+    SetTTFName(0x411, 16, "")
+    SetTTFName(0x411, 17, "")
+    new_basename = "mplus1mn-bold"
+  # repurpose bold as bold italic
+  elseif (new_basename == "mplus1mn-bold")
+    SetFontNames("mplus1mn-bolditalic", "M+ 1mn", "M+ 1mn Bold Italic")
+    SetOS2Value("Weight", 700)
+    SetPanose(2, 8)
+    SetTTFName(0x409, 2, "Bold Italic")
+    SetTTFName(0x409, 16, "")
+    SetTTFName(0x409, 17, "")
+    SetTTFName(0x411, 16, "")
+    SetTTFName(0x411, 17, "")
+    new_basename = "mplus1mn-bolditalic"
+  endif
+  # Generate BOM from no-break space (for M+ fonts)
+  Select(0u00a0)
+  Copy()
+  SelectNone()
+  Select(0ufeff)
+  Paste()
+  SetWidth(0)
+  SelectNone()
+  new_filename = new_basename + new_suffix
+  new_filepath = output_dir + "/" + new_filename
+  Print("Generating " + new_filename + "...")
+  Generate(new_filepath, "", genflags)
+  Close()
+  # Regenerate to drop invalid cmap format 14 table (ignore warnings)
+  Open(new_filepath)
+  Generate(new_filepath, "", genflags)
+  Close()
+  fi = fi + 1
+endloop

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: asciidoctor-epub3
+version: !ruby/object:Gem::Version
+  version: 1.0.0.alpha.1
+platform: ruby
+authors:
+- Dan Allen
+- Sarah White
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0.rc.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0.rc.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: gepub
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.9.2
+- !ruby/object:Gem::Dependency
+  name: thread_safe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+description: |
+  An extension for Asciidoctor that converts AsciiDoc documents to EPUB3 and KF8/MOBI (Kindle) e-book archives.
+email: dan@opendevise.io
+executables:
+- asciidoctor-epub3
+- adb-push-ebook
+extensions: []
+extra_rdoc_files:
+- README.adoc
+- LICENSE.adoc
+- NOTICE.adoc
+files:
+- LICENSE.adoc
+- NOTICE.adoc
+- README.adoc
+- Rakefile
+- bin/adb-push-ebook
+- bin/asciidoctor-epub3
+- data/fonts/assorted-icons.ttf
+- data/fonts/fontawesome-icons.ttf
+- data/fonts/mplus1mn-bold-ascii.ttf
+- data/fonts/mplus1mn-bolditalic-ascii.ttf
+- data/fonts/mplus1mn-italic-ascii.ttf
+- data/fonts/mplus1mn-regular-ascii-conums.ttf
+- data/fonts/mplus1p-bold-latin-cyrillic.ttf
+- data/fonts/mplus1p-bold-latin-ext.ttf
+- data/fonts/mplus1p-bold-latin.ttf
+- data/fonts/mplus1p-bold-multilingual.ttf
+- data/fonts/mplus1p-light-latin-cyrillic.ttf
+- data/fonts/mplus1p-light-latin-ext.ttf
+- data/fonts/mplus1p-light-latin.ttf
+- data/fonts/mplus1p-light-multilingual.ttf
+- data/fonts/mplus1p-regular-latin-cyrillic.ttf
+- data/fonts/mplus1p-regular-latin-ext.ttf
+- data/fonts/mplus1p-regular-latin.ttf
+- data/fonts/mplus1p-regular-multilingual.ttf
+- data/fonts/notoserif-bold-latin-cyrillic.ttf
+- data/fonts/notoserif-bold-latin-ext.ttf
+- data/fonts/notoserif-bold-latin.ttf
+- data/fonts/notoserif-bold-multilingual.ttf
+- data/fonts/notoserif-bolditalic-latin-cyrillic.ttf
+- data/fonts/notoserif-bolditalic-latin-ext.ttf
+- data/fonts/notoserif-bolditalic-latin.ttf
+- data/fonts/notoserif-bolditalic-multilingual.ttf
+- data/fonts/notoserif-italic-latin-cyrillic.ttf
+- data/fonts/notoserif-italic-latin-ext.ttf
+- data/fonts/notoserif-italic-latin.ttf
+- data/fonts/notoserif-italic-multilingual.ttf
+- data/fonts/notoserif-regular-latin-cyrillic.ttf
+- data/fonts/notoserif-regular-latin-ext.ttf
+- data/fonts/notoserif-regular-latin.ttf
+- data/fonts/notoserif-regular-multilingual.ttf
+- data/images/default-avatar.jpg
+- data/images/default-avatar.png
+- data/images/default-avatar.svg
+- data/images/default-cover-large.png
+- data/images/default-cover.png
+- data/images/default-cover.svg
+- data/images/default-headshot.jpg
+- data/images/default-headshot.png
+- data/samples/asciidoctor-epub3-readme.adoc
+- data/samples/asciidoctor-js-extension.adoc
+- data/samples/asciidoctor-js-introduction.adoc
+- data/samples/i18n.adoc
+- data/samples/images/asciidoctor-js-chrome-extension.png
+- data/samples/images/avatars/graphitefriction.png
+- data/samples/images/avatars/mogztter.png
+- data/samples/images/avatars/mojavelinux.png
+- data/samples/images/correct-text-justification.png
+- data/samples/images/incorrect-text-justification.png
+- data/samples/images/screenshots/chapter-title-day.png
+- data/samples/images/screenshots/chapter-title.png
+- data/samples/images/screenshots/figure-admonition.png
+- data/samples/images/screenshots/section-title-paragraph.png
+- data/samples/images/screenshots/sidebar.png
+- data/samples/images/screenshots/table.png
+- data/samples/images/screenshots/text.png
+- data/samples/sample-book.adoc
+- data/samples/sample-content.adoc
+- data/styles/color-palette.css
+- data/styles/epub3-css3-only.css
+- data/styles/epub3-fonts.css
+- data/styles/epub3.css
+- lib/asciidoctor-epub3.rb
+- lib/asciidoctor-epub3/converter.rb
+- lib/asciidoctor-epub3/core_ext/string.rb
+- lib/asciidoctor-epub3/font_icon_map.rb
+- lib/asciidoctor-epub3/packager.rb
+- lib/asciidoctor-epub3/spine_item_processor.rb
+- lib/asciidoctor-epub3/version.rb
+- scripts/generate-font-subsets.pe
+homepage: https://github.com/asciidoctor/asciidoctor-epub3
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8 --title="Asciidoctor EPUB3" --main=README.adoc -ri
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Converts AsciiDoc documents to EPUB3 and KF8/MOBI (Kindle) e-book formats
+test_files: []