Будущее направление форматов файлов справки

StackOverflow https://stackoverflow.com/questions/396930

  •  29-08-2019
  •  | 
  •  

Вопрос

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

Помощь в победе
- устаревший

HTMLHelp (CHM)
- не поддерживается в Vista по умолчанию
- плохо работает с общим сетевым ресурсом

Справка 2 (HXS)
- Я понимаю, что это используется в VS2005 + для отображения справки

Веб-сайт на основе
- Может быть сложно управлять несколькими версиями

Какой формат файла справки вы бы использовали в новом приложении (C #), которое предоставляет несколько версий из одной и той же кодовой базы?

Мы хотели бы использовать CHM help, однако, похоже, это не то направление, в котором Microsoft хочет, чтобы мы двигались.

Кто-нибудь использует HXS для своих файлов справки?

Обратная связь оценена по достоинству


Обновление, основанное на комментариях lassevk;

Похоже, что справка HXS не предназначена для использования в обычных проектах справки.


Нет правильного решения

Другие советы

Что именно заставляет вас думать , что в Windows Vista нет средства просмотра default .chm ?(Безусловно, он есть на моем компьютере, а также на моей коробке Win7)

Вы можете перепутать .chm с .hlp (Microsoft действительно прекратила поддержку .hlp в vista, затем в конечном итоге возобновила ее в центре обновления Windows)

Итог :файлы .chm, похоже, по-прежнему поддерживаются во всех версиях Windows, и единственной реальной альтернативой файлам .chm, о которых я знаю, является .html

this.Mode = Modes.Rant;

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

Я не могу сказать вам, сколько раз новый формат HXS полностью закрывал мою справку Visual Studio при интеграции третьими сторонами.Вы могли бы сказать, что это ошибка сторонних установочных средств, но в течение довольно долгого времени не было НЕТ документация о том, как это сделать, поэтому им пришлось выбирать между обратным проектированием (и иногда ошибаться) или вообще не интегрировать.Я до сих пор не знаю, работает ли интеграция, но в эти дни я просто переключаю Visual Studio на использование интерактивной справки.В основном это просто работает, тогда как встроенная справка неизменно отображается на индикаторе выполнения, который просто блокирует Visual Studio до тех пор, пока она не перестроит файл справки, за исключением того, что этого не произошло, потому что файлы теперь повреждены, поэтому каждый раз, когда я нажимаю F1, Visual Studio просто блокируется, если я не убью программу DEXPLORE любое количество раз.

Как это привело к решению какой-либо проблемы, я до сих пор не знаю.

Во-вторых, инструменты должны присутствовать.CHM viewer присутствует в pre-Vista, а не в Vista, но инструменты, необходимые для отображения HXS, отсутствуют в pre-vista, но я полагаю, что они есть в Vista.Отлично, так что теперь у меня есть выбор между использованием одного формата, который должен быть установлен пользователем на компьютере пользователя, или ...ошибка, еще один, который необходимо настроить на компьютерах других пользователей.Правильно.

this.Mode = Modes.JustTicked;

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

Я бы предпочел иметь блестящую помощницу файл хотя.

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

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


Редактировать:Хм, беглый взгляд на справочные страницы для получения справки и руководства, продукт, который мы используем, имеет это можно сказать о HXS:

Справка Visual Studio также известна как MS Help 2.0.Первоначально этот формат справки должен был стать преемником HTML Help.Однако затем Microsoft отложила его выпуск на неопределенный срок, и теперь ясно, что он никогда не будет выпущен в формате справки для обычных пользовательских приложений.

Пожалуйста, обратите внимание, что это специальный формат справки, который используется только для документирования программных компонентов сторонних производителей, предназначенных для интеграции в Visual Studio .NET.Он не подходит ни для каких других целей и не может быть использован в обычных проектах справки для прикладных программ!

Я думаю, тогда HXS полностью исключен из обсуждения.


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

Для меня CHM по-прежнему является ответом.Я создаю CHM-файлы с помощью Инструмент для создания файлов справки Sandcastle это доступно на Codeplex.

Опасения по поводу доступности CHM обоснованны.Чтобы решить эту проблему, я довольно легко создал конвертер CHM-to-Web, немного взломав IStorage, выполнив текстовый поиск и замену и XSL-преобразование. Эта страница это веб-сайт, который был создан автоматически примерно за 8 секунд.Он имеет древовидный вид расширения / свертывания в левой части навигации.Основанный на фреймах (не очень удобный для URL-адресов), но он работает достаточно хорошо.

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

По какой-то причине Microsoft просто плохо разбирается в файлах справки.Интерактивная справка для Visual Studio / SQL Studio / Office ужасна, MSDN - беспорядок, CHMS неуклюжи, а поиск Microsoft никогда не возвращает результаты, которые вы действительно хотите.(Просто мое мнение :)

Компания Adobe RoboHelp может использоваться для создания справочного контента, содержащего контент / индекс / поиск / глоссарий и работающего в браузере в формате HTML.Поддерживает 35 языков.

У нас есть веб-приложение на основе Flex, которое использует это для управления содержимым справки приложения.Приложение Flex и его справочная система работают в большинстве браузеров Windows / MacOSX / Linux.

Несколько обновленных мыслей для тех, кто все еще читает этот вопрос...

Согласно Википедии, Microsoft приняла решение о Вспомогательный язык разметки Microsoft после отказа от помощи 2.

Существует также Справочная система Microsoft, который поставляется с Visual Studio 2010.

Лицензировано под: CC-BY-SA с атрибуция
Не связан с StackOverflow
scroll top