stas
9422a7ee05
docs improvements, see ZF-5418
|
%!s(int64=16) %!d(string=hai) anos | |
|---|---|---|
| .. | ||
| figures | %!s(int64=16) %!d(string=hai) anos | |
| html | %!s(int64=16) %!d(string=hai) anos | |
| module_specs | %!s(int64=16) %!d(string=hai) anos | |
| ref | %!s(int64=16) %!d(string=hai) anos | |
| tools | %!s(int64=16) %!d(string=hai) anos | |
| Makefile.in | %!s(int64=16) %!d(string=hai) anos | |
| README | %!s(int64=16) %!d(string=hai) anos | |
| configure.in | %!s(int64=16) %!d(string=hai) anos | |
| html.xsl.in | %!s(int64=16) %!d(string=hai) anos | |
| manual-lint.xml.in | %!s(int64=16) %!d(string=hai) anos | |
| manual-print1.xml.in | %!s(int64=16) %!d(string=hai) anos | |
| manual-print2.xml.in | %!s(int64=16) %!d(string=hai) anos | |
| manual.xml.in | %!s(int64=16) %!d(string=hai) anos | |
| pdf-manual.xsl.in | %!s(int64=16) %!d(string=hai) anos | |
| xinclude.mod | %!s(int64=16) %!d(string=hai) anos | |
README
Required software:
- autoconf
- make
- xsltproc
- xmllint
On Windows, you should use Cygwin software or another port of GNU
development tools.
How to build the DocBook documentation:
- run "autoconf" in this dir
- run "./configure" in this dir
- run "make"
The HTML files are rendered in the "html" dir.
When developing content, you can verify your changes by running:
"make check"
This verifies the XML for the whole manual is valid.
You can verify your changes in a single file by running:
"make XMLFILE=filename.xml check1"
The filename.xml is relative to the "module_specs" directory.
DocBook resources:
http://www.ibiblio.org/godoy/sgml/docbook/howto/index.html
http://opensource.bureau-cornavin.com/crash-course/index.html
http://ds9a.nl/docbook/
http://www.sagehill.net/docbookxsl/index.html
http://docbook.org/tdg/en/html/part2.html DocBook tag reference
To generat a CHM project file, you must install MsHtmlHelpWorkshop.
To build the CHM file on the command line navigate to the directory
in which the manual html files are built as described above
Then call:
"C:/path/to/workshop/hhc htmlhelp.hhp"
where "C:/path/to/workshop/" is the path to MsHtmlHelpWorkshop.
This will build a "Zend_Framework_LANGUAGE.chm" file.
You should now have an index in the file..
- autoconf
- make
- xsltproc
- xmllint
On Windows, you should use Cygwin software or another port of GNU
development tools.
How to build the DocBook documentation:
- run "autoconf" in this dir
- run "./configure" in this dir
- run "make"
The HTML files are rendered in the "html" dir.
When developing content, you can verify your changes by running:
"make check"
This verifies the XML for the whole manual is valid.
You can verify your changes in a single file by running:
"make XMLFILE=filename.xml check1"
The filename.xml is relative to the "module_specs" directory.
DocBook resources:
http://www.ibiblio.org/godoy/sgml/docbook/howto/index.html
http://opensource.bureau-cornavin.com/crash-course/index.html
http://ds9a.nl/docbook/
http://www.sagehill.net/docbookxsl/index.html
http://docbook.org/tdg/en/html/part2.html DocBook tag reference
To generat a CHM project file, you must install MsHtmlHelpWorkshop.
To build the CHM file on the command line navigate to the directory
in which the manual html files are built as described above
Then call:
"C:/path/to/workshop/hhc htmlhelp.hhp"
where "C:/path/to/workshop/" is the path to MsHtmlHelpWorkshop.
This will build a "Zend_Framework_LANGUAGE.chm" file.
You should now have an index in the file..