Глава 2. Инструменты

Содержание
2.1. Обязательные инструменты
2.2. Необязательные инструменты

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

Все эти инструменты доступны в виде Портов и Пакаджей FreeBSD, что очень сильно упрощает работу по их установке .

Перед тем, как вы сможете работать с какими-либо примерами из последующих глав, вам нужно установить эти программные средства. Реальное использование этих инструментов освещено в следующих главах.

По возможности используйте порт textproc/docproj: Вы можете сэкономить себе много времени, если установите порт textproc/docproj. Это мета-порт, который сам по себе не содержит программ. Однако он зависит от корректной установки различных других портов. При установке порта должны сгрузиться и установиться все нужные вам пакаджи, перечисленные в этой главе.

Один из пакаджей, который вам может потребоваться, является пакетом макросов JadeTeX. В свою очередь, этот пакет макросов требует наличия установленного TeX. TeX является большим пакетом, и он вам потребуется, если только вы будет генерировать вывод в форматах Postscript или PDF.

Для экономии собственного времени и дискового пространства вы должны указать, хотите ли вы устанавливать JadeTeX (а значит, и TeX) при установке этого порта. Выполните:

# make JADETEX=yes install

или

# make JADETEX=no install

при необходимости. Альтернативным способом является установка textproc/docproj-jadetex или textproc/docproj-nojadetex. Эти вторичные порты только определяют переменную JADETEX за вас, и таким образом они будут устанавливать на вашу машину один и тот же пакет приложений. Заметьте, что вы можете генерировать только текстовую выдачу в форматах HTML или ASCII, пока не установите JadeTeX. Для работы с PostScript или PDF требуется установка пакета TeX.

2.1. Обязательные инструменты

2.1.1. Программное обеспечение

Эти программы требуются перед тем, как вы сможете с пользой поработать с документацией FreeBSD, и они позволят вам преобразовать документацию в HTML, обычный текст и формат RTF. Все они включены в порт textproc/docproj.

SP (textproc/sp)

Набор приложений, включающий проверяющий анализатор SGML и нормализатор SGML.

Jade (textproc/jade)

Реализация DSSSL. Используется для преобразования размеченных документов в другие форматы, включая HTML и TeX.

Tidy (www/tidy)

''Красивая печать'' HTML, используемая для переформатирования некоторых из автоматически генерируемых файлов HTML для облегчения их чтения.

Links (www/links)

WWW-браузер, который может также преобразовывать файлы HTML в обычный текст.

peps (graphics/peps)

В часть документации включены графические изображения, некоторые из которых хранятся в виде файлов EPS. Они должны быть преобразованы в PNG для того, чтобы большинство веб-браузеров могли бы их выводить на экран.

2.1.2. DTD и сущности

В FDP используются наборы сущностей и разные DTD. Перед тем, как вы сможете работать с документацией, их нужно установить.

HTML DTD (textproc/html)

HTML представляет собой язык разметки, выбранный для World Wide Web и используемый для веб-сервера FreeBSD.

DocBook DTD (textproc/docbook)

DocBook разработан для разметки технической документации. Вся документация FreeBSD написана на DocBook.

Сущности ISO 8879 (textproc/iso8879)

19 из наборов символьных сущностей ISO 8879:1986 используются во многих DTD. Сюда включены именования математических символов, дополнительные символы в наборе символов ''Latin'' (акценты, диакритические символы, и так далее) и греческие символы.

2.1.3. Таблицы стилей

Таблицы стилей используются при преобразовании и форматировании документации для вывода на экран, печати и так далее.

Модульные таблицы стилей DocBook (textproc/dsssl-docbook-modular)

Модульные таблицы стилей DocBook используются при преобразовании документации, размеченной в DocBook, в другие форматы, такие, как HTML или RTF.

Этот, и другие документы, могут быть скачаны с ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/.

По вопросам, связанным с FreeBSD, прочитайте документацию прежде чем писать в <questions@FreeBSD.org>.
По вопросам, связанным с этой документацией, пишите <doc@FreeBSD.org>.
По вопросам, связанным с русским переводом документации, пишите в рассылку <frdp@FreeBSD.org.ua>.
Информация по подписке на эту рассылку находится на сайте проекта перевода.