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

Корректная работа WebHelp на локальном компьютере

Вряд ли кто-то считает тестирование справки хоть сколько-нибудь сложной задачей. Тестирование документации вообще очень редко упоминается в профильной литературе. Многие скажут: а что тут сложного? Открыл справку, сравнил описание с тем, как работает программа, и всё! А потом приходится читать замечания, написанные так, как будто их писали люди, вообще не имеющие представления о том, что такое справка, где и как она должна работать. Попробуем разобраться, как добиться корректной работы справки в формате WebHelp на локальном компьютере, и какие средства можно для этого использовать.

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

В чем суть вопроса

Документация в формате WebHelp представляет собой веб-приложение с динамическим оглавлением, указателем и полнотекстовым поиском, для работы которого не требуется веб-сервер. Подробнее о WebHelp смотрите статью Формат WebHelp. При открытии WebHelp из сети Интернет особых сложностей не возникает — все работает корректно в любом современном браузере. А вот попытка запустить WebHelp на локальном компьютере может добавить головной боли любому, не знакомому с предметом пользователю.

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

Такая ситуация наблюдается не во всех браузерах. Строго говоря, работа WebHelp на локальном ПК зависит не от браузера, а от движка, который используется в том или ином браузере. Поэтому в браузерах, использующих один и тот же движок, с работой WebHelp будут похожие проблемы. Рассмотрим, как добиться корректной работы WebHelp в самых популярных браузерах: Google Chrome, Internet Explorer, Safari и Mozilla Firefox.

Mozilla Firefox и Safari

В Firefox и Safari динамическое оглавление WebHelp на локальном компьютере работает корректно. Ничего дополнительно делать не требуется. В Mozilla Firefox используется движок Gecko, в Safari — WebKit.

WebHelp в Internet Explorer

В Internet Explorer используется движок Trident. C настройками по умолчанию пользователь Internet Explorer может сам выбрать, блокировать выполнение сценариев и элементов ActiveX, или нет. Если разрешить заблокированное содержимое (нажать на кнопку Разрешить заблокированное содержимое), динамическое оглавление будет работать во время текущей сессии корректно. При частом использовании Internet Explorer для тестирования WebHelp сообщение о безопасности будет выводиться на экран каждый раз при запуске браузера.

Это назойливое сообщение можно легко убрать. Для этого настройте Internet Explorer следующим образом.

  1. Запустите Internet Explorer.
  2. На клавиатуре нажмите Alt (чтобы вывести на экран строку меню, так как по умолчанию она скрыта).
  3. В строке меню выберите Сервис / Свойства браузера.

  1. В окне Свойства браузера перейдите на вкладку Дополнительно.
  2. В группе Безопасность пометьте флажок Разрешать запуск активного содержимого файлов на моем компьютере.

настройка Internet Explorer для корректной работы WebHelp

  1. Нажмите на кнопку ОК и перезапустите Internet Explorer.

 

Примечание. Чтобы WebHelp корректно работал с компакт-диска в Internet Explorer, пометьте флажок Разрешать запуск активного содержимого компакт-дисков на моем компьютере.

 

Google Chrome, Opera и Яндекс.Браузер — решение проблем с WebHelp

В браузере Google Chrome, начиная с версии 28, используется движок Blink. На нем также работают Opera (начиная с версии 15) и Яндекс.Браузер. В данных браузерах при запуске WebHelp с локального ПК динамическое оглавление по умолчанию будет полностью развернуто. При переходе в другой раздел из оглавления в консоли разработчика будут отображаться ошибки.

Обойти данную проблему можно следующими способами:

  1. Можно запустить WebHelp из командной строки в браузере с ключом -- allow-file-access-from-files:

для Chrome: start chrome “путь к Webhelp\index.html” --allow-file-access-from-files

для Яндекс.Браузер: start browser.exe “путь к Webhelp\index.html” --allow-file-access-from-files

