public inbox archive for pandoc-discuss@googlegroups.com
 help / color / mirror / Atom feed
From: Albert Krewinkel <albert+pandoc-9EawChwDxG8hFhg+JK9F0w@public.gmane.org>
To: pandoc-discuss-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org
Subject: Re: Lua filter to modify captions in tables
Date: Sat, 16 Jul 2022 14:25:28 +0200	[thread overview]
Message-ID: <87a699dy1b.fsf@zeitkraut.de> (raw)
In-Reply-To: <0abadbc7-8cc9-4d67-92e2-fbd636f6cf3fn-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org>


Abhishek Ulayil <abhiman2000-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> writes:

> I was working on a lua filter to change the Table caption to add
> numbering
>
> ```
> tables = 0
> function Table(el)
>     tables = tables + 1
>     local caption = "Table " .. tostring(tables) .. ": " ..
>       pandoc.utils.stringify(el.caption)
>     print(caption)
>
>     el.caption = caption --facing problem here
>     return el
> end
> ```
>
> I am facing a problem to set the caption back to the element,
>
> what will be the correct way to set the caption.

Captions consist of two parts, the normal (long) caption and a shorter
(short) description that can be used in a list of tables, for example.
The problematic line should be changed to

    el.caption.long = caption

As you noticed, it's not very user-friendly though, and we should
definitely improve that.

You'll probably want to keep the markup in the caption. I'm attaching a
version that's a bit longer, but will preserve the caption's markup.

HTH!


```
tables = 0
function Table(el)
  tables = tables + 1
  local label = pandoc.Inlines("Table " .. tostring(tables))
  local caption = el.caption.long
  if not caption[1] then
    -- Table has no caption, just add the label
    caption = pandoc.Blocks{label}
  elseif caption[1].tag == 'Plain' or caption[1].tag == 'Para' then
    -- Prepend label to paragraph
    label:extend{pandoc.Str ':', pandoc.Space()}
    caption[1].content = label .. caption[1].content
  else
    -- Add label as plain block element
    label:extend{pandoc.Str ':', pandoc.Space()}
    caption:insert(1, pandoc.Plain(label))
  end

  el.caption.long = caption
  return el
end
```


  parent reply	other threads:[~2022-07-16 12:25 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-16 12:21 Abhishek Ulayil
     [not found] ` <0abadbc7-8cc9-4d67-92e2-fbd636f6cf3fn-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org>
2022-07-16 12:25   ` Albert Krewinkel [this message]
     [not found]     ` <87a699dy1b.fsf-9EawChwDxG8hFhg+JK9F0w@public.gmane.org>
2022-07-16 13:19       ` Abhishek Ulayil
     [not found]         ` <83057d17-1bda-4ec8-a96f-9567f975033en-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org>
2022-07-16 13:33           ` Albert Krewinkel
2022-07-16 13:42       ` Albert Krewinkel

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=87a699dy1b.fsf@zeitkraut.de \
    --to=albert+pandoc-9eawchwdxg8hfhg+jk9f0w@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).