什么是有效的 arara 配置文件?

什么是有效的 arara 配置文件?

arara 程序本身是从命令行和 TeXWorks 运行的,但我陷入了配置文件错误。

它应该是可选的 - 所以我尝试不使用它。这会导致错误Apparently, there's an invalid directive at line 3.

有规则https://github.com/cereda/arara/tree/master/rules但至少 lualatex 会引发错误。

看似符合手册的规则https://ctan.crest.fr/tex-archive/support/arara/doc/arara-usermanual.pdf有效例如

!config
paths:
- C:/Program Files/arara

抛出类似以下的错误

Problem: mapping values are not allowed here
Error found in line 1, column 5.
    paths:

网上有各种版本,但都会抛出类似的错误。

答案1

我将此答案标记为社区维基。

已知版本3.0a随 TeX Live 和 MiKTeX 一起提供,因此如果您拥有其中任一 TeX 发行版,则几乎可以肯定您arara的系统路径中已经拥有它。:)快速浏览终端:

[paulo@cambridge ~] $ arara -v
  __ _ _ __ __ _ _ __ __ _ 
 / _` | '__/ _` | '__/ _` |
| (_| | | | (_| | | | (_| |
 \__,_|_|  \__,_|_|  \__,_|

arara 3.0a - The cool TeX automation tool
Copyright (c) 2012, Paulo Roberto Massa Cereda
All rights reserved.
...

到目前为止,一切都很好。:)

arara还附带了几个预定义规则。它们列在当前用户手册中(可通过 CTAN 或texdoc arara在终端中发出命令访问)。以下是 TeX Live 安装中它们的位置:

[paulo@cambridge rules] $ pwd
/usr/local/texlive/2017/texmf-dist/scripts/arara/rules
[paulo@cambridge rules] $ ls
biber.yaml         lmkclean.yaml        make.yaml        sketch.yaml
bibtex.yaml        lualatexmk.yaml      nomencl.yaml     songidx.yaml
clean.yaml         lualatex.yaml        pdflatexmk.yaml  tex.yaml
dvips.yaml         luatex.yaml          pdflatex.yaml    xelatexmk.yaml
frontespizio.yaml  makeglossaries.yaml  pdftex.yaml      xelatex.yaml
latex.yaml         makeindex.yaml       ps2pdf.yaml      xetex.yaml

因此,除非您想为 定义自定义规则arara,否则完全不需要配置文件。:)一切都已开箱即用。例如,考虑mydoc.tex

% arara: pdflatex
\documentclass{article}

\begin{document}
Hello world.
\end{document}

如果你运行arara mydoc.tex,编译将按预期进行:

[paulo@cambridge ~] $ arara mydoc.tex 
  __ _ _ __ __ _ _ __ __ _ 
 / _` | '__/ _` | '__/ _` |
| (_| | | | (_| | | | (_| |
 \__,_|_|  \__,_|_|  \__,_|

Running PDFLaTeX... SUCCESS

要运行araraTeXworks,我们需要先配置编辑器。:)开始吧!

以下步骤在当前用户手册中有描述,因此,为了完整性起见,我冒昧地在此重现了它。

  1. 首先,点击编辑 → 偏好设置...打开首选项屏幕:

屏幕 1

  1. 下一个屏幕是 TeXworks 首选项。有多个选项卡可用。导航到排版选项卡,其中包含两个列表:TeX 和相关程序的路径以及处理工具。在第二个列表中 -处理工具- 点击加号 (+) 按钮添加另一个工具。

屏幕 2

  1. TeXworks 提供了一个非常直接的界面来添加新工具;我们只需要提供工具名称、可执行路径和参数。

屏幕

重要的提示:当我编写手册时,arara它尚未与 TeX Live 或 MiKTeX 一起发布,因此图中显示的路径不同。建议您从 TeX Live 安装中的文件夹arara中选择可执行文件bin。遗憾的是,我没有 Windows 机器可以为您指出确切的位置,因此我恳请我们的朋友在这方面帮助我。:)

这里有参数:

桌子

现在只需确认将其包含arara在 TeXworks 会话中的工具列表中。:)然后arara将被列为编译配置文件:

屏幕 4

现在,让我回过头来谈谈 版本的配置文件3.0a。由于我是 Linux 用户,我花了一段时间才明白为什么该工具会引发该特定错误。令人惊讶的是,原因是 的存在:,它在 YAML 格式中代表映射分隔符(因此出现错误)。解决方案是使用单引号或双引号引用该条目:

!config
paths:
- 'C:/Program Files/arara'

我相信这个有关配置文件的特定问题已经解决。现在,回到 GitHub 上的项目官方存储库中的规则。 :)

一段时间以来,我一直在arara开发一个全新的版本,希望在今年发布。这个新版本添加了新的增强功能、错误修复和更多内容,并且必须更新规则格式。鉴于这是我的第一个具有很高知名度的项目,我在组织事物方面经验不足,因此没有警告标志告诉用户3.0a版本arara不是仅因为这些规则是针对即将推出的版本且不向后兼容,所以不依赖这些规则。因此,对于造成的混淆,我深表歉意。

没有必要依赖这些规则,因为当前的发行版arara已经涵盖了大部分规则。希望新版本能在接下来的几个月内发布,所有与版本控制有关的混乱都将结束。最终,其他问题将会出现。:)

就这样吧,希望我的简陋笔记能帮到你。:)如果你需要任何澄清,请告诉我,我非常乐意帮助你!

相关内容