kramdown-rfc2629 1.0.29 → 1.0.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec6389f9081b9af7bfc2a1131abf05006494e2d2
-  data.tar.gz: 772094191a700a5be2e790dc38214bb034431e56
+  metadata.gz: a7bc8abb77836597a85d3759acc1b9c967ab08b9
+  data.tar.gz: 0f0936ec35dcaa2f17fcad200b8078a5280d4f6d
 SHA512:
-  metadata.gz: 6b021318fe0e79b1e12704611a1546cd40a99000ddb7828ccc6c2d5c65e8f8cf7b07655df60762fe691d57ff75e174db7413541803e12b03df0cb7298897dbc3
-  data.tar.gz: 4a62a7a8e4980b8892e2f54e50d2ab156646f4a765650a6cdc80dc7337d39612ebf1c97832557063de9c67e91ad58e4f7bef232b94202e91111480083be3a848
+  metadata.gz: d4ff0aa08e50fa874c90c83eaaacc8239ee3d313f1862d6f0f40d4aced3761bc727e52f4f2fc48aab71354a5b0d1fa377d4f5ac4266c4036f2325d707988d788
+  data.tar.gz: 76ca0282a1f3aa15ab0b72c61bd17b1865ec703cc54820e1926dc1d8c1516c59d9103ffccb2bfd099ba68a2a759f607c1fe6cd9d13d8867dfbf0f54bc35822f2

data/README.md

@@ -4,8 +4,8 @@
 number of backends for generating HTML, Latex, and markdown again.
 
 **kramdown-rfc2629** is an additional backend to that: It allows the
-generation of [XML2RFC][] XML markup (also known as [RFC 2629][]
-compliant markup).
+generation of [XML2RFC][] XML markup (originally known as [RFC 2629][]
+compliant markup, now documented in [RFC 7749][]).
 
 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
@@ -35,10 +35,11 @@ To use kramdown-rfc2629, you'll need a Ruby 1.9 or 2.x, and maybe
 
 # 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 2629 style document,
+does not cater for all the structure of an RFC 7749 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
@@ -117,8 +118,8 @@ or
         phone: "+33 4 97 23 26 34"
         email: pthubert@cisco.com
 
-(the hash keys are the XML GIs from RFC 2629, with a flattened
-structure.  As RFC 2629 requires giving both the name and
+(the hash keys are the XML GIs from RFC 7749, with a flattened
+structure.  As RFC 7749 requires 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.)
@@ -233,6 +234,22 @@ special support in XML2RFC), and HTML syntax of course.
 A number of more esoteric features have recently been added.  
 (The minimum required version for each full feature is indicated.)
 
+(1.0.30:)
+kramdown-rfc now uses kramdown 1.10, which leads to two notable updates:
+
+ * Support for empty link texts in the standard markdown
+   reference syntax, as in `[](#RFC7744)`.
+ * Language names in fenced code blocks now support all characters
+   except whitespace, so you can go wild with `asn.1` and `C#`.
+
+A heuristic generates missing initials/surname from the `name` entry
+in author information.  This should save a lot of redundant typing.
+You'll need to continue using the `ins` entry as well if that
+heuristic fails (e.g., for Spanish names).
+
+Also, there is some rather experimental support for markdown display
+math (blocks between `$$` pairs) if the `tex2mail` tool is available.
+
 (1.0.23:)
 Move up to kramdown 1.6.0.  This inherits a number of fixes and one
 nice feature:
@@ -373,13 +390,11 @@ 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 2629][] (or the more current [Internet-Draft][IAB-RFCXMLv2]) if you want to write an Internet-Draft, but you
+skim [RFC 7749][] 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).
 
-[IAB-RFCXMLv2]: https://tools.ietf.org/html/draft-iab-xml2rfcv2-00
-
 # Upconversion
 
 If you have an old RFC and want to convert it to markdown, try just
@@ -389,6 +404,28 @@ remaining 20 % some more, but that hasn't been done.
 If you have XML, there is an experimental upconverter that does 99 %
 of the work.  Please contact the author if you want to try it.
 
