基于Pandoc生成自定义XML元数据文件的技术实现问询

一、Writer与模板的分工及选择 #

• 模板（Template）：适合输出结构固定、仅需替换元数据变量的场景。如果你的XML文件大部分结构固定，只需要填充标题、作者、日期这类元数据，直接用带$variable$的XML模板最省心。
• 自定义Writer：适合需要深度解析AST（比如提取幻灯片层级结构）、输出逻辑复杂的场景。如果你的XML需要包含类似OPML的演示文稿大纲，必须用自定义Writer遍历AST节点来实现。
  新风格的Lua Writer更推荐：相比旧风格，新风格的Writer(doc, opts)函数可以直接获取完整文档AST和配置选项，代码更简洁易维护。

二、Lua vs Haskell 开发选择 #

• Lua自定义Writer：门槛低，无需编译，直接通过pandoc命令调用，适合快速迭代。Pandoc的Lua API已覆盖大部分AST节点处理需求，完全能实现类似OPML的大纲输出。
• Haskell自定义Writer：仅适合需要深度整合Pandoc核心功能、对性能要求极高的场景，需要Haskell开发环境，编译调试成本高。你的需求只是生成管理用XML，完全没必要用Haskell。

三、具体实现步骤 #

场景1：仅提取基础元数据（用模板） #

1. 编写XML模板文件metadata-template.xml：

<presentation-metadata>
  <title>$title$</title>
  <authors>
    $for(author)$
    <author>$author$</author>
    $endfor$
  </authors>
  <date>$date$</date>
  <source>$sourceFile$</source>
</presentation-metadata>

2. 执行生成命令：

pandoc input.qmd --template=metadata-template.xml -o metadata.xml

Quarto的元数据会被Pandoc自动识别，直接在模板中使用对应变量即可。

场景2：提取幻灯片结构（类似OPML，用Lua Writer） #

1. 编写Lua Writer文件xml-metadata-writer.lua：

function Writer(doc, opts)
  local xml_lines = {}
  -- 写入根节点
  table.insert(xml_lines, '<presentation>')
  
  -- 写入基础元数据
  table.insert(xml_lines, '  <metadata>')
  if doc.meta.title then
    table.insert(xml_lines, '    <title>' .. pandoc.utils.stringify(doc.meta.title) .. '</title>')
  end
  if doc.meta.author then
    table.insert(xml_lines, '    <authors>')
    for _, auth in ipairs(doc.meta.author) do
      table.insert(xml_lines, '      <author>' .. pandoc.utils.stringify(auth) .. '</author>')
    end
    table.insert(xml_lines, '    </authors>')
  end
  table.insert(xml_lines, '  </metadata>')
  
  -- 遍历AST生成幻灯片大纲
  table.insert(xml_lines, '  <outline>')
  local function traverse_blocks(blocks, depth)
    depth = depth or 1
    local indent = string.rep('    ', depth)
    for _, block in ipairs(blocks) do
      -- 处理标题型幻灯片
      if block.t == 'Header' then
        local title = pandoc.utils.stringify(block.content)
        table.insert(xml_lines, indent .. '<slide title="' .. title .. '" level="' .. block.level .. '"/>')
      -- 处理Quarto的slide Div块
      elseif block.t == 'Div' and block.classes:includes('slide') then
        local slide_title = ''
        for _, child in ipairs(block.content) do
          if child.t == 'Header' then
            slide_title = pandoc.utils.stringify(child.content)
            break
          end
        end
        table.insert(xml_lines, indent .. '<slide title="' .. slide_title .. '"/>')
        traverse_blocks(block.content, depth + 1)
      end
    end
  end
  traverse_blocks(doc.blocks)
  table.insert(xml_lines, '  </outline>')
  
  table.insert(xml_lines, '</presentation>')
  return table.concat(xml_lines, '\n')
end

2. 执行生成命令：

pandoc input.qmd -t xml-metadata-writer.lua -o metadata.xml

场景3：Writer与模板结合 #

如果需要固定XML结构，同时插入动态生成的大纲内容，可以在Lua Writer中读取模板并替换占位符：

-- 读取模板文件
local template = io.open('metadata-template.xml', 'r'):read('*a')

function Writer(doc, opts)
  -- 生成大纲字符串
  local outline = ''
  -- 此处复用场景2的大纲生成逻辑，将结果存入outline变量
  
  -- 替换模板占位符
  local result = template:gsub('{{OUTLINE}}', outline)
  result = result:gsub('{{TITLE}}', pandoc.utils.stringify(doc.meta.title) or '')
  return result
end

四、注意事项 #

• Quarto Markdown的幻灯片可能用标题（##）或:::{slide} Div定义，Lua Writer中需要对应处理这两种结构。
• 使用pandoc.utils.stringify()可安全将Pandoc的Inline元素转为字符串，若需严格XML规范，可额外处理<、>、"等特殊字符的转义。

内容的提问来源于stack exchange，提问作者Eric G