Re: cvs: peardoc /en/package/xml xml-feed-parser.xml /en/package/xml/xml-feed-parser extensions.xml intro.xml

From: Date: Sun, 08 Jan 2006 16:14:23 +0000
Subject: Re: cvs: peardoc /en/package/xml xml-feed-parser.xml /en/package/xml/xml-feed-parser extensions.xml intro.xml
References: 1  Groups: php.pear.doc 
Request: Send a blank email to pear-doc+get-7431@lists.php.net to get a copy of this message
On Sat, Jan 07, 2006 at 08:20:22PM -0000, James Stewart wrote: > jystewart Sat Jan 7 20:20:22 2006 UTC > > Added files: > /peardoc/en/package/xml xml-feed-parser.xml > /peardoc/en/package/xml/xml-feed-parser extensions.xml intro.xml Thanks _very_ much for writing documentation! Welcome to the team. As a new commer, there are some things you'll need to pick up... You left out the "Local variables:" section at the bottom of the extensions and intro files. Copy them from other documentation that is at the same directory level as the files you committed. > <refsect1 id="package.xml.xml-feed-parser.intro.desc"> > &title.desc; > > <para>Using XML namespaces, the various syndication formats are very easy to extend and > the number of extensions in use is enormous.</para> Please nest the para and it's contents. Also, nest all XML and examples with spaces instead of tabs. Please wrap at ~75 chars. This helps reading on multiple platforms and for people doing translations. > <para>For example, to make use of the 'pheed' extension (namespace °R > òÀU6‘¨i#íÇÃhttp://www.pheed.com/pheed/) we might use: <programlisting > role="php"> > $feed = new XML_Feed_Parser($xml_source); Similarly, put the programlisting element on it's own line. > </programlisting> > </para> > > </refsect1> > </refentry> Please nest all elements. > <programlisting role="php"> > /* The file you wish to parse */ > $source = 'my_source.xml'; The one thing that doesn't get nested to the element level are the examples. They're always flush left so they render in the produced documentation w/o the extra white space. Thanks again, --Dan -- T H E A N A L Y S I S A N D S O L U T I O N S C O M P A N Y data intensive web and database programming http://www.AnalysisAndSolutions.com/ 4015 7th Ave #4, Brooklyn NY 11232 v: 718-854-0335 f: 718-854-0409

« previous php.pear.doc (#7431) next »