6. fejezet - A dokumentumok szervezése a doc/ könyvtáron belül

Tartalom
6.1. A legfelső szint: a doc/ könyvtár
6.2. A nyelv.kódolás/ könyvtárak
6.3. Az egyes dokumentumokkal kapcsolatos tudnivalók

A doc/ könyvtár tartalma egy adott módon szerveződik, és ennek megfelelően a FreeBSD Dokumentációs Projektben készített dokumentumok is adott módon kerülnek elrendezésre. Célunk ezzel megkönnyíteni az újabb dokumentációk felvételét, illetve:

  1. leegyszerűsíteni az új dokumentum automatikus átalakítását különböző formátumokba;

  2. megteremteni a különböző dokumentumok közti következetes elrendezést, így könnyebben lehet köztük váltani munka közben;

  3. segíteni az új dokumentumok helyének egyszerű eldöntésében.

Mindezek mellett a dokumentációt tároló könyvtárnak olyan felépítésűnek kell lennie, amely lehetővé teszi több különböző nyelven és több különböző kódolásban írt dokumentumok kényelmes elhelyezését. Fontos hozzátennünk, hogy a könyvtár szerkezete nem követel meg semmilyen különleges előfeltételezést vagy kulturális berendezkedést.

6.1. A legfelső szint: a doc/ könyvtár

A doc/ további két, különleges névvel és jelentéssel rendelkező könyvtárat rejt.

Könyvtár: share/
Leírás: Ebben a könyvtárban találjuk azokat az állományokat, amelyek függetlenek az egyes fordításoktól és kódolásoktól. A benne található alkönyvtárakon keresztül tovább csoportosítódik a tartalmuk. Például a dokumentáció előállításához kapcsolódó make(1) infrastruktúra állományai a share/mk, miközben a SGML használatához szükséges további állományok (mint például a FreeBSD kiterjesztéseit tartalmazó DocBook DTD) a share/xml alkönyvtárban helyezkednek el.
Könyvtár: nyelv.kódolás/
Leírás: Minden fordításhoz és annak kódolásához tartozik egy könyvtár, például en_US.ISO8859-1 vagy hu_HU.ISO8859-2. A nevek alapvetően hosszúak, de pontosan meghatározzák az adott nyelvet és a dokumentáció írásához alkalmazott kódolást. Ezzel igyekszük felkészülni olyan esetekre, amikor a fordítócsapatok egy nyelven többféle kódolás szerint is szeretnének dokumentációt készíteni. Ez a megoldás egyben kiutat szolgáltat egy esetleges későbbi, Unicode kódolásra váltás során felmerülő problémák elől.

Ha kérdése van a FreeBSD-vel kapcsolatban, a következő címre írhat (angolul): <questions@FreeBSD.org>.

Ha ezzel a dokumentummal kapcsolatban van kérdése, kérjük erre a címre írjon: <gabor@FreeBSD.org>.