From 529f845f3d102fb2cd90c85587fe225dcaa6f57c Mon Sep 17 00:00:00 2001 From: Andrey Zakhvatov Date: Tue, 14 Dec 1999 04:38:25 +0000 Subject: [PATCH] Initial import, synchronized with English 1.12 --- ru/docproj/sgml.sgml | 195 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 195 insertions(+) create mode 100644 ru/docproj/sgml.sgml diff --git a/ru/docproj/sgml.sgml b/ru/docproj/sgml.sgml new file mode 100644 index 0000000000..2fc23deb1e --- /dev/null +++ b/ru/docproj/sgml.sgml @@ -0,0 +1,195 @@ + + + + %includes; +]> + + + + &header; + +

The Documentation Project пытается использовать SGML в качестве + стандартного средства для написания документации.

+ +

Сокращение SGML означает Standard Generalised + Markup Language (Стандартный Формализованный Язык + Разметки).

+ +

По сути (и да простят нас SGML-пуристы, присутствующие среди + аудитории, к которой мы обращаемся) SGML является языком для написания + других языков.

+ +

Скорее всего, вы уже работали с SGML, не подозревая об этом. HTML, + язык, на котором пишутся страницы веба, имеет формальное описание. Это + описание написано на SGML. Когда вы пишете в HTML, вы не + пишете на SGML (per se), но используете язык, заданный при помощи + SGML.

+ +

Существует много, очень много языков разметки, которые заданы с + помощью SGML. HTML - один из них. Другой называется "LinuxDoc". + Как вы уже, наверное, догадались, он был создан группой, + документирующей Linux, для написания документации, и используется во + FreeBSD Documentation Project.

+ +

Другим языком разметки, заданным с помощью SGML, является "DocBook". + Этот язык был разработан специально для написания технической + документации, и поэтому в нем имеется множество тэгов (это нечто, + находящееся внутри <...>) для описания всего, что связано с + технической документацией.

+ +

Например, вот так может выглядеть короткий параграф в HTML + (не обращайте внимания на содержимое, смотрите на тэги):

+ + 
Пароли хранятся в /etc/passwd.	Чтобы отредактировать этот
+      файл, вы должны использовать vipw.  Однако, если вам
+      нужно только добавить в систему нового пользователя, вы можете
+      воспользоваться утилитой adduser.

+]]>
+ +

Тот же параграф, оформленный в стандарте DocBook, выглядит как

+ + 
Пароли хранятся в /etc/passwd.  Чтобы
+      отредактировать этот файл, вы должны использовать
+      vipw.	Однако, если вам нужно только добавить в
+      систему нового пользователя, вы можете воспользоваться утилитой
+      adduser.
+]]>
+ +

Как вы можете видеть, DocBook более 'выразителен', чем HTML. В + примере с HTML задается вывод имени файла шрифтом 'пишущей машинки'. + В примере с DocBook вывод имени файла задается именно как 'имя файла', + конкретное представление имени файла не оговаривается.

+ +

Имеется несколько плюсов использования этой более выразительной формы + разметки:

+ + + +

Если вы знакомы с Microsoft Word, это похоже на таблицы стилей, только + гораздо более мощные.

+ +

Конечно же, эти возможности достигаются определенной ценой;

+ + + +

На данный момент Проект все еще использует LinuxDoc для Руководства + и FAQ. Это положение меняется, в частности, идет процесс + преобразования документации в формат DocBook.

+ +

Что, если вы не знаете LinuxDoc/DocBook? Можете ли вы предоставлять + нам документацию?

+ +

Да, можете. Однозначно. Любая документация лучше, чем ее отсутствие. + Если у вас есть документация, которую вы хотите нам предоставить, и она + размечена не в формате LinuxDoc или DocBook, ничего страшного.

+ +

Пошлите нам документацию обычным + образом. Кто-нибудь из Проекта рассмотрит документацию, которую вы + послали, разметит ее за вас и включит в систему. С некоторой + вероятностью обратно вам будет выслан размеченный текст. Это весьма + полезно, так как вы сможете сравнить документацию "до и после", + обычный текст и размеченный, и, может быть, узнаете что-то новое о + процессе разметки.

+ +

Как правило, это замедляет процесс включения документации в систему, + так как предоставленный вами текст должен быть предварительно размечен, + что может занять вечер или два. Но она будет включена.

+ +

Хотите знать больше о SGML и DocBook?

+ +

Сначала вы должны прочесть Documentation Project + Primer. Этот документ является подробным описанием всего, + что вам нужно знать для работы с документации FreeBSD.

+ +

Это большой документ, разделенный на много меньших файлов. Вы можете + также просматривать его в виде одного + большого файла.

+ +
+
http://www.oasis-open.org/cover/sgml-xml.html
+ +

Страница SGML/XML. Содержит бесчисленное множество ссылок на + информацию о SGML.

+ +
http://www-tei.uic.edu/orgs/tei/sgml/teip3sg/index.html
+ +

"Gentle Introduction to SGML". Рекомендуемое чтение для всех, + кто хочет изучить SGML более подробно с уровня начинающего.

+ +
http://www.oasis-open.org/docbook/
+ +

DocBook DTD поддерживается OASIS. Эти страницы предназначены + для пользователей, которые чувствуют себя уверенно с SGML и хотят + изучить DocBook.

+
+ +
http://fallout.campusview.indiana.edu/~jfieber/docbook/
+ +

На странице Джона Фибера (John Fieber) находятся ссылки на + ресурсы, посвященные DocBook и примеры документов. Там также + имеется начало руководства по разметке для FreeBSD.

+ +
http://www.nothing-going-on.demon.co.uk/FreeBSD/
+ +

Страница Ника Клэйтона (Nik Clayton) содержит ссылки на + документацию, написанную в DocBook, а затем преоразованну в HTML. + Доступны оригинальные файлы в формате DocBook, и дается достаточно + большой пример того, как могут быть использованы различные элементы + DocBook.

+ +
+ http://www.FreeBSD.org/~wosch/papers/webbuild.html
+ +
&webbuild;
+
+ +

FreeBSD Documentation Project Home +&footer; + +