TeX Policy: различия между версиями

Версия от 13:06, 26 марта 2009

ALT TeX policy

Черновик политики Sisyphus

[none Обсуждение в devel@]

Обсуждается с none

Данный документ содержит правила и рекомендации по упаковке пакетов, предоставляющих компоненты подсистемы TeX или использующих ТеХ и его компоненты для сборки, а также имеющих установочные зависимости на те или иные части подсистемы ТеХ.

Определения

Дистрибутив ТеХ — пакет или коллекция пакетов, предоставляющих исполняемые файлы оригинальной программ tex и metafont Дональда Кнута, а также совместимых с ним программ, и прочие файлы, необходимые для их работы. В настоящий момент в Сизифе имеется два дистрибутива TeX — texlive и tetex. Дистрибутивы ТеХ конфликтуют между собой и на настоящий момент нет возможности одновременно установить пакеты, относящиеся к разным дистрибутивам ТеХ.
Дерево TEXMF — подкаталог файловой системы, организованный в соответствии с TDS. В контексте создания пакетов актуальны следующие деревья texmf:
- TEXMFMAIN — /usr/share/texmf
- TEXMFDIST — /usr/share/texmf-<tex_distro_name>
Модуль TEXMF — любые файлы, предназначенные для использования ТеХ’ом и совместимыми с ним программами (размещаемые в одном из деревьев TEXMF и доступные средствами библиотеки libkpathsea). Модуль TEXMF может быть оформлен в качестве отдельного пакета, независимого от конкретного дистрибутива ТеХ, что позволяет использовать такие пакеты с любым из дистрибутивов ТеХ.
Пакет, использующий подсистему ТеХ — любой пакет, который нуждается в сборочных либо установочных зависимостях на любые программы, входящие в дистрибутив ТеХ.

Упаковка пакетов, использующих подсистему ТеХ

Установочные зависимости

В общем случае (пакет не специфичен для конкретного дистрибутива ТеХ), зависимости на необходимые программы из состава дистрибутива ТеХ не следует указывать явно — они будут обнаружены автоматически. Выполнение этого правила позволит использовать такой пакет с любым из дистрибутивов ТеХ, не привязывая его без необходимости к одному из них.

В случае, если необходимая зависимость не была по каким-то причинам обнаружена автоматически, допускается явное указание зависимости на конкретный исполняемый файл, необходимый пакету, например:

Requires: /usr/bin/latex
Requires: /usr/bin/dvips

Обо всех случаях, когда необходимые зависимости не были обнаружены автоматически, следует сообщать как об ошибке.

Возможны ситуации, когда пакет специфичен для конкретного дистрибутива ТеХ и либо не работает с другим дистрибутивом ТеХ, либо не имеет для него смысла. В этом случае допускается указание зависимости на имена пакетов конкретного дистрибутива TeX, например, tetex-latex.

Во всех остальных случаях указание в пакете зависимости на имена пакетов одного из дистрибутивов ТеХ считается ошибкой.

Сборочные зависимости

Пакетам, использующим программы из состава дистрибутива ТеХ, следует указывать сборочную зависимость на пакеты того дистрибутива ТеХ, который мантейнер считает нужным использовать для сборки.

Ниже в таблице приведены имена пакетов дистрибутивов ТеХ, соответствующих основным функциональностям, необходимым другим пакетам при сборке:

Функциональность	tetex	texlive
tex(LaTeX) -> dvi	tetex-latex	texlive-latex-base
tex(LaTeX) -> pdf	tetex-latex	texlive-latex-base
dvi -> ps	tetex-dvips	texlive-base-bin

В настоящее время дистрибутивы ТеХ неравноценны в отношении поддержки: tetex не поддерживается, texlive поддерживается и развивается. Поэтому мантейнерам рекомендуется по возможности использовать при сборке пакеты texlive.

Дистрибутивы ТеХ должны быть эквивалентны в своей основной функциональности, поэтому замена в сборочной среде пакетов одного дистрибутива ТеХ на эквивалентный набор пакетов другого не должна влиять на успешность и результат сборки. Если такое влияние обнаруживается, об этом следует сообщать как о возможной ошибке.

Нельзя одновременно указывать в сборочных зависимостях пакеты, относящиеся к разным дистрибутивам ТеХ, т.к. это приведёт к невозможности сформировать сборочную среду (дистрибутивы ТеХ конфликтуют между собой).

Упаковка модулей TEXMF

В этом разделе рассмотрены правила упаковки компонентов ТеХ на нескольких наиболее распространённых примерах.

Размещение файлов

Сначала определим некоторые дополнительные термины:

TEXMFMAIN

TEXMFDIST

TeX input files
Документация
Конфигурационные файлы

Стили для LaTeX

Стиль для LaTeX может быть запакован в отдельный пакет в том случае, если этот стиль либо отсутствует в дистрибутивах ТеХ, либо имеется там в более ранней версии, чем в отдельном пакете.

Схема именования пакетов: latex-<имя_стиля>
FIXME: сделать шаблон спека

Шрифты для использования в ТеХ

Схема именования пакетов: fonts-<тип>-<имя_коллекции>-tex. См. также FontsPolicy
FIXME: сделать шаблон спека

Ссылки

TeX

LaTeXIgnores • SampleSpecs/texmf-latex • TeX Policy • TeXLivePackaging • TeXLiveTesting • TeXSubsystem • Books:Советы по вёрстке

@@ Строка 50: / Строка 50: @@
 === Сборочные зависимости ===
-Пакетам, вызывающим ТеХ или его модификации для сборки, следует указывать
+Пакетам, использующим программы из состава дистрибутива ТеХ, следует
-сборочную зависимость на пакеты одного из дистрибутивов ТеХ.
+указывать сборочную зависимость на пакеты того дистрибутива ТеХ,
+который мантейнер считает нужным использовать для сборки.
-Наиболее типичная сборочная зависимость -- использование LaTeX при сборке:
+Ниже в таблице приведены имена пакетов дистрибутивов ТеХ, соответствующих
-* tetex -- {{pkg|tetex-latex}}
+основным функциональностям, необходимым другим пакетам при сборке:
-* texlive -- {{pkg|texlive-latex-base}}
+{| class="standard"
+|-
+!Функциональность || tetex || texlive
+|-
+|tex(LaTeX) -> dvi || tetex-latex || texlive-latex-base
+|-
+|tex(LaTeX) -> pdf || tetex-latex || texlive-latex-base
+|-
+|dvi -> ps || tetex-dvips || texlive-base-bin
+|}
+В настоящее время дистрибутивы ТеХ неравноценны в отношении поддержки:
+tetex не поддерживается, texlive поддерживается и развивается.
+Поэтому мантейнерам рекомендуется по возможности использовать
+при сборке пакеты texlive.
+Дистрибутивы ТеХ должны быть эквивалентны в своей основной функциональности,
+поэтому замена в сборочной среде пакетов одного дистрибутива ТеХ на
+эквивалентный набор пакетов другого не должна влиять на успешность
+и результат сборки. Если такое влияние обнаруживается, об этом следует
+сообщать как о возможной ошибке.
+Нельзя одновременно указывать в сборочных зависимостях пакеты, относящиеся
+к разным дистрибутивам ТеХ, т.к. это приведёт к невозможности сформировать
+сборочную среду (дистрибутивы ТеХ конфликтуют между собой).
 == Упаковка модулей TEXMF ==