Module: Asciidoctor::Rfc::V2::Base
- Included in:
- Converter
- Defined in:
- lib/asciidoctor/rfc/v2/base.rb
Instance Method Summary collapse
-
#cleanup(doc) ⇒ Object
clean up XML.
-
#document(node) ⇒ Object
Syntax: =Title Author :status :consensus :name :number.
-
#image(node) ⇒ Object
Syntax: [[id]] .Name [link=xxx,align=left|center|right,alt=alt_text,type] image::filename.
- #inline_break(node) ⇒ Object
- #inline_quoted(node) ⇒ Object
- #merge_vspace(node) ⇒ Object
-
#para_to_vspace(doc) ⇒ Object
replace any <t>text</t> instances with <vspace blankLines=“1”/>text.
-
#paragraph(node) ⇒ Object
Syntax: [[id]] Text.
- #resolve_references(node, doc) ⇒ Object
-
#section(node) ⇒ Object
Syntax: [[id]] == title Content.
- #verse(node) ⇒ Object
Instance Method Details
#cleanup(doc) ⇒ Object
clean up XML
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 |
# File 'lib/asciidoctor/rfc/v2/base.rb', line 289 def cleanup(doc) xmldoc = Nokogiri::XML(doc) do |config| config.noent end # any crefs that are direct children of section should become children of the preceding # paragraph, if it exists; otherwise, they need to be wrapped in a paragraph crefs = xmldoc.xpath("//cref") crefs.each do |cref| if cref.parent.name == "section" prev = cref.previous_element if !prev.nil? && prev.name == "t" cref.parent = prev else t = Nokogiri::XML::Element.new("t", xmldoc) cref.before(t) cref.parent = t end end end # any instances of spanx must be stripped of any internal tags spanxs = xmldoc.xpath("//spanx[descendant::*]") while !spanxs.empty? spanx = spanxs[0] spanx_text = "" spanx.traverse do |node| spanx_text = spanx_text + node.text.gsub(/<[^>]+>/, "") if node.text? end spanx.children = spanx_text spanxs = xmldoc.xpath("//spanx[descendant::*]") end xmldoc.root = merge_vspace(xmldoc.root) xmldoc = smart_quote_cleanup(xmldoc) unless $smart_quotes xmldoc.to_xml(encoding: "US-ASCII") end |
#document(node) ⇒ Object
Syntax:
=Title
Author
:status
:consensus
:name
:number
:ipr
:obsoletes
:updates
:submissionType
:indexInclude
:ipr-extract
:sort-refs
:sym-refs
:toc-include
ABSTRACT
NOTEs
==first title
CONTENT
[bibliography] # start of back matter
== Bibliography
[appendix] # start of back matter if not already started
== Appendix
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/asciidoctor/rfc/v2/base.rb', line 39 def document(node) $seen_back_matter = false $smart_quotes = (node.attr("smart-quotes") != "false") $inline_definition_lists = (node.attr("inline-definition-lists") == "true") result = [] result << '<?xml version="1.0" encoding="UTF-8"?>' is_rfc = node.attr("doctype") == "rfc" consensus_value = { "false" => "no", "true" => "yes", }[node.attr("consensus")] || node.attr("consensus") category = node.attr("status") category = "info" if category == "informational" category = "std" if category == "standard" category = "exp" if category == "experimental" rfc_attributes = { ipr: node.attr("ipr"), obsoletes: node.attr("obsoletes"), updates: node.attr("updates"), category: category, consensus: consensus_value, submissionType: node.attr("submission-type") || "IETF", iprExtract: node.attr("ipr-extract"), docName: (node.attr("name") unless is_rfc), number: (node.attr("name") if is_rfc), seriesNo: node.attr("series-no"), "xml:lang": node.attr("xml-lang"), } rfc_open = noko { |xml| xml.rfc **attr_code(rfc_attributes) }.join.gsub(/\/>$/, ">") result << rfc_open result << noko { |xml| front node, xml } result.last.last.gsub! /<\/front>$/, "" # FIXME: this is a hack! result << "</front><middle1>" result << node.content if node.blocks? result << ($seen_back_matter ? "</back>" : "</middle>") result << "</rfc>" # <middle> needs to move after preamble result = result.flatten result = if result.any? { |e| e =~ /<\/front><middle>/ } && result.any? { |e| e =~ /<\/front><middle1>/ } result.reject { |e| e =~ /<\/front><middle1>/ } else result.map { |e| e =~ /<\/front><middle1>/ ? "</front><middle>" : e } end ret = result * "\n" ret = cleanup(ret) ret1 = Nokogiri::XML(ret) ret1 = set_pis(node, ret1) ret1 = insert_biblio(node, ret1) unless node.attr("biblio-dir").nil? || node.attr("biblio-dir").empty? Asciidoctor::Rfc::Common::Validate::validate(ret1, File.join(File.dirname(__FILE__), "validate.rng")) ret1 = resolve_references(node, ret1) ret1.to_xml end |
#image(node) ⇒ Object
Note:
ignoring width, height attributes
Syntax:
[[id]]
.Name
[link=xxx,align=left|center|right,alt=alt_text,type]
image::filename[alt_text,width,height]
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 |
# File 'lib/asciidoctor/rfc/v2/base.rb', line 262 def image(node) uri = node.image_uri node.attr("target") artwork_attributes = { align: node.attr("align"), alt: node.alt, height: node.attr("height"), name: node.title, src: uri, type: node.attr("type"), width: node.attr("width"), } noko do |xml| if node.parent.context != :example figure_attributes = { anchor: node.id, } xml.figure **attr_code(figure_attributes) do |xml_figure| xml_figure.artwork **attr_code(artwork_attributes) end else xml.artwork **attr_code(artwork_attributes) end end end |
#inline_break(node) ⇒ Object
112 113 114 115 116 117 |
# File 'lib/asciidoctor/rfc/v2/base.rb', line 112 def inline_break(node) noko do |xml| xml << node.text xml.vspace end.join end |
#inline_quoted(node) ⇒ Object
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 |
# File 'lib/asciidoctor/rfc/v2/base.rb', line 119 def inline_quoted(node) noko do |xml| case node.type when :emphasis xml.spanx node.text, style: "emph" when :strong xml.spanx node.text, style: "strong" when :monospaced xml.spanx node.text, style: "verb" when :double xml << ($smart_quotes ? "“#{node.text}”" : "\"#{node.text}\"") when :single xml << ($smart_quotes ? "‘#{node.text}’" : "'#{node.text}'") when :superscript xml << "^#{node.text}^" when :subscript xml << "_#{node.text}_" else # [bcp14]#MUST NOT# if node.role == "bcp14" xml.spanx node.text.upcase, style: "strong" elsif node.role == "comment" xml.comment " " + node.text + " " else xml << node.text end end end.join end |
#merge_vspace(node) ⇒ Object
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 |
# File 'lib/asciidoctor/rfc/v2/base.rb', line 326 def merge_vspace(node) nodes = [] newnodes = [] node.children.each do |element| nodes << element end counter = 0 while counter < nodes.size if nodes[counter].name == "vspace" blankLines = 0 while counter < nodes.size && nodes[counter].name == "vspace" blankLines += 1 if nodes[counter][:blankLines].nil? blankLines += nodes[counter][:blankLines].to_i end if counter + 1 < nodes.size && nodes[counter + 1].text? && nodes[counter + 1].text =~ /\A[\n ]+\Z/m counter += 1 end counter += 1 end counter -= 1 if counter == nodes.size newnodes << noko do |xml| xml.vspace **attr_code(blankLines: (blankLines - 1)) end.join else newnodes << merge_vspace(nodes[counter]) counter += 1 end end node.children.remove newnodes.each do |item| node.add_child(item) end node end |
#para_to_vspace(doc) ⇒ Object
replace any <t>text</t> instances with <vspace blankLines=“1”/>text
364 365 366 367 368 369 370 371 372 373 374 375 376 377 |
# File 'lib/asciidoctor/rfc/v2/base.rb', line 364 def para_to_vspace(doc) xmldoc = Nokogiri::XML("<fragment>#{doc}</fragment>") paras = xmldoc.xpath("/fragment/t") paras.each do |para| # we do not insert vspace if the para contains a list: space will go there anyway unless para.element_children.size == 1 && para.element_children[0].name == "list" vspace = Nokogiri::XML::Element.new("vspace", xmldoc.document) vspace["blankLines"] = "1" para.before(vspace) end para.replace(para.children) end xmldoc.root.children.to_xml(encoding: "US-ASCII") end |
#paragraph(node) ⇒ Object
Syntax:
[[id]]
Text
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/asciidoctor/rfc/v2/base.rb', line 152 def paragraph(node) if node.role == "comment" return noko do |xml| xml.comment " " + [flatten_rawtext(node)].flatten.join("\n") + " " end.join("\n") end t_attributes = { anchor: node.id, } noko do |xml| xml.t **attr_code(t_attributes) do |xml_t| xml_t << node.content end end.join("\n") end |
#resolve_references(node, doc) ⇒ Object
102 103 104 105 106 107 108 109 110 |
# File 'lib/asciidoctor/rfc/v2/base.rb', line 102 def resolve_references(node, doc) extract_entities(node, doc).each do |entity| Nokogiri::XML::EntityDecl::new(entity[:entity], doc, Nokogiri::XML::EntityDecl::EXTERNAL_GENERAL_PARSED, nil, entity[:url], nil) entity[:node].replace(Nokogiri::XML::EntityReference.new(doc, entity[:entity])) end doc end |
#section(node) ⇒ Object
Syntax:
[[id]]
== title
Content
[bibliography]
== References
[bibliography]
=== Normative|Informative References
++++
RFC XML references
++++
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 |
# File 'lib/asciidoctor/rfc/v2/base.rb', line 199 def section(node) result = [] if node.attr("style") == "bibliography" || node.parent.context == :section && node.parent.attr("style") == "bibliography" $xreftext = {} $processing_reflist = true references_attributes = { title: node.title, } if node.blocks.empty? result << noko { |xml| xml.references **references_attributes } end node.blocks.each do |block| if block.context == :section result << node.content elsif block.context == :pass # NOTE: references are assumed to be found in a single passthrough # block containing <reference> tags. result << noko do |xml| xml.references **references_attributes do |xml_references| # NOTE: we're allowing the user to do more or less whathever # in the passthrough since the xpath below just fishes out ALL # <reference>s in an unrooted fragment, regardless of structure. Nokogiri::XML::DocumentFragment. parse(block.content).xpath(".//reference"). each { |reference| xml_references << reference.to_xml } end end end end result = result.unshift("</middle><back>") unless $seen_back_matter $processing_reflist = false $seen_back_matter = true else if node.attr("style") == "appendix" result << "</middle><back>" unless $seen_back_matter $seen_back_matter = true end section_attributes = { anchor: node.id, title: node.title.gsub(/<[^>]+>/, ""), } result << noko do |xml| xml.section **attr_code(section_attributes) do |xml_section| xml_section << node.content end end end result end |
#verse(node) ⇒ Object
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
# File 'lib/asciidoctor/rfc/v2/base.rb', line 170 def verse(node) result = [] t_attributes = { anchor: node.id, } result << noko do |xml| xml.t **attr_code(t_attributes) do |xml_t| xml_t << node.content.gsub("\n\n", "<vspace blankLines=\"1\"/>").gsub("\n", "<vspace/>\n") end end result end |