texdoctk - Интернет в облаке

ПРОГРАММА:

ИМЯ

texdoctk - графический интерфейс для облегчения доступа к пакетам TeX и программной документации

СИНТАКСИС

текстдоктк - [водный]

ОПИСАНИЕ

текстдоктк - это графический интерфейс для облегчения доступа к большей части огромного количества пакетов и
программная документация и руководства для TeX и его различных производных (в основном LaTeX).
Он оптимизирован и включен в дистрибутивы teTeX и fpTeX, а также доступен с
TeXLive.

Документация сгруппирована по 17 категориям; 18-я кнопка главной панели - это
по умолчанию неактивен и предназначен для использования с локальными дополнениями (см. раздел КОНФИГУРАЦИЯ
ниже).

В окне настроек вы видите флажок в меню конвертера html-> ps и text-> ps для
включение / выключение перенаправления вывода. Это связано с тем, что некоторые преобразователи не
записывать их вывод в файл, но по умолчанию в стандартный вывод, поэтому требуется перенаправление, например

a2ps myfile.txt> myfile.ps

ДОПОЛНИТЕЛЬНЫЕ ОПЦИИ

-v подробный: включить некоторые сообщения зрителя, которые в противном случае отправляются на stderr, а также
всплывающие окна с предупреждениями. Это также можно установить в файле конфигурации.

-a autoview: автоматически запускать программу просмотра, если список содержит только один элемент (это будет
часто встречаются в результатах поиска). Это также можно установить в файле конфигурации.

КОНФИГУРАЦИЯ

Конфигурация контролируется системным файлом конфигурации по умолчанию.
($ TEXMFMAIN) /texdoctk/texdocrc.defaults, большая часть записей которого может быть заменена
собственный необязательный ~ / .texdocrc файлы и / или параметры командной строки.

Команда Настройки МЕНЮ и конфигурация файлов
Меню настроек используется для изменения определяемых пользователем настроек текстдоктк для
продолжительность вызова программы или новые значения по умолчанию. Последний случай является целью
Кнопка Сохранить, которая генерирует или перезаписывает собственные ~ / .texdocrc файл. Система
значения по умолчанию нельзя изменить в меню «Настройки».

Пути Сообщаются пути типа TEXMF в системе, и пользователь может указать имя
подкаталога $ HOMETEXMF, где хранится личная документация.

Общее поведение зрителя

Подавить ошибка Сообщения переключить подробный режим (см. опцию -v); по умолчанию выключено.

Автоматический старт зритель для один предмет списки если список содержит только один элемент (см.
опция -a)

Используйте текст зритель для неизвестный файл формат т.е. рассматривать файл как обычный текст. текстдоктк
должен распознавать обычные форматы файлов, а также связывать имена, такие как README, с обычными
текст, но некоторые документы могут иметь произвольные названия. По умолчанию включен; если выключено,
попытка просмотреть такие файлы вызовет ошибку. Переключатель не влияет
печать: нераспознанные форматы не могут быть напечатаны.

Изменить зритель цвета используя либо триплеты RGB в формате #rrggbb, либо
стандартизированные имена.

DVI / PostScript / PDF / HTML / обычный текст
Для текстовых файлов текстдоктк предоставляет собственный просмотрщик. Если этот просмотрщик отключен, но нет
указан альтернативный просмотрщик, текстдоктк пытается прочитать содержание
переменная окружения $ PAGER.

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

dvi-> ps: dvips (входит в состав teTeX) (http://www.radicaleye.com/dvips.html)

pdf-> ps: pdf2ps (http://www.cs.wisc.edu/~ghost) или Acrobat Reader
(http://www.adobe.com)

html-> ps: html2ps (http://user.it.uu.se/~jan/html2ps.html)

простой текст-> ps: a2ps (http://www-inf.enst.fr/~demaille/a2ps/)

Меню конвертера html-> ps и text-> ps для включения / выключения перенаправления вывода.
Это связано с тем, что некоторые конвертеры не записывают свой вывод в файл.
но по умолчанию на стандартный вывод, поэтому требуется перенаправление, например а2пс мой файл.txt > myfile.ps

Общесистемный файл конфигурации ($ TEXMFMAIN) /texdoctk/texdocrc.defaults и должен
быть доступным для записи только администратору установки с помощью любого текстового редактора. В
необязательный файл конфигурации пользователя ~ / .texdocrc и может переопределить все, кроме этих систем
настройки, влияющие на установку в целом. Предпочтительный способ его изменения -
через меню настроек.

Команда базы данных
текстдоктк поставляется с файлом базы данных по умолчанию ($ TEXMFMAIN) /texdoctk/texdoctk.dat с
специальный формат. Он разделен на 17 разделов, соответствующих 17 кнопкам, которые
активен по умолчанию. Каждый раздел начинается строкой

@имя_раздела

в котором имя_раздела текст в том виде, в котором он отображается на кнопке. За этим заголовком следует
описательные записи для каждой документации, которые имеют следующий формат:

упаковка-этикетка; Краткое описание для списка (опц. имя пакета); путь в документе
каталог; необязательные ключевые слова

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

Администратор, вероятно, установит дополнительные пакеты в локальное дерево texmf. В
соответствующая документация может быть доступна через дополнительную базу данных
$ TEXMFLOCAL / texdoctk / texdoctk-local.dat. Кроме того, отдельные пользователи могут установить
дополнительные пакеты в подкаталоге texmf их $ HOME, для которых они могут создать
отдельные базы данных как $ TEXMFHOME / texdoctk / texdoctk-pers.dat. После создания
в таких файлах должен выполняться texhash.

Оба типа баз данных должны иметь ту же структуру, что и системная база данных, хотя они
нужно (и нужно) не включать все его разделы, если нет дополнительных записей. Для
Например, если пакет Foo добавляется в локальное дерево таким образом, что его документация
файл ($ TEXMFLOCAL) /doc/latex/foo/foo.dvi, и было решено, что он лучше всего подходит для
существующая категория Графика, texdoctk-local.dat будет выглядеть так:

@Графика
foo; Создание наворотов (foo); latex / foo / foo.dvi; украшение

Запись для Foo будет добавлен к списку записей в категории Графика.
18-ю кнопку можно активировать таким же образом, но с новым названием категории; возможный
записи в начале базы данных, которые не были присвоены категории, будут
быть назначенным по умолчанию для Разного, делая активным 18-ю кнопку с этим ярлыком.
Учтите, что у вас не может быть более 18 категорий; если их больше, только определенное
последний появится и будет использоваться.

Если документация включена в файл .sty вместо надлежащего файла документации,
необязательные ключевые слова должны начинаться с -? - сразу после точки с запятой, где? равно 0, 1,
2 или 3; это флаги, которые указывают, в какой части .sty находятся инструкции.
размещен и должен помочь текстдоктк извлечь документацию из стиля и представить ее
без кода, который обычно бесполезен.

0 нет определенного места, разбросаны между кодами

1 в конце, за \ endinput; за некоторыми файлами .sty стоит хорошо организованная документация.
конец фактического кода, где TeX не видит его при компиляции

2 в начале, завершается %%%%%%; в некоторых других случаях некоторая информация об использовании
в начале .sty как комментарий, заканчивающийся строкой, заполненной%

3 как 2, но с пустой строкой в ​​качестве завершения

См. Системную базу данных для множества примеров.

Используйте texdoctk онлайн с помощью сервисов onworks.net