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

Обзор MadCap Flare 10 (часть 2)

14.03.2014

14.03.14Продолжаем публикацию обзора продукта Flare компании MadCap. Сегодня мы узнаем о том, насколько могут быть полезны слайд-шоу, зачем нужна функция Экспорт проекта, а также о том, каким образом компания вынуждает пользователей переходить с trial-версий на лицензионные.


Поддержка в Flare вывода HTML5 и адаптивного вывода

В Flare 9 была добавлена поддержка вывода HTML5, весьма удачно встроенная в интерфейс. Некоторые опции были названы по-другому и располагались не там, где их эквиваленты для WebHelp, но все равно оказались под рукой. В Flare 10 добавили новый, более лёгкий в использовании, редактор оболочек HTML5 и адаптивный вывод в виде набора новых вариантов в редакторе оболочек HTML5 и редакторе целевых файлов. Вы включаете адаптивный вывод на дополнительной вкладке редактора целевых файлов, устанавливаете контрольные точки на вкладке настройки редактора оболочек HTML5 и устанавливаете различные другие параметры отображения в редакторе оболочек HTML5.

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

Слайд-шоу

Функция слайд-шоу концептуально проста – вы добавляете в топик ряд горизонтальных слайдов, содержащих изображения или другие виды контента, включая «…фрагменты, текст, таблицы и многое другое…» (из справки). Это, как утверждает справка: «…может быть особенно полезно для показа галереи изображений или видео…». Пользователи могут перемещаться между слайдами с помощью кнопок со стрелками по обе стороны от слайда или ряда точек, так называемого «пролистывателя», под каждым слайдом. (Вы также можете заменить точки миниатюрами изображений).

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

01

Вы можете видеть навигационные стрелки по обе стороны от слайда и точки пролистывателя под слайдом. Следующее изображение показывает слайд 2 того же топика, на этот раз с таблицей.

02

В дополнение к показу «галереи изображений», думаю, что функция слайд-шоу может решить вековую проблему топиков, описывающих задачи. Золотое правило при проектировании топика, содержащего список пронумерованных шагов – избегать ссылок, которые ведут пользователя вне этого списка или потока. Это правило не позволяет использовать якорные (или, как их ещё называют, прыжковые) ссылки [Ссылки, расставляемые в пределах одной страницы и позволяющие «прыгать» по ней. Прим.пер.] Авторы обычно используют вместо них всплывающие окна, раскрывающиеся списки или «переключатели» [Функция, позволяющая «переключаться» между отображением/скрытием тегированной части контента. Пользователь видит «точку доступа», – любой текст или изображение – нажатие на которую разворачивает скрытый текст. Прим.пер.], но каждый из этих типов имеет недостатки. Всплывающие окна заслоняют часть основного топика и не могут содержать большое количество материала. Раскрывающиеся списки не закрывают основной топик, но могут содержать столько материала, что читатели начинают терять вертикальное положение в основном топике. «Переключатели» могут содержать так много блоков контента, выскакивающего на всём протяжении топика, чтобы читатели снова начинают терять вертикальное положение.

Слайд-шоу, на мой взгляд, устраняет эти проблемы, позволяя автору добавлять к слайд-шоу такое количество материала, какое им нужно, но без изменения расположения взгляда читателя в топике. Другими словами, читатели открывают слайд-шоу, смотрят его по горизонтали, а затем продолжают чтение по вертикали. Это может быть очень полезно не только в любом описательном топике, содержащем пронумерованные шаги, но и в топиках, которые содержат длинные, сложные отступления.

Eclipse Help

Я очень мало работал с Eclipse Help, поэтому оставлю его для других рецензентов, которые и опишут его детально. (Дополнительную информацию о Eclipse Help см. «Документирование проекта с помощью системы Eclipse Help» на https://www.ibm.com/developerworks/library/os-echelp/).

Поддержка Flare для Eclipse Help делает его полезной опцией для разработчиков Eclipse. Особенности Flare позволяют создавать автономную документацию или контекстно-зависимую справку, создавать справки, которые могут работать с сервера или локально, и распространять выходные данные в виде набора файлов в папке или инкапсулировать как один файл JAR (Java Archive). Заметим, что использование Eclipse Help в Flare требует дополнительной настройки, в том числе загрузки и установки JRE (Java Runtime Environment) и Java v.7, Update 45 на ваш ПК.

Экспорт проекта

Эта функция является расширением функции Zip-архивации проекта (в группе Сохранить на вкладке Проект), которую Flare предлагает для нескольких версий. Эта возможность является простым и быстрым способом упаковать проект в Zip-архив или отправить на другой адрес – на ноутбук, чтобы работать в дороге, например. Минусом функции Zip-архивации проекта было то, что она просто архивировала весь проект и сохраняла его в определённом месте или прикрепляла к электронной почте. Функция Экспорт проекта может больше.

С Экспортом проекта вы также можете заархивировать проект, но теперь есть возможность извлечения и сжатия частей проекта на основе выходных целей, условий или тегов файлов – все файлы, которые формируют Canadian HTML5, например. Вы также можете сохранить экспортированный проект в формате для экспорта, разархивировать его или сохранить в качестве шаблона Flare. (Эта последняя функция может быть очень полезна, но вынуждает автора использовать продуманные и точные имена проектов, чтобы проекты не смешались с шаблонами с похожими именами).

(продолжение следует)

Источник: MadCap Flare 10 – A Review

Тэги: , , , , ,

< Вернуться к списку публикаций

Облако тегов