Re: Tip: comments in Markdown

[BPJ <bpj-J3H7GcXPSITLoDKTGw+V6w@public.gmane.org>]

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

It's perhaps not proper to include this in the manual because it is an
exploit of a feature for something it wasn't meant for, or if you want to
be charitable you can call it an "emergent feature". Maybe there could be a
section in the manual describing the various alternatives for *simulating*
markdown comments, but it would have to be somewhat carefully worded!

I think a better solution would be to document such borderline "features"
on the GitHub wiki. However I just checked and there is no link to the wiki
in the manual. There probably should be one.

Den ons 22 juni 2022 21:13Thomas Byskov Dalgaard <tbdlist@coolfortheblind.dk>
skrev:

> Wow that would be very cool. Would you mind documenting this in the Pandoc
> manual?
>
> Will test this to see if it can help me in some very odd cases I have had
> in the past. Thanks again bpj.
>
> Best regards Thomas
>
> Den 22. jun. 2022 kl. 15.53 skrev BPJ <melroch-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>:
>
> I don't know if I or someone else has mentioned this before, but I just
> realized that there is (another) simple trick to simulate "markdown
> comments" as opposed to HTML comments:
>
> ``````markdown
> ```{=comment}
> This won't show up in HTML output!
> ```
>
> `This neither`{=comment}
>
> <!-- But this will be in HTML -->
> ``````
>
> Theoretically this might break if there ever is an output format called
> "comment" but I guess that is highly unlikely.
>
> It will also probably work with your local language's word(s) for
> 'comment'; I tried with Swedish "anmärkning" (and the abbreviations
> "anmärkn" and "anm") and it seems multi-byte chars in the "format name" is
> no problem.
>
> Also if you don't trust Pandoc to automatically reject raw elements with a
> bogus format you can use a simple filter:
>
> ``````lua
> local is_comment = {
>   'comment',
>   'com',
>   'remark',
>   'rem',
>   'kommentar',
>   'komm',
>   'anmärkning',
>   'anm',
>   'athugasemd',
>   'aths',
> }
> -- Turn the list into a set
> for i=1,#is_comment do
>   is_comment[is_comment[i]] = true
>   is_comment[i] = nil
> end
>
> local function raw (r)
>   if is_comment[r.format] then
>     return {}
>   else
>     return nil
>   end
> end
>
> return {
>   {
>     RawBlock = raw,
>     RawInline = raw,
>   }
> }
> ``````
>
> Notably this filter can be used to remove such "comments" from Markdown
> output, while otherwise they will remain when reformatting Markdown source
> with Pandoc, which IMO is an advantage over YAML comments.
>
> I hope this is useful for others,
>
> /bpj
>
>
> --
> 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 view this discussion on the web visit
> https://groups.google.com/d/msgid/pandoc-discuss/CADAJKhAYoUGxuA-xFBp699zqrYHTARhTLCmPjZ2%3DBE2T7kO0GA%40mail.gmail.com
> <https://groups.google.com/d/msgid/pandoc-discuss/CADAJKhAYoUGxuA-xFBp699zqrYHTARhTLCmPjZ2%3DBE2T7kO0GA%40mail.gmail.com?utm_medium=email&utm_source=footer>
> .
>
>
> --
> 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 view this discussion on the web visit
> https://groups.google.com/d/msgid/pandoc-discuss/332666C5-9B8E-42B1-A9D2-2437FCE7B70E%40coolfortheblind.dk
> <https://groups.google.com/d/msgid/pandoc-discuss/332666C5-9B8E-42B1-A9D2-2437FCE7B70E%40coolfortheblind.dk?utm_medium=email&utm_source=footer>
> .
>

-- 
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 view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/CADAJKhDBa8sm2VNKdQpdz_SsBvMYOfofJG-6-hjY6XrSL19nPA%40mail.gmail.com.

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