2008-12-29 9 views
19

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

WinHelp
- устаревшее

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

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

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

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

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

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

Feeback оценили


Update основан на lassevk комментарии;

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


ответ

4
this.Mode = Modes.Rant; 

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

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

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

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

this.Mode = Modes.JustTicked; 

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

Я бы скорее попросил блестящую помощь файл.

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

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


Edit: Хм, быстрый взгляд на страницах справки для справки и Руководства по продукту мы используем, имеет this to say about HXS:

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

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

Я предполагаю, что HXS полностью со стола.


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

+0

спасибо ... похоже HXS полностью покинуть пределы. – Helios

+0

Возможно, нам просто нужно подождать Windows 7, чтобы узнать, что они там будут делать. И снова, опять же, в Windows 8. ...: D –

4

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

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

2

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

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

+2

CHM - это просто HTML, который индексируется и сжимается. Есть зрители с открытым исходным кодом и (де) компрессоры –

1

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

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

10

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

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

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

1

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

Согласно Википедии, Microsoft решила на Microsoft Assistance Markup Language после отказа от справки 2.

Существует также Microsoft Help System, что и корабли с Visual Studio 2010.