dbtoepub #1

  • //
  • guest/
  • paul_allen/
  • p4convert-maven/
  • docs/
  • docbook-xsl-ns-1.78.1/
  • epub/
  • bin/
  • dbtoepub
  • View
  • Commits
  • Open Download .zip Download (3 KB)
#!/usr/bin/env ruby
# This program converts DocBook documents into .epub files.
# 
# Usage: dbtoepub [OPTIONS] [DocBook Files]
#
# .epub is defined by the IDPF at www.idpf.org and is made up of 3 standards:
# - Open Publication Structure (OPS)
# - Open Packaging Format (OPF) 
# - Open Container Format (OCF)
#
# Specific options:
#     -c, --css [FILE]                 Use FILE for CSS on generated XHTML.
#     -d, --debug                      Show debugging output.
#     -f, --font [OTF FILE]            Embed OTF FILE in .epub.
#     -h, --help                       Display usage info.
#     -s, --stylesheet [XSL FILE]      Use XSL FILE as a customization
#                                        layer (imports epub/docbook.xsl).
#     -v, --verbose                    Make output verbose.

lib = File.expand_path(File.join(File.dirname(__FILE__), 'lib'))
$LOAD_PATH.unshift(lib) if File.exist?(lib)

require 'fileutils'
require 'optparse'
require 'tmpdir'

require 'docbook'

verbose = false
debug = false
css_file = nil
otf_files = []
customization_layer = nil
output_file = nil

#$DEBUG=true

# Set up the OptionParser
opts = OptionParser.new
opts.banner = "Usage: #{File.basename($0)} [OPTIONS] [DocBook Files]

#{File.basename($0)} converts DocBook <book> and <article>s into to .epub files.

.epub is defined by the IDPF at www.idpf.org and is made up of 3 standards:
- Open Publication Structure (OPS)
- Open Packaging Format (OPF) 
- Open Container Format (OCF)

Specific options:"
opts.on("-c", "--css [FILE]", "Use FILE for CSS on generated XHTML.") {|f| css_file = f}
opts.on("-d", "--debug", "Show debugging output.") {debug = true; verbose = true}
opts.on("-f", "--font [OTF FILE]", "Embed OTF FILE in .epub.") {|f| otf_files << f}
opts.on("-h", "--help", "Display usage info.") {puts opts.to_s; exit 0}
opts.on("-o", "--output [OUTPUT FILE]", "Output ePub file as OUTPUT FILE.") {|f| output_file = f}
opts.on("-s", "--stylesheet [XSL FILE]", "Use XSL FILE as a customization layer (imports epub/docbook.xsl).") {|f| customization_layer = f}
opts.on("-v", "--verbose", "Make output verbose.") {verbose = true}

db_files = opts.parse(ARGV)
if db_files.size == 0
  puts opts.to_s
  exit 0
end

db_files.each {|docbook_file|
  dir = File.expand_path(File.join(Dir.tmpdir, ".epubtmp#{Time.now.to_f.to_s}"))
  FileUtils.mkdir_p(dir)
  e = DocBook::Epub.new(docbook_file, dir, css_file, customization_layer, otf_files)

  if output_file
    epub_file = output_file
  else  
    epub_file = File.basename(docbook_file, ".xml") + ".epub"
  end  
  puts "Rendering DocBook file #{docbook_file} to #{epub_file}" if verbose
  e.render_to_file(epub_file)
}  
# Change User Description Committed
#1 13895 Paul Allen Copying using p4convert-docbook
//guest/perforce_software/doc_build/main/docbook-xsl-ns-1.78.1/epub/bin/dbtoepub
#1 12728 eedwards Upgrade ANT doc build infrastructure to assemble PDFs:

- remove non-namespaced DocBook source and add
  namespaced DocBook source.

- add Apache FOP 1.1

- copy fonts, images, XSL into _build, establishing new
  asset structure. The original structure remains until
  all guides using it can be upgraded, and several other
  issues can be resolved.

- updated build.xml to allow for per-target build properties.

- upgraded the P4SAG to use the new infrastructure.

- tweaked admonition presentation in PDFs to remove
  admonition graphics, and resemble closely the
  presentation used in the new HTML layout, including
  the same colors.

With these changes, building PDFs involves using a
shell, navigating into the guide's directory (just P4SAG
for now), and executing "ant pdf".

Issues still to be resolved:

- PDF generation encounters several warnings about
  missing fonts (bold versions of Symbol and ZapfDingbats),
  and a couple of locations where the page content
  exceeds the defined content area.

- Due to issues within Apache FOP, PDF generation emits
  a substantial amount of output that is not easily suppressed
  without losing important warning information.

- Apache FOP's interface to ANT does not expose a way
  to set the font base directory. The current configuration does
  work under Mac OSX, but further testing on Windows will
  need to be done to determine if the relative paths defined
  continue to work. The workaround is for Windows users to
  customize the fop-config.xml to provide absolute system
  paths to the required fonts.

- HTML generation needs further browser testing, and
  exhibits broken navigation on iOS browsers within the
  TOC sidebar.

- A number of PDF and HTML presentation tweaks still
  need to be made, for example: sidebars, gui* DocBook
  tags, whitespace, section separation, etc.