asciidoctor-rfc 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a6bea3ae379ea8404bb2554c297ac8021f575dc09c5e11cb5ddb72802bed384
-  data.tar.gz: c530c5f75c72755c9b78240dff2117a098d15d695854cfbcc3d77fd77eb305af
+  metadata.gz: 415bbddbd5dc25773291e4b534f831aca0b95095afde843bb5d042a798fab7dd
+  data.tar.gz: df38598b9f2fc70983b605b7ef003d4b90a76be28027092191b0a8ec52e57967
 SHA512:
-  metadata.gz: 1aec907eef6a4f4ba30d58d182242217fa679348dba0e33b805efaca7f5a9fb95326a2b87c2a7a571b5548642bf0aba572f2972d012e01e421fa694af961cb10
-  data.tar.gz: e601d621850627bb9899477f1488f75fd37fbea898cbcd17b8be45f25446d2405b649a25dfc733d5c3bcff948801d9127dc9fb8ba699c9ad1c41d9a6080eb68c
+  metadata.gz: 4db78b248939d8bcc55bcf95ff35c37295505c532f75056d9152b8d157da522a3219139620420b06daf02888f25fdb2e46f82b7f7bb90d789a9ffe383325692d
+  data.tar.gz: 1448366ea2283e1483a8279dc2e381784dfc94a6a77e8516a967de40303f0e03a77de05ecb35208fc56eb44cef8cc4285c83079727c0e41f4fb5ac0b0def9449

data/.travis.yml

@@ -1,11 +1,23 @@
+dist: trusty
 sudo: true
 language: ruby
+python:
+- 2.7
 rvm:
-  - 2.4.0
-before_install: 
-  - gem install bundler -v 1.16.0
-  - bundle install
-install:
-  - sudo pip install xml2rfc
-script:
-  - bundle exec rspec --color --format documentation --require spec_helper 
+  - 2.5
+  - 2.4
+  - 2.3
+  - ruby-head
+addons:
+  apt:
+    packages:
+    - python-lxml
+    - python-pip
+
+before_install:
+  - gem install bundler -v 1.16.1
+  - unset _JAVA_OPTIONS
+  - pip install --user xml2rfc
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/README.adoc

@@ -987,8 +987,8 @@ Quotation <3>
 
 ==== Asciidoctor comments
 
-Asciidoctor implements both inline comments (prefixed with `\\`)
-and block comments (prefixed with `\\\\`). Both are ignored by
+Asciidoctor implements both inline comments (prefixed with `//`)
+and block comments (prefixed with `////`). Both are ignored by
 the Asciidoctor processor, and are not rendered in any output,
 including RFC XML.
 

data/asciidoctor-rfc.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   DESCRIPTION
 
   spec.homepage      = "https://github.com/riboseinc/asciidoctor-rfc"
-  spec.license       = "MIT"
+  spec.license       = "BSD-2-Clause"
 
   spec.bindir        = "bin"
   spec.require_paths = ["lib"]

data/docs/installation.md

@@ -0,0 +1,21 @@
+---
+title: Installation
+---
+
+Add this line to your application’s Gemfile:
+
+```
+gem "asciidoctor-rfc"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install asciidoctor-rfc
+```

data/docs/navigation.md

@@ -0,0 +1,10 @@
+---
+sections:
+- name: Introduction
+  items:
+    - overview
+    - installation
+- name: Usage
+  items:
+    - basic
+---

data/docs/overview.md

@@ -0,0 +1,5 @@
+---
+title: Overview
+---
+
+asciidoctor-rfc lets you write Internet-Drafts and RFCs in AsciiDoc, the “asciidoctor-way”.

data/lib/asciidoctor/rfc/common/base.rb

@@ -526,6 +526,15 @@ HERE
         end
         xmldoc
       end
+
+      def output_dtd
+        filename = File.join(File.dirname(__FILE__), "../../../../rfc2629.dtd")
+        system "cp #{filename} ."
+        filename = File.join(File.dirname(__FILE__), "../../../../rfc2629-other.ent")
+        system "cp #{filename} ."
+        filename = File.join(File.dirname(__FILE__), "../../../../rfc2629-xhtml.ent")
+        system "cp #{filename} ."
+      end
     end
   end
 end

data/lib/asciidoctor/rfc/v2/base.rb

@@ -89,12 +89,11 @@ module Asciidoctor
         ret = result * "\n"
         ret = cleanup(ret)
         ret1 = Nokogiri::XML(ret)
-        # Validate::validate(ret1)
         ret1 = set_pis(node, ret1)
         ret1 = insert_biblio(node, ret1) unless node.attr("biblio-dir").nil? || node.attr("biblio-dir").empty?
