YAML closing delimiter

YAML closing delimiter

[John Muccigrosso]

[-- Attachment #1.1: Type: text/plain, Size: 1627 bytes --]

Pandoc uses 
...

as its closing delimiter in the YAML block. It will also *read *
---

 as one.


I see from the discussion when adding metadata to pandoc was being 
discussed that gitit also uses the periods 
<https://github.com/jgm/gitit/blob/22b7f66c79068a7da3a44d3ada8e5133ea334d95/README.markdown> 
to close the front matter by the logic that sections constitutes a YAML 
document which takes that delimiter. 
<http://www.yaml.org/spec/1.2/spec.html#marker/document%20end/>

However this seems not to be the case in at least some other environments 
that use YAML for front matter, like Jekyll 
<http://jekyllrb.com/docs/frontmatter/> and Assemble 
<http://assemble.io/docs/YAML-front-matter.html>.

For me, this means that the YAML front matter in pandoc-generated markdown 
docs doesn't get read correctly in, for example, MacDown 
<https://macdown.uranusjr.com>, which I use as a markdown editor, since it 
uses Jekyll to handle the front matter.

I raise this because I wonder how common a problem this is, and what the 
best solution might be.

-- 
You received this message because you are subscribed to the Google Groups "pandoc-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/ebb2d862-397d-4e25-9e7e-fb54323a81c2%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[-- Attachment #1.2: Type: text/html, Size: 2736 bytes --]

Re: YAML closing delimiter

[John MACFARLANE]

Best solution would be to ask these other processors to
support ... as closing delimiter -- since after all this
is a standard YAML.  (Another advantage is that if you
use ---, many markdown syntax highlighters will highlight the
last line of your metadata as a title, which looks bad.)

+++ John Muccigrosso [Oct 13 15 09:11 ]:
>   Pandoc uses
>   ...
>   as its closing delimiter in the YAML block. It will also read
>   ---
>    as one.
>   I see from the discussion when adding metadata to pandoc was being
>   discussed that [1]gitit also uses the periods to close the front matter
>   by the logic that sections constitutes a YAML document which [2]takes
>   that delimiter.
>   However this seems not to be the case in at least some other
>   environments that use YAML for front matter, like [3]Jekyll and
>   [4]Assemble.
>   For me, this means that the YAML front matter in pandoc-generated
>   markdown docs doesn't get read correctly in, for example, [5]MacDown,
>   which I use as a markdown editor, since it uses Jekyll to handle the
>   front matter.
>   I raise this because I wonder how common a problem this is, and what
>   the best solution might be.
>
>   --
>   You received this message because you are subscribed to the Google
>   Groups "pandoc-discuss" group.
>   To unsubscribe from this group and stop receiving emails from it, send
>   an email to [6]pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
>   To post to this group, send email to
>   [7]pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
>   To view this discussion on the web visit
>   [8]https://groups.google.com/d/msgid/pandoc-discuss/ebb2d862-397d-4e25-
>   9e7e-fb54323a81c2%40googlegroups.com.
>   For more options, visit [9]https://groups.google.com/d/optout.
>
>References
>
>   1. https://github.com/jgm/gitit/blob/22b7f66c79068a7da3a44d3ada8e5133ea334d95/README.markdown
>   2. http://www.yaml.org/spec/1.2/spec.html#marker/document end/
>   3. http://jekyllrb.com/docs/frontmatter/
>   4. http://assemble.io/docs/YAML-front-matter.html
>   5. https://macdown.uranusjr.com/
>   6. mailto:pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org
>   7. mailto:pandoc-discuss-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org
>   8. https://groups.google.com/d/msgid/pandoc-discuss/ebb2d862-397d-4e25-9e7e-fb54323a81c2-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org?utm_medium=email&utm_source=footer
>   9. https://groups.google.com/d/optout

Re: YAML closing delimiter

[John Muccigrosso]

[-- Attachment #1.1: Type: text/plain, Size: 1432 bytes --]

On Tuesday, October 13, 2015 at 2:10:00 PM UTC-4, John MacFarlane wrote:
>
> Best solution would be to ask these other processors to 
> support ... as closing delimiter -- since after all this 
> is a standard YAML.  (Another advantage is that if you 
> use ---, many markdown syntax highlighters will highlight the 
> last line of your metadata as a title, which looks bad.) 
>

I've asked over at the Jekyll github repo, where they clearly had this 
discussion and went for "simplicity" for users by eliminating the option of 
using dots, which had been added to the original (and now again current) 
practice of only allowing hyphens. Their issue 3138 
<https://github.com/jekyll/jekyll/pull/3138> has a rather derogatory 
reference to "bending to the will of pandoc", which completely ignores the 
issue of actual YAML standards, raised by several people.

-- 
You received this message because you are subscribed to the Google Groups "pandoc-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/08e65baa-f8d6-4437-af61-d106b36d1382%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[-- Attachment #1.2: Type: text/html, Size: 2035 bytes --]

Re: YAML closing delimiter

[BPJ]

[-- Attachment #1: Type: text/plain, Size: 2547 bytes --]

Try

pandoc -t markdown in.md | perl -ple's/^\.\.\.$/---/' >out.md

tisdag 13 oktober 2015 skrev John Muccigrosso <jmuccigr-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>:

> On Tuesday, October 13, 2015 at 2:10:00 PM UTC-4, John MacFarlane wrote:
>>
>> Best solution would be to ask these other processors to
>> support ... as closing delimiter -- since after all this
>> is a standard YAML.  (Another advantage is that if you
>> use ---, many markdown syntax highlighters will highlight the
>> last line of your metadata as a title, which looks bad.)
>>
>
> I've asked over at the Jekyll github repo, where they clearly had this
> discussion and went for "simplicity" for users by eliminating the option of
> using dots, which had been added to the original (and now again current)
> practice of only allowing hyphens. Their issue 3138
> <https://github.com/jekyll/jekyll/pull/3138> has a rather derogatory
> reference to "bending to the will of pandoc", which completely ignores the
> issue of actual YAML standards, raised by several people.
>
> --
> You received this message because you are subscribed to the Google Groups
> "pandoc-discuss" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org
> <javascript:_e(%7B%7D,'cvml','pandoc-discuss%2Bunsubscribe-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org');>
> .
> To post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org
> <javascript:_e(%7B%7D,'cvml','pandoc-discuss-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org');>.
> To view this discussion on the web visit
> https://groups.google.com/d/msgid/pandoc-discuss/08e65baa-f8d6-4437-af61-d106b36d1382%40googlegroups.com
> <https://groups.google.com/d/msgid/pandoc-discuss/08e65baa-f8d6-4437-af61-d106b36d1382%40googlegroups.com?utm_medium=email&utm_source=footer>
> .
> For more options, visit https://groups.google.com/d/optout.
>

-- 
You received this message because you are subscribed to the Google Groups "pandoc-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/CADAJKhCt9EqV_v3XTrXq%3DoPFiOHnEsk5xEtB8wYiMKb3V0xDTw%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

[-- Attachment #2: Type: text/html, Size: 3659 bytes --]

Re: YAML closing delimiter

[John Muccigrosso]

[-- Attachment #1.1: Type: text/plain, Size: 785 bytes --]

OK, turns out that despite several threads to the contrary, the current 
Jekyll codebase does indeed support the dots as well as the dashes.

Working now on getting my markdown editor, MacDown, to support it too.

-- 
You received this message because you are subscribed to the Google Groups "pandoc-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/848379a7-9aff-40d9-b24e-149531932c9d%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[-- Attachment #1.2: Type: text/html, Size: 1220 bytes --]

Re: YAML closing delimiter

[John MacFarlane]

+++ BPJ [Oct 18 15 10:58 ]:
>   Try
>
>   pandoc -t markdown [1]in.md | perl -ple's/^\.\.\.$/---/' >out.md

This will probably work well enough in most cases, but what
if your document has a line with `...` that isn't a YAML
header closer?  (E.g. in a fenced code block?)  It will get
converted to `---` too, won't it?

Re: YAML closing delimiter

[BP Jonsson]

Den 2015-10-19 kl. 07:12, skrev John MacFarlane:
> +++ BPJ [Oct 18 15 10:58 ]:
>>   Try
>>
>>   pandoc -t markdown [1]in.md | perl -ple's/^\.\.\.$/---/' >out.md
>
> This will probably work well enough in most cases, but what
> if your document has a line with `...` that isn't a YAML
> header closer?  (E.g. in a fenced code block?)  It will get
> converted to `---` too, won't it?
>

I thought the same right after I hit send. There is a trick which 
will replace only the first match in the file, which is usually 
what you want in this case:

    pandoc -t markdown in.md | perl -ple'$seen ||= 
s/^\.\.\.$/---/' >out.md

Here `$seen`, which is a global variable, will be set to a true 
value the first time the substitution matches because the 
substitution operator returns the number of substitutions made on 
the current line, which in this case will be either 0 (false) or 1 
(true). On subsequent lines, when `$seen` already has a true value 
the substitution won't even be tried.  It's faster too as it 
doesn't need to try the regular expression against every line in 
the file. (It needs to *print* every line though, which it does.)

/bpj

P.S.  I don't know where the `[1]` came from.  Probably a pasting 
error!

Re: YAML closing delimiter

[John MacFarlane]

+++ BP Jonsson [Oct 19 15 10:50 ]:
>Den 2015-10-19 kl. 07:12, skrev John MacFarlane:
>>+++ BPJ [Oct 18 15 10:58 ]:
>>>  Try
>>>
>>>  pandoc -t markdown [1]in.md | perl -ple's/^\.\.\.$/---/' >out.md
>>
>>This will probably work well enough in most cases, but what
>>if your document has a line with `...` that isn't a YAML
>>header closer?  (E.g. in a fenced code block?)  It will get
>>converted to `---` too, won't it?
>>
>
>I thought the same right after I hit send. There is a trick which will 
>replace only the first match in the file, which is usually what you 
>want in this case:
>
>   pandoc -t markdown in.md | perl -ple'$seen ||= s/^\.\.\.$/---/' >>out.md

Thanks for that.  I puzzled for some time trying to figure
out how to do this!  Seems like it ought to be simpler.