«Документальный» плюс

Денис Колисниченко

Спецвыпуск: Хакер, номер #053, стр. 053-048-5

Форматирование

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

1. увеличить количество абзацев;

2. увеличить интервал между абзацами;

3. выделить термины, команды, названия файлов и каталогов;

4. увеличить размер шрифта.

Для выделения терминов и команд я рекомендую использовать шрифт Arial - он более читабельный, чем Times.

Программы

Для создания HTML-документации вполне хватит "Блокнота", а какую программу будем использовать для создания CHM-файла? Могу порекомендовать две очень удобные программы для создания CHM-файлов: Microsoft HTML Help Workshop и HelpScribble.

Первая очень удобна, позволяет из готовых HTML-файлов скомпилировать CHM-файл (Help Workshop позволяет). Лично мне эта программа симпатична больше (точнее, к ней я больше привык), чем Help Scribble, но это только мое мнение. Help Scribble любезно избавит тебя от необходимости использовать дополнительные программы (кроме компилятора справки) для создания файла справки, чем выделяется среди себе подобных. Текст документации можно создавать прямо в Help Scribble, причем в твоем распоряжении будет полноценный RTF-редактор, позволяющий изменять форматирование, применять макросы форматирования (аналог стилей в Word), вставлять картинки, кнопки и т.д. Главное отличие HTML Help Workshop от Help Scribble в том, что первая программа сама является компилятором CHM-файлов, а вторая - это RTF-редактор с функциями создания справки, но для самого процесса компиляции нужен внешний компилятор. Запусти Help Scribble и выбери команду меню Project, Options: ты увидишь окно поиска компилятора help-файлов.

Если ты хочешь создавать CHM-файлы с помощью Help Scribble, тебе все равно нужно установить HTML Help Workshop, поскольку он является компилятором CHM-файлов. Зато Help Scribble, в отличие от HTML Help Workshop, умеет создавать файлы справки любых форматов, а не только CHM: Например:

- 16-разрядный help-файл, который поддерживается всеми ОС Windows, начиная с Windows 3.11 и заканчивая Windows XP.

- 32-разрядный help-файл, который поддерживается операционными системами Windows 95-XP.

- CHM-файл, поддерживаемый системами Windows 98, ME, 2000, XP.