kramdown-rfc2629 1.6.1 → 1.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e14f146c7079e4611aa6ddf79f706ef0fddb168e1bb510c278ead6c93595b99a
-  data.tar.gz: efa3c83941f0eaa68e82d9d2bbe554826f70bee1469498e870506f006806bcf8
+  metadata.gz: 3216df18368295dd7cd569731da214ec39f57132880c8d12d51f9dc02dce30fb
+  data.tar.gz: e2f0bfaf8d5b96bc2451d93c6c08a636b0b013420201821bff611918a87e7922
 SHA512:
-  metadata.gz: 54b21302c63267ecf9eaf845d67927c8f7f7dc78b4608c545fb6487274a507980695512d21397fa54c7700c3659600229c6dc0cab4964e2c8e9a471da9b51e00
-  data.tar.gz: '093aaa4efee63f5a103fba961072413884170bbcf13bb402b3ea40f36d1af1843d0b170be57d257dbf94f7b05bb6dc1e38df6a76abee06a5c475517fdd843d62'
+  metadata.gz: acfa4b9493d9cd4eb39ea67665a86a249915aa5f537ddbff53e6add625a0576223dc93bc9cb6ffb192f61c1805f892940c667153a9a316b5a7195820135e5365
+  data.tar.gz: 56de1bff6b8db68224ea994c8604dc75dd1ef99f01705ea04a704be0b1d635bdfa229296f9ad5a9c6a5263812da6dfa4b9d955035dd5f20a64d11b657afd7fca

data/README.md

@@ -1,11 +1,12 @@
-# kramdown-rfc2629
+# kramdown-rfc
 
 [kramdown][] is a [markdown][] parser by Thomas Leitner, which has a
 number of backends for generating HTML, Latex, and markdown again.
 
-**kramdown-rfc2629** is an additional backend to that: It allows the
+**kramdown-rfc** is an additional backend to that: It allows the
 generation of [XML2RFC][] XML markup (originally known as [RFC 2629][]
-compliant markup, now documented in [RFC 7749][]).
+compliant markup, with a newer version documented in [RFC 7749][];
+version 3 now documented in [RFC 7991][] etc. and [v3][]).
 
 Who would care?  Anybody who is writing Internet-Drafts and RFCs in
 the [IETF][] and prefers (or has co-authors who prefer) to do part of
@@ -13,33 +14,33 @@ their work in markdown.
 
 # Usage
 
-Start by installing the kramdown-rfc2629 gem (this automatically
+Start by installing the kramdown-rfc gem (this automatically
 installs appropriate versions of referenced gems such as kramdown as
 well):
 
-    gem install kramdown-rfc2629
+    gem install kramdown-rfc
 
 (Add a `sudo` and a space in front of that command if you don't have
 all the permissions needed.)
 
-The guts of kramdown-rfc2629 are in one Ruby file,
+The guts of kramdown-rfc are in one Ruby file,
 `lib/kramdown-rfc2629.rb` --- this melds nicely into the extension
-structure provided by kramdown.  `bin/kramdown-rfc2629` started out as
+structure provided by kramdown.  `bin/kramdown-rfc` started out as
 a simple command-line program showing how to use this, but can now do
 much more (see below).
 
-To use kramdown-rfc2629, you'll need Ruby (at least version 2.3, but
+To use kramdown-rfc, you'll need Ruby (at least version 2.3, but
 preferably a current version), and maybe
 [XML2RFC][] if you want to see the fruits of your work.
 
-    kramdown-rfc2629 mydraft.mkd >mydraft.xml
+    kramdown-rfc mydraft.mkd >mydraft.xml
     xml2rfc mydraft.xml
 
 (The most popular file name extension that IETF people have for
 markdown is .md -- for those who tend to think about GNU machine
 descriptions here, any extension such as .mkd will do, too.)
 
-A more brief interface for both calling kramdown-rfc2629 and XML2RFC
+A more brief interface for both calling kramdown-rfc and XML2RFC
 is provided by `kdrfc`:
 
     kdrfc mydraft.mkd
@@ -52,29 +53,31 @@ is provided by `kdrfc`:
 
 Since RFC 8650, RFCs are using an updated grammar as defined in RFC
 7991 to 7998 and further updated informally since, colloquially called "[v3][]".
-As RFC 2629 is no longer the governing standard, kramdown-rfc2629 is
+As RFC 2629 is no longer the governing standard, what was called kramdown-rfc2629 is
 now called kramdown-rfc.  The latter command defaults to v3 processing