+# Tools
+
+Joe Hildebrand has a
+[grunt][] plugin for kramdown-rfc2629 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.
+
+[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
+follow the installation instructions.
+
+[I-D Template]: https://github.com/martinthomson/i-d-template
+
 # Related Work
 
 Moving from XML to Markdown for RFC writing apparently is a
@@ -415,6 +452,7 @@ made it possible to license kramdown-rfc2629 under the same license.
 [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
 [markdown]: http://en.wikipedia.org/wiki/Markdown
 [IETF]: http://www.ietf.org
 [Miek Gieben]: http://www.miek.nl/

data/bin/kramdown-rfc2629

@@ -247,6 +247,13 @@ def authorps_from_hash(au)
     aups.rest["initials"] = parts[0..-2].join('.') << '.'
     aups.rest["surname"] = parts[-1]
   end
+  # hack ("heuristic for") initials and surname from name
+  # -- only works for people with exactly one last name and uncomplicated first names
+  if n = aups.rest["name"]
+    n = n.split
+    aups.rest["initials"] ||= n[0..-2].map(&:chr).join('.') << '.'
+    aups.rest["surname"] ||= n[-1]
+  end
   aups
 end
 

data/kramdown-rfc2629.gemspec

@@ -1,10 +1,10 @@
 spec = Gem::Specification.new do |s|
   s.name = 'kramdown-rfc2629'
-  s.version = '1.0.29'
-  s.summary = "Kramdown extension for generating RFC 2629 XML."
-  s.description = %{An RFC2629 (XML2RFC) generating backend for Thomas Leitner's
+  s.version = '1.0.30'
+  s.summary = "Kramdown extension for generating RFC 7749 XML."
+  s.description = %{An RFC7749 (XML2RFC) generating backend for Thomas Leitner's
 "kramdown" markdown parser.  Mostly useful for RFC writers.}
-  s.add_dependency('kramdown', '~> 1.9.0')
+  s.add_dependency('kramdown', '~> 1.10.0')
   s.files = Dir['lib/**/*.rb'] + %w(README.md LICENSE kramdown-rfc2629.gemspec bin/kramdown-rfc2629 data/kramdown-rfc2629.erb)
   s.require_path = 'lib'
   s.executables = ['kramdown-rfc2629']

data/lib/kramdown-rfc2629.rb

@@ -11,12 +11,13 @@
 
 raise "sorry, 1.8 was last decade" unless RUBY_VERSION >= '1.9'
 
-gem 'kramdown', '~> 1.9.0'
+gem 'kramdown', '~> 1.10.0'
 require 'kramdown'
 my_span_elements =  %w{list figure xref eref iref cref spanx vspace}
 Kramdown::Parser::Html::Constants::HTML_SPAN_ELEMENTS.concat my_span_elements
 
 require 'rexml/parsers/baseparser'
+require 'open3'                 # for math
 
 class Object
   def deep_clone
@@ -290,7 +291,8 @@ module Kramdown
         @in_dt = 1
         vspace = opts[:vspace]
         vspaceel = "<vspace blankLines='#{vspace}'/>" if vspace
-        "#{close}#{' '*indent}<t#{el_html_attributes(el)} hangText='#{inner(el, indent, opts)}'>#{vspaceel}\n"
+        ht = escape_html(inner(el, indent, opts), :attribute) # XXX this may leave gunk
+        "#{close}#{' '*indent}<t#{el_html_attributes(el)} hangText='#{ht}'>#{vspaceel}\n"
       end
 
       HTML_TAGS_WITH_BODY=['div', 'script']
@@ -552,11 +554,26 @@ module Kramdown
 
       def convert_math(el, indent, opts) # XXX: This is wrong
         el = el.deep_clone
-        el.attr['class'] ||= ''
-        el.attr['class'] += (el.attr['class'].empty? ? '' : ' ') + 'math'
-        type = 'span'
-        type = 'div' if el.options[:category] == :block
-        "<#{type}#{el_html_attributes(el)}>#{escape_html(el.value, :text)}</#{type}>#{type == 'div' ? "\n" : ''}"
+        if el.options[:category] == :block
+          el.attr['artwork-type'] ||= ''
+          el.attr['artwork-type'] += (el.attr['artwork-type'].empty? ? '' : ' ') + 'math'
+          artwork_attr = {}
+          el.attr.each do |k, v|
+            if md = k.match(/\Aartwork-(.*)/)
+              el.attr.delete(k)
+              artwork_attr[md[1]] = v
+            end
+          end
+          result, _s = Open3.capture2("tex2mail -noindent -ragged -by_par -linelength=69", stdin_data: el.value);
+          # warn "*** tex2mail not in path?" unless s.success? -- doesn't have useful status
+          "#{' '*indent}<figure#{el_html_attributes(el)}><artwork#{html_attributes(artwork_attr)}><![CDATA[#{result}#{result =~ /\n\Z/ ? '' : "\n"}]]></artwork></figure>\n"
+
+        else
+          warn "*** no support for inline math in XML2RFCv2"
+          type = 'spanx'
+          attrstring = el_html_attributes_with(el, {"style" => 'verb'})
+          "<#{type}#{attrstring}>#{escape_html(el.value, :text)}</#{type}>"
+        end
       end
 
       ITEM_RE = '\s*(?:"([^"]*)"|([^,]*?))\s*'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-rfc2629
 version: !ruby/object:Gem::Version
-  version: 1.0.29
+  version: 1.0.30
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-05 00:00:00.000000000 Z
+date: 2016-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -16,16 +16,16 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: 1.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: 1.10.0
 description: |-
-  An RFC2629 (XML2RFC) generating backend for Thomas Leitner's
+  An RFC7749 (XML2RFC) generating backend for Thomas Leitner's
   "kramdown" markdown parser.  Mostly useful for RFC writers.
 email: cabo@tzi.org
 executables:
@@ -62,6 +62,6 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Kramdown extension for generating RFC 2629 XML.
+summary: Kramdown extension for generating RFC 7749 XML.
 test_files: []
 has_rdoc: