[MPEG-OTSPEC] Proposal to discontinue the AdHoc Group
David Singer
singer at apple.com
Mon Sep 21 18:23:15 CEST 2020
> On 21Sep, 2020, at 9:01 , Adam Twardoch (Lists) <list.adam at twardoch.com> wrote:
>
> I think that depends on how you define “spec”. I think Markdown is good for the “prose bits”, while there could be something more formal for the structural bits.
>
> I think there may be some approaches that are akin to literate programming, where data structures are expressed using a formal notation while explanations are expressed in something prose-like. Those two threads can interweave, and suitable tools can build either human-readable documents or some machine-readable notation.
We’ve looked at Kaitai as a possible candidate for file-format specs, to replace our somewhat inaccurate SDL. But SDL is C-like and readable; Kaitai is not very readable at all.
>
> A.
>
>
>
> On Mon, 21 Sep 2020 at 17:54, Peter Constable <pgcon6 at msn.com> wrote:
> Markdown is a pain for the spec. It's just less of a pain than HTML.
>
>
>
> -----Original Message-----
>
> From: mpeg-otspec <mpeg-otspec-bounces at lists.aau.at> On Behalf Of Werner LEMBERG
>
> Sent: Monday, September 21, 2020 7:22 AM
>
> To: list.adam at twardoch.com
>
> Cc: mpeg-otspec at lists.aau.at
>
> Subject: Re: [MPEG-OTSPEC] Proposal to discontinue the AdHoc Group
>
>
>
>
>
> > Those technical documents (the spec plus other documentation) should
>
> > be treated like code. On Github, when I go like “well, that bit,
>
> > maybe, blah...” on some repo, the maintainer will often say “make a
>
> > pull request, then we’ll review it”.
>
>
>
> Yes! I think that the Markdown format is good enough for the specification; if necessary we could use Pandoc extensions (in addition to what GitHub provides), for example.
>
>
>
> In case it is not sufficient there are easy solutions to improve formatting by adding proper comments here and there that a postprocessor script could handle.
>
>
>
>
>
> Werner
>
> _______________________________________________
>
> mpeg-otspec mailing list
>
> mpeg-otspec at lists.aau.at
>
> https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Flists.aau.at%2Fmailman%2Flistinfo%2Fmpeg-otspec&data=02%7C01%7C%7Cd9a387be877b44af2dd308d85e39b563%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637362949241825735&sdata=tyGjDUI8cpenlLgAiYsTpHtckTLZF80yof5bmfchp1I%3D&reserved=0
>
> _______________________________________________
> mpeg-otspec mailing list
> mpeg-otspec at lists.aau.at
> https://lists.aau.at/mailman/listinfo/mpeg-otspec
Dave Singer
Multimedia and Software Standards, Apple
singer at apple.com
More information about the mpeg-otspec
mailing list