<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0"
	xmlns:content="http://purl.org/rss/1.0/modules/content/"
	xmlns:wfw="http://wellformedweb.org/CommentAPI/"
	xmlns:dc="http://purl.org/dc/elements/1.1/"
	xmlns:atom="http://www.w3.org/2005/Atom"
	xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
	xmlns:slash="http://purl.org/rss/1.0/modules/slash/"
	>

<channel>
	<title>LAMPlights &#187; documentation</title>
	<atom:link href="http://www.hermanradtke.com/blog/tag/documentation/feed/" rel="self" type="application/rss+xml" />
	<link>http://www.hermanradtke.com</link>
	<description>Personal anecdotes from my experiences using the LAMP stack</description>
	<lastBuildDate>Wed, 25 Jan 2012 18:14:47 +0000</lastBuildDate>
	<language>en</language>
	<sy:updatePeriod>hourly</sy:updatePeriod>
	<sy:updateFrequency>1</sy:updateFrequency>
	<generator>http://wordpress.org/?v=3.3.1</generator>
		<item>
		<title>Updating PHP Documentation</title>
		<link>http://www.hermanradtke.com/blog/updating-php-documentation/</link>
		<comments>http://www.hermanradtke.com/blog/updating-php-documentation/#comments</comments>
		<pubDate>Sun, 05 Dec 2010 16:51:01 +0000</pubDate>
		<dc:creator>Herman Radtke</dc:creator>
				<category><![CDATA[Uncategorized]]></category>
		<category><![CDATA[documentation]]></category>
		<category><![CDATA[memcache]]></category>
		<category><![CDATA[phd]]></category>
		<category><![CDATA[php]]></category>

		<guid isPermaLink="false">http://www.hermanradtke.com/?p=569</guid>
		<description><![CDATA[I sometimes help update the PHP documentation.  I have not done it in a while since I started maintaining pecl/memcache.  However, there was a recent bug submission where I felt the documentation for pecl/memcache should be updated.  A lot of work has been done to the documentation tools since I last updated documentation.  I went [...]]]></description>
			<content:encoded><![CDATA[<p>I sometimes help update the PHP documentation.  I have not done it in a while since I started maintaining <a href="http://pecl.php.net/package/memcache" target="_blank">pecl/memcache</a>.  However, there was a recent <a href="http://pecl.php.net/bugs/bug.php?id=20375" target="_blank">bug submission</a> where I felt the documentation for pecl/memcache should be updated.  A lot of work has been done to the documentation tools since I last updated documentation.  I went to <a href="http://doc.php.net" target="_blank">http://doc.php.net</a> for a quick primer on how to generate some new documentation output so I could test my changes and found the documentation for generating documentation a little hard to follow.<span id="more-569"></span></p>
<p>PHP documentation generation is done in two steps.  First, you need to generate the docbook file.  You somehow have to find this page <a href="http://pecl.php.net/bugs/bug.php?id=20375" target="_blank">http://doc.php.net/php/dochowto/chapter-configure.php</a> that explains how.  Once the docbook file, normally called manual.xml, is generated you have to actually generate the documentation output.  I found the PhD manual here: <a href="http://doc.php.net/phd/docs" target="_blank">http://doc.php.net/phd/docs</a>.  PhD can create a number of different documentation formats from the docbook file.  I normally just use the xhtml output and serve the page up on my local web-server to verify my changes.  I found section on rendering to be a little hard to follow.  Here are the steps I used to update the content on the <a href="http://www.php.net/manual/en/memcache.getextendedstats.php" target="_blank">Memcache:getExtendedStats</a> page:</p>

<div class="wp_syntax"><div class="code"><pre class="bash" style="font-family:monospace;"><span style="color: #c20cb9; font-weight: bold;">sudo</span> pear <span style="color: #c20cb9; font-weight: bold;">install</span> doc.php.net<span style="color: #000000; font-weight: bold;">/</span>phd-beta
&nbsp;
<span style="color: #666666; font-style: italic;"># use a sparse SVN checkout so all the languages and</span>
<span style="color: #666666; font-style: italic;"># the tags and branches directories are skipped</span>
<span style="color: #c20cb9; font-weight: bold;">svn</span> <span style="color: #c20cb9; font-weight: bold;">co</span> http:<span style="color: #000000; font-weight: bold;">//</span>svn.php.net<span style="color: #000000; font-weight: bold;">/</span>repository<span style="color: #000000; font-weight: bold;">/</span>phpdoc <span style="color: #660033;">--depth</span> empty phpdoc
&nbsp;
<span style="color: #666666; font-style: italic;"># checkout the documentation toolset</span>
<span style="color: #c20cb9; font-weight: bold;">svn</span> update phpdoc<span style="color: #000000; font-weight: bold;">/</span>doc-base <span style="color: #660033;">--set-depth</span> empty
<span style="color: #c20cb9; font-weight: bold;">svn</span> update phpdoc<span style="color: #000000; font-weight: bold;">/</span>doc-base<span style="color: #000000; font-weight: bold;">/</span>trunk <span style="color: #660033;">--set-depth</span> infinity
&nbsp;
<span style="color: #666666; font-style: italic;"># checkout the english version of the documentation</span>
<span style="color: #c20cb9; font-weight: bold;">svn</span> update phpdoc<span style="color: #000000; font-weight: bold;">/</span>en <span style="color: #660033;">--set-depth</span> empty
<span style="color: #c20cb9; font-weight: bold;">svn</span> update phpdoc<span style="color: #000000; font-weight: bold;">/</span>en<span style="color: #000000; font-weight: bold;">/</span>trunk <span style="color: #660033;">--set-depth</span> infinity
&nbsp;
<span style="color: #7a0874; font-weight: bold;">cd</span> phpdoc
<span style="color: #c20cb9; font-weight: bold;">vim</span> en<span style="color: #000000; font-weight: bold;">/</span>trunk<span style="color: #000000; font-weight: bold;">/</span>reference<span style="color: #000000; font-weight: bold;">/</span>memcache<span style="color: #000000; font-weight: bold;">/</span>memcache<span style="color: #000000; font-weight: bold;">/</span>getextendedstats.xml
&nbsp;
<span style="color: #666666; font-style: italic;"># generate the docbook file</span>
<span style="color: #666666; font-style: italic;"># disable libxml check as Cent OS 5.5 does not have LibXML version 2.7.4</span>
<span style="color: #666666; font-style: italic;"># put the docbook file in the root phpdoc directory</span>
php doc-base<span style="color: #000000; font-weight: bold;">/</span>trunk<span style="color: #000000; font-weight: bold;">/</span>configure.php <span style="color: #660033;">--output</span>=manual.xml <span style="color: #660033;">--disable-libxml-check</span>
&nbsp;
<span style="color: #666666; font-style: italic;"># generate xhtml output in the output/ directory</span>
phd <span style="color: #660033;">-d</span> manual.xml <span style="color: #660033;">-f</span> xhtml</pre></div></div>

<p>Note: you can safely ignore the E_USER_WARNING about "Image does not exist" when generating the output.</p>
]]></content:encoded>
			<wfw:commentRss>http://www.hermanradtke.com/blog/updating-php-documentation/feed/</wfw:commentRss>
		<slash:comments>0</slash:comments>
		</item>
		<item>
		<title>Frustration with vim.org</title>
		<link>http://www.hermanradtke.com/blog/frustration-with-vimorg/</link>
		<comments>http://www.hermanradtke.com/blog/frustration-with-vimorg/#comments</comments>
		<pubDate>Tue, 14 Apr 2009 01:02:37 +0000</pubDate>
		<dc:creator>Herman Radtke</dc:creator>
				<category><![CDATA[Uncategorized]]></category>
		<category><![CDATA[docblock]]></category>
		<category><![CDATA[documentation]]></category>
		<category><![CDATA[php]]></category>
		<category><![CDATA[vim]]></category>

		<guid isPermaLink="false">http://www.hermanradtke.com/blog/?p=50</guid>
		<description><![CDATA[I started using the phpDocumentor for Vim (PDV) script written by Tobias Schlitt.  Very quickly I found a bug with one of the regular expressions used to parse apart the class definition.  Tobias does not seem to be maintaing this plugin anymore, so I decided I would fix the bug and submit a new version [...]]]></description>
			<content:encoded><![CDATA[<p>I started using the phpDocumentor for Vim (PDV) script written by Tobias Schlitt.  Very quickly I found a bug with one of the regular expressions used to parse apart the class definition.  Tobias does not seem to be maintaing this plugin anymore, so I decided I would fix the bug and submit a new version to vim.org.  I packaged up the new version of the script and went to update the PDV page on vim.org only to find out I can't.  There isn't even a mechanism for me to post a comment.</p>
<p><span id="more-50"></span></p>
<p>I was frustrated to say the least, but knew I could not have been the first one.  I found an <a title=" Improvements for vim.org/scripts" href="http://www.mail-archive.com/vim_use@googlegroups.com/msg00456.html" target="_blank">archived email</a> sent by Thomas Koch to the VIM mailing list describing some of the problems with the management of scripts and the improvements he would like to see made.  Thomas also created a <a title="vim.org relaunch" href="http://vim.wikia.com/wiki/Vim.org_relaunch" target="_blank">wiki page</a> to organize his proposed relauch.</p>
<p>The great thing is that the website is built using PHP and MySQL.  That means I can lend a hand to make these changes happen.  I really don't want to see this project die off, so I have emailed the vim@vim.org mailing list prompting for more action.</p>
]]></content:encoded>
			<wfw:commentRss>http://www.hermanradtke.com/blog/frustration-with-vimorg/feed/</wfw:commentRss>
		<slash:comments>2</slash:comments>
		</item>
	</channel>
</rss>

