path: root/hu_HU.ISO8859-2/books/fdp-primer/overview/chapter.xml

<?xml version="1.0" encoding="iso-8859-2"?>
<!-- Copyright (c) 1998, 1999 Nik Clayton, All rights reserved.

     Redistribution and use in source (SGML DocBook) and 'compiled' forms
     (SGML HTML, PDF, PostScript, RTF and so forth) with or without
     modification, are permitted provided that the following conditions
     are met:

      1. Redistributions of source code (SGML DocBook) must retain the above
         copyright notice, this list of conditions and the following
         disclaimer as the first lines of this file unmodified.

      2. Redistributions in compiled form (transformed to other DTDs,
         converted to PDF, PostScript, RTF and other formats) must reproduce
         the above copyright notice, this list of conditions and the
         following disclaimer in the documentation and/or other materials
         provided with the distribution.

     THIS DOCUMENTATION IS PROVIDED BY NIK CLAYTON "AS IS" AND ANY EXPRESS OR
     IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     DISCLAIMED. IN NO EVENT SHALL NIK CLAYTON BE LIABLE FOR ANY DIRECT,
     INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
     STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
     ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE
     POSSIBILITY OF SUCH DAMAGE.

     $FreeBSD$
-->

<!-- The FreeBSD Hungarian Documentation Project
     Translated by: PALI, Gabor <pgj@FreeBSD.org>
     %SOURCE%  en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml
     %SRCID%   1.24
-->

<chapter id="overview" lang="hu">
  <title>Áttekintés</title>

  <para>Ü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.</para>

  <para>Ennek a dokumentumnak fõ célja, hogy bemutassa
    <emphasis>az FDP szervezõdését</emphasis>,
    <emphasis>hogyan készítsünk és
    küldjünk az FDP részére
    dokumentációt</emphasis>, és <emphasis>hogyan
    használjuk hatékonyan a dokumentációk
    írásához készített
    eszközöket</emphasis>.  </para>

  <indexterm><primary>tagság</primary></indexterm>

  <para>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é.</para>

  <para>A könyv elolvasása során
    megismerjük:</para>

  <itemizedlist>
    <listitem>
      <para>milyen dokumentációkat tart karban az
	FDP;</para>
    </listitem>

    <listitem>
      <para>az FDP által karbantartott
	dokumentációk megírásához
	használt SGML nyelvet;</para>
    </listitem>

    <listitem>
      <para>hogyan készítsünk
	módosításokat a
	dokumentációhoz;</para>
    </listitem>

    <listitem>
      <para>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.</para>
    </listitem>
  </itemizedlist>

  <sect1 id="overview-doc">
    <title>A &os; dokumentációja</title>

    <para>Az FDP a &os;-hez mellékelt dokumentációk
      négy fajtájáért felelõs:</para>

    <variablelist>
      <varlistentry>
	<term>Man oldalak</term>

	<listitem>
	  <para>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.</para>

	  <para>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.</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>GYIK</term>

	<listitem>
	  <para>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.</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>Kézikönyv</term>

	<listitem>
	  <para>A kézikönyv a &os;
	    felhasználók számára
	    összeállított átfogó,
	    intereten keresztül is olvasható
	    referencia.</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>Honlap</term>

	<listitem>
	  <para>A <ulink
	      url="&url.base;/index.html">http://www.FreeBSD.org/</ulink>
	    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.</para>
	</listitem>
      </varlistentry>
    </variablelist>

    <para>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
      <application>CVSup</application> vagy
      <application>CTM</application> alkalmazások
      használatával a
      dokumentációkból létre tudunk hozni
      egy helyi másolatot.</para>

    <para>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.</para>
  </sect1>

  <sect1 id="overview-before">
    <title>Mielõtt belekezdenénk</title>

    <para>Az alábbi ismereteket feltételezzük az
      olvasó részérõl:</para>

    <itemizedlist>
      <listitem>
	<para>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
	  <application>CVS</application>,
	  <application>CVSup</application> vagy
	  <application>CTM</application> alkalmazások
	  valamelyikének használatával), vagy
	  egyszerûen csak letölteni belõle a
	  <application>CVSup</application>
	  segítségével egy <emphasis>elõre
	  kikért</emphasis> példányt.</para>
      </listitem>

      <listitem>
	<para>Tudunk szoftvereket telepíteni a &os;
	  Portgyûjteményébõl vagy a
	  &man.pkg.add.1; használatával.</para>
      </listitem>
    </itemizedlist>
  </sect1>

  <sect1 id="overview-quick-start">
    <title>A legfontosabb tudnivalók</title>

    <para>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:</para>

    <procedure>
      <step>
	<para>Telepítsük a <filename
	    role="package">textproc/docproj</filename> metaportot:</para>

	<screen>&prompt.root; <userinput>cd /usr/ports/textproc/docproj</userinput>
