在 arara 中添加对 upmendex 的支持

在 arara 中添加对 upmendex 的支持

这实际上不是一个问题,而是一个对“arara”作者的建议。

我试图找到联系 Paulo Cereda(《arara》的作者)的方法,但在互联网上却没能很快找到。

我第一次在 Frank Mittelbach 所著的《The Latex Companion - Third Edition》一书中读到有关“upmendex”的内容。

Upmendex 是一个可用于生成基于 Unicode 索引的程序。

我想要“arara”中“upmendex”的“规则”。

现在我自己创建了一个,通过复制“arara-rule-makeindex.yaml”并将其重命名为文件夹“C:\texlive\2023\texmf-dist\scripts\arara\rules”中的“arara-rule-upmendex.yaml”。

我将其改为如下所示:

!config
# Arara, the cool TeX automation tool
# Copyright (c) 2023, Island of TeX
# All rights reserved.
#
# This rule is part of arara.
identifier: upmendex
name: UpMendex
authors:
- Hans Nieuwenhuis
commands:
- name: The UpMendex index software
  command: >
    @{
        base = getBasename(reference.fileName);
        infile = base.concat('.').concat(input[0]);
        outfile = [ '-o', base.concat('.').concat(output[0]) ];
        logfile = [ '-t', base.concat('.').concat(log[0]) ];
        return getCommand('upmendex', IgnoreLeadingAndTrailingBlanks, style, order, options,
                          logfile, infile, outfile);
    }
arguments:
- identifier: input
  flag: >
    @{
      parameters.input
    }
  default: idx
- identifier: output
  flag: >
    @{
      parameters.output
    }
  default: ind
- identifier: log
  flag: >
    @{
      parameters.log
    }
  default: ilg
- identifier: IgnoreLeadingAndTrailingBlanks
  flag: >
    @{
        isTrue(parameters.IgnoreLeadingAndTrailingBlanks, '-c')
    }
- identifier: order
  flag: >
    @{
        if ([ 'letter', 'word' ].contains(parameters.order)) {
            return isTrue(parameters.order == 'letter', '-l', '');
        }
        else {
            throwError('The provided order is invalid.');
        }
    }
- identifier: style
  flag: "@{ [ '-s', parameters.style ] }"
- identifier: options
  flag: >
    @{
        if (isList(parameters.options)) {
            return parameters.options;
        }
        else {
            throwError('I was expecting a list of options.');
        }
    }

我在 Latex 文件中使用它如下:

% arara: lualatex: { synctex: no, shell: yes }
% arara: lualatex: { synctex: no, shell: yes}
% arara: lualatex: { synctex: no, shell: yes }
% arara: upmendex: { IgnoreLeadingAndTrailingBlanks: yes, style: MyIndexStyle.ist }
% arara: lualatex: { synctex: no }
% arara: lualatex: { synctex: no }
% arara: clean: { extensions: [ log, aux, out, toc, ] }

文件“MyIndexStyle.ist”如下所示:

% This is the style file for generating an index using upmendex
% https://github.com/t-tk/upmendex-package

% show a big letter above each group of words starting with the same letter
headings_flag    1
heading_prefix   "\\hfill {\\Large --\\textbf{"
heading_suffix   "}--} \\hfill \\nopagebreak \n"

% right align page numbers
delim_0   "\\dotfill "
delim_1   "\\dotfill "
delim_2   "\\dotfill "

请随意使用它,直到“arara”中对“upmendex”有官方支持为止:-)

相关内容