RFCTool User Guide
draft-hallambaker-rfctool-04

Document Type Active Internet-Draft (individual)
Last updated 2019-12-31
Stream (None)
Intended RFC status (None)
Formats plain text html xml pdf htmlized (tools) htmlized bibtex
Stream Stream state (No stream defined)
Consensus Boilerplate Unknown
RFC Editor Note (None)
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to (None)
Network Working Group                                 P. M. Hallam-Baker
Internet-Draft                                            1 January 2020
Intended status: Informational                                          
Expires: 4 July 2020

                           RFCTool User Guide
                      draft-hallambaker-rfctool-04

Abstract

   RFCTool is a documentation tool for building specifications from
   multiple sources and multiple source formats.  Source formats
   currently supported are OOXML/Word, Markdown, XML2RFC and SVG.
   Publication formats supported are plaintext, HTML and XML2RFC.  This
   document provides information on how to use RFCTool to generate
   Internet Drafts and RFCs.

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 https://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 4 July 2020.

Copyright Notice

   Copyright (c) 2020 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 (https://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.

Hallam-Baker               Expires 4 July 2020                  [Page 1]
Internet-Draft             RFCTool User Guide               January 2020

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
     1.1.  Automating the editing process  . . . . . . . . . . . . .   3
   2.  Installing and Using RFCTool. . . . . . . . . . . . . . . . .   4
     2.1.  Installation  . . . . . . . . . . . . . . . . . . . . . .   4
     2.2.  Running RFCTool . . . . . . . . . . . . . . . . . . . . .   4
     2.3.  Converting files  . . . . . . . . . . . . . . . . . . . .   5
     2.4.  Creating Templates  . . . . . . . . . . . . . . . . . . .   5
     2.5.  Support for other standards organizations . . . . . . . .   6
   3.  Writing an RFCTool Document . . . . . . . . . . . . . . . . .   6
     3.1.  Document Metadata . . . . . . . . . . . . . . . . . . . .   6
     3.2.  References  . . . . . . . . . . . . . . . . . . . . . . .   7
       3.2.1.  Citations . . . . . . . . . . . . . . . . . . . . . .   7
       3.2.2.  Internal  . . . . . . . . . . . . . . . . . . . . . .   7
     3.3.  Including files . . . . . . . . . . . . . . . . . . . . .   7
       3.3.1.  Include . . . . . . . . . . . . . . . . . . . . . . .   7
       3.3.2.  Sourcecode  . . . . . . . . . . . . . . . . . . . . .   7
       3.3.3.  Images  . . . . . . . . . . . . . . . . . . . . . . .   8
   4.  Editing with Word . . . . . . . . . . . . . . . . . . . . . .   8
     4.1.  Metadata  . . . . . . . . . . . . . . . . . . . . . . . .   8
     4.2.  Character Styles  . . . . . . . . . . . . . . . . . . . .   8
     4.3.  Paragraph Styles  . . . . . . . . . . . . . . . . . . . .   9
     4.4.  Tables  . . . . . . . . . . . . . . . . . . . . . . . . .   9
   5.  Editing with Markdown . . . . . . . . . . . . . . . . . . . .   9
   6.  Markup Reference  . . . . . . . . . . . . . . . . . . . . . .   9
   7.  Document data . . . . . . . . . . . . . . . . . . . . . . . .   9
     7.1.  Authors . . . . . . . . . . . . . . . . . . . . . . . . .  10
   8.  Formatting  . . . . . . . . . . . . . . . . . . . . . . . . .  10
   9.  Processing Instructions . . . . . . . . . . . . . . . . . . .  10
   10. Acknowledgements  . . . . . . . . . . . . . . . . . . . . . .  10
   11. Security Considerations . . . . . . . . . . . . . . . . . . .  10
   12. IANA Considerations . . . . . . . . . . . . . . . . . . . . .  10
   13. Informative References  . . . . . . . . . . . . . . . . . . .  10

1.  Introduction

   RFCTool is a documentation tool for building specifications from
   multiple sources and multiple source formats.  A specification built
   using RFCTool typically comprises:

   *  A core document containing the bulk of the prose.

   *  Source code

   *  Diagrams

   *  Examples generated from running code

Hallam-Baker               Expires 4 July 2020                  [Page 2]
Internet-Draft             RFCTool User Guide               January 2020

   *  Reference material generated from schemas

   Automating the process of building specifications allows the
Show full document text