diff --git a/ru/docproj/current.sgml b/ru/docproj/current.sgml index 2321ce9704..c8dab9268b 100644 --- a/ru/docproj/current.sgml +++ b/ru/docproj/current.sgml @@ -1,14 +1,14 @@ - + %navincludes; %includes; @@ -29,10 +29,7 @@ &header;

Здесь приведён список проектов, которые находятся в работе (или - активно обсуждаются в списке рассылки freebsd-doc). Также сюда - включены некоторые проекты, которые еще не обсуждались, но воплотить - их было бы хорошей идеей. У каждого проекта есть человек для контактов - (если он известен).

+ активно обсуждаются в списке рассылки freebsd-doc).

Если вы думаете, что сможете принять участие в любом из этих проектов, не стесняйтесь заявить об этом. Поговорите с человеком, отвечающим за @@ -42,19 +39,13 @@ FreeBSD-doc@FreeBSD.org.

+ +

TODO список для документации

+ +

TODO список для документации - это + постоянно обновляющийся список проблем с документацией, которые должны + быть решены. Этот список ежемесячно отсылается в список рассылки FreeBSD-doc@FreeBSD.org. + Если вы хотите помочь нам улучшить документацию FreeBSD, то в первую + вы должны выбрать пункт из этого списка.

Открытые сообщения об ошибках в документации

@@ -99,30 +87,6 @@ href="http://www.FreeBSD.org/cgi/query-pr-summary.cgi?category=docs&responsible=.">просмотреть открытые сообщения об ошибках в документации.

- -

3-е печатное издание Руководства FreeBSD

- -

Ответственный: - Мюррей Стокели <murray@FreeBSD.org>

- -

Описание: - Этот проект завершён. 3-е издание Руководства FreeBSD теперь можно - приобрести в виде комплекта из двух томов в компании The FreeBSD Mall. Том - 1 ISBN: 1-57176-327-9, Том 2 ISBN: 1-57176-328-7.

- -

Список задач, который мы использовали при подготовке этой книги, - остаётся доступным здесь для потомков.

- -

Список задач проекта во второму изданию также остаётся доступным здесь. Объём второго издания книги составляет - 653 страниц, его номер ISBN 1-57176-303-1. Спасибо всем, кто принял в - нём участие. Полный анонс можно прочесть - здесь.

- -

Улучшение тематического указателя в Руководстве

@@ -136,7 +100,7 @@ не подходят в существующую схему. Некоторые тематические указатели добавлялись внутри списков или других областях текста, где их использование в соответствии с применяемыми нами таблицами стилей не - разрешается. Это приводит к появлению символов '???' вместо реальных + разрешается. Это приводит к появлению символов ??? вместо реальных номеров страниц при выдаче индексного указатели на печать.

Работа с указателями требует опыта и всякому, работающему над этой @@ -150,53 +114,12 @@ Руководства в формате PostScript, так как многие ошибки, такие как длинные слова или указатели с большим уровнем вложения будут отрицательно сказываться на используемую здесь выдачу в две колонки, - либо будут приводить в выдаче номеров страниц в виде '???'.

+ либо будут приводить в выдаче номеров страниц в виде ???.

Имеется скрипт doc/share/misc/indexreport.pl, который может использоваться для выявления областей SGML-файла, в котором метки <indexterm> встречаются редко.

- - -

Доработка главы Руководства о сетевых экранах

- -

Ответственный: FreeBSD-doc <FreeBSD-doc@FreeBSD.org>

- -

Описание: В Руководство FreeBSD недавно была добавлена глава о - сетевых экранах. Это новое добавление по большей части является - незаконченной работой, в нём присутствует много грамматических и - оформительских недочётов. Ранее эта глава являлась большой частью - главы об информационной безопасности, так что пожалуйста, обратитесь к - CVS-журналу security/chapter.sgml, чтобы просмотреть те работы, - которые были выполнены в течение последних месяцев, чтобы сделать этот - раздел более соответствующим Учебнику по Проекту документирования и - набору остальных наших документов. Предстоит выполнить ещё много - работы, и любая помощь будет принята.

- - - -

Модернизация Web-сайта при помощи CSS

- -

Ответственный: FreeBSD-www < - FreeBSD-www@FreeBSD.org>

- -

Описание: Web-сайт FreeBSD.org большей частью написан на HTML - 3.2. Некоторые составляющие его файлы технически были обновлены для - использования HTML 4 DTD, но по духу они остаются файлами стандарта - HTML 3.2 с чрезвычайно слабым использованием CSS и значительным - применением жёстко заданных меток, определяющих внешний вид.

