Навигация:  Дополнительные процедуры> Опции командной строки>

.INI и пакетные файлы

Печать этого раздела Предыдущая страницаВернуться к краткому обзору главыСледующая страница

В этом разделе:

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

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

Как создать .INI файл:

Используйте редактора текста, чтобы создать файл простого текста с расширением .INI (например batchcompile.ini) в каталоге проекта, для которого Вы хотите выполнить компиляцию.

(Если Вы используете Блокнот, Вы должны включить имя файла в кавычки, когда Вы сохраняете его, иначе Блокнот автоматически добавит расширение .TXT, приводя к недопустимому имени файла, как finalbuild.ini.txt!)
· .INI файл содержит все переключатели и параметры, которые находятся после имени файлапроекта, с одним переключателем или параметром в строке. Они должны быть введены в точно том же порядке, как Вы ввели бы их в командную строку. Это означает, что переключатель выходного формата всегда находится сначала, сопровождаемый всеми другими переключателями.
· Правила для многократного вывода - такие же, как в командной строке. Сначала первый переключатель выходного формата, сопровождаемый его переключателями, потом следующий переключатель выходного формата, сопровождаемый его переключателями, и так далее.
· Выключатели, которые Вы можете использовать в .INI файле, - точно такие же, как переключатели командной строки. Однако, они должны все быть введены в одну строку, и им не предшествует слэш.
· Кроме того, Вы не должны использовать кавычки в .INI файлах, даже если ваши параметры содержат пробелы! Это очень важно!

Пример:

CHM=F:\Project Files\Help Project\Help\WidgetHelp.chm
I=CHM,FINALBUILD
KEEPTEMP
PDF=F:\Project Files\Help Project\PDF\WidgetHelp.pdf
I=PDF,FINALBUILD
Template=usletter.mnl
L=F:\Project Files\Help Project\Logs\compilerlog.txt

Что делает этот пример .INI файла:

· Первая строка компилирует Справку HTML с определенным каталогом вывода и именем файла. Определение вывода явно позволяет Вам компилировать в другие назначения вручную в Help & Manual, не волнуясь об изменении адресата вывода .INI файла. (Каждый раз Вы при компиляции вручную Вы автоматически сбрасываете адрес вывода по умолчанию.)
· Переключатель Включение опции I=CHM,FINALBUILD включает все отмеченное определяемой пользователем опцией FINALBUILD.  Так как Вы определили пользовательскую опцию, Вы должны также определить CHM, чтобы гарантировать, что все стандартные разделы Справки HTML и элементы также включены (это определено автоматически, если Вы не включаете любую из включенных опций). KEEPTEMP говорит компилятору не удалять временные исходные файлы, используемые, чтобы генерировать вывод Справки HTML.
· Потом тот же проект выводится в PDF, также с определенным каталогом вывода и именем файла. Включенные опции - те же, но с PDF вместо CHM, чтобы включить соответствующие разделы в дополнение к всему отмеченному FINALBUILD. Следующая строка определяет шаблон печатного руководства PDF, который используется для вывода. Так как никакой путь не определен, он, как предполагается, находится в проектном каталоге. Если он сохранен в любом другом местоположении, Вы должны включить путь.
· Наконец, параметр L = хранит все сообщения ошибки компилятора в журнале в указанном местоположении. Если бы никакой путь не был включен, то этот файл сохранился бы в проектном каталоге.

 

Локальные и глобальные переключатели для множественного вывода

Локальные переключатели:

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

/I=<включенные опции> Включенные опции, которые Вы хотите использовать для выходного формата.
/TEMPLATE=<PDF template> Шаблон PDF, который используется для вывода PDF (только для вывода PDF).
/V = <имя файла> Этот переключатель определяет внешний файл, чтобы переопределить значения переменных в вашем проектном файле.

Глобальные переключатели:

Эти переключатели "глобальны". Они применяются ко всем выходным форматам в командной строке, и лучше помещать их в конце командной строки, после всех переключателей выходного формата и их соответствующих локальных переключателей.

NOCLOSE Оставляет Help & Manual открытым после компилирования.
KEEPTEMP Не удаляет временные каталоги и исходные файлы, сгенерированные для вывода Winhelp и Справки HTML. (Относиться только к Winhelp и Справке HTML.)
/L=<журнал компилятора> Выводит журнал компилятора в указанный файл.
DEBUG Показывает информацию отладки для каждого выходного формата перед компилированием.

См. Синтаксис для получения дополнительной информации об отдельных переключателях и параметрах.

Как использовать .INI файл из командной строки:

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

Как обычно, пример предполагает, что Вы работаете из каталога программы Help & Manual.

Пример:

helpman.exe "D:\Help Project\Widget\WidgetHelp.hmx" batchcompile.ini

Это запускает Help & Manual, открывает WidgetHelp.hmx и затем выполняет все команды, определенные переключателями и параметрами, содержащимися в batchcompile.ini.

Как использовать .INI файл из пакетного файла:

Вы можете сделать этот шаг вперед и автоматизировать процесс полностью, помещая командную строку (или строки!) со ссылкой на .INI файл в пакетный файл. Потом Вы можете создать ярлык к пакетному файлу и выполнить весь комплекс процесса компиляции, дважды щелкая на ярлыке. Это делается так:

· Создайте файл простого текста с расширением .BAT (например batchcompile.bat) и храните его в каталоге программы Help & Manual. Потом Вы должны только ввести путь в проектный файл, так как все другие параметры автоматически используют путь проектного каталога.
· Введите каждую командную строку, которую Вы хотите выполнить, на отдельной строке в файле, как показано в примере ниже.

Пример:

@ECHO OFF
helpman.exe "D:\Help Project\Widget\WidgetHelp.hmx" batchcompile.ini
helpman.exe "D:\Help Project\Widget Two\WidgetTwoHelp.hmx" batchtwo.ini

· Команда @ECHO OFF подавляет вывод в командную консоль. Это на самом деле не требуется, только общепринято использовать это.
Вы будете обычно хотеть использовать только одну командную строку с .INI файлом в пакетном файле, но нет ничего, чтобы препятствовать Вам включать столько, сколько хотите. Они будут все обработаны один за другим, когда Вы вызываете пакетный файл.
Не забудьте хранить каждый .INI файл в его собственном проектном каталоге - то есть в каталоге, в котором сохранен ассоциированный с ним .HMX файл проекта Help & Manual.
· Наконец, создайте ярлык к пакетному файлу. Самое удобное местоположение для него находится обычно на вашем Рабочем столе, но это может быть где-нибудь еще. Потом двойной клик на ярлыке запустит пакетный файл, который будет использовать установки в указанном .INI файле (или файлах), чтобы выполнить все операции, которые Вы определили.

См. также:

Вывод в множественные форматы