1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
|
<?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 xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="overview" xml: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 xml: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 <link xlink:href="&url.base;/index.html">http://www.FreeBSD.org/</link>
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 xml: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 xml: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 <package>textproc/docproj</package> 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
<buildtarget>lint</buildtarget> 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 <varname>FORMATS</varname>
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>
|