class Asciidoctor::Converter::DocBook5Converter
A built-in {Converter} implementation that generates DocBook 5 output. The output is inspired by the output produced by the docbook45 backend from AsciiDoc.py, except it has been migrated to the DocBook 5 specification.
Constants
- CopyrightRx
- DLIST_TAGS
- ImageMacroRx
- MANPAGE_SECTION_TAGS
- QUOTE_TAGS
- TABLE_PI_NAMES
Public Class Methods
new(backend, opts = {})
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 31 def initialize backend, opts = {} @backend = backend init_backend_traits basebackend: 'docbook', filetype: 'xml', outfilesuffix: '.xml', supports_templates: true end
Public Instance Methods
convert_admonition(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 90 def convert_admonition node %(<#{tag_name = node.attr 'name'}#{common_attributes node.id, node.role, node.reftext}> #{title_tag node}#{enclose_content node} </#{tag_name}>) end
convert_colist(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 98 def convert_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.join LF end
convert_dlist(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 112 def convert_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 {|dt| result << %(<simpara>#{dt.text}</simpara>) } result << %(</entry> <entry>) if dd 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 {|dt| result << %(<#{term_tag}>#{dt.text}</#{term_tag}>) } result << %(</#{label_tag}>) if label_tag result << %(<#{item_tag}>) if dd 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.join LF end
convert_document(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 36 def convert_document node result = ['<?xml version="1.0" encoding="UTF-8"?>'] result << ((node.attr? 'toclevels') ? %(<?asciidoc-toc maxdepth="#{node.attr 'toclevels'}"?>) : '<?asciidoc-toc?>') if node.attr? 'toc' result << ((node.attr? 'sectnumlevels') ? %(<?asciidoc-numbered maxdepth="#{node.attr 'sectnumlevels'}"?>) : '<?asciidoc-numbered?>') if node.attr? 'sectnums' lang_attribute = (node.attr? 'nolang') ? '' : %( xml:lang="#{node.attr 'lang', 'en'}") if (root_tag_name = node.doctype) == 'manpage' manpage = true root_tag_name = 'article' end root_tag_idx = result.size id = node.id result << (document_info_tag node) unless node.noheader if manpage result << '<refentry>' result << '<refmeta>' result << %(<refentrytitle>#{node.apply_reftext_subs node.attr 'mantitle'}</refentrytitle>) if node.attr? 'mantitle' result << %(<manvolnum>#{node.attr 'manvolnum'}</manvolnum>) if node.attr? 'manvolnum' result << %(<refmiscinfo class="source">#{node.attr 'mansource', ' '}</refmiscinfo>) result << %(<refmiscinfo class="manual">#{node.attr 'manmanual', ' '}</refmiscinfo>) result << '</refmeta>' result << '<refnamediv>' result += (node.attr 'mannames').map {|n| %(<refname>#{n}</refname>) } if node.attr? 'mannames' result << %(<refpurpose>#{node.attr 'manpurpose'}</refpurpose>) if node.attr? 'manpurpose' result << '</refnamediv>' end unless (docinfo_content = node.docinfo :header).empty? result << docinfo_content end result << node.content if node.blocks? unless (docinfo_content = node.docinfo :footer).empty? result << docinfo_content end result << '</refentry>' if manpage id, node.id = node.id, nil unless id # defer adding root tag in case document ID is auto-generated on demand result.insert root_tag_idx, %(<#{root_tag_name} xmlns="http://docbook.org/ns/docbook" xmlns:xl="http://www.w3.org/1999/xlink" version="5.0"#{lang_attribute}#{common_attributes id}>) result << %(</#{root_tag_name}>) result.join LF end
convert_example(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 168 def convert_example node if node.title? %(<example#{common_attributes node.id, node.role, node.reftext}> <title>#{node.title}</title> #{enclose_content node} </example>) else %(<informalexample#{common_attributes node.id, node.role, node.reftext}> #{enclose_content node} </informalexample>) end end
convert_floating_title(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 181 def convert_floating_title node %(<bridgehead#{common_attributes node.id, node.role, node.reftext} renderas="sect#{node.level}">#{node.title}</bridgehead>) end
convert_image(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 185 def convert_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 = '' scale_attribute = '' 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'}") : '' #depth_attribute = (node.attr? 'height') ? %( depth="#{node.attr 'height'}") : '' scale_attribute = %( scale="#{node.attr 'scale'}") else width_attribute = (node.attr? 'width') ? %( contentwidth="#{node.attr 'width'}") : '' depth_attribute = (node.attr? 'height') ? %( contentdepth="#{node.attr 'height'}") : '' scale_attribute = '' end align_attribute = (node.attr? 'align') ? %( align="#{node.attr 'align'}") : '' 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
convert_inline_anchor(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 490 def convert_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']) %(<link xl:href="#{node.target}">#{node.text || path}</link>) else if (linkend = node.attributes['refid']).nil_or_empty? root_doc = get_root_document node # Q: should we warn instead of generating a document ID on demand? linkend = (root_doc.id ||= generate_document_id root_doc) end # NOTE the xref tag in DocBook does not support explicit link text, so the link tag must be used instead # The section at http://www.sagehill.net/docbookxsl/CrossRefs.html#IdrefLinks gives an explanation for this choice # "link - a cross reference where you supply the text of the reference as the content of the link element." (text = node.text) ? %(<link linkend="#{linkend}">#{text}</link>) : %(<xref linkend="#{linkend}"/>) end when :link %(<link xl:href="#{node.target}">#{node.text}</link>) when :bibref %(<anchor#{common_attributes node.id, nil, (text = "[#{node.reftext || node.id}]")}/>#{text}) else logger.warn %(unknown anchor type: #{node.type.inspect}) nil end end
convert_inline_break(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 518 def convert_inline_break node %(#{node.text}<?asciidoc-br?>) end
convert_inline_callout(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 526 def convert_inline_callout node %(<co#{common_attributes node.id}/>) end
convert_inline_footnote(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 530 def convert_inline_footnote node if node.type == :xref %(<footnoteref linkend="#{node.target}"/>) else %(<footnote#{common_attributes node.id}><simpara>#{node.text}</simpara></footnote>) end end
convert_inline_image(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 538 def convert_inline_image node width_attribute = (node.attr? 'width') ? %( contentwidth="#{node.attr 'width'}") : '' depth_attribute = (node.attr? 'height') ? %( contentdepth="#{node.attr 'height'}") : '' %(<inlinemediaobject#{common_attributes nil, node.role}> <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
convert_inline_indexterm(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 549 def convert_inline_indexterm node if (see = node.attr 'see') rel = %(\n<see>#{see}</see>) elsif (see_also_list = node.attr 'see-also') rel = see_also_list.map {|see_also| %(\n<seealso>#{see_also}</seealso>) }.join else rel = '' end if node.type == :visible %(<indexterm> <primary>#{node.text}</primary>#{rel} </indexterm>#{node.text}) elsif (numterms = (terms = node.attr 'terms').size) > 2 %(<indexterm> <primary>#{terms[0]}</primary><secondary>#{terms[1]}</secondary><tertiary>#{terms[2]}</tertiary>#{rel} </indexterm>#{(node.document.option? 'indexterm-promotion') ? %[ <indexterm> <primary>#{terms[1]}</primary><secondary>#{terms[2]}</secondary> </indexterm> <indexterm> <primary>#{terms[2]}</primary> </indexterm>] : ''}) elsif numterms > 1 %(<indexterm> <primary>#{terms[0]}</primary><secondary>#{terms[1]}</secondary>#{rel} </indexterm>#{(node.document.option? 'indexterm-promotion') ? %[ <indexterm> <primary>#{terms[1]}</primary> </indexterm>] : ''}) else %(<indexterm> <primary>#{terms[0]}</primary>#{rel} </indexterm>) end end
convert_inline_kbd(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 585 def convert_inline_kbd node if (keys = node.attr 'keys').size == 1 %(<keycap>#{keys[0]}</keycap>) else %(<keycombo><keycap>#{keys.join '</keycap><keycap>'}</keycap></keycombo>) end end
convert_inline_quoted(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 606 def convert_inline_quoted node if (type = node.type) == :asciimath # NOTE fop requires jeuclid to process mathml markup asciimath_available? ? %(<inlineequation>#{(::AsciiMath.parse node.text).to_mathml 'mml:', 'xmlns:mml' => 'http://www.w3.org/1998/Math/MathML'}</inlineequation>) : %(<inlineequation><mathphrase><![CDATA[#{node.text}]]></mathphrase></inlineequation>) 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
convert_listing(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 223 def convert_listing node informal = !node.title? common_attrs = common_attributes node.id, node.role, node.reftext if node.style == 'source' if (attrs = node.attributes).key? 'linenums' numbering_attrs = (attrs.key? 'start') ? %( linenumbering="numbered" startinglinenumber="#{attrs['start'].to_i}") : ' linenumbering="numbered"' else numbering_attrs = ' linenumbering="unnumbered"' end if attrs.key? 'language' wrapped_content = %(<programlisting#{informal ? common_attrs : ''} language="#{attrs['language']}"#{numbering_attrs}>#{node.content}</programlisting>) else wrapped_content = %(<screen#{informal ? common_attrs : ''}#{numbering_attrs}>#{node.content}</screen>) end else wrapped_content = %(<screen#{informal ? common_attrs : ''}>#{node.content}</screen>) end informal ? wrapped_content : %(<formalpara#{common_attrs}> <title>#{node.title}</title> <para> #{wrapped_content} </para> </formalpara>) end
convert_literal(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 248 def convert_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
convert_olist(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 292 def convert_olist node result = [] num_attribute = node.style ? %( numeration="#{node.style}") : '' start_attribute = (node.attr? 'start') ? %( startingnumber="#{node.attr 'start'}") : '' 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#{common_attributes item.id, item.role}>) result << %(<simpara>#{item.text}</simpara>) result << item.content if item.blocks? result << '</listitem>' end result << %(</orderedlist>) result.join LF end
convert_open(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 308 def convert_open node case node.style when 'abstract' if node.parent == node.document && node.document.doctype == 'book' logger.warn 'abstract block cannot be used in a document without a title when doctype is book. Excluding block content.' '' else %(<abstract> #{title_tag node}#{enclose_content node} </abstract>) end when 'partintro' if node.level == 0 && node.parent.context == :section && node.document.doctype == 'book' %(<partintro#{common_attributes node.id, node.role, node.reftext}> #{title_tag node}#{enclose_content node} </partintro>) else logger.error 'partintro block can only be used when doctype is book and must be a child of a book part. Excluding block content.' '' end else reftext = node.reftext if (id = node.id) role = node.role if node.title? %(<formalpara#{common_attributes id, role, reftext}> <title>#{node.title}</title> <para>#{content_spacer = node.content_model == :compound ? LF : ''}#{node.content}#{content_spacer}</para> </formalpara>) elsif id || role if node.content_model == :compound %(<para#{common_attributes id, role, reftext}> #{node.content} </para>) else %(<simpara#{common_attributes id, role, reftext}>#{node.content}</simpara>) end else enclose_content node end end end
convert_page_break(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 350 def convert_page_break node '<simpara><?asciidoc-pagebreak?></simpara>' end
convert_paragraph(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 354 def convert_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
convert_preamble(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 365 def convert_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
convert_quote(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 375 def convert_quote node blockquote_tag(node, (node.has_role? 'epigraph') && 'epigraph') { enclose_content node } end
convert_section(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 78 def convert_section node if node.document.doctype == 'manpage' tag_name = MANPAGE_SECTION_TAGS[tag_name = node.sectname] || tag_name else tag_name = node.sectname end title_el = node.special && ((node.option? 'notitle') || (node.option? 'untitled')) ? '' : %(<title>#{node.title}</title>\n) %(<#{tag_name}#{common_attributes node.id, node.role, node.reftext}> #{title_el}#{node.content} </#{tag_name}>) end
convert_stem(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 263 def convert_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' # NOTE fop requires jeuclid to process mathml markup equation_data = asciimath_available? ? ((::AsciiMath.parse equation).to_mathml 'mml:', 'xmlns:mml' => 'http://www.w3.org/1998/Math/MathML') : %(<mathphrase><![CDATA[#{equation}]]></mathphrase>) 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
convert_table(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 389 def convert_table node has_body = false result = [] pgwide_attribute = (node.option? 'pgwide') ? ' pgwide="1"' : '' frame = 'topbot' if (frame = node.attr 'frame', 'all', 'table-frame') == 'ends' grid = node.attr 'grid', nil, 'table-grid' result << %(<#{tag_name = node.title? ? 'table' : 'informaltable'}#{common_attributes node.id, node.role, node.reftext}#{pgwide_attribute} frame="#{frame}" rowsep="#{['none', 'cols'].include?(grid) ? 0 : 1}" colsep="#{['none', 'rows'].include?(grid) ? 0 : 1}"#{(node.attr? 'orientation', 'landscape', 'table-orientation') ? ' orient="land"' : ''}>) 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' if (width = (node.attr? 'width') ? (node.attr 'width') : nil) TABLE_PI_NAMES.each do |pi_name| result << %(<?#{pi_name} table-width="#{width}"?>) end col_width_key = 'colabswidth' else col_width_key = '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.to_h.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| colspan_attribute = cell.colspan ? %( namest="col_#{colnum = cell.column.attr 'colnumber'}" nameend="col_#{colnum + cell.colspan - 1}") : '' rowspan_attribute = cell.rowspan ? %( morerows="#{cell.rowspan - 1}") : '' # NOTE <entry> may not have whitespace (e.g., line breaks) as a direct descendant according to DocBook rules entry_start = %(<entry align="#{cell.attr 'halign'}" valign="#{cell.attr 'valign'}"#{colspan_attribute}#{rowspan_attribute}>) if tsec == :head cell_content = cell.text else case cell.style when :asciidoc cell_content = cell.content 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.join '</emphasis></simpara><simpara><emphasis role="strong">'}</emphasis></simpara>) else cell_content = (cell_content = cell.content).empty? ? '' : %(<simpara>#{cell_content.join '</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}>) logger.warn 'tables must have at least one body row' unless has_body result.join LF end
convert_thematic_break(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 379 def convert_thematic_break node '<simpara><?asciidoc-hr?></simpara>' end
convert_ulist(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 455 def convert_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}") : '' 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 = (item.attr? 'checked') ? '✓ ' : '❏ ' if checklist && (item.attr? 'checkbox') result << %(<listitem#{common_attributes item.id, item.role}>) result << %(<simpara>#{text_marker || ''}#{item.text}</simpara>) result << item.content if item.blocks? result << '</listitem>' end result << '</itemizedlist>' end result.join LF end
convert_verse(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 484 def convert_verse node blockquote_tag(node, (node.has_role? 'epigraph') && 'epigraph') { %(<literallayout>#{node.content}</literallayout>) } end
Private Instance Methods
asciimath_available?()
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 792 def asciimath_available? (@asciimath_status ||= load_asciimath) == :loaded end
blockquote_tag(node, tag_name = nil) { || ... }
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 773 def blockquote_tag node, tag_name = nil if tag_name start_tag, end_tag = %(<#{tag_name}), %(</#{tag_name}>) else start_tag, end_tag = '<blockquote', '</blockquote>' end result = [%(#{start_tag}#{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>' result << (node.attr 'attribution') if node.attr? 'attribution' result << %(<citetitle>#{node.attr 'citetitle'}</citetitle>) if node.attr? 'citetitle' result << '</attribution>' end result << yield result << end_tag result.join LF end
common_attributes(id, role = nil, reftext = nil)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 632 def common_attributes id, role = nil, reftext = nil if id attrs = %( xml:id="#{id}"#{role ? %[ role="#{role}"] : ''}) elsif role attrs = %( role="#{role}") else attrs = '' end if reftext if (reftext.include? '<') && ((reftext = reftext.gsub XmlSanitizeRx, '').include? ' ') reftext = (reftext.squeeze ' ').strip end reftext = reftext.gsub '"', '"' if reftext.include? '"' %(#{attrs} xreflabel="#{reftext}") else attrs end end
cover_tag(doc, face, use_placeholder = false)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 743 def cover_tag doc, face, use_placeholder = false if (cover_image = doc.attr %(#{face}-cover-image)) width_attr = '' depth_attr = '' if (cover_image.include? ':') && ImageMacroRx =~ cover_image attrlist = $2 cover_image = doc.image_uri $1 if attrlist attrs = (AttributeList.new attrlist).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
document_info_tag(doc)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 664 def document_info_tag doc result = ['<info>'] unless doc.notitle if (title = doc.doctitle partition: true, use_fallback: true).subtitle? result << %(<title>#{title.main}</title> <subtitle>#{title.subtitle}</subtitle>) else result << %(<title>#{title}</title>) end end if (date = (doc.attr? 'revdate') ? (doc.attr 'revdate') : ((doc.attr? 'reproducible') ? nil : (doc.attr 'docdate'))) result << %(<date>#{date}</date>) end if doc.attr? 'copyright' CopyrightRx =~ (doc.attr 'copyright') result << '<copyright>' result << %(<holder>#{$1}</holder>) result << %(<year>#{$2}</year>) if $2 result << '</copyright>' end if doc.header? unless (authors = doc.authors).empty? if authors.size > 1 result << '<authorgroup>' authors.each {|author| result << (author_tag doc, author) } result << '</authorgroup>' else result << (author_tag doc, (author = authors[0])) result << %(<authorinitials>#{author.initials}</authorinitials>) if author.initials 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 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 result << %(<orgname>#{doc.attr 'orgname'}</orgname>) if doc.attr? 'orgname' unless (docinfo_content = doc.docinfo).empty? result << docinfo_content end end result << '</info>' result.join LF end
enclose_content(node)
click to toggle source
FIXME this should be handled through a template mechanism
# File lib/asciidoctor/converter/docbook5.rb, line 735 def enclose_content node node.content_model == :compound ? node.content : %(<simpara>#{node.content}</simpara>) end
generate_document_id(doc)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 730 def generate_document_id doc %(__#{doc.doctype}-root__) end
get_root_document(node)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 723 def get_root_document node while (node = node.document).nested? node = node.parent_document end node end
load_asciimath()
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 796 def load_asciimath (defined? ::AsciiMath.parse) ? :loaded : (Helpers.require_library 'asciimath', true, :warn).nil? ? :unavailable : :loaded end
title_tag(node, optional = true)
click to toggle source
# File lib/asciidoctor/converter/docbook5.rb, line 739 def title_tag node, optional = true !optional || node.title? ? %(<title>#{node.title}</title>\n) : '' end