Будущее направление форматов файлов справки
Похоже, что файлы справки CHM больше не являются форматом файла справки по выбору.
WinHelp
- устарел
HtmlHelp (CHM)
- по умолчанию не поддерживается в Vista
- плохо работает на сетевом ресурсе
Помощь 2 (HXS)
- Я понимаю, что это используется в VS2005+ для отображения справки
Основанный на сети
- Может быть трудно управлять для нескольких версий
Какой формат файла справки вы бы использовали в новом (C#) приложении, которое предоставляет несколько версий из одной и той же кодовой базы?
Мы хотели бы воспользоваться помощью CHM, однако это не то направление, в котором Microsoft хочет, чтобы мы двигались.
Кто-нибудь использует HXS для своих файлов помощи?
Отзыв оценили
Обновление на основе комментариев lassevk;
Похоже, что справка HXS не предназначена для использования в обычных проектах справки.
6 ответов
Что именно заставляет вас думать, что в Windows Vista нет программы просмотра.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 присутствует в предварительной версии, а не в Vista, но инструменты, необходимые для отображения HXS, отсутствуют в предварительной версии, но я полагаю, что они в Vista. Хорошо, так что теперь у меня есть выбор между использованием одного формата, который необходимо установить на компьютере пользователя, или... ошибочно, другого, который необходимо установить на компьютере других пользователей. Правильно.
this.Mode = Modes.JustTicked;
Где я работаю, мы отправляем файлы CHM и HTML-версию на основе файлов для тех, кто развертывает свои приложения через общий сетевой ресурс. Что касается Vista, то мы еще не видели этого, но html-версия также работала бы там.
Я бы предпочел иметь блестящий файл справки.
Хорошим результатом html-версии является то, что мы можем ссылаться на те же файлы в веб-модуле, который следует за нашим продуктом. Таким образом, будет только одна версия, которая нужна клиенту.
Мы смотрим на обновление инструмента, который мы используем на работе, поэтому в моем расписании на эту неделю, приятно и тихо на работе, я буду смотреть на различные типы вывода, которые он может производить, среди прочего, HXS.
Изменить: Хм, быстрый взгляд на страницы справки для справки и руководства, продукта, который мы используем, есть что сказать о HXS:
Visual Studio Help также известен как MS Help 2.0. Первоначально этот формат справки должен был стать преемником справки HTML. Однако затем Microsoft отложила выпуск на неопределенный срок, и теперь стало ясно, что он никогда не будет выпущен в качестве справочного формата для обычных пользовательских приложений.
Обратите внимание, что это специальный формат справки, который используется только для документирования сторонних программных компонентов, предназначенных для интеграции в Visual Studio .NET. Он не подходит для каких-либо других целей и не может использоваться для обычных проектов помощи для прикладных программ!
Я думаю, что HXS полностью снят со стола.
Примечание: веб-интерфейс не обязательно означает, что вам нужен веб- сервер, только то, что вам нужен веб- браузер. Независимо от того, интегрируете ли вы его в свое приложение, используете компонент веб-браузера или просто запускаете браузер пользователя по умолчанию, это будет выбор, который вам придется сделать, но большинство выводимых справок через Интернет, которые я видел, не требуют каких-либо настройка сервера вообще.
Для меня CHM все еще ответ. Я создаю файлы CHM с помощью инструмента для создания справочных файлов Sandcastle, который доступен в Codeplex.
Опасения по поводу доступности CHM действительны. Чтобы справиться с этим, я довольно легко создал преобразователь CHM в Web с некоторыми взломами IStorage, текстовым поиском и заменой и XSL-преобразованием. Эта страница является веб-сайтом, который был создан автоматически примерно за 8 секунд. Он имеет вид дерева разворачивания / свертывания в левой части навигационной панели. Основан на фреймах (не очень подходит для URL), но работает достаточно хорошо.
Единственной полезной справочной документацией, которую я когда-либо видел, был простой HTML. Большинство, если не все, проектов с открытым исходным кодом, которые я видел, имеют HTML-страницы справки (для API и справочных документов). Все, что использует собственный формат или требует наличия специального считывателя, рискует устареть (CHM) или столкнуться с проблемами совместимости или раздувания (PDF).
По какой-то причине Microsoft просто плохо справилась с файлами. Онлайн-справка для Visual Studio/SQL Studio/Office ужасна, MSDN - беспорядок, CHM неуклюжи, а поиск Microsoft никогда не возвращает результаты, которые вы действительно хотите. (Просто мое мнение:)
Некоторые обновленные мысли для тех, кто все еще читает этот вопрос...
Согласно Википедии, Microsoft выбрала язык разметки Microsoft Assistance после отказа от справки 2.
Существует также справочная система Microsoft, которая поставляется с Visual Studio 2010.
Adobe RoboHelp можно использовать для создания справочного контента, который имеет контент / индекс / поиск / глоссарий и работает в браузере как HTML-генерируемый. Поддерживает 35 языков.
У нас есть веб-приложение на основе Flex, которое использует его для управления справочным контентом приложения. Приложение Flex и его справочная система работают в большинстве браузеров в Windows/MacOSX/Linux.