- -

Любой пересмотр дизайна Web-сайта FreeBSD.org будет в большей мере - основан на CSS. Перевод существующих страниц на использование CSS - позволяет нам быстрее изменять внешний вид и общий дизайн Web-сайта в - целом, а также снизить требования к пропускной способности. Как и для - DocBook, используемом для написания нашей технической документации, - современные стандарты CSS и HTML позволяют нам отделить внешний вид от - данных, и мы должны лучше учитывать эти особенности при создании нашего - Web-сайта.

-

Разработка демонстрационных слайдов и презентационных материалов

@@ -257,18 +180,6 @@ href="http://www.FreeBSD.org/~gibbs/"> Архитектура и реализация подсистемы SCSI во FreeBSD.

- -

Написание некоторых глав для Руководства Разработчика

- -

Ответственный: - <doc@FreeBSD.org>

- -

Описание:

- -

Скрипты CGI

Ответственный: @@ -335,275 +246,6 @@ и запрашиваемый текст, что позволит пользователю увидеть, насколько результат поиска соответствует запросу.

- -

Документирование параметров настройки FreeBSD.

- -

Ответственный: - Tom Rhodes <trhodes@FreeBSD.org>

- -

Многие параметры настройки FreeBSD не документированы. Каждый знает, - насколько сложным может быть использование недокументированной системы, - поэтому и был организован этот проект. Основная его цель это создание - инструмента, способного генерировать страницу справочника с параметрами - настройки. Следовательно, нам потребуется создать этот список из - исходного кода.

- - -

Написание страниц справочника раздела 9

- -

Ответственный: - Tom Rhodes <trhodes@FreeBSD.org> - и Hiten Pandya <hmp@FreeBSD.org>

- -

Описание: Документирование интерфейсов и функций ядра.

- - -

Написание страниц справочника раздела 4

- -

Описание: Написание страниц справочника раздела 4.

- -

У всех драйверов в FreeBSD должны быть страницы справочника - в разделе 4, но некоторых страниц нет.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ЗадачаОписаниеОтветственныйПоследнее обновлениеСостояние
Новые страницы справочника раздела 4
bs(4) драйвер WD33C93 SCSI   7 ноября 2003 &status.new;
cm(4)сетевые адаптеры SMC Arcnet&a.trhodes;21 июня 2004&status.done;
cnw(4)Адаптер беспроводной сети NetWave AirSurfer&a.brueffer;10 сентября 2004&status.done;
ct(4) основанный на WD33C93 драйвер SCSI &a.non; 21 ноября 2003 &status.wip;
digi(4)драйвер интеллектуального коммуникационного адаптера DigiBoardXXX7 декабря 2003&status.done;
emu10k1(4) драйвер Soundblaster Pro &a.trhodes;, &a.hmp; 7 ноября 2003 &status.done;
esp(4)SCSI-контроллер QLogic (?), имеющийся в машинах Sun&a.trhodes;21 июня 2004&status.done;
hfa(4)драйвер HARP ATM&a.trhodes;6 августа 2004&status.done;
idt(4) NICStar ATM Adapter &a.trhodes;, &a.bms; 9 ноября 2003 &status.done;
ips(4) контроллер IBM/Adaptec ServerRAID &a.trhodes; 11 ноября 2003 &status.done;
mss(4) AD1848-совместимый драйвер MSS/WSS   7 ноября 2003 &status.new;
ncv(4) драйвер NCR 53C500 SCSI (PC-98) &a.trhodes; 20 ноября 2003 &status.done;
nsp(4) драйвер Workbit Ninja SCSI (PC-98) &a.non; 24 ноября 2003 &status.done;
nss(4) поддержка звука NEC PC-98   7 ноября 2003 &status.new;
ofwcons(4) IEEE-1275 / Open Firmware   7 ноября 2003 &status.new;
rc(4)драйвер коммуникационного мультиплексора Riscom/8&a.trhodes;21 июня 2004&status.done;
sab(4) драйвер SAB82523 Dual UART &a.bms; 6 декабря 2003 &status.done;
snc(4)драйвер сетевого адаптера Nat. Semi. DP8393X&a.trhodes;21 июня 2004&status.done;
uaudio(4) драйвер USB Audio &a.hmp; 10 ноября 2003 &status.done;
wdc(4)   &a.rushani; 8 ноября 2003 &status.done;
wds(4)SCSI-драйвер WD7000 24 августа 2004&status.new;
xrpu(4) драйвер Xilinx FPGA/RPU   7 ноября 2003 &status.new;
zs(4) драйвер Zilog UART   7 ноября 2003 &status.new;
- -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Обозначения
&status.new;Ещё не начата
&status.blocked; Заблокирована в ожидании завершения другой задачи
&status.wip; В работе
&status.done; Задача завершена
&status.n-a; Не запланирована
- -
- -

