public inbox archive for pandoc-discuss@googlegroups.com
 help / color / mirror / Atom feed
From: BPJ <melroch-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
To: pandoc-discuss <pandoc-discuss-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org>
Subject: Re: Lua filter to convert Markdown comment
Date: Fri, 15 Jan 2021 10:19:41 +0100	[thread overview]
Message-ID: <CADAJKhDDZXjEBCWKRBnJChN1F-i_2BctoD1WHauPLXJHTKbGKA@mail.gmail.com> (raw)
In-Reply-To: <CAMxYqzHK6BvhbzE__4__Po+wizq_4b3CZT9q=9ZQ1iF9JR-VSg-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>

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

Almost there. You need


`content = {pandoc.Str"Foo"}`


since the content of a Header is a list of inline elements.

As for multiple possible values Lua patterns are, as you seem to have
discovered, a bit challenged in that they don't support alternations. The
best solution is to use a table:

``````lua
-- Localize `pandoc` to a shorter name to save space & type less!
local p = pandoc

-- This is your "substitution" table.
local text4match = {
  -- If you need styling do this:
  foo = { p.Str"Foo", p.Space(), p.Str"and", p.Space(),
p.Emph(p.Str"more.") },
  -- If you do not need styling you can do this:
  bar = { p.Str"Bar and less." },
}

function RawBlock (elem)
  local key = elem.text:match"%<%!%-%-%s*(%a+)%s*%-%-%>"
  if key then
    local text = text4match[key]
    if text then
      return p.Header(2, text)
    end
  end
  -- No match, no text, ignore this elem
  return nil
end
``````

HTH,

/bpj

-- 
Better --help|less than helpless

Den fre 15 jan. 2021 04:39Peter Matulis <pmatulis-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> skrev:

> So I now have this:
>
> function RawBlock(el)
>   if el.text:match("%<%!%-%- foo %-%-%>") then
>     content = "foo"
>     return pandoc.Header(2, content)
>   end
> end
>
> There are actually about a dozen such known Markdown comments (e.g. 'foo',
> 'bar').
> Instead of creating multiple files I'd like to have just one that uses a
> regex and capture group:
>
>   if el.text:match("%<%!%-%- (%a+) %-%-%>") then
>
> I'm just unsure how to refer to the capture in a conditional statement
> (i.e. "if 'foo' is captured then 'content' = "foo", elsif 'bar' is
> captured then 'content' = "bar").
>
>
> On Thu, 14 Jan 2021 at 15:57, Peter Matulis <pmatulis-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:
>
>> Gratitude. This got me going.
>>
>> On Thu, 14 Jan 2021 at 13:52, John MacFarlane <jgm-TVLZxgkOlNX2fBVCVOL8/A@public.gmane.org> wrote:
>>
>>>
>>> What you want to do is match on a RawBlock element.
>>> Something like
>>>
>>> function RawBlock(el)
>>>   if el.text:match("<!--") then
>>>     content = -- fill this in based on el.text
>>>     return pandoc.Header(2, content)
>>>   end
>>> end
>>>
>>>
>>> Peter Matulis <pmatulis-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> writes:
>>>
>>> > Hi. I'm new to Pandoc & Lua but my present issue is straightforward. I
>>> am
>>> > converting a Markdown file to HTML with pandoc like this:
>>> >
>>> > pandoc -L filter.lua -f gfm -t html -o file.html file.md
>>> >
>>> > Where file.md contains a line with this MD comment (the MD file was
>>> > obtained by converting from RST where I had to seed that file with an
>>> RST
>>> > comment to use as a placeholder for what I'm doing here):
>>> >
>>> > <!-- blah -->
>>> >
>>> > I simply want to convert this into an actual (second-level) MD header:
>>> >
>>> > ## blah
>>> >
>>> > From what I've read, I would ideally specify an "element" that will be
>>> > acted upon, but what is a comment considered? Anyway, I think I can
>>> specify
>>> > `Pandoc` to mean "check the entire document", and that's what I've done
>>> > here (I will eventually be iterating through multiple MD files so I
>>> should
>>> > really not be doing it like this; please advise!):
>>> >
>>> > function Pandoc (value)
>>> >   comment = "<!-- blah -->"
>>> >   comment = comment:gsub("%<%!%-%- blah %-%-%>", "## blah")
>>> >   return value
>>> > end
>>> >
>>> > I've run the main logic through Lua on the terminal and it works:
>>> >
>>> > $ lua
>>> > Lua 5.3.3  Copyright (C) 1994-2016 Lua.org, PUC-Rio
>>> >> comment = "<!-- blah -->"
>>> >> comment = comment:gsub("%<%!%-%- blah %-%-%>", "## blah")
>>> >> print (comment)
>>> > ## blah
>>> >
>>> > But I'm failing to integrate it with Pandoc (no change is registered in
>>> > file.html). It's probably due to my misunderstanding of functions (not
>>> a
>>> > programmer!).
>>> >
>>> > TIA.
>>> >
>>> > /pm
>>> >
>>> > --
>>> > 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/CAMxYqzEvRHcFQ1BYsFODC-Bd36%3DLfO-UKcVYPNzR8i8rDZorXw%40mail.gmail.com
>>> .
>>>
>> --
> 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/CAMxYqzHK6BvhbzE__4__Po%2Bwizq_4b3CZT9q%3D9ZQ1iF9JR-VSg%40mail.gmail.com
> <https://groups.google.com/d/msgid/pandoc-discuss/CAMxYqzHK6BvhbzE__4__Po%2Bwizq_4b3CZT9q%3D9ZQ1iF9JR-VSg%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/CADAJKhDDZXjEBCWKRBnJChN1F-i_2BctoD1WHauPLXJHTKbGKA%40mail.gmail.com.

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

  parent reply	other threads:[~2021-01-15  9:19 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-01-14 18:08 Peter Matulis
     [not found] ` <CAMxYqzEvRHcFQ1BYsFODC-Bd36=LfO-UKcVYPNzR8i8rDZorXw-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2021-01-14 18:51   ` John MacFarlane
     [not found]     ` <m2h7njgxme.fsf-jF64zX8BO08an7k8zZ43ob9bIa4KchGshsV+eolpW18@public.gmane.org>
2021-01-14 20:57       ` Peter Matulis
     [not found]         ` <CAMxYqzEn22Y4goKKW-D3Coqi5UTNR+6AgfcJAkJZPy8qtXjvjQ-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2021-01-15  3:38           ` Peter Matulis
     [not found]             ` <CAMxYqzHK6BvhbzE__4__Po+wizq_4b3CZT9q=9ZQ1iF9JR-VSg-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2021-01-15  9:19               ` BPJ [this message]
     [not found]                 ` <CADAJKhDDZXjEBCWKRBnJChN1F-i_2BctoD1WHauPLXJHTKbGKA-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2021-01-15 19:14                   ` Peter

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CADAJKhDDZXjEBCWKRBnJChN1F-i_2BctoD1WHauPLXJHTKbGKA@mail.gmail.com \
    --to=melroch-re5jqeeqqe8avxtiumwx3w@public.gmane.org \
    --cc=pandoc-discuss-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).