Windows файлы справки - Какие есть варианты?

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

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

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

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

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

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

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

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

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

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

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

До сих пор все однофайловые типы для Windows кажутся сломанными в той или иной степени:

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

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

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

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

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

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

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

PDF имеет недостаток, требующий Adobe читателя

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

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

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

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

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

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

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