13.2 Export Settings

导出选项可在多处设置:全局变量;单个文件内通过缓冲区局部变量设置(见 Summary of In-Buffer Settings);单独设置关键字或用 ‘OPTIONS’ 关键字紧凑设置;子树级别通过属性设置(见 Properties and Columns)。低层级设置会覆盖高层级设置。

缓冲区设置可出现在文件任意位置,可直接书写或通过 ‘#+SETUPFILE: filename or URL’ 语法引入外部文件。针对特定后端的选项关键字集可在导出调度器(见 The Export Dispatcher)中按 # 使用 ‘插入模板(Insert template)’ 命令生成。逐个插入关键字时,建议输入 ‘#+’ 后按 M-TAB128 补全以确保正确。

所有后端通用的导出关键字及对应全局变量包括:

AUTHOR

文档作者 (user-full-name) 。

CREATOR

生成输出内容的程序标识 (org-export-creator-string)。

DATE

日期或时间戳129

EMAIL

邮箱地址 (user-mail-address)。

LANGUAGE

导出时用于翻译固定字符串的语言 (org-export-default-language)。例如 ‘#+LANGUAGE: fr’ 会将 ‘Table of contents’ 译为法语 ‘Table des matières130

SELECT_TAGS

选中导出的标签列表,默认 org-export-select-tags("export")’ 。子树带有 ‘export’ 标签时,该子树及其下级会被导出,其余无此标签的部分忽略。

按 ‘export’ 标签选择性导出时,第一个标题前的文本不会导出。

无 ‘export’ 标签的文件会导出全部内容。

如需自定义导出标签,可全局修改 org-export-select-tags 或在文档中添加 ‘#+SELECT_TAGS: tag1 tag2’ 。

EXCLUDE_TAGS

排除导出的标签列表,默认 org-export-exclude-tags("noexport")’ 。子树带有 ‘noexport’ 标签时,该子树及其下级会被排除。

标记 ‘noexport’ 的条目无条件排除,即使同时带有 ‘export’ 标签。子树即使不导出,其中代码块仍会执行。

如需自定义排除标签,可全局修改 org-export-exclude-tags 或在文档中添加 ‘#+EXCLUDE_TAGS: tag1 tag2’ 。

TITLE

文档标题。长标题可使用多行 ‘#+TITLE’ 。

EXPORT_FILE_NAME

指定输出文件名。未指定时,Org 会根据缓冲区名称和后端格式后缀自动生成。

OPTIONS’ 关键字为紧凑设置方式,可使用多行配置多个选项,支持以下参数:

'

切换智能引号 (org-export-with-smart-quotes)。启用后,根据语言将双引号作为主引号、单引号作为次引号,单独撇号视为省略符。

*

切换强调文本 (org-export-with-emphasize)。

-

切换特殊字符串转换 (org-export-with-special-strings)。

:

切换等宽区域 (org-export-with-fixed-width)。

<

切换是否包含时间/日期的激活/非激活标记 (org-export-with-timestamps)。

\n

切换是否保留换行 (org-export-preserve-breaks)。

^

切换类 TeX 上下标语法。若写 ‘^:{}’ ,则 ‘a_{b}’ 会被解析,简单写法 ‘a_b’ 保持原样 (org-export-with-sub-superscripts)。

arch

设置已归档子树的导出方式。设为 headline 时仅导出标题忽略内容 (org-export-with-archived-trees)。

author

切换是否在导出文件中包含作者名 (org-export-with-author)。

expand-links

切换是否展开文件路径中的环境变量 (org-export-expand-links)。

broken-links

切换发现无效内部链接时是否继续导出。设为 mark 时会在输出中明显标记问题链接 (org-export-with-broken-links)。

c

切换是否包含 ‘CLOCK’ 关键字 (org-export-with-clocks)。

creator

切换是否在导出文件中包含生成程序信息 (org-export-with-creator)。

d

切换是否包含抽屉,或指定包含/排除的抽屉列表 (org-export-with-drawers)。

date

切换是否在导出文件中包含日期 (org-export-with-date)。

e

切换是否包含实体字符 (org-export-with-entities)。

email

切换是否在导出文件中包含作者邮箱 (org-export-with-email)。

f

切换是否包含脚注 (org-export-with-footnotes)。

H

设置导出时仍作为标题的最低层级 (org-export-headline-levels)。低于该层级的标题在多数后端中会转为列表项。

inline

切换是否包含内联任务 (org-export-with-inlinetasks)。

num

切换章节编号 (org-export-with-section-numbers)。设为数字 N 时仅对 N 级及以上标题编号。将 ‘UNNUMBERED’ 属性设为非 nil 可完全禁用标题编号;若值为 ‘notoc’ ,该标题及其子项也不会出现在目录中(见 Table of Contents)。

p

切换是否导出计划信息 (org-export-with-planning)。计划信息指标题下方包含 ‘SCHEDULED’ 、 ‘DEADLINE’ 、 ‘CLOSED’ 等标记的行。

pri

切换是否包含优先级标记 (org-export-with-priority)。

prop

切换是否包含属性抽屉,或指定要包含的属性 (org-export-with-properties)。

stat

切换是否包含统计标记 (org-export-with-statistics-cookies)。

tags

切换是否包含标签,也可设为 not-in-toc (org-export-with-tags)。

tasks

切换是否包含任务(TODO 项); nil 移除所有任务; todo 移除已完成任务;或指定保留的关键字列表 (org-export-with-tasks)。

tex

nil 不导出; t 正常导出; verbatim 全部按原样保留 (org-export-with-latex)。

timestamp

切换是否在导出文件中包含创建时间 (org-export-timestamp-file)。

title

切换是否包含标题 (org-export-with-title)。

toc

切换是否包含目录,或设置层级限制 (org-export-with-toc)。

todo

切换是否在导出文本中包含 TODO 关键字 (org-export-with-todo-keywords)。

|

切换是否包含表格 (org-export-with-tables)。

导出子树时,特殊节点属性可覆盖以上关键字。这类属性以 ‘EXPORT_’ 为前缀,例如 ‘DATE’ 在子树中对应 ‘EXPORT_DATE’ 。除 ‘SETUPFILE’ 外,其余关键字均有对应的 ‘EXPORT_’ 属性。

org-export-allow-bind-keywordsnil ,可通过 ‘BIND’ 关键字在导出时将 Emacs 变量设为缓冲区局部变量,语法为 ‘#+BIND: variable value’ ,适用于无法通过关键字修改的缓冲区设置。


Footnotes

(128)

许多桌面环境会拦截 M-TAB 用于窗口切换,此时可改用 C-M-iESC TAB

(129)

变量 org-export-date-timestamp-format 定义该时间戳的导出格式。

(130)

导出为 LaTeX 格式(或 Beamer 等相关格式)时,需额外配置变量 org-latex-package-alist ,参见 LaTeX specific export settings