如何使用pandoc lua过滤器将标题添加为1级标题?

问题描述 投票:1回答:1

当我将多个markdown文件从markdown转换为pdf时,我想使用pandoc lua过滤器。我希望将单个降价文件的标题用作章节(第一级标题)。

我了解了现有示例,我认为这很接近我的需要-基本上我需要将pandoc.Header(1,doc.meta.title)添加到我的所有markdown文件中,但是我一直在努力编写lua过滤器并使其起作用。

我认为这个问题正在执行类似的操作pandoc filter in lua and walk_block

pandoc命令:

pandoc -N --lua-filter add-title.lua blog/*.md --pdf-engine=xelatex --toc -s -o my_book.pdf

add-title.lua(这是错误的,没有异常,但输出没有任何反应:):

function add_header (header)
return {
  {Header = pandoc.Header(1, meta.title)}}
end

输入文件:

1.md

---
title: Topic1
---

## Sample Header from file 1.md

text text text

2.md

---
title: Topic2
---

## Sample Header from file 2.md

text text text

预期输出等于此降价(但我的最终格式是pdf)

---
title: Title from pandoc latex variable
---
# Topic1

## Sample Header from file 1.md

text text text

# Topic2

## Sample Header from file 2.md

text text text
lua pandoc
1个回答
0
投票

我认为关键问题是lua过滤器仅在将全部文档解析为一个AST后才运行。因此,在解析之前可以有效地连接各个文件,以创建具有单组元数据的单个文档。过滤器有机会运行之前,将覆盖yaml元数据块中的各个title设置。假设您需要从每个单独的元数据块中获取标题(并且不能仅将标题直接放入),这意味着您不能让pandoc加入文件。您将需要分别阅读和解析每个文件。幸运的是,使用过滤器非常容易。

第一步是制作单个参考文件,其中包含指向所有其他文件的链接。

---
title: Combined title
---

![First file](1.md){.markdown}

![Second file](2.md){.markdown}

请注意,链接是使用具有特殊类别.markdown的图像指定的。您可以使用其他方法,但是图像很方便,因为它们支持属性并且易于识别。

现在,我们只需要一个过滤器,即可将这些图像替换为链接的markdown文件中的已解析元素。为此,我们可以打开lua中的文件,然后使用pandoc.read将其解析为完整的文档(请参见https://www.pandoc.org/lua-filters.html#module-pandoc)。获得文档后,我们可以从元数据中读取标题并插入新的标题。请注意,我们将过滤器应用于Para元素,而不是Image本身。这是因为pandoc将Block元素与Inline元素分开,并且过滤器的返回值必须为同一类型。 Image筛选器无法返回从文件解析的块列表,但Para可以。

所以这是结果代码。

function Para(elem)
    if #elem.content == 1 and elem.content[1].t == "Image" then
      local img = elem.content[1]    
      if img.classes:find('markdown',1) then
        local f = io.open(img.src, 'r')
        local doc = pandoc.read(f:read('*a'))
        f:close()

        -- now we need to create a header from the metadata
        local title=pandoc.utils.stringify(doc.meta.title) or "Title has not been set"
         local newHeader=pandoc.Header(1, {pandoc.Str(title)})
        table.insert(doc.blocks, 1, newHeader) 
        return doc.blocks
      end
    end
end

如果在以下合并文件上运行它,则>

pandoc -f markdown -t markdown -i combined.md  -s --lua-filter addtitle.lua

您会得到

---
title: Combined title
---

Topic 1
=======

Sample Header from file 1.md
----------------------------

text text text

Topic 2
=======

Sample Header from file 2.md
----------------------------

text text text

根据需要。

请注意,所包含文件中的任何其他Yaml元数据都将丢失。您可以通过从单个meta对象中获取并将其放入全局对象中来捕获其他任何内容。

© www.soinside.com 2019 - 2024. All rights reserved.