diff --git a/hu_HU.ISO8859-2/books/Makefile b/hu_HU.ISO8859-2/books/Makefile index 2bf1c5f2d9..136238534b 100644 --- a/hu_HU.ISO8859-2/books/Makefile +++ b/hu_HU.ISO8859-2/books/Makefile @@ -1,17 +1,18 @@ # # The FreeBSD Documentation Project # The FreeBSD Hungarian Documentation Project # # $FreeBSD$ # %SOURCE% en_US.ISO8859-1/books/Makefile # %SRCID% 1.14 # SUBDIR = faq +SUBDIR+= fdp-primer SUBDIR+= handbook ROOT_SYMLINKS= faq handbook DOC_PREFIX?= ${.CURDIR}/../.. .include "${DOC_PREFIX}/share/mk/doc.project.mk" diff --git a/hu_HU.ISO8859-2/books/fdp-primer/Makefile b/hu_HU.ISO8859-2/books/fdp-primer/Makefile new file mode 100644 index 0000000000..6239e2b129 --- /dev/null +++ b/hu_HU.ISO8859-2/books/fdp-primer/Makefile @@ -0,0 +1,56 @@ +# +# $FreeBSD$ +# +# %SOURCE% en_US.ISO8859-1/books/fdp-primer/Makefile +# %SRCID% 1.14 +# +# Build the FreeBSD Documentation Project Primer. +# + +NO_TIDY=yes + +MAINTAINER=pgj@FreeBSD.org + +DOC?= book + +FORMATS?= html-split html + +INSTALL_COMPRESSED?= gz +INSTALL_ONLY_COMPRESSED?= + +# +# SRCS lists the individual SGML files that make up the document. Changes +# to any of these files will force a rebuild +# + +# SGML content +SRCS= book.sgml +SRCS+= overview/chapter.sgml +SRCS+= psgml-mode/chapter.sgml +SRCS+= see-also/chapter.sgml +SRCS+= sgml-markup/chapter.sgml +SRCS+= sgml-primer/chapter.sgml +SRCS+= stylesheets/chapter.sgml +SRCS+= structure/chapter.sgml +SRCS+= doc-build/chapter.sgml +SRCS+= the-website/chapter.sgml +SRCS+= tools/chapter.sgml +SRCS+= translations/chapter.sgml +SRCS+= writing-style/chapter.sgml + +SRCS+= examples/appendix.sgml + +# Images from the cross-document image library +IMAGES_LIB= callouts/1.png +IMAGES_LIB+= callouts/2.png +IMAGES_LIB+= callouts/3.png +IMAGES_LIB+= callouts/4.png +IMAGES_LIB+= callouts/5.png + +# Entities +SRCS+= chapters.ent + +URL_RELPREFIX?= ../../../.. +DOC_PREFIX?= ${.CURDIR}/../../.. + +.include "${DOC_PREFIX}/share/mk/doc.project.mk" diff --git a/hu_HU.ISO8859-2/books/fdp-primer/book.sgml b/hu_HU.ISO8859-2/books/fdp-primer/book.sgml new file mode 100644 index 0000000000..f45a6a5e3d --- /dev/null +++ b/hu_HU.ISO8859-2/books/fdp-primer/book.sgml @@ -0,0 +1,318 @@ + + + + + +%books.ent; + %chapters; + + +]> + + + + A &os; Dokumentációs Projekt irányelvei + kezdõknek + + A &os; Dokumentációs Projekt + + + 1998 + 1999 + 2000 + 2001 + 2002 + 2003 + 2004 + 2005 + 2006 + 2007 + 2008 + DocEng + + + $FreeBSD$ + + $FreeBSD$ + + &bookinfo.legalnotice; + + + Köszönjük a részvételt a &os; + Dokumentációs Projektben! Minden + segítség nagyon fontos számunkra. + + Ebben az ismertetõben megtalálható a &os; + Dokumentációs Projekt munkáját + segítõ (kötelezõ és + ajánlott) szoftverek és + segédeszközök + leírásától kezdõdõen a + Dokumentációs Projekt mögött + álló elképzelések + bemutatásáig minden olyan hasznos + információ, amelyre szükségünk + lehet a munkánk megkezdéséhez. + + A leíráson folyamatosan dolgozunk, nem + tekinthetõ még véglegesnek. A befejezetlen + szakaszokat a címükben csillaggal jelöltük + meg. + + Fordította: &a.hu.pgj; + + + + + Bevezetés + + + Parancssori promptok + + A következõ táblázatban + láthatjuk a rendszer alapértelmezett + promptját és a rendszeradminisztrátor + promptját. A példákban ilyen elemek + segítségével fogjuk jelezni, hogy milyen + felhasználóként kell azokat + lefuttatni. + + + + + + Felhasználó + Prompt + + + + + + Egyszerû felhasználó + &prompt.user; + + + + Rendszeradminisztrátor + &prompt.root; + + + + + + + + Szedési szabályok + + Az alábbi táblázatban röviden + összefoglaljuk a könyvben alkalmazott szedési + irányelveket. + + + + + + Leírás + Példa + + + + + + Parancsok + A ls -l + használatával listázzuk ki az + összes állományt. + + + + Állománynevek + Nyissuk meg a .login + állományt. + + + + Képernyõn megjelenõ + üzenetek + You have mail. + + + + Felhasználói parancsok + + &prompt.user; su +Password: + + + + Hivatkozások man oldalakra + + A &man.su.1; használatával + váltsunk felhasználót. + + + + Felhasználói- és + csoportnevek + + Ezt kizárólag csak a + root felhasználó + végezheti el. + + + + Kiemelések + + Ezt meg kell + csinálni. + + + + Parancssori változók: + helyettesítsük egy valódi névvel + vagy változóval + + Az állomány + törléséhez adjuk ki az rm + állománynév + parancsot. + + + + Környezeti változók + + A $HOME a saját + felhasználói könyvtárunkat + tartalmazza. + + + + + + + + Megjegyzések, tanácsok, fontosabb + információk, figyelmeztetések és + példák + + A szövegben elõfordulhatnak megjegyzések, + figyelmeztetések és példák. + + + Így jelennek meg a megjegyzések és + általában ránk hatással levõ + információkat tartalmaznak, amelyeket + érdemes figyelembe vennünk. + + + + Így jelennek meg a gyakorta hasznos + tanácsok, amelyek esetenként egy másik, + gyakran egyszerûbb megoldást mutatnak be. + + + + Így jelennek meg a fontosabb + információk. Általában még + további elvégzendõ lépéseket + adnak meg. + + + + Így jelennek meg a figyelmeztetések. + Határozottan érdemes rájuk figyelni, mert + ha nem követjük pontosan a bennük megadott + utasításokat, akkor azzal kárt okozhatunk + a rendszerünkben. Ez lehet fizikai, tehát a + hardvereszközeink sérülését + okozó probléma, vagy nem fizikai, tehát + például egy fontos állomány + akartlan törlése. + + + + Mintapélda + + Így jelennek meg a példák, amelyek + jellemzõen valaminek a részletes + bemutatását vagy egy konkrét mûvelet + eredményét tartalmazzák. + + + + + Köszönetnyilvánítás + + Szeretnénk megköszönni Sue Blake, Patrick + Durusau, Jon Hamilton, Peter Flynn és Christopher Maden + munkáját, akik kellõ fordítottak + idõt arra, hogy átolvassák a könyv + kezdeti változatait, majd azt számos + értékes megjegyzéssel és javaslattal + gazdagítsák. + + + + &chap.overview; + &chap.tools; + &chap.sgml-primer; + &chap.sgml-markup; + &chap.stylesheets; + &chap.structure; + &chap.doc-build; + &chap.the-website; + &chap.translations; + &chap.writing-style; + &chap.psgml-mode; + &chap.see-also; + + &app.examples; + + + + + diff --git a/hu_HU.ISO8859-2/books/fdp-primer/chapter.decl b/hu_HU.ISO8859-2/books/fdp-primer/chapter.decl new file mode 100644 index 0000000000..95f1304b1e --- /dev/null +++ b/hu_HU.ISO8859-2/books/fdp-primer/chapter.decl @@ -0,0 +1,7 @@ + + diff --git a/hu_HU.ISO8859-2/books/fdp-primer/chapters.ent b/hu_HU.ISO8859-2/books/fdp-primer/chapters.ent new file mode 100644 index 0000000000..e30e16263d --- /dev/null +++ b/hu_HU.ISO8859-2/books/fdp-primer/chapters.ent @@ -0,0 +1,30 @@ + + + + + + + + + + + + + + + + + + diff --git a/hu_HU.ISO8859-2/books/fdp-primer/doc-build/chapter.sgml b/hu_HU.ISO8859-2/books/fdp-primer/doc-build/chapter.sgml new file mode 100644 index 0000000000..70b08ccdf8 --- /dev/null +++ b/hu_HU.ISO8859-2/books/fdp-primer/doc-build/chapter.sgml @@ -0,0 +1,684 @@ + + + + + + A dokumentáció + elõállításának folyamata + + Ebben a fejezetben szeretnénk pontosan tisztázni + hogyan szervezõdik a dokumentáció + elõállításának folyamata + és hogyan tudunk ebbe + beavatkozni. + + A fejezet elolvasása során + megismerjük: + + + + az SGML eszközeirõl + szóló fejezetben említetteken + túl a &os; Dokumentációs Projekt keretein + belül készített dokumentáció + különbözõ változatainak + elõállításához mire van + még szükségünk; + + + + a dokumentumokhoz tartozó + Makefile állományokban + szereplõ make + utasításokat, valamint a hivatkozott + doc.project.mk vázlatos + felépítését; + + + + további make + változókon és célokon keresztül + miként tudjuk testreszabni a dokumentáció + különbözõ változatainak + elõállítási folyamatát. + + + + + A &os; dokumentáció + elõállításának + eszközei + + Munkánk folyamán az itt felsorolt + eszközök állnak rendelkezésünkre. + Használjuk ki az általuk nyújtott + lehetõségeket, amennyire csak tudjuk. + + + + Az elsõdleges eszköz maga a + make parancs, pontosabban a + Berkeley Make. + + + + Csomagokat a &os; alaprendszerében + megtalálható pkg_create + programmal tudunk készíteni. Ha nem &os; alatt + dolgozunk, akkor vagy csomagok nélkül kell + dolgoznunk, vagy magunknak kell ezeket + elkészítenünk. + + + + A gzip + segítségével lehet az + elõállított dokumentumok + tömörített változatát + elkészíteni. Emellett még a + bzip2 és zip + típusú tömörítés is + támogatott. A tar programot is + támogatjuk, a csomagok + készítéséhez kell. + + + + A dokumentáció + telepítésének elfogadott eszköze az + install program. Természetesen + léteznek egyéb megoldások is. + + + + + Nem valószínû, hogy ez az utolsó + két eszközt ne lenne elérhetõ a + rendszerünkön, csupán a teljesség + kedvéért említettük meg ezeket. + + + + + A dokumentációt tároló + könyvtárban található + <filename>Makefile</filename> állományok + + A &os; Dokumentációs Projekt által + használt könyvtárakban megtalálható + Makefile állományoknak + három típusa létezik: + + + + Az alkönyvtári + Makefile állományok + egyszerûen csak továbbadják a parancsokat + az alkönyvtáraiknak. + + + + A dokumentumokra vonatkozó + Makefile állományok + írják le, hogy milyen dokumentumokat kellene az + adott könyvtárban + elõállítani. + + + + Az .mk + állományok segítik valamilyen + formában a dokumentumok + elõállítását. Többnyire + doc.xxx.mk + névvel láthatóak. + + + + + Az alkönyvtári <filename>Makefile</filename> + állományok + + Ezek a típusú Makefile + állományok általában a + következõ alakúak: + + SUBDIR =articles +SUBDIR+=books + +COMPAT_SYMLINK = en + +DOC_PREFIX?= ${.CURDIR}/.. +.include "${DOC_PREFIX}/share/mk/doc.project.mk" + + Röviden összefoglalva: az elsõ négy + nem üres sorban ún. make + változókat definiálunk. Ezek rendre a + SUBDIR, COMPAT_SYMLINK + és DOC_PREFIX. + + Az elsõ SUBDIR sornál, + illetve a COMPAT_SYMLINK sorában + láthatjuk hogyan kell egy új értéket + beállítani egy ilyen + változónak. + + A második SUBDIR sorban azt + láthatjuk, hogyan tudunk a változó + aktuális értékéhez + továbbiakat hozzáfûzni. Ebben az esetben + tehát az utasítás + végrehajtása után a + SUBDIR értéke articles + books lesz. + + A DOC_PREFIX esetében pedig olyan + értékadást figyelhetünk meg, amelyik + csak akkor hajtódik végre ténylegesen, ha a + változónak addig még nem volt + értéke. Ez olyankor tud kapóra jönni, + amikor a DOC_PREFIX nem pontosan az, amire a + Makefile számít — a + felhasználó ekkor meg tudja adni a helyes + értéket. + + Ez így együttesen tehát mit is jelent? A + SUBDIR összefoglalja azokat a + könyvtárakat, amelyekben a dokumentumok + elõállításának + folyamatának folytatódnia kell majd. + + A COMPAT_SYMLINK a kompatibilitás + céljából létrehozott szimbolikus + linkekre vonatkozik, amelyek (valamilyen csoda folytán) + az adott nyelv hivatalos kódolására + mutatnak (tehát például a + doc/en a + en_US.ISO8859-1 + könyvtárra). + + A DOC_PREFIX a &os; + Dokumentációs Projekt + fõkönyvtárához vezetõ utat adja + meg. Ezt nem mindig egyszerû megtalálni, + ezért a rugalmasság kedvéért + könnyedén felül is definiálható. + A .CURDIR a make egyik + saját belsõ változója, amelyben az + aktuális könyvtár elérési + útját tárolja. + + Végül az utolsó sorban a &os; + Dokumentációs Projekt összes + Makefile állományára + vonatkozó, rendszerszintû + doc.project.mk állományra + hivatkozunk, amelyen keresztül az iménti + változókból épül fel a + dokumentumok elõállításának + pontos menete. + + + + A dokumentumokra vonatkozó + <filename>Makefile</filename> állományok + + Ezekben a Makefile + állományokban az adott könyvtárban + található dokumentumok + elõállítását + leíró különbözõ + make változók + szerepelnek. + + Lássunk erre egy példát: + + MAINTAINER=pgj@FreeBSD.org + +DOC?= book + +FORMATS?= html-split html + +INSTALL_COMPRESSED?= gz +INSTALL_ONLY_COMPRESSED?= + +# Az SGML forrás +SRCS= book.sgml + +DOC_PREFIX?= ${.CURDIR}/../../.. + +.include "$(DOC_PREFIX)/share/mk/docproj.docbook.mk" + + A MAINTAINER változó nagyon + fontos. A &os; Dokumentációs Projekten belül + ezen a változón keresztül jelezhetjük a + dokumentum birtoklását, vagyis + karbantartási kötelezettségünket. + + A DOC hivatkozik (az + .sgml kiterjesztés + nélkül) az adott könyvtárban + található dokumentum fõ + forrására. Emellett az SRCS + változóban kell összefoglalnunk a + dokumentumot alkotó források neveit. Ebben + érdemes megadni minden olyan állományt, + amelynek megváltozása esetén újra + elõ kell állítani az érintett + dokumentumot. + + A FORMATS + segítségével definiáljuk a dokumentum + alapértelmezetten elõállítandó + formátumait. A INSTALL_COMPRESSED + változóban a dokumentum + elkészítésekor felhasználandó + tömörítési formákat adhatjuk meg. + A INSTALL_ONLY_COMPRESSED + változó alapból üres, de ha adunk neki + valamilyen egyéb értéket, akkor a + dokumentumoknak csak a tömörített + változata fog elkészülni. + + + A változók feltételes + értékadásáról már + volt szó az elõzõ + szakaszban. + + + A DOC_PREFIX változó + és az .include utasítás a + korábbiak alapján már ismerõs + lehet. + + + + + A &os; Dokumentációs Projekt + <filename>.mk</filename> állományai + + Ezek az állományok legjobban talán + önmagukon keresztül mutathatóak be. A + következõ rendszerszintû .mk + állományokat használjuk a &os; + Dokumentációs Projektben: + + + + A doc.project.mk a központi + .mk állomány, amely + szükség szerint hivatkozik az összes + többi .mk + állományra. + + + + Az elõállítás és a + telepítés során a + doc.subdir.mk felelõs a dokumentumokat + tároló könyvtárak + bejárásért. + + + + A doc.install.mk tartalmazza a + karbantartóval és a telepítéssel + kapcsolatos változókat. + + + + A doc.docbook.mk + állomány csak akkor kerül + feldolgozásra, ha a DOCFORMAT + értéke docbook és a + DOC változónak van + értéke. + + + + + A <filename>doc.project.mk</filename> + állomány + + Nézzünk bele: + + DOCFORMAT?= docbook +MAINTAINER?= doc@FreeBSD.org + +PREFIX?= /usr/local +PRI_LANG?= en_US.ISO8859-1 + +.if defined(DOC) +.if ${DOCFORMAT} == "docbook" +.include "doc.docbook.mk" +.endif +.endif + +.include "doc.subdir.mk" +.include "doc.install.mk" + + + Változók + + Ha nem állítjuk be a dokumentum + Makefile + állományában, akkor a + DOCFORMAT és a + MAINTAINER változók ezen a + helyen kapnak értéket. + + A PREFIX adja azt a + könyvtárat, amelyen belül + elérhetõek a + dokumentáció + elõállításához + szükséges eszközök. + A csomagok és portok átlagos használata + esetén ez a /usr/local. + + A PRI_LANG adja meg azt a nyelvet + és kódolást, amely a + dokumentációt olvasó + felhasználó számára + elsõdlegesként leginkább elfogadott. + Alapértelmezés szerint ez az amerikai + angol. + + + A PRI_LANG változó + semmilyen hatással nincs a dokumentumok + elõállítására. + Egyedül a &os; dokumentáció + telepítésekor a leggyakrabban hivatkozott + dokumentumokhoz létrehozandó szimbolikus + linkek készítésénel van + szerepe. + + + + + Elágazások + + A .if defined(DOC) sorban a + Makefile állományokban + megadható elágazásokra láthatunk + példát. Hasonlóan más + programokhoz, a Makefile + mûködését tudjuk meghatározni + egy logikai kifejezés + igazságértéktõl függõen. + Ebben a kifejezésben a defined + függvény, amely megadja, hogy a + paramétereként megadott változó + definiált-e. + + A következõ elágazásban, vagyis az + .if ${DOCFORMAT} == "docbook" + utasításban azt vizsgáljuk meg, hogy a + DOCFORMAT változó + értéke "docbook" vagy sem. + Amennyiben a válasz erre igen (vagyis + igaz), beemeljük a + doc.docbook.mk tartalmát. + + Az elõbb említett két + elágazást rendre az .endif + kulcsszóval zárjuk le. + + + + + A <filename>doc.subdir.mk</filename> + állomány + + Ez az állomány már + túlságosan nagy ahhoz, hogy a fejezeten belül + könnyen ki lehessen elemezni. Ezért az + elõzõ szakaszok alapján a részleteket a + kedves Olvasóra bízzuk, ehhez adunk még itt + némi segítséget. + + + Változók + + + + A SUBDIR tartalmazza azokat az + alkönyvtárakat, amelyeket a feldolgozás + során be kell járnunk. + + + + A ROOT_SYMLINKS a + dokumentáció + fõkönyvtárából + szimbolikusan linkelendõ könyvtárak + neveit adja meg, amennyiben az adott nyelv (a + PRI_LANG változó szerint) + az elsõdleges. + + + + A COMPAT_SYMLINK + változót már korábban bemutattuk + az alkönyvtári + Makefile + állományok címû + szakaszban. + + + + + + Célok és makrók + + A függõségi viszonyokat + cél: + függõség1 + függõség2 ... + formában írjuk fel, ahol így megmondjuk, + hogy a cél + létrehozásához elõször milyen + elemeknek kell létezniük. Ezeket nevezzük + függõségeknek. + + A függõségi viszony megadása alatt + lehetõségünk van részletezni a + függõségekbõl a cél + elõállításához + szükséges utasításokat. Ezt akkor + kell megtenni, ha a cél és a + függõségek közti + átalakítást elõzõleg még + nem definiáltuk, vagy ha az adott esetben az + átalakítás eltér a + korábbiaktól. + + A .USE nevû speciális + függõség egy makróval + egyenértékû eszköz + használatára ad lehetõséget. + +_SUBDIRUSE: .USE +.for entry in ${SUBDIR} + @${ECHO} "===> ${DIRPRFX}${entry}" + @(cd ${.CURDIR}/${entry} && \ + ${MAKE} ${.TARGET:S/realpackage/package/:S/realinstall/install/} DIRPRFX=${DIRPRFX}${entry}/ ) +.endfor + + A fenti kódrészletben tehát a + _SUBDIRUSE most már egy + makró lesz, amely ha megjelenik a + függõségek között, akkor a + törzsében megadott parancsokat hajtja + végre. + + Mi különbözteti meg ezt a makrót a + többi céltól? Két lényeges + eltérés: elõször is, a benne megadott + utasítások a rá + függõségként hivatkozó + célhoz társított + átalakítást végzõ + utasítások után + fognak lefutni, másrészt nem befolyásolja + a jelenleg feldolgozás alatt álló + cél nevét tároló + .TARGET változó + értékét. + +clean: _SUBDIRUSE + rm -f ${CLEANFILES} + + Ebben a kódrészletben a tehát + clean esetében csak az + rm -r ${CLEANFILES} parancs lefutása + után fog végrehajtódni a + _SUBDIRUSE makró tartalma. + Ennek hatására a clean + megy egyre lentebb és lentebb a + könyvtárszerkezetben, + miközben törli a + elõzõleg elõállított + állományokat. + + + Definiált célok + + + + Az install és a + package célok + egyaránt folyamatosan haladnak lefelé a + könyvtárszerkezetben és az + alkönyvtárakban hívják + saját maguk tényleges + változatát (ezek a + realinstall és + realpackage). + + + + A clean + eltávolítja a folyamat során + keletkezett állományokat (és az + elõbbiekhez hasonlóan lefele halad a + könyvtárszerkezetben). A + cleandir ugyanezt + csinálja, de ha talál a + tárgykódokhoz tartozó + könyvtárat, akkor azt is törli. + + + + + + + Bõvebben a feltételes + kifejezésekrőlzekrõl + + + + Az exists egy másik logikai + függvény, amellyel lekérdezhetjük, + hogy a paramétereként megadott + állomány létezik-e. + + + + Az empty logikai + függvény igaz értékû, ha a + paramétereként megadott + változó értéke + üres. + + + + A target logikai + függvény igaz értékû, ha a + paraméterként megadott cél még + nem létezik. + + + + + + Ciklusszerverzési lehetõségek + (<literal>.for</literal>) + + A .for utasítás + segítségével adott + utasításokat tudunk elvégezni egy + változó tartalmaként megadott, + szóközökkel határolt elemekre. A + ciklus belsejében egy változóból + érhetjük el az aktuálisan feldolgozott + elemet. + +_SUBDIRUSE: .USE +.for entry in ${SUBDIR} + @${ECHO} "===> ${DIRPRFX}${entry}" + @(cd ${.CURDIR}/${entry} && \ + ${MAKE} ${.TARGET:S/realpackage/package/:S/realinstall/install/} DIRPRFX=${DIRPRFX}${entry}/ ) +.endfor + + A fenti kódrészletben ha a + SUBDIR üres, akkor nem + történik semmi. Ha viszont egy vagy több + elemet is tartalmaz, akkor a .for és + az .endfor között megadott + utasítások megismétlõdnek minden + egyes elem esetén. Ezek értékét a + ciklus belsejében rendre a entry + változóban veszi fel. + + + + + + + diff --git a/hu_HU.ISO8859-2/books/fdp-primer/examples/appendix.sgml b/hu_HU.ISO8859-2/books/fdp-primer/examples/appendix.sgml new file mode 100644 index 0000000000..42cdb579c5 --- /dev/null +++ b/hu_HU.ISO8859-2/books/fdp-primer/examples/appendix.sgml @@ -0,0 +1,452 @@ + + + + + + Példatár + + Ebben a függelékben bemutatunk néhány + minta SGML forrást, illetve azokat a parancsokat, amelyekkel + egyik formátumból a másikba lehet ezeket + alakítani. Amennyiben sikeresen telepítettük + rendszerünkre a Dokumentációs Projektben + használt segédprogramokat, akkor az itt megadott minta + forrásokat akár közvetlenül is fel tudjuk + használni. + + A mintáképp mellékelt források nem + fednek le mindent — nem tartalmazzák az összes + korábban ismertetett elemet, és + egyáltalán nem térnek ki a rövidebb + részek, például bevezetés, + elõszó, + köszönetnyilvánítás stb. + jelölésére. Ha konkrét + jelölési megoldásokra lenne + szükségünk, akkor kérjük le a + repositoryból a doc + CVSup gyûjteményt, és + nézzük át a benne szereplõ SGML + forrásokat, vagy böngésszük ezeket + közvetlenül a honlapon + keresztül. + + A félreértések elkerülése + végett ezek a példák a szabvány DocBook + 4.1 DTD szerint íródtak, mellõzik a &os; + kiterjesztéseit. Ugyanúgy nem + építkeznek a &os; Dokumentációs Projekt + által módosított stíluslapokra sem, + hanem a Norm Walsh eredetileg kiadott stíluslapjait + használják. Ennek köszönhetõen + általános DocBook mintáknak is + tekinthetõek. + + + DocBook könyv, a <sgmltag>book</sgmltag> elem + + + DocBook <sgmltag>book</sgmltag> + + + + + + ]]>Könyvminta<![ CDATA [ + + + ]]>Vezetéknév + ]]>Keresztnév + +
]]>ize@minta.hu
+
+
+ + + 2008 + ]]>A copyright szövege + + + + ]]>Ha tartozik a könyvhöz rövid tartalmi összefoglaló + (absztrakt), akkor azt ide írjuk. + +
+ + + ]]>Elõszó<![ CDATA [ + + ]]>A könyvhöz tartozhat elõszó is, amelyet itt kell + szerepeltetnünk. + + + + ]]>Elsõ fejezet<![ CDATA [ + + ]]>Ez a könyv elsõ fejezetének tartalma. + + + ]]>Az elsõ szakasz<![ CDATA [ + + ]]>Ez a könyv elsõ szakasza. + + +
]]>
+
+
+ + + DocBook cikk, az <sgmltag>article</sgmltag> elem + + + DocBook <sgmltag>article</sgmltag> + + + +
+ + ]]>Cikkminta<![ CDATA [ + + + ]]>Vezetéknév + ]]>Keresztnév + +
ize@minta.hu
+
+
+ + + 2008 + ]]>A copyright szövege + + + + ]]>Ha tartozik a cikkhez rövid tartalmi összefoglalás + (absztrakt), akkor annak ide kell kerülnie. + +
+ + + ]]>Elsõ szakasz<![ CDATA [ + + ]]>Ez a cikk elsõ szakasza. + + + ]]>Elsõ alszakasz<![ CDATA [ + + ]]>Ez a cikk elsõ alszakasza. + + +
]]>
+
+
+ + + A formázott kimenet + elõállítása + + Ebben a szakaszban feltételezzük, hogy már + vagy kézzel vagy pedig a hozzátartozó port + segítségével telepítettük a + textproc/docproj portban szereplõ + segédeszközöket. Emellett továbbá + még feltesszük, hogy az összes eszközt a + /usr/local + könyvtár alá telepítettük és + a binárisok elérési útvonala + része a PATH környezeti + változónak. Amennyiben ezektõl a + feltételezésektõl valamilyen módon + eltértünk, akkor a példákat + értelemszerûen a saját környezetünkre + alkalmazva kell végrehajtani. + + + A Jade használata + + + DocBook forrás átalakítása + HTML formátumúra (egyetlen nagy + állomány) + + &prompt.user; jade -V nochunks \ + -c /usr/local/share/sgml/docbook/dsssl/modular/catalog \ + -c /usr/local/share/sgml/docbook/catalog \ + -c /usr/local/share/sgml/jade/catalog \ + -d /usr/local/share/sgml/docbook/dsssl/modular/html/docbook.dsl \ + -t sgml állomány.sgml > állomány.html + + + + A nochunks paramétert adja + át a stíluslapoknak és az + eredményt a szabványos kimenetre + irányítattja át (Norm Walsh + stíluslapjait használjuk). + + + + Megadjuk a Jade + által feldolgozandó katalógusokat. Itt + három katalógust kell megadni. Az elsõ + katalógus a DSSSL stíluslapok, a + második a DocBook DTD és a harmadik a + Jade számára + tartalmaz információkat. + + + + A Jade a dokumentum + feldolgozásához az itt megadott DSSSL + stíluslapot fogja felhasználni. + + + + A Jade itt kap + utasítást arra, hogy az egyik DTD-ból a + másikba alakítsa + át a dokumentumot. Ebben a + példában most a DocBook DTD-ból + alakítunk át a HTML DTD-ba. + + + + Megadjuk a feldolgozandó + állományt a Jade + számára és + átirányítjuk a kimenetet egy + .html kiterjesztésû + állományba. + + + + + + DocBook forrás átalakítása + HTML formátumúra (több kisebb + állomány) + + &prompt.user; jade \ + -c /usr/local/share/sgml/docbook/dsssl/modular/catalog \ + -c /usr/local/share/sgml/docbook/catalog \ + -c /usr/local/share/sgml/jade/catalog \ + -d /usr/local/share/sgml/docbook/dsssl/modular/html/docbook.dsl \ + -t sgml állomány.sgml + + + + Megadjuk a Jade + által feldolgozandó katalógusokat. Itt + három katalógust kell megadni. Az elsõ + katalógus a DSSSL stíluslapok, a + második a DocBook DTD és a harmadik a + Jade számára + tartalmaz információkat. + + + + A Jade a dokumentum + feldolgozásához az itt megadott DSSSL + stíluslapot fogja felhasználni. + + + + A Jade itt kap + utasítást arra, hogy az egyik DTD-ból a + másikba alakítsa + át a dokumentumot. Ebben a + példában most a DocBook DTD-ból + alakítunk át a HTML DTD-ba. + + + + Megadjuk a feldolgozandó + állományt a Jade + számára. A stíluslap fogja majd + eldönteni, hogy mi legyen a neve a menet közben + keletkezõ egyes HTML állományoknak, + illetve a gyökérnek (ez az az + állomány, ahonnan a dokumentum + kezdõdik). + + + + Elõfordulhat, hogy ez a parancs szintén csak + egyetlen HTML állományt generál. Ez + függ a feldolgozandó dokumentum + szerkezetétõl és a stíluslap + feldarabolást vezérlõ + szabályaitól. + + + + DocBook forrás átalakítása + Postscript formátumúra + + Az SGML forrást &tex; + állománnyá akarjuk alakítani. + + &prompt.user; jade -V tex-backend \ + -c /usr/local/share/sgml/docbook/dsssl/modular/catalog \ + -c /usr/local/share/sgml/docbook/catalog \ + -c /usr/local/share/sgml/jade/catalog \ + -d /usr/local/share/sgml/docbook/dsssl/modular/print/docbook.dsl \ + -t tex állomány.sgml + + + + Felparaméterezzük a stíluslapot a + &tex; formátumú kimenet + elõállításához. + + + + Megadjuk a Jade + által feldolgozandó katalógusokat. Itt + három katalógust kell megadni. Az elsõ + katalógus a DSSSL stíluslapok, a + második a DocBook DTD és a harmadik a + Jade számára + tartalmaz információkat. + + + + A Jade a dokumentum + feldolgozásához az itt megadott DSSSL + stíluslapot fogja felhasználni. + + + + Megadjuk a Jade + számára, hogy &tex; formátumú + kimenetet készítsen. + + + + Az így keletkezõ .tex + kiterjesztésû állomány aztán a + &jadetex makrócsomaggal + együtt átadható bemenetként a + tex parancsnak. + + &prompt.user; tex "&jadetex" állomány.tex + + A tex parancsot + legalább háromszor le kell + futtatni. Elõször feldolgozza a dokumentumot, + és szétválogatja az egyes részeit, + hogy meg tudja állapítani részeit + hivatkoztuk valahonnan máshonnan, hogyan indexelje + stb. + + Ha ebben a fázbisban különbözõ + figyelmeztetéseket látunk, mint + például LaTeX Warning: Reference + `136' on page 5 undefined on input line 728., + akkor még ilyenkor ne foglalkozzunk + különösebben velük. + + A második futtatás során újra + feldolgozza a dokumentumot a korábbi + feldolgozásból származó bizonyos + elõismeretek (például a dokumentum + oldalszámának) alapján. Ekkor az indexek + és a kereszthivatkozások már gond + nélkül feloldhatóak. + + A harmadik menetben elvégzi az utolsó + simításokat, amennyiben szükség van + rájuk. + + Ebben a fázisban egy + állomány.dvi + alakú eredményt kapunk. + + Végezetül az imént kapott + .dvi állomány Postscript + formátumúra alakításához + futtassuk le a dvips parancsot: + + &prompt.user; dvips -o állomány.ps állomány.dvi + + + + DocBook forrás átalakítása + PDF formátumúra + + A feldolgozási folyamat elsõ része + hasonló ahhoz, amikor DocBook forrásból + akarunk Postscript formátumú + állományt készíteni, tehát + elegendõ a jade parancsot az + elõbb megadott paraméterekkel meghívni + (lásd ). + + Amikor viszont megkaptuk a .tex + állományt, akkor a + pdfTeX programot futtassuk le + rá. Ügyeljünk arra, hogy ekkor már a + &pdfjadetex makrócsomagot kell + használnunk: + + &prompt.user; pdftex "&pdfjadetex" állomány.tex + + Ebben az esetben is háromszor kell lefuttatnunk a + parancsot. + + Ennek eredményeképpen aztán + végül elõáll egy további + feldolgozást már nem igénylõ + állomány.pdf + állomány. + + + +
+ + diff --git a/hu_HU.ISO8859-2/books/fdp-primer/overview/chapter.sgml b/hu_HU.ISO8859-2/books/fdp-primer/overview/chapter.sgml new file mode 100644 index 0000000000..95a0a69749 --- /dev/null +++ b/hu_HU.ISO8859-2/books/fdp-primer/overview/chapter.sgml @@ -0,0 +1,378 @@ + + + + + + Áttekintés + + Üdvözöljük a &os; + Dokumentációs Projektben! A &os; + sikerességéhez elegendhetetlenül fontos a + jó minõségû dokumentáció, + amelynek jelentõs részét a &os; + Dokumentációs Projekt (röviden FDP) + állítja elõ. Ez a projekt rendkívül + értékesnek tart bármilyen fajta + támogatást. + + Ennek a dokumentumnak fõ célja, hogy bemutassa + az FDP szervezõdését, + hogyan készítsünk és + küldjünk az FDP részére + dokumentációt, és hogyan + használjuk hatékonyan a dokumentációk + írásához készített + eszközöket. + + tagság + + Az FDP bárkit szívesen fogad. A tagságnak + nincs semmiféle elõfeltétele, a tagoknak nem + kötelezõ havonta adott mennyiségû + dokumentációk írniuk. A + belépésnek mindössze annyit kell tennünk, + hogy feliratkozunk a &a.doc; tagjai közé. + + A könyv elolvasása során + megismerjük: + + + + milyen dokumentációkat tart karban az FDP; + + + + az FDP által karbantartott + dokumentációk megírásához + használt SGML nyelvet; + + + + hogyan készítsünk + módosításokat a + dokumentációhoz; + + + + hogyan küldjük be és nézessük + át a módosításainkat, ezek + miként kerülhetnek be a &os; hivatalos + dokumentációjába. + + + + + A &os; dokumentációja + + Az FDP a &os;-hez mellékelt dokumentációk + négy fajtájáért felelõs: + + + + Man oldalak + + + Az angol nyelvû man oldalakat nem az FDP tagjai + készítik, azok az alaprendszer részei. + Az FDP viszont az olvashatóság vagy az + esetleges pontatlanságok javítása + érdekében át tudja fogalmazni + ezeket. + + Továbbá a különbözõ + fordítói csoportok felelõsek a rendszerhez + tartozó egyes man oldalak + fordításaiért, amelyek szintén + az FDP keretein belül készülnek. + + + + + GYIK + + + A GYIK célja a &os;-vel foglalkozó + különbözõ levelezõ listákon + és hírcsoportokon felbukkanó gyakran + ismételt kérdések (rövid, + lényegretörõ) megválaszolása. + Ez a formátum nem teszi lehetõvé hosszabb + és minden részletre kiterjedõ + válaszok megfogalmazását. + + + + + Kézikönyv + + + A kézikönyv a &os; + felhasználók számára + összeállított átfogó, + intereten keresztül is olvasható + referencia. + + + + + Honlap + + + A http://www.FreeBSD.org/ + címen, illetve annak különbözõ + tükrözésein keresztül + elérhetõ honlapok képviselik a &os; + elsõdleges megjelenési formáját a + világhálón. Legtöbben ezen az + oldalon találkoznak a &os;-vel + elõször. + + + + + Az imént felsorolt kategóriák mindegyike + megtalálható a &os; repositoryjában, + ezért a velük kapcsolatos + változtatásokhoz tartozó + naplóbejegyzések mindenki számára + láthatóak, illetve a + CVSup vagy + CTM alkalmazások + használatával a + dokumentációkból létre tudunk hozni + egy helyi másolatot. + + Mindezek mellett sokan készítettek + további oktatóanyagokat és &os;-hez + kapcsolódó honlapokat. Ezek némelyike (a + szerzõ elõzetes engedélyével) a + repositoryban is megtalálható. A többi esetben + a szerzõk úgy döntöttek, hogy a &os; + forrásaitól független helyen szeretnék + tárolni a leírásaikat. Ilyenkor pedig az FDP + törekszik belinkelni ezeket. + + + + Mielõtt belekezdenénk + + Az alábbi ismereteket feltételezzük az + olvasó részérõl: + + + + Képesek vagyunk lekérni és + folyamatosan frissíteni a &os; repository egy helyi + számítógépen tárolt + változatát (például a + CVS, + CVSup vagy + CTM alkalmazások + valamelyikének használatával), vagy + egyszerûen csak letölteni belõle a + CVSup + segítségével egy elõre + kikért példányt. + + + + Tudunk szoftvereket telepíteni a &os; + Portgyûjteményébõl vagy a + &man.pkg.add.1; használatával. + + + + + + A legfontosabb tudnivalók + + Ha most csak a legalapvetõbb ismeretekre van + szükségünk, és a részletekkel + csupán késõbb akarunk majd foglalkozni, akkor + az alábbi utasítások alapján javasolt + elindulni: + + + + Telepítsük a textproc/docproj metaportot: + + &prompt.root; cd /usr/ports/textproc/docproj +&prompt.root; make JADETEX=no install + + + + Készítsünk egy helyi másolatot a + &os; forrásának doc + könyvtáráról. Erre megfelel a + CVSup checkout + módja vagy a repository teljes tartalmának + letöltése. + + Egy használható helyi másolathoz + legalább a doc/share és + doc/en_US.ISO8859-1/share + könyvtárakat kell kikérnünk: + + &prompt.user; cvs checkout doc/share +&prompt.user; cvs checkout doc/en_US.ISO8859-1/share + + Ha viszont sok tárhellyel rendelkezük, akkor + akár mindent kikérhetünk: + + &prompt.user; cvs checkout doc + + + + Amikor egy korábban felrakott könyvhöz + vagy cikkhez készítünk + módosításokat, elõtte + kérjük ki a repositoryból. Ha egy + új könyvet vagy cikket szeretnék + beküldeni, akkor építkezzünk a + meglevõekbõl. + + Tegyük fel például, hogy írtunk + egy cikket a &os; és &windows; 2000 rendszerek közti + VPN-hálózatok + létrehozásáról: + + + + Kérjük ki az articles + könyvtár tartalmát. + + &prompt.user; cvs checkout doc/en_US.ISO8859-1/articles + + + + Másoljunk le valamelyik cikket és + használjuk fel sablonként. Most úgy + döntöttük, hogy az új cikket a + vpn-w2k könyvtárba + helyezzük el: + + &prompt.user; cd doc/en_US.ISO8859-1/articles +&prompt.user; cp -R committers-guide vpn-w2k + + + + Ha viszont egy már létezõ dokumentumot + akarunk szerkeszteni, például a GYIK-ot, akkor + kérjük ki azt a könyvtárat, amelyikben + található. Ez ebben az esetben a + doc/en_US.ISO8859-1/books/faq: + + &prompt.user; cvs checkout doc/en_US.ISO8859-1/books/faq + + + + A könyvtárban található + .sgml állományokat + írjuk át a kedvenc + szövegszerkesztõnkkel. + + + + A forrásban használt jelölõket a + lint cél + segítségével ellenõrizhetjük. + Ilyenkor anélkül tudjuk megtalálni a + dokumentum forrásában rejtõzõ + hibákat, hogy ténylegesen el kellene + végeznünk azok idõigényes + átalakítását: + + &prompt.user; make lint + + Amikor viszont valóban le akarjuk + generáltatni a dokumentumot, a FORMATS + változóban tudjuk felsorolt a kért + formátumokat. Itt jelen pillanatban a + html, html-split, + txt, ps, + pdf és rtf + értékeket szerepeltethetjük. A + támogatott formátumok legfrissebb + listáját mellesleg a + doc/share/doc.docbook.mk + állományban találhatjuk meg. Ha + egyszerre több formátumot kértünk, + akkor ne felejtsük el idézõjelek + közé tenni a felsorolást. + + Például így lehet egy dokumentumot + csak html formátumra + alakítani: + + &prompt.user; make FORMATS=html + + Ha viszont egyszerre szeretnénk a + dokumentumból html és + txt formátumot létrehozatni, + akkor megtehetjük azt két külön + &man.make.1; paranccsal: + + &prompt.user; make FORMATS=html +&prompt.user; make FORMATS=txt + + Vagy egyetlen paranccsal: + + &prompt.user; make FORMATS="html txt" + + + + Küldjük be a + módosításainkat a &man.send-pr.1; + használatával. + + + + + + + diff --git a/hu_HU.ISO8859-2/books/fdp-primer/psgml-mode/chapter.sgml b/hu_HU.ISO8859-2/books/fdp-primer/psgml-mode/chapter.sgml new file mode 100644 index 0000000000..18a197292c --- /dev/null +++ b/hu_HU.ISO8859-2/books/fdp-primer/psgml-mode/chapter.sgml @@ -0,0 +1,242 @@ + + + + + + Az <literal>sgml-mode</literal> használata az + <application>Emacs</application> + szövegszerkesztõben + + Az Emacs és + XEmacs újabb változataihoz + tartozik egy psgml nevû, nagyon hasznos + csomag (a Portgyûjteménybõl a editors/psgml portból + telepíthetjük fel). Ez a + kiegészítés vagy az .sgml + állományok megnyitásakor töltõdik be + automatikusan, vagy pedig az M-x sgml-mode + parancs begépelésével. + Általánosságban véve ez az SGML + állományok és a bennük + található elemek és tulajdonságok + szerkesztésére alkalmas mód. + + Az alábbiakban bemutatunk néhány olyan + alapvetõ parancsot ebben a módban, amelyekkel + könnyebbé válik a különbözõ + SGML dokumentumok, többek közt a kézikönyv + szerkesztése. + + + + C-c C-e + + + Meghívja az + sgml-insert-element függvényt. + Ekkor meg kell adnunk az adott pontra beillesztendõ elem + nevét. Itt a Tab + lenyomásával kérhetjük a név + kiegészítését, az adott ponton + érvénytelen elemek neveit ilyenkor nem + érhetjük el. + + A szövegbe ekkor bekerülnek az elemhez + tartozó kezdõ- és + zárócímkék. Amennyiben az elemhez + még tartoznak más egyéb + kötelezõ elemek is, akkor egyúttal ezek is + beszúródnak. + + + + + C-c = + + + Meghívja az + sgml-change-element-name + függvényt. A parancs használatához + álljunk a módosítandó elembe. A + végrehajtáshoz meg kell még adnunk azt + is, hogy mire akarjuk átírni az elem + nevét. Ezután az érintett elem + kezdõ- és zárócímkéi + lecserélõdnek. + + + + + C-c C-r + + + Meghívja az sgml-tag-region + függvényt. A használatához + elõször jelöljük ki a szöveg egy + részét (vigyük a kurzort a + kijelölés kezdetéhez, adjuk ki a + C-space billentyûparancsot, vigyük a kurzort a + kijelölés végéhez és + ismét adjuk ki a C-space parancsot). + Ezután meg kell adnunk még a bejelölt + rész jelöléséhez használni + kívánt elemet. Ennek + eredményeképpen végül a + kijelölt szakasz elejére és + végére bekerül az adott elem kezdõ- + és zárócímkéje. + + + + + C-c - + + + Meghívja az sgml-untag-element + függvényt. Álljunk a kurzorral az + eltávolítani kívánt elem + kezdõ- vagy + zárócímkéjére és + adjuk ki a parancsot. Ekkor az elem kezdõ- és + zárócímkéi törlésre + kerülnek. + + + + + C-c C-q + + + Meghívja az sgml-fill-element + függvényt. Ennek hatására az elem, + amelyben állunk a kurzorral rekurzívan + feldolgozásra kerül (például + újraformázódik). Ez a + változtatás a tördelést is + érinteni fogja, tehát + például még + programlisting elemek esetében is. + Ezért mindig csak körültekintéssel + alkalmazzuk! + + + + + C-c C-a + + + Meghívja az + sgml-edit-attributes függvényt. + Ekkor a legközelebbi befoglaló elemhez + megnyílik egy másik szerkesztési + pufferben az összes hozzátartozó + tulajdonság, értékekkel együtt. Itt + a Tab lenyomásával tudunk + lépkedni az egyes elemek között, a + C-k paranccsal lecserélni egy + meglevõ értéket egy újra, illetve a + C-c C-c paranccsal bezárni a puffert + és visszatérni az eredeti dokumentum + szerkesztéséhez. + + + + + C-c C-v + + + Meghívja az sgml-validate + függvényt. Felajánlja a jelenleg megnyitott + dokumentum mentését (amennyiben + szükséges) és ellenõrzi az SGML + szabvány szerinti + érvényességét. A vizsgálat + eredménye egy új pufferbe kerül, ahol + szépen sorban végig tudjuk nézni az + összes hibát és javítani ezeket + menet közben. + + + + + C-c / + + + Meghívja az + sgml-insert-end-tag + függvényt. Bezárja a kurzor elõtt + megkezdett elemet. + + + + + Nyilvánvalóan ebben a módban még + vannak további hasznos funkciók, de az + említetteket használják a leggyakrabban. + + A Dokumentációs Projekten belüli + munkához az .emacs + állományban a következõ bejegyzéseket + érdemes megadni a megfelelõ tördeléshez, + elrendezéshez és sorszélességhez: + + + (defun local-sgml-mode-hook + (setq fill-column 70 + indent-tabs-mode nil + next-line-add-newlines nil + standard-indent 4 + sgml-indent-data t) + (auto-fill-mode t) + (setq sgml-catalog-files '("/usr/local/share/sgml/catalog"))) + (add-hook 'psgml-mode-hook + '(lambda () (local-psgml-mode-hook))) + + + + + diff --git a/hu_HU.ISO8859-2/books/fdp-primer/see-also/chapter.sgml b/hu_HU.ISO8859-2/books/fdp-primer/see-also/chapter.sgml new file mode 100644 index 0000000000..8b6316ae04 --- /dev/null +++ b/hu_HU.ISO8859-2/books/fdp-primer/see-also/chapter.sgml @@ -0,0 +1,148 @@ + + + + + + Lásd még... + + Ez a dokumentum szándékosan nem törekszik az + SGML és az említett DTD-k, valamint a &os; + Dokumentációs Projekt részletes + bemutatására. Ezekrõl részletesebb + információkat az ebben a fejezetben + összegyûjtött hivatkozások mentén + kaphatunk. + + + &os; Dokumentációs Projekt + + + + A &os; + Dokumentációs Projekt honlapja + + + + A &os; + kézikönyv + + + + + + SGML + + + + Az SGML/XML + honlapja, minden, ami SGML + + + + Könnyed + bevezetés az SGML használatába + (angolul) + + + + + + HTML + + + + A World Wide Web + Consortium honlapja + + + + A HTML 4.0 + specifikációja + + + + + + DocBook + + + + DocBook + Mûszaki Bizottság, a DocBook DTD + karbantartói + + + + DocBook: The + Definitive Guide, a DocBook DTD interneten + olvasható dokumentációja + + + + Nyílt + DocBook Repository, különbözõ + DSSSL stíluslapok és egyéb + források a DocBook felhasználók + számára + + + + + + Linux Dokumentációs Projekt + + + + A Linux + Dokumentációs Projekt honlapja + + + + + + + diff --git a/hu_HU.ISO8859-2/books/fdp-primer/sgml-markup/chapter.sgml b/hu_HU.ISO8859-2/books/fdp-primer/sgml-markup/chapter.sgml new file mode 100644 index 0000000000..cc53fc2c5b --- /dev/null +++ b/hu_HU.ISO8859-2/books/fdp-primer/sgml-markup/chapter.sgml @@ -0,0 +1,3425 @@ + + + + + + Az SGML alkalmazása + + Ebben a fejezetben a &os; Dokumentációs Projekt + keretein belül két leggyakrabban elõforduló + jelölõnyelvet ismerhetjük meg. Az egyes szakaszokban + ezen nyelvek bemutatására, illetve jelenleg + alkalmazott vagy alkalmazandó jelölési + sajátosságaira térünk ki. + + Az itt tárgyalt jelölõnyelvek nagy + számú elemet tartalmaznak, és ezért + gyakorta zavarba ejtõ lehet az adott helyzetnek + leginkább megfelelõ elemek kiválasztása a + rengeteg kínálkozó alternatíva + közül. Ebben a szakaszban ezért igyekezük + érinteni az összes fontosabb elemet, valamint + példákat mutatni a megfelelõ + használatukra. + + Ez az összefoglalás természetesen + nem tartalmazza mindegyik elemet, mivel ezzel + lényegében a nyelv saját + dokumentációját írnánk le + ismételten. Ebben a szakaszban elsõsorban inkább + azon elemek ismertetését tûztük ki + célul, amelyek a munkánk során + valószínûleg a leghasznosabbaknak fognak + bizonyulni. A további különbözõ + jelölési megoldásokra vonatkozóan + bátran kérhetünk tanácsot a &a.doc; + tagjaitól! + + + Belsõ elemek kontra blokkok + + A leírás további részeiben + belsõnek nevezzük azokat az elemeket, + amelyek szerepelhetnek blokkelemekben és nem okoznak + sortörést. Ezzel szemben viszont a + blokk formátumú elemek + feldolgozása sortörést (vagy egyéb + feldolgozási lépéseket) + eredményez. + + + + HTML + + A HTML, más néven HyperText Markup Language, a + Világháló jelölõnyelve. Ezzel + kapcsolatban részlesebb leírásokat a címen + találhatunk. + + A HTML használata a &os; honlapján + található oldalak + készítésénél jelenik meg. + Más dokumentációkhoz azonban + (általánosságban) nem szokták + alkalmazni, mivel a DocBook ennél sokkal + bõségesebb eszközöket kínál + fel. Ennek következményeképpen tehát + többnyire csak a honlap fejlesztése során + fogunk HTML oldalakkal találkozni. + + A HTML létrejötte óta több + verzióváltáson is keresztülment + már, az 1, 2, 3.0, 3.2 verziókat követõen + egészen a legfrissebb 4.0 változatáig (amely + egyaránt elérhetõ + szigorú (strict) és + enyhébb (loose) formáiban + is). + + A HTML DTD-k a Portgyûjteménybõl a textproc/html porton keresztül + érhetõek el. A textproc/docproj port ezt automatikusan + telepíti. + + + Formális publikus azonosító + + A HTML megfelelni kívánt verziójától (amelyet sokszor szintnek is szoktak + nevezni) függően különböző formális publikus azonosító (FPI) + áll rendelkezésünkre. + + A &os; honlapján található + HTML dokumentumok többsége a HTML 4.0 enyhébb + változatának felel meg: + + PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" + + + + A dokumentum részei + + A HTML dokumentumok általános esetben + két részre oszthatóak. Az elsõ, + fejnek nevezett rész tartalmazza a + dokumentumhoz tartozó metainformációkat, + például a címét, a szerzõ + nevét, a szülõdokumentumot és így + tovább. A második, + törzsnek hívott rész + pedig a felhasználó részére + megjelenített tartalmat foglalja magában. + + A dokumentum ezen részeit rendre a + head (mint angolul a fej) + és a body (mint angolul a + törzs) elemekkel jelöljük. Ezeket + az elemeket végül a legfelsõbb szinten + álló html elem + tartalmazza. + + + Egy átlagos HTML dokumentum + felépítése + + <html> + <head> + <title>A dokumentum címe</title> + </head> + + <body> + + … + + </body> +</html> + + + + + Blokkok + + + Fejlécek + + A HTML lehetõvé teszi fejlécek + jelölését egészen hat + különbözõ szintig. + + A legnagyobb és legkiemelkedõbb fejléc + a h1, majd ezt követi a + h2, egészen a h6 + címkéig. + + Az elem tartalma a fejléc szövege lesz. + + + A <sgmltag>h1</sgmltag>, <sgmltag>h2</sgmltag>, stb. + elmek + + A használat módja: + + ]]>Elsõ szakasz + + + +

]]>Ez az elsõ szakasz fejléce + + + +

]]>Ez az elsõ alszakasz fejléce + + + +

]]>Ez a második szakasz fejléce + +]]> + + + A HTML oldalaknak általában + rendelkezniük kell elsõ szintû fejléccel + (h1). Ez tetszõleges + számú második szintû fejlécet + (h2) tartalmazhat, amelyek szintén + tetszõleges mennyiségû harmadik szintû + fejlécet. Ügyeljünk arra, hogy minden + hn elem mindig a + nála eggyel nagyobb szintû elemet tartalmazza, a + sorszámozásban tehát nem javasolt + közöket hagyni. + + + A <sgmltag>h<replaceable>n</replaceable></sgmltag> + elemek helytelen sorrendje + + A használati módja: + + ]]>Elsõ szakasz + + + +

]]>Alszakasz + +]]> + + + + + Bekezdések + + A HTML egyetlen bekezdésfajtát ismer, ez a + p. + + + A <sgmltag>p</sgmltag> elem + + A használat módja: + + ]]>Ez egy bekezdés. Szinte bármilyen más elemet tartalmazhat.]]> + + + + + Idézetblokkok + + Az idézetblokkok más dokumentumok nagyobb + részeinek idézésére + használhatóak az aktuális + bekezdésen túl. + + + A <sgmltag>blockquote</sgmltag> elem + + A használat módja: + + ]]>Részlet a Szózatból: + +
]]>Hazádnak rendületlenûl + Légy híve, oh magyar, + Bölcsõd az 's majdan sírod is, + Melly ápol 's eltakar. + + A' nagy világon e' kivûl + Nincsen számodra hely, + Áldjon vagy verjen sors' keze, + Itt élned, halnod kell. + + Ez a' föld, mellyen annyiszor + Apáid' vére folyt; + Ez, mellyhez minden szent nevet + Egy ezredév csatolt. + + Itt küzdtenek honért a' hõs + Árpádnak hadai, + Itt törtek össze rabigát + Hunyadnak karjai. + + Szabadság! Itten hordozák + Véres zászlóidat, + 'S elhulltanak legjobbjaink + A' hosszu harcz alatt.]]> + + + + + Felsorolások + + A dokumentumokban háromféle + felsorolást használhatunk: sorszámozott, + sorszámozás nélkül és + definíciós. + + Röviden úgy mutathatnánk be ezeket a + formátumokat, hogy a sorszámozott + felsorolásban az elemek elé számok + kerülnek, a sorszámozás nélküli + esetben pontok, a definíciós + felsorolásban pedig a bejegyzések két + részébõl jönnek létre az + elemek. Ezek közül az elsõ részben a + meghatározandó fogalom található, + míg a második részben annak + meghatározása. + + A sorszámozott felsorolásokat az + ol elem jelzi, a sorszámozás + nélküli felsorolásokat az + ul elem, végül a + definíciós felsorolásokat a + dl elem. + + A sorszámozott és sorszámozás + nélküli felsorolások a felsorolás + elemeit tartalmazzák, amelyeket a li + elemekkel vezetünk be. A felsorolások elemeinek + szöveges tartalma lehet, vagy ha ezeket becsomagoljuk egy + vagy több p elembe, további + elemeket tartalmazhatnak. + + A definíciós felsorolások + meghatározandó fogalmakat (dt) + és meghatározásokat + (dd) tartalmazhatnak. A + meghatározandó fogalmat tartalmazó + részben csak belsõ elemek szerepelhetnek. A + meghatározásokban viszont további blokkok + is megjelenhetnek. + + + Az <sgmltag>ul</sgmltag> és + <sgmltag>ol</sgmltag> elemek + + A használat módja: + + ]]>Egy sorszámozás nélkül felsorolás. A felsorolás elemei elõtt minden + bizonnyal pontok fognak megjelenni. + +
    +
  • ]]>Elsõ elem + +
  • ]]>Második elem + +
  • ]]>Harmadik elem +
+ +

]]>Egy sorszámozott lista, ahol az elemek több bekezdésbõl állnak. + Mindegyik elem (figyelem: nem mindegyik bekezdés) elõtt egy sorszámnak kell + szerepelnie. + +

    +
  1. +

    ]]>Ez az elsõ elem. Ennek csak egy bekezdése van. +

  2. + +
  3. +

    ]]>Ez a második elem elsõ bekezdése. + +

    ]]>Ez a második elem második bekezdése. +

  4. + +
  5. +

    ]]>Ez az elsõ és egyetlen bekezdés a harmadik elemben. +

  6. +
]]>
+
+ + + Definíciós felsorolások a + <sgmltag>dl</sgmltag> elemmel + + A használat módja: + + +
]]>Elsõ fogalom + +
+

]]>Az elsõ fogalom meghatározásának elsõ bekezdése. + +

]]>Az elsõ fogalom meghatározásának második bekezdése. +

+ +
]]>Második fogalom + +
+

]]>A második fogalom meghatározásának elsõ bekezdése. +

+ +
]]>Harmadik fogalom + +
+

]]>A harmadik fogalom meghatározásának elsõ bekezdése. +

+]]>
+
+
+ + + Formázott szöveg + + Megadhatjuk, hogy a szöveg egyes részei + pontosan abban a formában kerüljenek a + felhasználó elé, ahogy az eredetileg + szerepel. Ilyenkor általában a szöveg + rögzített szélességû + betûtípussal jelenik meg, az egymás mellett + levõ szóközök nem vonódnak + össze, a sortörések hatása + fontossá válik. + + Mindezt a pre elemen keresztül + érhetjük el. + + + A <sgmltag>pre</sgmltag> elem + + A pre elem például + remekül alkalmas e-mailek + jelölésére: + + From: Gabor PALI <pgj@FreeBSD.org> + To: bsd@hu.FreeBSD.org + Subject: Uj FreeBSD-cikk forditas: Naplozo UFS hasznalata asztali szamitogepeken + + Kedves listatagok! + + + Nemreg elkeszitettem az ``Implementing UFS Journaling on a Desktop + PC'' neven szerepelo [1] FreeBSD-cikk magyar forditasat [2]. + Szeretnek megkerni mindenkit, akit erdekel a honositott valtozat, + hogy olvassa el, nezze at, betatesztelje es mondjon rola velemenyt. + Egyelore meg csak a sajat Perforce repositorynkbol erheto el, de a + megadott linken naponta egyszer automatikusan frissul a HTML valtozat + a feltoltott valtoztatasok (peldaul hibajavitasok) fuggvenyeben. + Elore is nagyon szepen koszonom mindenkinek a segitseget! + + :g + + [1] http://www.freebsd.org/doc/en/articles/gjournal-desktop/ + [2] http://people.freebsd.org/~pgj/gjournal-desktop_hu/]]> + + Hasznos azonban tudnunk, hogy a < + és & jelek a formázott + szövegben továbbra is speciális + jelentéssel bírnak. A példában + ezért is használtunk + &lt; egyedeket a + < jelek helyett. Ugyanezért a + &gt; a > + helyén is látható. Ezért mindig + körültekintõen bánjunk a nyers + szövegbõl, például e-mailbõl + vagy forráskódból bemásolt + részletekkel, és ne felejtsük el + átalakítani a bennük + található speciális + karaktereket. + + + + + + Táblázatok + + + A legtöbb (Lynx-hez hasonló) szöveges + módban futó böngészõ + kifejezetten ügyetlen módon jeleníti meg + a táblázatokat. Ha az oldalon a + táblázatos felépítést + választjuk, akkor a problémák + elkerüléséhez érdemes egy + alternatív jelölési módszert + alkalmazni. + + + A táblázatos formában + megjeleníteni kívánt + információt jelöljük a + table elemmel. A táblázatok + egy több sorból (tr mint + table row) állnak, amelyek egy vagy + több adatcellát (td mint + table data) tartalmaznak. Mindegyik cella + tartalmazhat további blokkokat, például + bekezdéseket vagy listákat, de akár + táblázatokat (ez a beágyazás + tetszõleges mélységig folytatható). + Ha a cella tartalma csak egyetlen bekezdés, akkor + nincs szükség a p elem + használatára. + + + A <sgmltag>table</sgmltag> egyszerû + használata + + A használat módja: + + ]]>Ez egy 2x2-es táblázat. + + + + + + + +
]]>Bal felsõ cella + + ]]>Jobb felsõ cella +
]]>Bal alsó cella + + ]]>Jobb alsó cella +
]]>
+ + Egy cella több sorra vagy oszlopra is + átnyúlhat. Ennek jelzéséhez a + kiterjesztendõ sorokhoz a rowspan + és/vagy oszlopokhoz a colspan + tulajdonságot adjuk meg a megfelelõ + értékkel. + + + A <literal>rowspan</literal> tulajdonság + + A használat módja: + + ]]>Egy magas keskeny cella a bal oldalon, mellette jobbra + két rövid cella. + + + + + + + +
]]>Hosszú és keskeny +
]]>Felsõ cella + + ]]>Alsó cella +
]]>
+
+ + + A <literal>colspan</literal> tulajdonság + + A használat módja: + + ]]>Felül egy hosszú cella, alatt két rövidebb cella. + + + + + + + +
]]>Felsõ cella +
]]>Bal alsó cella + + ]]>Jobb alsó cella +
]]>
+
+ + + A <literal>rowspan</literal> és + <literal>colspan</literal> tulajdonságok + együttes használata + + A használat módja: + + ]]>Egy 3x3-as rácson a bal felsõ blokk 2x2 egymásba olvasztott + cellából áll. A többi cella normális. + + + + + + + + + + + + +
]]>Bal felsõ nagy cella + + ]]>Jobb felsõ cella +
]]>Jobb középsõ cella +
]]>Bal alsó cella + + ]]>Bal középsõ cella + + ]]>Jobb alsó cella +
]]>
+
+
+ + + + Belsõ elemek + + + Az információ kiemelése + + A HTML esetén a kiemelésnek két + szintje létezik, az em és a + strong. Ezek közül az + em jelenti a hagyományos + kiemelést és a strong az + erõsebbet. + + Az em elem tartalma + általában dõlt betûvel jelenik meg, + miközben a strong elem tartalma + félkövéren. Ez a + megállapítás azonban nem minden esetben + igaz, ezért nem szabad semmi ilyesmit + feltételeznünk a használatukkor. + + + A <sgmltag>em</sgmltag> és + <sgmltag>strong</sgmltag> elemek + + A használat módja: + + ]]><em>Ezt</em> a részt kiemeltük, miközben <strong>ezt</strong> részt + erõsebben kiemeltük.]]> + + + + + Félkövér és dõlt + formázás + + Mivel a HTML tartalmaz konkrétan a + megjelenítésre vonatkozó + jelölõket is, ezért külön jelezni + tudjuk a forrásban, hogy a szöveg melyik + részét szeretnénk + félkövéren vagy dõlten látni. + Ezeket a funkciókat a b, illetve az + i elemekkel érhetjük el. + + + A <sgmltag>b</sgmltag> és <sgmltag>i</sgmltag> + elemek + + ]]><b>Ez</b> félkövér, <i>ez</i> pedig dõlt.]]> + + + + + Írógépszerû + formázás + + Az írógépszerûen + (rögzített szélességû + karakterekkel) írt szövegek + formázásához a tt + (mint teletype) elemet + használhatjuk. + + + A <sgmltag>tt</sgmltag> elem + + A használat módja: + + ]]>Ezt a dokumentumot eredetileg Páli Gábor fordította, + és a következõ címen érhetõ el: <tt>pgj@FreeBSD.org</tt>.]]> + + + + + Méretezés + + Elõfordulhat, hogy szeretnénk növelni + vagy csökkenteni a szöveg + megjelenítéséhez használt + betûtípus méretét. Erre + alapvetõen három lehetõség + kínálkozik. + + + + Ágyazzuk az átméterezendõ + szöveget big és + small elemekbe. Ezeket a + címkéket tetszõleges + mélységig egymásba tudjuk + ágyazni, tehát írható olyan, + hogy <big><big>Ez már sokkal + nagyobb!</big></big>. + + + + Használjuk a font elemet, + és a size + tulajdonságát állítsuk a + +1 vagy -1 + értékre. Ez hatása szerint + megegyezik a big és a + small elemek + használatával, azonban ez a + típusú megoldás már + elavult. + + + + A font size + tulajdonsága 1 és + 7 között + állítható. A betû + alapértelmezett mérete 3. + Ez a megközelítés már + elavult. + + + + + A <sgmltag>big</sgmltag>, <sgmltag>small</sgmltag> + és a <sgmltag>font</sgmltag> elemek + + A következõ kódrészleteknek + ugyanaz a hatása. + + ]]>Ez a szöveg <small>valamivel kisebb</small>. Ez a + a szöveg viszont <big>valamivel nagyobb</big>. + +

]]>Ez a szöveg <font size="-1">valamivel kisebb</font>. Ez a + szöveg viszont <font size="+1">valamivel nagyobb</font>. + +

]]>Ez a szöveg <font size="2">valamivel kisebb</font>. Ez a + szöveg viszont <font size="4">valamivel nagyobb</font>.]]> + + + + + + Hivatkozások + + + A hivatkozások is belsõ elemek. + + + + Hivatkozás más dokumentumokra a + Világhálón + + A Világhálón elhelyezkedõ + dokumentumokat úgy tudjuk hivatkozni, ha ismerjük a + helyüket. + + A hivatkozást az a elemmel + adhatjuk meg, amelynek a href + tulajdonsága tartalmazza a hivatkozott dokumentum + helyét. Az elem tartalma ekkor egy + hivatkozássá változik, és a + felhasználó számára is jól + látható módon jelenik meg + (aláhúzással, más színnel, + más egérmutatóval és így + tovább). + + + Az <literal><a href="..."></literal> elem + + A használat módja: + + ]]>Erre vonatkozóan részletesebb információkat a + <a href="http://www.FreeBSD.org/">&os; honlapján</a> találhatunk.]]> + + + Ezeket a hivatkozások a felhasználót + az adott dokumentum elejére + irányítják. + + + + A dokumentumok más részeinek + hivatkozása + + A dokumentumok egyéb részeire (akár + ugyanazon a dokumentumon belül) csak akkor tudunk + hivatkozni, ha a szerzõ elõzetesen + hivatkozási pontokat helyeztünk el + bennük. + + Hivatkozási pontokat szintén + a elemekkel adhatunk meg, azonban a + href tulajdonság helyett a + name használatával. + + + Az <literal><a name="..."></literal> elem + + A használat módja: + + ]]>Ez]]> a bekezdés a hivatkozásokban a ]]>bekezd1]]> + névvel érhetõ el.]]> + + + A dokumentum így megnevezett részét + egy egyszerû hivatkozás + készítésével tudjuk elérni, + azonban a hivatkozási pont neve elé tennünk + kell egy # jelet. + + + Egy másik dokumentum nevesített + részének elérése + + Tételezzük fel, hogy a + bekezd1 példánk az + ize.html állományban + található. + + ]]>A témáról további információkat az ]]>ize.html]]> + ]]>elsõ bekezdésében]]> találhatunk.]]> + + + Ha egy hivatkozási pontra ugyanazon a dokumentumon + belül szeretnénk hivatkozni, akkor nyugodtan + elhagyhatjuk a dokumentum nevét, elegendõ + egyszerûen magát a hivatkozási pontot + megadnunk (természetesen a hozzátartozó + # jellel együtt). + + + Ugyanazon dokumentum nevesített + részének elérése + + Tételezzük fel, hogy a + bekezd1 példa ugyanezen a + dokumentumon belül helyezkedik el: + + ]]>A témáról további információkat az + ]]>elsõ bekezdésben]]> találhatunk.]]> + + + + + + + DocBook + + A DocBook jelölõnyelvet eredetileg a HaL Computer + Systems és az O'Reilly & Associates dolgozta ki a + mûszaki jellegû dokumentációk + írásához + Ennek rövid története a + címen olvasható., illetve + 1998 óta a + DocBook Mûszaki Bizottság tartja karban. Mint + ilyen nyelv, eltérõen a LinuxDoc és a HTML + megoldásaitól, a DocBook erõsen olyan + jelölések irányába + orientálódik, amelyek nem azt írják le + hogyan, hanem mit + jelenítsünk meg. + + + <literal>Formális</literal> kontra + <literal>informális</literal> + + Bizonyos elemeknek létezik ún. + formális és + informális változata. A + formális változat általában egy + címbõl és az adott elem informális + változatából áll. Az + informális változat nem tartalmaz + címet. + + + A DocBook használatához szükséges + DTD a Portgyûjteménybõl a textproc/docbook porton keresztül + érhetõ el. Ez a textproc/docproj port + részeként automatikusan + telepítõdik. + + + A &os; kiterjesztései + + A &os; Dokumentációs Projekt kiterjesztette a + hivatalos DocBook DTD-t további elemekkel. + Segítségükkel bizonyos jelölések + sokkal pontosabbá tehetõek. + + A kizárólag a &os; esetén alkalmazott + elemeket egyértelmûen jelezni fogjuk a + felsorolásban. + + A dokumentum további részében a + DocBook kifejezés a DocBook DTD &os; + kiterjesztéseivel együtt értendõ. + + + Szeretnénk megemlíteni, hogy a + hozzáadott kiegészítésekben azonban + semmi olyan nincs, ami kizárólag a &os;-re + vonatkozna, egyszerûen csak a Projektben felmerült + igények mentén szeretne alkalmazni + néhány javítást. Ha más + &unix; jellegû rendszerek (NetBSD, OpenBSD, Linux, stb.) + fejlesztõit esetleg érdekelné a DocBook + további fejlesztése, kérjük, + vegyék fel velünk a kapcsolatot a &a.doceng; + címén. + + + A &os; kapcsán alkalmazott kiterjesztések + (jelenleg) nem érhetõek el a + Portgyûjteménybõl, hanem a &os; repositoryban + találjuk meg a doc/share/sgml/freebsd.dtd + helyen. + + + + Formális publikus azonosító + + A DocBook a testreszabott változatok formális + publikus azonosítóira vonatkozó + irányelvei szerint a &os; kiterjesztéseivel + bõvített DocBook DTD formális publikus + azonosítója a következõ lesz: + + PUBLIC "-//FreeBSD//DTD DocBook V4.1-Based Extension//EN" + + + + A dokumentum szerkezete + + A DocBook többféle módon + kínál lehetõségeket a dokumentumok + szerkezetének kialakítására. A &os; + Dokumentációs Projektben a DocBook dokumentumok + két alapvetõ fajtáját + használjuk, a könyvet és a cikket. + + A könyvek fejezetekbõl + (chapter) állnak, amelyek + használata kötelezõ. A könyv és a + fejezetek közé még további + szervezési rétegként beilleszhetõek + részek (part) is. Például a &os; + kézikönyv szerkezetét is ennek + megfelelõen alakítottuk ki. + + A fejezetek tartalmazhatnak (vagy sem) egy vagy több + szakaszt, amelyeket sect1 elemekkel + jelezhetünk. Amennyiben egy szakasz újabb szakaszt + tartalmaz, akkor használjuk a sect2 + elemet, és így tovább egészen a + sect5 szintig. + + A fejezetek és a szakaszok tartalmazzák a + dokumentum tartalmának fennmaradó + részét. + + Egy cikk egy könyvnél egyszerûbb + felépítésû, és nem tartalmaz + fejezeteket. Helyette a cikkek tartalmát egy vagy + több szakaszba szervezzük, a könyvnél + már említett sect1 + (sect2 és így tovább) + elemek segítségével. + + A készítendõ + dokumentációról értelemszerûen + jellegének mérlegelésével tudjuk + eldönteni, hogy könyvként esetleg + cikk-ként érdemesebb jelölni. A cikk + formátum választása leginkább olyan + információk esetén célszerû, + ahol nincs szükségünk külön + fejezetekre. Röviden szólva tehát egy + viszonylag rövid, legfeljebb 20-25 oldalas + írást takar. A könyv formátum ezzel + szemben leginkább olyan esetekben alkalmazható, + amikor az információ fejezetekre bontható, + amelyhez függelékek és hasonlók is + társulhatnak. + + A &os;-hez készített cikkek + mindegyikét cikk-ként jelöltük, + miközben például ez a dokumentum, a &os; GYIK, és + a &os; kézikönyv + könyvként került jelölésre. + + + Könyv írása + + A könyvek tartalmát egy + book elemben adjuk meg. Ez a + jelölõ amellett, hogy magában foglalja a + könyv teljes felépítését, + tovább információkat tud tárolni + magáról a könyvrõl. Ez lehet + akár hivatkozási célokat + szolgáló metainformáció, vagy + éppen a címlap + elkészítéséhez + szükséges egyéb + leírás. + + A könyvre vonatkozó további + információkat egy bookinfo + elemen belül adhatjuk meg. + + + Egy <sgmltag>book</sgmltag> és + <sgmltag>bookinfo</sgmltag> elemek + segítségével definiált + könyvsablon + + <book> + <bookinfo> + <title>Ide írjuk a címet</title> + + <author> + <surname>Vezetéknév</surname> + <firstname>Keresztnév</firstname> + <affiliation> + <address><email>E-mail cím</email></address> + </affiliation> + </author> + + <copyright> + <year>2008</year> + <holder role="mailto:E-mail cím">Név</holder> + </copyright> + + <releaseinfo>$&os;$</releaseinfo> + + <abstract> + <para>Ide kerüljön a könyv tartalmának rövid összefoglalása.</para> + </abstract> + </bookinfo> + + … + +</book> + + + + + Cikk írása + + A cikk tartalma az article elembe + kerül. A dokumentum szervezésén + kívül ennek az elemnek feladata + lehetõséget kínálni további + információk elhelyezésére. Ez + lehet hivatkozási célokra alkalmas + metainformáció, vagy például a + címlap elõállításához + szükséges egyéb adatok. + + A cikk-kel kapcsolatos további + információk egy articleinfo + elemben adhatóak meg. + + + Egy <sgmltag>article</sgmltag> és + <sgmltag>articleinfo</sgmltag> elemek + segítségével definiált + cikksablon + + <article> + <articleinfo> + <title>Ide írjuk a címet</title> + + <author> + <surname>Vezetéknév</surname> + <firstname>Keresztnév</firstname> + <affiliation> + <address><email>E-mail cím</email></address> + </affiliation> + </author> + + <copyright> + <year>2008</year> + <holder role="mailto:E-mail cím">Név</holder> + </copyright> + + <releaseinfo>$&os;$</releaseinfo> + + <abstract> + <para>Ide kerüljön a cikk tartalmának rövid összefoglalása.</para> + </abstract> + </articleinfo> + + … + +</article> + + + + + Fejezetek készítése + + A chapter elem + használatával tudunk fejezeteket jelölni. + Minden fejezetnek kötelezõen rendelkeznie kell egy + címmel, vagyis egy title elemmel. A + cikkek nem tartalmazhatnak fejezeteket, + kizárólag könyvek számára + tartják fenn. + + + Egy egyszerû fejezet + + + ]]>Fejezetcím<![ CDATA [ + + ... +]]> + + + A fejezetek nem lehetnek üresek, a + title elem mellett még tartalmazniuk + kell valamilyen másik elemet is. Az üres + fejezetek készítéséhez + használjunk egy üres bekezdést. + + + Üres fejezetek + + + ]]>Ez egy üres fejezet<![ CDATA [ + + +]]> + + + + + Szakaszok fejezetek alatt + + A könyvekben a fejezetek további szakaszokra, + alszakaszokra stb. bonthatóak (de nem + kötelezõ). A cikkekben azonban a szakaszok az + alapvetõ szervezõelemek, ezért minden cikknek + legalább egy szakaszt tartalmaznia kell. A szakaszok + létrehozására a + sectn elemet + használhatjuk, ahol az n + szám adja meg a szakasz szintjét. + + Az elsõ ilyen + sectn elem a + sect1, amelybõl egy fejezetben egy + vagy több is szerepelhet. Ezek egy vagy több + sect2 elemet tartalmazhatnak, és + így tovább egészen az + sect5 szintjéig. + + + Szakaszok fejezetekben + + + ]]>Minta fejezet<![ CDATA [ + + ]]>Egy kis fejezetbeli szöveg. + + + ]]>Elsõ szakasz (1.1)<![ CDATA [ + + … + + + + ]]>Második szakasz (1.2)<![ CDATA [ + + + ]]>Elsõ alszakasz (1.2.1)<![ CDATA [ + + + ]]>Elsõ al-alszakasz (1.2.1.1)<![ CDATA [ + + … + + + + + ]]>Második alszakasz (1.2.2)<![ CDATA [ + + … + + +]]> + + + + Láthatjuk, hogy ebben a példában a + szakaszok neveiben megjelenik a szakaszok + számozása. Ezt azonban ne írjuk bele a + dokumentumainkba! A szakaszok + számozását a stíluslapok + végzik (errõl még késõbb + szó lesz), ezekkel egyáltalán nem kell + foglalkoznunk. + + + + + A dokumentum felosztása <sgmltag>part</sgmltag> + elemek használatával + + A book és + chapter elemek részérõl + felkínált szervezési szintek + közé a part elemek + alkalmazásával egy újabbat tudunk + illeszteni. Erre a cikkek esetében nincs + lehetõségünk. + + + ]]>Bevezetés<![ CDATA [ + + + ]]>Áttekintés<![ CDATA [ + + ... + + + + ]]>Mi a &os;?<![ CDATA [ + + ... + + + + ]]>Történet<![ CDATA [ + + ... + +]]> + + + + + Blokkok + + + Bekezdések + + A DocBookban a bekezdések háromféle + típusát találhatjuk meg: + formalpara, para + és simpara. + + Az iméntiek közül a legtöbb esetben + az para elemre lesz + szükségünk. A formalpara + tartalmaz még egy title elemet, + illetve a simpara nem engedélyezi + bizonyos elemek használatát a + bekezdésben. Érdemes tehát inkább + következetesen a para + használatánál maradni. + + + A <sgmltag>para</sgmltag> elem + + A használat módja: + + ]]>Ez egy bekezdés. Tetszõleges egyéb elem megjelenhet benne.]]> + + Így jelenik meg: + + Ez egy bekezdés. Tetszõleges egyéb + elem megjelenhet benne. + + + + + Idézetblokkok + + Az idézetblokkok egy másik + dokumentumból származó, kiterjedtebb + hosszúságú idézetet jelölnek, + amelyeknek az aktuális bekezdéstõl + függetlenül kell megjelenniük. Erre + valószínûleg csak nagyon ritkán lesz + ténylegesen szükségünk. + + Az idézetblokkok opcionálisan címeket + és szerzõt is tartalmazhatnak (de akár + szerepelhetnek cím vagy szerzõ + nélkül). + + + A <sgmltag>blockquote</sgmltag> elem + + A használat módja: + + ]]>Részlet Szerb Antal <quote>A Pendragon legenda</quote> címû + mûvébõl: + +

+ ]]>A Pendragon legenda<![ CDATA [ + + ]]>Szerb Antal + + ]]>Minden nõben azt élveztem, hogy a szimbóluma volt valaminek. Volt + nõ, akit azért szerettem, mert õ volt Svédország, volt nõ, akit azért, + mert a XVIII. századra emlékeztetett törékeny Sèvres-mivolta. + Volt, akiben Jeanne d'Arc-ot álmodtam, volt, akiben az ezermellû + ephesusi Dianát. Cynthiát, ha megcsókoltam, úgy éreztem, most az + angol szonetekkel flörtölök, ötödfeles jambusokban. Volt, akinek édes + tehénszerûségében svájci, alpesi réteket élveztem. +
]]>
+ + Így jelenik meg: + + Részlet Szerb Antal A Pendragon + legenda címû + mûvébõl: + +
+ A Pendragon legenda + + Szerb Antal + + Minden nõben azt élveztem, hogy a + szimbóluma volt valaminek. Volt nõ, akit + azért szerettem, mert õ volt + Svédország, volt nõ, akit azért, + mert a XVIII. századra emlékeztetett + törékeny Sèvres-mivolta. Volt, akiben + Jeanne d'Arc-ot álmodtam, volt, akiben az + ezermellû ephesusi Dianát. Cynthiát, + ha megcsókoltam, úgy éreztem, most az + angol szonetekkel flörtölök, + ötödfeles jambusokban. Volt, akinek édes + tehénszerûségében svájci, + alpesi réteket élveztem. +
+
+
+ + + Tanácsok, megjegyzések, + felhívások, figyelmeztetések, fontos + és mellékes információk + + Esetenként szükségünk lehet arra, + hogy bizonyos többletinformációt + közöljünk az olvasóval a + szövegtõl elkülöníthetõ + módon. Ez többnyire olyan + metainformáció, amelyre a + felhasználónak tekintettel érdemes + lennie. + + Az adott információ jellegétõl + függõen erre a célra a tip + (tanács), note (megjegyzés), + warning (felhívás), + caution (figyelmeztetés) és + important (fontos információ) + elemek valamelyikét tudjuk használni. + Amennyiben a közölni kívánt + információ kötõdik ugyan a + szöveghez, azonban az elõbbiek közül egyik + kategóriába sem sorolható be, akkor + használhatjuk a sidebar + (mellékinformáció) elemet is. + + Nem teljesen tisztázott, hogy az imént + felsorolt elemek közül pontosan mikor melyiket kell + alkalmazni. A DocBook dokumentációja ezzel + kapcsolatban a következõket javasolja: + + + + A note elemek olyan + információkat jelölnek, amelyek az + olvasó részérõl + megszivlelendõek. + + + + Az important elemek a + note elemek egyik + változata. + + + + A caution elemmel olyan + információt jelölnek, amelyek + ismeretének hiányában + adatvesztés vagy szoftveres károdás + következhet be. + + + + A warning elemek olyan + információkat jelölnek, amelyek + ismeretének hiánya hardver + károsodását, + életveszélyt vagy a végtagok + sérülését + eredményezheti. + + + + + A <sgmltag>warning</sgmltag> elem + + A használat módja: + + + ]]>A &os; telepítése után könnyen elõfordulhat, hogy a Windowst + teljesen le akarjuk törölni a merevlemezünkrõl. +]]> + + + Így jelenik meg: + + + A &os; telepítése után könnyen + elõfordulhat, hogy a Windowst teljesen le akarjuk + törölni a merevlemezünkrõl. + + + + + Felsorolások és + eljárások + + Gyakran adódhatnak olyan helyzetek, amikor az + olvasó felé fel kell sorolnunk valamilyen + információkat, vagy egy adott cél + elérése érdekében be kell + mutatnunk neki egy sorszámozott, egyenként + végrehajtandó + lépéssorozatot. + + Erre a célra rendelkezésünkre + állnak az itemizedlist, az + orderedlist, illetve a + procedure elemek + A felsorolások megadására a + DocBook további lehetõségeket is + felkínál, azonban ezekkel itt most nem + foglalkozunk.. + + Az itemizedlist és az + orderedlist elemek hasonlóak az HTML + esetén már megismert megfelelõikhez, az + ul és ol + elemekhez. Egy vagy több listitem + elembõl állnak és mindegyik + listitem egy vagy több blokkot + tartalmaz. A listitem elemek a HTML + li elemeihez hasonlóak, azonban + ebben az esetben kötelezõ megadni ezeket. + + A procedure elem ettõl + némileg eltér. Itt step + elemekbõl épül fel, amelyek további + step vagy substep + típusú elemeket foglalhatnak magukban. A + step elemek mindegyike blokkokat + tartalmaz. + + + Az <sgmltag>itemizedlist</sgmltag>, + <sgmltag>orderedlist</sgmltag> és + <sgmltag>procedure</sgmltag> elemek + + A használat módja: + + + + ]]>Ez a felsorolás elsõ eleme. + + + + ]]>A a felsorolás második eleme. + + + + + + ]]>Ez az elsõ sorszámozott elem. + + + + ]]>Ez a második sorszámozott elem. + + + + + + ]]>Csináljuk ezt. + + + + ]]>Majd csináljuk azt. + + + + ]]>Most pedig csináljuk így. + +]]> + + Így jelenik meg: + + + + Ez a felsorolás elsõ eleme. + + + + Ez a felsorolás második eleme. + + + + + + Ez az elsõ sorszámozott elem. + + + + Ez a második sorszámozott elem. + + + + + + Csináljuk ezt. + + + + Majd csináljuk azt. + + + + Most pedig csináljuk így. + + + + + + + Példák állományokra + + Ha állományrészeket (vagy akár + teljes állományokat) akarunk bemutatni az + olvasónak, akkor érdemes ezeket egy + programlisting elembe illeszteni. + + A programlisting elemeken belül + alkalmazott tördelés és a + sortörések helye jelentéssel + bír. Ennek egyik fontos + következménye, hogy a + nyitócímkének az állomány + tartalmának elsõ sorával együtt kell + megjelennie, illetve a + zárócímkének pedig az + utolsó sorban, ellenkezõ esetben üres sorok + fognak keletkezni a kimenetben. + + + A <sgmltag>programlisting</sgmltag> elem + + A használat módja: + + ]]>Miután befejeztük a feladatot, a programunknak valahogy így kell + majd kinéznie: + +#include <stdio.h> + +int +main(void) +{ + printf("]]>Halló mindenki!]]> + + Láthatjuk, hogy az #include + után a relációs jeleket nem + közvetlenül adtuk meg, hanem a nekik + megfelelõ egyedekkel. + + Így jelenik meg: + + Miután befejeztük a feladatot, a + programunknak valahogy így kell majd + kinéznie: + + #include <stdio.h> + +int +main(void) +{ + printf("Halló mindenki!\n"); +} + + + + + Magyarázó szövegek + + A magyarázó szövegek + használatával a szöveg egy korábbi + részére vagy egy korábbi példa + adott helyére tudunk visszahivatkozni + anélkül, hogy a szövegen magán + belül hivatkoznánk rá. + + Ehhez a co elem + használatával jelöljük be a példa + (programlisting, + literallayout vagy bármi más) + fontosabb részeit. Mindegyik elemhez egy egyedi + azonosítót kell társítanunk. A + példa után helyezzünk el egy + calloutlist elemet, amelyben a + megfelelõ további magyarázat + megadásával együtt visszahivatkozunk a + példa egyes részeire. + + + A <sgmltag>co</sgmltag> és + <sgmltag>calloutlist</sgmltag> elemek + + ]]>Miután befejeztük a feladatot, a programunknak valahogy így kell + majd kinéznie: + +#include <stdio.h> + +int +main(void) +{ + printf("]]>Halló mindenki! +} + + + + ]]>A szabványos állománymûveleteket tartalmazó header + állomány. + + + + ]]>Megadjuk, hogy a <function>main()</function> függvény egy + <literal>int</literal> típusú értékkel térjen vissza. + + + + ]]>A <function>printf()</function> hívással egy + <literal>Halló mindenki!</literal> szöveget írunk ki a szabványos + kimenetre. + +]]> + + Így jelenik meg: + + Miután befejeztük a feladatot, a + programunknak valahogy így kell majd + kinéznie: + + #include <stdio.h> + +int +main(void) +{ + printf("Halló mindenki!\n"); +} + + + + A szabványos + állománymûveleteket tartalmazó + header állomány. + + + + Megadjuk, hogy a main() + függvény egy int + típusú értékkel + térjen vissza. + + + + A printf() + hívással egy Halló + mindenki! szöveget írunk ki a + szabványos kimenetre. + + + + + + + Táblázatok + + A HTML kapcsán megismertektõl + eltérõen a szöveg elrendezésének + befolyásolásához nem kell + táblázatokat használnunk, mivel + errõl majd a stíluslapok gondoskodnak + helyettünk. Ehelyett egyszerûen csak akkor + használjunk táblázatokat, amikor + táblázatosan akarunk adatokat megadni. + + Általános értelemben véve + (ennek további részleteit lásd a DocBook + leírásában) a táblázatok + (amelyek lehetnek formálisak vagy informálisak) + egy table elembõl állnak. + Ennek magában kell foglalnia legalább egy + csoportot jelölõ tgroup elemet, + amely (tulajdonságként) megadja, hogy benne + mennyi oszlop található. Ezekben a csoportokban + aztán a thead elemmel + fejlécet adhatunk meg az egyes oszlopoknak, illetve + azok törzseit pedig tbody elemek + specifikálják. + + A tgroup és + thead elemek egyaránt tartalmaznak + row elemeket, amelyek pedig + entry elemekre bonthatóak + tovább. Mindegyik ilyen entry elem + a táblázat egy celláját + jelöli. + + + Az <sgmltag>informaltable</sgmltag> elem + + A használat módja: + + + + + + ]]>Ez az elsõ oszlop fejléce + ]]>Ez a második oszlop fejléce + + + + + + ]]>Elsõ oszlop, elsõ sor + ]]>Második oszlop, elsõ sor + + + + ]]>Elsõ oszlop, második sor + ]]>Második oszlop, második sor + + + +]]> + + Így jelenik meg: + + + + + + Ez az elsõ oszlop fejléce + Ez a második oszlop fejléce + + + + + + Elsõ oszlop, elsõ sor + Második oszlop, elsõ sor + + + + Elsõ oszlop, második sor + Második oszlop, második sor + + + + + + + Az informaltable elemek esetén a + pgwide tulajdonságot mindig az + 1 értékkel használjuk, + ellenkezõ esetben az Internet Explorer egyik + hibája miatt a táblázat nem fog rendesen + megjelenni. + + Amennyiben nem szeretnénk keretet a + táblázathoz, állítsuk az + informaltable elem frame + tulajdonságát a none + értékre (vagyis <informaltable + frame="none">). + + + A <literal>frame="none"</literal> típusú + táblázat + + Így jelenik meg: + + + + + + Ez az elsõ oszlop fejléce + Ez a második oszlop fejléce + + + + + + Elsõ oszlop, elsõ sor + Második oszlop, elsõ sor + + + + Elsõ oszlop, második sor + Második oszlop, második sor + + + + + + + + + Példák mûveletekre + + Rengetegszer elõfordulhat, hogy az olvasónak + valamilyen módon be kell mutatnunk miként kell egy + bizonyos feladatot megoldania a rendszerben. Ezek a + példák általában valamilyen + párbeszédet jelentek a + számítógéppel: az olvasó + begépel egy parancsot, amelyre kap egy választ, + majd begépel egy újabb parancsot és + így tovább. + + Ilyen helyzetek több különbözõ + elem és egyed alkalmazható. + + + + A screen elem + + + Az olvasó a példával + kapcsolatos információkat a elsõsorban + képernyõrõl kapja, ennek + jelölésére használjuk a + screen elemet. + + A screen elemeken belül + számít a szöveg + tördelése. + + + + + A prompt elem, + &prompt.root; és + &prompt.user; egyedek + + + Az olvasó a képernyõn mindig + valamilyen promptot is látni fog (ez lehet az + operációs rendszer, a + parancsértelmezõ vagy az adott + alkalmazás). Ezt a prompt + elemmel tudjuk jelölni. + + Az egyszerû felhasználó és + a rendszergazda számára két + külön egyed létezik a parancssori + promptok jelölésére. Amikor + tehát az olvasónak egy paranccsorban kell + tevékenykednie, akkor a + &prompt.root; vagy a + &prompt.user; egyedek + valamelyikét használjuk. Ezeket nem kell + prompt elembe tenni. + + + A &prompt.root; és + &prompt.user; egyedek nem + részei az eredeti DocBook DTD-nek, + csupán a &os; kiterjesztései. + + + + + + A userinput elem + + + A példában az olvasó + által begépelendõ részeket + tegyük userinput elemekbe. Ez + az olvasó felé + valószínûleg majd + másképpen jelenik meg. + + + + + + A <sgmltag>screen</sgmltag>, <sgmltag>prompt</sgmltag> + és <sgmltag>userinput</sgmltag> elemek + + A használat módja: + + &prompt.user; ls -1 +ize1 +ize2 +ize3 +&prompt.user; ls -1 | grep ize2 +ize2 +&prompt.user; su +Password: +&prompt.root; cat ize2 +]]>Ez lenne az 'ize2' nevû állomány.]]> + + Így jelenik meg: + + &prompt.user; ls -1 +ize1 +ize2 +ize3 +&prompt.user; ls -1 | grep ize2 +ize2 +&prompt.user; su +Password: +&prompt.root; cat ize2 +Ez lenne az 'ize2' nevû állomány. + + + + Annak ellenére, hogy a példában + szerepeltettük az ize2 + állomány tartalmát, + nem a programlisting + elemmel jelöltük. A + programlisting elemeket inkább + állományrészletek + jelölésében alkalmazzuk, + függetlenül az olvasó + részérõl várt + mûveletektõl. + + +
+ + + Belsõ elemek + + + Az információ kiemelése + + Az egyes szavak vagy kifejezések + kiemeléséhez alkalmazzuk az + emphasis elemet. Ennek + hatására a kiemelt szövegrész + dõlten, esetleg félkövéren jelenik + meg, illetve a különbözõ felolvasó + szoftverek más hangsúlyozással + mondják el. + + A kiemelt szövegrészek tényleges + megjelenését nem tudjuk befolyásolni, nem + tekinthetõ egyenlõnek a HTML b + és i elemeivel. Ha fontos + információt kívánunk + közölni, akkor az emphasis + helyett érdemesebb inkább az + important elem használatát + megfontolni. + + + Az <sgmltag>emphasis</sgmltag> elem + + A használat módja: + + ]]>A &os; az Intel architektúrán kétség kívül + <emphasis>a</emphasis> legjobb UNIX-szerû operációs rendszer.]]> + + Így jelenik meg: + + A &os; az Intel architektúrán + kétség kívül a + legjobb UNIX-szerû operációs + rendszer. + + + + + Idézetek + + Ha más dokumentumokból vagy + forrásból akarunk idézni a szövegben, + esetleg valamire csak képletesen szeretnénk + utalni, akkor használjuk a quote + elemet. A quote elemen belül a + legtöbb jelölõ elérhetõ a + szövegben. + + + Idézetek + + A használat módja: + + ]]>Arra viszont ügyeljünk, hogy hogy a keresési rend ne lépje át a + <quote>helyi és nyilvános adminisztráció között meghúzódó + határt</quote>, ahogy azt az RFC 1535 nevezi.]]> + + Így jelenik meg: + + Arra viszont ügyeljünk, hogy hogy a + keresési rend ne lépje át a helyi + és nyilvános adminisztráció + között meghúzódó + határt, ahogy azt az RFC 1535 nevezi. + + + + + Billentyûk, egérgombok és azok + kombinációja + + A billentyûzeten egy adott billentyûre a + keycap elem + segítségével tudunk hivatkozni. Ugyanezt + a lehetõséget az egér gombjaira + vonatkozóan a mousebutton elem + nyújta. A billentyûk és egérgombok + együttes használatát pedig a + keycombo elemmel tudjuk + jelölni. + + A keycombo elemnek van egy + action (tevékenység) + nevû tulajdonsága, amely lehet + click (kattintás), + double-click (kettõs + kattintás), other (egyéb), + press (nyomva tartás), + seq (egymás utáni), illetve + simul (együttes használat). Az + utóbbi két értékkel + jelölhetjük, hogy a megadott billentyûket vagy + gombokat egymás után esetleg egyszerre kell + lenyomnunk. + + Az elemben felsorolt billentyûk és gombok + nevei közé a stíluslapok automatikusan + beillesztik a megfelelõ összekapcsoló + szimbólumot, például a + + jelet. + + + Billentyûk, egérgombok és azok + kombinációja + + A használat módja: + + ]]>A második virtuális terminálra az <keycombo + action="simul"><keycap>Alt</keycap><keycap>F1</keycap></keycombo> + billentyûkombinációval tudunk + átváltani. + +]]>A <command>vi</command> programból úgy tudunk mentés nélkül kilépni, ha begépeljük a <keycombo + action="seq"><keycap>Esc</keycap><keycap>:</keycap> + <keycap>q</keycap><keycap>!</keycap></keycombo> sorozatot. + +]]>Az ablakkezelõt most úgy állítottuk be, hogy az <keycombo + action="simul"><keycap>Alt</keycap> + <mousebutton>jobb</mousebutton></keycombo> egérgomb segítségével + tudjuk mozgatni az ablakokat.]]> + + Így jelenik meg: + + A második virtuális terminálra az + AltF1 + billentyûkombinációval tudunk + átváltani. + + A vi programból úgy + tudunk mentés nélkül kilépni, ha + begépeljük az Esc: q! + sorozatot. + + Az ablakkezelõt most úgy + állítottuk be, hogy az Alt jobb + egyérgomb segítségével tudjuk + mozgatni az ablakokat. + + + + + Alkalmazások, parancsok, kapcsolók + és man hivatkozások + + Nem szokatlan az igény, hogy a + dokumentáció írása során + gyakran szeretnénk hivatkozni alkalmazásokra + és parancsokra egyaránt. A két fajta + elem közti különbség egyszerû: az + alkalmazás az adott feladatot + megvalósító programcsomag (vagy program) + neve, miközben a parancs konkrétan annak a + programnak a neve, amelyet az olvasó futtatni + tud. + + Mindezek mellett alkalmanként + szükségünk lehet arra, hogy a parancs + által várt egy vagy több paramétert + valamilyen módon felsoroljuk. + + Végül hozzátesszük, hogy sokszor + szükségünk lehet a parancsokat a + hozzájuk tartozó man oldalakkal együtt + hivatkozni, a UNIX típusú + kézikönyvek megszokott + parancs(szám) + jelölésben. + + Az alkalmazások neveit az + application elemmel tudjuk + jelölni. + + Ha egy parancsot a hozzátartozó man oldallal + együtt akarunk hivatkozni (amire + valószínûleg az esetek nagy + többségében szükségünk is + lesz), akkor az ennek megfelelõ Docbook elem a + citerefentry lesz. Ez további + két elemet tartalmaz, ezek a + refentrytitle és a + manvolnum. A + refentrytitle tartalma a parancs neve, + illetve a manvolnum lesz a + hozzátartozó man oldal megfelelõ + szekciója. + + Az iménti jelölések írása + esetenként nehézkesnek bizonyulhat, ezért + ennek megkönnyítésére + létrehoztunk általános egyedeket. + Az egyedek + &man.man-oldal.man-szekció; + alakban érhetõek el. + + Ezeket az egyedeket a + doc/share/sgml/man-refs.ent + állományban találjuk meg, amelyre a + következõ formális publikus + azonosító segítségével + tudunk hivatkozni: + + PUBLIC "-//FreeBSD//ENTITIES DocBook Manual Page Entities//EN" + + Ezért tehát a dokumentumunk elején + minden bizonnyal szerepelni fog egy ilyen sor: + + <!DOCTYPE book PUBLIC "-//FreeBSD//DTD DocBook V4.1-Based Extension//EN" [ + +<!ENTITY % man PUBLIC "-//FreeBSD//ENTITIES DocBook Manual Page Entities//EN"> +%man; + +… + +]> + + A command elemmel a parancsok neveit + tudjuk a szövegben hivatkozni közvetlenül, az + olvasó által begépelendõ + formában. + + Az option elem + segítségével a parancsok + számára megadható kapcsolókat + jelölhetjük. + + Amikor többször ugyanarra a parancsra + hivatkozunk egymáshoz viszonylag közel, a + &man.parancs.szekció; + típusú jelölést érdemes csak + az elsõ hivatkozásnál alkalmazni, a + többi inkább legyen egyszerûen csak + command elemben. Az ebbõl + készített kimenet, különösen a + HTML esetében így kinézetében + sokkal olvashatóbb. + + A jelölési megoldások közti + választás ettõl függetlenül + idõnként nem mindig egyértelmû, de + remélhetõleg a következõ példa + segít ebben. + + + Alkalmazások, parancsok és + kapcsolók + + A használat módja: + + ]]>A <application>sendmail</application> az egyik legelterjedtebb + levelezõ alkalmazás UNIX rendszereken. + +]]>A <application>sendmail</application> alkalmazás részei a + <citerefentry> + <refentrytitle>sendmail</refentrytitle> + <manvolnum>8</manvolnum> + </citerefentry>, &man.mailq.1; és &man.newaliases.1; + programok. + +]]>A <citerefentry> + <refentrytitle>sendmail</refentrytitle> + <manvolnum>8</manvolnum> + </citerefentry> egyik kapcsolója a <option>-bp</option>, amellyel a + levelezési sorban található üzenetek aktuális állapotát kérdezhetjük + le. Ezt a <command>sendmail -bp</command> parancs kiadásával tehetjük + meg.]]> + + Így jelenik meg: + + A sendmail az egyik + legelterjedtebb levelezõ alkalmazás UNIX + rendszereken. + + A sendmail alkalmazás + részei a + sendmail + 8 + , &man.mailq.1; és &man.newaliases.1; + programok. + + A + sendmail + 8 + egyik kapcsolója a + , amellyel a levelezési sorban + található üzenetek aktuális + állapotát kérdezhetjük le. Ezt a + sendmail -bp parancs + kiadásával tehetjük meg. + + + + Figyeljük meg, hogy a + &man.parancs.szekció; + jelölés mennyivel könnyebben + olvasható. + + + + + Állományok, könyvtárak, + kiterjesztések + + Amikor állományok neveire, + könyvtárakra, esetleg kiterjesztésekre + akarunk hivatkozni, használjunk a + filename elemeket. + + + A <sgmltag>filename</sgmltag> elem + + A használat módja: + + ]]>A kézikönyv magyar változatának SGML forrása a <filename + class="directory">/usr/doc/hu_HU.ISO8859-2/books/handbook/</filename> + könyvtárban található. Ebben a könyvtárban a + <filename>book.sgml</filename> lesz a fõ forrásállomány. Mellette + láthatunk még egy <filename>Makefile</filename> állományt és több + <filename>.ent</filename> kiterjesztéssel rendelkezõ + állományt.]]> + + Így jelenik meg: + + A kézikönyv magyar + változatának SGML forrása a /usr/doc/hu_HU.ISO8859-2/books/handbook + könyvtárban található. Ebben a + könyvtárban a book.sgml lesz + a fõ forrásállomány. Mellette + találhatunk még egy + Makefile állományt + és több .ent + kiterjesztéssel rendelkezõ + állományt. + + + + + A portok nevei + + + A &os; kiterjesztése + + Ezek az elemek a &os; DocBookhoz készített + kiterjesztéseinek részei, az eredeti DocBook + DTD-ben nem szerepelnek. + + + Esetenként szükségünk lehet a &os; + Portgyûjteményében található + bizonyos programok nevének + megemlítésére a + dokumentációban. Ezt a + filename elem role + tulajdonságának a package + értékre állításával + tehetjük meg. Mivel a Portgyûjtemény + tetszõleges helyre telepíthetõ, ezért + mindig csak a port kategóriáját és + nevét adjuk meg, a /usr/ports + rész elhagyásával. + + + A <sgmltag>filename</sgmltag> elem és a + <literal>package</literal> role együttes + használata + + A használat módja: + + ]]>A hálózati forgalom figyeléséhez telepítsük a <filename + role="package">net/ethereal</filename> portot.]]> + + Így jelenik meg: + + A hálózati forgalom + figyeléséhez telepítsük a net/ethereal portot. + + + + + Eszközök + + + A &os; kiterjesztése + + Ezek az elemek a &os; DocBookhoz készített + kiterjesztéseinek részei, az eredeti DocBook + DTD-ben nem szerepelnek. + + + Az eszközök hivatkozását + két módon jelölhetjük. Az eszközre + hivatkozhatunk a /dev + könyvtárban megjelenõ neve szerint, vagy + pedig a rendszermagbeli neve szerint. Ez utóbbi + esetben használjuk a devicename + jelölést. + + Néha elõfordulhat, hogy nincs + választási lehetõségünk. + Bizonyos eszközök, például a + hálózati kártyákhoz nem tartozik + semmilyen bejegyzés a /dev + könyvtárban, esetleg az ott megjelenõ + nevük teljesen eltér. + + + A <sgmltag>devicename</sgmltag> elem + + A használat módja: + + ]]>A &os; rendszermagjában a <devicename>sio</devicename> + eszközöket a soros vonali kommunikációra használjuk. A + <devicename>sio</devicename> eszközök az idõk során több különbözõ + alakban jelentek meg a <filename>/dev</filename> könyvtárban, például + <filename>/dev/ttyd0</filename> és <filename>/dev/cuaa0</filename> + néven. + +]]>Ezzel szemben a hálózati eszközök, mint például az + <devicename>ed0</devicename> nem jelennek meg a + <filename>/dev</filename> könyvtárban. + +]]>Az MS-DOS rendszerekben az elsõdleges hajlékonylemezes meghajtót + az <devicename>a:</devicename> néven érhetjük el, miközben &os; + alatt ennek a neve <filename>/dev/fd0</filename>.]]> + + Így jelenik meg: + + A &os; rendszermagjában a + sio eszközöket a soros + vonali kommunikációra használjuk. A + sio eszközök az idõk + során több különbözõ alakban + jelentek meg a /dev + könyvtárban, például + /dev/ttyd0 és + /dev/cuaa0 néven. + + Ezzel szemben a hálózati + eszközök, mint például az + ed0 nem jelennek meg a + /dev könyvtárban. + + Az MS-DOS rendszerekben az elsõdleges + hajlékonylemezes meghajtót az + a: néven + érhetjük el, miközben &os; alatt ennek a + neve /dev/fd0. + + + + + Hálózati nevek, tartományok, + IP-címek és így tovább + + + A &os; kiterjesztése + + Ezek az elemek a &os; DocBookhoz készített + kiterjesztéseinek részei, az eredeti DocBook + DTD-ben nem szerepelnek. + + + A vonatkozó információ + jellegétõl függõen a + hálózatba kapcsolt + számítógépek + azonosítására szolgáló + adatatokat többféle módon is jelölni + tudjuk. Minden esetben a hostid elemre + fogunk támaszkodni, amely role + tulajdonságával tudjuk megválasztani a + jelölt információ + típusát. + + + + Nem szerepel a role + tulajdonság vagy + role="hostname" + + + A role tulajdonság + megadása nélkül (vagyis az elem + hostid/hostid + alakú) a jelölt információ egy + hálózati név, mint + például freefall vagy + disznohal. Ugyanezt explicit + módon a role="hostname" + hozzáadásával tudjuk + jelölni. + + + + + role="domainname" + + + Az elem tartalma egy tartomány nevét + jelöli, mint például + FreeBSD.org vagy + inf.elte.hu. Ekkor nincs benne + konkrét hálózati név. + + + + + role="fqdn" + + + Az elem tartalma egy teljes hálózati + név, amely már tartalmaz + tartománynevet és hálózati + nevet. + + + + + role="ipaddr" + + + Az elem egy IP-címet jelöl, négy, + pontokkal tagolt szám + formájában. + + + + + role="ip6addr" + + + Az elem egy IPv6 formátumú + IP-címet jelöl. + + + + + role="netmask" + + + Az elem tartalma egy hálózati maszk, + amelyet megadhatunk pontokkal elválasztott + számokkal, hexadecimális + számjegyekkel vagy a / + szimbólumot követõen egy + számmal. + + + + + role="mac" + + + Az elemben egy Ethernet MAC-címet adtunk meg, + kétjegyû hexadecimális számok + kettõspontokkal tagolt sorozataként. + + + + + + A <sgmltag>hostid</sgmltag> elem és a + különbözõ role + értékek + + A használat módja: + + ]]>A gépünk mindig elérhetõ <hostid>localhost</hostid> néven, + amelyhez a <hostid role="ipaddr">127.0.0.1</hostid> IP-cím + tartozik. + +]]>A <hostid role="domainname">FreeBSD.org</hostid> tartomány több + különbözõ gépet foglal magában, többek közt a <hostid + role="fqdn">freefall.FreeBSD.org</hostid> és <hostid + role="fqdn">pointyhat.FreeBSD.org</hostid> címeket. + +]]>Amikor egy interfészhez IP-álnéveket társítunk (az + <command>ifconfig</command> paranccsal), akkor ehhez + <emphasis>mindig</emphasis> a <hostid + role="netmask">255.255.255.255</hostid> hálózati maszkot adjuk meg + (amelyet <hostid role="netmask">0xffffffff</hostid> formában is + írhatunk). + +]]>A MAC-cím az összes létezõ hálózati eszközt egyértelmûen + azonosítja. A MAC-címek általában a <hostid + role="mac">08:00:20:87:ef:d0</hostid> címhez hasonlóak.]]> + + Így jelenik meg: + + A gépünk mindig elérhetõ + localhost néven, amelyhez a 127.0.0.1 IP-cím tartozik. + + A FreeBSD.org + tartomány több különbözõ + gépet foglal magában, többek közt a + freefall.FreeBSD.org és + pointyhat.FreeBSD.org + címeket. + + Amikor egy interfészhez + IP-álnéveket társítunk (az + ifconfig paranccsal), akkor ehhez + mindig a 255.255.255.255 + hálózati maszkot adjuk meg (amelyet 0xffffffff formában is + írhatunk). + + A MAC-cím az összes létezõ + hálózati eszközt egyértelmûen + azonosítja. A MAC-címek + általában a 08:00:20:87:ef:d0 címhez + hasonlóak. + + + + + Felhasználói nevek + + + A &os; kiterjesztése + + Ezek az elemek a &os; DocBookhoz készített + kiterjesztéseinek részei, az eredeti DocBook + DTD-ben nem szerepelnek. + + + Ha felhasználókra (például + root vagy bin) kell + hivatkoznunk a szövegben, használjuk a + username elemet. + + + A <sgmltag>username</sgmltag> elem + + A felhasználás módja: + + ]]>A rendszerünk karbantartásával kapcsolatos legtöbb feladatot + kizárólag csak a <username>root</username> felhasználóval tudjuk + elvégezni.]]> + + Így jelenik meg: + + A rendszerünk karbantartásával + kapcsolatos legtöbb feladatot kizárólag + csak a root + felhasználóval tudjuk elvégezni. + + + + + A <filename>Makefile</filename> + állományokkal kapcsolatos + jelölések + + + A &os; kiterjesztése + + Ezek az elemek a &os; DocBookhoz készített + kiterjesztéseinek részei, az eredeti DocBook + DTD-ben nem szerepelnek. + + + A Makefile állományok + egyes részeinek jelöléséhez a + maketarget és + makevar elemeket tudjuk + használni. + + A maketarget azokat a + Makefile állományokban + megadott fordítási célokat + azonosítja, amelyeket a make + paramétereként lehet használni. A + makevar pedig azokat a (környezetben, + a make hívásakor vagy a + Makefile állományon + belül definiált) változókat + azonosítja, amelyekkel a fordítás + folyamát lehet szabályozni. + + + A <sgmltag>maketarget</sgmltag> és a + <sgmltag>makevar</sgmltag> elemek + + A használat módja: + + ]]>A <filename>Makefile</filename> állományokban két igen gyakori cél + az <maketarget>all</maketarget> és a + <maketarget>clean</maketarget>. + +]]>Az <maketarget>all</maketarget> megadásakor általában + újrafordítjuk az alkalmazást, a <maketarget>clean</maketarget> + megadásakor pedig eltávolítjuk a fordítás közben keletkezett + ideiglenes állományokat (például az <filename>.o</filename> + állományokat). + +]]>A <maketarget>clean</maketarget> viselkedését számos változó + befolyásolja, többek közt a <makevar>CLOBBER</makevar> és a + <makevar>RECURSE</makevar>.]]> + + Így jelenik meg: + + A Makefile + állományokban két igen gyakori + cél az all és a + clean. + + Az all megadásakor + általában újrafordítjuk az + alkalmazást, a clean + megadásakor pedig eltávolítjuk a + fordítás közben keletkezett ideiglenes + állományokat (például az + .o állományokat). + + A clean + viselkedését számos változó + befolyásolja, többek közt a + CLOBBER és a + RECURSE. + + + + + Formázatlan szöveg + + Sokszor lehet szükségünk + formázatlan szövegekre a + dokumentáció írása közben. + Ilyen szöveg jellemzõ módon egy valamelyik + másik állományból átvett + részlet, vagy amelyet magából a + dokumentációból kell szó szerint + átmásolni egy állományba. + + Néhány esetben a korábban már + bemutatott programlisting pontosan + elegendõ ehhez a feladathoz. Azonban ez a + jelölési módszer nem minden esetben + megfelelõ, különösen olyan helyzetekben, + amikor az állomány egy részét + magába a bekezdésbe akarjuk tenni. + + Ilyen alkalmakkor használjuk a + literal elemet. + + + A <sgmltag>literal</sgmltag> elem + + A használat módja: + + ]]>A rendszermag konfigurációs állományában a + <literal>maxusers 10</literal> sor határozza meg különbözõ + rendszerszintû táblázatok méretét, és ezáltal ad egy durva becslést + arra, hogy a rendszerünk mennyi bejelentkezést lesz képes egyszerre + kezelni.]]> + + Így jelenik meg: + + A rendszermag konfigurációs + állományában a maxusers 10 + sor határozza meg különbözõ + rendszerszintû táblázatok + méretét, és ezáltal ad egy durva + becslést arra, hogy a rendszerünk mennyi + bejelentkezést lesz képes egyszerre + kezelni. + + + + + Az olvasó által + <emphasis>kötelezõen</emphasis> kitöltendõ + részek jelölése + + Minden bizonnyal lesznek olyan részek a + dokumentációban, ahol meg szeretnénk + mutatni az olvasónak mit kell csinálnia, esetleg + hivatkozni akarunk egy állomány nevére + vagy egy parancsra stb., viszont nem közvetlenül a + megadott nevet kell bemásolnia, hanem + önmagától kell kipótolnia egy + sémát. + + Pontosan ilyen eshetõségekre + találták ki a replaceable + elemet. Más elemeken belül + használva olyan részeket tudunk vele + megjelölni, amelyeket az olvasónak kell + kitöltenie. + + + A <sgmltag>replaceable</sgmltag> elem + + A használat módja: + + &prompt.user; man ]]>parancs]]> + + Így jelenik meg: + + + &prompt.user; man parancs + + + A replaceable több + különbözõ elemen belül is + alkalmazható, egyik ilyen a + literal. Ebben a példában + azt is megmutatjuk, hogy a replaceable + elembe ténylegesen csak azt a részt kell + tennünk, amelyet az + olvasónak kell hozzátennie, rajta + kívül semmi mást nem kell + megváltoztatnia. + + A használat módja: + + ]]>A rendszermag konfigurációs állományában a <literal>maxusers <replaceable>n</replaceable></literal> sor határozza + meg különbözõ rendszerszintû táblázatok méretét, és ezáltal ad egy + durva becslést arra, hogy a rendszerünk mennyi bejelentkezést + lesz képes egyszerre kezelni. + +]]>Asztali munkaállomások esetén az n helyére írhatjuk például a <literal>32</literal> + értéket.]]> + + Így jelenik meg: + + A rendszermag konfigurációs + állományában a maxusers + n + sor határozza meg különbözõ + rendszerszintû táblázatok + méretét, és ezáltal ad egy durva + becslést arra, hogy a rendszerünk mennyi + bejelentkezést lesz képes egyszerre + kezelni. + + Asztali munkaállomások esetén az + n helyére írhatjuk + például a 32 + értéket. + + + + + Hibaüzenetek idézése + + Olykor szükségünk lehet a &os; + által jelzett hibák jelölésére. + A hibák során keletkezõ pontos + hibaüzeneteket tegyük errorname + elemekbe. + + + Az <sgmltag>errorname</sgmltag> elem + + A használat módja: + + Panic: cannot mount root]]> + + + Így jelenik meg: + + + Panic: cannot mount root + + + + + + + Képek + + + A dokumentációban a képek + használatának támogatása jelen + pillanatban még csak kísérleti + jellegû. Az itt leírt ismeretek + valószínûleg nem fognak változni, de + nem szavatoljuk. + + A különféle képformátumok + közti átalakításokhoz még + telepítenünk kell a graphics/ImageMagick portot. Ez egy + nagy méretû port és a legtöbb + részére nincs is konkrétan + szükségünk, viszont jelentõsen meg tudja + könnyíteni a dolgunkat, amikor + Makefile állományokkal + és egyéb infrastrukturális elemekkel + dolgozunk. Ez a port nem része a + textproc/docproj + metaportnak, külön kell egyedileg + telepítenünk. + + A képek használatára talán a + legjobb példát a + doc/en_US.ISO8859-1/articles/vm-design + szolgáltatja. Ha tehát nem + értenénk teljesen a szakaszban leírtakat, + nézzük meg ezt az állományt + és a gyakorlatban is látni fogjuk hogyan + kapcsolódnak össze az felhasznált elemek. + Ne restelljünk kísérletezgetni a + különbözõ formázási + stílusokkal, így láthatjuk miként + jelennek meg a jelölt képek a formázott + kimenetben. + + + + Képformátumok + + Jelenleg kétféle képformátum + támogatott. A beillesztendõ kép + jellegétõl függ, hogy ezek közül + ténylegesen melyiket kell majd használnunk a + dokumentumban. + + Az alapvetõen vektoros szerkezetû + képeket, mint például a + hálózati kapcsolatokat bemutató + diagramokat, idõvonalakat és ehhez + hasonlókat Encapsulated Postscript formátumban + érdemes ábrázolnunk. Gondoskodjunk + róla, hogy ezek a képek + .eps kiterjesztéssel + rendelkezzenek. + + A raszteres képeket, mint például a + képernyõ elmentett tartalmát Portable Network + Graphic formátumban készítsük el. + Figyeljünk rá, hogy az ilyen típusú + képek kiterjesztése mindig + .png legyen. + + Ezek tehát + kizárólagosan azok a + formátumok, amelyek bekerülhetnek a + repositoryba. + + A képekhez mindig válasszuk a megfelelõ + formátumot, teljesen elfogadott a + dokumentációban az EPS és PNG + formátumú képek vegyes + alkalmazása. A Makefile + állományok gondoskodni fognak a képek + formátumuknak megfelelõ szabályos + feldolgozásáról. Ugyanazt a + képet a repositoryban ne tároljuk el mind a + két formátumban! + + + A Dokumentációs Projekt + elõreláthatólag a jövõben majd a + vektoros képek + ábrázolására a Scalable Vector + Graphic (SVG) formátumot fogja használni, + azonban jelenleg még nem állnak + rendelkezésre olyan SVG szerkesztõk, amelyek ezt + a gyakorlatban is hatékonnyá + tennék. + + + + + Jelölések + + A képek jelölése viszonylag + egyszerû. Elõször is + készítsünk egy + mediaobject elemet. A + mediaobject elembe ezután + további, pontosabban specifikáló + objektumokat helyezhetünk el. Most két ilyen + elemmel foglakozunk, ezek az imageobject + és a textobject. + +Egy imageobject és két + textobject elemet kell megadnunk. Az + imageobject a beilleszteni + kívánt kép nevére fog hivatkozni + (kiterjesztés nélkül). A + textobject elemekben olyan + információ szerepel, amelyet az olvasó a + kép mellett vagy éppen helyett fog látni + a dokumentumban. + + Ilyen két esetben fordulat elõ: + + + + A dokumentum HTML változatát olvassuk. + Ekkor minden képhez szükség van + még egy helyettesítõ szövegre, + amelyet a kép betöltõdésekor + láthatunk, vagy amikor az egérmutatót + a kép felé visszük. + + + + A dokumentumot nyers szöveges formátumban + olvassuk. Ekkor a kép ASCII karakterekbõl + kirakott változatát kellene látnia az + olvasónak. + + + + Egy példán keresztül mindez + valószínûleg sokkal könnyebben + érthetõvé válik. Tegyük + tehát most fel, hogy van egy abra1 + nevû képünk, amelyet szeretnénk + betenni a dokumentumba. Ez a kép egy A betût + ábrázol egy téglalapban. A + hozzátartozó jelölés a + következõ lesz: + + <mediaobject> + <imageobject> + <imagedata fileref="abra1"> + </imageobject> + + <textobject> + <literallayout class="monospaced">+---------------+ +| A | ++---------------+</literallayout> + </textobject> + + <textobject> + <phrase>Egy kép</phrase> + </textobject> +</mediaobject> + + + + Helyezzünk el egy imagedata + elemet az imageobject elembe. A + fileref tulajdonságban kell + megadnunk kiterjesztés nélkül a + képhez tartozó állomány + nevét. A stíluslapok maguktól + megállapítják a neki megfelelõ + kiterjesztést. + + + + Az elsõ textobject elemben + szerepelnie kell egy literallayout + elemnek, ahol a class + tulajdonság értéke + monospaced legyen. Itt tudjuk + megmutatni milyen jól tudunk ASCII karakterekkel + rajzolni. Ezt a dokumentum nyers szöveges + változatának + elõállításakor fogjuk + felhasználni. + + A literallayout elem + belsejének elsõ és utolsó + sorában megfigyelhetjük, hogy + közvetlenül a szöveges ábra mellett + kezdõdnek, így garantálhatjuk, hogy + semmilyen további felesleges szóköz nem + jelenik meg a generált változatban. + + + + A második textobject elemben + egy phrase elemnek kell lennie. Ennek + tartalma lesz a HTML változatban a képhez + tartozó alt tulajdonság + értéke. + + + + + + A <filename>Makefile</filename> + felépítése + + A Makefile + állományokban az IMAGES + változóban kell felsorolnunk a dokumentumhoz + tartozó képeket. Ebben a + változóban kell megadnunk a képek + forrását. Tehát + például, ha van három + ábránk, név szerint az + abra1.eps, abra2.png + és abra3.png, akkor ennek + megfelelõen a Makefile + állománynak a következõ sorokat + kellene tartalmaznia: + + … +IMAGES= abra1.eps abra2.png abra3.png +… + + vagy + + … +IMAGES= abra1.eps +IMAGES+= abra2.png +IMAGES+= abra3.png +… + + A Makefile magától el + fogja készíteni a dokumentum + lefordításához szükséges + képek teljes listáját, nekünk + egyedül tehát csak azokat a képeket kell + megadnunk, amelyeket mi + készítettünk. + + + + Képek és fejezetek + alkönyvtárakban + + Nem árt óvatosnak lennünk, amikor a + dokumentumunkat kisebb állományokra bontjuk + szét (lásd ) több + különbözõ + alkönyvtárban. + + Tegyük fel, hogy van egy három fejezetbõl + álló könyvünk, ahol az egyes fejezeteket + a saját könyvtáraikban tároljuk: + fejezet1/fejezet.sgml, + fejezet2/fejezet.sgml és + fejezet3/fejezet.sgml. Ha az egyes + fejezetekhez képeket akartunk társítani, + akkor javasolt ezeket a fejezetek + alkönyvtárába + (fejezet1, fejezet2, + fejezet3) tennünk. + + Ekkor azonban ne felejtsük el, hogy a + Makefile állomány + IMAGES változójában + és az imagedata + elemekben is a könyvtárak neveivel együtt + kell hivatkoznunk a képekre. + + Például a + fejezet1/abra.png kép + esetében a fejezet1/fejezet.sgml + állományban a következõt kell + megadnunk: + + <mediaobject> + <imageobject> + <imagedata fileref="fejezet1/abra1"> + </imageobject> + + … + +</mediaobject> + + + + A könyvtár nevét is meg kell adnunk + a fileref tulajdonságban. + + + + Az ennek megfelelõ Makefile + állomány tartalma: + + … +IMAGES= fejezet1/fejezet1.png +… + + Ezzel már minden remekül + mûködik. + + + + + Hivatkozások + + + A hivatkozások is belsõ elemek. + + + + Hivatkozás ugyazon a dokumentumon + belül + + A dokumentum belül úgy tudunk + hivatkozásokat készíteni, ha + egyrészt megadjuk honnan hivatkozunk (tehát + szükségünk lesz egy olyan elemre, amelyre az + olvasó kattinthat vagy megjelölhetõ a + hivatkozás forrásaként), + másrészt megadjuk hova hivatkozunk (tehát + a célt). + + A DocBook összes eleme rendelkezik egy + id tulajdonsággal, amelyben az adott + elem adott példányához tudunk kapcsolni + egy egyedi azonosítót. + + Ezt az értéket kell megadnunk a + hivatkozás forrásának + megjelölésekor. + + Általában tehát amikor fejezeteket + vagy szakaszokat hivatkozunk, érdemes felvennünk + hozzájuk egy id + tulajdonságot. + + + Az <literal>id</literal> tulajdonság + fejezeteknél és szakaszoknál + + + ]]>Bevezetés<![ CDATA [ + + ]]>Ez a bevezetés. Ebben szerepel egy szintén azonosítóval + rendelkezõ alszakasz. + + + ]]>Elsõ alszakasz<![ CDATA [ + + ]]>Ez az alszakasz. + +]]> + + + A dokumentáció írásakor + nyilván ennél beszédesebb + azonosítókat lesz majd érdemes + kitalálnunk. Mindig ügyeljünk arra, hogy az + azonosítóknak egyedieknek kell lenniük a + dokumentumban (tehát nem csak az adott + állományon, hanem a teljes dokumentum + belül). Figyeljük meg hogyan képeztük a + példában az alszakasz id + tulajdonságát a fejezet id + tulajdonságának + értékébõl. Ezzel szavatoltuk az + azonosító egyediségét. + + Ha a dokumentum valamelyik közbensõ + elemére (jellemzõen egy bekezdés vagy egy + példa közepére) akarunk hivatkozni, akkor + használjuk az anchor elemet. Ennek + az elemnek nincs tartalma, azonban rendelkezik + id tulajdonsággal. + + + Az <sgmltag>anchor</sgmltag> elem + + ]]>Ebben a bekezdésben elrejtettünk egy <anchor + id="bekezd">hivatkozás forrását. Ez a dokumentumban nem fog + látszani.]]> + + + Ha a dokumentum egy id + tulajdonsággal rendelkezõ részére + szeretnénk létrehozni egy hivatkozást + (amelyet például kattintással el lehet + érni), akkor használjuk az + xref vagy link + elemeket. + + Mind a két imént említett elemnek van + egy linkend tulajdonsága. Ennek az + értéke lényegében ugyanaz lesz, + amelyet a hivatkozás forrásában az + id tulajdonság + értékének megadtunk (nem + számít, hogy ez szerepelt-e már a + dokumentumban a hivatkozás helye elõtt, mert + elõre és visszafele is lehet hivatkozni). + + Az xref elem használatakor a + hivatkozás szövege magától jön + létre, nem tudjuk befolyásolni. + + + Az <sgmltag>xref</sgmltag> elem + + Tegyük fel, hogy felbukkan a következõ + szövegrészlet valahol a dokumentumban, amely + hivatkozik a korábbi id + tulajdonságot bemutató példánk + azonosítóira: + + ]]>A témával kapcsolatos részleteket az + <xref linkend="fejezet1"> foglalja össze. + +]]>További részleteket pedig a <xref linkend="fejezet1-szakasz1"> tár + fel.]]> + + Ekkor tehát a hivatkozás szövege + magától létrejön, így a + következõ szöveget kapjuk (a + kiemelt rész jelzi a + hivatkozás szövegét): + +
+ A témával kapcsolatos részleteket + az Elsõ fejezet foglalja + össze. + + További részleteket pedig az + Elsõ alszakasz tár + fel. +
+
+ + Figyeljük meg hogyan képezõdött a + fejezet számából vagy a szakasz + címébõl a megfelelõ + hivatkozás. + + + Az iméntiekbõl következik, hogy az + xref elemmel nem + lehet anchor elemek + id tulajdonságaira hivatkozni. Az + anchor elemben nincs semmi, ezért + az xref nem képes + magától létrehozni hozzá a + hivatkozás szövegét. + + + Ha szeretnénk kézzel megadni a + hivatkozások szövegét, akkor + használjuk a link elemet, amelynek a + tartalmában szerepeltethetjük ezt. + + + A <sgmltag>link</sgmltag> elem + + Tegyük fel, hogy a következõ + szövegrészlet jelenik meg valahol a + dokumentumnkban, és az id + tulajdonságot bemutató példában + definiált azonosítókra + hivatkozik. + + ]]>Errõl bõvebb tájékoztatást <link linkend="fejezet1">az elsõ + fejezetben</link> kapunk. + +]]>Errõl a részrõl pedig <link linkend="fejezet1-szakasz1">ebben</link> a szakaszban olvashatunk + többet.]]> + + Ez a következõképpen jelenik meg (ahol + a kiemelt szövegek jelzik a + hivatkozásokat magukat): + +
+ Errõl bõvebb + tájékoztatást az elsõ + fejezetben kapunk. + + Errõl a részrõl pedig + ebben a szakaszban olvashatunk + többet. +
+
+ + + Ez utóbbi nem teljesen egy jó + példa. Lehetõleg ne ebben vagy + itt néven hivatkozzunk, mert az + olvasó így nem fogja közvetlenül + látni, hogy az adott hivatkozás pontosan hova + is viszi. + + + + A link elemmel már + tudunk hivatkozni + anchor elemek id + tulajdonságaira, hiszen a link + elemben már megadható a hivatkozás + szövege. + +
+ + + A Világhálón található + dokumentumok hivatkozása + + A külsõ dokumentumok hivatkozása + valamennyivel könnyebb a belsõ hivatkozások + használatánál, mivel ehhez csak annyit + kell tudunk, milyen címre akarunk mutatni. Erre az + ulink elem alkalmas. Rendelkezik egy + url tulajdonsággal, amelyben a + hivatkozni kívánt oldal címét kell + megadnunk. Az elem belsejében pedig a + hivatkozás olvasó felé megjelenõ + szövegét adhatjuk meg. + + + Az <sgmltag>ulink</sgmltag> elem + + A használat módja: + + ]]>Természetesen már most felhagyhatunk a dokumentum olvasásával és + helyette megnézhetjük a <ulink + url="&url.base;/index.html">&os; honlapját</ulink>.]]> + + Így jelenik meg: + + Természetesen már most felhagyhatunk a + dokumentum olvasásával és helyette + megnézhetjük a &os; honlapját. + + +
+ + + + diff --git a/hu_HU.ISO8859-2/books/fdp-primer/sgml-primer/chapter.sgml b/hu_HU.ISO8859-2/books/fdp-primer/sgml-primer/chapter.sgml new file mode 100644 index 0000000000..0b0f9b72fb --- /dev/null +++ b/hu_HU.ISO8859-2/books/fdp-primer/sgml-primer/chapter.sgml @@ -0,0 +1,2126 @@ + + + + + + SGML alapismeretek + + Az FDP keretében készített + dokumentációk többsége az SGML valamilyen + alkalmazásában íródik. Ebben a + fejezetben részletesebben kifejtjük a mögötte + álló fogalmakat, a dokumentumok alapjául + szolgáló források + megértését és + írását, illetve a dokumentáció + forrásainak tanulmányozása során + elõkerülõ különféle + SGML-trükköket. + + A bemutatás alapjául szolgáltak Mark + Galassi Get Going With DocBook + címû írásának egyes + részei. + + + Áttekintés + + A kezdeti idõkben még viszonylag könnyen el + lehetett boldogulni az elektronikus formában tárolt + szövegekkel. Elegendõ volt csupán annyit tudni., + hogy az adott írást milyen + karakterkódolással készítették + (ez lehetett ASCII, EBCDIC vagy éppen valami más). + A szöveg nem volt több mint egyszerû szöveg, + és közvetlenül a végleges + formáját adta. Semmi csel, semmi + formázás, semmi hozzáadott + értelem. + + Ezen a fokon aztán elkerülhetetlen módon + tovább kellett lépni. Hiszen ha egyszer a + szöveges információkat egy + számítógép által kezelhetõ + alakban tároljuk, akkor jogosan elvárhatjuk, hogy az + képes legyen felhasználni és + értelmesen feldolgozni. Szeretnénk a szöveg + bizonyos részeit például kiemelni, felvenni + egy szójegyzékbe, vagy éppen + hivatkozással ellátni. Az állományok + neveit a képernyõn + írógépszerû, a + nyomtatásban viszont már + dõltbetûs stílusban + szeretnénk látni, nem is beszélve a + szöveg megjelenésének számtalan + egyéb módjáról. + + Egy idõben a Mesterséges Intelligencia (MI) + megjelenésétõl várták a + megváltást ezen a területen. A + számítógépünk majd szépen + beolvassa az általunk írt dokumentumot és + magától felismeri a fontosabb kulcsszavakat, + állományneveket, a felhasználó + által begépelendõ szövegeket, a + példákat és így tovább. + Sajnálatosan azonban a valóságban ez + még egyáltalán nem valósult meg, a + számítógépeknek ezért + szükségünk van némi + segítségre a szöveges adatok értelmes + feldolgozásában. + + Pontosabban úgy fogalmazhatnánk, hogy + segítenünk kell nekik az egyes elemek + beazonosításában. Nézzük meg + például ezt a szöveget: + +
+ Az &man.rm.1; parancs használatával + töröljük a /tmp/ize + állományt: + + &prompt.user; rm /tmp/ize +
+ + Emberi szemmel könnyedén fel tudjuk ismerni benne + az állományneveket, a parancsokat, a man oldalak + hivatkozásait és így tovább, azonban a + számítógép erre + önállóan nem képes. Ezért lesz + szükségünk jelölõkre. + + A jelölõ szó eredetijét + (markup) gyakran olyan értelemben használják + mint haszonkulcs vagy kockázati + pótlék. Kevés + elvonatkoztatással ugyanez lényegében + alkalmazható a szövegek esetében is. A + jelölõk a dokumentumban szereplõ + kiegészítõ, hasznos, az + azonosítás kockázatát + csökkentõ, a szöveg többi + részétõl egyértelmûen + megkülönböztethetõ további + szöveges információkat jelentik. Ezek + alapján a programok a dokumentumok feldolgozása + során képesek önállóan meghozni + bizonyos döntéseket. A szövegszerkesztõk el + tudják rejteni ezeket a + többletinformációkat az olvasók + elõl, így azok egyáltalán nem + zavarják õket. + + A jelölõkben tárolt adatok tehát + növelik a dokumentumok hasznát. A + jelölõk hozzáadását, a szöveg + bejelölését értelemszerûen emberek + végzik, hiszen ha erre a + számítógépek is képesek + lennének, akkor nem is lenne rájuk + egyáltalán szükség. Ezzel azonban + pótlékot kell nyújtanunk + (vagyis további költségeket + ráfordítanunk) a dokumentumok + megírásához. + + Az elõzõ példában szereplõ + szöveget ennek megfelelõen a következõ + módon írjuk meg: + + Az &man.rm.1; parancs használatával + töröljük a /tmp/ize + állományt: + +&prompt.user; rm /tmp/ize]]> + + Láthatjuk, hogy a jelölõk nagyon jól + elkülöníthetõek a szöveg + tartalmától. + + A jelölõk használatához + nyilvánvalóan valamilyen módon meg kell + határoznunk, hogy az adott jelölõk mit jelentenek + és hogyan kell azokat értelmezni. A + jelölõk összefogásához tehát + szükségünk van egy ún. + jelölõnyelvre, amely alapján aztán + jelölni fogjuk a dokumentumainkat. + + Ehhez természetesen egyetlen jelölõnyelv + önmagában még nem feltétlenül lesz + elég. A szaknyelven íródott + dokumentációkhoz igazított + jelölõnyelvvel szemben teljesen másak az + elvárásaink, mint például a receptek + leírásához használt nyelv + esetében, ez pedig megint más, mint amivel verseket + tudunk jelölni. Elõször tehát egy olyan + nyelvet kell megfogalmaznunk, amely ilyen jelölõnyelvek + elõírására használható. + Ezt nevezzük a jelölõnyelvek + jelölõnyelvének, vagyis a + meta-jelölõnyelvnek. + + Az SGML, avagy Standard Generalized Markup + Language (Szabványos + Általánosított Jelölõnyelv) + pontosan egy ilyen nyelv. Számos jelölõnyelv + készült az SGML segítségével, + többek közt az FDP által leginkább + használt HTML és DocBook. + + Az egyes nyelvek részletes + leírását hivatalosan + dokumetumtípus-definíciónak + (Documentum Type Definition, + DTD) nevezik. A DTD + felhasználásával adhatjuk meg a + szövegben jelölõként alkalmazható + elemeket, azok sorrendjét (vagy éppen + egymásba ágyazhatóságának + mikéntjét) és a hozzájuk + kapcsolódó egyéb információkat. + A DTD-ket gyakran csak úgy említik mint az SGML + alkalmazásait. + + A DTD tartalmazza az + összes felhasználható elem + leírását, azok használatának + sorrendjét, megadja, hogy ezek közül melyeknek + kell szerepelniük, illetve melyek hagyhatóak el + és így tovább. Ennek + köszönhetõen készíthetõ egy + olyan SGML alapján mûködõ + elemzõ, amely a DTD és egy + dokumentum birtokában képes + megállapítani, hogy az adott dokumentum megfelel-e a + DTD által meghatározott szabályoknak: a benne + szereplõ elemek a megfelelõ sorrendben vannak, esetleg + tartalmaznak hibákat. Ezt a lépést nevezik + általában a dokumentum + érvényesítésének. + + + Az ellenõrzés folyamán egyszerûen + annyi történik, hogy az elemzõ a megadott DTD + alapján jóváhagyja a dokumentumban + feltüntetett elemeket, azok rendezettségét + és a többit. A jelölõk + helyes használatát azonban + nem vizsgálja. Ha éppen + függvénynévként jelöljük be + a szövegben megjelenõ állományok neveit, + akkor az elemezõ ezt nem fogja hibának tekinteni + (ekkor természetesen feltételezzük, hogy a + DTD definiálja az állomány- és + függvénynevek jelölésére alkalmas + elemeket, illetve ezek ugyanazokon a helyeken + szerepelhetnek). + + + A Dokumentációs Projekt számára + beküldött munkáinkban jó eséllyel a + HTML vagy a DocBook nyelvek valamelyike szerint kell + dokumentumokat megjelölnünk, és nem kell a DTD + módosításával foglalkoznunk. + Ennélfogva ez a leírás sem tér ki a + DTD írásának részleteire. +
+ + + Elemek, címkék és + tulajdonságok + + Az SGML használatával készített + dokumentumtípus-definíciók mindegyikének + vannak közös jellemzõi. Ez viszont aligha lesz + számunkra meglepõ, ahogy majd fokozatosan + megismerkedünk az SGML kialakítása + mögött álló alapvetõ gondolatokkal. + Ezek közül a legkézenfekvõbbek a + tartalom és az + elem. + + A dokumentáció minden esetben (legyen az most + egy normál honlap vagy éppen egy vaskos könyv) + rendelkezik valamilyen tartalommal, amelyet aztán + tovább (esetleg még tovább) osztunk elemekre. + A jelölõk elhelyezésének ezen elemek + határainak kijelölésében és + elnevezésében van szerepe a feldolgozás + késõbbi szakaszaiban. + + Ehhez példaként tekintsünk egy + hagyományos könyvet. A legfelsõ szinten ez a + könyv önmagában egy elemet képvisel. Ez a + könyv elem aztán magától + értetõdõ módon tartalmaz fejezeteket, + amelyek szintén önálló elemeknek + tekinthetõek. Minden ilyen fejezet további elemeket + foglal magában, például bekezdéseket, + idézeteket és lábjegyzeteket. Minden egyes + bekezdésben találhatunk újabb elemeket, + amelyek elárulják nekünk, hogy a bennük + szereplõ szövegben melyik részében + beszélnek egymással a szereplõk, vagy + éppen hogy hívják az egyes + karaktereket. + + Az egészet úgy képzelhetjük el mint + a tartalom feldarabolását. A + legfelsõ szinten adott egy darab, maga a könyv. Ahogy + haladunk kicsivel lentebb, újabb darabokat találunk, + a fejezeteket. Ezeket aztán tovább bomlanak + bekezdésekre, lábjegyzetekre, a karakterek neveire + és a többi. + + Meglepõ, hogy az SGML lehetõségeinek + igénybevétele nélkül milyen könnyen + különbséget tudunk tenni az egyes elemek + közt. Ehhez valójában elegendõ a + könyv nyomtatott változata, néhány + különbözõ színû kiemelõ, + amelyekkel aztán bejelöljük a tartalom egyes + részeit. + + Sajnos a kiemelõknek nem létezik elektronikus + változata, ezért találnunk kell valamilyen + egyéb módot a tartalom egyes részeinek + megjelölésére. Az SGML-ben megfogalmazott + nyelvek (HTML, DocBook és társaik) ezt + címkékkel oldják + meg. + + A címkékkel mondhatjuk meg hol kezdõdnek + és hol fejezõdnek be az egyes elemek. A + címke nem az elem része. Mivel a DTD + általában azért készül, hogy a + szövegben adott típusú + információkat tudjunk jelölni, adott + típusú elemeket fog elfogadni, ezért ezeknek + megfelelõen kell címkéket + létrehoznunk. + + Egy elem elemhez tartozó + kezdõcímke általános alakja az + elem. Az + hozzátartozó zárócímke pedig az + /elem. + + + Elem (kezdõ- és + zárócímkék) használata + + A HTML-ben a bekezdéseket a p + (mint paragrafus) elemmel jelölhetjük. Ehhez az elemhez + tartozik kezdõ- és + zárócímke. + + ]]>Ez egy bekezdés. A 'p' elem kezdõcímkéjétõl indul és a 'p' + zárócímkéjénél fejezdõdik be. + +

]]>Ez meg egy másik bekezdés. Ez viszont már rövidebb.]]> + + + Nem mindegyik elemnél kell + zárócímkét használnunk, egyes + elemekhez ugyanis nem járul semmilyen tartalom. + Például egy HTML állományban + jelölhetjük, hogy legyen a dokumentumban egy + vízszintes elválasztó. Ehhez a vonalhoz + értelemszerûen nem kapcsolódik tartalom, + ezért elég egy kezdõcímkét + beszúrni. + + + Elem (csak kezdõcímke) + használata + + A HTML-ben van egy hr nevû elem, + amellyel vízszintes elválasztókat (horizontal + rule) jelölhetünk. Ennek az elemnek nincs tartalma, + ezért csak kezdõcímkével + rendelkezik. + + ]]>Ez itt egy bekezdés. + +


+ +

]]>Ez pedig egy másik bekezdés. Az elõzõ bekezdéstõl egy vízszintes + vonal választja el.]]> + + + Ha eddig még nem sejtettük volna, + megemlítjük, hogy az elemek természetesen + elemeket is tartalmazhatnak. A korábbi könyves + példánkban a könyv elem magában foglalta + az összes fejezet elemet, amelyek pedig a bekezdés + elemeket és így tovább. + + + Elemek elemekben, az <sgmltag>em</sgmltag> elem + + ]]>Ez egy egyszerû ]]>bekezdés]]>, amelyben néhány ]]>szót]]> + szépen ]]>kiemeltünk.

]]>
+
+ + A DTD pontosan tartalmazza mely elemek tartalmazhatnak + további elemeket, valamint az elemek egymásba + ágyazhatóságának + szabályait. + + + Az emberek gyakran összetévesztik a + címkéket az általuk jelölt elemekkel, + és egymás szinonímájaként + használják ezeket a kifejezéseket. Ez + viszont helytelen. + + A dokumentumokat elemekbõl építjük + fel. Minden elem elõre meghatározott módon + kezdõdik és fejezõdik be. Az elemek + kezdetét és végét + címkék jelölik. + + Amikor ez a dokumentum (vagy bárki, az SGML + használatában járatos személy) + a p címkére + hivatkozik, akkor ez alatt a <, + p, > karakterekbõl + álló sorozatot érti. Ezzel szemben viszont + a p a teljes elemre + vonatkozik. + + Ez egy nagyon kicsi + eltérés, de mindig tartsuk észben! + + + Az elemeknek lehetnek tulajdonságaik. A + tulajdonságokat nevek és értékek + párosai alkotják, segítségükkel + az elemhez fejthetünk ki további + információkat. Ez lehet az adott elem által + jelölt tartalom megjelenítésére + vonatkozó utasítás, esetleg az elem + valamilyen azonosítója vagy valami + más. + + Az elemek tulajdonságait mindig az adott elem kezdőcímkéjén + belül soroljuk fel, + tulajdonság="érték" + alakban. + + A HTML újabb változataiban például + a p elemnek van egy align + tulajdonsága, amely a HTML megjelenítése + során javasolja, hogy az általa jelölt + bekezdést merre igazítsuk. + + Ez az align tulajdonság négy + elõre meghatározott érték + valamelyikét kaphatja meg: left (balra + zárt), center (középre + zárt), right (jobbra zárt) + és justify (sorkizárt). Ha nem + adjuk meg a tulajdonság értékét a + kezdõcímkében, akkor + alapértelmezés szerint left + lesz. + + + Tulajdonság használata elemben + + ]]>Az 'align' tulajdonság ebben a bekezdésben igazából + teljesen felesleges, hiszen alapértelmezés szerint is balra zárt + lenne.]]> + +]]>Ennek viszont már középre kellene kerülnie.]]> + + + Egyes tulajdonságok csak adott értékeket + vehetnek fel, mint például left + vagy justify, másoknál viszont + lényegében bármit megadhatunk. Ha a + tulajdonság értékének + megfogalmazása során idézõjeleket + (") is használni akarunk, akkor az + egész kifejezést tegyük egyszeres + idézõjelbe. + + + A tulajdonságok értékének + megadása egyszeres idézõjellel + + ]]>Jobbra zárt!]]> + + + Elõfordulhat, hogy az érték + megadásakor egyáltalán nem kell semmilyen + idézõjelet használni. Ennek szabályai + viszont nagyon halványak, ezért sokkal + egyszerûbb mindig idézõjelbe + tenni a tulajdonságok értékeit. + + Az elemekhez, címkékhez és + tulajdonságokhoz tartozó információk + SGML katalógusokban kerülnek tárolásra. + A Dokumentációs Projektben használt + eszközök ilyen katalógusok mentén + nézik át a munkánkat. A textproc/docproj csomagban a + segédprogramok mellett rengeteg ilyen + SGML-katalógust találhatunk. A &os; + Dokumentációs Projektnek is vannak saját + katalógusai. Az alkalmazott eszközöknek mind a + két fajta katalógusokat ismerniük kell. + + + Egy kis gyakorlás… + + A szakaszban szereplõ példák + kipróbálásához + telepítenünk kell bizonyos szoftvereket, illetve + beállítani egy környezeti + változó értékét. + + + + Töltsük le és telepítsük a + textproc/docproj portot a + &os; Portgyûjteményébõl. Ez + portoknak a portja, tehát egy + metaport, így a + Dokumentációs Projektben használt + összes eszköz rajta keresztül + letöltõdik és + telepítõdik. + + + + A parancssorunk konfigurációs + állományában állítsuk be az + SGML_CATALOG_FILES környezeti + változó értékét. + (Amennyiben nem az angol nyelvû + dokumentációval dolgozunk, itt érdemes + a nyelvünknek megfelelõ könyvtárakat + megadni.) + + + Minta <filename>.profile</filename> + állomány &man.sh.1; és &man.bash.1; + parancssorokhoz + + SGML_ROOT=/usr/local/share/sgml +SGML_CATALOG_FILES=${SGML_ROOT}/jade/catalog +SGML_CATALOG_FILES=${SGML_ROOT}/docbook/4.1/catalog:$SGML_CATALOG_FILES +SGML_CATALOG_FILES=${SGML_ROOT}/html/catalog:$SGML_CATALOG_FILES +SGML_CATALOG_FILES=${SGML_ROOT}/iso8879/catalog:$SGML_CATALOG_FILES +SGML_CATALOG_FILES=/usr/doc/share/sgml/catalog:$SGML_CATALOG_FILES +SGML_CATALOG_FILES=/usr/doc/en_US.ISO8859-1/share/sgml/catalog:$SGML_CATALOG_FILES +export SGML_CATALOG_FILES + + + + Minta <filename>.cshrc</filename> + állomány &man.csh.1; és &man.tcsh.1; + parancssorokhoz + + setenv SGML_ROOT /usr/local/share/sgml +setenv SGML_CATALOG_FILES ${SGML_ROOT}/jade/catalog +setenv SGML_CATALOG_FILES ${SGML_ROOT}/docbook/4.1/catalog:$SGML_CATALOG_FILES +setenv SGML_CATALOG_FILES ${SGML_ROOT}/html/catalog:$SGML_CATALOG_FILES +setenv SGML_CATALOG_FILES ${SGML_ROOT}/iso8879/catalog:$SGML_CATALOG_FILES +setenv SGML_CATALOG_FILES /usr/doc/share/sgml/catalog:$SGML_CATALOG_FILES +setenv SGML_CATALOG_FILES /usr/doc/en_US.ISO8859-1/share/sgml/catalog:$SGML_CATALOG_FILES + + + A módosítások + elvégzése után vagy jelentkezzük ki + majd be, vagy pedig adjuk ki a közvetlenül + parancssorban az adott parancsokat. + + + + + + Hozzunk létre egy + próba.sgml nevû + állományt, és írjuk bele az + alábbi szöveget: + + + + + + ]]>Próba HTML állomány<![ CDATA [ + + + +

]]>Ebben a bekezdésben legyen valamennyi szöveg. + +

]]>Az utána következõ bekezdésbe is rakjunk még valamennyi szöveget. + +

]]>Ennek a bekezdésnek jobbra zártnak kellene lennie. + +]]> + + + + Próbáljuk meg az állományt + érvényesíteni valamelyik SGML + elemezõvel. + + A textproc/docproj + csomagnak része az nsgmls + nevû érvényesítést végzõ elemezõ. + Az nsgmls beolvas egy tetszõleges + SGML DTD szerint definiált elemekkel jelölt + dokumentumot és ebbõl elkészíti a + hozzátartozó + elemstruktúra-információs halmazt + (Element Structure Information Set, ESIS, de ezzel itt most + nem foglalkozunk). + + Ha viszont az nsgmls parancsnak + megadjuk a paramétert, akkor nem + generál tényleges eredményt, + csupán a hibaüzenetek jeleníti meg. + Ennek köszönhetõen könnyen + ellenõrizni tudjuk, hogy az általunk + készített dokumentum érvényes + vagy sem. + + Az nsgmls parancs + használatával tehát + ellenõrizzük az imént létrehozott + dokumentumunk + érvényességét: + + &prompt.user; nsgmls -s próba.sgml + + Láthatjuk, hogy az nsgmls nem + jelez semmiféle hibát, ami azt jelenti, hogy a + dokumentumunk valóban érvényes. + + + + Nézzük meg mi történik akkor, ha + kihagyjuk a kötelezõ elemeket. + Töröljük például a + title és /title + címkéket, majd próbáljuk meg + újra az + érvényesítést. + + &prompt.user; nsgmls -s próba.sgml +nsgmls:próba.sgml:5:4:E: character data is not allowed here +nsgmls:próba.sgml:6:8:E: end tag for "HEAD" which is not finished + + Az nsgmls által + generált hibaüzenetek kettõspontokkal + tagolt csoportokba vagy oszlopokba + sorolhatóak. + + + + + + Oszlop + Jelentés + + + + + + 1 + A hibát jelzõ program neve. Ez + minden esetben az nsgmls. + + + + 2 + A hibát tartalmazó + állomány neve. + + + + 3 + A hibát tartalmazó sor + száma. + + + + 4 + A hibát tartalmazó oszlop + száma. + + + + 5 + A generált üzenet jellegét + megadó egybetûs kód. Az + I információt, a + W figyelmeztetést, az + E hibát + + Ez nem minden esetben az ötödik + oszlopban szerepel. Az nsgmls + -sv például az + nsgmls:I: SP version "1.3" + üzenetet adja vissza (a tényleges + verziójától + függõen). Ez például + egy információs + üzenet. + , végül pedig az + X a kereszthivatkozást + jelez. Ebbõl + megállapítható, hogy az + iménti üzenetek hibákra + vonatkoznak. + + + + 6 + Az üzenet szövege. + + + + + + Egyedül a title címke + elhagyásával két + különbözõ hibát kaptunk. + + Ezek közül az elsõ jelzi, hogy az SGML + elemzõ olyan helyen találkozott tartalommal (amely + ebben esetben konkrétan karaktereket jelent és + nem az elemet bevezetõ kezdõcímkét), + ahol valami másra számított. Az + elemzõ itt ugyanis valamelyik, a + head elemen belül szabályosan + elhelyezhetõ elem + kezdõcímkéjét várja + (amilyen például a + title). + + A második hibát pedig azért kaptuk, + mert a head elemeknek tartalmazniuk + kell title elemet. + Az nsgmls ezt azonban nem ebben a + formában közli: mivel az elemet még a + befejezõdése (tehát a + title megemlítése) + elõtt lezártuk, szerinte egyszerûen csak + nem ért véget rendesen. + + + + Tegyük vissza a title + elemet. + + + + + + + A DOCTYPE deklarációk + + A dokumentumok elején mindig meg kell adni annak a + dokumentípus-deklarációnak a nevét, + amely alapján készítjük. Ennek + köszönhetõen az SGML elemzõk elõ + tudják keresni a dokumentum + érvényesítéséhez kellõ + DTD-t. + + Ezt az információt általában + egyetlen sorban, a DOCTYPE deklarációban adjuk + meg. + + A HTML DTD 4.0 változatának megfelelõ + dokumentumokat tehát például így + vezetjük be: + + ]]> + + Ebben a sorban több különbözõ + típusú alkotórészt fedezhetünk + fel. + + + + <! + + + Ez egy jelzés, amellyel + jelezzük egy SGML-beli deklaráció + kezdetét. Ez a sor a dokumentum + típusát határozza meg. + + + + + DOCTYPE + + + A dokumentumtípus SGML-beli + deklarációját vezeti be. + + + + + html + + + A dokumentumban elsõként megjelenõ + elemet + nevezi meg. + + + + + PUBLIC "-//W3C//DTD HTML 4.0//EN" + + + formális publikus + azonosító + + + + Megadja a dokumentum DTD-jéhez tartozó + formális publikus azonosítót + (Formal Public Identifier, + FPI). Az SGML elemzõ ennek + alapján találja meg a dokumentum + feldolgozása során szükséges + DTD-t. + + A PUBLIC nem része az + azonosítónak, azonban segít az SGML + elemzõnek megtalálni a benne megfogalmazott + DTD-t. Késõbb + további módszereket is láthatunk majd + erre. + + + + + > + + + A deklaráció + lezárása. + + + + + + Formális publikus azonosítók + + + formális publikus + azonosító + + + + Ebben a szakaszban csupán + kiegészítõ ismeretek szerepelnek. Ezek + viszont hasznos hátteret adhatnak például + olyan esetekben, amikor ki akarjuk deríteni, hogy az + SGML feldolgozó miért nem éri el a + megadott DTD állományokat. + + + A formális publikus azonosítók (FPI) + egy speciális felírással rendelkeznek, amely + a következõ: + + "Tulajdonos//Kulcsszó Leírás//Nyelv" + + + + Tulajdonos + + + Ez határozza meg kihez tartozik az FPI. + + Ha az értéke az ISO + részlettel kezdõdik, akkor az FPI az ISO + tulajdona. Például a "ISO + 8879:1986//ENTITIES Greek Symbols//EN" + esetén a görög szimbólumokat + tartalmazó egyedkészlet tulajdonosa. Az ISO + 8879:1986 az SGML szabvány ISO száma. + + Minden más esetben az értéke a + következõ alakú lesz: + -//Tulajdonos + vagy + +//Tulajdonos + (vegyük észre, hogy a két + változat csak a sor elején levõ + + és - + jelekben tér el). + + Ha az érték a - + jellel kezdõdik, akkor a tulajdonos adatai nem + regisztráltak, a + + esetében pedig regisztráltak. + + Az ISO 9070:1991 szabvány definiálja a + regisztrált nevek + elõállítását, amelynek + értelmében egy ISO publikáció, + egy ISBN kód vagy az adott szervezet ISO 6523 + szabványnak megfelelõ kódjának + számából kell származtatni, + illetve a nevek kiosztását egy erre + felhatalmazott szerv végzi. Ezt a feladatot az + Amerikai Nemzeti Szabványügyi Intézetre + (ANSI) bízta az ISO tanácsa. + + Mivel a &os; Projekt nem regisztrálta + magát, a hozzátartozó + érték tehát a + -//&os; lesz. Látható + egyébként, hogy a W3C sem + regisztrálta még magát. + + + + + Kulcsszó + + + Az állományban található + információ típusának + megadására különbözõ + kulcsszavak használhatóak. Ezek + általában a DTD, + ELEMENT, ENTITIES + és TEXT. A + DTD csak DTD + állományokhoz használatos, az + ELEMENT pedig olyan DTD + részletekhez, amelyekeben csak egyedek vagy elemek + leírásai találhatóak. A + TEXT SGML tartalmat jelent + (szövegeket és jelölõket). + + + + + Leírás + + + Minden egyéb adat, amit az + állomány tartalmáról még + meg akarunk adni. Tartalmazhat + verziószámokat, vagy bármilyen + számunkra értelmes és az SGML + rendszer számára egyedien + azonosítható rövid + szöveget. + + + + + Nyelv + + + Kétkarakteres, ISO szabvány szerint + megadott kód, amellyel az állomány + natív nyelvét adjuk meg. Az angol + esetében ez az EN. + + + + + + Katalógusok + + Az SGML feldolgozónak a dokumentum + feldolgozása során valamilyen módon az + így megadott formális publikus + azonosítóból vissza kell tudnia fejtenie + a DTD-t tartalmazó állomány + nevét. + + Mindehhez egy katalógusra lesz + szükségünk. Ezek (amelyeket + általában catalog + néven találhatunk meg) tartalmazzák az + azonosítók és a hozzájuk + tartozó állománynevek + összerendeléseit. Például, ha egy + katalógusban a következõ sor + található: + + PUBLIC "-//W3C//DTD HTML 4.0//EN" "4.0/strict.dtd" + + Az SGML feldolgozó a catalog + állományt tartalmazó könyvtár + 4.0 alkönyvtárában + levõ strict.dtd + állományban fogja keresni az adott DTD-t. + + Nézzünk szét kicsit a + /usr/local/share/sgml/html/catalog + állományban. Ez tartalmazza a textproc/docproj portból + telepített HTML DTD-kre vonatkozó + állományinformációkat. + + + + Az <envar>SGML_CATALOG_FILES</envar> környezeti + változó + + Az SGML feldolgozónak valahogy tudnia kell hol + keresse a katalógusokat. Számos + implementációjuk parancssori + paramétereken keresztül teszi lehetõvé + a feldolgozás során használni + kívánt katalógus vagy katalógusok + felsorolását. + + Emellett az SGML_CATALOG_FILES + környezeti változó + segítségével is megadhatóak ezek + az állományok. A változó + értékének a (teljes elérési + útvonallal kifejtett) katalógusok vesszõvel + tagolt felsorolását kell + beállítani. + + Az esetek döntõ többségében a + következõ állományokat kell ilyen + módon felvennünk: + + + + /usr/local/share/sgml/docbook/4.1/catalog + + + + /usr/local/share/sgml/html/catalog + + + + /usr/local/share/sgml/iso8879/catalog + + + + /usr/local/share/sgml/jade/catalog + + + + Ezt egyébként korábban már elvégeztük. + + + + + Azonosítók helyett + + A formális publikus azonosítók + használata helyett akár közvetlenül meg is + adhatjuk a dokumentum érvényességét + definiáló DTD-t tartalmazó konkrét + állomány nevét. + + Ennek felírása némileg + eltér: + + /az/elérési/út/állomány.dtd]]> + + A SYSTEM kulcsszóval + jelezzük, hogy az SGML feldolgozó a DTD + leírását rendszerszinten keresse. Ez + általában (de nem mindig) azt jelenti, hogy a DTD + elérhetõségét + állománynév formájában adjuk + meg. + + Az FPI használata leginkább a + hordozhatóság támogatása miatt + ajánlott. Ilyenkor nem kell ugyanis a dokumentumokhoz + mellékelni a DTD egy példányát, + illetve ha a SYSTEM kulcsszóval + adnánk meg, akkor mindig az adott helyre kellene tenni a + DTD állományokat. + + + + + Visszaváltás az SGML + használatára + + Az alapismeretek tárgyalása során + már korábban szóba került, hogy az SGML + csak a dokumentumtípus-deklaráció + leírásához használatos. Ez azonban + nem tökéletesen igaz, mivel léteznek olyan + SGML-beli szerkezetek, amelyeket magukban a dokumentumokban is fel + tudunk használni. Például a dokumentumokba + beszúrhatóak az elemzõ + részérõl figyelmen kívül + hagyandó megjegyzések. Ezeket az SGML + szabályai szerint adjuk meg. A többi szerkezet + használatára kicsivel késõbb mutatunk + még példákat. + + Nyilvánvalóan valamilyen módon + jeleznünk kell az SGML feldolgozónak, hogy a soron + következõ elem tartalmát hagyja figyelmen + kívül, de az elemzõ ezt alapvetõen az SGML + alapján észleli. + + Az ilyen részeket <! … + > formában jelöljük. Az + elhatárolók között szabályos SGML + szerkezetek szerepelhetnek, pontosan olyanok, amelyeket az DTD-k + készítésénél is + alkalmaznak. + + Az elõbb bemutatott DOCTYPE deklaráció + erre éppen remek példaként + szolgálhat. + + + + Megjegyzések + + A megjegyzések tehát SGML-beli + konstrukciók, és általában csak a + DTD-ben érvényes a használatuk. A ban viszont láthattuk, + hogy az SGML szerkezetei akár a dokumentumokban is + használhatóak. + + Az SGML megjegyzéseket + -- szimbólumok + használatával határolhatjuk el. A + szimbólum elsõ elõfordulásával + kezdjük a megjegyzést és a másodikkal + zárjuk le. + + + Általános SGML megjegyzés + + <!-- próba megjegyzés --> + + Most a megjegyzés belsejében vagyunk + + + + + +]]> + + + + A két kötõjel használata + + A Postscript és PDF változatok esetén + kisebb problémák jelentkeznek ennél a + példánál, ugyanis bennük csak egyetlen + kötõjel fog látszani a <! + és > szimbólumok + mellett. + + A forráskódban azonban két + - (kötõjel) szimbólumot + kell használnunk, + nem pedig egyet. A Postscript és + PDF változatokban az eredetileg két + kötõjelet összevonják egyetlen hosszabb + kötõjellé, ezáltal elrontják az + iménti példát. + + A dokumentum HTML, szöveges és RTF + változatait ez nem érinti. + + ]]> + + Ha dolgoztunk már korábban HTML kóddal, + akkor elõfordulhat, hogy más meghatározást + láttunk a megjegyzésekre. Ezért + tévesen azt gondolhattuk, hogy a megjegyzéseket a + <!-- karaktersorozat vezeti be, és + csak a --> zárhatja le. + + Valójában viszont nem + így van. Sok böngészõ hibás HTML + elemzõt tartalmaz, ezért ezt érvényesnek + fogadják el. A Dokumentációs Projektben + használt SGML elemzõk azonban ennél sokkal + szigorúbbak és az ilyen hibás + dokumentumokat visszadobják. + + + Hibás SGML megjegyzések + + Most egy megjegyzés belsejében vagyunk + + KÍVÜL VAGYUNK A MEGJEGYZÉSEN! + + ismét megjegyzésben vagyunk ]]> + + Az SGML elemzõ ezt valahogy így fogja + értelmezni: + + <!KÍVÜL VAGYUNK A MEGJEGYZÉSEN> + + Ez nem szabályos SGML és + ráadásul félrevezetõ hibaüzenetet + eredményez. + + Ez nem szép dolog! ]]> + + A példa szövege szerint sem + javasolt ilyen megjegyzéseket írni. + + ]]> + + Ez már (valamivel) értelmesebb + megoldás, de még feláll a veszélye, + hogy megtéveszti az SGML-ben járatlan + olvasókat. + + + + Egy kis gyakorlás… + + + + Tegyünk néhány megjegyzést a + korábban készített + próba.sgml + állományunkba, majd az + nsgmls segítségével + ellenõrizzük, hogy közben + érvényes marad. + + + + Tegyünk néhány + érvénytelen megjegyzést a + próba.sgml + állományba, majd nézzük meg, hogy + az nsgmls milyen hibaüzeneteket ad + rájuk. + + + + + + + Egyedek + + Az egyedek felhasználásával neveket + tudunk rendelni a tartalom egyes darabjaihoz. Az SGML elemzõ a + dokumentum feldolgozása közben ezeket az egyedeket + megtalálja és helyükre beszúrja az + általuk hivatkozott tartalmat. + + Ezzel az SGML dokumentumokban könnyedén ki tudunk + alakítani újrafelhasználható, gyorsan + cserélhetõ tartalmat, illetve kizárólag + ezen a módon lehet jelölõkkel ellátott + SGML állományokat beletenni egy másik + hasonló SGML állományba. + + Az egyedek kétfajta típusa létezik, + amelyek mindegyike eltérõ helyzetekben + használható: ezek az + általános egyedek és a + paraméteregyedek. + + + Általános egyedek + + Általános egyedeket nem lehet SGML + környezetben használni (habár definiálni + igen), egyedül magában a dokumentumban. Vessük + össze a paraméteregyedekkel. + + Mindegyik általános egyed rendelkezik egy + névvel. Így tudunk hivatkozni egy + általános egyedre (ezáltal mindarra a + szövegre, amelyet képvisel a dokumentumunkban): + &egyednév;. + Vegyük például, hogy van egy + jelenlegi.valtozat nevû egyedünk, + amely a termékünk jelenlegi + verziószámát helyettesíti be a + szövegbe. Ezt így fogalmaznánk meg: + + ]]>A termékünk jelenlegi változata a(z) + ]]> + + Így a verziószám + változásakor egyszerûen csupán az + általános egyed definícióját + kell megváltoztatni, majd újra feldolgozni a + dokumentumot. + + Az általános egyedek + segítségével olyan karakterek is + megadhatóvá válnak, amelyeket + egyébként nem tudnánk SGML dokumentumokban + leírni. Például a < + és a & normális esetben + nem lehet része SGML dokumentumoknak. Amikor ugyanis az + SGML elemzõ egy < szimbólumot + észlel, feltételezi, hogy ezzel egy (kezdõ- + vagy záró) címke kezdõdik, illetve + amikor pedig egy & szimbólumot + talál, akkor a következõ lépésben + egy egyed nevét várja. + + Szerencsére ezek a szimbólumok a + szövegben bármikor kiválthatóak az + &lt; és + &amp; általános egyedek + használatával. + + Általános egyedek csak SGML környezetben + definiálhatóak. Ezeket általában + közvetlenül a DOCTYPE deklaráció + után sorolják fel. + + + Általános egyedek + definíciója + + + +]>]]> + + Figyeljük meg, hogy a DOCTYPE + deklarációt a sor végén egy + szögletes nyitó zárójel + elhelyezésével kibõvítettük: a + kiegészítésként felvett két + egyedet az utána következõ két sorban + definiáltuk, majd bezártuk a szögletes + zárójelet és DOCTYPE + deklarációt. + + A szögletes zárójelek + szükségesek ahhoz, hogy jelezzük a DOCTYPE + deklarációban megadott DTD további + kiegészítéseit. + + + + + Paraméteregyedek + + Az általános egyedekhez + hasonlóan a paraméteregyedek is + újrafelhasználható szövegrészek + elnevezését engedik meg. Miközben azonban az + általános egyedek csak a dokumentumokban + alkalmazhatóak, addig a paraméteregyedek csak + SGML környezetekben + használhatóak. + + A paraméteregyedek az általános + egyedekhez hasonló módon + definiálhatóak, az + &egyednév; + felírás helyett azonban az + %egyednév; + alakban tudunk rájuk hivatkozni. Továbbá a + definíciójukban az ENTITY + kulcsszó és az egyed neve közé be kell + szúrni a % (százalékjel) + szimbólumot. + + + Paraméteregyedek megadása + + valami +szöveg +más + + +]>]]> + + + Ez most még nem tûnik + különösebben hasznosnak. Késõbb + viszont majd az lesz. + + + + Egy kis gyakorlás… + + + + Tegyük bele a + próba.sgml + állományunkba a következõ + általános egyedet: + + +]> + + + + ]]>Egy minta HTML állomány<![ CDATA [ + + + + + +

]]>Ebben a bekezdésben van egy kis szöveg. + +

]]>Ez a bekezdés még tartalmaz némi szöveget. + +

]]>Ennek a bekezdésnek jobbra zártnak kellene lennie. + +

]]>A dokumentum jelenlegi változata: + +]]> + + + + Az nsgmls használatával + vizsgáltassuk meg a dokumentum + érvényességét. + + + + Töltsük be a + próba.sgml + állományt a böngészõnkbe + (elõfordulhat, hogy másolatot kell + készíteni róla + próba.html néven, mert a + böngészõnk csak így ismerné + fel HTML dokumentumként). + + Hacsak a böngészõnk nem annyira + fejlett, a dokumentumban a &valtozat; + egyedhivatkozás nem fog lecserélõdni a + verziószámra. A böngészõk + többségében nagyon primitív + elemzõk találhatóak, amelyek nem + képesek rendesen kezelni az SGML + dokumentumokat + Micsoda szégyen! Képzeljük csak + el, mennyi gondot és ügyeskedést + (mint például a szerver oldalán + beemelt állományokat) el tudnánk + kerülni, ha rendesen + támogatnák. + . + + + + A megoldást a dokumentum + normalizálása jelenti, + amelyet egy SGML normalizálóval tudunk + elvégezni. A normalizáló beolvas egy + érvényes SGML állományt + és eredményként egy szintén + érvényes, de valamilyen módon + átalakított SGML állományt + készít. Az SGML állományok + átalakításának egyik ilyen + módja a dokumentumban található + egyedhivatkozások helyettesítése az + általuk képviselt szöveggel. + + Erre a célra az sgmlnorm + használható. + + &prompt.user; sgmlnorm próba.sgml > próba.html + + Ennek hatására + próba.html néven + létrejön a dokumentum normalizált (vagyis + a kifejtett egyedhivatkozásokkal létrehozott) + változata, és most már + betölthetõ a böngészõnkbe. + + + + Ha most megnézzük az + sgmlnorm által gyártott + végeredményt, akkor tapasztalhatjuk, hogy az + elején nem szerepel DOCTYPE deklaráció. + Ezt a kapcsolóval tehetjük + hozzá: + + &prompt.user; sgmlnorm -d próba.sgml > próba.html + + + + + + + Állományok tartalmának + elérése egyedeken keresztül + + Az (általános + és paraméter-) + egyedek különösen hasznosak olyan esetekben, amikor + állományok tartalmát akarjuk beilleszteni + másik állományokba. + + + Állományok tartalmának + elérése általános egyedekkel + + Tegyük fel, hogy egy könyvön dolgozunk az + SGML felhasználásával, amelyet + fejezetenként állományokra bontottunk, + fejezet1.sgml, + fejezet2.sgml stb. néven, illetve a + könyv.sgml állomány + tartalmazza ezeket a fejezeket. + + Az állományok tartalmát a + SYSTEM kulcsszó + használatával tudjuk egyedek + értékeként megadni. Ennek + hatására az SGML elemzõ a megadott + állomány tartalmát adja az egyed + értékének. + + + Állományok tartalmának + elérése általános egyeddel + + + + + +]> + + + + + &fejezet.1; + &fejezet.2; + &fejezet.3; +]]> + + + + Amikor általános egyedeken keresztül + illesztünk be állományokat egy másik + állományba, a beillesztett + állományok (amilyen például a + fejezet1.sgml, + fejezet2.sgml és a többi) + nem kezdõdhetnek DOCTYPE + deklarációval. Ez szintaktikai hibát + eredményez! + + + + + Állományok tartalmának + elérése paraméteregyedekkel + + Emlékezzünk vissza, hogy a + paraméteregyedek csak SGML környezetben + alkalmazhatóak. Miért akarnánk + állományokat beilleszteni egy SGML + környezetbe? + + Így tudunk gondoskodni az általános + egyedek + újrafelhasználhatóságáról. + + Tegyük fel, hogy a dokumentumunkban rengeteg fejezet + található és ezeket két + különbözõ könyvben is + felhasználtuk, azonban eltérõ + stílusban. + + A könyvek elején fel lehetne sorolni az + egyedeket, de ezzel viszont gyorsan kezelhetetlenné + válnának. + + Ehelyett csak tegyünk az általános + egyedekre vonatkozó definíciókat egyetlen + állományba és a dokumentumunkban erre + építve paraméteregyedek + beiktatásával végezzük az adott + állományok beillesztését. + + + Állományok beillesztése + paraméteregyedekkel + + Elõször vegyük az egyedek + definícióit egy külön + fejezetek.ent állományba. + Ebben a következõek + találhatóak: + + + +]]> + + Most pedig hozunk létre egy paraméteregyedet + az állomány tartalmának + hivatkozására. Ezután az iménti + paraméteregyeddel illesszük be az + állományt a dokumentumba, így az + összes általános egyed + elérhetõvé válik. Innentõl + már a megszokott módon használhatjuk az + általános egyedeket: + + A fejezetekhez tartozó egyedek betöltéséhez definiálunk egy paraméteregyedet + + + +%fejezetek; +]> + + + &fejezet.1; + &fejezet.2; + &fejezet.3; +]]> + + + + + Egy kis gyakorlás… + + + Állományok beillesztése + általános egyedek + segítségével + + + + Hozzunk létre három + állományt: bekezd1.sgml, + bekezd2.sgml és + bekezd3.sgml. + + Töltsük fel ezeket valami hasonló + szöveggel: + + ]]>Ez az elsõ bekezdés.]]> + + + + Szerkesszük át a + próba.sgml + állományunk tartalmát az + alábbi módon: + + + + + +]> + + + + ]]>Próba HTML állomány<![ CDATA [ + + + +

]]>A dokumentum jelenlegi változata: + + &bekezd1; + &bekezd2; + &bekezd3; + +]]> + + + + A próba.sgml + normalizálásával hozzuk létre a + próba.html + állományt. + + &prompt.user; sgmlnorm -d próba.sgml > próba.html + + + + Nyissuk meg a böngészõnkkel a + próba.html + állományt és ellenõrizzük, + hogy a + bekezdn.sgml + állományok tartalma bekerült a + próba.html + állományba. + + + + + + Állományok beillesztése + paraméteregyedek + segítségével + + + Ehhez elõször végezzük el az + elõbbi lépéseket. + + + + + Szerkesszük át a + próba.sgml + állományt a következõeknek + megfelelõen: + + %egyedek; +]> + + + + ]]>Próba HTML állomány<![ CDATA [ + + + +

]]>A dokumentum jelenlegi változata: + + &bekezd1; + &bekezd2; + &bekezd3; + +]]> + + + + Hozzunk létre egy új + állományt egyedek.sgml + néven a következõ tartalommal: + + + + +]]> + + + + A próba.sgml + normalizálásával állítsuk + elõ a próba.html + állományt: + + &prompt.user; sgmlnorm -d próba.sgml > próba.html + + + + Nyissuk meg a böngészõnkben a + próba.html + állományt és ellenõrizzük, + hogy a + bekezdn.sgml + állományok szerepelnek a + próba.html + állományban. + + + + + + + + Jelölt szakaszok + + Az SGML tartalmaz olyan megoldást, amellyel a + dokumentum bizonyos részeit speciális + feldolgozásra jelölhetjük meg. Ezeket nevezik + jelölt szakaszoknak. + + + A jelölt szakaszok + felépítése + + <![ KULCSSZÓ [ + A jelölt szakasz tartalma. +]]> + + + A korábbiakban tapasztaltak szerint + természetesen a jelölt szakaszokat az SGML + részeként a <! + szimbólummal vezetjük be. + + Ezt követõen az elsõ szögletes + zárójel határolja el a jelölt + szakaszt. + + Az elemzõ a feldolgozás során a + KULCSSZÓ alapján + értelmezi az adott jelölt szakaszt. + + A második szögletes zárójellel + kezdõdik a jelölt szakasz tényleges + tartalma. + + A jelölt szakasz az iménti két + szögletes zárójel + lezárásával ér véget, majd a + > szimbólummal visszaváltunk + az SGML környezetbõl a dokumentum + környezetébe. + + + A jelölt szakaszok kulcsszavai + + + <literal>CDATA</literal>, <literal>RCDATA</literal> + + A kulcsszavakkal a jelölt szakasz tartalmi + modelljét tudjuk + megváltoztatni. + + Az SGML elemzõ a dokumentum feldolgozása + során tárol egy ún. tartalmi + modellt. + + Röviden úgy foglalhatnánk össze, + hogy ez a tartalmi modell írja le az elemzõ + részérõl várt + információkat és azok + feldolgozását. + + A két ilyen leghasznosabb tartalmi modell a + CDATA és az + RCDATA. + + A CDATA jelentése + Character Data, vagyis karakteres + adat. Az elemzõ ebben a tartalmi modellben + kizárólag csak karaktereket lát. Ebben a + modellben a < és + & szimbólumok + elveszítik különleges + jelentésüket. + + Az RCDATA jelentése + Entity references and character data, vagyis + egyedhivatkozások és karakteres + adatok. Ebben a tartalmi modellben az elemzõ + karakterekre és egyedekre + számít. A < + szimbólum ilyenkor elveszíti a + különleges jelentését, azonban az + & továbbra is + általános egyedek kezdetét fogja + jelölni. + + Ezek használata különösen hasznos + abban az esetben, amikor rengeteg < + és & karaktert tartalmazó + nyers szöveget akarunk beilleszteni valahova a + dokumentumba. Természetesen ez megoldható + úgy is, ha minden < + szimbólumot &lt; + karaktersorozattá, illetve minden + & szimbólumot + &amp; karaktersorozattá + alakítunk, de sokkal könnyebb ezeket a szakaszokat + CDATA típusúnak + megjelölni. Az SGML elemzõk ilyenkor tehát + figyelmen kívül hagyják a tartalomban + talált < és + & szimbólumokat. + + + A CDATA vagy + RCDATA kulcsszavakat bemutató SGML + példákkal kapcsolatban megjegyezzük, hogy + a CDATA szakaszok tartalma nem + érvényesítõdik. Az így + beillesztett SGML szöveget valamilyen más + módon kell ellenõrizni. Például + írjuk meg a karakteres szakasz tartalmát egy + másik dokumentumban, ellenõriztessük le, + majd másoljuk be a CDATA + részbe. + + + + CDATA típusú jelölt szakaszok + használata + + <para>Ebben a példában láthatjuk hogyan tudunk sok <literal>&lt;</literal> + és <literal>&amp;</literal> szimbólumot tartalmazó szöveget elhelyezni + a dokumentumunkban. A minta most egy HTML kódrészlet lesz, az ezt övezõ + szöveg (<para>) és (<programlisting>) pedig DocBook.</para> + +<programlisting> + <![ CDATA [ ]]>Ezzel a példával mutatjuk HTML elemek használatát a + dokumentumban. Mivel elég sok relációjelet kell ilyenkor megadni, + sokkal egyszerûbb azt mondani, hogy legyen az egész példa egy + CDATA szakaszban, mintsem végig egyedekkel jelöljük a balra és + jobb nyitó relációjeleket. + +

    +
  • ]]>Ez egy listaelem +
  • ]]>Ez egy másik listaelem +
  • ]]>Ez már egy harmadik listaelem +
+ +

]]>Itt a vége a példának.]]> + ]]> +</programlisting> + + Ha megnézzük a dokumentum + forrását, láthatjuk a + jelölésnél alkalmazott + megoldásokat. + + + + + <literal>INCLUDE</literal> és + <literal>IGNORE</literal> + + Az INCLUDE kulcsszó + megadásakor a jelölt szakasz teljes tartalma + feldolgozódik. Ezzel szemben viszont az + IGNORE kulcsszó esetén a + jelölt szakasz tartalmát figyelmen + kívül fogja hagyni az elemzõ és + ezáltal nem dolgozódik fel, tehát nem + jelenik meg az eredményben. + + + Az <literal>INCLUDE</literal> és + <literal>IGNORE</literal> használata jelölt + szakaszokban + + <![ INCLUDE [ + Ez a szöveg feldolgozódik és beillesztõdik. +]]> + +<![ IGNORE [ + Ez a szöveg nem dolgozódik fel és nem is illesztõdik be. +]]> + + + Ezek önmagukban nem túlzottan hasznosak, + elvégre, ha el akarunk távolítani egy + szövegrészt a dokumentumunkból, akkor vagy + egyszerûen kivágjuk, vagy megjegyzésbe + tesszük. + + Sokkal hasznosabbá válhatnak viszont a + számunkra, ha észrevesszük, hogy paraméteregyedek + segítségével mindez + vezérelhetõ. Emlékezzünk vissza, hogy + a paraméteregyedek csak SGML környezetben + használhatóak, és a jelölt + szakaszokhoz tartozó kulcsszavak + pontosan egy ilyen SGML környezetben + vannak. + + Például tegyük fel, hogy egy + dokumentáció nyomtatott és elektronikus + változatán dolgozunk egyszerre. Az elektronikus + változatban szeretnénk azonban + néhány olyan elemet is betenni, amelyeket nem + akarunk megjelentetni nyomtatásban. + + Hozzunk létre egy paraméteregyedet és + legyen az értéke INCLUDE. + Készítsük el a dokumentumot, és + jelölt szakaszokkal határoljuk el a csak az + elektronikus változat megjelenõ részeket. + Ezekben a jelölt szakaszokban a kulcsszavak + helyére írjuk be az elõbbi + paraméteregyedet. + + Amikor a dokumentumot nyomtatásra akarjuk + elõkészíteni, akkor legyen a + paraméteregyed értéke + IGNORE, majd dolgozzuk fel újra az + egész dokumentumot. + + + Jelölt szakaszok vezérlése + paraméteregyeddel + + <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [ +<!ENTITY % elektronikus.valtozat "INCLUDE"> +]]> + +... + +<![ %elektronikus.valtozat [ + Ez a rész csak a dokumentum elektronikus változatában fog megjelenni. +]]> + + A nyomtatott változat + elõkészítésekor így + állítsuk át az egyed + értékét: + + <!ENTITY % elektronikus.valtozat "IGNORE"> + + A dokumentum újbóli feldolgozása + során a jelölt szakaszok a + %elektronikus.valtozat + értékét fogják + kulcsszóként megkapni, és így + kimaradnak. + + + + + + Egy kis gyakorlás… + + + + A következõ szöveggel hozzunk + létre egy állományt + szakasz.sgml néven: + + <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [ +<!ENTITY % szoveges.kimenet "INCLUDE"> +]> + +<html> + <head> + <title>Példa a jelölt szakaszok használatára</title> + </head> + + <body> + <p>Ez a bekezdés <![ CDATA [sok-sok < + karaktert (< < < < <) tartalmaz, így érdemesebb + CDATA szakaszba tenni]]>.</p> + + <![ IGNORE [ + <p>Ez a bekezdés egyértelmûen nem fog látszódni az eredményben.</p> + ]]> + + <![ [ + <p>Ez a bekezdés nem fog feltétlenül megjelenni az eredményben.</p> + + <p>A konkrét megjelenését a + paraméteregyed értéke befolyásolja.</p> + ]]> + </body> +</html> + + + + A &man.sgmlnorm.1; használatával + normalizáljuk ezt az állományt, majd + elemezzük az eredményt. Nézzük meg + melyik bekezdések tûntek el, melyek jelentek meg + és mi történt a CDATA szakaszok + tartalmával. + + + + A szoveges.kimenet + értéke legyen INCLUDE az + IGNORE helyett. Futassuk le újra + így a normalizálást és + vizsgáljuk meg mi változott az + eredményben. + + + + + + + Befejezés + + Ezzel befejeztük az SGML alapismeretek + bemutatását. A helyigény, illetve a + bonyolultság visszaszorítása + érdekében bizonyos témákkal teljes + mélységében (vagy egyáltalán) + nem foglalkoztunk, azonban az iménti szakaszokban + elkerült SGML ismeretek elegendõek lesznek az FDP + által készített dokumentáció + megértéséhez. + + + + diff --git a/hu_HU.ISO8859-2/books/fdp-primer/structure/chapter.sgml b/hu_HU.ISO8859-2/books/fdp-primer/structure/chapter.sgml new file mode 100644 index 0000000000..1858833fed --- /dev/null +++ b/hu_HU.ISO8859-2/books/fdp-primer/structure/chapter.sgml @@ -0,0 +1,412 @@ + + + + + + A dokumentumok szervezése a <filename>doc/</filename> + könyvtáron belül + + A doc/ könyvtár tartalma egy + adott módon szervezõdik, és ennek megfelelõen + a &os; 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: + + + + leegyszerûsíteni az új dokumentum + automatikus átalakítását + különbözõ formátumokba; + + + + 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; + + + + 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. + + + A legfelsõ szint: a <filename>doc/</filename> + 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 + + Leírás + + + share/ + + 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ó &man.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 &os; kiterjesztéseit + tartalmazó DocBook DTD) a + share/sgml alkönyvtárban + helyezkednek el. + + + + nyelv.kódolá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. + + + + + + A + <filename><replaceable>nyelv</replaceable>.<replaceable>kódolás</replaceable>/</filename> + könyvtárak + + Ezek a könyvtárak tartalmazzák magukat a + dokumentumokat. A dokumentumokat ezen a szinten a + különbözõ könyvtárak neveinek + megfelelõen három vagy több + kategóriára osztjuk. + + + Könyvtár + + Tartalom + + + articles + + Az itt található dokumentumokat a DocBook + article eleme szerint (vagy egy azzal + egyenlõ megoldással) jelöltük. + Viszonylag rövid, szakaszokra osztott dokumentumokat + találhatunk itt. Általában egyetlen HTML + állományként érhetõek + el. + + + + books + + Ebben a könyvtárban a DocBook + book eleme szerint (vagy egy azzal + egyenlõ megoldással) jelöltük. + Hosszabb, fejezetekre osztott dokumentum. + Általában egyetlen nagyobb HTML + állományként (a gyors + internetkapcsolattal rendelkezõ, vagy a dokumentumot a + böngészõbõl nyomtatni + kívánó egyének + számára), illetve több kisebb + állományként együtteseként is + elérhetõ. + + + + man + + A rendszerhez tartozó man oldalak + fordításai. A lefordított szakaszoknak + megfelelõen ebben a könyvtárban egy vagy + több mann + nevû alkönyvtárat találhatunk. + + + + Nem mindegyik + nyelv.kódolás + könyvtár tartalmazza ezeket az + alkönyvtárakat. Az egyes fordítások + tartalma mindig attól függ, hogy az adott + fordítócsapatnak mennyit sikerült eddig + lefordítania. + + + + Az egyes dokumentumokkal kapcsolatos + tudnivalók + + Ebben a szakaszban a &os; Dokumentációs Projekt + keretein belül gondozott különbözõ + dokumentumokat ismerhetjük meg részletesebben. + + + A kézikönyv + + books/handbook/ + + A kézikönyv a &os; kiterjesztéseit + tartalmazó DocBook DTD szerint készült. + + A kézikönyv a DocBook book + elemének megfelelõen szervezõdik. Több + part elemmel jelölt részbõl + áll, amelyek mindegyike több + chapter elemmel jelölt fejezetet foglal + magában. Ezek a fejezetek további szakaszokra + (sect1) bomlanak, amelyek helyenként + alszakaszokra (sect2, + sect3) oszlanak, és így + tovább. + + + Fizikai szervezés + + A kézikönyv forrásai több + különbözõ állományban + és könyvtárban a + handbook könyvtáron + belül találhatóak. + + + A kézikönyv szervezése + idõrõl-idõre változik, ezért + könnyen elõfordulhat, hogy ez a dokumentum csak + kissé késve követi ezeket a + változtatásokat. Ha további + kérdéseink lennének a + kézikönyv szervezésérõl, + bátran írjunk a &a.doc; + címére! + + + + <filename>Makefile</filename> + + A Makefile + állományban definiálódnak olyan + változók, amelyek a SGML források + különbözõ formátumúra + alakításának menetét + befolyásolják, illetve hivatkozik a + kézikönyv forrásaira. Ezután + beemeli a doc.project.mk + állományt, és így + lényegében betölti a dokumentumok + átalakításáért + felelõs további + utasításokat. + + + + <filename>book.sgml</filename> + + Ez a kézikönyv legfelsõ szintû + dokumentuma. Ebben van a kézikönyv dokumentípus-deklarációja, + illetve a szerkezetét leíró + további elemek. + + A book.sgml az + .ent kiterjesztésû + állományokat paraméteregyedek + segítségével tölti be. Ezek az + állományok (amelyekrõl késõbb + még szó lesz) aztán a + kézikönyv további részeiben + használt általános + egyedeket definiálnak. + + + + <filename><replaceable>könyvtár</replaceable>/chapter.sgml</filename> + + A kézikönyv egyes fejezetei + egymástól különálló + könyvtárakban, chapter.sgml + nevû állományokban + tárolódnak. Ezeket a könyvtárakat + az adott fejezetet jelölõ + chapter id + tulajdonsága szerint szokták elnevezni. + + Például ha az egyik fejezet + forrásában a következõ sor + olvasható: + + +... +]]> + + Ekkor a chapter.sgml nevû + állományt tartalmazó könyvtár + neve kernelconfig lesz. Egy ilyen + állomány általában a teljes + fejezetet tartalmazza. + + A kézikönyv HTML változatának + készítése során ebbõl a + kernelconfig.html + állomány fog keletkezni. Ezt azonban az + id értéke határozza + meg, semmi köze nincs a könyvtár + elnevezéséhez. + + A kézikönyv korábbi + változataiban az összes forrás a + book.sgml állománnyal + volt egy szinten, és az adott + chapter elemek id + tulajdonságának megfelelõen került + elnevezésre. A könyvtárak + létrehozásával a kézikönyv + szervezésének további + átalakításait kívántuk + elõkészíteni. Itt + különösen gondolunk arra, hogy ezzel + szeretnénk lehetõvé tenni képek + hozzáadását az egyes fejezetekhez. + Véleményünk szerint sokkal több + értelme van ugyanis a képeket a fejezetek + forrásával együtt egy külön + könyvtárban tárolni, mintsem az + összes képet és szöveget egyetlen + nagy könyvtárban összeömleszteni. A + névütközés egy idõ után + úgyis elkerülhetetlenné válik, + és sok, kevés állományt + tartalmazó könyvtárral + egyébként is könnyebb dolgozni, mint egy + sok állományt tartalmazó + könyvtárral. + + A kézikönyv forrásaiban könnyen + láthatjuk, hogy sok ilyen könyvtár van, + bennük egy-egy chapter.sgml + állománnyal. Például + basics/chapter.sgml, + introduction/chapter.sgml és + printing/chapter.sgml. + + + A fejezeteket és könyvtárakat nem + szabad semmilyen sorrendiségre utaló + módon elnevezni. A fejezetek elrendezése + ugyanis változhat a kézikönyv egy + esetleges átszervezése során. Az + ilyen átszervezések során pedig + (általában) nem lenne szabad + állományokat átnevezni (hacsak + komplett fejezeteket nem mozgatunk fentebb vagy lentebb a + szerkezetben). + + + Az egyes chapter.sgml + állományok önmagukban teljes SGML + dokumentumok. Különösen azért, mert + semmilyen DOCTYPE sor nem + található az elejükön. + + Ez abból a szempontból + hátrányos, hogy ezeket az + állományokat ezért nem tudjuk + normál SGML állományokként + kezelni. Emiatt ezeket nem lehet egyszerûen, a + kézikönyvhöz hasonlóan módon + HTML, RTF, PS vagy más egyéb formátumba + átalakítani. Ezért tehát + könnyen elõfordulhat, hogy a fejezetek + megváltoztatásakor a + teljes kézikönyvet elõ + kell állítanunk. + + + + + + + + diff --git a/hu_HU.ISO8859-2/books/fdp-primer/stylesheets/chapter.sgml b/hu_HU.ISO8859-2/books/fdp-primer/stylesheets/chapter.sgml new file mode 100644 index 0000000000..aca214649e --- /dev/null +++ b/hu_HU.ISO8859-2/books/fdp-primer/stylesheets/chapter.sgml @@ -0,0 +1,124 @@ + + + + + + * Stíluslapok + + Az SGML szabvány nem rendelkezik arról, hogy a + dokumentumokat milyen módon kell megjeleníteni a + felhasználónak vagy miként kell papírra + vetni. Ennek megvalósításához több + különbözõ nyelvet hoztak létre + stílusleírások + készítéséhez, ilyen + például a DynaText, a Panorama, a SPICE, a JSSS, a + FOSI, a CSS és a DSSSL. + + A stíluslapok DocBook esetében a DSSSL, míg + a HTML esetén a CSS szabályai szerint + készülnek. + + + * DSSSL + + A Dokumentációs Projekt Norm Walsh eredeti + moduláris DocBook stíluslapjainak némileg + módosított változatát + használja. + + A moduláris stíluslapok a textproc/dsssl-docbook-modular + portból érhetõek el. + + A Projekt által használt + módosított stíluslapok nincsenek a + Portgyûjteményben. Ezeket a + Dokumentációs Projekt repositoryjában, a + doc/share/sgml/freebsd.dsl + állományban találhatjuk meg. A + megértését a benne elhelyezett rengeteg + megjegyzés segíti, és láthatjuk benne + hogyan alakították át a szabványos + stíluslapokat a &os; Dokumentációs Projekt + igényeinek megfelelõen. Ebben az + állományban további példákat + láthatunk a stíluslap által felismert elemek + bõvítésére, illetve ezek + formázásának leírására. + A fejezet elolvasása mellett tehát javasoljuk ennek + is az alapos átnézését. + + + + CSS + + A Cascading Stylesheets (CSS) egy olyan + megoldás, amellyel anélkül tudunk + különbözõ + stílusinformációkat (betûtípus, + szélesség, méret, szín és + így tovább) hozzákapcsolni egy + HTML dokumentum elemeihez, hogy errõl a dokumentumból + bármit is leírnánk. + + + DocBook dokumentumok + + A &os; DSSSL stíluslapok hivatkoznak egy + docbook.css nevû stíluslapra, + amelynek a HTML állományokkal egy + könyvtárban kell lennie. A dokumentumok HTML + változatának elkészítésekor a + doc/share/misc/docbook.css + állomány fog minden helyre magától + bemásolódni és + telepítõdni. + + + + + diff --git a/hu_HU.ISO8859-2/books/fdp-primer/the-website/chapter.sgml b/hu_HU.ISO8859-2/books/fdp-primer/the-website/chapter.sgml new file mode 100644 index 0000000000..b3ef3fa6dd --- /dev/null +++ b/hu_HU.ISO8859-2/books/fdp-primer/the-website/chapter.sgml @@ -0,0 +1,534 @@ + + + + + + A honlap + + + Elõkészületek + + A honlap elõállításához + elsõsorban elegendõ szabad területet kell + keresnünk valamelyik merevlemezünkön. Ennek + mennyisége a választott módszertõl + függõen úgy nagyjából + 200 MB-tól 500 MB-ig terjedhet. Ez a + becslés magában foglalja az SGML + eszközökhöz, a CVS + repository megfelelõ részeihez, valamint a honlap + generálásához szükséges + lemezterületet. + + + Mindig ellenõrizzük, hogy a + dokumentáció + elõállításához használt + portok frissek legyenek. Ha nem vagyunk benne biztosak, akkor a + portok telepítése elõtt a &man.pkg.delete.1; + paranccsal töröljük a korábbi + változatukat. Például ha a jade-1.2 + csomagra van szükségünk és a + rendszerünkön már megtalálható a + jade-1.1, akkor a következõt kell tennünk: + + &prompt.root; pkg_delete jade-1.1 + + + A honlap elõállításához ebben + a fejezetben most két módszert adunk meg: + + + + A csup parancs + használatával hozzuk létre és + tartsunk karban a gépünkön a források + helyi másolatát valamelyik + CVSup szerverrõl. Ez a + legegyszerûbb megoldás, mivel semmilyen + további szoftver telepítését nem + igényli. Ehhez a következõ szakaszban + megadott supfile állomány mindig a + szükséges állományok legfrissebb + változatát kéri le. Ez abban az esetben + tökéletesen megfelelõ, ha egyszerûen + csak le akarjuk generálni a honlapokat és nem + kívánunk a forrásokkal dolgozni. + + + A &man.csup.1; a &os; 6.2-RELEASE + kiadástól az alaprendszer része. + Amennyiben még a &os; egy korábbi + változatát használjuk, akkor ezt a + programot a Portgyûjteménybõl a net/csup port + telepítésével érhetjük + el. + + + + + A cvsup parancs + használatával CVS módban + hozzunk létre és tartsunk karban egy helyi + CVS repositoryt a + szükséges állományokkal. Ehhez + például a net/cvsup-without-gui port + telepítését kell elvégeznünk, + ezáltal viszont egy sokkal rugalmasabb módszert + nyerünk abban az esetben, ha gyorsan és + könnyedén hozzá szeretnénk + férni a doc és www repositorykban tárolt + állományok különbözõ + revízióihoz, elõzményeihez vagy + éppen tárolni szeretnénk a &os; + központi CVS + repositoryjába. + + + + + Az egyszerû megoldás: a <command>csup</command> + használata + + A csup az alaprendszer része lett, + de egy ideje már nagyon sokan használják, + többek közt a saját + portgyûjteményük + frissítésére. A most következõ + példa supfile állománnyal a honlapok + elõállításához + szükséges állományokat tudjuk + elérni: + + # +# Ezzel a konfigurációs állománnyal a &os; honlapjának +# legenerálásához szükséges gyûjteményeket tudjuk elérni. +# +# A http://www.freebsd.org/doc/handbook/mirrors.html honlapon található +# felsorolásból válasszuk ki a hozzánk legközelebb elhelyezkedõ CVSup +# tükrözést. + +*default host=cvsup10.FreeBSD.org +*default base=/var/db +*default prefix=/usr/build +*default release=cvs tag=. +*default delete use-rel-suffix +*default compress + +# A &os; repository teljes doc ágát lekérjük. + +doc-all + +# Lekérjük a honlap forrásait. + +www + +# A holnapok elõállításához szükséges néhány alapvetõ port lekérése. + +ports-base + + A default host helyére + természetesen ne felejtsük el megadni a hozzánk + legközelebb elhelyezkedõ + CVSup tükrözést + (például cvsup.hu.FreeBSD.org), + illetve a default prefix + bejegyzésnél azt a könyvtárat, + ahová a lekért állományokat + szeretnénk elhelyezni. Ezután az így + kitöltött mintát mentsük el + például + doc-www-supfile + néven és adjuk ki a következõ + parancsot: + + &prompt.root; csup doc-www-supfile + + A parancs lefutásának + eredményeképpen ekkor tehát a + default prefix + értékeként megadott könyvtáron + belül létrejönnek a doc/, www/ és ports/ alkönyvtárak + (amely a példánkban a /usr/build + volt). Ebben a könyvtárban fogjuk + egyébként létrehozni az + állományokat, ezért ezt érdemes egy + olyan állományrendszerre tenni, ahol tehát + elegendõ szabad terület áll + rendelkezésre. + + Remek! Most lépjünk tovább a honlap + elõállításáról + szóló részhez. + + + + A rugalmasabb megoldás: saját doc és + www repositoryk létrehozása és + karbantartása + + Ez a módszer több lehetõséget + kínál, viszont cserébe + telepítenünk kell hozzá a net/cvsup-without-gui portot vagy + csomagot. + + + A net/cvsup-without-gui port + fordításához szükséges a + lang/ezm3 port, vagyis egy + Modula 3 fordító. Ennek a + fordítása viszonylag sok idõt vesz + igénybe és ráadásul a + legtöbben nem is használják másra, + ezért a CVSup + telepítéséhez elsõsorban a csomagok + használatát javasoljuk. + + + A CVSup program rendelkezik egy + speciális, ún. CVS móddal, + amelynek köszönhetõen lehetõvé teszi + a CVS repositoryt alkotó + ,v állományok + elérését. Ez a funkció jelenleg + még nem érhetõ el a + csup programban. A + CVSup részletes + bemutatását a &os; kézikönyv A + források szinkronizálása + címû részében olvashatjuk. + + A most következõ supfile állomány + lekéri a holnapok + elõállításához + szükséges gyûjteményeket és + létrehozza a CVS repository + helyi másolatát: + + # +# Ezzel az állománnyal létre tudjuk hozni a CVS repository egy olyan +# helyi másolatát, amelyben csak a &os; holnapjának elõállításához +# szükséges gyûjtemények találhatóak meg. Jelen pillanatban *kizárólag* +# a cvsup paranccsal fog mûködni (a csup programmal tehát nem) + +*default host=cvsup10.FreeBSD.org +*default base=/var/db +*default prefix=/usr/dcvs +*default release=cvs +*default delete use-rel-suffix +*default compress + +# A honlapok generálásához az alábbi gyûjteményekre lesz szükségünk: + +ports-base +doc-all +www + +# A CVS funkciókhoz még ezek a gyûjtemények is kelleni fognak: + +cvsroot-common +cvsroot-ports +cvsroot-doc + + A default host sorban + értelemszerûen a hozzánk legközelebb + elhelyezkedõ CVSup + tükrözést adjuk meg (például + cvsup.hu.FreeBSD.org), illetve a + default prefix bejegyzésnél + pedig azt a könyvtárat, ahol a repository + állományait kívánjuk tárolni. + Valamilyen, például + doc-ww-cvsfile + néven mentsük el ezt a mintát és adjuk + ki a következõ parancsot: + + &prompt.root; cvsup doc-www-cvsfile + + Továbbá érdemes még a + parancsértelmezõnk + indítóállományaiban + beállítani a CVSROOT + környezeti változó + értékét is. Például + vegyük fel az alábbi sort a + .cshrc állományunkba: + + setenv CVSROOT /usr/dcvs + + Ennek megadásával a repositoryval kapcsolatos + mûveletek elvégzésekor a (lentebb + látható) parancsból elhagyhatjuk a + paraméter + megadását. + + Jelenleg a repositoryban tárolt + állományok befogadásához + legalább 400 MB tárterületre lesz + szükségünk. A honlapok + elõállítása során ezen + felül ideiglenesen még nagyjából + további 200 MB hely kellhet. A + cvsup parancs lefutása után + már ki is kérhetjük a forrásokat a + munkakönyvtárunkba: + + &prompt.root; mkdir /usr/build +&prompt.root; cd /usr/build +&prompt.root; cvs /usr/dcvs co doc www ports + + Ez a parancs lényegében ugyanannak felel meg, + ahogy a csup kéri le az + állományokat a CVSup + szervertõl. A folyamat befejezõdése + után a munkakönyvtárban tehát + tulajdonképpen ugyanazokat fogjuk találni, mint az + egyszerûbb, csup alapú + módszer esetében. + + Az imént bemutatott cvsup parancs + folyamatos használatával tudjuk rendszeresen + karbantartani a CVS repository helyi + másolatát. Az elsõ esetben még + viszonylag sok állomány fog letöltõdni, + azonban a késõbbiekben már viszont csak + néhány percet vesz igénybe a + frissítés. + + + + + A honlapok elõállítása + + Miután az elõbb tárgyalt módszerek + valamelyikével elõkészítettük + rendszerünkön a honlapok forrásainak egy + naprakész másolatát, készen + állunk a honlapok létrehozására. A + példánkban az ehhez használt + munkakönyvtár a /usr/build + volt, ahol már minden szükséges + állomány megtalálható. + + + + Lépjünk be a + munkakönyvtárba: + + &prompt.root; cd /usr/build + + + + A honlapok elõállítása a + www/en + könyvtárból indul, az + all &man.make.1; cél + végrehajtásával megkezdõdik a + honlapok készítése. + + &prompt.root; cd www/en +&prompt.root; make all + + + + + + A generált honlapok telepítése a + webszerverre + + + + Ha nem az en + könyvtárban állunk, akkor váltsunk + vissza rá. + + &prompt.root; cd /usr/build/www/en + + + + A DESTDIR változóban + állítsuk be a honlapok tényleges + helyét, és futtassuk le vele a + install &man.make.1; + célt. + + &prompt.root; env DESTDIR=/usr/local/www make install + + + + Ha az elõbb megadott könyvtárba + korábban már másoltunk honlapokat, akkor az + újabb másolás során nem + törlõdnek a régi vagy elavult lapok. + Például ha a honlapokat napi + rendszereséggel frissítjük, akkor a + következõ paranccsal meg tudjuk keresni és + törölhetjük azokat a lapokat, amelyeket + már három napja nem + frissítettünk. + + &prompt.root; find /usr/local/www 3 | xargs rm + + + + + + Környezeti változók + + + + CVSROOT + + + A CVS állományait tároló + könyvtár gyökere. Ha a + CVSup alapú + módszert alkalmazzuk, akkor érdemes a + hozzátartozó változót + beállítanunk: + + &prompt.root; CVSROOT=/usr/dcvs; export CVSROOT + + A CVSROOT egy környezeti + változó. Vagy a paranccsorban, vagy pedig a + parancsértelmezõnknek megfelelõ + konfigurációs állományban + (például .profile) kell + beállítanunk. Ennek pontos + mikéntjét maga a parancsértelmezõ + határozza meg (a fenti parancsban + például a bash + és a hozzá hasonló + parancsértelmezõk által alkalmazott + megadási mód látható). + + + + + ENGLISH_ONLY + + + Ha beállítjuk és nem üres, + akkor a folyamat során csak az angol nyelvû + oldalak fognak elkészülni, a + fordítások figyelmen kívül + maradnak. Például: + + &prompt.root; make ENGLISH_ONLY=YES all install + + Ha le akarjuk tiltani az ENGLISH_ONLY + hatását és az összes oldalt az + összes elérhetõ fordítással + létrehozni, akkor az ENGLISH_ONLY + változónak adjunk üres + értéket: + + &prompt.root; make ENGLISH_ONLY="" all install clean + + + + + WEB_ONLY + + + Ha beállítottuk és az + értéke nem üres, akkor + hatására csak a www könyvtárban + található HTML oldalak + állítódnak elõ és + telepítõdnek. Ilyenkor a doc könyvtár teljes + tartalma (kézikönyv, GYIK és egyéb + leírások) figyelmen kívül + marad. + + &prompt.root; make WEB_ONLY=YES all install + + + + + NOPORTSCVS + + + Ennek megadásakor a Makefile + állományok nem kérnek ki + állományokat a portokhoz tartozó + repositoryból. Ehelyett a szükséges + állományokat közvetlenül a /usr/ports + könyvtárból (vagy ahova a + PORTSBASE változó + értéke mutat) fogják + átmásolni. + + + + + A WEB_ONLY, ENGLISH_ONLY + és NOPORTSCVS változók a + make programhoz tartoznak. Ezek + értékét az + /etc/make.conf állományban, + vagy környezeti változókhoz hasonlóan + parancssorból, illetve a parancsértelmezõ + konfigurációs állományaiban + állíthatjuk be. + + + + diff --git a/hu_HU.ISO8859-2/books/fdp-primer/tools/chapter.sgml b/hu_HU.ISO8859-2/books/fdp-primer/tools/chapter.sgml new file mode 100644 index 0000000000..fb7c4184b7 --- /dev/null +++ b/hu_HU.ISO8859-2/books/fdp-primer/tools/chapter.sgml @@ -0,0 +1,376 @@ + + + + + + Eszközök + + Az FDP a &os; 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 &os; + 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 &os; 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. + + + Lehetõség szerint a <filename + role="package">textproc/docproj</filename> 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: + + &prompt.root; make JADETEX=yes install + + vagy + + &prompt.root; 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;. + + + + Alapeszközök + + + Szoftverek + + A &os; 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. + + + + Jade + (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. + + + + + Tidy + (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. + + + + + Links + (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. + + + + + peps + (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á. + + + + + + + Dokumentumtípus-definíciók és + egyedek + + 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. + + + + HTML DTD (textproc/html) + + + A HTML a World Wide Web nyelveként + egységesen elfogadott jelölõnyelv, amely + ezáltal a &os; honlapjának is alapja. + + + + + DocBook DTD (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 &os; teljes + dokumentációja DocBook formátumban + készül. + + + + + ISO 8879 szabványú egyedek + (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. + + + + + + + Stíluslapok + + 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. + + + + Moduláris DocBook stíluslapok + (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. + + + + + + + + Kiegészítõ eszközök + + Ebben a szakaszban további választható + eszközöket sorolunk fel. Telepítésük + nem kötelezõ, azonban jelentõs + mértékben meg tudják könnyíteni a + munkánkat, illetve a dokumentációból + elõállítható kimeneti formátumok + terén kínálnak nagyobb + rugalmasságot. + + + Szoftverek + + + + JadeTeX és + teTeX + (print/jadetex és + print/teTeX) + + + A Jade és a + teTeX alkalmazások + segítségével + alakíthatóak át a DocBook + dokumentumaink DVI, Postscript és PDF + állományokká. Ehhez viszont a + JadeTeX makrókat is + telepítenünk kell. + + Ha az imént említett formátumok + egyikére sincs szükségünk + (tehát elegendõ a HTML, szöveges + és RTF kimenet), akkor nem kell + telepítenünk a + JadeTeX és + teTeX szoftvereket. Ezzel + egyébként viszonylag sok helyet + megspórolhatunk, mivel a + teTeX közel 30 MB + méretû. + + + Ha a JadeTeX és a + teTeX + telepítése mellett döntünk, + akkor a JadeTeX + telepítése után megfelelõen be + kell állítanunk a + teTeX alkalmazást. Az + erre vonatkozó részletes + utasításokat a + print/jadetex/pkg-message + állományban olvashatjuk. + + + + + + Emacs vagy + XEmacs + (editors/emacs vagy + editors/xemacs) + + + Mind a két szövegszerkesztõ tartalmaz + az SGML DTD-hez igazodó speciális + szerkesztési módot. Ebben olyan parancsok + találhatóak, amelyekkel + csökkenthetõ a munka + elvégzéséhez szükséges + gépelés és ezáltal a + hibák keletkezésének + valószínûsége. + + Egyáltalán nem kötelezõ ezeket + használni. A feladatra bármilyen szabadon + választott szövegszerkesztõ + tökéletesen megfelelõ, viszont a fentiek + némileg megkönnyíthetik a + munkavégzést. + + + + + Ha ismerünk az SGML dokumentumok feldolgozása + során alkalmazható további hasznos + szoftvereket, akkor jelezzük bátran a &a.doceng; + felé és felveszik erre a listára. + + + + + diff --git a/hu_HU.ISO8859-2/books/fdp-primer/translations/chapter.sgml b/hu_HU.ISO8859-2/books/fdp-primer/translations/chapter.sgml new file mode 100644 index 0000000000..4a31251d5f --- /dev/null +++ b/hu_HU.ISO8859-2/books/fdp-primer/translations/chapter.sgml @@ -0,0 +1,621 @@ + + + + + + Fordítások + + Ebben a fejezetben gyakran ismételt + kérdések és válaszok + formájában próbálunk + segítséget nyújtani a &os; + dokumentációjának (a kézikönyv, a + GYIK, különbözõ leírások, man + oldalak és egyebek) különbözõ nyelvekre + fordításában. + + Az itt szereplõ bejegyzések + nagyrészt az eredetileg Frank Gründer + (elwood@mc5sys.in-berlin.de) által a + Német &os; Dokumentációs Projekt + számára összeállított GYIK + tartalmán alapszanak, amelyet Bernd Warken + (bwarken@mayn.de) fordított késõbb + angolra. + + A bejegyzéseket jelenleg a &a.doceng; tartja + karban. + + + + + Miért éppen GYIK? + + + + A &a.doc.name; levelezési listán egyre + többen és többen jelzik, hogy + szeretnék lefordítani a &os; + dokumentációját + különbözõ idegennyelvekre. Az itt + összegyûjtött kérdésekben + ezért most igyekszünk megválaszolni az + ilyenkor általában elõkerülõ + problémákat, hogy minél gyorsabban el + tudják kezdeni a munkát. + + + + + + Mit az az i18n és + l10n? + + + + Az i18n jelentése + internationalization + (idegennyelvûség), az l10n + jelentése pedig localization + (honosítás). Ezeket + egyszerûsítették le és + rövidítették. + + Az i18n úgy + értelmezhetõ, hogy elõször egy + i, majd 18 betû, aztán egy + n. Ehhez hasonlóan, az + l10n egy l, amelyet 10 + betû követ és egy n + zár. + + + + + + Van külön levelezési lista a + fordítók számára is? + + + + Igen. Az egyes fordítói csapatoknak + többnyire van saját önálló + levelezési listájuk. Ezzel, illetve a csapatok + által mûködtetett webhelyekkel kapcsolatban + a + fordítói projektekkel + foglalkozó oldalon találhatunk bõvebb + információkat. + + + + + + Szükség van még + fordítókra? + + + + Igen. Minél többen dolgoznak egy + fordításon, annál gyorsabban + készül el, illetve annál gyorsabban + frissül az eredeti angol dokumentáció + változásai szerint. + + Nem kell képzett szakfordítónak lenni + ahhoz, hogy segíteni tudjunk. + + + + + + Milyen nyelveket kell ismerni? + + + + Nem árt jól ismernünk az írott + angolt és értelemszerûen folyékonyan + beszélni a fordítás + célnyelvét. + + Az angol nyelv ismerete egyébként nem + kötelezõ. Például a GYIK spanyol + fordítását + elkészíthetjük a magyar változat + alapján is. + + + + + + Milyen szoftvereket kell ismerni? + + + + Mindenképpen javasoljuk, hogy hozzunk létre + magunknak egy helyi másolatot a &os; + repositoryjáról (legalább a + dokumentációról) a + CTM vagy a + CVSup + segítségével. Az említett + alkalmazások használatáról a &os; + kézikönyv A forrás + szinkronizálása címû + szakaszában olvashatunk részletesebben. + + Hasznos, ha járatosak vagyunk a + CVS használatában. + Segítségével meg tudjuk nézni, + hogy mi változott a különbözõ + revíziókban, így mindig csak a + változások lefordításával + karban tudjuk tartani a lefordított + dokumentációkat. + + + + + + Honnan lehet kideríteni, hogy esetleg valaki + más már dolgozik ugyanazon nyelv + fordításán? + + + + A Dokumentációs + Projekt fordításokkal foglalkozó + oldalán megtalálhatjuk a jelenleg + ismert összes fordítást. Ha valaki vagy + valakik már dolgoznak fordításon a + kiválasztott nyelvhez, akkor inkább vegyük + fel velük a kapcsolatot, hogy ne dolgozzon senki sem + feleslegesen. + + Attól függetlenül, hogy az + említett oldal szerint senki sem foglalkozik az adott + nyelvre fordítással, a biztonság + kedvéért küldjünk még egy + levelet a &a.doc; címére. Elõfordulhat + ugyanis, hogy hozzánk hasonlóan valaki + szintén szeretne fordítani, de hivatalosan + még nem jelentette be. + + + + + + Senki sem fordít a kiválasztott nyelvre. Mi + a teendõ? + + + + Nos, ebben az esetben gratulálunk, miénk a + Nyelv &os; + Dokumentációs Projekt! Isten hozott a + fedélzeten! + + Elsõként alaposan fontoljuk meg, hogy + valóban hajlandóak vagyunk kellõ idõt + szentelni rá. Mivel jelen pillanatban egyedül + csak mi foglalkozunk az adott nyelvi + fordítással, nekünk magunknak kell + képviselnünk és + népszerûsítenünk a munkánkat, + illetve irányítani a késõbb + csatlakozni kívánó önkéntesek + munkáját. + + Írjunk egy levelet a &os; + Dokumentációs Projekt levelezési + listájára, amelyben bejelentjük, hogy + nekikezdünk fordítani az adott nyelvre, + ezáltal felkerül az elõbb említett + honlapra. + + Ha az adott nyelvhez tartozó országban van a + &os; Projektnek valamilyen tükrözése, akkor + érdemes kapcsolatba lépnünk az + üzemeltetõitõl és kérni a + munkánkhoz némi tárhelyet, esetleg a + levelezés támogatását vagy + saját egy levelezési listát. + + Válasszunk egy dokumentumot és kezdjük + el fordítani. Érdemes valamelyik rövidebb + résszel kezdeni, például a GYIK-kal vagy + valamelyik leírással. + + + + + + Hova lehet küldeni fordításokat? + + + + Ez változó. Ha már az adott nyelven + dolgozik egy fordítócsapat (például + a magyar vagy a német), akkor a saját + honlapjukon valószínûleg megadják + hogyan kezelik és hogy lehet hozzájuk eljuttatni + a fordításokat. + + Amennyiben viszont még csak egyedül dolgozunk + az érintett nyelven (vagy a + fordítócsapatunk képviseletében + szeretnénk eljuttatni a munkánkat a &os; + Projektnek), akkor érdemes közvetlenül a &os; + Projektnek küldeni a fordításainkat + (lásd a következõ + kérdést). + + + + + + Hova lehet beküldeni a fordításokat, ha + senki más nem dolgozik még + fordításon az adott nyelvhez? + + avagy: + + A fordítócsapatok hova tudják + küldeni a tagjaik által készített + fordításokat? + + + + Elõször is az elkészült + fordításokat a megfelelõ formára kell + hoznunk. Ez nagyjából azt jelenti, hogy + tegyük a már meglevõ + dokumentációk közé és + próbáljuk meg elõállítani + belõle a különbözõ + formátumokat. + + A &os; dokumentációja jelenleg a + legfelsõ szinten egy doc/ könyvtárba + szervezõdik. A benne található + könyvtárakat az adott nyelvek ISO639 + szabványú (a &os; 1999. január 20. + utáni változataiban a + /usr/share/misc/iso639 + állományban definiált) kódja + szerint nevezik el. + + Ha az adott nyelv többféle + kódolással is rendelkezik (mint + például a kínai), akkor ezen a szinten az + egyes kódolásokhoz külön + könyvtárak fognak tartozni. + + Végezetül az egyes dokumentumokat tegyünk + külön könyvtárakba. + + Például egy képzeletbeli svéd + fordítás körülbelül így + nézne ki: + + doc/ + sv_SE.ISO8859-1/ + Makefile + books/ + faq/ + Makefile + book.sgml + + Az sv_SE.ISO8859-1 a + fordítás neve, amely tehát a + korábban tárgyalt + nyelv.kódolás + alakban szerepel. A dokumentáció + elõállításához + elhelyeztünk még benne két + Makefile állományt + is. + + A &man.tar.1; és &man.gzip.1; programok + segítségével + tömörítsük össze az így + összekészített dokumentációt + és juttassuk el a Projekthez. + + &prompt.user; cd doc +&prompt.user; tar cf swedish-docs.tar sv_SE.ISO8859-1 +&prompt.user; gzip -9 swedish-docs.tar + + Az így keletkezõ + swedish-docs.tar.gz állományt + töltsük fel valahova. Ha nincs saját + tárhelyünk az interneten (mert + például a szolgáltatónk nem + bocsátott a rendelkezésünkre), akkor + küldjünk egy levelet a &a.doceng; + címére és segítenek megszervezni + az állomány + átvételét. + + Akármelyik megoldást is választjuk, a + &man.send-pr.1; használatával ne felejtsük el + jelezni, hogy beküldtük a fordítást. + Mivel nem nagyon valószínû, hogy a + fordítást ténylegesen + tároló személy folyékonyan + beszélné az adott nyelvet, ezért + mielõtt elküldjük, érdemes rendesen + átnézetni a fordításunkat. + + Valaki (valószínûleg a + Dokumentációs Projekt valamelyik vezetõje, a + &a.doceng; tagja) ezután ellenõrzi, hogy + beküldött fordítás nem tartalmaz + semmilyen technikai hibát. Különösen a + következõkre figyelnek ilyenkor: + + + + Minden állományban megvan a + verziókezeléshez szükséges + azonosító (mint például a + Projekt esetében a FreeBSD)? + + + + Az sv_SE.ISO8859-1 + könyvtárban hibamentesen lefut a make + all parancs? + + + + A fordítással kiegészítve + a teljesen &os; dokumentációra hibamentesen + lefut a make install parancs? + + + + Akárki is nézi majd át a + beküldött fordítást, ha az elõbb + felsoroltak bármelyikével probléma akad, + vissza fogják küldeni, hogy javítsuk + ki. + + Ha viszont mindent rendben találnak, akkor a + fordításunk hamarosan bekerül a &os; + repositoryjába. + + + + + + A fordítás tartalmazhat a nyelvre vagy + országra vonatkozó további + információkat? + + + + Alapvetõen ezt nem javasoljuk. + + Például a kézikönyv koreai + fordításában szeretnénk + hozzáadni egy szakaszt a Koreában + található boltokról. + + Igazából nem látjuk indokoltnak, hogy + ez az információ miért ne lehetne + része az angol (vagy német, spanyol, magyar + stb.) változatoknak. Könnyen elõfordulhat + ugyanis, hogy egy Koreában elõ, angol nyelvi + beszélõ szeretne a környéken keresni + egy ilyen üzletet. Mellesleg ezzel inkább jobban + láthatóvá válik mindenki + számára, hogy a &os; a világ mennyi + országában elérhetõ. Ez + azért nem is olyan rossz. + + Ha tehát valamilyen országfüggõ + információt szeretnénk betenni a + dokumentációba, akkor elõször + küldjünk róla egy hibajelentést (a + &man.send-pr.1; segítségével) a + kézikönyv számára, és csak + ezután fordítsuk vissza az adott nyelvre. + + Köszönjük az + együttmûködést! + + + + + + Hogyan illeszthetõek be a + dokumentációba nemzeti karakterek? + + + + Az alap ASCII készletben meg nem jelenõ + karaktereket hivatalosan SGML egyedek formájában + kell használnunk. + + Röviden: egy és jellel (&) + kezdõdnek, majd az azonosítójukat + követõen egy pontosvesszõvel (;) + zárulnak. + + A nemzeti karakterek + ábrázolására + használható egyedeket az ISO8879 + szabványban definiálták, amely a + Portgyûjteménybõl a textproc/iso8879 porton + keresztül érhetõ el. + + Néhány példaképpen ezek + közül: + + + Egyed + + Megjelenés + + Leírás + + + &eacute; + é + Ékezetes e. + + + + &Eacute; + É + Ékezetes E. + + + + &uuml; + ü + Trémás (umlautos, kétpontos) + u. + + + + Miután telepítettük az említett + portot, a /usr/local/share/sgml/iso8879 + könyvtárban található + állományokban lesz a + szabvány szerint elfogadott összes egyed. + + + + + + Hogyan szólítsuk meg az + Olvasót? + + + + Az angol nyelvû dokumentációban az + Olvasót általában a you + szóval szokták megszólítani, + azonban ezzel sok más nyelvtõl + eltérõen nem választják + külön az informális és formális + stílust. + + Ha olyan nyelvre fordítunk, amelyben létezik + ez a megkülönböztetés, + próbáljunk az adott nyelven írott + szakszövegek stílusához illeszkedni. Ha + nincs semmilyen ötletünk, akkor írjunk + visszafogott, illedelmes megfogalmazásban. + + + + + + Kell más egyéb információt + elhelyeznünk a fordításokban? + + + + Igen! + + Az angol nyelvû dokumentumok fejléce + általában valahogy így szokott + kinézni: + + <!-- + The &os; Documentation Project + + $&os;: doc/en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml,v 1.5 2000/07/07 18:38:38 dannyboy Exp $ +--> + + A pontos felépítés ettõl + némileg eltérhet, de szinte biztos, hogy mindig + találunk benne egy $&os;$ kezdetû + sort, illetve egy The &os; Documentation + Project szöveget. A $&os;$ + részt a verziókezelõ rendszer fogja + magától behelyettesíteni, ezért az + új állományok esetében ennek + üresnek kell lennie (egyszerûen csak + $&os;$). + + A fordításoknak tartalmazniuk kell egy + saját $&os;$ sort, illetve a &os; + Documentation Project nevet cseréljük ki + az adott nyelvhez tartozó The &os; + nyelv-angolul Documentation + Project névre. + + Mindezek mellett érdemes még egy harmadik + sort is felvenni a dokumentumba, amellyel jelezzük a + forráskódban, hogy a fordítás + melyik angol nyelvû szöveg alapján + készült. + + Ennek megfelelõen tehát a magyar + fordításokban általában a + következõ szöveg szerepel: + + <!-- + The FreeBSD Hungarian Documentation Project + + $FreeBSD$ + Original revision: 1.31 +--> + + + + + + diff --git a/hu_HU.ISO8859-2/books/fdp-primer/writing-style/chapter.sgml b/hu_HU.ISO8859-2/books/fdp-primer/writing-style/chapter.sgml new file mode 100644 index 0000000000..33fc0bcbff --- /dev/null +++ b/hu_HU.ISO8859-2/books/fdp-primer/writing-style/chapter.sgml @@ -0,0 +1,664 @@ + + + + + + A fogalmazás stílusa + + A &os; dokumentációját + készítõ rengeteg író + munkájának összehangolására ebben a + fejezetben megadunk néhány követendõ + alapelvet. + + + + Az angol nyelvû dokumentáció + írásakor az amerikai angol szerinti + helyesírást használjuk! + + + A szavak helyesírását tekintve az + angolnak több különbözõ + változata létezik. Vitás helyzetekben az + egységesség kedvéért ezért + mindig az amerikai helyesírást tekintsük + irányadónak. Ennek megfelelõen + tehát color és nem + colour, rationalize és + nem rationalise, stb. + + + A brit angol használata elfogadott lehet + beküldött cikkek esetében, viszont ilyenkor a + helyesírásnak egységesnek kell lennie a + teljes dokumentumon belül. Az összes többi + dokumentum, tehát könyvek, honlapok, man oldalak + stb. esetén azonban mindig amerikai angolt kell + alkalmazni. + + + + + + Ne rövidítsünk! + + + Ne alkalmazzunk rövidítéseket a + szövegben. Mindig minden kifejezést, szót + írjunk ki teljes alakjában. Pl. ez a + példa tehát nem helyes. Angol nyelven + mindez az összevonások + elkerülésére vonatkozik, tehát a + formális fogalmazási stílusra. + + A rövidítések + elhagyásával könnyebb a szövegnek + formális jelleget adni, így sokkal + precízebben megfogalmazott, a fordítók + számára is érthetõbb mondatokat + nyerünk. + + + + + A felsorolásoknál tegyünk ki + vesszõket! + + + Angol nyelven, ha több elemet sorolunk fel egyetlen + bekezdésben, akkor ezeket mindig vesszõkkel kell + tagolnunk. Az utolsó elemnél mindezt + egészítsük ki még egy + and (és) szóval. + A magyarban figyeljünk arra, hogy ez elé + már nem kell vesszõ. + + Például tekintsük a következõ + mondatot: + +

+ This is a list of one, two and three items. +
+ + Magyarul: + +
+ Ez a lista egy, két és három + elembõl áll. +
+ + Az angol változat esetén felvetõdhet a + kérdés, hogy ez a lista most egy, + két és + három elembõl áll, vagy + egy, két és + három elembõl. + + Ezért itt az utolsó tag elõtt is ki + kell tenni a vesszõt: + +
+ This is a list of one, two, and three items. +
+ + + + + Kerüljük a + szóismétlést! + + + Lehetõség szerint törekedjünk a + szóismétlések + elkerülésére. Ez konkrétan a + a parancs, az + állomány és man + parancs jellegû kifejezések + mellõzését jelenti, mert ezek sokszor + feleslegesen szerepelnek a szövegben. A magyar + fordításban azonban néha hasznosnak + bizonyulnak, különösen a + ragozásban. + + Most mutatunk két példát a + parancsokra. Ezek közül a másodikban + bemutatott stílust javasoljuk az angol szövegek + esetén. + + + Use the command cvsup to update your + sources. + + + + Use cvsup to update your sources. + + + A magyar szövegben viszont ennek + tökéletesen elfogadott a következõ + típusú fordítása, mivel így + könnyebb ragozni a parancsot: + + + A forrásainkat a cvsup + paranccsal frissítsük. + + + Ha a magyarban is el akarjuk kerülni minden + áron az ilyen jellegû ismétléseket, + akkor próbálkozhatunk úgy írni a + mondatot, hogy ne kelljen az idegen szót + ragoznunk: + + + A cvsup + segítségével frissítsük a + forrásainkat. + + + Az alábbi példákban az + állományok neveire láthatunk + példákat, amelyek közül ismét a + másodikat javasoljuk az angol nyelv + esetén: + + + … in the filename + /etc/rc.local + + + + … in + /etc/rc.local + + + A magyarban szintén a korábbiak + érvényesek. + + A most következõ példákban man + hivatkozásokat láthatunk. Közülük + ismét a második lesz a javasolt: + + + See man csh for more + information. + + + + See &man.csh.1;. + + + A magyar fordításban: + + + Lásd &man.csh.1;. + + + Vagy: + + + Lásd a &man.csh.1; man oldalt. + + + + + + Mindig hagyjunk két szóközt a mondatok + között! + + + A mondatok végén mindig hagyjunk két + szóköznyi helyet. Ezáltal javul a + szöveg olvashatósága, valamint + megkönnyíti az Emacs + és a hozzá hasonló eszközök + használatát. + + Habár vitatható, hogy ez a + megkülönböztetés egyáltalán + szükséges-e, bizonyos esetekben valóban + hasznos lehet, különösen neveknél. Erre + remek példa Jordan K. Hubbard. Ebben a + névben középen található egy + H, amelyet a mondat végéhez + hasonlóan egy pont és egy szóköz + követ, viszont jól látható, hogy itt + nem ér véget a mondat. + + + + + Az angol nyelvû fogalmazási stílus + szabályairól részletesebb bemutatást + William Strunk Elements of Style + címû könyvébõl kaphatunk. + + + A forráskód stílusa + + Mivel a dokumentáció forrását + egyszerre többen szerkesztik, valamilyen módon + egységes formában kell tartani. Ennek + érdekében legyünk szívesek az + alábbiakban megadott iránymutatások szerint + dolgozni. + + + Kis- és nagybetûk + + A címkéket soha ne + nagybetûkkel, hanem mindig kisbetûkkel írjuk, + például para és + nem PARA. + + Az SGML környezetekben megjelenõ szövegeket + viszont általában nagybetûvel kell írni, + például <!ENTITY…>, + <!DOCTYPE…>, és + nem + <!entity…> vagy + <!doctype…>. + + + + Mozaikszavak + + A mozaikszavakat elsõ alkalommal + általában illik rendesen kiírni, + például: Network Time Protocol (NTP). + Miután definiáltuk a mozaikszó + mögött álló jelentést, + elegendõ csak a rövidített alakot + használni (nem kell tehát a teljes + kifejezést, kivéve, ha az adott + szövegkörnyezetben annak több értelme + van). A mozaikszavakat dokumentumonként egyszer + definiáljuk. Ha viszont nekünk jobban megfelel, + akkor akár fejezetenként is kifejthetjük az + egyes mozaikszavakat. + + A mozaikszavak elsõ három + megjelenését az acronym elemmel + kell jelölni, ahol egy role + tulajdonságban megadjuk a mögött + álló teljes kifejezést. Ennek + köszönhetõen a dokumentumok feldolgozása + során létre lehet hozni szószedetet az + alkalmazott rövidítésékhez, illetve a + honlapokon meg lehet oldani, hogy ha az egérrel + felé visszük a kurzort, megjelenjen a teljes + megnevezés. + + + + Tördelés + + Mindegyik forrás tördelése a nulladik + oszloptól indul, függetlenül + attól, hogy az adott állományt milyen + más állomány fogja késõbb + tartalmazni. + + A nyitócímkék után két + szóközzel kell bentebb húzni a szöveget. + Ennek megfelelõen a zárócímkék + pedig két szóközzel csökkentik az + aktuális behúzás + mértékét. A sorok elején + szereplõ szóközöket nyolcas csoportban + cseréljünk tabulátorokra. Ne + használjunk szóközöket a + tabulátorok elõtt, és ne tegyünk + további szóközöket a sorok + végére. Ha az elemek tartalma egy sornál + hosszabb, akkor a következõ sort az elem + nyitócímkéjéhez képest mindig + két szóközzel bentebb kell kezdeni. + + Például ennek a szakasznak így + néz ki a szabályos tördelése: + + +--- Ez a nulladik oszlop +V +<chapter> + <title>...</title> + + <sect1> + <title>...</title> + + <sect2> + <title>Tördelés</title> + + <para>Mindegyik forrás tördelése a nulladik oszloptól indul, + <emphasis>függetlenül</emphasis> attól, hogy az adott állomány + milyen más állomány fogja késõbb tartalmazni.</para> + + ... + </sect2> + </sect1> +</chapter> + + Ha az Emacs vagy + XEmacs szerkesztõkkel dolgozunk, + akkor az állományok megnyitásakor + automatikusan be kellene töltõdnie az + sgml-mode + kiegészítésnek, illetve az egyes + források végén található + változók pontosan a fenti szabályok + betartatásáról gondoskodnak. + + A Vim szerkesztõvel + dolgozóknak pedig a következõ + beállításokat javasoljuk: + + augroup sgmledit + autocmd FileType sgml set formatoptions=cq2l " Speciális formázási beállítások + autocmd FileType sgml set textwidth=70 " Legfeljebb 70 oszlop széles sorok + autocmd FileType sgml set shiftwidth=2 " Az automatikus behúzás mértéke + autocmd FileType sgml set softtabstop=2 " A tabulátor 2 szóközzel visz bentebb + autocmd FileType sgml set tabstop=8 " 8 szóköz cseréje egy tabulátorra + autocmd FileType sgml set autoindent " Automatikus behúzás +augroup END + + + + A címkék stílusa + + + A címkék elrendezése + + Az egy behúzási szinten + található címkéket mindig + válasszuk el egy üres sorral, a többi esetben + viszont ne: + + + <article> + <articleinfo> + <title>NIS</title> + + <pubdate>1999 október</pubdate> + + <abstract> + <para>... + ... + ...</para> + </abstract> + </articleinfo> + + <sect1> + <title>...</title> + + <para>...</para> + </sect1> + + <sect1> + <title>...</title> + + <para>...</para> + </sect1> +</article> + + + + + A címkék tagolása + + Bizonyos címkék, mint például + az itemizedlist, amelyekben további + címkék szerepelnek és nem karakteres + adat, mindig egyedül állnak egy sorban. + + A para és + term címkék esetén + viszont szükség van további + címkékre a karakteres adatok + befoglalásához, ezért ilyenkor a tartalom + közvetlenül a címke után + következik, ugyanabban a + sorban. + + Ugyanez érvényes az említett + címketípusok zárásakor. + + A címketípusok keveredése egy + nyilvánvaló problémát + eredményez. + + Amikor egy karakteres adatot tárolni nem + képes elemet nyitó címke + közvetlenül követ egy karakteres adatokat + bevezetõ címkét, külön sorba kell + kerülniük. A második címkét a + szabályok szerint kell behúzni. + + Amikor egy karakteres adatokat befoglaló + címke záródik közvetlenül a + karakteres adatokat tartalmazni nem képes címke + után, szerepelhetnek ugyanabban a sorban. + + + + + Változtatások a forrás + tördelésén + + A források változtatása során + ügyeljünk arra, hogy sose tároljunk + egyszerre a repositoryba tartalmat és + tördelést érintõ + módosításokat. + + Ennek köszönhetõen a + dokumentációt fordító csapatok + könnyebben észreveszik, hogy mi változott a + módosításunk nyomán. Így nem + kell azon gondolkozniuk, hogy vajon most tényleg + változott a tartalom, vagy csak + újratördeltük a sorokat. + + Például ha felvettünk két mondatot + még egy bekezdéshez, és ezzel az adott + bekezdés sorainak hossza túlságosan + megnõtt, akkor elõször tároljuk a + hosszú sorokat tartalmazó változatot. + Ezután végezzük el a szükséges + tördelést és tároljuk azt a + változatot is. Ez utóbbi esetben azonban ne + felejtsük egyértelmûen jelezni a + tároláshoz tartozó üzenetben, hogy + csak a tördelésen változtattunk + (whitespace-only change). Így a + fordítók tudni fogják, hogy ezt figyelmen + kívül kell hagyniuk. + + + + Nem törhetõ szóközök + + Lehetõleg kerüljük a sortöréseket + olyan helyeken, ahol csúnyán néznének + ki, vagy rontanának a szöveg + olvashatóságán. A sortörések + mindig a kimeneti formátum által alkalmazott + sorszélességtõl függenek. + Különösen a HTML oldalakon + található formázott bekezdések + jelennek meg ízléstelenül egy szöveges + böngészõben, mint például ez + is: + + Az adattároló kapacitása általában 40 MB és 15 +GB között változik. Hardveres tömörítéssel … + + Az &nbsp; általános + egyed viszont megtiltja az egymáshoz szorosan + kötõdõ elemek közti sortörést. + Az ilyen nem törhetõ + szóközök használatát + elsõsorban a következõ helyeken + javasoljuk: + + + + mennyiségek és egységek + között: + + + + + program neve és verziószáma + között: + + + + + több szóból álló nevek + esetén (óvatosan bánjunk ezzel viszont + olyan hosszabb neveknél, mint például a + The &os; Brazilian Portugese Documentation + Project): + + + + + + + + Szólista + + Ebben a rövid szólistában + összefoglalunk néhány angol szót a &os; + Dokumentációs Projektben alkalmazandó + írásmódjuk szerint. Ha a keresendõ + szó nem szerepel ebben a felsorolásban, + nézzük meg az O'Reilly-féle + gyûjteményt. + + + + 2.2.X + + + + 4.X-STABLE + + + + CD-ROM + + + + DoS (Denial of Service) + + + + Ports Collection + + + + IPsec + + + + Internet + + + + MHz + + + + Soft Updates + + + + Unix + + + + disk label + + + + email + + + + file system + + + + manual page + + + + mail server + + + + name server + + + + null-modem + + + + web server + + + +
+ + +