Глава 6. Структурирование документов в doc/

Содержание
6.1. Самый верхний уровень, doc/
6.2. Каталоги lang.encoding/
6.3. Информация, специфичная для конкретных документов

Дерево doc/ организовано определенным образом, и документы, являющиеся частью FDP, в свою очередь, организованы определенным образом. При этом преследуется цель упрощения добавления новой документации в дерево, а также:

  1. облегчение автоматизации преобразования документов в другие форматы

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

  3. облегчить решение того, куда поместить новую документацию

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

6.1. Самый верхний уровень, doc/

имеется два типа каталогов под doc/, каждый с очень специфичными именами каталогов и значениями.

Каталог: share/

Значение: Содержит файлы, которые не являются специфичными для различных переводов и кодировок документации. Содержит подкаталоги для дальнейшей категоризации информации. К примеру, файлы, которые составляют инфраструктуру make(1), располагаются в share/mk, когда как дополнительные файлы поддержки SGML (например, расширенный DocBook DTD для FreeBSD), находятся в share/sgml.

Каталог: lang.encoding/

Значение: Для каждого имеющегося перевода и кодировки документации имеется каталог, например, en_US.ISO8859-1/ и zh_TW.Big5/. Имена длинные, но полным заданием языка и кодировки мы избавляемся от головной боли в будущем, если команда переводчиков задумает дать документацию на одном языке, но более чем в одной кодировке. Это также полностью изолирует нас от каких-либо проблем, могущим возникнуть при переходе на Unicode.

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

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