<div dir="ltr">Hello all!<div>(cc-ing the flac-dev list)<br><div><br></div><div>I would like to give an update as to the recent CELLAR work on the FLAC specification.</div><div><br></div><div>• Work has been done to make internal and external links more accurate and reliable.</div><div>• 'Rice Coding' has been clarified as 'Exponential Golomb Coding.'</div><div>• Clarifications have been made for binary representation.</div><div>• Typos and other small changes have been fixed for clarity.</div><div><br></div><div>Lastly, a version 00 release has been made (available at <a href="https://github.com/privatezero/flac_markdown/releases">https://github.com/privatezero/flac_markdown/releases</a>) and the draft document has been uploaded to the IETF datatracker (<a href="https://datatracker.ietf.org/doc/draft-xiph-cellar-flac/">https://datatracker.ietf.org/doc/draft-xiph-cellar-flac/</a>)</div><div><br></div><div>All the best!</div><div>Andrew Weaver</div></div></div><div class="gmail_extra"><br><div class="gmail_quote">On Mon, May 22, 2017 at 11:06 AM, Dave Rice <span dir="ltr"><<a href="mailto:dave@dericed.com" target="_blank">dave@dericed.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div style="word-wrap:break-word"><span class=""><br><div><blockquote type="cite"><div>On May 12, 2017, at 1:05 PM, Dave Rice <<a href="mailto:dave@dericed.com" target="_blank">dave@dericed.com</a>> wrote:</div><br class="m_8408475518535631529Apple-interchange-newline"><div><span style="font-family:Helvetica;font-size:12px;font-style:normal;font-variant-caps:normal;font-weight:normal;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px;float:none;display:inline!important">Hi all,</span><div style="font-family:Helvetica;font-size:12px;font-style:normal;font-variant-caps:normal;font-weight:normal;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px">And cc'ing flac-dev.</div><div style="font-family:Helvetica;font-size:12px;font-style:normal;font-variant-caps:normal;font-weight:normal;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px"><br><div><blockquote type="cite"><div>On May 10, 2017, at 12:15 PM, Dave Rice <<a href="mailto:dave@dericed.com" target="_blank">dave@dericed.com</a>> wrote:</div><br class="m_8408475518535631529Apple-interchange-newline"><div><div style="word-wrap:break-word">Hi Andrew,<div><br><div><blockquote type="cite"><div>On May 10, 2017, at 11:19 AM, Andrew James Weaver <<a href="mailto:weevz@uw.edu" target="_blank">weevz@uw.edu</a>> wrote:</div><br class="m_8408475518535631529Apple-interchange-newline"><div><div dir="ltr">Hello all!<div><br></div><div>In a previous discussions on this list about people interested in working on the FLAC standard, I said that I would be willing to start the process of converting the existing standard into Markdown. I am writing to inform the list that I have begun preliminary work on this conversion.</div><div><br></div><div>Currently that work is living here<span class="m_8408475518535631529Apple-converted-space"> </span><a href="https://github.com/privatezero/flac_markdown" target="_blank">https://github.com/<wbr>privatezero/flac_markdown</a>.</div></div></div></blockquote><br></div><div>I sent a pull request at <a href="https://github.com/privatezero/flac_markdown/pull/1" target="_blank">https://github.com/<wbr>privatezero/flac_markdown/<wbr>pull/1</a>, which starts to add a process to convert the markdown to the RFC format using the same Makefile approach that we use with the FFV1 and EBML markdown files. There's still a lot of inter-document cross-referencing that needs to be adjusted before the Makefile works. For instance current cross-referencing like:</div><div><br></div><div>[*SUBFRAME\_VERBATIM*](#<wbr>subframe_verbatim)</div><div><br></div><div>won't render as expected in a plain text RFC, but would simply render to something like "Section X.X.X".</div><div><br></div><div>In EBML we use markdown such as</div><div><pre><pre>See [the section on `Element Data Size`](#element-data-size) for rules that apply to elements of unknown length.</pre></pre><div>so that in the RFC this renders to</div><div><pre>See Section 7 for rules that apply to elements of unknown length.</pre><div>and in the markdown it renders to</div></div><div><br></div><div>See<span class="m_8408475518535631529Apple-converted-space"> </span><a href="https://github.com/Matroska-Org/ebml-specification/blob/master/specification.markdown#element-data-size" target="_blank">the section on<span class="m_8408475518535631529Apple-converted-space"> </span><code>Element Data Size</code></a><span class="m_8408475518535631529Apple-converted-space"> </span>for rules that apply to elements of unknown length.</div></div></div></div></div></blockquote><br></div><div>I added some issues to the flac_markdown repository and Andrew addressed them in<span class="m_8408475518535631529Apple-converted-space"> </span><a href="https://github.com/privatezero/flac_markdown/pull/7" target="_blank">https://github.com/<wbr>privatezero/flac_markdown/<wbr>pull/7</a>. Most of these issues pertain to unintended semantic differences between the FLAC specification as it exists in its original HTML form at <a href="https://xiph.org/flac/format.html" target="_blank">https://xiph.org/flac/<wbr>format.html</a><span class="m_8408475518535631529Apple-converted-space"> </span>and the markdown rendition being worked on at <a href="https://github.com/privatezero/flac_markdown/blob/master/flac.md" target="_blank">https://github.com/<wbr>privatezero/flac_markdown/<wbr>blob/master/flac.md</a>.</div><div><br></div><div>Since the recent work focuses on a change of format from HTML to markdown, I suggest that short term goals on the flac specification focus on:</div></div><div style="font-family:Helvetica;font-size:12px;font-style:normal;font-variant-caps:normal;font-weight:normal;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px">- verifying semantic equalness with the html version</div><div style="font-family:Helvetica;font-size:12px;font-style:normal;font-variant-caps:normal;font-weight:normal;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px">- resolving issues that block the mmark/xml2rfc process that generates the RFC formats of the specification</div><div style="font-family:Helvetica;font-size:12px;font-style:normal;font-variant-caps:normal;font-weight:normal;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px">- add standard RFC boilerplate (abstract, rfc2119, etc)</div></div></blockquote><br></div></span><div>To summarize recent work on the FLAC specification, the document has been adjusted in its new markdown format in order to achieve semantic similarity to the original HTML rendition on the <a href="http://xiph.org" target="_blank">xiph.org</a> site. In order to get the structural data (such as the tables at the end of <a href="https://xiph.org/flac/format.html" target="_blank">https://xiph.org/flac/<wbr>format.html</a>) to fit in plain text RFC style, the tables were dissected a bit to separate value lists from structural lists. In this way the subcomponents and defined in their own sections instead of the prior strategy of detailing lists and pseudocode within large tables. For instance see the original rendition of the frame header documentation from <a href="https://xiph.org/flac/format.html#frame_header" target="_blank">https://xiph.org/flac/format.<wbr>html#frame_header</a> compared to the dissected version which gives the subcomponents their own subsequent sections at <a href="https://github.com/privatezero/flac_markdown/blob/7a5c21d49d1fda89609ffa9edfca2447c7ca3c5e/flac.md#frame_header" target="_blank">https://github.com/<wbr>privatezero/flac_markdown/<wbr>blob/<wbr>7a5c21d49d1fda89609ffa9edfca24<wbr>47c7ca3c5e/flac.md#frame_<wbr>header</a>. Splitting out the subcomponents into their own sections also gives space to be more explicate in defining them, such as <a href="https://github.com/privatezero/flac_markdown/commit/3aaa5f293102018bd7c41409e79e36f510557d96" target="_blank">https://github.com/<wbr>privatezero/flac_markdown/<wbr>commit/<wbr>3aaa5f293102018bd7c41409e79e36<wbr>f510557d96</a>.</div><div><br></div><div>Andrew noticed that there are some issues with managing section titles that contain underscores and getting internal sectional citations to work. For instance (#frame-header) will link to `FRAME HEADER` (space) but not `FRAME_HEADER` (underscore). Is there any reason not to swap the all-caps, underscored component names to tilde-quoted, all caps name with spaces rather than underscores?</div><div><br></div><div>For convenience, here is a rendering of the plain text RFC output of git-master of the FLAC format repository: <a href="https://gist.github.com/dericed/2639d0eed5e064b4dec1399bc8716833" target="_blank">https://gist.<wbr>github.com/dericed/<wbr>2639d0eed5e064b4dec1399bc87168<wbr>33</a>.</div><div><br></div><div>I suggest reviews of the current markdown from those familiar with the historical FLAC format specification so that we ensure that the current work is the same in meaning to the original html version of the specification.</div><div><br></div><div>Best Regards,</div><div>Dave Rice</div></div><br>______________________________<wbr>_________________<br>
Cellar mailing list<br>
<a href="mailto:Cellar@ietf.org">Cellar@ietf.org</a><br>
<a href="https://www.ietf.org/mailman/listinfo/cellar" rel="noreferrer" target="_blank">https://www.ietf.org/mailman/<wbr>listinfo/cellar</a><br>
<br></blockquote></div><br><br clear="all"><div><br></div>-- <br><div class="gmail_signature" data-smartmail="gmail_signature"><div dir="ltr"><div><div dir="ltr"><div><div dir="ltr"><div><div dir="ltr"><font color="#888888"><font><span><span style="font-family:georgia,serif">Andrew Weaver, MLIS</span></span></font></font></div></div><div><font color="#888888"><font><span><span style="font-family:georgia,serif">American Archive of Public Broadcasting</span></span></font></font></div><div><font color="#888888"><font><span><span style="font-family:georgia,serif">National Digital Stewardship Resident @ CUNY TV</span></span></font></font></div><div><font color="#888888"><font><span><span style="font-family:georgia,serif"><a href="mailto:weevz@uw.edu" target="_blank">weevz@uw.edu</a></span></span></font></font></div></div></div></div></div></div></div>
</div>