Дистрибутивные файлы

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

Справка HTML:

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

Классический Winhelp:

Winhelp Заметьте, что Windows Vista не поддерживает Winhelp. Если Вы хотите быть совместимым с Vista, Вы должны перейти к другому формату справки. всегда состоит из двух файлов: A. Файла .HLP, содержащего основную часть справки и .CNT файла, содержащего Содержание. Если Вы забудете включить .CNT файл, ваша справка будет функциональна, но не будет иметь Содержания.

Броузерная справка:

Броузерная справка - фактически замкнутый web сайт. Как любой web сайт, она состоит из большого количества отдельных файлов, включая файлы HTML, графические файлы, файлы JavaScript и другие файлы. Если Вы имеете большой проект справки, ваша Броузерная справка может легко состоять из нескольких сотен файлов. Вы должны передать все файлы в каталоге вывода на ваш сервер, чтобы Броузерная справка работала должным образом! Кроме того, Вы должны передать все файлы в тот же каталог! Не делайте никаких изменений в этих файлах. Например, не изменяйте регистр имен файла.

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

Adobe PDF:

Вывод Adobe PDF всегда состоит из единственного .PDF файла.

Help & Manual eBook:

Help & Manual eBook состоит из единственного исполняемого .EXE файла, который содержит и содержание eBook, и программу средства просмотра, которая должна отобразить справку. Этот файл полностью замкнут, и это - единственный файл, который Вы должны распределить.

MS Word RTF:

MS Word RTF выводится к единственному .RTF файлу. Однако, если файл содержит изображения, графические файлы являются внешними и должны быть распределены с .RTF файлом, иначе пользователь не будет в состоянии видеть их.

Справка Visual Studio / MS Help 2.0:

Справка 2.0 обычно выводится к единственному, замкнутому .HXS файлу. Это - единственный файл, который Вы должны распределить. Однако, Вы можете также выбрать опцию, чтобы создать и .HXS файл и отдельный .HXL файл в Проект > Свойства проекта > Справка Visual Studio > Имена и Опции. Пожалуйста отметьте, что этот формат не проектирован для общей справки для пользовательских приложений! Справка Visual Studio используется только, чтобы документировать компоненты программирования, добавленные к Visual Studio .NET, и компилятор может использоваться только в комбинации с пакетом Visual Studio .NET! Этот формат справки является полностью несоответствующим для нормальной справки и документации приложений!

См. также:

Форматы справки (Справочная информация)