[FFmpeg-devel] [PATCH] conversion of FFV1 specification from lyx to markdown

[Dave Rice]

> On Jul 21, 2015, at 10:24 AM, Michael Niedermayer <michael at niedermayer.cc> wrote:
> 
> On Mon, Jul 20, 2015 at 11:55:41PM -0400, Dave Rice wrote:
>> 
>>> On Jul 20, 2015, at 8:52 PM, Michael Niedermayer <michael at niedermayer.cc> wrote:
>>> 
>>> On Tue, Jul 21, 2015 at 02:14:11AM +0200, Michael Niedermayer wrote:
>>> [...]
>>>> ill take another quick look and then will probably push your changes
>>>> its probably easier to work on top of it then wait with pushing until
>>>> its perfect
>>> 
>>> pushed it
>>> 
>>> btw please remove trailing whitespace unless some of it is required
>>> for the formating or something
>> 
>> Send this pull request to clean up white spaces, indentation, and trailing slashes. https://github.com/FFmpeg/FFV1/pull/12
>> 
>>> also, it seems github doesnt render all parts of the file well, some
>>> look quite broken (found by jamrial)
>> 
>> Github's markdown rendering is a little different than pandoc's rendering. Some table updates were done here: https://github.com/FFmpeg/FFV1/pull/11 <https://github.com/FFmpeg/FFV1/pull/11>. There's still the header which starts with percent signs, this is a workaround to get pandoc to render that as a header but to not include it within the table of contents.
>> 
>> Unless I'm missing something, Github doesn't seem to support rendering latex style equations in markdown (although pandoc does) so we may not be able to have a markdown that can be fully rendered by Github alone (unless we remove the need for latex). Perhaps the ffv1.md could occasionally be rendered (via the makefile) with the outputs updated on ffmpeg.org <http://ffmpeg.org/>. Then within the README of the FFV1 repo we could link to the rendered copy on ffmpeg.org <http://ffmpeg.org/>.
> 
> ive uploaded a temporary version to
> http://ffmpeg.org/~michael/ffv1-markdown/ffv1.html
> http://ffmpeg.org/~michael/ffv1-markdown/ffv1.pdf <http://ffmpeg.org/~michael/ffv1-markdown/ffv1.pdf>

Thanks.

> these are created with pandoc 1.13.2.1 locally
> the huffman/suffix/example tables still are wrong, that could be
> worked aroun by placing one of the magic non breaking or whatever spaces
> before the tables

I'm not sure I understand why they are 'wrong'.

> also the html lost its left border/margin which looks odd

Agreed. For HTML we're using http://elyxer.nongnu.org/lyx.css <http://elyxer.nongnu.org/lyx.css> which uses "margin: 0". For a number of reasons I think we'll need to use a custom css, will send a PR for that later.

[...]

Dave