kramdown-rfc2629 1.2.8 → 1.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fa5b9b51745917f5f6388bd784cd3a98720acf30736dbe586b2d8741ab754bd
-  data.tar.gz: ce1a64c8cb9f4754c30209842de2546cc4f238e1a7e0cce6d9c27a326b0d2dfa
+  metadata.gz: d72f5abee0d9218cd232396588b481b4188577ee7972f2e2b2b476f28cfc7a53
+  data.tar.gz: c745ac5a2ea1879cbc30dce943667c9cd0b8b5aaa3f9e24bbd9ec442db92c02d
 SHA512:
-  metadata.gz: 4ef4e2254173879c3c960b09c1564da339df5f4cd96d81d625e32d53ec6441325eb6685fc744aaa89ae8a819b005dfc1f6ef899d35fdaa233e087b680dfbe3e4
-  data.tar.gz: 382c5b23ace07baa9e5dff9d3814fb77278a17f24cfd379e9430a5b122970535487df2a8bcc76e40a650f832b05283ae138e10fd8d350ab58f5439fb0f81962b
+  metadata.gz: 98a41b09d6b12695bc41f0ecc6defd40f96815ff24e88ad92a63877b6130b1fd7bad3584b38d04f07c0a07fa7594a2d09c4caefde5e60f989c27a41b1b2fb3cf
+  data.tar.gz: 68b405cfca06b2bc8c12b1108889a70a752894f6323e86b44276317212dc07a3bc203487e5bd6d46bf6d532825561fdcf3b6eabd51da340ab862e606564347cf

data/README.md

@@ -28,7 +28,7 @@ structure provided by kramdown.  `bin/kramdown-rfc2629` 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 a Ruby 1.9 or 2.x, and maybe
+To use kramdown-rfc2629, you'll need a Ruby 2.x, and maybe
 [XML2RFC][] if you want to see the fruits of your work.
 
     kramdown-rfc2629 mydraft.mkd >mydraft.xml
@@ -38,6 +38,15 @@ To use kramdown-rfc2629, you'll need a Ruby 1.9 or 2.x, and maybe
 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
+is provided by `kdrfc`:
+
+    kdrfc mydraft.mkd
+
+`kdrfc` can also use a remote installation of XML2RFC if needed:
+
+    kdrfc -r mydraft.mkd
+
 # Examples
 
 For historical interest
@@ -265,6 +274,36 @@ 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.2.9:)
+The YAML header now allows specifying [kramdown_options][].
+
+[kramdown_options]: https://kramdown.gettalong.org/options.html
+
+This was added specifically to provide easier access to the kramdown
+`auto_id_prefix` feature, which prefixes by some distinguishing string
+the anchors that are auto-generated for sections, avoiding conflicts:
+
+```yaml
+kramdown_options:
+  auto_id_prefix: sec-
+```
+
+(1.2.8:)
+An experimental feature was added to include [BCP 14] boilerplate:
+
+```markdown
+{::boilerplate bcp14}
+```
+
+which saves some typing.  Saying "bcp14+" instead of "bcp14" adds some
+random clarifications at the end of the [standard boilerplate text][] that
+you may or may not want to have.  (Do we need other boilerplate items
+beyond BCP14?)
+
+[BCP 14]: https://www.rfc-editor.org/info/bcp14
+
+[standard boilerplate text]: https://tools.ietf.org/html/rfc8174#page-3
+
 (1.0.35:)
 An experimental command `doilit` has been added.  It can be used to
 convert DOIs given on the command line into references entries for
@@ -454,6 +493,20 @@ 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).
 
+Occasionally, you do need to reach through to the XML arcana, e.g. by
+setting attribute values using kramdown's ["IAL" syntax][IAL].
+This can for instance be used to obtain unnumbered appendices:
+
+```markdown
+Acknowledgements
+================
+{: numbered="no"}
+
+John Mattsson was nice enough to point out the need for this being documented.
+```
+
+[IAL]: https://kramdown.gettalong.org/syntax.html#inline-attribute-lists
+
 # Upconversion
 
 If you have an old RFC and want to convert it to markdown, try just

data/bin/kramdown-rfc2629

@@ -16,7 +16,7 @@ def boilerplate(key)
 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
 NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED",
 "MAY", and "OPTIONAL" in this document are to be interpreted as
-described in BCP 14 {{!RFC2119}} {{!RFC8174}} when, and only when, they
+described in BCP 14 {{!RFC2119}} {{!RFC8174}} when, and only when, they
 appear in all capitals, as shown here.
 RFC8174
     if $1
@@ -84,6 +84,7 @@ def xml_from_sections(input)
   ps = KramdownRFC::ParameterSet.new(yaml_load(yaml_in, [Date], [], true))
   coding_override = ps.has(:coding)
   smart_quotes = ps[:smart_quotes]
+  kramdown_options = ps[:kramdown_options]
 
   # all the other sections are put in a Hash, possibly concatenated from parts there
   sechash = Hash.new{ |h,k| h[k] = ""}
@@ -233,7 +234,7 @@ def xml_from_sections(input)
     warn "*** sections left #{sechash.keys.inspect}!"
   end
 
-  [input, coding_override, link_defs, smart_quotes]
+  [input, coding_override, link_defs, smart_quotes, kramdown_options]
 end
 
 XML_RESOURCE_ORG_PREFIX = Kramdown::Converter::Rfc2629::XML_RESOURCE_ORG_PREFIX
@@ -304,7 +305,7 @@ end
 link_defs = {}
 if input =~ /\A---/        # this is a sectionized file
   do_the_tls_dance unless ENV["KRAMDOWN_DONT_VERIFY_HTTPS"]
-  input, target_coding, link_defs, smart_quotes = xml_from_sections(input)
+  input, target_coding, link_defs, smart_quotes, kramdown_options = xml_from_sections(input)
 end
 if input =~ /\A<\?xml/          # if this is a whole XML file, protect it
   input = "{::nomarkdown}\n#{input}\n{:/nomarkdown}\n"
@@ -324,6 +325,9 @@ when nil, true
 else
   warn "*** Can't deal with smart_quotes value #{smart_quotes.inspect}"
 end
+if kramdown_options
+  options.merge! kramdown_options
+end
 
 if target_coding
   input = input.encode(Encoding.find(target_coding), fallback: FALLBACK)

data/kramdown-rfc2629.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
   s.name = 'kramdown-rfc2629'
-  s.version = '1.2.8'
+  s.version = '1.2.9'
   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.}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-rfc2629
 version: !ruby/object:Gem::Version
-  version: 1.2.8
+  version: 1.2.9
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-19 00:00:00.000000000 Z
+date: 2018-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -83,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Kramdown extension for generating RFC 7749 XML.