Az FDP a FreeBSD dokumentációját többféle eszköz segítségével tartja karban, alakítja át különböző kimeneti formátumokra és így tovább. Ha tehát a FreeBSD dokumentációjával akarunk dolgozni, akkor mindezekre az eszközökre nekünk is szükségünk lesz.
Ezek az eszközök a FreeBSD csomag- és portgyűjteményében is megtalálhatóak, ami így nagyban megkönnyíti a telepítésüket.
Tehát érdemes elvégeznünk a telepítésüket mielőtt foglalkoznánk a későbbi fejezetekben található példákkal. Az egyes programok konkrét használatával is majd ezekben a fejezetekben fogunk részletesebben foglalkozni.
textproc/docproj
portot
használjuk: A textproc/docproj
port
telepítésével rengeteg időt és
fáradalmat megtakaríthatunk magunknak. Ez egy
ún. metaport, amely önmaga nem
tartalmaz semmilyen szoftvert, helyette azonban függ az
egyébként telepítendő portoktól.
Így tehát csupán ezen port
telepítésével automatikusan le
kellene töltődnie és
települnie kellene a fejezetben
ismertetett összes csomagnak.
Az egyik telepítésre javasolt csomag a JadeTeX elnevezésű makrókészlet, amelynek viszont szüksége van a TeX csomagra. A TeX egy viszonylag nagy méretű csomag, ennek a tényleges telepítését csak abban az esetben javasoljuk, ha a dokumentációból Postscript vagy PDF változatot akarunk készíteni.
Telepítési idő és tárterület szempontjából nyilatkoznunk kell róla, hogy a port részeként a JadeTeX (és így a TeX) felkerüljön vagy sem. Ennek megfelelően választhatunk:
#
make JADETEX=yes install
vagy
#
make JADETEX=no install
Ugyanezt a választást a textproc/docproj-jadetex
vagy a
textproc/docproj-nojadetex
portok valamelyikének telepítésével is
megtehetjük. Ezek a segédportok helyettünk
már definiálják a JADETEX
változó értékét, és
ennek megfelelően telepítik gépünkre az
alkalmazásokat. Ne felejtsük el, hogy ha nem
tesszük fel a JadeTeX csomagot,
akkor csak HTML és ASCII formátumú
dokumentációt leszünk képesek
előállítani. Postscript vagy PDF
készítéséhez mindenképpen
szükséges a TeX.
A FreeBSD dokumentációjával csak az ebben
a szakaszban ismertetett programok
segítségével tudunk érdemben
dolgozni. Ezekkel a programokkal tudjuk
lényegében átalakítani a
dokumentációt többek közt egyszerű
ASCII szöveggé, HTML oldalakká vagy RTF
dokumentumokká. Mindegyikük része a
textproc/docproj
csomagnak.
textproc/jade
)Egy DSSSL implementáció, ezen keresztül alakíthatóak át a dokumentumok jelölőkkel ellátott forrásai más, például HTML vagy TeX formátumokba.
www/tidy
)Egy HTML forrásokra alkalmazható „formázó”, amellyel a többi program által automatikusan létrehozott egyes HTML állományokat lehet emberek számára könnyebben érthető alakra hozni.
www/links
)Egy szöveges módban működő webböngésző, amely remekül használható HTML oldalak egyszerű szöveges változatainak létrehozására.
graphics/peps
)A dokumentációban néhol találhatóak ábrák, amelyek némelyike EPS állományokban tárolódik. A webböngészők azonban csak akkor fogják tudni ezeket megjeleníteni, ha előtte átalakítjuk PNG állományokká.
Az FDP az itt felsorolt dokumentumtípus-definíciókat (DTD-ket) használja. A dokumentációval csak ezek telepítése után tudunk dolgozni.
textproc/html
)A HTML a World Wide Web nyelveként egységesen elfogadott jelölőnyelv, amely ezáltal a FreeBSD honlapjának is alapja.
textproc/docbook
)A DocBook a különféle szakmai jellegű dokumentációk készítéséhez kialakított jelölőnyelv. A FreeBSD teljes dokumentációja DocBook formátumban készül.
textproc/iso8879
)Az ISO 8879:1986 szabványban meghatározott karakteregyed-készletek közül 19 előfordul számos DTD részeként. Ezekben szerepelnek matematikai szimbólumok, a Latin karakterkészletekben megjelenő további (ékezetes, mellékjeles stb.) karakterek és görög szimbólumok.
A stíluslapok felhasználásával tudjuk a képernyő, a nyomtatás stb. számára alkalmassá tenni a dokumentációkat az átalakítás vagy a formázás során.
textproc/dsssl-docbook-modular
)A moduláris DocBook stíluslapok alkalmazásával alakítjuk át a DocBook formában előkészített dokumentációt más, például HTML vagy RTF változatúra.
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>.