-rules; from 2022-02-22T22:02:22 on, kramdown-rfc2629 does as well (1.6.1).
+rules; from 2022-02-22T22:02:22 on, the old kramdown-rfc2629 driver program does as well (1.6.1).
 (-3/--v3 and -2/--v2 select v3 and v2 explicitly; the latter should
 only be needed if there is a reason to to make a document look
 like it's 2016.)
 
-[v3]: https://xml2rfc.tools.ietf.org/xml2rfc-doc.html
+See also [v3 announcement mail][].
+
+[v3 announcement mail]: https://mailarchive.ietf.org/arch/msg/rfc-markdown/JC__LDDGuUbSFqyaEntF9r4kwKw
 
 # Examples
 
 For historical interest
 `stupid.mkd` was an early markdown version of an actual Internet-Draft
 (for a protocol called [STuPiD][] \[sic!]).  This demonstrated some,
-but not all features of kramdown-rfc2629.  Since markdown/kramdown
-does not cater for all the structure of an RFC 7749 style document,
+but not all features of kramdown-rfc.  Since markdown/kramdown
+does not cater for all the structure of an RFC 7991 style document,
 some of the markup is in XML, and the example switches between XML and
 markdown using kramdown's `{::nomarkdown}` and `{:/nomarkdown}` (this
 is ugly, but works well enough).  `stupid.xml` and `stupid.txt` show
-what kramdown-rfc2629 and xml2rfc make out of this.
+what kramdown-rfc and xml2rfc make out of this.
 
 `stupid-s.mkd` is the same document in the new sectionized format
-supported by kramdown-rfc2629.  The document metadata are in a short
+supported by kramdown-rfc.  The document metadata are in a short
 piece of YAML at the start, and from there, `abstract`, `middle`,
 references (`normative` and `informative`) and `back` are sections
 delimited in the markdown file.  See the example for how this works.
@@ -82,7 +85,7 @@ The sections `normative` and `informative` can be populated right from
 the metadata, so there is never a need to write XML any more.
 Much less scary, and no `{:/nomarkdown}` etc. is needed any more.
 Similarly, `stupid-s.xml` and `stupid-s.txt` show what
-kramdown-rfc2629 and xml2rfc make out of this.
+kramdown-rfc and xml2rfc make out of this.
 
 `draft-ietf-core-block-xx.mkd` is a real-world example of a current
 Internet-Draft done this way.  For RFC and Internet-Draft references,
@@ -147,7 +150,7 @@ or
         email: pthubert@cisco.com
 
 (the hash keys are the XML GIs from RFC 7749, with a flattened
-structure.  As RFC 7749 requires giving both the full name and
+structure.  As RFC 7749 requiresd giving both the full name and
 surname/initials, we use `ins` as an abbreviation for
 "initials/surname".  Yes, the toolchain is Unicode-capable, even if
 the final RFC output is still in ASCII.)
@@ -161,7 +164,7 @@ might otherwise be interpreted as a number, losing the + sign).
 
 The references section is built from the references listed in the YAML
 header and from references made inline to RFCs and I-Ds in the
-markdown text.  Since kramdown-rfc2629 cannot know whether a reference
+markdown text.  Since kramdown-rfc cannot know whether a reference
 is normative or informative, no entry is generated by default in the
 references section.  By indicating a normative reference as in
 `{{!RFC2119}}` or an informative one as in `{{?RFC1925}}`, you can
@@ -333,7 +336,7 @@ not have the tools installed in its docker instance.
 
 More details have been collected on the [wiki][svg].
 
-[svg]: https://github.com/cabo/kramdown-rfc2629/wiki/SVG
+[svg]: https://github.com/cabo/kramdown-rfc/wiki/SVG
 
 (1.2.9:)
 The YAML header now allows specifying [kramdown_options][].
@@ -549,7 +552,7 @@ note that this creates ugly blank space in some HTML converters).
 
 The code is not very polished, but now quite stable; it has been successfully used for a
 number of non-trivial Internet-Drafts and RFCs.  You probably still need to
-skim [RFC 7749][] if you want to write an Internet-Draft, but you
+skim [v3][] if you want to write an Internet-Draft, but you
 don't really need to understand XML very much.  Knowing the basics of
 YAML helps with the metadata (but you'll understand it from the
 examples).
@@ -579,7 +582,7 @@ of the work.  Please [contact the
 author](mailto:cabo@tzi.org?subject=Markdown%20for%20RFCXML) if you want
 to try it.
 
