Проект Документация за FreeBSD - Учебник за нови участници

Nik Clayton

nik@FreeBSD.org

Copyright © 1998, 1999, 2000, 2001, 2002 by Nik Clayton

Благодарим Ви, че ставате част от Проект Документация за FreeBSD. Вашият принос е изключително ценен.

Тeзи примери покриват всичко, което е необходимо да знаете, за да започнете да допринасяте за документацията на FreeBSD, от инструментите и програмите, които ще използвате (задължителни и препоръчителни) до философията зад Проекта по Документацията.

Този документ се допълва и не претендира да е пълен. Секциите, които е известно, че не са пълни са обозначени със * в името им.

Table of Contents

Подкана (промпт) на командния интерпретатор (шел)
Типографски обозначения
Забележки, съвети, важна информация, предупреждения и примери
Благодарности

1 Въведение

1.1 Групи документация за FreeBSD
1.2 Преди да започнете
1.3 Кратко начало

2 Инструменти

2.1 Задължителни инструменти

2.1.1 Софтуер
2.1.2 DTDs и Entities
2.1.3 Stylesheets (стилови таблици)

2.2 Опционални инструменти

2.2.1 Софтуер

3 SGML учебник

3.1 Въведение

3.2 Елементи, маркери (tags) и атрибути

3.2.1 За упражнение...

3.3 DOCTYPE декларация

3.3.1 Формален Публичен Идентификатор (Formal Public Identifiers (FPIs))
3.3.2 Алтернативи на FPI

3.4 Обръщения към SGML

3.5 Коментари

3.5.1 За упражнение...

3.6 Етикети

3.6.1 Общи етикети
3.6.2 Параметрични етикети
3.6.3 За упражнение...

3.7 Използване на етикети за включване на файлове

3.7.1 Използване на общи етикети за включване на файлове
3.7.2 Използване на параметрични етикети за включване на файлове
3.7.3 За упражнение...

3.8 Маркирани секции

3.8.1 Ключови думи за маркирани секции
3.8.2 За упражнение...

3.9 Заключение

4 SGML Маркиране

4.1 HTML

4.1.1 Формален Публичен Идентификатор - Formal Public Identifier (FPI)
4.1.2 Секционни елементи
4.1.3 Блокови елементи
4.1.4 Елементи в линията
4.1.5 Препратки

4.2 DocBook

4.2.1 FreeBSD допълнения
4.2.2 Формален публичен Идентификатор (FPI)
4.2.3 Структура на документ
4.2.4 Блокови елементи
4.2.5 Вградени елементи
4.2.6 Графични файлове
4.2.7 Препратки

5 * Stylesheets (Стилови таблици)

5.1 * DSSSL

5.2 CSS

5.2.1 Уеб сайта (HTML документи)
5.2.2 DocBook документите

6 Структуриране на документи в doc/

6.1 Основното ниво, doc/

6.2 Директориите език.кодиране/

6.3 Информация за специфични документи

6.3.1 Наръчника (Ръководството)

7 Процес на компилиране на документацията

7.1 Инструментариум за изграждане на FreeBSD документацията

7.2 Употреба на Makefile-ове в дървото на Документацията

7.2.1 Makefile-ове в поддиректориите
7.2.2 Makefile-ове на документацията

7.3 Включени в make файлове на Проект по документация на FreeBSD

7.3.1 doc.project.mk
7.3.2 doc.subdir.mk

8 Уеб сайт

8.1 Подготовка
8.2 Компилиране на уеб страниците
8.3 Инсталирайте уеб страниците във вашия уеб сървър
8.4 Променливи на обкръжението

9 Преводи

10 Стил на писане

10.1 Упътване за стилове

10.1.1 Големи (малки) букви
10.1.2 Вмъкнатост
10.1.3 Стил на етикетите
10.1.4 Промени във форматирането
10.1.5 Непрекъсваеми интервал

10.2 Списък с думи

11 Използване на sgml-mode с Emacs

12 Вижте също

12.1 Проект по документация за FreeBSD
12.2 SGML
12.3 HTML
12.4 DocBook
12.5 Линукс Документационен Проект

A. Примери

A.1 DocBook <book>

A.2 DocBook <article>

A.3 Получаване на форматиран резултат

A.3.1 използване на Jade

List of Examples
1. Обикновен пример
3-1. Използване на елемент (начален и краен маркери)
3-2. Използване на елемент (само с начален маркер)
3-3. Елементи в елементи; <em>
3-4. Използване на елемент с атрибут
3-5. Единични кавички около атрибутите
3-6. .profile, за sh(1) и bash(1) потребители
3-7. .login, за csh(1) и tcsh(1) потребители
3-8. SGML общ коментар
3-9. Неправилни SGML коментари
3-10. Дефиниране на общи етикети
3-11. Дефиниране на параметрични етикети
3-12. Използване на общи етикети за включване на файлове
3-13. Използване на параметрични етикети за включване на файлове
3-14. Структура на маркираните секции
3-15. Пример за използване на CDATA маркирана секция
3-16. Използване на INCLUDE и IGNORE в маркирани секции
3-17. Използване на параметричен етикет за контролиране на маркирана секция
4-1. Стандартна структура на HTML документ
4-2. <h1>, <h2> и т.н.
4-3. Лошо подреждане на <hn> елементи
4-4. <p>
4-5. <блоков цитат>
4-6. <ul> и <ol>
4-7. Списъци дефиниции с <dl>
4-8. <pre>
4-9. Примери за приложение на <table>
4-10. Приложение на rowspan
4-11. Приложение на colspan
4-12. Приложение на rowspan и colspan заедно
4-13. <em> и <strong>
4-14. <b> и <i>
4-15. <tt>
4-16. <big>, <small> и <font>
4-17. Пример за <a href="...">
4-18. Пример за <a name="...">
4-19. Препращане към част от друг документ
4-20. Препращане към част от текущия документ
4-21. <book> с <bookinfo>
4-22. <article> с <articleinfo>
4-23. Примерна глава
4-24. Празни глави
4-25. Секции в глави
4-26. <para>
4-27. <blockquote>
4-28. <warning>
4-29. <itemizedlist>, <orderedlist> и <procedure>
4-30. <programlisting>
4-31. <co> и <calloutlist>
4-32. <informaltable>
4-33. Таблици с frame="none"
4-34. <screen>, <prompt> и <userinput>
4-35. <emphasis>
4-36. Цитати
4-37. Клавиши, бутони на мишката и комбинации
4-38. Приложения, команди и опции.
4-39. <filename>
4-40. <filename> етикет с package role
4-41. <devicename>
4-42. <hostid> и roles
4-43. <username>
4-44. <maketarget> и <makevar>
4-45. <literal>
4-46. <replaceable>
4-47. <errorname>
4-48. id на глави и секции
4-49. <anchor>
4-50. Използване на <xref>
4-51. Използване на <link>
4-52. <ulink>
A-1. DocBook <book>
A-2. DocBook <article>
A-3. Конвертиране от DocBook към HTML (един файл)
A-4. Конвертиране от DocBook към HTML (множество малки файлове)
A-5. Конвертиране от DocBook към Postscript
A-6. Конвертиране от DocBook към PDF

		Next
		Увод

Този и други документи можете да намерите в ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/.

За въпроси отностно FreeBSD, прочетете документацията преди да попитате в <questions@FreeBSD.org>.
За въпроси отностно този документ, e-mail <doc@FreeBSD.org>.