class Asciidoctor::Converter::DocBook5Converter

A built-in {Converter} implementation that generates DocBook 5 output similar to the docbook45 backend from AsciiDoc Python, but migrated to the DocBook 5 specification.

Constants

DLIST_TAGS
ImageMacroRx
MANPAGE_SECTION_TAGS
QUOTE_TAGS
TABLE_PI_NAMES

Public Instance Methods

admonition(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 59
    def admonition node
      %(<#{tag_name = node.attr 'name'}#{common_attributes node.id, node.role, node.reftext}>
#{title_tag node}#{resolve_content node}
</#{tag_name}>)
    end
author_element(doc, index = nil) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 644
def author_element doc, index = nil
  firstname_key = index ? %(firstname_#{index}) : 'firstname'
  middlename_key = index ? %(middlename_#{index}) : 'middlename'
  lastname_key = index ? %(lastname_#{index}) : 'lastname'
  email_key = index ? %(email_#{index}) : 'email'

  result = []
  result << '<author>'
  result << '<personname>'
  result << %(<firstname>#{doc.attr firstname_key}</firstname>) if doc.attr? firstname_key
  result << %(<othername>#{doc.attr middlename_key}</othername>) if doc.attr? middlename_key
  result << %(<surname>#{doc.attr lastname_key}</surname>) if doc.attr? lastname_key
  result << '</personname>'
  result << %(<email>#{doc.attr email_key}</email>) if doc.attr? email_key
  result << '</author>'

  result * LF
end
colist(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 67
def colist node
  result = []
  result << %(<calloutlist#{common_attributes node.id, node.role, node.reftext}>)
  result << %(<title>#{node.title}</title>) if node.title?
  node.items.each do |item|
    result << %(<callout arearefs="#{item.attr 'coids'}">)
    result << %(<para>#{item.text}</para>)
    result << item.content if item.blocks?
    result << '</callout>'
  end
  result << %(</calloutlist>)
  result * LF
end
common_attributes(id, role = nil, reftext = nil) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 663
def common_attributes id, role = nil, reftext = nil
  attrs = id ? %( xml:id="#{id}") : ''
  attrs = %(#{attrs} role="#{role}") if role
  if reftext
    if (reftext.include? '<') && ((reftext = reftext.gsub XmlSanitizeRx, '').include? ' ')
      reftext = (reftext.squeeze ' ').strip
    end
    reftext = (reftext.gsub '"', '&quot;') if reftext.include? '"'
    attrs = %(#{attrs} xreflabel="#{reftext}")
  end
  attrs
end
cover_tag(doc, face, use_placeholder = false) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 768
    def cover_tag doc, face, use_placeholder = false
      if (cover_image = doc.attr %(#{face}-cover-image))
        width_attr = nil
        depth_attr = nil
        if (cover_image.include? ':') && ImageMacroRx =~ cover_image
          cover_image = doc.image_uri $1
          unless $2.empty?
            attrs = (AttributeList.new $2).parse ['alt', 'width', 'height']
            if attrs.key? 'scaledwidth'
              # NOTE scalefit="1" is the default in this case
              width_attr = %( width="#{attrs['scaledwidth']}")
            else
              width_attr = %( contentwidth="#{attrs['width']}") if attrs.key? 'width'
              depth_attr = %( contentdepth="#{attrs['height']}") if attrs.key? 'height'
            end
          end
        end
        %(<cover role="#{face}">
<mediaobject>
<imageobject>
<imagedata fileref="#{cover_image}"#{width_attr}#{depth_attr}/>
</imageobject>
</mediaobject>
</cover>)
      elsif use_placeholder
        %(<cover role="#{face}"/>)
      end
    end
dlist(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 102
    def dlist node
      result = []
      if node.style == 'horizontal'
        result << %(<#{tag_name = node.title? ? 'table' : 'informaltable'}#{common_attributes node.id, node.role, node.reftext} tabstyle="horizontal" frame="none" colsep="0" rowsep="0">
#{title_tag node}<tgroup cols="2">
<colspec colwidth="#{node.attr 'labelwidth', 15}*"/>
<colspec colwidth="#{node.attr 'itemwidth', 85}*"/>
<tbody valign="top">)
        node.items.each do |terms, dd|
          result << %(<row>
<entry>)
          [*terms].each do |dt|
            result << %(<simpara>#{dt.text}</simpara>)
          end
          result << %(</entry>
<entry>)
          unless dd.nil?
            result << %(<simpara>#{dd.text}</simpara>) if dd.text?
            result << dd.content if dd.blocks?
          end
          result << %(</entry>
</row>)
        end
        result << %(</tbody>
</tgroup>
</#{tag_name}>)
      else
        tags = DLIST_TAGS[node.style]
        list_tag = tags[:list]
        entry_tag = tags[:entry]
        label_tag = tags[:label]
        term_tag = tags[:term]
        item_tag = tags[:item]
        if list_tag
          result << %(<#{list_tag}#{common_attributes node.id, node.role, node.reftext}>)
          result << %(<title>#{node.title}</title>) if node.title?
        end

        node.items.each do |terms, dd|
          result << %(<#{entry_tag}>)
          result << %(<#{label_tag}>) if label_tag

          [*terms].each do |dt|
            result << %(<#{term_tag}>#{dt.text}</#{term_tag}>)
          end

          result << %(</#{label_tag}>) if label_tag
          result << %(<#{item_tag}>)
          unless dd.nil?
            result << %(<simpara>#{dd.text}</simpara>) if dd.text?
            result << dd.content if dd.blocks?
          end
          result << %(</#{item_tag}>)
          result << %(</#{entry_tag}>)
        end

        result << %(</#{list_tag}>) if list_tag
      end

      result * LF
    end
doctype_declaration(root_tag_name) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 676
def doctype_declaration root_tag_name
  nil
end
document(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 8
def document node
  result = []
  if (root_tag_name = node.doctype) == 'manpage'
    root_tag_name = 'refentry'
  end
  result << '<?xml version="1.0" encoding="UTF-8"?>'
  if (doctype_line = doctype_declaration root_tag_name)
    result << doctype_line
  end
  if node.attr? 'toc'
    if node.attr? 'toclevels'
      result << %(<?asciidoc-toc maxdepth="#{node.attr 'toclevels'}"?>)
    else
      result << '<?asciidoc-toc?>'
    end
  end
  if node.attr? 'sectnums'
    if node.attr? 'sectnumlevels'
      result << %(<?asciidoc-numbered maxdepth="#{node.attr 'sectnumlevels'}"?>)
    else
      result << '<?asciidoc-numbered?>'
    end
  end
  lang_attribute = (node.attr? 'nolang') ? nil : %( #{lang_attribute_name}="#{node.attr 'lang', 'en'}")
  result << %(<#{root_tag_name}#{document_ns_attributes node}#{lang_attribute}>)
  result << (document_info_element node, root_tag_name) unless node.noheader
  result << node.content if node.blocks?
  unless (footer_docinfo = node.docinfo :footer).empty?
    result << footer_docinfo
  end
  result << %(</#{root_tag_name}>)

  result * LF
end
document_info_element(doc, info_tag_prefix, use_info_tag_prefix = false) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 680
    def document_info_element doc, info_tag_prefix, use_info_tag_prefix = false
      info_tag_prefix = nil unless use_info_tag_prefix
      result = []
      result << %(<#{info_tag_prefix}info>)
      result << document_title_tags(doc.doctitle :partition => true, :use_fallback => true) unless doc.notitle
      if (date = (doc.attr? 'revdate') ? (doc.attr 'revdate') : ((doc.attr? 'reproducible') ? nil : (doc.attr 'docdate')))
        result << %(<date>#{date}</date>)
      end
      if doc.has_header?
        if doc.attr? 'author'
          if (authorcount = (doc.attr 'authorcount').to_i) < 2
            result << (author_element doc)
            result << %(<authorinitials>#{doc.attr 'authorinitials'}</authorinitials>) if doc.attr? 'authorinitials'
          else
            result << '<authorgroup>'
            authorcount.times do |index|
              result << (author_element doc, index + 1)
            end
            result << '</authorgroup>'
          end
        end
        if (doc.attr? 'revdate') && ((doc.attr? 'revnumber') || (doc.attr? 'revremark'))
          result << %(<revhistory>
<revision>)
          result << %(<revnumber>#{doc.attr 'revnumber'}</revnumber>) if doc.attr? 'revnumber'
          result << %(<date>#{doc.attr 'revdate'}</date>) if doc.attr? 'revdate'
          result << %(<authorinitials>#{doc.attr 'authorinitials'}</authorinitials>) if doc.attr? 'authorinitials'
          result << %(<revremark>#{doc.attr 'revremark'}</revremark>) if doc.attr? 'revremark'
          result << %(</revision>
</revhistory>)
        end
        unless use_info_tag_prefix
          if (doc.attr? 'front-cover-image') || (doc.attr? 'back-cover-image')
            if (back_cover_tag = cover_tag doc, 'back')
              result << (cover_tag doc, 'front', true)
              result << back_cover_tag
            elsif (front_cover_tag = cover_tag doc, 'front')
              result << front_cover_tag
            end
          end
        end
        unless (head_docinfo = doc.docinfo).empty?
          result << head_docinfo
        end
        result << %(<orgname>#{doc.attr 'orgname'}</orgname>) if doc.attr? 'orgname'
      end
      result << %(</#{info_tag_prefix}info>)

      if doc.doctype == 'manpage'
        result << '<refmeta>'
        result << %(<refentrytitle>#{doc.attr 'mantitle'}</refentrytitle>) if doc.attr? 'mantitle'
        result << %(<manvolnum>#{doc.attr 'manvolnum'}</manvolnum>) if doc.attr? 'manvolnum'
        result << '</refmeta>'
        result << '<refnamediv>'
        result << %(<refname>#{doc.attr 'manname'}</refname>) if doc.attr? 'manname'
        result << %(<refpurpose>#{doc.attr 'manpurpose'}</refpurpose>) if doc.attr? 'manpurpose'
        result << '</refnamediv>'
      end

      result * LF
    end
document_ns_attributes(doc) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 742
def document_ns_attributes doc
  ' xmlns="http://docbook.org/ns/docbook" xmlns:xl="http://www.w3.org/1999/xlink" version="5.0"'
end
document_title_tags(title) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 750
    def document_title_tags title
      if title.subtitle?
        %(<title>#{title.main}</title>
<subtitle>#{title.subtitle}</subtitle>)
      else
        %(<title>#{title}</title>)
      end
    end
example(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 164
    def example node
      if node.title?
        %(<example#{common_attributes node.id, node.role, node.reftext}>
<title>#{node.title}</title>
#{resolve_content node}
</example>)
      else
        %(<informalexample#{common_attributes node.id, node.role, node.reftext}>
#{resolve_content node}
</informalexample>)
      end
    end
floating_title(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 177
def floating_title node
  %(<bridgehead#{common_attributes node.id, node.role, node.reftext} renderas="sect#{node.level}">#{node.title}</bridgehead>)
end
image(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 181
    def image node
      # NOTE according to the DocBook spec, content area, scaling, and scaling to fit are mutually exclusive
      # See http://tdg.docbook.org/tdg/4.5/imagedata-x.html#d0e79635
      if node.attr? 'scaledwidth'
        width_attribute = %( width="#{node.attr 'scaledwidth'}")
        depth_attribute = nil
        scale_attribute = nil
      elsif node.attr? 'scale'
        # QUESTION should we set the viewport using width and depth? (the scaled image would be contained within this box)
        #width_attribute = (node.attr? 'width') ? %( width="#{node.attr 'width'}") : nil
        #depth_attribute = (node.attr? 'height') ? %( depth="#{node.attr 'height'}") : nil
        scale_attribute = %( scale="#{node.attr 'scale'}")
      else
        width_attribute = (node.attr? 'width') ? %( contentwidth="#{node.attr 'width'}") : nil
        depth_attribute = (node.attr? 'height') ? %( contentdepth="#{node.attr 'height'}") : nil
        scale_attribute = nil
      end
      align_attribute = (node.attr? 'align') ? %( align="#{node.attr 'align'}") : nil

      mediaobject = %(<mediaobject>
<imageobject>
<imagedata fileref="#{node.image_uri(node.attr 'target')}"#{width_attribute}#{depth_attribute}#{scale_attribute}#{align_attribute}/>
</imageobject>
<textobject><phrase>#{node.alt}</phrase></textobject>
</mediaobject>)

      if node.title?
        %(<figure#{common_attributes node.id, node.role, node.reftext}>
<title>#{node.title}</title>
#{mediaobject}
</figure>)
      else
        %(<informalfigure#{common_attributes node.id, node.role, node.reftext}>
#{mediaobject}
</informalfigure>)
      end
    end
inline_anchor(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 507
def inline_anchor node
  case node.type
  when :ref
    %(<anchor#{common_attributes((id = node.id), nil, node.reftext || %([#{id}]))}/>)
  when :xref
    if (path = node.attributes['path'])
      # QUESTION should we use refid as fallback text instead? (like the html5 backend?)
      %(<link xl:href="#{node.target}">#{node.text || path}</link>)
    else
      linkend = node.attributes['fragment'] || node.target
      (text = node.text) ? %(<link linkend="#{linkend}">#{text}</link>) : %(<xref linkend="#{linkend}"/>)
    end
  when :link
    %(<link xl:href="#{node.target}">#{node.text}</link>)
  when :bibref
    # NOTE technically node.text should be node.reftext, but subs have already been applied to text
    %(<anchor#{common_attributes node.id, nil, (text = node.text)}/>#{text})
  else
    warn %(asciidoctor: WARNING: unknown anchor type: #{node.type.inspect})
  end
end
inline_break(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 529
def inline_break node
  %(#{node.text}<?asciidoc-br?>)
end
inline_button(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 533
def inline_button node
  %(<guibutton>#{node.text}</guibutton>)
end
inline_callout(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 537
def inline_callout node
  %(<co#{common_attributes node.id}/>)
end
inline_footnote(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 541
def inline_footnote node
  if node.type == :xref
    %(<footnoteref linkend="#{node.target}"/>)
  else
    %(<footnote#{common_attributes node.id}><simpara>#{node.text}</simpara></footnote>)
  end
end
inline_image(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 549
    def inline_image node
      width_attribute = (node.attr? 'width') ? %( contentwidth="#{node.attr 'width'}") : nil
      depth_attribute = (node.attr? 'height') ? %( contentdepth="#{node.attr 'height'}") : nil
      %(<inlinemediaobject>
<imageobject>
<imagedata fileref="#{node.type == 'icon' ? (node.icon_uri node.target) : (node.image_uri node.target)}"#{width_attribute}#{depth_attribute}/>
</imageobject>
<textobject><phrase>#{node.alt}</phrase></textobject>
</inlinemediaobject>)
    end
inline_indexterm(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 560
    def inline_indexterm node
      if node.type == :visible
        %(<indexterm><primary>#{node.text}</primary></indexterm>#{node.text})
      else
        terms = node.attr 'terms'
        result = []
        if (numterms = terms.size) > 2
          result << %(<indexterm>
<primary>#{terms[0]}</primary><secondary>#{terms[1]}</secondary><tertiary>#{terms[2]}</tertiary>
</indexterm>)
        end
        if numterms > 1
          result << %(<indexterm>
<primary>#{terms[-2]}</primary><secondary>#{terms[-1]}</secondary>
</indexterm>)
        end
        result << %(<indexterm>
<primary>#{terms[-1]}</primary>
</indexterm>)
        result * LF
      end
    end
inline_kbd(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 583
def inline_kbd node
  if (keys = node.attr 'keys').size == 1
    %(<keycap>#{keys[0]}</keycap>)
  else
    %(<keycombo><keycap>#{keys * '</keycap><keycap>'}</keycap></keycombo>)
  end
end
inline_menu(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 591
def inline_menu node
  menu = node.attr 'menu'
  if (submenus = node.attr 'submenus').empty?
    if (menuitem = node.attr 'menuitem', nil, false)
      %(<menuchoice><guimenu>#{menu}</guimenu> <guimenuitem>#{menuitem}</guimenuitem></menuchoice>)
    else
      %(<guimenu>#{menu}</guimenu>)
    end
  else
    %(<menuchoice><guimenu>#{menu}</guimenu> <guisubmenu>#{submenus * '</guisubmenu> <guisubmenu>'}</guisubmenu> <guimenuitem>#{node.attr 'menuitem'}</guimenuitem></menuchoice>)
  end
end
inline_quoted(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 615
def inline_quoted node
  if (type = node.type) == :asciimath
    if ((defined? ::AsciiMath) || ((defined? @asciimath_available) ? @asciimath_available :
        (@asciimath_available = Helpers.require_library 'asciimath', true, :warn)))
      # NOTE fop requires jeuclid to process raw mathml
      %(<inlineequation>#{(::AsciiMath.parse node.text).to_mathml 'mml:', 'xmlns:mml' => 'http://www.w3.org/1998/Math/MathML'}</inlineequation>)
    else
      %(<inlineequation><mathphrase><![CDATA[#{node.text}]]></mathphrase></inlineequation>)
    end
  elsif type == :latexmath
    # unhandled math; pass source to alt and required mathphrase element; dblatex will process alt as LaTeX math
    %(<inlineequation><alt><![CDATA[#{equation = node.text}]]></alt><mathphrase><![CDATA[#{equation}]]></mathphrase></inlineequation>)
  else
    open, close, supports_phrase = QUOTE_TAGS[type]
    text = node.text
    if node.role
      if supports_phrase
        quoted_text = %(#{open}<phrase role="#{node.role}">#{text}</phrase>#{close})
      else
        quoted_text = %(#{open.chop} role="#{node.role}">#{text}#{close})
      end
    else
      quoted_text = %(#{open}#{text}#{close})
    end

    node.id ? %(<anchor#{common_attributes node.id, nil, text}/>#{quoted_text}) : quoted_text
  end
end
lang_attribute_name() click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 746
def lang_attribute_name
  'xml:lang'
end
listing(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 219
    def listing node
      informal = !node.title?
      listing_attributes = (common_attributes node.id, node.role, node.reftext)
      if node.style == 'source' && (node.attr? 'language')
        numbering = (node.attr? 'linenums', nil, false) ? 'numbered' : 'unnumbered'
        listing_content = %(<programlisting#{informal ? listing_attributes : nil} language="#{node.attr 'language', nil, false}" linenumbering="#{numbering}">#{node.content}</programlisting>)
      else
        listing_content = %(<screen#{informal ? listing_attributes : nil}>#{node.content}</screen>)
      end
      if informal
        listing_content
      else
        %(<formalpara#{listing_attributes}>
<title>#{node.title}</title>
<para>
#{listing_content}
</para>
</formalpara>)
      end
    end
literal(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 240
    def literal node
      if node.title?
        %(<formalpara#{common_attributes node.id, node.role, node.reftext}>
<title>#{node.title}</title>
<para>
<literallayout class="monospaced">#{node.content}</literallayout>
</para>
</formalpara>)
      else
        %(<literallayout#{common_attributes node.id, node.role, node.reftext} class="monospaced">#{node.content}</literallayout>)
      end
    end
olist(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 287
def olist node
  result = []
  num_attribute = node.style ? %( numeration="#{node.style}") : nil
  start_attribute = (node.attr? 'start') ? %( startingnumber="#{node.attr 'start'}") : nil
  result << %(<orderedlist#{common_attributes node.id, node.role, node.reftext}#{num_attribute}#{start_attribute}>)
  result << %(<title>#{node.title}</title>) if node.title?
  node.items.each do |item|
    result << '<listitem>'
    result << %(<simpara>#{item.text}</simpara>)
    result << item.content if item.blocks?
    result << '</listitem>'
  end
  result << %(</orderedlist>)
  result * LF
end
open(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 303
    def open node
      case node.style
      when 'abstract'
        if node.parent == node.document && node.document.doctype == 'book'
          warn 'asciidoctor: WARNING: abstract block cannot be used in a document without a title when doctype is book. Excluding block content.'
          ''
        else
          %(<abstract>
#{title_tag node}#{resolve_content node}
</abstract>)
        end
      when 'partintro'
        unless node.level == 0 && node.parent.context == :section && node.document.doctype == 'book'
          warn 'asciidoctor: ERROR: partintro block can only be used when doctype is book and it\'s a child of a part section. Excluding block content.'
          ''
        else
          %(<partintro#{common_attributes node.id, node.role, node.reftext}>
#{title_tag node}#{resolve_content node}
</partintro>)
        end
      else
        node.content
      end
    end
page_break(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 328
def page_break node
  '<simpara><?asciidoc-pagebreak?></simpara>'
end
paragraph(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 332
    def paragraph node
      if node.title?
        %(<formalpara#{common_attributes node.id, node.role, node.reftext}>
<title>#{node.title}</title>
<para>#{node.content}</para>
</formalpara>)
      else
        %(<simpara#{common_attributes node.id, node.role, node.reftext}>#{node.content}</simpara>)
      end
    end
preamble(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 343
    def preamble node
      if node.document.doctype == 'book'
        %(<preface#{common_attributes node.id, node.role, node.reftext}>
#{title_tag node, false}#{node.content}
</preface>)
      else
        node.content
      end
    end
quote(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 353
def quote node
  result = []
  result << %(<blockquote#{common_attributes node.id, node.role, node.reftext}>)
  result << %(<title>#{node.title}</title>) if node.title?
  if (node.attr? 'attribution') || (node.attr? 'citetitle')
    result << '<attribution>'
    if node.attr? 'attribution'
      result << (node.attr 'attribution')
    end
    if node.attr? 'citetitle'
      result << %(<citetitle>#{node.attr 'citetitle'}</citetitle>)
    end
    result << '</attribution>'
  end
  result << (resolve_content node)
  result << '</blockquote>'
  result * LF
end
resolve_content(node) click to toggle source

FIXME this should be handled through a template mechanism

# File lib/asciidoctor/converter/docbook5.rb, line 760
def resolve_content node
  node.content_model == :compound ? node.content : %(<simpara>#{node.content}</simpara>)
end
section(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 47
    def section node
      if node.document.doctype == 'manpage'
        tag_name = MANPAGE_SECTION_TAGS[tag_name = node.sectname] || tag_name
      else
        tag_name = node.sectname
      end
      %(<#{tag_name}#{common_attributes node.id, node.role, node.reftext}>
<title>#{node.title}</title>
#{node.content}
</#{tag_name}>)
    end
sidebar(node) click to toggle source
stem(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 253
    def stem node
      if (idx = node.subs.index :specialcharacters)
        node.subs.delete_at idx
        equation = node.content
        idx > 0 ? (node.subs.insert idx, :specialcharacters) : (node.subs.unshift :specialcharacters)
      else
        equation = node.content
      end
      if node.style == 'asciimath'
        if ((defined? ::AsciiMath) || ((defined? @asciimath_available) ? @asciimath_available :
            (@asciimath_available = Helpers.require_library 'asciimath', true, :warn)))
          # NOTE fop requires jeuclid to process raw mathml
          equation_data = (::AsciiMath.parse equation).to_mathml 'mml:', 'xmlns:mml' => 'http://www.w3.org/1998/Math/MathML'
        else
          equation_data = %(<mathphrase><![CDATA[#{equation}]]></mathphrase>)
        end
      else
        # unhandled math; pass source to alt and required mathphrase element; dblatex will process alt as LaTeX math
        equation_data = %(<alt><![CDATA[#{equation}]]></alt>
<mathphrase><![CDATA[#{equation}]]></mathphrase>)
      end
      if node.title?
        %(<equation#{common_attributes node.id, node.role, node.reftext}>
<title>#{node.title}</title>
#{equation_data}
</equation>)
      else
        # WARNING dblatex displays the <informalequation> element inline instead of block as documented (except w/ mathml)
        %(<informalequation#{common_attributes node.id, node.role, node.reftext}>
#{equation_data}
</informalequation>)
      end
    end
table(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 384
def table node
  has_body = false
  result = []
  pgwide_attribute = (node.option? 'pgwide') ? ' pgwide="1"' : nil
  result << %(<#{tag_name = node.title? ? 'table' : 'informaltable'}#{common_attributes node.id, node.role, node.reftext}#{pgwide_attribute} frame="#{node.attr 'frame', 'all'}" rowsep="#{['none', 'cols'].include?(node.attr 'grid') ? 0 : 1}" colsep="#{['none', 'rows'].include?(node.attr 'grid') ? 0 : 1}"#{(node.attr? 'orientation', 'landscape', nil) ? ' orient="land"' : nil}>)
  if (node.option? 'unbreakable')
    result << '<?dbfo keep-together="always"?>'
  elsif (node.option? 'breakable')
    result << '<?dbfo keep-together="auto"?>'
  end
  result << %(<title>#{node.title}</title>) if tag_name == 'table'
  col_width_key = if (width = (node.attr? 'width') ? (node.attr 'width') : nil)
    TABLE_PI_NAMES.each do |pi_name|
      result << %(<?#{pi_name} table-width="#{width}"?>)
    end
    'colabswidth'
  else
    'colpcwidth'
  end
  result << %(<tgroup cols="#{node.attr 'colcount'}">)
  node.columns.each do |col|
    result << %(<colspec colname="col_#{col.attr 'colnumber'}" colwidth="#{col.attr col_width_key}*"/>)
  end
  node.rows.by_section.each do |tsec, rows|
    next if rows.empty?
    has_body = true if tsec == :body
    result << %(<t#{tsec}>)
    rows.each do |row|
      result << '<row>'
      row.each do |cell|
        halign_attribute = (cell.attr? 'halign') ? %( align="#{cell.attr 'halign'}") : nil
        valign_attribute = (cell.attr? 'valign') ? %( valign="#{cell.attr 'valign'}") : nil
        colspan_attribute = cell.colspan ? %( namest="col_#{colnum = cell.column.attr 'colnumber'}" nameend="col_#{colnum + cell.colspan - 1}") : nil
        rowspan_attribute = cell.rowspan ? %( morerows="#{cell.rowspan - 1}") : nil
        # NOTE <entry> may not have whitespace (e.g., line breaks) as a direct descendant according to DocBook rules
        entry_start = %(<entry#{halign_attribute}#{valign_attribute}#{colspan_attribute}#{rowspan_attribute}>)
        if tsec == :head
          cell_content = cell.text
        else
          case cell.style
          when :asciidoc
            cell_content = cell.content
          when :verse
            cell_content = %(<literallayout>#{cell.text}</literallayout>)
          when :literal
            cell_content = %(<literallayout class="monospaced">#{cell.text}</literallayout>)
          when :header
            cell_content = (cell_content = cell.content).empty? ? '' : %(<simpara><emphasis role="strong">#{cell_content * '</emphasis></simpara><simpara><emphasis role="strong">'}</emphasis></simpara>)
          else
            cell_content = (cell_content = cell.content).empty? ? '' : %(<simpara>#{cell_content * '</simpara><simpara>'}</simpara>)
          end
        end
        entry_end = (node.document.attr? 'cellbgcolor') ? %(<?dbfo bgcolor="#{node.document.attr 'cellbgcolor'}"?></entry>) : '</entry>'
        result << %(#{entry_start}#{cell_content}#{entry_end})
      end
      result << '</row>'
    end
    result << %(</t#{tsec}>)
  end
  result << '</tgroup>'
  result << %(</#{tag_name}>)

  warn 'asciidoctor: WARNING: tables must have at least one body row' unless has_body
  result * LF
end
thematic_break(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 372
def thematic_break node
  '<simpara><?asciidoc-hr?></simpara>'
end
title_tag(node, optional = true) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 764
def title_tag node, optional = true
  !optional || node.title? ? %(<title>#{node.title}</title>\n) : nil
end
ulist(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 452
def ulist node
  result = []
  if node.style == 'bibliography'
    result << %(<bibliodiv#{common_attributes node.id, node.role, node.reftext}>)
    result << %(<title>#{node.title}</title>) if node.title?
    node.items.each do |item|
      result << '<bibliomixed>'
      result << %(<bibliomisc>#{item.text}</bibliomisc>)
      result << item.content if item.blocks?
      result << '</bibliomixed>'
    end
    result << '</bibliodiv>'
  else
    mark_type = (checklist = node.option? 'checklist') ? 'none' : node.style
    mark_attribute = mark_type ? %( mark="#{mark_type}") : nil
    result << %(<itemizedlist#{common_attributes node.id, node.role, node.reftext}#{mark_attribute}>)
    result << %(<title>#{node.title}</title>) if node.title?
    node.items.each do |item|
      text_marker = if checklist && (item.attr? 'checkbox')
        (item.attr? 'checked') ? '&#10003; ' : '&#10063; '
      else
        nil
      end
      result << '<listitem>'
      result << %(<simpara>#{text_marker}#{item.text}</simpara>)
      result << item.content if item.blocks?
      result << '</listitem>'
    end
    result << '</itemizedlist>'
  end

  result * LF
end
verse(node) click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 486
def verse node
  result = []
  result << %(<blockquote#{common_attributes node.id, node.role, node.reftext}>)
  result << %(<title>#{node.title}</title>) if node.title?
  if (node.attr? 'attribution') || (node.attr? 'citetitle')
    result << '<attribution>'
    if node.attr? 'attribution'
      result << (node.attr 'attribution')
    end
    if node.attr? 'citetitle'
      result << %(<citetitle>#{node.attr 'citetitle'}</citetitle>)
    end
    result << '</attribution>'
  end
  result << %(<literallayout>#{node.content}</literallayout>)
  result << '</blockquote>'
  result * LF
end