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

Tim Wicinski <tjw.ietf@gmail.com> Fri, 04 September 2020 09:30 UTC

Return-Path: <tjw.ietf@gmail.com>
X-Original-To: rfc-markdown@ietfa.amsl.com
Delivered-To: rfc-markdown@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 853D93A0C7E; Fri, 4 Sep 2020 02:30:41 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.097
X-Spam-Level:
X-Spam-Status: No, score=-2.097 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, HTML_MESSAGE=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=gmail.com
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 OH_GXY9qBQA3; Fri, 4 Sep 2020 02:30:39 -0700 (PDT)
Received: from mail-oi1-x22f.google.com (mail-oi1-x22f.google.com [IPv6:2607:f8b0:4864:20::22f]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 219253A0C6F; Fri, 4 Sep 2020 02:30:39 -0700 (PDT)
Received: by mail-oi1-x22f.google.com with SMTP id x14so5924365oic.9; Fri, 04 Sep 2020 02:30:39 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=nE3LP5HDZGsu0Sn0GN0wG0YmznjK/2k+TloHoKpobvU=; b=uvWhAgnIirb97mUUzHJGHGbZUWQRJM0evPQjlWG49O42ki5/nT0kYZoai76NsIa0bW sTa2R7fTNAb5oSs5tBIENVUlJesAka5ZYNI+UR5uMcl3vqjRforNz4udhcUtgXLBhXF8 BGzQ80G1qUtY0D1Q9HavX9RTaWIq8Za7LT+HwRzZ74gdB3t3KQQsSucbMxp4Th8GZ+XN IGHkjclSf6JCZ66Rn9U2B6pnk+VO27twPXWyKAM4dMEKqGK9ashwK8FTuyS1McZqPFtu Ntn+722bIZzUgoqXzROJ58zHvWl37xxCScV/9e2OAkWJlVE+VE1laS7TU9Jvt0KXefbc iKwg==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=nE3LP5HDZGsu0Sn0GN0wG0YmznjK/2k+TloHoKpobvU=; b=dnf3PeohkSyJ8xrW2KFK/1R3+QAv2NWFkabfEdxKvg9OGS/cnH3l5dQ9XzQJyyloMh 0+z1gsOJ5Yfx9r8sQzwU2eW7JD0e1AJEMWNuxH13bnpIn+cdl0wd1PD2y3K+mSnEeqyE wCm4m7I/fjnQhikyr9YBAgdXmOn8Fqd+rZ8nRFtHGA/5HmzK1JF4HGw3UbaYrIaZi0tL HcIsotBWhTHRsgSvgoqvFRLRjProi5rwKYUkeM2ADQ2CXrUMuZNVkR2Fd3HgRC3rrzXQ tUIm6Fh5dmNct0ix6ecYKm+ABJ4vI6F4N6+O+CLUp0RjV+NZirwbbTLDh5V9rJKaFOJf mWgg==
X-Gm-Message-State: AOAM531wz4CIONLLChxD23FK9c2JCKQhsDpNWoRLxMtRbp7m+2DvcYP/ vwRyp+mKW/jFZrXCz0+TQfEDlMGuC14INJ97Nxz/hkc1sC0=
X-Google-Smtp-Source: ABdhPJyI1RscquJlmTF/BJWfAG1DvbotvCD+GsrFKSTUZB5Gq2414S+KV6YF/gmtQv4PHLFhXwT8LFWK/gV0sSZVaec=
X-Received: by 2002:a05:6808:9b9:: with SMTP id e25mr4473731oig.173.1599211838371; Fri, 04 Sep 2020 02:30:38 -0700 (PDT)
MIME-Version: 1.0
References: <E1kDR4G-0008G7-M9@durif.tools.ietf.org> <4a9228c8-9dab-9500-b1ca-44560febd97a@levkowetz.com>
In-Reply-To: <4a9228c8-9dab-9500-b1ca-44560febd97a@levkowetz.com>
From: Tim Wicinski <tjw.ietf@gmail.com>
Date: Fri, 04 Sep 2020 05:30:27 -0400
Message-ID: <CADyWQ+ESOOhM24H=-WVZzUekGW=7+=amvyLp=qHkCxBpRcq4tg@mail.gmail.com>
To: Henrik Levkowetz <henrik@levkowetz.com>
Cc: xml2rfc-dev@ietf.org, xml2rfc@ietf.org, rfc-markdown@ietf.org
Content-Type: multipart/alternative; boundary="0000000000008bfcfc05ae7985f8"
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-markdown/MkL6I4axVd9j_KXUOPzmPGxsAHA>
Subject: Re: [Rfc-markdown] [xml2rfc-dev] 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: Fri, 04 Sep 2020 09:30:42 -0000

Thanks for these notes Henrik, and for 3.0.

I'd also suggest if you're moving to python3 (I will not judge here), I did
much work with
virtualenv to not blow up your system python.   Glad to assist.

tim


On Thu, Sep 3, 2020 at 2:25 PM Henrik Levkowetz <henrik@levkowetz.com>
wrote:

> Hi,
>
> I've had a few questions related to installation of this release, so I
> might as well add some notes about installation.  The the following
> approach should work.  You may need to adapt slightly to fit your
> environment:
>
>  1. If you don't have Python 3.5 or higher, install it.  You can get it
>     here: https://www.python.org/downloads/ .  I'll assume python 3.8 in
>     the following.  (If this fails, you should not go on with the remaining
>     steps -- you're stuck with the previous version of xml2rfc until you
>     can get a Python 3 running.)
>
>  2. If you have xml2rfc installed for Python 2.7 currently:
>     Run 'pip2.7 uninstall -y xml2rfc' # repeat until no version installed
>     (Possibly you might need to do 'sudo pip2.7 uninstall -y xml2rfc' or
>     the equivalent)
>
>  3. Install for your python 3.  Pip3.x should not need to run as sudo or
>     equivalent on most OSes:
>     Run 'pip3.8 install --upgrade xml2rfc'
>
>  4. If you have id2xml installed, make sure it's installed for the same
>     python version as xml2rfc; for instance if you're moving from 2.7 to
> 3.8:
>     'pip2.7 uninstall -y id2xml'  (or 'sudo pip2.7 uninstall -y id2xml')
>     followed by 'pip3.8 install id2xml'
>
>
> I hope this is helpful.
>
>
> Best regards,
>
>         Henrik
>
> On 2020-09-02 13:36, Henrik Levkowetz wrote:
> >
> > Hi,
> >
> > 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
> >     entries.
> >
> >   * 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
> >     accordingly.
> >
> >   * 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
> > manually.
> >
> > 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:
> >   https://xml2rfc.tools.ietf.org/xml2rfc-doc-3.0.0.html
> >
> > Regards,
> >
> >       Henrik
> >       (via the mkrelease script)
> >
> > _______________________________________________
> > xml2rfc mailing list
> > xml2rfc@ietf.org
> > https://www.ietf.org/mailman/listinfo/xml2rfc
> >
>
> _______________________________________________
> Rfc-markdown mailing list
> Rfc-markdown@ietf.org
> https://www.ietf.org/mailman/listinfo/rfc-markdown
>