+        output_dtd()
         Validate::validate(ret1)
         ret1 = resolve_references(node, ret1)
-        # Validate::validate(ret1)
         ret1.to_xml
       end
 
@@ -232,6 +231,9 @@ module Asciidoctor
           $processing_reflist = false
           $seen_back_matter = true
         else
+          if $seen_back_matter && node.attr("style") != "appendix"
+            warn "Appendix not marked up with [appendix]!"
+          end
           if node.attr("style") == "appendix"
             result << "</middle><back>" unless $seen_back_matter
             $seen_back_matter = true

data/lib/asciidoctor/rfc/v3/base.rb

@@ -86,6 +86,7 @@ module Asciidoctor
         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?
+        output_dtd()
         Validate::validate(ret1)
         ret1 = resolve_references(node, ret1)
         # Validate::validate(ret1)
@@ -130,7 +131,8 @@ module Asciidoctor
 
       BCP_KEYWORDS = [
         "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
-        "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", "OPTIONAL"
+        "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED",
+        "MAY", "OPTIONAL"
       ].freeze
 
       def inline_quoted(node)
@@ -251,6 +253,9 @@ module Asciidoctor
           result = ref_section(node)
         else
           result = []
+          if $seen_back_matter && node.attr("style") != "appendix"
+            warn "Appendix not marked up with [appendix]!"
+          end
           if node.attr("style") == "appendix"
             result << "</middle><back>" unless $seen_back_matter
             $seen_back_matter = true

data/lib/asciidoctor/rfc/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module RFC
-    VERSION = "0.9.0".freeze
+    VERSION = "0.9.1".freeze
   end
 end

data/lib/metanorma/rfc/processor_v2.rb

@@ -16,6 +16,10 @@ module Metanorma
         }
       end
 
+      def version
+        "Asciidoctor::Rfc2 #{Asciidoctor::RFC::VERSION}"
+      end
+
       def input_to_isodoc(file)
         Asciidoctor.convert(
           file,
@@ -35,4 +39,4 @@ module Metanorma
 
     end
   end
-end
+end

data/lib/metanorma/rfc/processor_v3.rb

@@ -16,6 +16,10 @@ module Metanorma
         }
       end
 
