Comments (8)
There are actually two types of documents we should handle:
- Internet-Draft ("I-D") is the normal one that people create (like this: https://github.com/riboseinc/rfc-openpgp-oscca-adoc). These are documents not yet approved by the IETF. These documents have a "rev" number beginning from "00", "01", etc.
- RFC is an official document published by the IETF, with an official numbering, after being approved from an Internet-Draft.
Maybe we should have separate :doctype:
s for them ("internet-draft", "rfc"). Both have pretty much an identical structure, but different boilerplate.
RFCs are only created by IETF "RFC Editors", not by mere mortals. The only purpose of the "rfc" doctype in this gem is to re-create XMLRFCs of existing RFCs in asciidoctor format.
The purpose of the "internet-draft" doctype is to create XMLRFCs that can be submitted to the Internet Drafts Repository.
from asciidoctor-rfc.
@paolobrasolin: Note that the RFC XML doesn't look essentially different, but there are different, in some instances mutually exclusive document header values. I haven't actually done anything with front/boilerplate in v3, because I had no idea how to populate it!
I have assumed the documents processed by this code to be articles, with an initial top-level title; so presumably rfc doctype would be a subclass of article.
from asciidoctor-rfc.
I think the boilerplate is inserted by the RFC tools (e.g., xml2rfc) as long as you have a <boilerplate>
element in front
: https://tools.ietf.org/html/rfc7991#section-2.11
And yes I agree that the rfc
and internet-draft
doctypes can subclass article
.
from asciidoctor-rfc.
I feel that this should be implemented early on. Any time for this @opoudjis ?
from asciidoctor-rfc.
rolls eyes :-)
Obviously I need a sample of what this boilerplate is supposed to look like, and I assume the boilerplate is not determined by the ASCIIdoctor at all, but fixed for all Internet Drafts? The xml2rfc tool https://xml2rfc.tools.ietf.org says only that you should provide rfc@ipr attributes, not how you should populate the <boilerplate>
element. I'll put an empty element for now, and see what xml2rfc does with it.
from asciidoctor-rfc.
From MMark only these elements are generated (from the rfc-openpgp-oscca draft):
<rfc ipr="trust200902" category="std" docName="draft-openpgp-oscca-02" updates="4880, 6637">
<?rfc toc="yes"?>
<?rfc symrefs="yes"?>
<?rfc sortrefs="yes"?>
<?rfc compact="yes"?>
<?rfc subcompact="no"?>
<?rfc private=""?>
<?rfc topblock="yes"?>
<?rfc comments="no"?>
...
</rfc>
Seems that the <boilerplate>
element is only used by "real" RFC Editor tools, and is not present in MMark generated RFC XML. In any case, the textual boilerplate, like licenses etc., are indeed generated by xml2rfc.
from asciidoctor-rfc.
Doctype is implemented, and is inheriting :article behaviour by default (since other doctype values are by exception).
Boilerplate element is not present in MMark output either, and is not required by XML2RFC. So closing this ticket.
from asciidoctor-rfc.
Perfect -- thank you @opoudjis !
from asciidoctor-rfc.
Related Issues (20)
- Render RFC references HOT 8
- Warn if section after appendix not marked up as appendix HOT 8
- In RFC style, backticks should be presented as double quotes HOT 7
- Tests failed on windows HOT 2
- AsciiRFC Internet-Draft bug HOT 2
- RELAXNG validation error: <eref> inside <spanx> HOT 4
- Extract references as entities HOT 7
- Line numbers / file path missing in WARNING messages HOT 3
- Uncertainty in allowed values of <workgroup> and <area> HOT 4
- Inconsistent behavior of `[source]` block without figure wrapper in v3/v2 HOT 3
- Build failure needs to be resolved HOT 32
- Asciidoctor-biblio workaround HOT 11
- Canonical references have dots HOT 1
- Add xml-stylesheet `rfc2629.xslt` HOT 2
- Handling IRTF Working Groups HOT 1
- Referencing the latest I-D BibXML causes resulting ENTITY to lose link HOT 2
- CR before literal/sourcecode HOT 5
- Automatic section referencing overrides explicit references HOT 8
- Test errors HOT 1
- `NOT RECOMMENDED` should be labeled as `<bcp14>`
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from asciidoctor-rfc.