Re: Please look at your groups' charters rendered through markdown

Spencer Dawkins at IETF <spencerdawkins.ietf@gmail.com> Tue, 21 September 2021 19:21 UTC

Return-Path: <spencerdawkins.ietf@gmail.com>
X-Original-To: wgchairs@ietfa.amsl.com
Delivered-To: wgchairs@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 6ABA03A082D for <wgchairs@ietfa.amsl.com>; Tue, 21 Sep 2021 12:21:07 -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 cRHB48_ujhUP for <wgchairs@ietfa.amsl.com>; Tue, 21 Sep 2021 12:21:02 -0700 (PDT)
Received: from mail-vk1-xa2b.google.com (mail-vk1-xa2b.google.com [IPv6:2607:f8b0:4864:20::a2b]) (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 E36193A0829 for <wgchairs@ietf.org>; Tue, 21 Sep 2021 12:21:01 -0700 (PDT)
Received: by mail-vk1-xa2b.google.com with SMTP id z202so150034vkd.1 for <wgchairs@ietf.org>; Tue, 21 Sep 2021 12:21:01 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=wRpwvj8dnnKCLZOCPKhT5ydr0k0fw2iObgtKOo/U81w=; b=nUqcr1+rY1TcYeNRZfynHtZ3pZlERf4Hqgm7f47YzfNhqLVuHtzgu730BDhHp4vopM pquZvSVc9uNBd2pPsvwEdYxD+C5SHdYwJaNjiTcTbTABbkbX8rTyKwMZkVlnCw95kGAH G0o4Ag6Q2VyWNNdiVfqogN+ZNyvQBA8boVFB9VmSmcrq0B8aGi0cpyIL5EY3swsIijdF W2jn+ioA3mtCjEK4By2Fdqn6HwvsEU4FYmDSu+fXL2N2+lzPHk+hXMSp9Tw2a0y+jVT0 wTa4O9bTrjG+hBmH7R+q6Tdhpv2Qfbswg1GGKqWwgJvT17cf269Zfm3LrvqZrgrfU7QT RT2w==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=wRpwvj8dnnKCLZOCPKhT5ydr0k0fw2iObgtKOo/U81w=; b=ivWYvx7AiP9CLXKpTRus+vGQ9k09mwiy8T2/79PxPy56jYbxXjU704kpwIHD29w1Dz /CcKR6/b67d7jB8HYQALlm8XAPv2F1KNCMjL4wEEBzLApLY6YKI361M/18qSNyZErpLF 0O+f4FbYZcNazpbIJILaAmWWlYr9YbRwJJdBxximXUPvcYKIxBEbftzdTdSjwWzaIisj F6XHQXd2vfLtFncn32fW+dQakmZ9VJSRKooLqbSiMLHv2gzkfgkQBq5AsK71fxV5gRDd iiMSZZB07vw85+erC50LzofIW6C5DVxXTXkBWv7djg9U6d6Yp6lDwpYCeNzUiBm0IpeR AwQw==
X-Gm-Message-State: AOAM532RSJio9Fqr+89jFi180BLdHRYh6677xcJRaYyGHvhMfE8MKWht 3FtAAC7bIyPyhIy9UTzeN2b8nTOZfWzJ680rRrfACx61j1k=
X-Google-Smtp-Source: ABdhPJyM1oo9S5BSlf/4Z+jMPiReqHTE2LJpJyOEZ3y9tKdZeCsOVHmxRL9drLML/ncAhGXoLTlQqGg2qAmdld6jRMI=
X-Received: by 2002:a1f:a916:: with SMTP id s22mr8204967vke.9.1632252060561; Tue, 21 Sep 2021 12:21:00 -0700 (PDT)
MIME-Version: 1.0
References: <91a7eae6-6752-9c25-648a-69c4b75d600b@nostrum.com> <C7840DDC-D58F-4509-8E35-C260C6B327F3@eggert.org> <4b587a46-6443-a4b1-d532-a47fbc86b39a@nostrum.com> <YUoNE+WFrQsHbl3c@faui48e.informatik.uni-erlangen.de> <0cc0f585-991e-68a3-44a2-f0ae28d4f9ce@nostrum.com>
In-Reply-To: <0cc0f585-991e-68a3-44a2-f0ae28d4f9ce@nostrum.com>
From: Spencer Dawkins at IETF <spencerdawkins.ietf@gmail.com>
Date: Tue, 21 Sep 2021 14:20:34 -0500
Message-ID: <CAKKJt-cS7chGZL6V7QjQVf+L37_5i56kzXcqbxfOhJ7EV7caAw@mail.gmail.com>
Subject: Re: Please look at your groups' charters rendered through markdown
To: Robert Sparks <rjsparks@nostrum.com>
Cc: Toerless Eckert <tte@cs.fau.de>, Working Chairs <wgchairs@ietf.org>
Content-Type: multipart/alternative; boundary="00000000000040f3fb05cc864ca1"
Archived-At: <https://mailarchive.ietf.org/arch/msg/wgchairs/Wx5pA1tbhLSEiKI3-nIkrGuJRuI>
X-BeenThere: wgchairs@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Working Group Chairs <wgchairs.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/wgchairs>, <mailto:wgchairs-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/wgchairs/>
List-Post: <mailto:wgchairs@ietf.org>
List-Help: <mailto:wgchairs-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/wgchairs>, <mailto:wgchairs-request@ietf.org?subject=subscribe>
X-List-Received-Date: Tue, 21 Sep 2021 19:21:08 -0000

Robert,

Top-posting to say "thank you for the clues".

Best,

Spencer

On Tue, Sep 21, 2021 at 12:44 PM Robert Sparks <rjsparks@nostrum.com> wrote:

>
> On 9/21/21 11:49 AM, Toerless Eckert wrote:
> > Nice job already, thanks a lot, Robert & team!
> >
> > On Mon, Sep 20, 2021 at 02:29:38PM -0500, Robert Sparks wrote:
> >> And here we hit the issues with the different versions of markdown at
> >> different sites.
> >>
> >> Github markdown treats leading space differently than Gruber's markdown.
> > Can we please have an authoritative documentation of the markup used
>
> Right now, the authoritative documentation is at the links I sent below
> (into Pypi and at daringfireball).
>
> To save you a little digging, very relevant spots are at
>
> https://python-markdown.github.io/#Features
>
> and
>
> https://daringfireball.net/projects/markdown/syntax
>
> (and because I've turned on "extra"
>
> https://python-markdown.github.io/extensions/extra/
>
> >
> > and a web page that will render an input text ?
>
> As a workaround for now, you can do this locally as documented here:
>
> https://python-markdown.github.io/cli/
>
> for example: (env) rjsparks@unformal markdown % python -m markdown -x
> extra src.md
>
>
> >
> > That way chairs can see how a version of a charter will look that
> > they have fixed up with the best rendering options for their charter
> text.
> > That should minimize work for the tools team to enhance/fixup the markup.
> >
> > If we need fixups, they should be in the way of wrappers to
> > avoid local versioning of an actual markup, such as done with
> > kramdown-rfc2629. For example to convert markup for
> > well known names such as RFC* and draft-* into URLs.
> >
> > Cheers
> >      Toerless
> >
> >> The relevant part of the source for the thing ending up with a different
> >> rendering looks like this (via hexdump -C). Best viewed in fixed width.
> >>
> >> 00000100  6c 65 64 20 62 65 6c 6f  77 3a 0a 0a 20 20 20 31  |led
> below:..
> >> 1|
> >> 00000110  2e 20 54 68 65 20 66 69  72 73 74 20 61 72 65 61  |. The first
> >> area|
> >> 00000120  20 6f 66 20 77 6f 72 6b  20 69 73 20 6d 61 69 6e  | of work is
> >> main|
> >> 00000130  74 65 6e 61 6e 63 65 20  61 6e 64 20 65 76 6f 6c |tenance and
> >> evol|
> >> 00000140  75 74 69 6f 6e 20 6f 66  20 74 68 65 20 65 78 69 |ution of the
> >> exi|
> >> 00000150  73 74 69 6e 67 20 51 55  49 43 20 73 70 65 63 69 |sting QUIC
> >> speci|
> >> 00000160  66 69 63 61 74 69 6f 6e  73 3a 0a 0a 20 20 20 20 |fications:..
> >> |
> >> 00000170  20 20 20 20 20 2a 20 4d  61 69 6e 74 65 6e 61 6e |     *
> >> Maintenan|
> >> 00000180  63 65 20 61 6e 64 20 65  76 6f 6c 75 74 69 6f 6e  |ce and
> >> evolution|
> >> 00000190  20 6f 66 20 74 68 65 20  51 55 49 43 20 62 61 73  | of the
> QUIC
> >> bas|
> >> 000001a0  65 20 73 70 65 63 69 66  69 63 61 74 69 6f 6e 73  |e
> >> specifications|
> >>
> >> That is, there are 9 spaces before what you intend to be a bullet mark.
> >>
> >> For what's at https://pypi.org/project/Markdown/ (implementing
> >> https://daringfireball.net/projects/markdown/) anything that starts
> with 4
> >> or more spaces or a tab is a blockquote.
> >>
> >> Do you easily see a single input file that gets the desired output out
> of
> >> both renderers?
> >>
> >> RjS
> >>
> >> On 9/20/21 2:17 PM, Lars Eggert wrote:
> >>> On 2021-9-20, at 20:34, Robert Sparks <rjsparks@nostrum.com> wrote:
> >>>> Bring any issues with the markdown rendering of the current charter
> text to me.
> >>> Not my group anymore, but QUIC looks a bit odd:
> https://datatracker.ietf.org/group/quic/about/rendertest/
> >>>
> >>> That should be an indented bullet list under 1., as shown on
> https://github.com/quicwg/wg-materials/blob/main/charter/charter.md
> >>>
> >>> Thanks,
> >>> Lars
> >>>
>
>