svn: /phpdoc/doc-base/trunk/howto/thequicky/ exceptions.xml

From: Date: Sun, 25 Apr 2010 11:23:35 +0000
Subject: svn: /phpdoc/doc-base/trunk/howto/thequicky/ exceptions.xml
Groups: php.doc.cvs 
Request: Send a blank email to doc-cvs+get-6446@lists.php.net to get a copy of this message
bjori Sun, 25 Apr 2010 11:23:35 +0000 Revision: http://svn.php.net/viewvc?view=revision&revision=298491 Log: - Update file locations after the SVN switch - Update phd commands to use PhD 1.0 (stable) Changed paths: U phpdoc/doc-base/trunk/howto/thequicky/exceptions.xml Modified: phpdoc/doc-base/trunk/howto/thequicky/exceptions.xml =================================================================== --- phpdoc/doc-base/trunk/howto/thequicky/exceptions.xml 2010-04-25 11:03:41 UTC (rev 298490) +++ phpdoc/doc-base/trunk/howto/thequicky/exceptions.xml 2010-04-25 11:23:35 UTC (rev 298491) @@ -14,26 +14,27 @@ <programlisting role="shell"> <![CDATA[ # Checkout the XML documentation sources -$ svn http://svn.php.net/repository/phpdoc/modules/phpdoc-en phpdoc +$ svn co http://svn.php.net/repository/phpdoc/modules/doc-en phpdoc $ cd phpdoc # Install the PHP based Docbook renderer (PhD) $ pear channel-discover doc.php.net -$ pear install doc.php.net/phd-beta +$ pear install doc.php.net/phd +$ pear install doc.php.net/phd_php # Configuring the XML and validate it -$ php configure.php +$ php doc-base/configure.php # Render the documentations -$ phd -d .manual.xml -t chunkedhtml +$ phd -d doc-base/.manual.xml -P PHP -f xhtml ]]> </programlisting> </example> <para> After running the <command>phd</command> command you should now have a - <emphasis>html/</emphasis> directory containing few thousands files. + <emphasis>output/php-xhtml/</emphasis> directory containing few thousands files. Feel free to click them and browse the docs in your browser just to make sure everything went fine. </para> @@ -42,7 +43,7 @@ <section xml:id="article.thequicky.exceptions.thefunpart"> <title>The fun part; documenting</title> <para> - Copy <filename>RFC/skeletons/exceptionname.xml</filename> to + Copy <filename>doc-base/RFC/skeletons/exceptionname.xml</filename> to <filename>en/reference/&lt;extension&gt;/&lt;exceptionname&gt;.xml</filename> (replacing <emphasis>&lt;extension&gt;</emphasis> and <emphasis>&lt;exceptionname&gt;</emphasis> with the actual exception name @@ -74,7 +75,7 @@ <para> Create a folder (in <filename>en/reference/&lt;extension&gt;/</filename>) with the same name as your <emphasis>&lt;exceptionname&gt;</emphasis> - previously. Copy <filename>RFC/skeletons/method.xml</filename> into that + previously. Copy <filename>doc-base/RFC/skeletons/method.xml</filename> into that folder and rename it to the methodname you will be documenting (all lowercased). The file, like <filename>exceptionname.xml</filename>, contains lots of comments to guide you through the process. @@ -127,9 +128,9 @@ </programlisting> </example> <para> - Now, poke around the <filename>html/</filename> directory and locate the + Now, poke around the <filename>output/php-xhtml/</filename> directory and locate the new exception you just documented - <filename>html/class.&lt;exceptionname&gt;</filename>. + <filename>output/php-xhtml/class.&lt;exceptionname&gt;</filename>. </para> </section>

« previous php.doc.cvs (#6446) next »