Opinions on in-band variation signaling

[mofo syne]

Oh and the proposed variant identifier (or document declaration if I
read correctly) I'm proposing is:

>>>

!CommonMark: 0.1.23-github.username.projectname
Author: Bane Liciea
Title: Why you should hire me
Date: 32-4-2002
Layout: Resume

... content blabalba ...

<<< ( http://talk.commonmark.org/t/the-case-for-a-commonmark-declaration-tag/584/9
)

`!CommonMark: 0.1.23-github.username.projectname` is located in the
very first line of a document and `!CommonMark:` is the magic word
along with the version identifier (optional, if missing assume latest
version).

 below the document declaration is simple key:value document metadata.
Which in archive analogy, is like the label stuck on top of microfilm
casing. So it is easier to scan and read as a batch (Keep reading
metadata after `!CommonMark:` until an empty line is detected)

Well that's my preference anyhow. No frills, just simple key:value
suggestions on what the document is and how the parser is recommend to
present it (e.g. 'layout: Resume' ).

Of course for pandoc, I would suggest that the magic word would be
`!pandoc: <version number>` on the very first line, and simple
metadata immediately below (as I suggested in previous email).



On Wed, Nov 12, 2014 at 11:03 AM, mofo syne <mofosyne at gmail.com> wrote:
> Was thinking that generic block directives concept in
> http://talk.commonmark.org/t/block-directives could assist with this.
>
>>>>
> !pandoc:
> This is a Title
> Sean Leonard
> November 2014
> <<< (compact)
>
> or if there is spaces in the metadata block. No need for %, since we
> know that it is metadata already.
>
>>>>
> !pandoc:
> ::::::::::::::::::::::::::::::::
> This is a Title
> Sean Leonard
> November 2014
> ::::::::::::::::::::::::::::::::
> <<< (fenced)
>
> Good for document declaration. E.g. should we load resume.css or
> blog.css default styles.
>
> On Wed, Nov 12, 2014 at 10:47 AM, Sean Leonard <dev+ietf at seantek.com> wrote:
>> Regarding the text/markdown registration:
>>
>> At least one commentator (Larry Masinter) specifically requested that the variant identifier be included in-band in the Markdown content, rather than as part of the metadata. I disagree with in-band signaling (as has been registered earlier on this list). Nevertheless, I wanted to take a straw poll and see if anyone has tried to implement in-band Markdown variation identifiers, with any success. Do any implementers have experience with picking the type of Markdown based on some info at the top of the Markdown content? Does it work—or will it never work? Or is it “bad” for particular reasons?
>>
>> By in-band, I mean a Markdown file with content like this:
>>
>>>>>
>> !pandoc
>> % This is a Title
>> % Sean Leonard
>> % November 2014
>>
>> Blah blah *blah*.
>> <<< (fortin’s suggestion)
>>
>>>>>
>> [!pandoc]: # "This is a pandoc document."
>> % This is a Title
>> % Sean Leonard
>> % November 2014
>>
>> Blah blah *blah*.
>> <<< (seantek’s suggestion)
>>
>> -Sean
>> _______________________________________________
>> Markdown-Discuss mailing list
>> Markdown-Discuss at six.pairlist.net
>> https://pairlist6.pair.net/mailman/listinfo/markdown-discuss