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

Table of Contents
6.1 Основното ниво, doc/
6.2 Директориите език.кодиране/
6.3 Информация за специфични документи

Дървото doc/ е организирано по определен начин, документите, които са част от FDP също имат определена подредба. Целта е да се улесни добавянето на нова документация в дървото и:

  1. лесно автоматично конвертиране на документа към други формати

  2. въвеждане на съгласуваност между различните документации, по-лесно преминаване към работа над друг документ

  3. отговор на въпроса къде в дървото трябва да бъдат поставени новите документи

В допълнение, дървото с документи трябва да подслонява документация написана на различни езици и в различни кодирания. Важно е структурата на документацията да не налага определени културни предпочитания.

6.1 Основното ниво, doc/

Има два типа поддиректории на doc/, всяка със специфично име и значение.

Директория: share/

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

Директория: език.кодиране/

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

Този и други документи можете да намерите в ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/.

За въпроси отностно FreeBSD, прочетете документацията преди да попитате в <questions@FreeBSD.org>.
За въпроси отностно този документ, e-mail <doc@FreeBSD.org>.