xCHM page like any other HTML consists of two parts – <head> and <body>
the structure of current head is below:
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html><head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>PHP Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<script language="JavaScript1.2" src="_script.js"></script>
</head>
file contains procedures to apply skins and render html page further to display it. By default the outmost <div> with id="pageContent" is hidden, i.e. has style="display:none" and on load event this style is changed by displayPage() function from
_script.js
Although header is the same there are some different page types in phpdoc structure. These are:
- title page (usually index.html), which contains PHP Manual info and table of contents (To C)
- preface with a short PHP intro and credits (pr01.html for original and preface.html for altered Doc Book templates)
- part pages with To C for part (pt03.html or install.html, langref.html for example)
Note: in customized xCHM templates files are named by their ID and these ID's are given manually with respect to the type of page
- chapter pages (ch01.html or introduction.html) contain text information. Information is divided into chapters and further into section for easy reader experience and better navigation. Every chapter page also contains it's first section.
- section pages (ch01s02.html or intro-whatcando.html, language.types.string.html, install.windows.apache2.html) – common documentation pages
- function reference part (pt06.html or funcref.html) nothing special – it is part page like any other except that it contains function reference pages
- function reference section index (rn37.html or ref.filesystem.html) pages of this type contain list functions which belong to some extension or divided be functionality. They usually consists of several paragraphs: Introduction, Requirements, Installation, Runtime Configuration, Predefined Constants and Table of Contents with a list of documented functions in this section
- function reference page (rn37re794.html or function.disk-total-space.html) differs slightly because among standard notes, examples, warnings and “see also” it includes function prototype and php version where this function is available
- Zend API part (pt07.html, ch44.html, ... or zend.*.html pages) whole part for C developers who write extensions for PHP. This part of dicumentation had slightly different layout from the very beginning and wasn't included in PHP manual. Therefore it contains some uncommon features like pictures requiring special handling to not allow them to be left abroad.
- PHP API – well, I believe this will be merged with Zend API and Appendix F. «Extending PHP 3" one day
- FAQ part (ch09.html or faq.html) contains tables with questions and answers (it seems that it can be nice to have some kind of rating for them)
- Appendixes index (appendixes.html) usual part index page with To C or appendix index
- Appendixes (apa.html, apb.html or <appendix id>.html such as aliases.html or reserved.html) contains reference info such as PHP history, various configuration, function, language specific tables and other useful facts
- Appendix S. Function Index (aps.html or indexes.html). I've put an accent on this appendix, because it isn't rendered by native Doc Book templates and is generated directly from PHP sources into funcindex.xml and later included in main file manual.xml to be processed by customized XSL stylesheets from xCHM building queue. Frankly speaking it is made by scripts/genfuncindex.php from quick reference, which is actually generated from PHP sources.
- And finally – xCHM only inclusion part (chmonly.html, chm.*.html) with features descriptions, tips about xCHM skinning and integrating manual. Some info from this part is duplicated here.
see. also
skins.elements.html