Блог технического писателя Ильи Жукова

Настройка окна справки в формате EWriter

EWriter — это формат справки и электронных книг для Windows от разработчика Help+Manual, компании EC Software. Несмотря на то, что формат EWriter не так популярен, как CHM и WebHelp, внешний вид документа EWriter как вызывал, так и вызывает много вопросов. В этой статье я расскажу, как настроить внешний вид окна документа в формате EWriter.

 

Что есть что

Для начала разберемся, что есть что в окне EWriter, и о каких настройках пойдет речь. Для примера возьмем WebHelp, развернутый здесь (исходник можно скачать по ссылке) и соберем из него документ в формате EWriter. Подробную информацию об устройстве EWriter смотрите в материале Формат EWriter. В статье можно ознакомиться с другими вариантами дизайна EWriter, а также с инструментами для его сборки. После сборки будет открыто окно с документом примерно следующего вида.

 

окно EWriter

 

Все, что отображается внутри окна, это WebHelp (веб-сайт, веб-приложение). В этой статье настроек внешнего вида WebHelp я касаться не буду.

 

меню окна EWriter

 

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

Еще один важный нюанс. Чтобы получить документ EWriter такого вида, я использовал первую версию бесплатного сборщика EWriter - The eBook Compiler для Windows XP и Vista. Последняя актуальная версия сборщика 2.6 (для Windows 7 – 11, скачать можно здесь) по умолчанию дает внешний вид, как показано на следующем рисунке. Но плоский дизайн – это дело вкуса.

 

меню окна EWriter с плоским дизайном

 

Как настроить меню

Чтобы настроить меню, в окне сборщика EWriter - The eBook Compiler перейдите на вкладку Menu.

 

настройка меню окна EWriter

 

Чтобы отключить меню, снимите соответствующий флажок:

  • Include an Application Menu – отключить главное меню.
  • Browser window has custom right-click menu – отключить контекстное меню.

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

 

главная кнопка меню EWriter

 

Выделенный элемент меню можно переместить вверх / вниз / в подменю (если подменю добавлено). Можно задать тип элемента меню, его название и команду. Выделенный элемент меню можно также удалить. При необходимости в меню можно добавить новый элемент, разделитель или подменю. Кнопка Reset позволяет сбросить все пользовательские настройки меню.

 

настройки элемента меню

 

Поддерживаются следующие типы элементов меню:

  • Command - Команда – для команды далее нужно выбрать одну из поддерживаемых команд.
  • Page link - Ссылка на страницу документации – выбрать HTML-файл документа.
  • Web-link - Ссылка на веб-ресурс – ввести ссылку.
  • Execute external file - Вызов внешнего файла – позволяет запустить программу или открыть внешний файл; ввести путь к файлу, имя файла и параметры его вызова.
  • Submenu - Подменю – указать название.
  • Splitter - Разделитель.

 

При помощи элемента Web link можно создать пункт меню Обратная связь, который будет запускать почтовую программу, выбранную в ОС Windows для работы с почтой по умолчанию, создавать письмо с заданными адресом и темой. Формат ссылки следующий:

 

Код:

mailto:e-mail?subject=Вопрос по книге о HelpNDoc

 

типы элементов меню

 

Для типа элемента меню Command можно выбрать следующие команды:

  • :home– позволяет открыть страницу документа, заданную для открытия по умолчанию при запуске файла EWriter; элемент меню можно назвать Главная или Домой.
  • :back – перейти к последней открытой странице; Назад.
  • :forward – перейти к следующей странице; Вперед.
  • :selectall – выделить весь контент на странице; Выделить всё.
  • :copy – копировать выделенный контент в буфер обмена; Копировать.
  • :print - распечатать текущую страницу; Печать.
  • :exit – закрыть электронную книгу; Выход или Закрыть.

 

поддерживаемые команды

 

В настройках безопасности на вкладке Protection (Защита) можно запретить копирование контента и печать страниц электронной книги. В этом случае команды Выделить все, Копировать и Печать в меню электронной книги будут неактивными. А кнопка Печать в строке заголовка окна будет скрыта.

Контекстное меню настраивается аналогичным образом.

 

Как задать название документа

Название документа, которое отображается в строке заголовка окна EWriter, по умолчанию My eBook title, задается на вкладке Source (Исходные данные) в поле Book title (Заголовок книги). Обратите внимание на флажок Display title of HTML pages in eBook title bar (Отображать заголовок HTML-страницы в строке заголовка окна электронной книги). По умолчанию он помечен. При таких настройках пользовательский заголовок книги будет отображаться только во время запуска файла электронной книги, то есть первые несколько секунд. Когда будет открыта страница книги, выбранная как страница по умолчанию, в строке заголовка окна появится заголовок текущей страницы. Далее в строке заголовка окна будут отображаться заголовки страниц, выбранных в содержании.

 

