Pandoc lua过滤器:如何保留脚注的格式?

时间:2018-07-26 23:32:26

标签: html5 filter lua markdown pandoc

我尝试实现CSS Generated Content for Paged Media Module中定义的脚注。
使用此定义,脚注必须为内联span。 我写了pandoc lua过滤器的初稿。
这是我的第一个pandoc过滤器(也是我第一次在lua中编写代码)。

以下是过滤器:

Note = function (elem)
  local textContent = {}
  local content = elem.content
  for i = 1, #content do
    textContent[2*i-1] = pandoc.Str(pandoc.utils.stringify(content[i]))
    if i < #content
    then
      textContent[2*i] = pandoc.LineBreak()
    end
  end
  return pandoc.Span(textContent, pandoc.Attr("", {"footnote"}, {}))
end

它适用于具有未格式化文本的脚注(由于使用stringify()函数而导致格式丢失):简单的脚注和多个块的脚注都可以很好地呈现。

为了保留格式,我尝试在walk_block()元素的content上使用Note函数,但无法获得任何结果。

我遇到第二个问题:stringify()函数为CodeBlock元素返回一个空字符串。

因此,当我在以下markdown文本上使用此过滤器时:

Here is a footnote reference,[^1] and another.[^longnote]

[^1]: Here is the footnote.

[^longnote]: Here's one with multiple blocks.

    Subsequent paragraphs are indented to show that they
belong to the previous footnote.

        { some.code }

    The whole paragraph can be indented, or just the first
    line.  In this way, multi-paragraph footnotes work like
    multi-paragraph list items.

This paragraph won't be part of the note, because it
isn't indented.

我获得以下HTML片段:

<p>
  Here is a footnote reference,
  <span class="footnote">Here is the footnote.</span>
  and another.
  <span class="footnote">Here’s one with multiple blocks.
    <br />
    Subsequent paragraphs are indented to show that they belong to the previous footnote.
    <br />
    <br />
    The whole paragraph can be indented, or just the first line. In this way, multi-paragraph footnotes work like multi-paragraph list items.
  </span>
</p>
<p>This paragraph won’t be part of the note, because it isn’t indented.</p>

代码块丢失。有什么办法可以同时保留脚注的格式和代码块?

1 个答案:

答案 0 :(得分:4)

我发现了如何处理Note元素。

首先,Note元素是一个内联元素,因此我们可以使用walk_inline。奇怪的是,Note元素可以嵌入ParaCodeBlock之类的块元素。

以下过滤器仅处理ParaCodeBlock元素。保持格式。

由于Para元素是内联元素的列表,因此很明显可以在Span元素中重用这些元素。
CodeBlock文本也可以在嵌入式Code元素中进行处理。

local List = require 'pandoc.List'

Note = function (elem)
  local inlineElems = List:new{} -- where we store all Inline elements of the footnote
  -- Note is an inline element, so we have to use walk_inline
  pandoc.walk_inline(elem, {
    -- Para is a list of Inline elements, so we can concatenate to inlineElems
    Para = function(el)
      inlineElems:extend(el.content)
      inlineElems:extend(List:new{pandoc.LineBreak()})
    end,
    -- CodeBlock is a block element. We have to store its text content in an inline Code element
    CodeBlock = function(el)
      inlineElems:extend(List:new{pandoc.Code(el.text, el.attr), pandoc.LineBreak()})
    end
  })
  table.remove(inlineElems) -- remove the extra LineBreak
  return pandoc.Span(inlineElems, pandoc.Attr("", {"footnote"}, {}))
end

如果Note元素嵌入其他类型的块元素(如BulletListTable),则必须为walk_inline函数开发特定的过滤器。