Файлы справки Windows - какие параметры?

В прежние времена Help не было тривиальным, но возможно: сгенерируйте некоторый funky.rtf файл со специальными тегами, запустите его через компилятор, и у вас есть файл WinHelp (.hlp), который действительно работает очень хорошо.

Затем Microsoft решила, что WinHelp больше не будет хип и круто, и переключился на CHM, вплоть до того, что они фактически остановили WinHelp от Vista.

Теперь CHM может быть приятным, но все, кто пытался открыть файл .chm в сети, будут знать, что красивый экран "Навигация к веб-странице был отменен", вызванный ограничениями безопасности.

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

Bottom Line: Я нахожу CHM абсолютно непригодным для использования. Но с WinHelp, который больше не является вариантом, интересно, какие альтернативы есть, особенно когда дело доходит до интеграции с моим приложением (т.е. Для WinHelp и CHM есть функции, которые позволяют вам напрямую перейти к теме)?

PDF имеет недостаток в требовании Adobe Reader (или одного из более легких, который не многие используют). Я мог бы жить с этим наблюдением, поскольку сейчас это стандарт, но можете ли вы надежно сказать, чтобы перейти к заданной странице/якорю?

HTML файлы кажутся лучшим выбором, тогда вам просто нужно иметь дело с разными браузерами (CSS и прочее).

Изменить: Я ищу, чтобы создать свои собственные файлы справки. Поскольку я являюсь поклонником философии "Нет установки, просто извлечения и запуска", у меня была эта проблема много раз в прошлом, потому что многие из моих пользователей запускают ее из сети, что вызывает именно эту проблему.

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

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

Ответ 1

HTML будет лучшим выбором, ТОЛЬКО ЕСЛИ вы будете обслуживать их с общедоступного веб-сервера. Если вы попытались связать его с вашим приложением, все файлы (и изображения (и таблицы стилей (и...))) сделают CHM похожим на подарок от богов.

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

OTOH, еще одна ошибка о файлах CHM: даже если вы попытаетесь открыть CHM файл на локальном диске, вы можете столкнуться с блокировкой безопасности, если вы изначально загрузили его откуда-то, потому что файл может быть отмечен как "получен из внешнего источника", когда он был получен.

Ответ 2

Мне не нравится опция html и на самом деле перешел с простого HTML на CHM, сжимая и индексируя их. Даже используйте их даже на нескольких клиентах, отличных от Windows. Он просто решил постоянные небольшие поломки людей, помещающих его в сеть (ограничение глубины вложенности, странные эффекты блокировки), антивирус, который умер в каталогах с 30000 html файлами и 20-минутное время декомпрессии при установке в более старой системе, зонах безопасности браузера и функции, просчет необходимого места в установщике и т.д.

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

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

Между тем у нас также есть собственный компилятор, поэтому мы свободны от MS в будущем. Это не значит, что мы никогда не изменимся (решения с локальными веб-серверами кажутся фаворитами в наши дни), но по крайней мере у нас есть выбор.

Ответ 3

Возникает вопрос, как создавать собственные файлы справки или какой формат файла справки лучше всего?

Лично я считаю CHM отличным. Одной из первых вещей, которые я делаю при настройке машины, является загрузка руководства PHP в формате CHM (http://www.php.net/download-docs.php) и добавление горячей клавиши к нему в Crimson Editor. Поэтому, когда я нажимаю F1, он загружает CHM и выполняет поиск слова, в котором находится мой курсор (отлично подходит для быстрой ссылки на функцию).

Ответ 4

Наше программное обеспечение распространяется как локально для клиентов, так и через сетевой ресурс. Мы решили создать как файл CHM, так и набор файлов HTML для работы в сети. Пользователи, запускающие программу локально, используют CHM файл, а пользователи, получающие свою программу от общего сетевого ресурса, должны использовать файлы HTML.

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

Пока все однотипные типы для Windows кажутся разбитыми так или иначе:

WinHelp - устаревший
HtmlHelp (CHM) - устаревший на Vista, не работает из сетевого ресурса, кроме этого работает очень приятно
Microsoft Help 2 (HXS) - похоже, это работает вплоть до момента, когда это не так, поврежденные индексы или аналогичные, это используется Visual Studio 2005 и выше, в качестве примера

Ответ 5

Если вы не хотите использовать установщик, и вы не хотите, чтобы пользователь выполнял какие-либо дополнительные шаги, чтобы разрешить CHM файлы по сети, почему бы не вернуться к WinHelp? Vista не включает WinHlp32.exe из коробки, но она свободно доступна как загрузка для Vista и Server 2008.

Ответ 6

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

Справочный источник DITA компилируемый XML, хранящийся в SCC (ClearCase).
Редактирование справки XMetal
Компиляция справки, настроенная Откройте DITA Toolkit с пользовательской предварительной обработкой Perl/Java
Источник справки перекрестно ссылается на ресурсы приложений во время компиляции, файлы .RC и т.д.
Сопоставление результатов из одного источника, PDF, CHM, Eclipse Help, HTML.
Репозиторий с одним источником создает помощь для нескольких продуктов 10+ с тысячами разделяемых тем.

Из того, что вы описали, я бы посмотрел на Eclipse Help, его не просто интегрировать в .NET или MFC-приложения, вам в основном нужно сделать сопоставление справки для разрешения запроса на URL-адрес, а затем запустить URL-адрес в оболочку справки Eclipse или браузера.

Ответ 7

Если вы делаете "просто извлечение и запуск", вы будете сталкиваться с проблемами безопасности. Это особенно верно, если вы используете Vista (или позже). есть ли причина, по которой вы хотели избежать упаковки ваших приложений внутри установщика? Использование установщика облегчит проблему "внешнего источника". Вы могли бы без проблем использовать файлы .chm.

Мы используем InstallAware для создания наших пакетов установки. Это не дешево, но очень хорошо. Если вы беспокоитесь о стоимости, WIX является открытым исходным кодом и довольно надежным. У WIX есть кривая обучения, но с ней легко работать.

Ответ 8

PDF имеет недостаток в требовании Adobe Reader

Я использую Foxit Reader в Windows дома и на работе. Гораздо меньше и очень быстро открывается. Очень удобно, когда вам интересно, что такое a80000326.pdf и почему он засоряет папку ваших документов.

Ответ 9

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

Я планирую, чтобы содержимое загружалось в огромную серию файлов XML, каждая из которых содержала помощь для определенного элемента. Этот XML будет содержать ссылки на другие файлы XML. Мы будем использовать XSLT для отображения содержимого по мере необходимости.

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

Ответ 10

Я использую коммерческий пакет под названием AuthorIT, который может генерировать несколько различных форматов, таких как chm, html, pdf, word, windows help, xml, xhtml и некоторые другие, о которых я никогда не слышал (дита звонит в колокольчик?). Это система управления контентом, ориентированная на потребности разработчиков технической документации. Преимущество состоит в том, что вы можете использовать и повторно использовать один и тот же контент для создания набора руководств, а затем генерировать их в разных форматах.

Итак, нижняя строка относительно вопроса о выборе chm или html или что-то еще, что если вы используете это, вы не заблокированы в заданный формат, но можете предоставить несколько из них, которые пользователь может выбрать, и вы можете даже добавьте больше форматов по мере продвижения, без каких-либо дополнительных затрат.

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