diff --git a/ru_RU.KOI8-R/books/fdp-primer/writing-style/chapter.sgml b/ru_RU.KOI8-R/books/fdp-primer/writing-style/chapter.sgml new file mode 100644 index 0000000000..d2453ad864 --- /dev/null +++ b/ru_RU.KOI8-R/books/fdp-primer/writing-style/chapter.sgml @@ -0,0 +1,497 @@ + + + + + + Стиль написания + + Для того, чтобы соблюсти общность между множеством авторов документации + FreeBSD, для них были написаны некоторые руководящие указания, которым они + должны следовать. + + + + Используйте Американский вариант английского языка + + + Существует несколько вариантов английского языка, с + отличающимися вариантами записи одинаковых слов. В случае, + если написания отличаются - используйте американский вариант. + color, а не colour, + rationalize, а не rationalise, и так + далее. + + + Использование британского английского может быть принято при + предоставлении статей, но написание должно быть одинаковым во всём + документе. Другие документы, такие как книги, страницы Web-сайта, + справочные страницы и так далее, должны использовать американский + английский. + + + + + + Не используйте сокращений + + + Не используйте кратких форм в английском тексте. Всегда пишите + фразу полностью. Будет неправильно написать Don't use + contractions. + + Избежание кратких форм позволяет выдерживать более формальный + тон, фраза более точна и ее гораздо легче перевести на другой + язык. + + + + + Используйте несколько запятых + + + В списке объектов внутри параграфа отделяйте каждый пункт от + другого при помощи запятых. В английском тексте отделяйте последний + пункт от других при помощи запятой и слова and. + + К примеру, рассмотрим следующее: + +
+ This is a list of one, two and three items. +
+ + Это список из трех объектов one, + two и three, или список из двух пунктов + one и two and three? + + Лучше быть точным и включить запятую: + +
+ This is a list of one, two, and three items. +
+
+
+ + + Избегайте лишних фраз + + + Попытайтесь не использовать ненужных фраз. В частности, + the command, the file и man + command, наверное, излишни. + + Эти два примера показывают это для команд. Второй вариант + предпочтителен. + + + Use the command cvsup to update your + sources + + + + Use cvsup to update your sources + + + Эти два примера показывают это для имен файлов. Предпочтителен + второй вариант. + + + … in the filename + /etc/rc.local + + + + … in + /etc/rc.local + + + Эти два примера показывают это для ссылок на справочную систему. + Предпочтителен второй вариант (второй вариант использует + citerefentry). + + + See man csh for more + information. + + + + See &man.csh.1; + + + + + + Два пробела в конце предложений + + + Всегда используйте два пробела в конце предложений, так как это + усиливает читабельность, и облегчает использование таких + инструментов, как Emacs. + + Хотя могут быть возражения, что заглавная буква, которая следует + за точкой, обозначает новое предложение, это не тот случай, особенно + при использовании имен. Jordan K. Hubbard является + хорошим примером; в этом имени есть заглавная H, + которая следует за точкой и пробелом, но это не новое + предложение. + + +
+ + Более подробную информацию о стиле написания можно найти в работе + Уильяма Странка Elements of + Style. + + + Руководство по стилю + + Для того, чтобы исходный текст Руководства был выполнен в одном + стиле, когда много разных людей его редактируют, пожалуйста, следуйте + следующим соглашениям о стиле. + + + Регистр букв + + Метки вводятся в нижнем регистре, <para>, + а не <PARA>. + + Текст, который появится в контексте SGML, обычно пишется в верхнем + регистре, <!ENTITY…> и + <!DOCTYPE…>, но не + <!entity…> и + <!doctype…>. + + + + Акронимы + + Акронимы обычно должны расшифровываться при первом появлении + в книге, например: "Network Time Protocol (NTP)." После + определения акронима, обычно используется только он, + (а не термин целиком, если только в данном случае + использование полного термина не предпочтительнее). Обычно + акронимы определяются только один раз во всей книге. Но + если желаете, вы можете определять их в каждой главе. + + Первые три раза акроним должен помещаться внутри тегов + <acronym>, с атрибутом role, + где определен полный термин. Это позволяет создавать ссылку + на глоссарий, и выводить полное описание при наведении на + термин курсора мыши. + + + + Отступы + + Каждый файл начинается с отступа в колонке 0, + независимо от отступа файла, который может + включать этот файл. + + Открывающие метки увеличивают отступ на 2 пробела. Закрывающие + метки в свою очередь уменьшают отступ на 2 пробела. Заменяйте начальные + пробелы символами табуляции, насколько это возможно. Не используйте + пробелы перед символами табуляции, и не добавляйте дополнительных + пробелов в конце строки. Содержимое элементов должно иметь отступ в + два пробела, если содержимое превышает по размеру одну строку. + + Например, исходный код этого раздела выглядит примерно так: + + + ... + + + ... + + + Отступы + + Каждый файл начинается с отступа в колонке 0, + независимо от отступа файла, который может + включать этот файл. + + Каждая открывающая метка увеличивает отступ на 2 пробела, а каждая + закрывающая метка уменьшает его на 2 пробела. Заменяйте начальные + пробелы символами табуляции, насколько это возможно. Не используйте + пробелы перед символами табуляции, и не добавляйте дополнительных + пробелов в конце строки. Содержимое элементов должно иметь отступ в + два пробела, если содержимое превышает по размеру одну строку. + + ... + + +
]]> + + Если для редактирования файлов вы используете + Emacs или XEmacs, + то должен быть автоматически загружен sgml-mode, а + локальные переменные Emacs в конце + каждого файла должны заставить включить эти стили. + + Пользователи Vim могут использовать + следующие команды для конфигурации: + + augroup sgmledit + autocmd FileType sgml set formatoptions=cq2l " Special formatting options + autocmd FileType sgml set textwidth=70 " Wrap lines at 70 columns + autocmd FileType sgml set shiftwidth=2 " Automatically indent + autocmd FileType sgml set softtabstop=2 " Tab key indents 2 spaces + autocmd FileType sgml set tabstop=8 " Replace 8 spaces with a tab + autocmd FileType sgml set autoindent " Automatic indentation +augroup END + + + + + Стиль меток + + + Отделение меток + + Метки, которые находятся на том же уровне, что и предыдущая + метка, должны отделяться пустой строкой, а те, что не находятся на + той же самой позиции, что и предыдущая метка, не должны: + + + + + NIS + + Октябрь 1999 + + + ... + ... + ... + + + + + ... + + ... + + + + ... + + ... + +]]> + + + + + Отделение меток + + Такие метки, как itemizedlist, которые всегда + будут иметь метки внутри них, и на самом деле сами в себе текстовых + данных не содержат, всегда располагаются на одном уровне. + + Таким меткам, как para и + term, не нужны другие метки для обычных символьных + данных, а их содержимое начинается сразу же после метки, на + той же самой строке. + + То же самое относится к закрытию этих двух типов меток. + + Это приводит к очевидной проблеме при смешивании этих + меток. + + В случае, когда начальная метка, которая не может содержать + символьных данных, непосредственно следует за меткой типа, требующего + других меток внутри нее для использования символьных данных, они + располагаются на отдельных строках. Вторая метка должна быть + размещена с отступом. + + Когда метка, которая может содержать символьные данные, + закрывается сразу после закрывающей метки, которая не может содержать + символьных данных, то они располагаются на одной и той же + строке. + + + + + Изменения, затрагивающие только количество пробелов + + При коммите изменений не вносите изменения в содержимое + одновременно с изменениями в форматировании. + + Это нужно, потому что команды, которые переводят Руководство на + другие языки, могут быстро увидеть, как изменилось содержимое с вашим + коммитом без раздумий над тем, изменилась ли строка из-за содержания + или из-за другого расположения пробелов. + + К примеру, если вы добавили два предложения в абзац, и при этом + длины строк в абзаце теперь превысила 80 символов, сначала выполните + коммит ваших изменений с длинными строками. Затем измените перенос + строк и закоммитьте второе изменение. В сообщении, описывающем коммит + по второму изменению, обязательно укажите, что это несущественное + изменение, и что команды переводчиков могут его игнорировать. + + + + Непрерываемые пробелы + + Старайтесь избегать переводов строк там, где они могут выглядеть + некрасиво или делают неудобным отслеживание смысла фразы. Переводы + строк зависят от ширины выбранного формата вывода. В частности, + чтение HTML документации в текстовом навигаторе может привести к + появлению плохо сформатированных абзацев, как например: + + Data capacity ranges from 40 MB to 15GB. Hardware compression … + + Общая сущность &nbsp; запрещает перенос + строки между частями относящимися друг к другу. Используйте + прерываемые пробелы в подобных случаях: + + + + между цифрами и величинами: + + + + + между названием программы и номером версии: + + + + + между многословными названиями (используйте осторожно, когда + применяете это правило к фразам содержащим 3-4 и более слов. + Например: The FreeBSD Brazilian + Portuguese Documentation Project): + + + + + + + + + Словарь + + Далее следует краткий список слов, написание которых дано в виде, + который должен использоваться в Проекте Документирования FreeBSD. Если + в этом списке нет слова, которое вы ищете, то обратитесь к словарю + O'Reilly. + + + + 2.2.X + + + + 4.X-STABLE + + + + CD-ROM + + + + DoS (Denial of Service) + + + + Ports Collection + + + + IPsec + + + + Internet + + + + MHz + + + + Soft Updates + + + + Unix + + + + disk label + + + + email + + + + file system + + + + manual page + + + + mail server + + + + name server + + + + web server + + + + + +