Sublime Text 的 AsciiDoc 软件包

目前正在寻找维护者！

这是一个为 AsciiDoc 语言提供语法高亮和代码片段的 Sublime Text 软件包。

Sublime Text 与 OS X 的 Textmate 编辑器的代码片段、首选项和语言文件兼容。然而，尽管 Sublime 可以识别 Textmate 代码片段，但一些功能（如标签完成和快捷命令）在默认情况下可能无法正常工作。此软件包克服了这些限制。

此处提供的所有文件应在 Windows 7 和 OS X Lion 上工作。

安装（包控制）

在包控制中查找名为 AsciiDoc 的软件包。

安装（手动）

要手动安装软件包，请按照以下步骤操作

• 下载包含源文件的 zip 文件。
• 将文件提取到 AsciiDoc 文件夹下，在以下位置：
  • Windows: %APPDATA%\Sublime Text 3\Packages\
    
  • OS X: ~/Library/Application Support/Sublime Text 3/Packages
  • Linux: ~/.config/sublime-text-3/Packages
  • 便携式安装: Sublime Text 2/Data
    
• 关闭所有 Sublime Text 实例，然后重新启动编辑器。
  

如果安装成功，您应该在 视图 > 语法 和 工具 > 代码片段 下看到 AsciiDoc 条目。

注意：在 Windows 下，代码片段可能需要几秒钟才能加载。

配置变量：TM_FULLNAME，TM_EMAIL 等。

文章片段引用了某些变量，其样式遵循 TextMate 对环境变量的标准（以及其他 Sublime 的设计），这些变量可以通过 Default.tmPreferences 文件进行配置。

1. 编辑 Default.tmPreferences
2. 将“我的全名”、“我的电子邮件”和“我的公司”替换为您的实际姓名、电子邮件地址和公司名称。
3. 如有必要，更新 TM_YEAR 的定义（目前为 2013）。
4. 测试文章片段（创建一个新的 AsciiDoc 文件，输入“ar”并按 Tab 键）。

配置 AsciiDoc 构建设置

Sublime具有用于编译源代码的构建系统，在本例中为AsciiDoc源代码。这里提供了一个名为asciidoc.sublime-build的文件，以允许您利用构建系统，但需要告知Python和AsciiDoc的实际安装位置

1. 编辑asciidoc.sublime-build
2. 将工作目录（working_dir）从“/path/to/asciidoc-8.6.8”更改为实际安装AsciiDoc的位置（例如“C:\prgs\asciidoc-8.6.8”）
3. 将cmd的第一个参数从“/path/to/python”更改为Python引擎的实际名称和位置（例如“C:\Python27\python.exe”）
4. 注意：有关ctrl+b不再作为构建系统快捷键的信息，请参阅下文。

用法

• 创建一个新文件，将其保存为<filename>.asc
• 开始键入AsciiDoc！

代码片段

可以通过使用菜单命令工具 > 代码片段 > AsciiDoc或键入前两个字符然后按Tab键进行完成来插入代码片段。以下是一些Tab完成示例：

• 开始新文章（键入ar TAB）
• 注释（键入// TAB）
• 标题（键入h1 TAB到h4 TAB为一行版本）
• 表格生成（键入|= TAB）
• 块中的Tab扩展（键入== TAB）
  
• 侧边栏块（键入** TAB）
• 向词表添加定义（键入:: TAB）
• 在其他地方引用词表定义（键入<< TAB）

文章:: 当您首次调用文章片段时，“标题”将被突出显示。用您想要的实际标题覆盖它。（注意，新标题将被自动下划到指定长度。）按Tab键离开标题，后端选择将变得突出。这仅是最受欢迎的3个后端。您可以选择删除2个，或者用第4个选择（例如manpage）覆盖它。按Tab键离开。

定义和定义链接:: 使用这些来创建具有锚点和相应引用的词表定义。注意，当您键入被定义的术语名称时，锚标记将自动组成，以及任何非字母数字字符都将自动从标记中排除。

键盘快捷键

现在有一些实用的快捷键得到了基本支持

• 粗体选项：选择一些文本然后按ctrl+b
• 倾斜选择：选择一些文本然后按ctrl+i
• 将选择标记为代码文字：选择一些文本然后按ctrl+k，ctrl+k
• 将选择标记为文件名：选择一些文本然后按ctrl+k，ctrl+f

注意：ctrl+b覆盖了工具 > 构建系统的标准快捷键绑定。如果您感到困扰，可以编辑Packages\AsciiDoc文件夹下的.sublime-keymap文件（根据您的操作系统）。

如果有时间，我将添加更多快捷键，但与此同时，如果您发现了有用的东西，请随时提交补丁！

增强功能

以下是该计划的增强功能：

• 为各种命令（如加粗文本、斜体、块等）添加键盘快捷键。
• 添加构建系统以预览为HTML或PDF。

欢迎您的建议。

作者及致谢

由Hrusikesh Panda创建。左移或右移，随意。

感谢Christian Zuckschwerdt为其原始工作在AsciiDoc TextMate bundle上的贡献。

文章、定义和定义链接片段由Craig Jones编写。