Синтаксис

Это руководство по синтаксису - справочник для пользователей, знакомых с использованием командной строки. Для подробных инструкций смотрите другие разделы в этой главе.

Пути в командной строке:

Примеры синтаксиса предполагают, что Вы вводите командные строки в каталоге программы Help & Manual, который является обычно C:\Program Files\HelpAndManual4.

Когда Вы делаете это, Вы должны ввести только путь для аргумента проектного файла (project.hmx в руководстве синтаксиса). Все другие аргументы имени файла автоматически используют этот путь, таким образом Вы не должны вводить путь для них, если они сохранены в проектном каталоге. Вы должны ввести информацию пути для всех файлов, сохраненных в любом другом местоположении. Вы можете использовать относительные пути, если хотите - они потом свяжутся с проектным каталогом.

/XML="D:\XML Output\projectb.xml"

Синтаксис командной строки:

helpman.exe "<путь>\project.hmx" /<формат> /<другие переключатели > ...

Всегда заключайте все пути и имена файла, содержащие пробелы, в кавычки.

helpman.exe

Программный файл Help & Manual.

<путь>

Путь к проектному файлу, например "F:\Projects\Help Project\project.hmx". Всегда заключайте это и проектное имя файла в кавычки, если они содержат пробелы. Этот путь используется автоматически для всех других аргументов файла, для которых Вы не вводите пути.

project.hmx

Проектный файл, который Вы хотите открыть. Это должно всегда быть непосредственно после имени программного файла Help & Manual.

/<формат>

Переключатель выходного формата. Это должно всегда быть первым переключателем, введенным после проектного имени файла. Другие упомянутые ниже переключатели могут использоваться в любом порядке, но они должны быть после переключателя выходного формата.

Переключатели:

/CHM (Справка HTML)

/HLP (Winhelp)

/HTML (Броузерная справка)

/HXS (Справка Visual Studio / MS Help 2.0)

/PDF (Adobe PDF)

/RTF (Word RTF)

/EBOOK (Help & Manual eBook)

/XML (пакет файла XML)

Имя выходного файла и путь:

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

Примеры:

/CHM=testproject.chm

/HLP="F:\Final Build\widgethelp.hlp"

/I=<включенные опции>

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

Если Вы не будете определять переключатель /I, то программа будет использовать опции, используемые при последней компиляции в указанном формате.

Важно: Эти опции не выбирают выходной формат!

Формат включенных опций:

ALL Все сборки и определяемые пользователем опции.

CHM (Справка HTML)

HLP (Winhelp)

HTML (Броузерная справка)

HXS (Справка Visual Studio / MS Help 2.0)

PDF (Adobe PDF)

RTF (Word RTF)

EBOOK (Help & Manual eBook)

Заметьте, что нет включенных опций для XML. XML вывод always включает весь проект.

Примеры:

/I=CHM,MYBUILD

/I=HTML,HXS,DEMOVERSION

Если Вы используете переключатель /I, Вы должны также определить включение для текущего выходного формата, как показано в примерах выше, иначе элементы, специально отмеченные только для этого формата, не будут включены.

Вы можете использовать ваши опции тем же способом.

/V = <имя файла>

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

Формат файла:

TITLE=Widget Editor V2.8

EDITORS=John and Jane Doe

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

Примеры:

/V=variables.txt

/V="F:\Data Sources\variables.txt"

/Template=<имя файла >

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

Если Вы не определяете этот переключатель, программа использует шаблон, выбранный для PDF в Свойствах проекта.

/noclose

Оставляет Help & Manual открытым после окончания компилирования (это обычно выходит автоматически).

/keeptemp

Не удаляет временные исходные каталоги и файлы, сгенерированные при сборке Справки HTML, Winhelp и справки Visual Studio / MS Help 2.

/L=<журнал компилятора>

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

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

/debug

Отобразит окно сообщения перед выводом показа пакетных команд, и были ли они распознаны должным образом. Используется для поиска ошибок, если ваша командная строка не работает как ожидается.