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

Корректная работа 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 в качестве браузеров по умолчанию.

 

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

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

Как вставить тесты в 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-файлов. Программа не требовательна к ре...

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

KEL CHM Creator — бесплатная программа д…

Если вам нужно создать CHM-файл, и вы больше не хотите пользоваться глючной программой HTML Help Workshop, тогда KEL CHM Creator — это ваш вариант. Программа позволяет...

Читать полностью...
ключевые слова

Ключевые слова в Help+Manual…

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

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

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

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

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