-Actually, if the XML was generated by kramdown-rfc2629, you can simply
+Actually, if the XML was generated by kramdown-rfc, you can simply
 extract the input markdown from that XML file (but will of course lose
 any edits that have been made to the XML file after generation):
 
@@ -589,21 +592,21 @@ any edits that have been made to the XML file after generation):
 # Tools
 
 Joe Hildebrand has a
-[grunt][] plugin for kramdown-rfc2629 at:
+[grunt][] plugin for kramdown-rfc at:
 https://github.com/hildjj/grunt-kramdown-rfc2629
 .
 Get started with it at:
 https://github.com/hildjj/grunt-init-rfc
 .
 This provides a self-refreshing web page with the
-kramdown-rfc2629/xml2rfc rendition of the draft you are editing.
+kramdown-rfc/xml2rfc rendition of the draft you are editing.
 
 [grunt]: http://gruntjs.com
 
 Martin Thomson has an [I-D Template][] for github repositories that enable
 collaboration on draft development.
-This supports kramdown-rfc2629 out of the
-box.  Just name your draft like `draft-ietf-unicorn-protocol-latest.md` and
+This supports kramdown-rfc out of the
+box.  Just name your draft like `draft-ietf-unicorn-protocol.md` and
 follow the installation instructions.
 
 [I-D Template]: https://github.com/martinthomson/i-d-template
@@ -615,12 +618,12 @@ no-brainer, so I'm not the only one who has written code for this.
 
 [Miek Gieben][] has done a [similar thing][pandoc2rfc] employing
 pandoc, now documented in [RFC 7328][].  He uses multiple input files instead of
-kramdown-rfc2629's sectionized input format.  He keeps the metadata in
+kramdown-rfc's sectionized input format.  He keeps the metadata in
 a separate XML file, similar to the way the previous version of
-kramdown-rfc2629 stored (and still can store) the metadata in XML in
+kramdown-rfc stored (and still can store) the metadata in XML in
 the markdown document.  He also uses a slightly different referencing
 syntax, which is closer to what markdown does elsewhere but more
-verbose (this syntax is now also supported in kramdown-rfc2629).
+verbose (this syntax is now also supported in kramdown-rfc).
 (Miek now also has a new thing going on with mostly different syntax,
 see [mmark][] and its [github repository][mmark-git].)
 
@@ -632,14 +635,16 @@ Other human-oriented markup input languages that are being used for authoring RF
 # License
 
 Since kramdown version 1.0, kramdown itself is MIT licensed, which
-made it possible to license kramdown-rfc2629 under the same license.
+made it possible to license kramdown-rfc under the same license.
 
 [kramdown]: https://kramdown.gettalong.org
 [kdsyntax]: http://kramdown.gettalong.org/syntax.html
 [kdsyntax-ial]: http://kramdown.gettalong.org/syntax.html#inline-attribute-lists
 [stupid]: http://tools.ietf.org/id/draft-hartke-xmpp-stupid-00
-[RFC 2629]: http://xml.resource.org/public/rfc/html/rfc2629.html
-[RFC 7749]: http://tools.ietf.org/html/rfc7749
+[RFC 2629]: https://www.rfc-editor.org/rfc/rfc2629.html
+[RFC 7749]: https://www.rfc-editor.org/rfc/rfc7749.html
+[RFC 7991]: https://www.rfc-editor.org/rfc/rfc7991.html
+[v3]: https://xml2rfc.tools.ietf.org/xml2rfc-doc.html
 [markdown]: http://en.wikipedia.org/wiki/Markdown
 [IETF]: http://www.ietf.org
 [Miek Gieben]: http://www.miek.nl/

data/data/kramdown-rfc2629.erb

@@ -169,6 +169,10 @@
 
   <back>
 
+<% displayref.each do |k, v| -%>
+    <displayreference target="<%=k%>" to="<%=v%>"/>
+<% end -%>
+
 <% if sh = sechash.delete("normative") -%>
     <references title='Normative References'>
 

data/kramdown-rfc2629.gemspec

@@ -1,8 +1,8 @@
 spec = Gem::Specification.new do |s|
   s.name = 'kramdown-rfc2629'