Данный способ работает в Google Chrome и в Яндекс.Браузер. Но вряд ли любой пользователь справится с подобной задачей.

  1. Можно вместо WebHelp использовать новый формат EWriter. Данный способ подойдет только для пользователей MS Windows.
  2. Можно для сборки WebHelp использовать новые адаптивные шаблоны 3-й версии, входящие в состав дополнительного набора шаблонов Premium Pack. Данное решение платное.
  3. Можно использовать бесплатный локальный веб-сервер, интегрировав его с системой справки. Существует ряд простейших веб-серверов, позволяющих запускать WebHelp локально без блокировок контента и сообщений о безопасности. С Help+Manual 7 поставляется бесплатный веб-сервер, HM2GO. Он представляет собой файл размером порядка 3 Мб, который входит в состав дистрибутива Help+Manual. Его также можно бесплатно скачать с сайта компании-разработчика и включать в поставки своей документации. Веб-сервер HM2GO будет работать и с оптических носителей информации (компакт-дисков CD и DVD). Подробнее о его настройках и использовании я расскажу в отдельной статье.

 

Подводя итоги сказанного выше, хочу подчеркнуть следующие моменты.

  • Проблем с локальным запуском и тестированием WebHelp не будет у пользователей Help+Manual 7. Данный программный комплекс позволяет запустить WebHelp автоматически сразу же после сборки, используя встроенный веб-сервер HM2GO. Для этого необходимо пометить флажок Display file when publishing is complete. При этом из адресной строки браузера по умолчанию можно скопировать путь к файлу для запуска WebHelp и открыть его параллельно в любом браузере, не закрывая окна Help+Manual. В этом случае WebHelp будет корректно работать в любом современном браузере на локальном ПК.
  • Проблем с локальным запуском и тестированием WebHelp также не будет и у авторов, использующих Mozilla Firefox, Safari или Internet Explorer в качестве браузеров по умолчанию.

 

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

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

Что нового в Help+Manual 8

10 февраля 2020 года вышла 8-я версия Help+Manual. Любой желающий может бесплатно скачать пробную версию с сайта компании-разработчика и оценить ее потенциал. В течени...

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

Работа со стилями в Help and Manual 7

Чтобы внешний вид нового CHM-файла соответствовал оригиналу, необходимо создать стили, применить их к проекту и очистить встроенное форматирование. Это позволит обеспе...

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

Форматы справки для ОС Linux

В рамках замещения импортного программного обеспечения все больше государственных структур переходят на отечественные сборки Linux. Прежде всего, это Alt Linux и Astra...

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

Сборка CHM-файла в Help and Manual

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

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

Основные настройки проекта в Help and Ma…

Если для сборки справки не используется шаблон (skin-file), внешний вид и основной функционал CHM-справки берется из настроек проекта. В этой статье я расскажу о том, ...

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

Импорт CHM в Help and Manual

Программный комплекс Help and Manual позволяет импортировать документацию из ряда форматов, в том числе, из HTML и CHM. Готовую документацию можно загрузить как в суще...

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

Как отредактировать CHM в Help and Manua…

Если вам нужно внести несколько небольших правок в CHM-файл, такую задачу можно успешно решить при помощи бесплатных программ HTML Help Workshop и Notepad++. Серьезная...

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

Как сделать качественные скриншоты

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

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

Внесение изменений и сборка нового CHM-ф…

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

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

Создание и настройка проекта в HTML Help…

Установив необходимые бесплатные программы, мы разобрали исходный файл api.chm и получили 64 файла (подробнее смотрите материал Декомпиляция CHM-файла). Это основная ч...

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

Декомпиляция CHM-файла

Файл в формате CHM представляет собой скомпилированный HTML. В него могут входить HTML-страницы, рисунки, таблицы стилей, скрипты и другие файлы. Подробное описание со...

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

Редактирование CHM бесплатными программа…

Если заказчику или работодателю не принципиально, какое программное обеспечение использовать, я предпочитаю редактировать CHM в Help+Manual 7. Но как показывает практи...

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

Как отредактировать CHM-файл

Пользовательская документация для приложений, работающих в ОС Windows, чаще всего поставляется в формате CHM как встроенная в программу справка. Технические писатели, ...

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

Как создать справку в формате CHM

Формат HTML Help или CHM был разработан компанией Microsoft в 1997 г. Сегодня CHM остается стандартом справки для приложений, работающих в ОС Windows. Средство для про...

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

Бесплатный локальный сервер HM2GO для We…

Одна из моих предыдущих статей была посвящена особенностям работы WebHelp на локальных компьютерах. Некоторые популярные браузеры, в том числе Google Chrome, Opera и Я...

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

Дата в полном формате с месяцем в родите…

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

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

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

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

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