Всё для технического документирования
+7 (925) 328-76-00
Разработка технической документации
Курсы для технических писателей
Программное обеспечение

Новости о техническом писательстве

MadCap Flare: публикация документов Microsoft Word в шаблоне ГОСТ

19.12.2018

Вы публикуете документацию из MadCap Flare в Microsoft Word и сталкиваетесь с проблемой «исчезающих» положенных по ГОСТ рамок и границ? Ольга Колячко, преподаватель курса «Знакомимся с MadCap Flare: основные возможности» (с 20.12.18 по 20.01.19 — скидка на курс 15%), подготовила для вас статью, где подробно изложено решение этой задачи. Статья будет полезна, даже если вы просто разрабатываете документы по ГОСТ, и пока ещё не знаете, как вставить рамки в документ MS Word.


Одно из преимуществ MadCap Flare – гибкие настройки для публикации контента. В MadCap Flare можно создать несколько вариантов макетов страниц и публиковать документы как в свободном, корпоративном шаблоне, так и в более строгом варианте, соответствующем стандартам ГОСТ.

Все это прекрасно работает, пока вы публикуете документы в формате PDF. Однако если заказчик требует документацию в Microsoft Word, скорее всего, вы потратите немало времени, чтобы документ выглядел также, как и в PDF. Все дело в одной неприятной особенности: при публикации документа в формате Microsoft Word MadCap Flare не сохраняет рамки и границы, добавленные в макет страницы. А значит, вам придется создавать их в уже опубликованном документе вручную.

В этой статье мы рассмотрим одно из возможных решений этой проблемы. Победить этот недостаток MadCap Flare можно с помощью макросов Microsoft Word.

Нам понадобятся:

  1. шаблон для документов ГОСТ в Microsoft Word;
  2. готовый проект документа MadCap Flare;
  3. и макрос Microsoft Word.

Первая вещь, которую нужно подготовить, – шаблон с рамками в формате Microsoft Word. В качестве базы, например, можно взять шаблон, разработанный Дмитрием Васильевым. Скачать шаблон можно здесь.

Сохраните шаблон в формате DOTM. Этот формат шаблонов позволяет использовать макросы в документе.

Следующий шаг – подготовить проект MadCap Flare. Здесь, в принципе, все как обычно. Обратить внимание стоит только на одну вещь на уровне содержания. Между разделами, добавленными в содержание, не должно быть разрывов. Для того чтобы проверить эту настройку, открываем содержание, щелкаем правой кнопкой по разделу и открываем его свойства. Переходим на вкладку Printed Output и проверяем поле Break Type. Здесь должна быть выбрана опция None.

Повторяем операцию для всех разделов в содержании.

Если вам все-таки нужны разрывы страниц, их можно добавить непосредственно в раздел: открываем раздел, переходим на вкладку Insert и нажимаем кнопку Page Break.

И последний шаг – подготовка макроса. Этот макрос будет копировать содержимое из документа, собранного с помощью MadCap Flare, в наш шаблон.

Sub CopyToTemplate()

‘ Copies content from doc to template

Selection.WholeStory

Selection.Copy

Documents.Add template:=“d:\Learning\MadCap\Course\template01.dotm

Selection.GoTo What:=wdGoToPage, Count:=1

Selection.PasteAndFormat (wdSingleCellText)

End Sub

В макросе нужно подправить пару моментов:

  • Add template – путь к шаблону
  • Count:=1– номер страницы, начиная с которой вы хотите вставить скопированный текст. Например, если титульный лист должен отличаться от остальных листов в документе, вы можете добавить в шаблон 2 листа, оформить титульный лист, а само содержимое документа добавлять, начиная с листа 2. В этом случае в макросе будет прописано: Count:=2.

Что нужно, чтобы добавить макрос в Microsoft Word? Копируем содержимое макроса, открываем любой документ Microsoft Word, переходим на вкладку Вид и выбираем Макросы > Макросы. Если в документе еще нет ни одного макроса, вводим любое название в поле Имя и нажимаем кнопку Создать. Если макросы уже есть, выбираем любой макрос в списке и нажимаем кнопку Изменить.

