Какой формат файла справки рекомендуется использовать в современном приложении Windows? - PullRequest
10 голосов
/ 23 ноября 2011

Я занимаюсь разработкой приложения для WinForms и хотел бы включить в него справку. В прошлом я интегрировал файлы справки .chm.

Что касается файлов .chm, эта статья в вики гласит:

В 2002 году Microsoft объявила о рисках безопасности, связанных с форматом .CHM, а также бюллетенях по безопасности и исправлениях. С тех пор они объявили о своих намерениях не развивать далее формат .CHM.

Из того, что я прочитал, справка Microsoft 2.x была механизмом справки, который использовался в VS 2008 и Office 2007 с использованием файлов справки с расширением .hxs.

Что используется в Office 2010? Какой формат файла справки рекомендуется использовать?

Обновление:

Я нашел следующую статью MSDN с полезной информацией по этой теме:

Совместимость приложений: поддержка службы поддержки

Ответы [ 2 ]

2 голосов
/ 23 ноября 2011

Sandcastle - http://sandcastle.codeplex.com/ - широко используется. Он имеет несколько выходных форматов, в том числе создание веб-сайта, который вы можете публично или в частном порядке размещать для пользователей своего приложения, что позволяет вам вносить обновления по мере необходимости без необходимости развертывания новых файлов справки для всех пользователей по отдельности.

Вы также можете использовать Sandcastle для создания файлов, которые интегрируются с программой просмотра файлов справки MS, встроенной в Windows. Я не знаю, является ли это «официально» лучшим методом, но он хорошо работает.

Единственное предостережение с Sandcastle в том, что у него есть немного кривой обучения.

Также представляет интерес: http://en.wikipedia.org/wiki/Microsoft_Assistance_Markup_Language. MAML определяет общую схему для описания очень широкого спектра сценариев помощи / документации. MAML позволяет документировать функциональность конечного пользователя, а также задачи уровня API. В зависимости от вашей аудитории, это может иметь большое значение. Sandcastle включает в себя множество шаблонов MAML.

1 голос
/ 29 ноября 2011

Рекомендованным, вероятно, является клиент Assistance Platform (HelpPane.exe) с расширениями .h1s, которые по умолчанию поддерживаются Vista и W7, а также в последних версиях Office

Afaik h2s (а теперь и html3)поддерживается только VS.

Но поскольку Asistance Platform является VIsta +, если вам все еще нужно поддерживать XP, вы застряли с CHM

...