Рисунок 1. Структура набора стилей
М. Острогорский, 2013
В методическом пособии, предлагаемом вниманию читателя, приведен типовой набор стилей для технического документа. Говоря о стилях, мы имеем в виду, прежде всего, функциональность текстового процессора Microsoft Word, но если вы пользуетесь другой программой, реализующей сходные принципы работы с текстом, например, OpenOffice Writer или Adobe FrameMaker, создание аналогичного набора стилей тоже представляется нам целесообразным.
Разумеется, предлагаемый подход — не единственно возможный. Наверняка можно придумать много других наборов стилей для оформления технической документации, в том числе, более удачных. Однако описанный здесь набор достаточно хорош, во всяком случае, мы успешно применяли его при разработке различных комплектов технической документации. В случае необходимости его можно (и нужно) расширить, добавив стили, необходимые в конкретном проекте.
В текстовом процессоре Microsoft Word изначально предусмотрен набор универсальных стилей, которые, — наверно так думали разработчики, — потребуются любому автору.
Встроенные стили в основном предназначены для оформления элементов информационно-поискового аппарата документа: оглавлений, колонтитулов, номеров страниц и т. п. У них есть важная особенность: когда вы вставляете в документ тот или иной элемент, текстовый процессор автоматически применяет к ним соответствующие стили. Например, номера страниц автоматически оформляются стилем Номер страницы, а сноски — стилем Текст сноски. Поэтому создавать для тех же целей другие стили в большинстве случаев нецелесообразно.
Большим соблазном для многих пользователей текстового процессора Microsoft Word становится встроенный стиль Обычный. Он предназначен для оформления основного текста документа. Если вы создаете новый документ и начинаете набирать в нем текст, программа автоматически применяет к нему этот стиль. Если вы вставляете новый абзац после заголовка того или иного уровня, к этому абзацу тоже автоматически применяется стиль Обычный. Во всяком случае, так происходит, если вы не перенастраивали этот аспект поведения заголовочных стилей.
Коварство стиля Обычный в том, что на нем основаны некоторые другие встроенные стили, в том числе, стили для заголовков, колонтитулов, номеров страниц. Если вы внесете в него изменения, необходимые для оформления основного текста, например, назначите ему красную строку, эти изменения будут унаследованы его дочерними стилями, что может оказаться совсем не кстати: для чего абзацный отступ нужен колонтитулам и номерам страниц? Поэтому мы рекомендуем отказаться от использования стиля Обычный и создать собственный стиль для оформления основного текста документа.
В других текстовых процессорах, в частности, в OpenOffice Writer, встроенные стили организованы похожим образом, хотя их состав у каждой программы свой.
При построении набора стилей мы руководствовались следующими принципами.
Почему стили должны соответствовать типам содержания абзацев и линейных фрагментов, а не способам их оформления? Целесообразность такого решения неочевидна, тем более, что способ реализации стилей в большинстве программ для редактирования и верстки как будто предлагает нам задумываться, в первую очередь, о внешнем виде документа, а не о его структуре.
Этот принцип обеспечивает управляемость оформления документа. Рассмотрим простой пример.
Предположим, мы решили выделять термины и цитаты курсивом, а названия кнопок и названия клавиш — жирным шрифтом. Для этого мы создали два стиля: Курсив и Жирный. Набрали текст. Отдаем документ заказчику. Заказчик смотрит на него и говорит: «Сделайте цитаты не курсивом, а жирным». Какую работу нам придется провести, чтобы выполнить это требование? Мы будем вынуждены просмотреть весь документ, чтобы найти в нем цитаты и заменить на них стиль Курсив стилем Жирный. Если бы мы для каждого из четырех типов выделенного текста использовали отдельный стиль, нам достаточно было бы изменить его параметры.
Структура предлагаемого набора стилей абзацев (за исключением стилей, изначально предусмотренных в текстовом процессоре) показана на приведенной ниже схеме (рис. 1).
Рисунок 1. Структура набора стилей
Во избежание путаницы мы рекомендуем в каждой организации присваивать стилям имена, начинающиеся каким-нибудь характерным префиксом. Например, в компании ABCD стили будут называться abcd_base, abcd_flow и т. д.
| Стиль абзаца | Базовый стиль абзаца | Назначение | Рекомендации |
|---|---|---|---|
| base | нет | предок всех стилей (кроме стандартных) | основная гарнитура, используемая в документе |
| titlepage | base | предок всех стилей для титульного листа | гарнитура шрифта |
| flow | base | предок всех стилей для текста в основном потоке | межстрочный интервал, гарнитура и размер шрифта |
| special_heading | base | предок стилей абзацев для особых заголовков | не разрывать абзац, не отрывать от следующего, запрет переносов, жирный шрифт |
| listitem | flow | предок стилей абзацев для пунктов списков | отступы по горизонтали, не разрывать абзац, табуляции |
| inset | flow | предок всех стилей для врезок | отступы по горизонтали |
| inset_signal | inset | предок всех стилей для сигнальных блоков | отступы, границы, гарнитура и размер шрифта |
| inset_body | inset | предок всех стилей для содержания врезок | отступы по горизонтали |
| object_title | flow | предок всех стилей для заголовков таблиц, рисунков, листингов и т. п. | не разрывать абзац, жирный шрифт |
| table | base | предок всех стилей для текста в таблицах | размер шрифта |
Набор стилей для оформления титульного листа определяется его макетом. Макет титульного листа зависит от разных обстоятельств, в том числе, от используемых стандартов, корпоративных или публичных. Здесь мы приведем в качестве примера ограниченный набор стилей для оформления титульного листа в «коммерческом« духе. Оформление титульного листа в «официальном» духе, например, по ГОСТ 19.104-78, предполагает большее количество элементов, размещаемых на титульном листе, и, следовательно, требует создания большего количества стилей для их оформления.
Как известно, у изданий, выпущенных промышленным способом, бывают обложка и титульный лист (рис. 2). Когда мы держим в руках закрытую книгу, мы видим обложку. Перевернув первую сторону обложки, мы видим титульный лист. В книгах титульный лист, как правило, отличается от первой стороны обложки не только материалом и оформлением, но и составом размещаемой на нем информации.
В документах, которые предполагают распространение в электронном виде или печать на офисном принтере в ограниченном количестве экземпляров, обложку и титульный лист часто заменяют одной страницей, образующей нечто среднее между ними. Не будем критиковать этот подход, поскольку с практической точки зрения он во многих случаях вполне оправдан. Тем не менее, мы предостерегаем авторов от его бездумного применения: подумайте, на что претендует ваш документ, и примите осознанное решение.
|
|
| Обложка | Титульный лист |
|
Компания Borland. Paradox. User's Guide. 1992 г. |
|
Рисунок 2. Обложка и титульный лист
| Стиль абзаца | Базовый стиль абзаца | Назначение | Рекомендации |
|---|---|---|---|
| titlepage_company | titlepage | название организации на титульном листе | отступы, размер и гарнитура шрифта |
| titlepage_subject | titlepage | название предмета документирования (например, PARADOX) | отступы, размер и гарнитура шрифта |
| titlepage_genre | titlepage | название жанра документа на титульном листе (например, User's Guide) | отступы, размер и гарнитура шрифта |
| titlepage_version | titlepage | версия предмета документирования | отступы, размер шрифта |
| titlepage_address | titlepage | адрес организации | отступы по вертикали, размер шрифта |
Для заголовков разделов (подразделов, пунктов, подпунктов) документа мы рекомендуем использовать стандартные стили, определенные в текстовом процессоре: Заголовок 1, Заголовок 2 и т. д.
| Стиль абзаца | Базовый стиль абзаца | Назначение | Рекомендации |
|---|---|---|---|
| heading_outoftoc | special_heading | заголовок оглавления, аннотации, других частей документа, не входящих в оглавление | с новой страницы, оформление как у стандартного стиля Заголовок 1 |
| bridgehead | special_heading | псевдозаголовок (заголовок, не влияющий на формальную структуру документа) | отступы по вертикали, размер шрифта |
| Стиль абзаца | Базовый стиль абзаца | Назначение | Рекомендации |
|---|---|---|---|
| common | flow | основной текст | выравнивание, отступы (в т. ч. красная строка) |
| common_after_table | common | основной текст после таблицы (чтобы абзац, который следует непосредственно за таблицей, не «прилипал» к нижней границе ее рамки) | отступ сверху |
| common_before_list | common | абзац перед списком | не отрывать от следующего |
| common_btw_list_n_table | common_after_table | абзац после таблицы и перед списком | не отрывать от следующего |
Списки, реализованные с помощью стилей, ведут себя более устойчиво, чем списки, реализованные прямым форматированием, особенно при переносе документа с одного компьютера на другой. Вместе с тем, активное использование вложенности и разных способов нумерации в списках приводит к появлению комбинаторного разнообразия способов их оформления. Создавать и поддерживать стили для каждого из них было бы обременительно, хотя некоторые авторы пытаются это делать.
К сожалению, мы не знаем хорошего выхода из этого положения. Поэтому мы рекомендуем авторам пользоваться списками по возможности сдержано:
Приведем пример минималистичного набора стилей для оформления пунктов списков.
| Стиль абзаца | Базовый стиль абзаца | Назначение | Рекомендации |
|---|---|---|---|
| listitem_o | listitem | пункт маркированного списка | тип маркера |
| listitem_123 | listitem | пункт нумерованного списка, нумерация арабскими цифрами | способ нумерации |
| listitem_ABC | listitem | пункт нумерованного списка, нумерация прописными латинскими буквами | способ нумерации |
В текстовом процессоре Microsoft Word кроме списков существует еще один способ нумерации абзацев, в том числе, заголовков: поля AutoNum, ListNumLgl, ListNumOut, ListNum. Они не предоставляют такого выбора способов нумерации, как списки, и требуют от автора несколько большего объема ручной работы, зато функционируют более устойчиво и предсказуемо.
Использование врезок — распространенный прием структурирования и оформления технической документации. В разных комплектах технической документации мы видим разные типы врезок и способы их оформления (рис. 2). Оформление врезки определяется характером сведений, которые в ней заключены. Предупреждения об опасности или возможном ущербе, как правило, выделяют более интенсивно, для врезок со вспомогательной информацией характерно более спокойное оформление.
Из всего возможного многообразия мы рассмотрим здесь врезки, предусмотренные стандартом ANSI Z535.6. Этот стандарт определяет требования к изложению сведений, касающихся безопасности человека при взаимодействии с техникой.
Согласно ANSI Z535.6, врезка состоит из сигнального символа (пиктограммы), сигнального слова и сообщения. Сигнальный символ и сигнальное слово определяются типом врезки. Допускается визуальное объединение сигнального символа и сигнального слова в один блок. В сообщении должно быть четко выделено указание по безопасности, дальше могут быть приведены развернутые пояснения.
Врезки, выполненные в соответствии с ANSI Z535.6, показаны на рис. 2 слева.
|
|
|
Врезки в руководстве по эксплуатации технического средства Компания Toshiba. Руководство по удобной и безопасной работе. 2007 г. |
Врезки в руководстве пользователя программного средства Компания Microsoft. FoxPro. User's Guide. 1993 г. |
Рисунок 2. Примеры врезок
| Стиль абзаца | Базовый стиль абзаца | Назначение | Рекомендации |
|---|---|---|---|
| inset_signal_danger | inset_signal | сигнальный блок для врезки «Опасно» | границы, заливка, цвет шрифта |
| inset_signal_warning | inset_signal | сигнальный блок для врезки «Осторожно» | границы, заливка, цвет шрифта |
| inset_signal_caution | inset_signal | сигнальный блок для врезки «Внимание» | границы, заливка, цвет шрифта |
| inset_signal_notice | inset_signal | сигнальный блок для врезки «Уведомление» | границы, заливка, цвет шрифта |
| inset_message | inset_body | основное сообщение врезки | отступы, межстрочный интервал, жирный шрифт |
| inset_details | inset_body | текст врезки | отступы |
Многие авторы используют для оформления врезок таблицу из одной строки и двух столбцов. В левый узкий столбец помещают пиктограмму, а в правый широкий — текст врезки. Достоинство этого способа в том, что он позволяет обойтись без плавающих рисунков, которые снискали среди пользователей текстового процессора Microsoft Word дурную славу из-за приписываемой им непредсказуемости поведения. Но есть у него и недостатки. Во-первых, такие врезки менее управляемы, чем выполненные только с помощью абзацев и стилей. Так, автору документа придется вручную устанавливать ширину левого и правого столбца каждой таблицы, а также следить за тем, чтобы у всех таких таблиц в документе эти размеры были одинаковы. Во-вторых, таблицы предназначены для отображения структурированных данных, а не для многоколоночной верстки, впрочем, это уже идеология.
| Стиль абзаца | Базовый стиль абзаца | Назначение | Рекомендации |
|---|---|---|---|
| table_title | object_title | заголовок таблицы | не отрывать от следующего, выравнивание (правое) |
| table_cell | table | обычный текст в ячейке таблицы | выравнивание (левое, наследуется через table от base) |
| table_column_caption | table | заголовок столбца | выравнивание (по центру), не отрывать от следующего, не разрывать абзац, запрет переносов, жирный шрифт |
| table_row_stub | table | боковик | выравнивание (левое, наследуется через table от base), не разрывать абзац, запрет переносов, жирный шрифт |
| table_listitem_o | table_cell | пункт маркированного списка в ячейке таблицы | отступы по горизонтали, отступы по вертикали, тип маркера, табуляции |
| Стиль абзаца | Базовый стиль абзаца | Назначение | Рекомендации |
|---|---|---|---|
| figure_graphic | flow | рисунок | отступы по вертикали, выравнивание (по центру), не отрывать от следующего |
| figure_title | object_title | подрисуночная подпись | отступы по вертикали, выравнивание (по центру) |
Многие технические документы имеют специфику, которая требует создания дополнительных стилей для оформления присущих им типов информации. Например, для руководства пользователя специфичны описания процедур, а для руководства программиста — описания классов, функций, аргументов, переменных и т. п.
Имеет ли смысл разрабатывать универсальный набор стилей, в котором были бы учтены все типы информации, характерные для технических документов? На первый взгляд, это безумная затея. Однако существуют наборы стилей, претендующие на столь широкий охват. Так, язык разметки DocBook/XML и комплект XSLT-стилей DocBook XLS поддерживают около 400 элементов, отвечающих различным типам информации. Взяв этот набор за образец, можно попробовать создать аналогичный набор стилей для текстового процессора Microsoft Word или другой программы. Не решаемся с уверенностью утверждать, что это невозможно или бессмысленно, но, во всяком случае, довольно трудоемко как для разработчика, так и для будущих авторов технической документации, которым придется осваивать все это великолепие.
На практике новые стили часто приходится разрабатывать по мере появления в проекте необходимости излагать информацию того или иного типа. Для этого требуется анализ, выполняемый примерно в следующем порядке:
На рис. 3 (слева) показана страница справочника по языку программиования. На ней расположено описание функции, которое представляет собой сложный тип информации.
|
|
|
Описание функции программного интерфейса Компания Microsoft. FoxPro Language Reference. 1993 г. |
Описание процедуры, выполняемой пользователем Компания Microsoft. FoxPro User's Guide. 1993 г. |
Рисунок 3. Специфические типы информации
Внутри описания функции можно выделить следующие простые типы информации:
Для каждого из них потребуется создать свой стиль, для одних стиль абзаца, для других стиль символа.
На рис. 3 (справа) показана страница руководства пользователя. На ней расположено описание процедуры, выполняемой пользователем для решения одной из предусмотренных в программе пользовательских задач: создания индекса базы данных. Описание пользовательской процедуры — тоже сложный тип информации.
Внутри описания пользовательской процедуры можно выделить следующие простые типы информации:
Учитывая, что описание процедуры внешне представляет собой сочетание нумерованного и маркированного списков, мы могли бы отказаться от создания отдельных стилей для оформления процедур и воспользоваться стилями для списков, о которые мы обсуждали выше. Но вспомним об одном из основных принципов: каждый тип информации должен быть обеспечен своим стилем, поскольку внешнее сходство оформления может оказаться случайным и временным обстоятельством. Поэтому для каждого простого типа информации, входящего в описание процедуры, следует все-таки создать отдельный стиль.
| Стиль символа | Базовый стиль символа | Назначение | Рекомендации |
|---|---|---|---|
| inline_heading | основной шрифт абзаца | псевдозаголовок в подбор (не влияет на формальную структуру документа) | жирный шрифт или другой способ выделения (цвет, гарнитура) |
| inline_glossterm | основной шрифт абзаца | термин | курсив |
| inline_guilabel | основной шрифт абзаца | название кнопки, поля, пункта меню | жирный шрифт |
| inline_keycap | основной шрифт абзаца | название кнопки, поля, пункта меню | жирный шрифт, малые прописные |
| inline_computertext | основной шрифт абзаца | строки, набираемые на клавиатуре или выводимые на экран | моноширинный шрифт (например, Courier) |
Здесь речь пойдет о стилях в эстетическом, а не в техническом смысле.
Мы унаследовали от Советского Союза обособленную практику управленческого и технического документооборота. Этой практике сопутствует определенная традиция оформления документов. Она отчетливо выражена в таких стандартах, как ГОСТ 2.105-95 или ГОСТ 7.32-2001, но не ограничивается ими. Многие люди усвоили советскую традицию на уровне своего эстетического чувства, вольно или невольно включили ее в собственные представления о том, как должен выглядеть серьезный, правильно оформленный документ. В результате эта традиция начала оказывать влияние не только на те документы, к оформлению которых предъявляются жесткие внешние требования, но и на гораздо более широкий слой документов и изданий. Таким образом, в нашей стране утвердился легко узнаваемый оформительский стиль, который воспроизводят поколения управленцев, инженеров, технических редакторов, авторов технических публикаций.
Традиционному (и частично закрепленному в национальных стандартах) советскому стилю оформления технических документов противостоит западный стиль, намного более разнообразный в своих проявлениях, но столь же узнаваемый. Он проник в Россию в начале 90-х годов вместе с документацией на современные технические и программные средства и был вскоре усвоен специалистами и менеджерами новой формации. Успех западного стиля объясняется не только тем, что он эстетически противостоял формализму и скуке официальной стороны советской жизни, но и большей гибкостью, более точным соответствием составу излагаемой информации.
В приведенной ниже таблице показаны основные отличительные черты обоих стилей.
| Черта стиля | Советский официальный стиль | Западный коммерческий стиль |
|---|---|---|
| выравнивание абзацев | по обоим краям | по левому краю или по обоим краям |
| красная строка в абзацах | есть | нет |
| вертикальные отступы между абзацами | нет | есть |
| выравнивание заголовков | по центру | по левому краю |
| нумерация заголовков | многоуровневая | только разделы верхнего уровня (главы) |
| маркер пункта в списках | дефис | диск («буллет»), квадрат и т. п. |
| выносные элементы на полях | нет | есть |
| врезки | слабо выделены | интенсивно выделены |
Примеры проявления двух больших стилей приведены на рис. 4.
|
|
|
Советский «официальный» стиль Л. И. Брежнев. Отчетный доклад ЦК КПСС XXIV съезду партии. Издательство «Молодая гвардия», 1971 г. |
Западный «коммерческий» стиль Компания Borland. Paradox. User's Guide. 1992 г. |
Рисунок 4. Два больших стиля
Подход, предлагаемый в этой статье, позволяет реализовать оба больших стиля оформления документов. Мы рекомендуем последовательно придерживаться одного из них и не смешивать их черты в одном документе.
При достаточно большой высоте шрифта в заголовке желательно использовать уменьшенный (допускается даже отрицательный) межстрочный интервал. Это касается как заголовков внутри документа, так и надписей на обложке и на титульном листе.
В техническом документе заголовки следует выравнивать по левому краю или по центру. Правое выравнивание в заголовках выглядит слишком вычурно для технического документа. Выравнивание по обоим краям в заголовках неоправданно и плохо смотрится.
Заголовок не должен быть последним абзацем на странице. Если заголовок состоит хотя бы из двух строк, он не должен перетекать со страницы на страницу.
Разница в размере шрифта между заголовками соседних уровней должна быть хорошо заметна. Чем выше уровень заголовка, тем крупнее должен быть шрифт.
Для всех заголовков соблюдайте следующее правило: расстояние от предшествующего текста до заголовка должно быть больше расстояния от заголовка до озаглавленного текста (что потребует от вас известного искусства).
Обычно заголовки и основной текст оформляют гарнитурами разных типов. Например, в заголовках часто используют шрифт без засечек, а в основном тексте — с засечками, но это именно традиция, а не стандарт.
В заголовках нежелательны переносы слов.
Если в абзаце используется шрифт высотой 10–12 пунктов, межстрочный интервал рекомендуется делать 1,2–1,5 высоты шрифта. Более четкого правила сформулировать невозможно, поскольку восприятие текста читателем зависит не только от соотношения линейных размеров абзаца, но и от особенностей гарнитуры шрифта.
Если абзац вырвнен по обоим краям, рекомендуется использовать в нем переносы слов, чтобы избежать появления слишком длинных пробелов между словами и уродливых «колодцев», которые они могут образовывать, случайно оказавшись на одной вертикали.
Есть два распространенных способа обратить внимание читателя на границы между абзацами:
Не рекомендуется смешивать эти два способа в одном документе и, тем более, в одном и том же наборе абзацев.
В таблицах допустимо использование шрифта на один-два пункта меньше, чем шрифт в основном тексте.
Выравнивание по обоим краям может плохо выглядеть в таблице, особенно, если она состоит из нескольких достаточно узких столбцов. Поэтому даже если в документе используется преимущественно выравнивание по обоим краям, в таблицах имеет смысл использовать выравнивание по левому краю. Если в таблице используется выравнивание по обоим краям, необходимо разрешить в ней перенос слов.
Функция определения (переопределения) стиля по образцу может давать неожиданные эффекты. В частности, ее использование может привести к непосредственному назначению стилю того свойства, которое должно было бы наследоваться от родительского стиля. В результате при изменении этого свойства у родительского стиля дочерний стиль останется прежним.
Достаточно ли создать набор стилей непосредственно в документе, или необходимо подготовить шаблон и привязать к нему документ?
Если документ, который вы разрабатываете, единственный в своем роде, и вы планируете заниматься им самостоятельно, можно обойтись без шаблона. Если вы собираетесь разрабатывать похожие документы в дальнейшем, в том числе, силами коллектива авторов, на шаблоне лучше не экономить.
Шаблон обеспечивает следующие возможности:
Последнюю возможность рассмотрим более подробно.
Если вы создаете документ на основе шаблона, этот документ не только перенимает стили, предусмотренные в шаблоне, но и сохраняет привязку к нему. Иначе говоря, документ «помнит», по какому шаблону он был создан. Вы можете присвоить документу признак «Автоматически обновлять стили» (рис. 5). Тогда при открытии документа текстовый процессор будет автоматически приводить стили, заданные в документе, в соответствие одноименным стилям, заданным в шаблоне.
Рисунок 5. Автоматическое обновление стилей (в разных версиях Microsoft Word это диалоговое окно может выглядеть по-разному)
Это весьма полезная форма поведения текстового процессора, которая может сильно ускорить и упростить работу в следующих ситуациях.