asciidoc_使用AsciiDoc编写文档

asciidoc

在一个月的午餐中编写“ 学习Linux”时发现了AsciiDoc AsciiDoc是一种用于编写书籍的非常详尽的标记语言-想想Markdown ,但是具有更多选项,例如边栏,注释和表格。 AsciiDoc允许您通过简单的语法来控制格式键入。

刚开始写书时,我在LibreOffice中使用Word样式表。 我的出版商曼宁(Manning)为OpenOffice提供了.odt版本,但是我无法使样式起作用。 具有讽刺意味的是,我最后使用了Word .docx模板,该模板最适合LibreOffice。 但是最大的问题是图像,无法正确嵌入。 当我需要写作时,我花费了大量时间格式化。

评论也很难解析。 吉姆·怀特赫斯特(Jim Whitehurst)在写《开放组织》一书时实际上为LibreOffice 打补丁以处理评论 经过几章的模板工作之后,我的编辑建议我们改用AsciiDoc,我的生活立即变得更轻松。

使用LibreOffice,我必须插入图像,对其进行编号,为其添加标题,对其进行样式设置,然后希望所有内容都结合在一起,而对于AsciiDoc,我需要编写以下内容:

.Mint的软件管理器外观与Ubuntu软件中心类似。

AsciiDoc会为我处理其他所有事情,包括为字幕中的图像编号。 上面的代码就是这样呈现的:

asciidoc_使用AsciiDoc编写文档
AsciiDoc转换为PDF。

侧边栏或注释就像这样简单:

asciidoc_使用AsciiDoc编写文档

注释的AsciiDoc语法。

变成这样:

asciidoc_使用AsciiDoc编写文档

呈现为PDF的注释的AsciiDoc语法。

AsciiDoc具有标题和副标题的格式,甚至可以基于它们自动生成目录:

asciidoc_使用AsciiDoc编写文档

AsciiDoc自动生成一个目录。

由于AsciiDoc是文本,因此您可以在任何文本编辑器中编写代码,但是我想预览代码以确保一切正常。 有一个Gedit插件,但是使用它会需要一些努力,而我正赶上最后期限。 我决定使用GitHub创建的文本编辑器Atom Atom有一个渲染AsciiDoc的插件,我在编写几章时曾尝试过,但是预览有时很特殊。 注释和侧栏将扩展到整个文档。 另外,我无法直接用它打开AsciiDoc格式的文档。 相反,我必须先打开Atom,然后通过Atom打开菜单打开文档。

Atom很好,但很烦人,我决定尝试使用Adobe开源文本编辑器Brackets 括号使AsciiDoc变得更好,尽管打开AsciiDoc文件仍然不是无缝的,但它比Atom更好。 我希望Brackets具有运行中的拼写检查功能,而不是能够在完成后运行拼写检查功能,但是它可以预览我需要查看的内容并为我提供运行中的字数统计功能,所以我很高兴。

asciidoc_使用AsciiDoc编写文档
括号文本编辑器。

asciidoc_使用AsciiDoc编写文档

由Brackets呈现的AsciiDoc。

括号和Atom使用HTML渲染,但是a2x命令是AsciiDoc软件包的一部分,使将.adoc文件转换为PDF变得容易(尽管当图像文件名称中带有句点时,错误会导致转换失败)。 输出看起来像是专业格式化的书章。

AsciiDoc一直是我的救星,我很幸运能与使用它的发行商合作。 我认为AsciiDoc可以为需要美观PDF或对自发布感兴趣的任何人提供应用程序。 同样,AsciiDoc对开放式教育资源也具有巨大的影响,因为它允许某人编写课本而不必格式化它。 他们将轻松准备好PDF,并且可以将基础AsciiDoc提供给想要修改原始文档的人员。

对于像我这样不想处理格式的人来说,像AsciiDoc这样的标记语言非常适合。 移至AsciiDoc后,我们可以使用私有git存储库来回提交草稿。 AsciiDoc还具有注释掉文本的功能,这使我们可以共享文本中的注释。 AsciiDoc节省了我编写本书的时间,因为它使我可以专注于编写而不是样式和格式。 如果您还没有尝试过AsciiDoc,请尝试一下,让我们知道您在评论中的想法。

最初发布在MyLinuxRig.com上 经许可重新发布。

文件

本文是Rikki Endsley协调的Doc Dish专栏的一部分。 要撰写本专栏文章,请提交您的故事创意与我们联系

翻译自: https://opensource.com/life/15/10/asciidoc

asciidoc