[Rfc-markdown] New xml2rfc release: v3.0.0

Henrik Levkowetz <henrik@levkowetz.com> Wed, 02 September 2020 11:36 UTC

Return-Path: <henrik@levkowetz.com>
X-Original-To: rfc-markdown@ietfa.amsl.com
Delivered-To: rfc-markdown@ietfa.amsl.com
Received: from localhost (localhost []) by ietfa.amsl.com (Postfix) with ESMTP id 10B133A0F41; Wed, 2 Sep 2020 04:36:47 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.899
X-Spam-Status: No, score=-1.899 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Received: from mail.ietf.org ([]) by localhost (ietfa.amsl.com []) (amavisd-new, port 10024) with ESMTP id bxamMI-WrzYV; Wed, 2 Sep 2020 04:36:44 -0700 (PDT)
Received: from durif.tools.ietf.org (durif.tools.ietf.org [IPv6:2001:1900:3001:11::3d]) (using TLSv1.2 with cipher DHE-RSA-AES128-SHA (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id D8BCA3A0F3B; Wed, 2 Sep 2020 04:36:44 -0700 (PDT)
Received: from henrik by durif.tools.ietf.org with local (Exim 4.80) (envelope-from <henrik@levkowetz.com>) id 1kDR4G-0008G7-M9; Wed, 02 Sep 2020 04:36:44 -0700
To: xml2rfc-dev@ietf.org, xml2rfc@ietf.org
Cc: rfc-markdown@ietf.org
Message-Id: <E1kDR4G-0008G7-M9@durif.tools.ietf.org>
From: Henrik Levkowetz <henrik@levkowetz.com>
Date: Wed, 02 Sep 2020 04:36:44 -0700
X-SA-Exim-Connect-IP: <locally generated>
X-SA-Exim-Rcpt-To: rfc-markdown@ietf.org, xml2rfc-dev@ietf.org, xml2rfc@ietf.org
X-SA-Exim-Mail-From: henrik@levkowetz.com
X-SA-Exim-Scanned: No (on durif.tools.ietf.org); SAEximRunCond expanded to false
X-Clacks-Overhead: GNU Terry Pratchett
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-markdown/-lKPmByUoKIPreugyyYmVHkQKoY>
Subject: [Rfc-markdown] New xml2rfc release: v3.0.0
X-BeenThere: rfc-markdown@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: "rfc-markdown is a discussion list for people writing I-Ds and RFCs in Markdown and the authors of the tools used for that." <rfc-markdown.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/rfc-markdown>, <mailto:rfc-markdown-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/rfc-markdown/>
List-Post: <mailto:rfc-markdown@ietf.org>
List-Help: <mailto:rfc-markdown-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/rfc-markdown>, <mailto:rfc-markdown-request@ietf.org?subject=subscribe>
X-List-Received-Date: Wed, 02 Sep 2020 11:36:47 -0000


This is an automatic notification about a new xml2rfc release, 
v3.0.0, generated when running the mkrelease script.

Release notes:

xml2rfc (3.0.0) ietf; urgency=medium

  **Transition to using the new schema v3 output formatters by default**

  This release provides the functionality that the 2.47.0 release had (with
  some enhancements), but is backwards incompatible because the default
  settings for some switches has changed.  The --legacy switch must now be set
  explicitly in order to use the old output formatters.  By default, XML input
  files with schema v2 content will be converted to v3 on the fly and the
  output formatting of the converted XML will be done with the new schema v3
  formatters.  With this release, support of Python 2.7, which is past
  end-of-life, will no longer be part of the test suite.

  There are also a number of other changes.  From the commit log:

  * Replaced the use of the deprecated optparse module with the newer 
    argparse python module.

  * Removed testing with Python 2.7, and added Python 3.8

  * Updated the bin/mkrelease script to generate documentation HTML and text
    for the release, place it on xml2rfc.tools.ietf.org, and mention the
    documentation URL in the release notes.

  * Updated the major revision to 3, given that we no longer support Py27 and
    have switched default output formatters.

  * Changed bin/mkrelease to install using pip3.6 on the tools servers (the 
    default pip might be for Py2.7).

  * Added an 'indent' attribute for <t>, in order to support indented
    paragraphs without the one-item unordered list workaround, as approved by
    the schema change board.  Added default values for the 'indent' attributes
    for <dl>, <ul>, <ol>, <t>.  For the <t> element, the 'indent' attribute
    indicates any extra amount of indentation to be used when rendering the
    paragraph of text.  The indentation amount is interpreted as characters when
    rendering plain-text documents, and en-space units when rendering in formats
    that have richer typographic support such as HTML or PDF.  One en-space is
    assumed to be the length of 0.5 em-space in CSS units.  Only non-negative
    integer amounts of indentation are supported.

  * Improved an error message about bad attribute values to show the line 
    of XML source on which the error was found.

  * Added information about command-line switches that have negations 
    (--no-foo... versions) to the context handed to the documentation template.

  * Changed the default of some switches for the 3.0.0 release: --v3 => 
    true; --legacy-date => true; --external-js => false.

  * Improved the documentation file output for switch default values and 
    for options with negation switches.

  * Updated the Makefile to use the appropriate 3.x release series switches.

  * Updated the requirements for a number of python modules.

  * Fixed an issue where hrefs without matching ids could be generated by 
    the HTML renderer from empty <name> elements.  This also fixed an issue 
    with missing figure and table captions in some unusual cases.

  * Added support for multi-level ordered lists through a '%p' (for parent) 
    code for use in the <ol> 'type' attribute.  Fixes issue #465.

  * Added more documentation for the --version switch

  * Updated the schema and tests to permit <blockquote> within <aside>.  
    Fixes issue #524.

  * Added a list of available postal elements for a country to the warning 
    for unused postal address parts.

  * Added a length limitation for the running header title in paginated 
    text documents, to avoid overwriting other parts of the running header.

  * Changed the schema to permit nested <sub> and <sup>, as approved by the
    v3 schema change board.

  * Added support for outdent handling to propagate upwards to parent 
    elements if the full needed outdent amount could not be done in the local 
    context, in order to be able to apply artwork outdenting to <artwork> 
    elements which aren't situated immediately under <section>.

  * Changed many instances of reference source indications (xml:base) from
    "xml2rfc.tools.ietf.org" to just "xml2rfc.ietf.org".  Removed the massaging
    of reference XML to place seriesInfo elements in the backwards-incomplatible
    location inside reference/front.  Changed the --add-xinclude flag to use
    datatracker.ietf.org/doc/bibxml3/ as the location of draft reference

  * Added a couple of entries to the test suite reference cache.

  * Improved the handling of missing day information for <date> to make sure we 
    don't pick days outside the acceptable range for the given month and also 
    pick a reasonable value based on whether the year and month is in the past, 
    present or future.

  * Improved an error message for a case of disallowed XML text content.  
    Tweaked the 'block_tags' list.

  * Changed the manpage template to not use comma before 'and' when 
    rendering a list of 2 elements.

  * Changed the schema to permit <aside> within <dl> on request from the 
    RPC, with schema change board approval.  Updated renderers, CSS and tests 

  * Tweaked the CSS for block elements that are direct first children of 
    <dd> to render the same way in HTML as in text (i.e., vertically distinct, 
    not on the same line as <dt>).

 -- Henrik Levkowetz <henrik@levkowetz.com>  01 Sep 2020 08:06:27 +0000

The preferred way to install xml2rfc is by doing 'pip install xml2rfc',
and 'pip install --upgrade xml2rfc' to upgrade.  If there are system-
installed python modules which pip will not upgrade, you may have to
use 'pip install --upgrade --no-deps xml2rfc' and install dependencies

The new version is also available through SVN checkout, with
  'svn checkout http://svn.tools.ietf.org/svn/tools/xml2rfc/tags/cli/3.0.0'

Documentation for this release is built-in, and also available at:


	(via the mkrelease script)