Главная страница Проекта Документирования - FreeBSD - &footer; diff --git a/ru/docproj/doc-set.sgml b/ru/docproj/doc-set.sgml index b18ccb0b4b..93afd33a85 100644 --- a/ru/docproj/doc-set.sgml +++ b/ru/docproj/doc-set.sgml @@ -1,14 +1,14 @@ - + %navincludes; %includes; @@ -35,13 +35,13 @@ Справочника по некоторой части FreeBSD подходит тот, кто эту часть реализовывал.

-
  • Книги

    +
  • Книги

    В проекте имеется большое количество документации, достигшей "книжной длины", или стремящейся к ней. Сюда включены FreeBSD FAQ и Руководство FreeBSD.

    -
  • Статьи

    +
  • Статьи

    В FreeBSD есть масса информации, доступной в более коротком формате статьи, аналогично учебникам или HOWTO других diff --git a/ru/docproj/handbook.sgml b/ru/docproj/handbook.sgml index 90de97d3aa..684df034b3 100644 --- a/ru/docproj/handbook.sgml +++ b/ru/docproj/handbook.sgml @@ -1,14 +1,14 @@ - + %navincludes; %includes; @@ -28,7 +28,7 @@ FreeBSD Mall. В окончательном варианте 653 страницы, его номер ISBN - 1571763031. Приносим благодарность всем принявшим участие. Полный анонс можно прочесть + href="http://docs.FreeBSD.org/cgi/getmsg.cgi?fetch=0+0+archive/2001/freebsd-announce/20011028.freebsd-announce"> здесь.

    Если в печатной версии вы обнаружите опечатку, пожалуйста, пришлите @@ -37,10 +37,10 @@ - - - - + + + + diff --git a/ru/docproj/sgml.sgml b/ru/docproj/sgml.sgml index 79f84038c6..2455b6fae1 100644 --- a/ru/docproj/sgml.sgml +++ b/ru/docproj/sgml.sgml @@ -1,14 +1,14 @@ - + %navincludes; %includes; @@ -17,10 +17,10 @@ &header; -

    The Documentation Project пытается использовать SGML в качестве +

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

    -

    Сокращение SGML означает Standard Generalised +

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

    @@ -29,22 +29,19 @@ других языков.

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

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

    - -

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

    + документации, и поэтому в нем имеется множество тегов (маркеры + в виде <содержимое тегов>) для описания + технической документации с последующим форматированием. + Проект документирования FreeBSD адаптировал его и определил несколько + новых элементов, чтобы сделать его более подходящим.

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

    @@ -84,7 +81,7 @@ месте.

    Процедура преобразования из DocBook в другие форматы (HTML, - Postscript®, и так далее) отвечает за то, чтобы все строки с + Postscript®, и так далее) отвечает за то, чтобы все элементы <filename> выглядели одинаково.

    @@ -94,7 +91,7 @@
  • Так как документация не привязана ни к какому конкретному выходному формату, та же самая документация может быть представлена - во многих различных форматах - просто текст, HTML, PostScript, + во многих различных форматах—просто текст, HTML, PostScript, RTF, PDF и так далее.

  • Документация становится более 'умной', поэтому с ней могут @@ -103,7 +100,7 @@ указаны все команды, упомянутые в документе.

  • -

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

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

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

    @@ -113,47 +110,41 @@ требуется больше времени на их изучение и понимание того, как использовать их эффективно.

    -

    Я обнаружил, что самым лучших методом обучения является чтение +

    Хороший способ обучения SGML и DocBook является чтение исходных текстов множества образцовых документов и сравнение того, как разные авторы оформляют подобную информацию.

  • Процесс преобразования не так уж прост.

  • -

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

    - -

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

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

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

    + размечена не в формате DocBook, ничего страшного.

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

    -

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

    +

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

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

    -

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

    - -

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

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

    - + %navincludes; %includes;
    ЗадачаОтветственныйПоследнее изменениеСостояниеЗадачаОтветственныйПоследнее изменениеСостояние