diff --git a/chmonly/aboutchm.xml b/chmonly/aboutchm.xml new file mode 100644 index 000000000..5bf01944e --- /dev/null +++ b/chmonly/aboutchm.xml @@ -0,0 +1,54 @@ + + + + + Об этом издании + + + Справочное издание Windows HTML Help руководства по PHP предназначено для разработчиков, + которые хотят, чтобы руководство всегда было под рукой, + и хотели бы читать страницы руководства и заметки пользователей, + не дожидаясь загрузки удалённой веб-страницы. + В этом издании вы найдете полное содержание руководства, заметки пользователей, + а также некоторые замечательные возможности, предоставляемые приложением для просмотра, + скриптами, которые мы используем для создания этого формата + и другими участниками в виде тем оформления. + + + + Дистрибутив руководства по PHP содержит множество файлов, включая основной + файл руководства php_manual_en.chm. Вы можете просмотреть руководство, + дважды щёлкнув по этому файлу (как вы уже догадались). + Вы также можете увидеть в каталоге файл php_manual_en.chw, + который создаётся при первом использовании вкладки index + и содержит индекс со страницами руководства. + + + + Для тех, кто интересуется техническими подробностями о Microsoft HTML Help, + &url.chm.helpware; является отличным ресурсом. + Дополнительные сведения и позиционирование Windows HTML Help в истории форматов + и служб помощи Microsoft смотрите в статье WinWriters. + + + + diff --git a/chmonly/integration.xml b/chmonly/integration.xml new file mode 100644 index 000000000..62c11c7fd --- /dev/null +++ b/chmonly/integration.xml @@ -0,0 +1,125 @@ + + + + + Интеграция руководства по PHP + + + + + Информация, представленная здесь, в основном предназначена для авторов IDE + или опытных пользователей, которые хотели бы интегрировать CHM-файл + в любимые IDE или другие компоненты производственной среды. + + + + + Существует несколько редакторов с поддержкой интеграции CHM, + но для успешной интеграции руководства в вашу среду, + может понадобиться кое-что узнать о том, что содержит CHM. + + + CHM создаётся с помощью таблиц стилей XSL из XML-источников. + Это уникальное явление в семействе руководств PHP, + поскольку все остальные версии создаются с использованием таблиц стилей DSSSL. + Это также означает, что могут возникнуть непреднамеренные различия в отображении. + На выходе XSLT выполняется специальный скрипт преобразования, + который добавляет несколько симпатичных функций и упаковывает руководство вместе + с файлами настроек и примерами тем отображения. + + + Если вы никогда не работали с CHM, то можете считать их сжатыми файлами + с поддерживаемым операционной системой доступом к файлам внутри + и некоторой дополнительной поддержкой поиска и индексации. + Однако CHM можно просматривать только с помощью HTML Help Viewer, + вы можете напрямую получить доступ к файлам внутри них, + используя специальный префикс URL, имя файла CHM и файл, + который вы запрашиваете изнутри. + Поскольку всё содержимое справки хранится в файлах HTML, + вы можете показывать страницы CHM в Internet Explorer. + + + Предположим, вы разместили php_manual_en.chm + в директории c:\phpmanual. + Индексный файл руководства (который вы видите в первый раз) можно открыть + по следующему URL mk:@MSITStore:C:\phpmanual\php_manual_en.chm::/_index.html. + Здесь mk:@MSITStore: – специальный «протокол», + C:\phpmanual\php_manual_en.chm – абсолютный пусть CHM. + Часть /_index.html – это путь к индексному файлу внутри CHM, + а :: – это то, что нужно поместить между путём CHM и путём к этому файлу. + + + + + Все файлы находятся в корневом каталоге CHM, в отличие от предыдущих версий CHM, + которые включали в себя языковой каталог. Имена изображений, + таблиц стилей и других дополнительных файлов начинаются с подчёркивания + (как в главном индексе, показанном выше), чтобы избежать коллизии имён. + + + + + Имена создаваемых файлов соответствуют тем же правилам, что и в онлайн-руководстве, + за исключением того, что расширение – .html, а не .php. + Самое важное, чтобы файлы документации по функциям назывались + function.FUNCNAME.html, где FUNCNAME – это имя функции, + со всеми подчеркиваниями, преобразованными в дефисы. + В качестве примера можно привести: + function.echo.html, + function.mysql-close.html, + function.imagecopy.html. + + + Используя всю эту информацию, вы можете показать страницу руководства для функции, + запрашиваемой пользователем. В дистрибутив включён простой пример под названием + php_quickref.hta. + Это HTML-приложение, демонстрирующее + простой процесс показа страницы руководства для функции. + Определённая в нём функция quickRef() выполняет эту работу. + + + Если вы хотите интегрировать руководство в IDE, не имеющую прямой поддержки руководства по PHP + (фактически преобразования подчёркивания в дефис), вы можете использовать включённый файл + _function.html для доступа к странице функции. + Этот файл является просто перенаправляющим и его можно настраивать с помощью URL, + например, _function.html#mysql_close. + Эта страница будет автоматически перенаправлять вас на страницу функции + mysql_close (function.mysql-close.html). + Вы можете указать полный путь к этому файлу, если ваша IDE поддерживает контекстно-зависимую справку, + а в качестве параметра указать строку, заданную IDE. + В качестве примера можно привести интерфейс UltraEdit 9 (смотрите сайт издания). + + + Индекс руководства (доступен на вкладке «Индекс» на панели навигации) + также может быть использован в интеграционных целях. + Все HTML-страницы включены в индекс с их названиями в качестве терминов индекса + (включая страницы описания функций). + + + Если вы являетесь разработчиком настольных приложений и хотите плотно интегрировать CHM в свою программу + (например, отображать дерево оглавления в окне справки вашей IDE), + вы можете найти дополнительную информацию на сайте &url.chm.helpware;, + а также ссылки на другие полезные ресурсы. + Официальный сайт HTML Help находится по адресу &url.chm;. + + +