eeeafee1f8
- Fix typos (tested with hungarian/hunspell) - Fix links (W3C Link Checker) Submitted by: gabor
218 lines
9.7 KiB
Text
218 lines
9.7 KiB
Text
<!DOCTYPE HTML PUBLIC "-//FreeBSD//DTD HTML 4.01 Transitional-Based Extension//EN" [
|
|
<!ENTITY base CDATA "..">
|
|
<!ENTITY date "$FreeBSD: www/hu/docproj/sgml.sgml,v 1.1 2007/01/07 22:44:47 keramida Exp $">
|
|
<!ENTITY title "FreeBSD Dokumentációs Projekt: SGML">
|
|
<!ENTITY % navinclude.docs "INCLUDE">
|
|
]>
|
|
|
|
<!-- The FreeBSD Hungarian Documentation Project
|
|
Translated by: Peter Terbe <sncdev@gmail.com>
|
|
Original Revision: r1.27 -->
|
|
|
|
<html>
|
|
&header;
|
|
|
|
<p>A Dokumentációs Projekt az SGML nyelvet használja, mint
|
|
alapvetõ eszközt a dokumentáció
|
|
bemutatásához.</p>
|
|
|
|
<p>Az SGML jelentése: <b>S</b>tandard <b>G</b>eneralized
|
|
<b>M</b>arkup <b>L</b>anguage.</p>
|
|
|
|
<p>Dióhéjban, (és elnézést
|
|
mindenkitõl, akit sért a következõ
|
|
kijelentés) az SGML egy nyelv további nyelvek
|
|
létrehozására.</p>
|
|
|
|
<p>Talán Ön is használta már az SGML-t,
|
|
anélkül, hogy tudott volna róla. A HTML, amely
|
|
nyelven a honlapok készülnek, rendelkezik formális
|
|
leírással, amely SGML nyelven íródott. Mikor
|
|
HTML nyelven ír, <b>nem</b> az SGML nyelvet használja
|
|
(és fordítva sem), csak egy olyan nyelvet, amelynek
|
|
szabályait az SGML segítségével
|
|
fektették le.</p>
|
|
|
|
<p>Sok leíró nyelv létezik, melynek alapjait SGML
|
|
nyelven írták. A HTML az egyik ezek közül.
|
|
Egy másik példa erre a "DocBook". Ez egy olyan nyelv,
|
|
melyet technikai leírások írásához
|
|
terveztek, és mint ilyen, sok taggel rendelkezik (amelyek így
|
|
néznek ki: <tt><Tag tartalma></tt>), a technikai
|
|
leírások megfelelõ formázásához.
|
|
A FreeBSD Dokumentációs Projekt ezt használja,
|
|
kiegészítve néhány új elemmel a
|
|
még nagyobb precizitás érdekében.</p>
|
|
|
|
<p>A következõ példa bemutatja, hogyan írhat
|
|
bekezdést a HTML nyelv segítségével
|
|
(a tartalomtól eltekintve, csak a tageket nézze):</p>
|
|
|
|
<pre><![ CDATA [
|
|
<p>A rendszer a jelszavak tárolására a
|
|
<tt>/etc/passwd</tt> fájlt használja. Ennek
|
|
módosításához a <b><tt>vipw</tt></b>
|
|
használata ajánlott. Amennyiben csak egy új
|
|
felhasználót akar felvenni a rendszerbe,
|
|
használhatja az <b><tt>adduser</tt></b> parancsot.</p>
|
|
]]></pre>
|
|
|
|
<p>Ugyanez a bekezdés a DocBook leírónyelvet
|
|
használva így néz ki:</p>
|
|
|
|
<pre><![ CDATA [
|
|
<para>A rendszer a jelszavak tárolására a
|
|
<filename>/etc/passwd</filename> fájlt használja. Ennek
|
|
módosításához a <command>vipw</command>
|
|
használata ajánlott. Amennyiben csak egy új
|
|
felhasználót akar felvenni a rendszerbe,
|
|
használhatja az <command>adduser</command> parancsot.</para>
|
|
]]></pre>
|
|
|
|
<p>Amint látja, a DocBook sokkal "kifejezõbb" a HTML-nél.
|
|
A HTML példában a fájlnév
|
|
megjelenítése "typewriter" betûtípussal
|
|
történik. A DocBook ugyanezt
|
|
"fájlnév"-ként képes kezelni,
|
|
függetlenül attól, hogy a fájlnév
|
|
leírását itt nem tárgyaljuk.</p>
|
|
|
|
<p>Ennek a sokkal kifejezõbb jelölési rendszernek
|
|
rengeteg elõnye van:</p>
|
|
|
|
<ul>
|
|
<li>
|
|
<p>Nem félreérthetõ vagy ellentmondásos.</p>
|
|
|
|
<p>Nem tölt idõt azon gondolkodva, hogy "Hmm, vajon egy
|
|
fájlnév megjelenítéséhez 'tt',
|
|
'b', vagy 'em' lenne megfelelõbb?"</p>
|
|
|
|
<p>Ehelyett a megfelelõ taget használhatja a megfelelõ
|
|
helyen.</p>
|
|
|
|
<p>A DocBookból más formátumokba (HTML,
|
|
PostScript®, stb.) történõ
|
|
átalakítás során biztos lehet abban,
|
|
hogy minden <filename> ugyanúgy fog kinézni.</p>
|
|
</li>
|
|
|
|
<li>
|
|
<p>Elfelejthet a dokumentum tálalásának
|
|
módjával foglalkozni, így
|
|
kizárólag a tartalomra koncentrálhat.</p>
|
|
</li>
|
|
|
|
<li>
|
|
<p>Mivel a dokumentáció leírásának
|
|
módja egyáltalán nem kötött, ugyanaz
|
|
a dokumentáció több más formátumban
|
|
is könnyedén elõállítható
|
|
— egyszerû szöveg, HTML, PostScript®, RTF, PDF,
|
|
stb.</p></li>
|
|
|
|
<li>
|
|
<p>A dokumentáció sokkal intelligensebb, tehát
|
|
intelligensebb feladatokra használható.
|
|
Például lehetséges egy olyan
|
|
tárgymutató automatikus
|
|
elõállítása, amely a
|
|
dokumentáció összes parancsát
|
|
tartalmazza.</p></li>
|
|
</ul>
|
|
|
|
<p>Ez olyan, mint a Microsoft® Word stílusai, csak
|
|
mérhetetlenül sokoldalúbb.</p>
|
|
|
|
<p>Természetesen a sokoldalúságnak ára van:</p>
|
|
|
|
<ul>
|
|
<li>
|
|
<p>Mivel a használható tagek száma sokkal nagyobb,
|
|
tovább tart megtanulásuk és alkalmazásuk
|
|
elsajátítása is.</p>
|
|
|
|
<p>Egy jó módszere az SGML és a DocBook
|
|
elsajátításának az, ha sok példa
|
|
dokumentáció forrásában
|
|
megfigyeljük, más szerzõk hogyan írtak le
|
|
hasonló információt.</p>
|
|
</li>
|
|
|
|
<li>
|
|
<p>Az átalakítás nem egyszerû.</p></li>
|
|
</ul>
|
|
|
|
<h2>Mi a teendõ, ha nem ismeri a DocBook rendszert?
|
|
Hozzájárulhat mással is?</h2>
|
|
|
|
<p>Természetesen igen. Bármely dokumentáció jobb a
|
|
nem létezõ dokumentációnál. Amennyiben
|
|
rendelkezik néhány közlésre szánt
|
|
dokumentációval, de azok nem DocBook nyelven
|
|
íródtak, ne aggódjon!</p>
|
|
|
|
<p><a href="submitting.html">Küldje el</a> a
|
|
dokumentációt, mint normális esetben. A projekt
|
|
egy másik tagja elõ fogja venni a javasolt
|
|
dokumentációt, elvégzi a konvertálást
|
|
és közzéteszi. Kis szerencsével az így
|
|
elkészült szöveget is elküldik Önnek!
|
|
Ez hasznos lehet, mert így megtekintheti a
|
|
dokumentáció "elõtte és utána"
|
|
változatát, és remélhetõen tanul
|
|
egy keveset a leíró folyamatból.</p>
|
|
|
|
<p>Ez nyilvánvalóan lelassítja a
|
|
közzétételi folyamatot, mivel a beküldött
|
|
dokumentációt még konvertálni kell.
|
|
Így pár órába, vagy pár
|
|
napba is beletelhet, mire elbírálásra
|
|
kerül.</p>
|
|
|
|
<h2>További információk az SGML-rõl és a
|
|
DocBookról</h2>
|
|
|
|
<p>Elõször is olvassa el a
|
|
<a href="&enbase;/doc/en_US.ISO8859-1/books/fdp-primer/index.html"><b>A FreeBSD
|
|
Dokumentációs Projekt Irányelvei
|
|
Kezdõknek</b></a> címû könyvet. Ennek
|
|
célja, hogy átfogó leírást
|
|
nyújtson minden, a FreeBSD dokumentációja kapcsán
|
|
felmerülõ kérdések
|
|
megválaszolásához. Igen hosszú
|
|
leírás, amely kisebb oldalakra van tagolva, de
|
|
lehetõsége van megtekinteni egy oldalként,
|
|
<a href="&enbase;/doc/en_US.ISO8859-1/books/fdp-primer/book.html"><b>egészben</b></a>.</p>
|
|
|
|
<dl>
|
|
<dt><a
|
|
href="http://www.oasis-open.org/cover/sgml-xml.html"><b>http://www.oasis-open.org/cover/sgml-xml.html</b></a>
|
|
</dt>
|
|
|
|
<dd><p>Az SGML/XML honlap. Számtalan hivatkozás az SGML-rõl.</p></dd>
|
|
|
|
<dt><a
|
|
href="http://www-sul.stanford.edu/tools/tutorials/html2.0/gentle.html"><b>http://www-sul.stanford.edu/tools/tutorials/html2.0/gentle.html</b></a>
|
|
</dt>
|
|
|
|
<dd><p>"Gentle Introduction to SGML". Ajánlott olvasmány
|
|
mindenkinek, aki közelebbrõl akar megismerkedni az SGML
|
|
nyelvvel, a kezdõk szemszögébõl nézve.</p>
|
|
</dd>
|
|
|
|
<dt><a
|
|
href="http://www.oasis-open.org/docbook/"><b>http://www.oasis-open.org/docbook/</b></a>
|
|
</dt>
|
|
|
|
<dd><p>A DocBook DTD-t az OASIS gondozza. Ezek az oldalak azoknak
|
|
szólnak, akik az SGML nyelvet már
|
|
elsajátították és a DocBook-ot
|
|
tanulmányoznák.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p></p><a href="docproj.html">FreeBSD Dokumentációs Projekt kezdõlap</a>
|
|
&footer;
|
|
|
|
</html>
|