Этот раздел описывает основные доступные опции командной строки и как использовать их, вводя команды вручную из подсказки командной строки. См. INI и пакетные файлы для подробностей об автоматизации процесса и для информации об использовании более сложных последовательностей команд.
См. Синтаксис для деталей всех переключателей командной строки и доступных параметров.
Все примеры синтаксиса предполагают, что Вы вводите командные строки в каталоге программы Help & Manual>, который обычно является C:\Program Files\HelpAndManual4. Когда Вы делаете это, Вы должны ввести только путь для проектного файла. Все другие параметры имени файла автоматически используют этот путь, таким образом Вы не должны вводить путь для них, если они сохранены в проектном каталоге.
Однако, Вы должны ввести информацию пути для всех файлов, сохраненных в любом другом местоположении. Вы можете использовать относительные пути, если Вы хотите - они потом отнесутся к проектному каталогу.
Основной синтаксис - открытие проекта Help & Manual из командной строки:
Это - самая простая команда. Она только запускает Help & Manual и загружает указанный проектный файл. Это довольно бессмысленно, но иллюстрирует, как используется командная строка.
· | Перейдите к каталогу программы Help & Manual и введите следующую команду, заменяя F:\My Projects\ путем к вашему проектному файлу и projectfile.hmx именем файла вашего проекта: |
helpman.exe "F:\My Projects\projectfile.hmx"
· | Отметьте использование кавычек! Так как проектный путь содержит пробел, он должен быть заключен в кавычки. То же самое касается любых имен файла в командной строке, которые содержат пробелы. |
Компилирование проекта из командной строки:
Команда компиляции проекта из командной строки весьма похожа. Вы должны только добавить дополнительную команду, известную как "переключатель", чтобы определить выходной формат, который Вы хотите использовать. Следующий пример компилирует проект в файл Справки HTML, используя последнее местоположение вывода и имя файла, которое Вы использовали, когда Вы компилировали вручную. (Значения по умолчанию проектного каталога и имени проекта.)
См. Синтаксис для деталей доступных переключателей выходного формата.
helpman.exe "F:\My Projects\projectfile.hmx" /CHM
Переключатель выходного формата должен всегда быть первым переключателем после имени проектного файла. Все другие переключатели могут входить в любом порядке, но они должны быть после переключателя выходного формата. |
Отметьте использование кавычек! Все пути и имена файлов, которые содержат пробелы, должны быть заключены в кавычки.
Компилирование проекта в другом местоположении и имени файла:
Чтобы компилировать проект в другом местоположении и имени файла только добавьте их к переключателю выходного формата с символом равенства:
helpman.exe" "F:\My Projects\projectfile.hmx" /CHM="F:\My Projects\Help\WidgetHelp.chm"
Отметьте использование кавычек! Все пути и имена файлов, которые содержат пробелы, должны быть заключены в кавычки.
Компилирование в PDF с определенным шаблоном печатного руководства PDF:
Эти примеры генерируют файлы PDF с явно указанным шаблоном печатного руководства. Первый пример предполагает, что шаблон печатного руководства сохранен в проектном каталоге. Второй пример получает шаблон из папки \Templates\Pdf в каталоге программы.
Пример 1:
helpman.exe "D:\Help Project\MyHelp.hmx" /PDF=widget.pdf/Template¤_template.mnl
Пример 2:
helpman.exe "D:\Help Project\MyHelp.hmx" /PDF=widget.pdf /Template="<%PROGPATH>Templates\Pdf\widget.mnl"