название электронной книги EWriter

 

Сборка EWriter из проекта Help+Manual

Документацию в формате EWriter можно также собрать из проекта Help+Manual. Настройки, аналогичные описанным выше, можно найти в дереве проекта, выбрав Configuration \ Publishing Options \ eBooks ..\ EWriter eBooks for Windows. Пользовательский интерфейс с настройками меню на вкладке Menus and Translation (Меню и перевод) такой же, как в сборщике EWriter - The eBook Compiler.

Название документа, которое отображается в строке заголовка окна EWriter, задается в поле Help title в настройках проекта Configuration \ Common Properties \ Title & Copyright.

 

Добавить комментарий

Последние статьи

Книга «Документирование программного обе…

Книга Татьяны Анатольевны Макаровских представляет собой реферативную подборку материалов, посвященных документированию программных средств. Данное учебное пособие адр...

Читать полностью...

Книга «Профессия технический писатель ил…

Если вы ничего не знаете ни о технических писателях, ни о технической документации, эта книга для вас! Книга Михайлова А.В. идеально подойдет студентам-технарям или ст...

Читать полностью...

Как вставить тесты в CHM и WebHelp…

Форматы электронной документации CHM, WebHelp и EWriter давно используются для создания и распространения электронных книг и учебников. Разработать такое учебное пособ...

Читать полностью...

Оформление рисунков в Help+Manual при по…

Рисунки в проекте Help and Manual можно единообразно оформить тремя способами. Во-первых, это можно сделать в графическом редакторе, например в Impict. Во-вторых, для ...

Читать полностью...

Подключение таблицы стилей к проекту Hel…

При работе с форматами, основанными на HTML, для оформления контента в документах можно использовать каскадные таблицы стилей, cascading style sheets или CSS. Данная т...

Читать полностью...

Формулы в HTML Help (CHM)

Я по образованию филолог. Специализируюсь на разработке пользовательской документации на английском и русском языках. С формулами в документации сталкиваюсь редко и по...

Читать полностью...

Импорт документов MS Word в Help+Manual…

Часто технический писатель получает исходные данные от аналитиков, разработчиков, тестировщиков, маркетологов и других специалистов в форматах DOC, DOCX и RTF (реже, и...

Читать полностью...

Поиск в WebHelp находит удаленные раздел…

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

Читать полностью...

Контекстная справка в приложениях Window…

Понятие контекстной или контекстно-зависимой справки (от англ. context-sensitive help) появилось в 1987 году с выходом формата WinHelp. Изначально контекстная справка ...

Читать полностью...

Как поддерживать скриншоты в актуальном …

Рисунки, схемы, скриншоты и другие изображения являются неотъемлемой частью любой пользовательской документации. Один скриншот с выносками может дать начинающему польз...

Читать полностью...

Книга «Разработка технической документац…

Уважаемые коллеги! Если вам нужно быстро освоить разработку документации по ГОСТ, рекомендую обратить внимание на книгу В.А. Глаголева «Разработка технической документ...

Читать полностью...

Перевод выходных документов в Help and M…

Выбрав русский язык и русскую кодировку в настройках проекта Help and Manual, многие авторы после первой сборки удивляются, увидев в выходных документах английские сло...

Читать полностью...

Размер и расположение окна CHM при перво…

Разработчик справки в формате CHM может задать размер и расположение окна, которые будут использоваться при первом запуске CHM-файла. После того, как пользователь пере...

Читать полностью...

Рваные края скриншотов в Help and Manual…

Многие платные редакторы скриншотов, например, SnagIt, FastStone Capture и др., умеют создавать эффект рваных краев. В сети Интернет можно найти множество видеоуроков ...

Читать полностью...
новое в Help and Manual 9

Новое в Help and Manual 9

23 ноября 2022 года компания EC Software к 25-летнему юбилею выпустила 9-ю версию программного комплекса Help and Manual (выходит c 1997 года). Комплект шаблонов Premi...

Читать полностью...

Создание CHM-справки в бесплатной програ…

KEL CHM Creator — это «новая» хорошо забытая программа, выпущенная в 2012 году, предназначенная для создания и декомпиляции CHM-файлов. Программа не требовательна к ре...

Читать полностью...

Все о справке и документации для пользователей!

Следить за новыми статьями:

© Илья Жуков, 2019-2025. Охраняется законом об авторском праве.