&prompt.root; <userinput>make JADETEX=no install</userinput></screen>
      </step>

      <step>
	<para>Készítsünk egy helyi másolatot a
	  &os; forrásának <filename>doc</filename>
	  könyvtáráról.  Erre megfelel a
	  <application>CVSup</application> <literal>checkout</literal>
	  módja vagy a repository teljes tartalmának
	  letöltése.</para>

	<para>Egy használható helyi másolathoz
	  legalább a <filename>doc/share</filename> és
	  <filename>doc/en_US.ISO8859-1/share</filename>
	  könyvtárakat kell kikérnünk:</para>

	<screen>&prompt.user; <userinput>cvs checkout doc/share</userinput>
&prompt.user; <userinput>cvs checkout doc/en_US.ISO8859-1/share</userinput></screen>

	<para>Ha viszont sok tárhellyel rendelkezük, akkor
	  akár mindent kikérhetünk:</para>

	<screen>&prompt.user; <userinput>cvs checkout doc</userinput></screen>
      </step>

      <step>
	<para>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.</para>

	<para>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:</para>

	<procedure>
	  <step>
	    <para>Kérjük ki az <filename>articles</filename>
	      könyvtár tartalmát.</para>

	    <screen>&prompt.user; <userinput>cvs checkout doc/en_US.ISO8859-1/articles</userinput></screen>
	  </step>

	  <step>
	    <para>Másoljunk le valamelyik cikket és
	      használjuk fel sablonként.  Most úgy
	      döntöttük, hogy az új cikket a
	      <filename>vpn-w2k</filename> könyvtárba
	      helyezzük el:</para>

	    <screen>&prompt.user; <userinput>cd doc/en_US.ISO8859-1/articles</userinput>
&prompt.user; <userinput>cp -R committers-guide vpn-w2k</userinput></screen>
	  </step>
	</procedure>

	<para>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
	  <filename>doc/en_US.ISO8859-1/books/faq</filename>:</para>

	<screen>&prompt.user; <userinput>cvs checkout doc/en_US.ISO8859-1/books/faq</userinput></screen>
      </step>

      <step>
	<para>A könyvtárban található
	  <filename>.xml</filename> állományokat
	  írjuk át a kedvenc
	  szövegszerkesztõnkkel.</para>
      </step>

      <step>
	<para>A forrásban használt jelölõket a
	  <maketarget>lint</maketarget> 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:</para>

	<screen>&prompt.user; <userinput>make lint</userinput></screen>

	<para>Amikor viszont valóban le akarjuk
	  generáltatni a dokumentumot, a <makevar>FORMATS</makevar>
	  változóban tudjuk felsorolt a kért
	  formátumokat.  Itt jelen pillanatban a
	  <literal>html</literal>, <literal>html-split</literal>,
	  <literal>txt</literal>, <literal>ps</literal>,
	  <literal>pdf</literal> és <literal>rtf</literal>
	  értékeket szerepeltethetjük.  A
	  támogatott formátumok legfrissebb
	  listáját mellesleg a
	  <filename>doc/share/doc.docbook.mk</filename>
	  á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.</para>

	<para>Például így lehet egy dokumentumot
	  csak <literal>html</literal> formátumra
	  alakítani:</para>

	<screen>&prompt.user; <userinput>make FORMATS=html</userinput></screen>

	<para>Ha viszont egyszerre szeretnénk a
	  dokumentumból <literal>html</literal> és
	  <literal>txt</literal> formátumot létrehozatni,
	  akkor megtehetjük azt két külön
	  &man.make.1; paranccsal:</para>

	<screen>&prompt.user; <userinput>make FORMATS=html</userinput>
&prompt.user; <userinput>make FORMATS=txt</userinput></screen>

	<para>Vagy egyetlen paranccsal:</para>

	<screen>&prompt.user; <userinput>make FORMATS="html txt"</userinput></screen>
      </step>

      <step>
	<para>Küldjük be a
	  módosításainkat a &man.send-pr.1;
	  használatával.</para>
      </step>
    </procedure>
  </sect1>
</chapter>