[xml2rfc-dev] New xml2rfc release: v2.47.0
Henrik Levkowetz <henrik@levkowetz.com> Fri, 17 July 2020 21:09 UTC
Return-Path: <henrik@levkowetz.com>
X-Original-To: xml2rfc-dev@ietfa.amsl.com
Delivered-To: xml2rfc-dev@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1])
by ietfa.amsl.com (Postfix) with ESMTP id 0FDA53A043E;
Fri, 17 Jul 2020 14:09:31 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.899
X-Spam-Level:
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 ([4.31.198.44])
by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024)
with ESMTP id pV21DTc3ZnRy; Fri, 17 Jul 2020 14:09:29 -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 55FFF3A0433;
Fri, 17 Jul 2020 14:09:29 -0700 (PDT)
Received: from henrik by durif.tools.ietf.org with local (Exim 4.80)
(envelope-from <henrik@levkowetz.com>)
id 1jwXbl-0007H8-5R; Fri, 17 Jul 2020 14:09:29 -0700
To: xml2rfc-dev@ietf.org, xml2rfc@ietf.org
Cc: rfc-markdown@ietf.org
Message-Id: <E1jwXbl-0007H8-5R@durif.tools.ietf.org>
From: Henrik Levkowetz <henrik@levkowetz.com>
Date: Fri, 17 Jul 2020 14:09:29 -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/xml2rfc-dev/cIMVJSkxd6KllDzUT1BNQnvYgB4>
Subject: [xml2rfc-dev] New xml2rfc release: v2.47.0
X-BeenThere: xml2rfc-dev@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: "Discussion about particulars of xml2rfc V3 design,
development and code." <xml2rfc-dev.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/xml2rfc-dev>,
<mailto:xml2rfc-dev-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/xml2rfc-dev/>
List-Post: <mailto:xml2rfc-dev@ietf.org>
List-Help: <mailto:xml2rfc-dev-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/xml2rfc-dev>,
<mailto:xml2rfc-dev-request@ietf.org?subject=subscribe>
X-List-Received-Date: Fri, 17 Jul 2020 21:09:31 -0000
Hi,
This is an automatic notification about a new xml2rfc release,
v2.47.0, generated when running the mkrelease script.
Release notes:
xml2rfc (2.47.0) ietf; urgency=medium
**CSS fixes, Built-in documentation, manpage mode, and more**
The major feature in this release is the addition of built-in documentation
generated from:
- the actual XML schema distributed with the tool
- the differences between the current schema and the RFC7991 schema
- the code's settings for which elements and attributes are deprecated
- text snippets describing the schema parts and how the code handles them.
There are new --doc/--docfile and --man/--manpage switches; the first will
generate documentation in the form of a v3 XML document that can then itself
be processed to generate the various supported formats. The second, --man,
will generate the documentation XML internally and then process it to text
output which is shown with a pager, like 'man'.
From the commit log:
* Corrected the CSS line height of compact lists (it should not be different
than for non-compact lists; compact should only affect spacing between
items, not line height). Also corrected the CSS top margin for nested
lists; extra top margin is desired for a top-level list, but not when
nesting them, due to the resulting inconsistency in apparent line height
variations.
* Changed <section> within <toc> from oneOrMore to zeroOrMore, in order to
make it possible to honour the tocInclude setting, and reordered some
true/false entries for consistency, and changed the line breaking of some
lines in the RNG compact representation to fit on 72-character lines.
* Added .rng and .rnc files with the RFC7991 schema, in order to be able to
automatically determine which elements and attributes are new in the schema
since 7991.
* Added a new writer, 'doc', and template and text snippet files for
autogenerated documentation.
* Updated the requirements file with some new module requirements.
* Refactured the code a bit to make it more straightforward to generate
text without writing it out to file.
* Moved the list of deprecated attributes to writers/base.py, and did some
slight refactoring for consistent naming of some class variables and
avoidance of duplicate parsing of the schema file.
* Did some minor code cleanup and dead code removal, and corrected the
header generation for non-IETF documents (using <rfc ipr=''>).
* Fixed an issue where XML parser errors could be reported for '<string>'
instead of the actual input file name.
* Added new options --docfile/--doc and --manpage/--man, used to trigger
generation and display of the built-in documentation. Reorganised the
option grouping. Updated some option help strings. Made it possible to
propagate all command-line option information to the documentation template.
* Corrected the default templates path. This is related to change [3723].
* Reverted a change from [3722] in the v2v3 converter.
* Added a custom Jinja2 filter 'capfirst()', for use in the documentation
template.
* Tweaked the documentation template: Some changed wording, support for
sub-items not wrapped in <t>, corrected capitalisation using the 'capfirst'
filter.
* Updated hastext() and iscomment() to do the right thing if given
content with embedded xml processing instructions.
* Tweaked the handling of default values for --date, so as to give better
documentation of the option, and also tweaked the help text for
--table-borders.
* Added a class utility method to get any current PI related to a given
setting, and fixed another case of template path default value, related to
[3722].
* Added PI support for text table borders setting, and improved the text
table output for transitions between <th> and <td> rows> for 'light' and
'minimal' borders.
* Added makefile support for testing of the --manpage and --docfile
switches. Added silencing of one unavoidable warning in the test of
--unprep.
-- Henrik Levkowetz <henrik@levkowetz.com> 17 Jul 2020 14:07:39 -0700
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
manually.
The new version is also available through SVN checkout, with
'svn checkout http://svn.tools.ietf.org/svn/tools/xml2rfc/tags/cli/2.47.0'
Regards,
Henrik
(via the mkrelease script)
- [xml2rfc-dev] New xml2rfc release: v2.47.0 Henrik Levkowetz