Если Вы не знакомы с Visual Studio .NET, Вы действительно не должны задумываться о работе со Справкой Visual Studio (Help 2.0). Это - чрезвычайно сложная система справки, и компилятор хитрый и очень придирчивый.
Необходимые установки:
Компилятора Help 2.0 требует "Пространства имен" и "Уникального идентификатора" (также называемого "Уникальный ID заголовка" в документации). Оба должны быть введены, иначе компилятор выдаст сообщение об ошибках. (Пространство имен используется, чтобы вызвать средство просмотра справки, Уникальный идентификатор походит на ID раздела для всего файла справки.)
В Help & Manual Вы можете ввести эти установки в Проект > Свойства проекта > Справка Visual Studio > Имена и опции.
Регистрация требуется для файлов справки .HXS:
В отличие от .CHM файлов Справки HTML файлы, Вы не можете просто дважды щелкнуть на файле .HXS Справки Visual Studio, чтобы запустить его. Он должен быть сначала установлен и регистрирован с Инсталлятором MS.
Когда Вы компилируете файлы .HXS с Help & Manual, они устанавливаются и регистрируются автоматически на вашей машине так, чтобы Вы могли рассмотреть их там. Однако, когда Вы распределяете ваши файлы, Вы должны конфигурировать Инсталлятор MS, чтобы сделать это. См. документацию инсталлятора и VS.NET для деталей.
Ссылка на файлы в ваших шаблонах раздела HTML:
Если Вы ссылаетесь на какие-нибудь дополнительные файлы в ваших шаблонах раздела HTML, Вы должны добавить их к Секции Багажа в Свойствах проекта. MS Help 2 не имеет ничего типа файла .HHP, с которым Вы можете сказать компилятору включить дополнительные файлы. (Еще одно удивительное ограничение по сравнению с другими более ранними форматами справки Microsoft.)
Если Вы добавите файлы к Секции Багажа, то они будут включены в ваш компилируемый вывод автоматически.
Опция "Не компилировать" для отладки:
Help & Manual поддерживает две разных опции компиляции для Справки Visual Studio. Обычно Вы будете компилировать законченный файл .HXS, который будет потом автоматически регистрирован на вашем локальном компьютере и открыт. Если это не работает должным образом, в диалоге Компиляция файла справки есть также опция отладки:
· | Если Вы выбираете опцию Не компилировать, открыть проект в VStudio, Help & Manual генерирует файл проекта Справки Visual Studio с расширением .HWProj во временном каталоге вывода. Это - маленький файл XML, который действует как обертка для VS.Net. |
· | Когда Вы выбираете эту опцию, временный каталог вывода (в вашем проектном каталоге) не удаляется после того, как Вы компилируете проект. После компилирования Вы может потом использовать файл .HWProj, чтобы открыть и компилировать проектный файл непосредственно в VS.Net, используя опции отладки, доступные там. |
Пример запросов:
Следующие два запроса - только краткие примеры. Более полные детали пожалуйста смотрите в документации VS.NET и VSHIK!
Ручная регистрация файла .HXS:
"C:\Program Files\Microsoft Help 2.0 SDK\hxreg" -n Namespace -i UniqueID -c MyHelpfile.HXS
Запрос на просмотр файла .HXS:
"C:\Program Files\Common Files\Microsoft Shared\Help\dexplore.exe" /helpcol ms-help://ECSoftware
Как Вы можете видеть, в запросе нет никакого имени файла. В вышеупомянутом примере ECSoftware - пространство имен. Средство просмотра найдет файл, только если он было регистрирован правильно. |
См. также:
Справка Visual Studio (Справочная информация)