Вставляем скопированный текст макроса в открывшееся окно.

Подготовительный этап окончен. Теперь соберем документ в Microsoft Word с помощью таргета MadCap Flare и откроем его.

Снова переходим на вкладку Вид, выбираем Макросы > Макросы. Выбираем в списке наш макрос и запускаем его.

Результат:

Небольшое примечание. Решение, описанное в статье, работает для Microsoft Word 2016. Макросы для других версий Microsoft Word могут отличаться.



Адаптация документов к требованиям ГОСТ с помощью MadCap Flare 12

09.11.2016

coverОформить документ по ГОСТ автоматически? В MadCap Flare — легко! Представляем вашему вниманию статью Павла Сапожникова, профессионального технического писателя, активно использующего в своей работе современные технологии документирования. Данная статья посвящена оформлению комплектов документов по российским стандартам в MadCap Flare, при этом изложенные в ней рекомендации могут по аналогии применяться и в других современных профессиональных инструментах для документирования.

У Вас ещё нет этого полезного софта? Не хотите долго возиться с документами, а потом мучиться с приёмкой в госкомиссии? Поможем Вам разработать комплекты документации по ГОСТ на аутсорсе. Обращайтесь! 🙂

Большинство софтверных компаний российского IT-рынка придерживаются собственного корпоративного стиля оформления документации на разрабатываемые программные продукты. Кажется, что строгие конструкторские рамки, шрифт Times New Roman, и прочие требования ГОСТ уже давно канули в лету. Да и у современного пользователя вид User Guide, оформленного по всем канонам ГОСТ19 и ГОСТ34, вызовет разве что недоумение.

Тем не менее, российский IT-рынок специфичен и местами консервативен. Здесь до сих пор встречается требовательный заказчик в лице государственных структур, для которого приходится соблюдать некоторые нормы ГОСТ. Читать дальше…



Как коммуникаторы используют Doc-To-Help

07.10.2015

00Недавно в нашем магазине появилась возможность приобрести продукт для создания контента Doc-To-Help, который совместим с Microsoft Word. Мы писали о возможностях данного софта для технических писателей, а сегодня расскажем о его особенностях в контексте различных форматов и типов документов.


 

Основанное на Word простое в использовании решение для создания, управления и публикации онлайн-справок, руководств и методик, электронных книг и другой документации

Doc-To-Help используется техническими коммуникаторами, разработчиками руководств, поддержкой пользователей, преподавателями и другими авторами контента для создания документации к программному обеспечению, онлайн-справок, инструкций к продуктам, руководств, которые могут быть опубликованы во множестве форматов, включая отзывчивый веб, PDF, ePub и другие. Читать дальше…



Встречайте Doc-To-Help

18.09.2015

00Используйте Doc-To-Help совместно с Microsoft® Word для производства онлайн-документации, веб-контента, контента для мобильных устройств, электронных книг или вывода на печать. Пишите свой контент единожды, и публикуйте в любых форматах и местах с Doc-To-Help.

Авторинг и публикация с помощью Microsoft® Word

Doc-To-Help предлагает возможность быстрого авторинга и публикацию с помощью Microsoft® Word для создания онлайн-документации, руководств и инструкций, электронных книг и тому подобных документов.

  • Избавьте контент из заточения в Microsoft® Word™ и преобразуйте его в любой формат вывода
  • Создавайте документы в привычной среде с помощью Word и используйте уже имеющийся контент
  • Быстро и просто создавайте учебники, руководства пользователя, базы знаний и многое другое
  • Публикуйте во множество форматов вывода, включая отзывчивый веб-формат, PDF, ePub и другие форматы
  • Используйте уже имеющийся контент с помощью функций простого импорта
  • Используйте профессиональные встроенные темы вывода или настройте собственную
  • Поддержка множества языков, интеграция с MadCap Lingo
  • Используйте условные тэги, чтобы составить карту контента для вывода в разные форматы
  • Улучшите контроль над источниками и совместную работу
  • Экономьте время, позволив Doc-To-Help делать работу для вас

