texdoc

Texdoc - поиск и просмотр документации в Tex Live

Общая информация

• Веб -сайт: https://www.tug.org/texdoc/
• Репозиторий: https://github.com/tex-live/texdoc/
• Список рассылки: [email protected]

Используя Texdoc

Texdoc является частью дистрибуции Tex Live. Как правило, вам не нужно устанавливать его самостоятельно.

Если вы хотите попробовать/протестировать разработку версии, см. Ниже.

Как установить версию разработки

Используя бундлер

Самый простой способ установить разработку версии Texdoc - это использование Bundler and Grable:

bundle install
rake install

Если вы хотите удалить версию разработки (для использования версии Tex Live), просто попробуйте:

rake uninstall

Установка вручную

Здесь, $TEXDOC означает путь к источникам Texdoc dev, которые вы клонировали (или загружены), а $TEXMFHOME обозначает ваше личное дерево Texmf (вы можете получить его местонахождение с помощью kpsewhich --var-value TEXMFHOME ).

• Команда. Symlink или Copy $TEXDOC/script как $TEXMFHOME/scripts/texdoc .
• Файл конфигурации. Symlink или Copy $TEXDOC/texdoc.cnf как $TEXMFHOME/texdoc/texdoc-dist.cnf (обратите внимание на -dist ). Он полностью переопределит другие файлы конфигурации, за исключением $TEXMFHOME/texdoc/texdoc.cnf которые вы все равно можете использовать для вас личных настройки.

Вы можете убедиться, что правильные файлы используются путем запуска texdoc --files : первая строка содержит полный путь к версии использованного texdoclib.tlu , а в Rest перечислены используемые файлы конфигурации.

Файлы в этом репозитории

• doc/ содержит документацию,
• script/ содержит исходный код,
• spec/ - это каталог для тестирования сценариев и
• texdoc.cnf - файл конфигурации по умолчанию.

Здание и тестирование

Многие строительные задачи определяются как грабли.

Генерируя всю документацию

Следующее будет генерировать как PDF, так и производитель в doc/ Directory.

rake doc

Создание предварительно сбитого кеша файла

Следующее будет генерировать предварительно забитый script/Data.tlpdb.lua . Эта задача должна быть выполнена в рамках Tex Live Setup с TLPDB.

rake gen_datafile

Заводящие тесты

Следующие будут выполнять все тесты в spec/ Directory.

rake test

В качестве альтернативы, вы можете дать имена спецификации с опцией --list ( -l ) для этой задачи. Например, следующее будет выполнять только spec/action/help_spec.rb и spec/mode/list_spec.rb :

rake test -- -l action/help,mode/list

Показывая все доступные задачи

Следующие будут показывать все доступные задачи с кратким описанием.

rake -T

В дополнение к этому, для доступных вариантов задач, например, rake test и rake run_texdoc , вы можете получить информацию о параметрах с опцией -h для каждой задачи:

rake test -- -h

Дополнительная информация

Более конкретную информацию, такую ​​как список TODO этого проекта и некоторая информация для дистрибьюторов, можно найти в вики репозитория GitHub. Пожалуйста, посетите:

• https://github.com/tex-live/texdoc/wiki

Авторские права и лицензия

Copyright 2008-2024 Manuel Pégorié-Gonnard, Takuto Asakura, Tex Live Team.

Этот пакет распространяется в соответствии с условиями общей публичной лицензии GNU, опубликованных Фондом Free Software Foundation, либо версией 3 лицензии, либо (по варианту) любой более поздней версии.

Предыдущая работа (программа Texdoc) в общественном доступе:

• Вклад Рейнхарда Котуча (2008).
• Первые версии Texlua Фрэнка Кюстера (2007).
• Оригинальный сценарий оболочки Томаса Эссера, Дэвида Аспиналла и Саймона Уилкинсона.