TeX Policy

Материал из ALT Linux Wiki
Версия от 09:15, 28 апреля 2009; Ilis (обсуждение | вклад) (Упаковка модулей TEXMF)
Перейти к: навигация, поиск

ALT TeX policy

Stub.png
Черновик политики Sisyphus
Автор(ы) — KirillMaslinsky
[none Обсуждение в devel@]
Обсуждается с none


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

Определения

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

См. также список других деревьев.

  • Модуль 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

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

Общие правила

Основные идеи и принципы упаковки отдельных модулей TEXMF аналогичны предложенным в Debian TeX Subpolicy:

  • Файлы отдельно упакованного модуля TEXMF имеют приоритет перед аналогичными файлами дистрибутивов ТеХ, «затеняют» их. Это позволяет предоставлять более новые версии модулей, чем те, которые имеются в относительно стабильных и редко обновляющихся дистрибутивах ТеХ.
  • Отдельно упакованные модули TEXMF должны быть «универсальными», доступными для использования с любым дистрибутивом ТеХ.

Отдельный пакет с модулем TEXMF имеет смысл только в том случае, если соответствующий модуль отсутствует в дистрибутиве ТеХ, либо в пакете предоставляется более новая версия модуля, чем та, которая присутствует в одном или во всех дистрибутивах ТеХ.

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

Именование пакетов

FIXME:

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

  • TeX input files

Модули TEXMF размещают файлы, предназначенные для использования ТеХом и сопутствующими программами (TeX input files), в дереве TEXMFMAIN в соответствии со стандартом TDS.

  • Документация

Файлы документации размещаются в подкаталогах TEXMFMAIN/doc в соответствии с TDS — это позволяет утилитам поиска ТеХ-документации (texdoc и пр.) обнаруживать эти файлы.

Допускается размещение файлов документации в каталоге /usr/share/doc/%name-%version, но в этом случае должны быть созданы необходимые символьные ссылки на файлы документации в иерархии TEXMFMAIN/doc, чтобы сделать их доступными для texdoc.

Файлы документации должны иметь содержательные названия, соответствующие тому пакету, который они документируют (не следует называть файлы общими именами manual, index и пр., так как это делает их недоступными для поиска средствами texdoc, использующими только имена файлов, но не каталогов, в которых эти файлы находятся).

  • Конфигурационные файлы

FIXME:

Зависимости

  • Сборочные (tex-common)
  • Post,Postun-Скрипты (/usr/bin/mktexlsr /usr/bin/updmap)

FIXME:

Стили для LaTeX

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

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

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

Упаковка дистрибутивов ТеХ

TODO

Ссылки