Читать дальше…



Преобразуем оригинальный дизайн в шаблон бланка Microsoft Word

18.08.2014

18.08.14Сколько бы функциональных и несложных инструментов ни предлагали разработчики, большинство до сих пор использует MicrosoftWord и сталкивается с огромным количеством иногда неразрешимых трудностей. Ребекка Крегер представляет нам решение одной из подобных проблем.

Хотите научиться разнообразным фишкам MS Word и других программ, изучить теорию по разработке технических текстов и приобрести практические навыки? Всё это Вы получите, освоив курс «Разработка технических текстов и документации».

В конце проекта с оригинальным дизайном довольно часто приходится слышать от клиентов: «Я хочу получить редактируемый шаблон этого бланка в Microsoft Word». Они, как правило, не устанавливают и не знают, как использовать передовые программы графического редактирования, такие как Adobe Illustrator, InDesign или Photoshop, и им просто нет смысла приобретать эти дорогостоящие программы.

Microsoft Word включает довольно примитивные технологии по сравнению с Illustrator или InDesign; однако, именно его используют клиенты, и ваш фирменный бланк бесполезен, если они не смогут редактировать и добавлять в него контент, поэтому умение создавать шаблоны бланков Microsoft Word является ключевым. Давайте начнем. Читать дальше…



А вы допускаете эти ошибки? (Часть 4)

23.12.2013

23.12.13Представляем вам продолжение статьи, предостерегающей неопытных технических писателей от самых распространённых ошибок. Сегодня речь пойдёт о слишком сложных шаблонах, неправильном форматировании и отсутствии глоссария.


Использование навороченных шаблонов

Многие компании не имеют достаточных навыков, чтобы создавать свои собственные шаблоны, и поэтому передают эту работу на аутсорсинг в другую компанию. Первая ошибка многих из этих сторонних компаний – это создание единого шаблона, как я уже писал выше. Вторая ошибка – добавление в шаблон такого количества ненужных функций, что его невозможно использовать.

Я когда-то работал в телекоммуникационной корпорации, которая, несмотря на её размер и долгое время существования, еще только начинала развивать собственную политику и процедуры создания документа. В какой-то момент компания разослала шаблон для писателей с указанием, что мы должны использовать его в дальнейшем. Он включал всякие фантастические функции, такие как сетки знаков, обрезные метки, таблицы, которые будут использоваться в одном виде документа, и таблицы, которые будут использоваться в другом, заголовки для этого и заголовки для того, все виды автоматических функций управления документами (ни одна из которых не работала) и многое, многое другое. К сожалению, никто из нас не мог понять, как его использовать, поэтому мы и не использовали.

Читать дальше…



А вы допускаете эти ошибки? (часть 3)

20.12.2013

01Сегодня мы обратим ваше внимание на такую немаловажную деталь, как использование шаблонов при создании документации, о чём зачастую забывают даже опытные технические писатели.


Отсутствие шаблонов

Из множества компаний, с которыми я работал на протяжении многих лет, девять были достаточно крупными и давно работающими, чтобы разработать собственные шаблоны, но лишь две это сделали. Учитывая, как много времени (а в бизнесе время – деньги) экономит использование шаблона, меня очень удивляет, почему компании от них отказываются.

Многие думают, что шаблон включает только стиль абзацев в документе. На самом деле, хорошо продуманный шаблон содержит не только стили, но и макеты для каждого элемента страницы (заголовки, нижние и верхние колонтитулы, таблицы, абзацы, отступы, предупреждающие сообщения, сноски) и каждого элемента книги (передняя обложка, титульный лист, оглавление, главы, глоссарий, задняя обложка и т.д.). Все эти элементы требуют тщательного продумывания и больших временных затрат, а шаблон легко использовать писателям и легко читать пользователям.

Читать дальше…