goba Tue Aug 13 12:23:49 2002 EDT Modified files: /phpdoc/howto howto.html.tar.gz tools.xml Log: As we have XSL sheets bundeld, modify docs to reflect this, and adding more info on xsltproc usage. Index: phpdoc/howto/howto.html.tar.gz Index: phpdoc/howto/tools.xml diff -u phpdoc/howto/tools.xml:1.13 phpdoc/howto/tools.xml:1.14 --- phpdoc/howto/tools.xml:1.13 Sun Jul 28 05:47:34 2002 +++ phpdoc/howto/tools.xml Tue Aug 13 12:23:49 2002 @@ -310,41 +310,13 @@ <link linkend="chapter-cvs">CVS section</link> of this document. </para> - <note> - <simpara> - If you decide to use another directory in one of the next - steps, you'll probably need to modify - <filename>phpdoc/configure.in</filename> manually. - We do not give any support if you are self-opinionated :) - In this situation you can specify the DSSSL location - manually by using the - <literal>--with-dsssl=C:/path/to/dsssl</literal> - option with configure. - </simpara> - </note> - <para> Make sure that you are in the directory where the <literal>phpdoc</literal> dir is located. (if you type <literal>ls</literal>, you should see - <literal>phpdoc</literal> listed). - </para> - - <para> - Type <literal>mkdir phpdoc-tools</literal>, and then unzip: - - <itemizedlist> - <listitem><simpara>Jade to <literal>phpdoc-tools/jade</literal></simpara></listitem> - </itemizedlist> - - XSL stylesheets are <emphasis>not necessary</emphasis> - to generate the html versions of the manual, the DSSSL style - sheets are used by default (from - <filename>phpdoc/dsssl/docbook</filename>). If you think - you would like to test XSL ones, than unzip Norman Walsh's - XSL files to <literal>phpdoc-tools/xsl/docbook</literal>. See - <ulink url="&url.nwalsh.xsl;">&url.nwalsh.xsl;</ulink> - for more information and downloadable files. + <literal>phpdoc</literal> listed). Type <literal>mkdir + phpdoc-tools</literal>, and then unzip Jade to + <literal>phpdoc-tools/jade</literal>. </para> <para> @@ -383,10 +355,6 @@ | | | \--jade.exe (etc) | - +--xsl (OPTIONAL!) - | | - | \--docbook (etc) - | \--php.bat </programlisting> </informalexample> @@ -424,9 +392,8 @@ <para> In order to successfully use the XSL stylesheets - you must have some XSLT processor and the XSL - DocBook Stylesheets. This is sufficient for - generating HTML version of the documentation. + you must have some XSLT processor. This is sufficient + for generating HTML version of the documentation. If you also want to create a version suitable for printing, you will additionally need a FO processor. @@ -451,11 +418,19 @@ but is a promising technology. You do not need to setup any tools mentioned here if you would not like to play with XSL stylesheets. However - we plan to use XSLT in the future for HTML + we plan to use XSL in the future for HTML generation, and possibly PDF generation, if we can manage to work out how to do it correctly. </para> </note> + + <para> + The phpdoc <filename>Makefile</filename> has options to + generate files using the XSL sheets, but these are currently + experimental (and require xsltproc exclusively). After running + <filename>./configure</filename> you can run <literal>make + html_xsl</literal> to generate HTML files using XSL sheets. + </para> <para> XSLT processors: @@ -472,9 +447,11 @@ </listitem> <listitem> <simpara> - Gnome LibXSLT: <ulink url="&url.xsl.libxslt;">&url.xsl.libxslt;</ulink>, - also available as Windows binary: + Gnome LibXSLT (also known as xsltproc): + <ulink url="&url.xsl.libxslt;">&url.xsl.libxslt;</ulink>, + available as Windows binary too at: <ulink url="&url.xsl.libxslt.win;">&url.xsl.libxslt.win;</ulink>, + and also included in current cygwin setups. </simpara> </listitem> </itemizedlist> @@ -488,10 +465,6 @@ </para> </note> - <para> - XSL DocBook Stylesheets: <ulink url="&url.xsl.style;">&url.xsl.style;</ulink> - </para> - <para> FO processors: <itemizedlist>
-- PHP Documentation Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php