Re: [Cellar] math in IETF specifications

Adam Roach <adam@nostrum.com> Wed, 02 December 2015 19:30 UTC

Return-Path: <adam@nostrum.com>
X-Original-To: cellar@ietfa.amsl.com
Delivered-To: cellar@ietfa.amsl.com
Received: from localhost (ietfa.amsl.com [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id D9A831ACF58 for <cellar@ietfa.amsl.com>; Wed, 2 Dec 2015 11:30:44 -0800 (PST)
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, HTML_MESSAGE=0.001, T_RP_MATCHES_RCVD=-0.01] autolearn=ham
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 Ak4MsvTYcsct for <cellar@ietfa.amsl.com>; Wed, 2 Dec 2015 11:30:42 -0800 (PST)
Received: from nostrum.com (raven-v6.nostrum.com [IPv6:2001:470:d:1130::1]) (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 6B5BC1ACF16 for <cellar@ietf.org>; Wed, 2 Dec 2015 11:30:42 -0800 (PST)
Received: from Svantevit.roach.at (cpe-70-122-154-80.tx.res.rr.com [70.122.154.80]) (authenticated bits=0) by nostrum.com (8.15.2/8.14.9) with ESMTPSA id tB2JUc1A044432 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128 verify=NO); Wed, 2 Dec 2015 13:30:39 -0600 (CST) (envelope-from adam@nostrum.com)
X-Authentication-Warning: raven.nostrum.com: Host cpe-70-122-154-80.tx.res.rr.com [70.122.154.80] claimed to be Svantevit.roach.at
To: Dave Rice <dave@dericed.com>, cellar@ietf.org
References: <D99E7E07-C087-4D97-A36B-9F59C8C0FBE4@dericed.com>
From: Adam Roach <adam@nostrum.com>
Message-ID: <565F46D9.90801@nostrum.com>
Date: Wed, 02 Dec 2015 13:30:33 -0600
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.10; rv:38.0) Gecko/20100101 Thunderbird/38.3.0
MIME-Version: 1.0
In-Reply-To: <D99E7E07-C087-4D97-A36B-9F59C8C0FBE4@dericed.com>
Content-Type: multipart/alternative; boundary="------------080408000501050303050006"
Archived-At: <http://mailarchive.ietf.org/arch/msg/cellar/QM0XJVuEHtg6koTE4pMfjb8oDqA>
Subject: Re: [Cellar] math in IETF specifications
X-BeenThere: cellar@ietf.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: Codec Encoding for LossLess Archiving and Realtime transmission <cellar.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/cellar>, <mailto:cellar-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/cellar/>
List-Post: <mailto:cellar@ietf.org>
List-Help: <mailto:cellar-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/cellar>, <mailto:cellar-request@ietf.org?subject=subscribe>
X-List-Received-Date: Wed, 02 Dec 2015 19:30:45 -0000

On 12/2/15 1:22 PM, Dave Rice wrote:
> Dear IETF lurkers,
>
> The current version of the FFV1 specification includes a lot of latex 
> style mathematical equations to express various aspects of the 
> encoding format. These can be seen in the markdown in locations like 
> this 
> https://github.com/FFmpeg/FFV1/blob/master/ffv1.md#range-binary-values and 
> in rendered form in HTML, 
> http://www.ffmpeg.org/~michael/ffv1-markdown/ffv1.html#range-coding-mode 
> <http://www.ffmpeg.org/%7Emichael/ffv1-markdown/ffv1.html#range-coding-mode>, 
> and PDF, http://www.ffmpeg.org/~michael/ffv1-markdown/ffv1.pdf 
> <http://www.ffmpeg.org/%7Emichael/ffv1-markdown/ffv1.pdf>.
>
> I've been investigating to see how other RFC documents integrate latex 
> style mathematical equations but have not found any? If there a 
> recommended manner to include math? Should it be translated into a 
> narrative? Is there a recommended way to render math in a plain text RFC?
>

There's an effort underway to modernize the RFC format, and the new 
format will allow for significantly better formatting of things like 
mathematical formulae. See:

https://tools.ietf.org/html/draft-flanagan-rfc-framework

and

http://www.rfc-editor.org/rse/format-faq/

It seems quite likely that this work will be reaching completion in 
about the same timeframe as CELLAR is ready to publish its final output.

In the meanwhile, there is precedent for publishing both .txt and .pdf 
versions of documents, with the .txt versions referring to the .pdf for 
information that cannot be rendered in text.

Another approach that has been taken is expression of this kind of 
information in algorithmic formats, using pseudocode or actual 
programming languages.

/a