pandoc 模板-元数据变量(标题、作者和日期等)
元数据变量
title
, author
, date
(标题,作者,日期)
能够帮助我们识别文档的基本信息。这些信息可以通过 LaTeX 和 ConTeXt 设置在 PDF 的元数据中。我们可以通过 pandoc title block 来设置这些信息,这种方式支持多作者,或者我们也可以通过 YAML 元数据块来设置,例如:
author:
- Aristotle
- Peter Abelard
...
请注意,如果你只想设置 PDF 或 HTML 的元数据,而不是文档内容中包含标题块,你可以设置 title-meta
,author-meta
和 date-meta
变量。(默认情况下,这些都会根据title
, author
, date
自动设置。)HTML 中的页面标题由 pagetitle
设置,它默认等于标题。
subtitle
文档副标题,包含在 HTML,EPUB,LaTeX,ConTeXt 和 docx 文档中
abstract
文档摘要,包含在 HTML,LaTeX,ConTeXt,AsciiDoc 和 docx 文档中
abstract-title
摘要的标题,目前只在 HTML,EPUB 和 docx 中使用。这将根据语言自动设置为本地化的值,但可以手动覆盖。
keywords
要包含在 HTML,PDF,ODT,pptx,docx 和 AsciiDoc 元数据中的关键词列表;重复作者上述的操作
subject
文档主题,包含在 ODT,PDF,docx,EPUB 和 pptx 元数据中
description
文档描述,包含在 ODT,docx 和 pptx 元数据中。一些应用程序将此显示为评论元数据。
category
文档类别,包含在 docx 和 pptx 元数据中
此外,任何根级字符串元数据,如果未包含在 ODT,docx 或 pptx 元数据中,将作为自定义属性添加。以下是一个 YAML 元数据块的例子:
---
title: 'This is the title'
subtitle: "This is the subtitle"
author:
- Author One
- Author Two
description: |
This is a long
description.
It consists of two paragraphs
...
在转换为 docx、ODT 或 pptx 时,将把 title
, author
和 description
作为标准文档属性包含进来,而 subtitle
则作为自定义属性。
语言变量
lang
使用 IETF 语言标签(遵循 BCP 47 标准)来标识文档的主要语言,例如 en 或 en-GB。可以使用语言子标签查找 工具来查找或验证这些标签。这影响大多数格式,并在使用 LaTeX(通过 babel 和 polyglossia)或 ConTeXt 生成 PDF 输出时控制连字符。
使用带有 lang 属性的原生 pandoc Divs 和 Spans 来切换语言,示例:
---
lang: en-GB
...
Text in the main document language (British English).
::: {lang=fr-CA}
> Cette citation est écrite en français canadien.
:::
More text in English. ['Zitat auf Deutsch.']{lang=de}
dir
基础脚本方向,可以是 rtl
(从右到左)或 ltr
(从左到右)。
对于双向文档,可以使用带有 dir
属性(值为 rtl
或 ltr
)的原生 pandoc span
和 div
来覆盖某些输出格式中的基本方向。如果最终的渲染器(例如,在生成 HTML 时的浏览器)支持 Unicode 双向算法,则可能并不总是需要这样做。
在使用 LaTeX 为双向文档时,只有 xelatex 引擎得到了完全支持(使用--pdf-engine=xelatex
)。