Re: [Rfc-markdown] [rfc-i] Problem with Kramdown tooling and figures?

Jay Daley <exec-director@ietf.org> Wed, 08 June 2022 13:24 UTC

Return-Path: <exec-director@ietf.org>
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 8683EC157B45 for <rfc-markdown@ietfa.amsl.com>; Wed, 8 Jun 2022 06:24:26 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.909
X-Spam-Level:
X-Spam-Status: No, score=-1.909 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Received: from mail.ietf.org ([50.223.129.194]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id QUZ1Y5lukZov for <rfc-markdown@ietfa.amsl.com>; Wed, 8 Jun 2022 06:24:22 -0700 (PDT)
Received: from ietfx.amsl.com (ietfx.amsl.com [50.223.129.196]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id AB5CCC14F72B for <rfc-markdown@ietf.org>; Wed, 8 Jun 2022 06:24:22 -0700 (PDT)
Received: from localhost (localhost [127.0.0.1]) by ietfx.amsl.com (Postfix) with ESMTP id 9E6D240D10D9; Wed, 8 Jun 2022 06:24:22 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
Received: from ietfx.amsl.com ([50.223.129.196]) by localhost (ietfx.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id eIR3d97z0L1F; Wed, 8 Jun 2022 06:24:22 -0700 (PDT)
Received: from smtpclient.apple (host-92-27-125-209.static.as13285.net [92.27.125.209]) by ietfx.amsl.com (Postfix) with ESMTPSA id ED28640A55B4; Wed, 8 Jun 2022 06:24:21 -0700 (PDT)
Content-Type: text/plain; charset="utf-8"
Mime-Version: 1.0 (Mac OS X Mail 16.0 \(3696.100.31\))
From: Jay Daley <exec-director@ietf.org>
In-Reply-To: <MN2PR11MB375776E0FFAA1023CFE4334AB9A49@MN2PR11MB3757.namprd11.prod.outlook.com>
Date: Wed, 08 Jun 2022 14:24:19 +0100
Cc: "rfc-markdown@ietf.org" <rfc-markdown@ietf.org>, RFC Interest <rfc-interest@rfc-editor.org>
Content-Transfer-Encoding: quoted-printable
Message-Id: <99D6215E-50DA-422C-96D1-50949951394D@ietf.org>
References: <MN2PR11MB37570F4603464349B5DFFE5AB9A59@MN2PR11MB3757.namprd11.prod.outlook.com> <5E5D4003-E3D8-49B2-B14D-5D4AC7ADA0A3@tzi.org> <MN2PR11MB3757F2B3467FA1B188A1294DB9A49@MN2PR11MB3757.namprd11.prod.outlook.com> <7FFFF173-7D5F-4000-BDD1-9B407767C48E@ietf.org> <MN2PR11MB375776E0FFAA1023CFE4334AB9A49@MN2PR11MB3757.namprd11.prod.outlook.com>
To: "Paul Duffy (paduffy)" <paduffy@cisco.com>
X-Mailer: Apple Mail (2.3696.100.31)
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-markdown/vpsAwOGs1L4Q5h4ag63Swy04H3k>
Subject: Re: [Rfc-markdown] [rfc-i] Problem with Kramdown tooling and figures?
X-BeenThere: rfc-markdown@ietf.org
X-Mailman-Version: 2.1.39
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, 08 Jun 2022 13:24:26 -0000

Thanks Paul

From Carsten’s response it looks as if this is an issue with upstream kramdown so the following is for info only.

Those templates are unfortunately very out of date and have been replaced with new templates here https://authors.ietf.org/en/templates-and-schemas.  Apologies for the confusion, but it has taken longer to redirect tools.ietf.org than expected and we have no mechanism to update it in the interim.  The redirection should be complete by IETF 114.

cheers
Jay


> On 8 Jun 2022, at 14:01, Paul Duffy (paduffy) <paduffy@cisco.com> wrote:
> 
> Sure.
> 
> Starting at line 114 here ... view-source:https://tools.ietf.org/tools/templates/draft-davies-template-bare-07.xml
> 
> -----Original Message-----
> From: Jay Daley <exec-director@ietf.org> 
> Sent: Wednesday, June 8, 2022 6:48 AM
> To: Paul Duffy (paduffy) <paduffy@cisco.com>
> Cc: rfc-markdown@ietf.org; RFC Interest <rfc-interest@rfc-editor.org>
> Subject: Re: [rfc-i] Problem with Kramdown tooling and figures?
> 
> Hi Paul
> 
>> On 8 Jun 2022, at 05:23, Paul Duffy (paduffy) <paduffy=40cisco.com@dmarc.ietf.org> wrote:
>> 
>> Hi Carsten
>> 
>> Per our previous conversation, I will be incorporating SVG graphics into my kramdown draft.
>> 
>> But I first tested the tooling with a very simple figure example lifted from one of the XML draft templates.  
> 
> Can I ask which of the templates you used?
> 
> cheers
> Jay
> 
>> 
>> Cheers
>> 
>> -----Original Message-----
>> From: rfc-interest <rfc-interest-bounces@rfc-editor.org> On Behalf Of Carsten Bormann
>> Sent: Tuesday, June 7, 2022 6:51 PM
>> To: Paul Duffy (paduffy) <paduffy=40cisco.com@dmarc.ietf.org>
>> Cc: RFC Interest <rfc-interest@rfc-editor.org>
>> Subject: Re: [rfc-i] Problem with Kramdown tooling and figures?
>> 
>> Hi Paul,
>> 
>>> On 7. Jun 2022, at 22:32, Paul Duffy (paduffy) <paduffy=40cisco.com@dmarc.ietf.org> wrote:
>>> 
>>> I have a Kramdown draft with the following figure attempt ...
>>> 
>>> <figure anchor="xml_happy">
>>> <artwork align="left" name="" type="" alt=""><![CDATA[
>>> +-----------------------+
>>> | Use XML, be Happy :-) |
>>> |_______________________|
>>>    ]]></artwork>
>>> </figure>
>>> 
>>> XML result from  https://author-tools.ietf.org/ …
>>> 
>>> <figure anchor="xml_happy"/>
>>> <artwork align="left" name="" type="" alt="">&lt;![CDATA[
>>> +-----------------------+
>>> | Use XML, be Happy :-) |
>>> |_______________________|
>>> ]]&gt;</artwork>
>> 
>> When I try this I get a couple of error messages:
>> 
>> - Found no end tag for 'figure' (line 575) - auto-closing it
>> - Found invalidly used HTML closing tag for 'figure' on line 581
>> 
>> …and a different (similarly broken) XML output, too; I’d probably need the whole document to reproduce this.
>> 
>> Clearly, something isn’t working the way we want it to with the XML (HTML) parsing in kramdown here (kramdown is the markdown engine on which kramdown-rfc was built).
>> 
>> Of course, the fix is to just write:
>> 
>> ~~~
>> +------------------------------+
>> | Use markdown, be Happier :-) |
>> |______________________________|
>> ~~~
>> {: #xml_happy}
>> 
>> But you probably had a reason why you wanted to put in your XML manually…
>> 
>> The mailing list to discuss this further is rfc-markdown@ietf.org (or maybe a GitHub issue on https://rfc.space).
>> 
>> Grüße, Carsten
>> 
>> _______________________________________________
>> rfc-interest mailing list
>> rfc-interest@rfc-editor.org
>> https://mailman.rfc-editor.org/mailman/listinfo/rfc-interest
>> _______________________________________________
>> rfc-interest mailing list
>> rfc-interest@rfc-editor.org
>> https://mailman.rfc-editor.org/mailman/listinfo/rfc-interest
> 
> -- 
> Jay Daley
> IETF Executive Director
> exec-director@ietf.org
> 

-- 
Jay Daley
IETF Executive Director
exec-director@ietf.org