14.1.7 Generating a sitemap

可使用以下属性控制指定项目的站点地图发布。

:auto-sitemap

nil 时,在执行 org-publish-current-projectorg-publish-all 时自动发布站点地图。

:sitemap-filename

站点地图输出文件名,默认为 ‘sitemap.org’ ,发布后变为 ‘sitemap.html’ 。

:sitemap-title

站点地图页面标题,默认为文件名。

:sitemap-style

可选 list (站点地图仅为相关文件标题的项目列表)或 tree (站点地图体现源文件的目录结构),默认为 tree

:sitemap-format-entry

该选项用于设置站点地图条目的格式。它是一个接收三个参数的函数:相对于项目基础目录的文件或目录名、 站点地图样式、当前项目,函数应返回一个字符串。默认值会将文件名转为链接,并使用文档标题作为链接描述。 如需特殊格式,可使用 org-publish-find-dateorg-publish-find-titleorg-publish-find-property 获取已发布文档的附加信息。

:sitemap-function

用于生成站点地图的插件函数。该函数接收两个参数:站点地图标题、项目涉及的文件与目录构成的嵌套列表, 该列表可通过 org-list-to-genericorg-list-to-subtree 等进一步转换。默认值生成指向项目内所有文件的纯链接列表。

:sitemap-sort-folders

文件夹在站点地图中的显示位置。设为 first (默认)或 last 可分别让文件夹显示在最前或最后; 设为 ignore 则完全忽略文件夹;其他值会将文件与文件夹混合显示。该变量在站点地图样式为 tree 时无效。

:sitemap-sort-files

文件在站点地图中的排序方式。可选 alphabetically (默认,按字母序)、 chronologically (按时间序,旧文件在前) 或 anti-chronologically (按反时间序,新文件在前)。文件日期通过 org-publish-find-date 获取。

:sitemap-ignore-case

排序是否区分大小写,默认为 nil