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

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

WinHelp
- устарело

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

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

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

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

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

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

Отзыв приветствуется


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

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



person Helios    schedule 29.12.2008    source источник


Ответы (6)


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

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

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

person Brann    schedule 11.11.2009

this.Mode = Modes.Rant;

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

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

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

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

this.Mode = Modes.JustTicked;

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

Хотя я бы предпочел блестящий файл справки.

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

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


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

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

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

Полагаю, тогда HXS полностью исключен из игры.


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

person Lasse V. Karlsen    schedule 29.12.2008
comment
Может быть, нам просто нужно дождаться Windows 7, чтобы узнать, что они собираются там делать. А потом снова в Windows 8. ...: D - person Jonathan Leffler; 29.12.2008

Для меня CHM по-прежнему остается ответом. Я создаю файлы CHM с помощью инструмента Sandcastle Help File Builder, доступного на Codeplex.

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

person Cheeso    schedule 09.03.2009

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

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

person Andy White    schedule 09.03.2009
comment
CHM - это просто индексированный и сжатый HTML. Существуют программы просмотра с открытым исходным кодом и (де) компрессоры. - person Marco van de Voort; 06.09.2009

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

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

Также существует справочная система Microsoft, которая входит в состав Visual Studio 2010.

person Colin Pickard    schedule 11.11.2009

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

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

person RogerV    schedule 01.06.2009