diff options
Diffstat (limited to 'ru_RU.KOI8-R/books/fdp-primer/overview/chapter.xml')
| -rw-r--r-- | ru_RU.KOI8-R/books/fdp-primer/overview/chapter.xml | 293 |
1 files changed, 293 insertions, 0 deletions
diff --git a/ru_RU.KOI8-R/books/fdp-primer/overview/chapter.xml b/ru_RU.KOI8-R/books/fdp-primer/overview/chapter.xml new file mode 100644 index 0000000000..e760bbbf19 --- /dev/null +++ b/ru_RU.KOI8-R/books/fdp-primer/overview/chapter.xml @@ -0,0 +1,293 @@ +<?xml version="1.0" encoding="koi8-r" standalone="no"?> +<!-- + The FreeBSD Russian Documentation Project + + $FreeBSD$ + $FreeBSDru: frdp/doc/ru_RU.KOI8-R/books/fdp-primer/overview/chapter.xml,v 1.5 2005/05/05 08:58:47 andy Exp $ + + Original revision: r23836 +--> + +<!-- Copyright (c) 1998, 1999 Nik Clayton, All rights reserved. + + Redistribution and use in source (SGML DocBook) and 'compiled' forms + (SGML HTML, PDF, PostScript, RTF and so forth) with or without + modification, are permitted provided that the following conditions + are met: + + 1. Redistributions of source code (SGML DocBook) must retain the above + copyright notice, this list of conditions and the following + disclaimer as the first lines of this file unmodified. + + 2. Redistributions in compiled form (transformed to other DTDs, + converted to PDF, PostScript, RTF and other formats) must reproduce + the above copyright notice, this list of conditions and the + following disclaimer in the documentation and/or other materials + provided with the distribution. + + THIS DOCUMENTATION IS PROVIDED BY NIK CLAYTON "AS IS" AND ANY EXPRESS OR + IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + DISCLAIMED. IN NO EVENT SHALL NIK CLAYTON BE LIABLE FOR ANY DIRECT, + INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN + ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE + POSSIBILITY OF SUCH DAMAGE. +--> + +<chapter id="overview"> + <title>Обзор</title> + + <para>Добро пожаловать в Проект Документирования FreeBSD. Наличие + документации хорошего качестве очень важно для успеха FreeBSD, и Проект + Документирования FreeBSD (FreeBSD Documentation Project - FDP) организован + для создания этой документации. Ваше участие очень важно.</para> + + <para>Главное назначение этого документа заключается в четком описании того, + <emphasis>как организован FDP</emphasis>, <emphasis>как создавать и + присылать документацию для FDP</emphasis> и <emphasis>как эффективно + использовать доступные вам инструменты при написании + документации</emphasis>.</para> + + <para> + <indexterm> + <primary>Участие</primary> + </indexterm> + К участию в FDP приглашаются все. Нет никаких минимальных требований, + предъявляемых к участникам, нет квот по объему документации, которую вам + нужно написать за месяц. Все, что вам нужно - это подписка на список + рассылки &a.doc;.</para> + + <para>После того, как вы прочтете этот документ, вы должны:</para> + + <itemizedlist> + <listitem> + <para>Знать, какая документация поддерживается в FDP.</para> + </listitem> + + <listitem> + <para>Уметь читать и понимать исходный код SGML в объеме документации, + которая ведется в FDP.</para> + </listitem> + + <listitem> + <para>Уметь вносить изменения в документацию.</para> + </listitem> + + <listitem> + <para>Уметь передавать ваши изменения обратно для просмотра и + последующего включения в документацию FreeBSD.</para> + </listitem> + </itemizedlist> + + <sect1 id="overview-doc"> + <title>Набор документации FreeBSD</title> + + <para>В FDP ведется документация FreeBSD четырех категорий.</para> + + <variablelist> + <varlistentry> + <term>Страницы справочной системы</term> + + <listitem> + <para>Системные англоязычные справочные страницы созданы не в FDP, + так как они являются частью системы. Однако FDP может (и делает) + перефразировать части существующих справочных страниц для того, + чтобы сделать их более понятными или с целью устранения + неточностей.</para> + + <para>Команды переводчиков отвечают за перевод системных справочных + страниц на другие языки. Эти переводы поддерживаются в FDP.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>FAQ</term> + + <listitem> + <para>FAQ предназначен для разрешения вопросов (в форме кратких + ответов на них), которые задаются или могут задаваться в различных + списках рассылки и новостных конференциях, посвященных FreeBSD. + Формат не разрешает длинных и подробных ответов.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Руководство</term> + + <listitem> + <para>Руководство предназначено быть полным онлайновым ресурсом + и справочником для пользователей FreeBSD.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Веб-сайт</term> + + <listitem> + <para>Это главное представительство FreeBSD в сети Интернет, + доступное по адресу <ulink + url="&url.base;/ru/index.html">http://www.FreeBSD.org/</ulink> и + на многих зеркалах по всему миру. Посещение веб-сервер является + первым знакомством с FreeBSD для многих людей.</para> + </listitem> + </varlistentry> + </variablelist> + + <para>Эти четыре категории документации все доступны в дереве CVS FreeBSD. + Это означает, что протоколы изменений в этих файлах общедоступны, и кто + угодно может воспользоваться программой типа + <application>CVSup</application> или <application>CTM</application> для + хранения собственной копии этой документации.</para> + + <para>Кроме того, на других веб-сайтах, посвященных FreeBSD, имеется + много учебников, написанных другими людьми. Некоторые из них также + располагаются в хранилище CVS (если автор согласился с этим). В других + случаях автор решил хранить свою документацию отдельно от главного + хранилища FreeBSD. FDP старается давать ссылки на максимальное + количество такой документации.</para> + </sect1> + + <sect1 id="overview-before"> + <title>До того, как вы начнете</title> + + <para>В этом документе предполагается, что вы уже знаете:</para> + + <itemizedlist> + <listitem> + <para>Как поддерживать в актуальном состоянии локальную копию + документации FreeBSD, ведя локальную копию CVS-хранилища FreeBSD + (используя <application>CVS</application> или + <application>CVSup</application> либо + <application>CTM</application>) или используя + <application>CVSup</application> для сгрузки только копии в режиме + <emphasis>checked-out</emphasis>.</para> + </listitem> + + <listitem> + <para>Как сгружать и устанавливать новое программное обеспечение при + помощи либо системы портов FreeBSD, либо программы + &man.pkg.add.1;.</para> + </listitem> + </itemizedlist> + </sect1> + + <sect1 id="overview-quick-start"> + <title>Быстрое начало</title> + + <para>Если вы просто хотите начать что-то делать и чувствуете уверенность, + что можете разобраться со всем самостоятельно, следуйте следующим + указаниям.</para> + + <procedure> + <step> + <para>установите мета-порт + <filename role="package">textproc/docproj</filename>.</para> + + <screen>&prompt.root; <userinput>cd /usr/ports/textproc/docproj</userinput> +&prompt.root; <userinput>make JADETEX=no install</userinput></screen> + </step> + + <step> + <para>Создайте локальную копию дерева <filename>doc</filename> FreeBSD. + Для этого воспользуйтесь CVSup в режиме <literal>checkout</literal> + либо создайте полную локальную копию хранилища CVS.</para> + + <para>Если у ас имеется локальное хранилище CVS, то, как минимум, вам + потребуется извлечь каталоги <filename>doc/share</filename> и + <filename>doc/en_US.ISO8859-1/share</filename>.</para> + + <screen>&prompt.user; <userinput>cvs checkout doc/share</userinput> +&prompt.user; <userinput>cvs checkout doc/en_US.ISO8859-1/share</userinput></screen> + + <para>Если у вас достаточный объем дискового пространства, то вы можете + вообще все.</para> + + <screen>&prompt.user; <userinput>cvs checkout doc</userinput></screen> + </step> + + <step> + <para>Если вы готовите изменение к существующей книге или статье, + извлеките их при необходимости из хранилища. Если вы планируете + создать новую книгу или статью, то используйте существующие в + качестве образца.</para> + + <para>Например, если вы хотите создать новую статью о настройте + VPN между FreeBSD и Windows 2000, вы можете сделать следующее.</para> + + <procedure> + <step> + <para>Извлеките каталог <filename>articles</filename>.</para> + + <screen>&prompt.user; <userinput>cvs checkout doc/en_US.ISO8859-1/articles</userinput></screen> + </step> + + <step> + <para>Скопируйте существующую статью для использования в качестве + шаблона. В нашем случае вы решили, что ваша новая статья + располагается в каталоге <filename>vpn-w2k</filename>.</para> + + <screen>&prompt.user; <userinput>cd doc/en_US.ISO8859-1/articles</userinput> +&prompt.user; <userinput>cp -R committers-guide vpn-w2k</userinput></screen> + </step> + </procedure> + + <para>Если вы хотите отредактировать существующий документ, такой, как + FAQ, который размещается в каталоге + <filename>doc/en_US.ISO8859-1/books/faq</filename>, вы должны извлечь + его из хранилища примерно следующим образом.</para> + + <screen>&prompt.user; <userinput>cvs checkout doc/en_US.ISO8859-1/books/faq</userinput></screen> + </step> + + <step> + <para>Отредактируйте файлы <filename>.xml</filename> при помощи вашего + любимого редактора.</para> + </step> + + <step> + <para>Оттестируйте разметку при помощи цели + <maketarget>lint</maketarget>. При этом будут быстро найдены все + ошибки в документе без реального выполнения занимающего время + преобразования.</para> + + <screen>&prompt.user; <userinput>make lint</userinput></screen> + + <para>Как только вы готовы на самом деле построить документ, то можете + задать какой-то формат или список форматов в переменной + <varname>FORMATS</varname>. В настоящее время поддерживаются + <literal>html</literal>, <literal>html-split</literal>, + <literal>txt</literal>, <literal>ps</literal>, + <literal>pdf</literal>, и <literal>rtf</literal>. Самый свежий + список поддерживаемых форматов находится в начале файла + <filename>doc/share/mk/doc.docbook.mk</filename>. Если вы + используете более чем один формат в одной команде, не забудьте + заключить список форматов в двойные кавычки.</para> + + <para>Например, для преобразования документа только в формат + <literal>html</literal>, вы должны использовать:</para> + + <screen>&prompt.user; <userinput>make FORMATS=html</userinput></screen> + + <para>Но когда вы хотите преобразовать документ в оба формата + <literal>html</literal> и <literal>txt</literal>, вы можете + использовать либо два отдельных вызова &man.make.1;:</para> + + <screen>&prompt.user; <userinput>make FORMATS=html</userinput> +&prompt.user; <userinput>make FORMATS=txt</userinput></screen> + + <para>либо это можно сделать одной командой:</para> + + <screen>&prompt.user; <userinput>make FORMATS="html txt"</userinput></screen> + </step> + + <step> + <para>Пришлите ваши изменения при помощи программы + &man.send-pr.1;.</para> + </step> + </procedure> + </sect1> +</chapter> |