[rfc-i] [Tools-discuss] Proposed survey on I-D authoring tools

Jay Daley jay at ietf.org
Wed Sep 30 19:19:08 PDT 2020

Thanks Dale

> On 1/10/2020, at 3:05 PM, Dale R. Worley <worley at ariadne.com> wrote:
> Jay Daley <jay at ietf.org> writes:
>> [QUESTION - Matrix/Rating Scale]
>> How often have you used the following document format(s) and associated output process(es) (editor/template/converter) when authoring an I-D? (Ignore any you don’t know about)
>> Items
>> 	• Plain text using no markup
>> 	• Plain text using a different output process
>> 	• Markdown using the kramdown-rfc2629 converter
>> 	• Markdown using the mmark converter
>> 	• Markdown using the draftr converter
>> 	• Markdown using the Pandoc2rfc converter
>> 	• Markdown using a different output process
>> 	• XML using the XMLMind editor and xml2rfc-xxe
>> 	• XML using a different output process
>> 	• AsciiDoc using the metanorma-ietf (formerly known as asciidoctor-rfc) converter
>> 	• AsciiDoc using a different output process
>> 	• TeX / LaTeX using Lyx editor and lyx2rfc
>> 	• TeX / LaTeX using a different output process
>> 	• nroff using the Nroff Edit editor
>> 	• nroff using nroff2xml template
>> 	• nroff using a different output process
>> 	• Microsoft Word rich text using Joe Touch’s Word Template (RFC5385)
>> 	• Microsoft Word rich text using a different output process (This means specifically using rich text styles that a template/convertor will recognise, it does not mean using this an editor for one of the other formats)
>> 	• Other format (Only use this option if you author in a different format to all of those above) [PLEASE SPECIFY what format you author in and what output process you use]
> There seem to be category inconsistency here.  It appears to me that the
> major differentiator in this list is "What do you write the I-D in?",
> viz., plain text, markdown, XML, AsciiDoc, TeX, nroff, MS Word.  Then
> attached to that is "How do you output the I-D from that source?", which
> seems to be "no markup", "a different output process", etc., etc.  And
> then there's the element "What tool do you use to write the source?",
> which can vary from completely unstated to tools specifically designed
> to write I-Ds (e.g., Joe Touch's Word template).
> What makes the choices hard to parse is that while all of the choices
> contain the source file type, only some specify the editing tool, and
> only some have the output process.  E.g., there are "XMLMind editor ->
> XML -> xml2rfc", "XML -> a different output process", and "plain text",
> each of which specifies a different subset of these elements.
> Perhaps splitting out the three elements would make the choices clearer,
> and possibly allow you to cover the universe of possibilities more
> thoroughly.

I initially wrote this with those elements split out but from early reviews it became clear that was just too complex because the two elements of format and output tool are so closely linked and we actually need to understand that as a whole process.

I suspect I need to add something to explain that we’re not really interested in what the editor is and the only reason we mentioned editors is because they are tied to the specific output tools.  i.e. lyx2rfc only works with lyx, xml2rfc-xxe only works with XMLMind, nroff Edit is a standalone product solely for I-D authoring, and Joe Touch’s template only works on MS Word.  I could reword those as

- Tex / LaTeX using lyx2rfc (requires Lyx)
- XML using xml2rfc-xxe (requires XMLMind)
- MS Rich text using Joe Touch’s Word Template (requires MS Word)

Does that work better?


> Dale

Jay Daley
IETF Executive Director
jay at ietf.org

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.rfc-editor.org/pipermail/rfc-interest/attachments/20201001/756d8884/attachment.html>

More information about the rfc-interest mailing list