Учебник по Проекту Документирования FreeBSD для новых участников

The FreeBSD Documentation Project

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

Этот учебник описывает все, что вам нужно знать для того, чтобы принять участие в Проекте Документирования FreeBSD, от инструментов и программного обеспечения, которое вы будете использовать (как обязательное, так и рекомендуемое), до философии Проекта Документирования.

Этот документ все время подвергается изменениям, и не полон. Еще не законченные разделы помечены знаком * в названии.

[ По разделам / Одним файлом ]

Содержание

Используемые сокращения

Приглашения командных процессоров
Типографские соглашения
Замечания, советы, важная информация, предупреждения и примеры
Благодарности

1. Обзор

1.1. Набор документации FreeBSD
1.2. До того, как вы начнете
1.3. Быстрое начало

2. Инструменты

2.1. Обязательные инструменты

2.1.1. Программное обеспечение
2.1.2. DTD и сущности
2.1.3. Таблицы стилей

2.2. Необязательные инструменты

2.2.1. Программное обеспечение

3. Учебник SGML

3.1. Обзор

3.2. Элементы, метки и атрибуты

3.2.1. Упражнения...

3.3. Декларация DOCTYPE

3.3.1. Идентификаторы FPI
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. Формальный Публичный Идентификатор (Formal Public Identifier - FPI)
4.2.3. Структура документа
4.2.4. Блочные элементы
4.2.5. Строчные элементы
4.2.6. Изображения
4.2.7. Ссылки

5. * Таблицы стилей

5.1. * DSSSL

5.2. CSS

5.2.1. Веб-сайт (документы HTML)
5.2.2. Документы DocBook

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

6.1. Самый верхний уровень, doc/

6.2. Каталоги lang.encoding/

6.3. Информация, специфичная для конкретных документов

6.3.1. Руководство

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

7.1. Набор инструментов для построения документации FreeBSD

7.2. Понимание make-файлов в дереве документации

7.2.1. Make-файлы в подкаталоге
7.2.2. Make-файлы для документации

7.3. Включаемые make-файлы Проекта Документирования FreeBSD

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

8. Web-сервер

8.1. Подготовка
8.2. Построение Web-страниц с нуля
8.3. Установка Web-страниц в ваш Web-сервер
8.4. Переменные окружения

9. Переводы

10. Стиль написания

10.1. Руководство по стилю

10.1.1. Регистр букв
10.1.2. Акронимы
10.1.3. Отступы
10.1.4. Стиль меток
10.1.5. Изменения, затрагивающие только количество пробелов
10.1.6. Непрерываемые пробелы

10.2. Словарь

11. Использование Emacs в режиме sgml-mode

12. Дополнительные источники информации

12.1. Проект Документирования FreeBSD
12.2. SGML
12.3. HTML
12.4. DocBook
12.5. Проект Документирования Linux

A. Примеры

A.1. DocBook <book>

A.2. DocBook <article>

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

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

Список примеров
1. Пример
3-1. Использование элемента (начальная и конечная метки)
3-2. Использование элемента (только начальная метка)
3-3. Элементы внутри элементов; <em>
3-4. Использование элемента с атрибутом
3-5. Атрибуты в одинарных кавычках
3-6. .profile для пользователей sh(1) и bash(1)
3-7. .cshrc, для пользователей 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. <blockquote>
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> с атрибутом role
4-41. <devicename>
4-42. <hostid> и роли
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

По вопросам, связанным с FreeBSD, прочитайте документацию прежде чем писать в <questions@FreeBSD.org>.
По вопросам, связанным с этой документацией, пишите <doc@FreeBSD.org>.
По вопросам, связанным с русским переводом документации, пишите в рассылку <frdp@FreeBSD.org.ua>.
Информация по подписке на эту рассылку находится на сайте проекта перевода.

		След.
		Используемые сокращения