Sublime Text 2/3 的 Pandoc academia 插件

一个用于处理 Sublime Text 2/3 的 Pandoc 的插件。本插件提供以下功能：

• 与两个暗色主题关联的语法高亮工具，
• 快速添加 Pandoc 功能的多个代码片段，
• 一个将 Pandoc 文件转换为 HTML、DocX、PDF 和 Beamer 文档的转换工具。

基于 Pandoc Render 插件。

版本

插件版本：v1.1 – 在编译后自动启动与文件关联的程序。

插件版本：v1.2 – 添加 Grid Table 模块和 LaTeX 类选项。

插件版本：v1.3 – 将脚本转换为 Python 3/Sublime Text 3 可运行的格式。

安装

安装包的最简单方法是使用 包控制管理器。进入偏好设置 > 包控制 > 安装包，搜索“潘多可 academia”。

您也可以手动安装插件。从 Github 下载最新版本，并将其文件夹复制到您的 Sublime Text 2 包文件夹中。（例如，在 Linux 中：/．config/sublime-text-2/Packages）。

$ git clone [email protected]:larlequin/PandocAcademic.git

依赖关系

您需要安装版本 1.9.4.2 或更高版本的 Pandoc。

可用命令

语法和配色方案

您可以在菜单中选择Markdown文件的语法（Pandoc）：查看 > 语法 > Pandoc。选择此语法以使转换菜单可用。

兼容的配色方案在菜单中提供：偏好设置 > 配色方案 > Pandoc academia > ColorScheme。

转换

转换在菜单中提供：工具 > Pandoc academia > Pandoc 转换（仅当 Pandoc 被定义为语法时）。您可以将 Pandoc 文件转换为：

• HTML
• DocX
• PDF（通过 LaTeX，见 Pandoc 文档）
• Beamer（通过 LaTeX，见 Pandoc 文档）

您还可以使用快捷键启动转换

• HTML > CTL+ALT+h
• DocX > CTL+ALT+d
• Beamer > CTL+ALT+b
• PDF > CTL+SHIFT+ALT+p

代码片段

通用代码片段

• co + 制表符 = 添加注释代码片段（HTML格式）
• bo + 制表符 = 添加粗体文本代码片段（Pandoc/Markdown中的**）
• it + 制表符 = 添加斜体文本代码片段（Pandoc/Markdown中的*）
• link + 制表符= 在Pandoc/Markdown中添加网页链接代码片段

图表和表格

• img + 制表符 = 在Pandoc中添加图片代码片段
• tab + tab = 从文件中添加表格并添加标题（类似文章）代码片段

引用/文献片段

• ci + 制表符 = 添加括号中的引用代码片段[文本? @引用键]
• bib + 制表符 = 在当前文件中添加[[BIB]]选项

数学片段

• mat + 制表符 = 基于LaTeX样式的数学代码片段
• pow + 制表符 = 添加eta平方符号代码片段

其他代码片段

• not + 制表符 = 添加脚注
• toc + 制表符 = 在当前文件中添加[[TOC]]选项
• temp + 制表符 = 在当前文件中添加[[DOCSYTLE=名称]]选项
• class + 制表符= 在当前文件中添加[[CLASS=名称]]选项
• head + 制表符 = 在当前文件中添加[[HEADER]]选项
• rend + 制表符 = 在当前文件中添加[[NORENDER]]选项

Pandoc选项

以下提示可以添加到您的文档中，以在Pandoc中开启更多功能

• \: 在输出文档顶部添加目录。
• \: 启用节编号。
• \: 添加处理引用和参考文献的引用选项（@引用键）。参考文献文件应与Pandoc文件同名。
• \: 指定csl参考文献样式。
• \: 指定转换为HTML或DOCX或Beamer的主题模板。
• \: 指定用于PDF、LaTeX或Beamer文档的类类型。
• \: 对转换为Beamer的转换添加自定义标题选项（文件应与Pandoc文件在同一目录中）。
• \: 不自动启动相关程序选项。

注意：这些提示由插件处理，并且不是Pandoc本身的一部分。

模板

模板可以在Pandoc插件文件夹中的“样式”文件夹中找到（在Sublime Text的包文件夹中）。版本中包含标准HTML和DOCX模板（来自Pandoc Render插件）以及APA指南DOCX模板。

您可以指定选项BIBSTYLE、DOCSTYLE、CLASS和HEADER中的路径和模板名称来使用自定义模板。

表格

在Pandoc中创建网格表格是一个繁琐的任务。使用Pandoc Academic可以轻松创建或扩展现有网格表格。

该模块将自动添加填充虚线和交叉。模块还将基于每列中最长的单元格自动调整列宽度。您可以处理空单元格并扩展现有网格表格。

创建新表格

要创建新表格，只需键入您的数据，列之间至少有2个空格作为分隔。

示例

Conditions  Col1  Col2  Col3
Line 1  data1  data2  data3
Line 2  data4  data5  data6

然后使用鼠标选择数据，转到工具 > Pandoc Academic > Pandoc Table或使用快捷键CTL+SHIFT+ALT+t。您应看到

+------------+-------+-------+-------+
| Conditions | Col1  | Col2  | Col3  |
+============+=======+=======+=======+
| Line 1     | data1 | data2 | data3 |
+------------+-------+-------+-------+
| Line 2     | data4 | data5 | data6 |
+------------+-------+-------+-------+

该模块始终将第一行视为标题行。如果一个或多个单元格应为空，只需键入NA。

扩展现有表格

该模块允许扩展现有表格。只需添加新数据或修改现有数据，然后使用模块

+------------+-------+-------+-------+
| Conditions | Col1  | Col2  | Col3  | Col4
+============+=======+=======+=======+
| Line 1     | rename | data2 | data3 | data7
+------------+-------+-------+-------+
| Line 2     | data4 | long long data | data6 | data8
+------------+-------+-------+-------+

将成为

+------------+--------+----------------+-------+-------+
| Conditions | Col1   | Col2           | Col3  | Col4  |
+============+========+================+=======+=======+
| Line 1     | rename | data2          | data3 | data7 |
+------------+--------+----------------+-------+-------+
| Line 2     | data4  | long long data | data6 | data8 |
+------------+--------+----------------+-------+-------+

路径选项

如果Pandoc不是Sublime Text的路径中，您可以在文件中使用以下命令指定自定义路径：[[PATH=路径名称]]。

如果您想要更改插件使用的路径，您可以编辑插件文件“PandocConvertor.py”，更改第146行：

cmd = ['pandoc']

使用

cmd = ['your_path']

说明

我是一个学术人，不是软件程序员或计算机高手。因此，这个插件缺少一些功能，可能需要改进。我会尽力而为，但需要您的反馈来帮助我改进：[[email protected]]。同样，如果您愿意帮助或参与这个项目，您的参与将非常受欢迎。

谢谢！

Guillaume