-  s.version = '1.6.1'
-  s.summary = "Kramdown extension for generating RFC 7749 XML."
-  s.description = %{An RFC7749 (XML2RFC) generating backend for Thomas Leitner's
+  s.version = '1.6.4'
+  s.summary = "Kramdown extension for generating RFCXML (RFC 799x)."
+  s.description = %{An RFCXML (RFC 799x) generating backend for Thomas Leitner's
 "kramdown" markdown parser.  Mostly useful for RFC writers.}
   s.add_dependency('kramdown', '~> 2.3.0')
   s.add_dependency('kramdown-parser-gfm', '~> 1.1')

data/lib/kramdown-rfc/command.rb

@@ -283,6 +283,8 @@ def xml_from_sections(input)
   ref_replacements = { }
   anchor_to_bibref = { }
 
+  displayref = {}
+
   [:ref, :normative, :informative].each do |sn|
     if refs = ps.has(sn)
       warn "*** bad section #{sn}: #{refs.inspect}" unless refs.respond_to? :each
@@ -300,6 +302,9 @@ def xml_from_sections(input)
           if bibref = v.delete("=")
             anchor_to_bibref[k] = bibref
           end
+          if dr = v.delete("display")
+            displayref[k] = dr
+          end
         end
       end
     end

data/lib/kramdown-rfc/refxml.rb

@@ -93,6 +93,10 @@ module KramdownRFC
   def self.handle_ins(aups, ins_k, initials_k, surname_k)
     if ins = aups[ins_k]
       parts = ins.split('.').map(&:strip) # split on dots first
+      if parts == []
+        warn "*** an empty '#{ins_k}:' value is not useful, try leaving it out"
+        return
+      end
       # Coalesce H.-P.
       i = 1; while i < parts.size
         if parts[i][0] == "-"
@@ -115,6 +119,10 @@ module KramdownRFC
   def self.handle_name(aups, fn_k, initials_k, surname_k)
     if name = aups.rest[fn_k]
       names = name.split(/ *\| */, 2) # boundary for given/last name
+      if names == []
+        warn "*** an empty '#{fn_k}:' value is not useful, try leaving it out"
+        return
+      end
       if names[1]
         aups.rest[fn_k] = name = names.join(" ") # remove boundary
         if surname = aups.rest[surname_k]
@@ -125,6 +133,10 @@ module KramdownRFC
         aups.rest[surname_k] = names[1]
       end
       parts = name.split
+      if parts == []
+        warn "*** a blank '#{fn_k}:' value is not useful, try leaving it out"
+        return
+      end
       surname = aups.rest[surname_k] || parts[-1]
       s = surname.split
       aups.rest[initials_k] ||= initials_from_parts_and_surname(aups, parts, s)

data/lib/kramdown-rfc2629.rb

@@ -808,7 +808,7 @@ COLORS
             out ="#{' '*indent}<dd><t/></dd>\n" # you can't make this one up
           end
           opts[:haddt] = true
-          out << "#{' '*indent}<dt#{el_html_attributes(el)}>\n#{inner(el, indent, opts)}#{' '*indent}</dt>\n"
+          out << "#{' '*indent}<dt#{el_html_attributes(el)}>#{inner(el, indent, opts)}</dt>\n"
         else
         close = "#{' '*indent}</t>\n" * @in_dt
         @in_dt = 1
@@ -914,6 +914,17 @@ COLORS
         gi = el.attr.delete('gi')
         res = inner(el, indent, opts)
         target = el.attr['target']
+        if target[0..1] == "{{"
+          # XXX ignoring all attributes and content
+          s = ::Kramdown::Converter::Rfc2629::process_markdown(target)
+          # if res != '' && s[-2..-1] == '/>'
+          #   if s =~ /\A<([-A-Za-z0-9_.]+) /
+          #     gi ||= $1
+          #   end
+          #   s[-2..-1] = ">#{res}</#{gi}>"
+          # end
+          return s
+        end
         if target[0] == "#"     # handle [](#foo) as xref as in RFC 7328
           el.attr['target'] = target = target[1..-1]
           if target.downcase == res.downcase

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-rfc2629
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.6.4
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-21 00:00:00.000000000 Z
+date: 2022-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 description: |-
-  An RFC7749 (XML2RFC) generating backend for Thomas Leitner's
+  An RFCXML (RFC 799x) generating backend for Thomas Leitner's
   "kramdown" markdown parser.  Mostly useful for RFC writers.
 email: cabo@tzi.org
 executables:
@@ -123,8 +123,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: Kramdown extension for generating RFC 7749 XML.
+summary: Kramdown extension for generating RFCXML (RFC 799x).
 test_files: []