Генерация документации

Для получения документации в формате html используются программа vipdoc.exe:

vipdoc <имя-ресурсного-файла>

В каталоге VipDoc имеются командные файлы res2chm.bat и chmBind.bat, упаковывающие документацию в формат chm.

Командный файл res2chm.bat вызывает vipdoc.exe для получения документации на ресурсный файл в формате html, после чего компилирует полученные html-файлы в формат chm:

res2chm.bat <имя-ресурсного-файла>

Полученный документ кладется в папку %TPU%.

Командный файл chmBind.bat создаёт сводный документ в формате chm, объединяющий все документы в формате chm из папки %TPU%:

chmBind.bat

Командные файлы res2chm.bat и chmBind.bat используют переменные среды:

• ATLANTIS - путь на Атлантис;

• HHC - путь на компилятор HTML Help Workshop;

• TPU - путь на папку с готовыми документами;

• STATISTIC_FILE - файл статистики, если он необходим.

Пример:

set ATLANTIS=E:\GalEnv\Atlantises\atl52.08\
set TPU=d:\810\EXE\
set HHC=Q:\ASDK\hhc.exe
set STATISTIC_FILE=%TPU%\statistic.txt

В папке с командными файлами res2chm.bat и chmBind.bat можно разместить файл sets.bat с необходимыми настройками.