+      def version
+        "Asciidoctor::Rfc3 #{Asciidoctor::RFC::VERSION}"
+      end
+
       def input_to_isodoc(file)
         Asciidoctor.convert(
           file,
@@ -35,4 +39,4 @@ module Metanorma
 
     end
   end
-end
+end

data/spec/examples/davies-template-bare-06.xml.orig.txt

@@ -0,0 +1,448 @@
+
+
+
+
+Internet Engineering Task Force                           E. Davies, Ed.
+Internet-Draft                                          Folly Consulting
+Intended status: Informational                             April 1, 2010
+Expires: October 3, 2010
+
+
+                   Put Your Internet Draft Title Here
+                     draft-ietf-xml2rfc-template-06
+
+Abstract
+
+   Insert an abstract: MANDATORY.  This template is for creating an
+   Internet Draft.
+
+Status of This Memo
+
+   This Internet-Draft is submitted in full conformance with the
+   provisions of BCP 78 and BCP 79.
+
+   Internet-Drafts are working documents of the Internet Engineering
+   Task Force (IETF).  Note that other groups may also distribute
+   working documents as Internet-Drafts.  The list of current Internet-
+   Drafts is at http://datatracker.ietf.org/drafts/current/.
+
+   Internet-Drafts are draft documents valid for a maximum of six months
+   and may be updated, replaced, or obsoleted by other documents at any
+   time.  It is inappropriate to use Internet-Drafts as reference
+   material or to cite them other than as "work in progress."
+
+   This Internet-Draft will expire on October 3, 2010.
+
+Copyright Notice
+
+   Copyright (c) 2010 IETF Trust and the persons identified as the
+   document authors.  All rights reserved.
+
+   This document is subject to BCP 78 and the IETF Trust's Legal
+   Provisions Relating to IETF Documents
+   (http://trustee.ietf.org/license-info) in effect on the date of
+   publication of this document.  Please review these documents
+   carefully, as they describe your rights and restrictions with respect
+   to this document.  Code Components extracted from this document must
+   include Simplified BSD License text as described in Section 4.e of
+   the Trust Legal Provisions and are provided without warranty as
+   described in the Simplified BSD License.
+
+
+
+
+
+
+Davies                   Expires October 3, 2010                [Page 1]
+
+Internet-Draft              Abbreviated Title                 April 2010
+
+
+Table of Contents
+
+   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
+     1.1.  Requirements Language . . . . . . . . . . . . . . . . . .   2
+   2.  Simple List . . . . . . . . . . . . . . . . . . . . . . . . .   2
+   3.  Figures . . . . . . . . . . . . . . . . . . . . . . . . . . .   3
+   4.  Subsections and Tables  . . . . . . . . . . . . . . . . . . .   3
+     4.1.  A Subsection  . . . . . . . . . . . . . . . . . . . . . .   3
+     4.2.  Tables  . . . . . . . . . . . . . . . . . . . . . . . . .   3
+   5.  More about Lists  . . . . . . . . . . . . . . . . . . . . . .   4
+     5.1.  Numbering Lists across Lists and Sections . . . . . . . .   4
+     5.2.  Where the List Numbering Continues  . . . . . . . . . . .   5
+   6.  Example of Code or MIB Module To Be Extracted . . . . . . . .   5
+   7.  Acknowledgements  . . . . . . . . . . . . . . . . . . . . . .   6
+   8.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   6
+   9.  Security Considerations . . . . . . . . . . . . . . . . . . .   7
+   10. References  . . . . . . . . . . . . . . . . . . . . . . . . .   7
+     10.1.  Normative References . . . . . . . . . . . . . . . . . .   7
+     10.2.  Informative References . . . . . . . . . . . . . . . . .   7
+   Appendix A.  Additional Stuff . . . . . . . . . . . . . . . . . .   7
+   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .   8
+
+1.  Introduction
+
+   The original specification of xml2rfc format is in RFC 2629
+   [RFC2629].
+
+1.1.  Requirements Language
+
+   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
+   "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
+   document are to be interpreted as described in RFC 2119 [RFC2119].
+
+2.  Simple List
+
+   List styles: 'empty', 'symbols', 'letters', 'numbers', 'hanging',
+   'format'.
+
+   o  First bullet
+
+   o  Second bullet
+
+   You can write text here as well.
+
+
+
+
+
+
+
+
+Davies                   Expires October 3, 2010                [Page 2]
+
+Internet-Draft              Abbreviated Title                 April 2010
+
+
+3.  Figures
+
+   Figures should not exceed 69 characters wide to allow for the indent
+   of sections.
+
+                 Preamble text - can be omitted or empty.
+
+   +-----------------------+
+   | Use XML, be Happy :-) |
+   |_______________________|
+
+        Cross-references allowed in pre- and postamble. [min_ref].
+
+                                 Figure 1
+
+   The CDATA means you don't need to escape meta-characters (especially
+   < (&lt;) and & (&amp;)) but is not essential.  Figures may also have
+   a title attribute but it won't be displayed unless there is also an
+   anchor.  White space, both horizontal and vertical, is significant in
+   figures even if you don't use CDATA.
+
+4.  Subsections and Tables
+
+4.1.  A Subsection
+
+   By default 3 levels of nesting show in table of contents but that can
+   be adjusted with the value of the "tocdepth" processing instruction.
+
+4.2.  Tables
+
+   .. are very similar to figures:
+
+     Tables use ttcol to define column headers and widths.  Every cell
+                  then has a "c" element for its content.
+
+                          +----------+----------+
+                          | ttcol #1 | ttcol #2 |
+                          +----------+----------+
+                          |   c #1   |   c #2   |
+                          |   c #3   |   c #4   |
+                          |   c #5   |   c #6   |
+                          +----------+----------+
+
+                      which is a very simple example.
+
+                       Table 1: A Very Simple Table
+
+
+
+
+
+Davies                   Expires October 3, 2010                [Page 3]
+
+Internet-Draft              Abbreviated Title                 April 2010
+
+
+5.  More about Lists
+
+   Lists with 'hanging labels': the list item is indented the amount of
+   the hangIndent:
+
+   short   With a label shorter than the hangIndent.
+
+   fantastically long label  With a label longer than the hangIndent.
+
+   vspace_trick
+           Forces the new item to start on a new line.
+
+   Simulating more than one paragraph in a list item using <vspace>:
+
+   a.  First, a short item.
+
+   b.  Second, a longer list item.
+
+       And something that looks like a separate pararaph..
+
+   Simple indented paragraph using the "empty" style:
+
+      The quick, brown fox jumped over the lazy dog and lived to fool
+      many another hunter in the great wood in the west.
+
+5.1.  Numbering Lists across Lists and Sections
+
+   Numbering items continuously although they are in separate <list>
+   elements, maybe in separate sections using the "format" style and a
+   "counter" variable.
+
+   First list:
+
+   R1  #1
+
+   R2  #2
+
+   R3  #3
+
+   Specify the indent explicitly so that all the items line up nicely.
+
+   Second list:
+
+   R4  #4
+
+   R5  #5
+
+   R6  #6
+
+
+
+Davies                   Expires October 3, 2010                [Page 4]
+
+Internet-Draft              Abbreviated Title                 April 2010
+
+
+5.2.  Where the List Numbering Continues
+
+   List continues here.
+
+   Third list:
+
+   R7  #7
+
+   R8  #8
+
+   R9  #9
+
+   R10 #10
+
+   The end of the list.
+
+6.  Example of Code or MIB Module To Be Extracted
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Davies                   Expires October 3, 2010                [Page 5]
+
+Internet-Draft              Abbreviated Title                 April 2010
+
+
+   The <artwork> element has a number of extra attributes that can be
+   used to substitute a more aesthetically pleasing rendition into HTML
+   output while continuing to use the ASCII art version in the text and
+   nroff outputs (see the xml2rfc README for details).  It also has a
+   "type" attribute.  This is currently ignored except in the case
+   'type="abnf"'.  In this case the "artwork" is expected to contain a
+   piece of valid Augmented Backus-Naur Format (ABNF) grammar.  This
+   will be syntax checked by xml2rfc and any errors will cause a fatal
+   error if the "strict" processing instruction is set to "yes".  The
+   ABNF will also be colorized in HTML output to highlight the syntactic
+   components.  Checking of additional "types" may be provided in future
+   versions of xml2rfc.
+
+
+   /**** an example C program */
+
+   #include <stdio.h>
+
+   void
+   main(int argc, char *argv[])
+   {
+      int i;
+
+      printf("program arguments are:\n");
+      for (i = 0; i < argc; i++) {
+          printf("%d: \"%s\"\n", i, argv[i]);
+      }
+
+      exit(0);
+   } /* main */
+
+   /* end of file */
+
+
+7.  Acknowledgements
+
+   This template was derived from an initial version written by Pekka
+   Savola and contributed by him to the xml2rfc project.
+
+   This document is part of a plan to make xml2rfc indispensable
+   [DOMINATION].
+
+8.  IANA Considerations
+
+   This memo includes no request to IANA.
+
+   All drafts are required to have an IANA considerations section (see
+   Guidelines for Writing an IANA Considerations Section in RFCs
+
+
+
+Davies                   Expires October 3, 2010                [Page 6]
+
+Internet-Draft              Abbreviated Title                 April 2010
+
+
+   [RFC5226] for a guide).  If the draft does not require IANA to do
+   anything, the section contains an explicit statement that this is the
+   case (as above).  If there are no requirements for IANA, the section
+   will be removed during conversion into an RFC by the RFC Editor.
+
+9.  Security Considerations
+
+   All drafts are required to have a security considerations section.
+   See RFC 3552 [RFC3552] for a guide.
+
+10.  References
+
+10.1.  Normative References
+
+   [min_ref]  authSurName, authInitials., "Minimal Reference", 2006.
+
+   [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
+              Requirement Levels", BCP 14, RFC 2119,
+              DOI 10.17487/RFC2119, March 1997,
+              <https://www.rfc-editor.org/info/rfc2119>.
+
+10.2.  Informative References
+
+   [DOMINATION]
+              Mad Dominators, Inc., "Ultimate Plan for Taking Over the
+              World", 1984, <http://www.example.com/dominator.html>.
+
+   [RFC2629]  Rose, M., "Writing I-Ds and RFCs using XML", RFC 2629,
+              DOI 10.17487/RFC2629, June 1999,
+              <https://www.rfc-editor.org/info/rfc2629>.
+
+   [RFC3552]  Rescorla, E. and B. Korver, "Guidelines for Writing RFC
+              Text on Security Considerations", BCP 72, RFC 3552,
+              DOI 10.17487/RFC3552, July 2003,
+              <https://www.rfc-editor.org/info/rfc3552>.
+
+   [RFC5226]  Narten, T. and H. Alvestrand, "Guidelines for Writing an
+              IANA Considerations Section in RFCs", RFC 5226,
+              DOI 10.17487/RFC5226, May 2008,
+              <https://www.rfc-editor.org/info/rfc5226>.
+
+Appendix A.  Additional Stuff
+
+   This becomes an Appendix.
+
+
+
+
+
+
+
+Davies                   Expires October 3, 2010                [Page 7]
+
+Internet-Draft              Abbreviated Title                 April 2010
+
+
+Author's Address
+
+   Elwyn Davies (editor)
+   Folly Consulting
+   Soham
+   UK
+
+   Phone: +44 7889 488 335
+   Email: elwynd@dial.pipex.com
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Davies                   Expires October 3, 2010                [Page 8]