Будущее направление форматов файлов справки - PullRequest
20 голосов
/ 29 декабря 2008

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

WinHelp
- устарел

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

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

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

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

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

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

Отзыв оценили


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

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


Ответы [ 6 ]

10 голосов
/ 11 ноября 2009

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

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

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

4 голосов
/ 09 марта 2009

Для меня CHM все еще ответ. Я создаю файлы CHM с помощью инструмента *1002*, который доступен в Codeplex.

.

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

4 голосов
/ 29 декабря 2008
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 также называется MS Help 2.0. Первоначально этот формат справки был задуман как преемник справки HTML. Однако затем Microsoft отложила выпуск на неопределенный срок, и теперь стало ясно, что он никогда не будет выпущен в качестве справочного формата для обычных пользовательских приложений.

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

Полагаю, тогда HXS полностью сошел со стола.


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

2 голосов
/ 09 марта 2009

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

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

1 голос
/ 11 ноября 2009

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

Согласно Википедии, Microsoft выбрала Язык разметки помощи Microsoft после отказа от справки 2.

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

1 голос
/ 02 июня 2009

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

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

...