Using Markup in YANG Text Arguments
draft-lhotka-netmod-yang-markup-00

Document Type Active Internet-Draft (individual)
Last updated 2017-03-09
Stream (None)
Intended RFC status (None)
Formats plain text xml pdf html bibtex
Yang Validation 0 errors, 0 warnings.
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)
NETMOD Working Group                                           L. Lhotka
Internet-Draft                                                    CZ.NIC
Intended status: Standards Track                          March 09, 2017
Expires: September 10, 2017

                  Using Markup in YANG Text Arguments
                   draft-lhotka-netmod-yang-markup-00

Abstract

   This document defines a YANG extension that allows for specifying a
   media type for text in the arguments of these YANG statements:
   "contact", "description", "error-message", "organization" and
   "reference."

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 September 10, 2017.

Copyright Notice

   Copyright (c) 2017 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.

Lhotka                 Expires September 10, 2017               [Page 1]
Internet-Draft                 i-d-abbrev                     March 2017

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Terminology . . . . . . . . . . . . . . . . . . . . . . . . .   3
   3.  Declaring the Media Type of Text Arguments  . . . . . . . . .   3
   4.  YANG Module . . . . . . . . . . . . . . . . . . . . . . . . .   4
   5.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   6
   6.  Security Considerations . . . . . . . . . . . . . . . . . . .   7
   7.  References  . . . . . . . . . . . . . . . . . . . . . . . . .   7
     7.1.  Normative References  . . . . . . . . . . . . . . . . . .   7
     7.2.  Informative References  . . . . . . . . . . . . . . . . .   7
   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .   8

1.  Introduction

   Descriptions play an important role in YANG data models.  They may
   specify normative semantic constraints that cannot be expressed
   formally, instructions for implementors of the data model, and other
   vital information.  That is why descriptions often comprise several
   paragraphs of text and sometimes also other structures such all
   numbered or bulleted lists.

   So far, YANG modules have mostly used only plain text in the argument
   of the "description" statement, i.e., formatted text structures using
   just whitespace.  This is generally sufficient for human readers and
   also for including YANG modules in RFC documents, but less so for
   tools that are designed to process or use YANG modules in other ways,
   for example:

   o  converting YANG compact syntax to other formats (YIN, HTML)

   o  including YANG modules in standards and other documents whose
      source form in not plain text

   o  including description text in user interface elements.

   The above considerations also apply, albeit to a lesser extent, to
   other YANG statements with more structured arguments: "contact",
   "error-message", "organization" and "reference".

   In principle, it is possible to use any kind of markup such as
   markdown [RFC7764] but doing so would not be not very effective and
   tool-friendly unless the markup format is either standardized or
   declared in the module source.

   This document defines a YANG extension statement, "text-media-type",
   that can be placed as a substatement of the "module" or "submodule"
   statement to indicate the media type that is used throughout the

Lhotka                 Expires September 10, 2017               [Page 2]
Internet-Draft                 i-d-abbrev                     March 2017
Show full document text