A FreeBSD Dokumentációs Projekt irányelvei kezdőknek

A FreeBSD Dokumentációs Projekt

Verzió: 43184
Jogi közlemény
2013-11-13 írta hrs.
Kivonat

Köszönjük a részvételt a FreeBSD Dokumentációs Projektben! Minden segítség nagyon fontos számunkra.

Ebben az ismertetőben megtalálható a FreeBSD 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: Páli Gábor, utolsó ellenőrzés: 2010.11.28.

[ Fejezetekre darabolt dokumentum / Teljes dokumentum ]

Tartalom
Bevezetés
1. Parancssori promptok
2. Szedési szabályok
3. Megjegyzések, tanácsok, fontosabb információk, figyelmeztetések és példák
4. Köszönetnyilvánítás
1. Áttekintés
1.1. A FreeBSD dokumentációja
1.2. Mielőtt belekezdenénk
1.3. A legfontosabb tudnivalók
2. Eszközök
2.1. Alapeszközök
2.2. Kiegészítő eszközök
3. SGML alapismeretek
3.1. Áttekintés
3.2. Elemek, címkék és tulajdonságok
3.3. A DOCTYPE deklarációk
3.4. Visszaváltás az SGML használatára
3.5. Megjegyzések
3.6. Egyedek
3.7. Állományok tartalmának elérése egyedeken keresztül
3.8. Jelölt szakaszok
3.9. Befejezés
4. Az SGML alkalmazása
4.1. HTML
4.2. DocBook
5. * Stíluslapok
5.1. * DSSSL
5.2. CSS
6. A dokumentumok szervezése a doc/ könyvtáron belül
6.1. A legfelső szint: a doc/ könyvtár
6.2. A nyelv.kódolás/ könyvtárak
6.3. Az egyes dokumentumokkal kapcsolatos tudnivalók
7. A dokumentáció előállításának folyamata
7.1. A FreeBSD dokumentáció előállításának eszközei
7.2. A dokumentációt tároló könyvtárban található Makefile állományok
7.3. A FreeBSD Dokumentációs Projekt .mk állományai
8. A honlap
8.1. Előkészületek
8.2. A honlapok előállítása
8.3. A generált honlapok telepítése a webszerverre
8.4. Környezeti változók
9. Fordítások
10. A fogalmazás stílusa
10.1. A forráskód stílusa
10.2. Szólista
11. Az sgml-mode használata az Emacs szövegszerkesztőben
12. Lásd még...
12.1. FreeBSD Dokumentációs Projekt
12.2. SGML
12.3. HTML
12.4. DocBook
12.5. Linux Dokumentációs Projekt
A. Példatár
A.1. DocBook könyv, a book elem
A.2. DocBook cikk, az article elem
A.3. A formázott kimenet előállítása
Tárgymutató
A példák listája
1. Mintapélda
3.1. Elem (kezdő- és zárócímkék) használata
3.2. Elem (csak kezdőcímke) használata
3.3. Elemek elemekben, az em elem
3.4. Tulajdonság használata elemben
3.5. A tulajdonságok értékének megadása egyszeres idézőjellel
3.6. Minta .profile állomány sh(1) és bash(1) parancssorokhoz
3.7. Minta .cshrc állomány csh(1) és tcsh(1) parancssorokhoz
3.8. Általános SGML megjegyzés
3.9. Hibás SGML megjegyzések
3.10. Általános egyedek definíciója
3.11. Paraméteregyedek megadása
3.12. Állományok tartalmának elérése általános egyeddel
3.13. Állományok beillesztése paraméteregyedekkel
3.14. A jelölt szakaszok felépítése
3.15. CDATA típusú jelölt szakaszok használata
3.16. Az INCLUDE és IGNORE használata jelölt szakaszokban
3.17. Jelölt szakaszok vezérlése paraméteregyeddel
4.1. Egy átlagos HTML dokumentum felépítése
4.2. A h1, h2, stb. elmek
4.3. A hn elemek helytelen sorrendje
4.4. A p elem
4.5. A blockquote elem
4.6. Az ul és ol elemek
4.7. Definíciós felsorolások a dl elemmel
4.8. A pre elem
4.9. A table egyszerű használata
4.10. A rowspan tulajdonság
4.11. A colspan tulajdonság
4.12. A rowspan és colspan tulajdonságok együttes használata
4.13. A em és strong elemek
4.14. A b és i elemek
4.15. A tt elem
4.16. A big, small és a font elemek
4.17. Az <a href="..."> elem
4.18. Az <a name="..."> elem
4.19. Egy másik dokumentum nevesített részének elérése
4.20. Ugyanazon dokumentum nevesített részének elérése
4.21. Egy book és bookinfo elemek segítségével definiált könyvsablon
4.22. Egy article és articleinfo elemek segítségével definiált cikksablon
4.23. Egy egyszerű fejezet
4.24. Üres fejezetek
4.25. Szakaszok fejezetekben
4.26. A para elem
4.27. A blockquote elem
4.28. A warning elem
4.29. Az itemizedlist, orderedlist és procedure elemek
4.30. A programlisting elem
4.31. A co és calloutlist elemek
4.32. Az informaltable elem
4.33. A frame="none" típusú táblázat
4.34. A screen, prompt és userinput elemek
4.35. Az emphasis elem
4.36. Idézetek
4.37. Billentyűk, egérgombok és azok kombinációja
4.38. Alkalmazások, parancsok és kapcsolók
4.39. A filename elem
4.40. A filename elem és a package role együttes használata
4.41. A devicename elem
4.42. A hostid elem és a különböző role értékek
4.43. A username elem
4.44. A maketarget és a makevar elemek
4.45. A literal elem
4.46. A replaceable elem
4.47. Az errorname elem
4.48. Az id tulajdonság fejezeteknél és szakaszoknál
4.49. Az anchor elem
4.50. Az xref elem
4.51. A link elem
4.52. Az ulink elem
A.1. DocBook book
A.2. DocBook article
A.3. DocBook forrás átalakítása HTML formátumúra (egyetlen nagy állomány)
A.4. DocBook forrás átalakítása HTML formátumúra (több kisebb állomány)
A.5. DocBook forrás átalakítása Postscript formátumúra
A.6. DocBook forrás átalakítása PDF formátumúra

Ha kérdése van a FreeBSD-vel kapcsolatban, a következő címre írhat (angolul): <questions@FreeBSD.org>.

Ha ezzel a dokumentummal kapcsolatban van kérdése, kérjük erre a címre írjon: <gabor@FreeBSD.org>.