Re: RFC : [PHP-DOC] FAQ porting to the manual?

From: Date: Mon, 09 Jul 2001 21:18:51 +0000
Subject: Re: RFC : [PHP-DOC] FAQ porting to the manual?
References: 1  Groups: php.doc 
Request: Send a blank email to phpdoc+get-969336036@lists.php.net to get a copy of this message
RE: [PHP-DOC] RFC : [PHP-DOC] FAQ porting to the manual?Would this not be better suited by using <sect1>... <sect2> blocks instead of <refentry> blocks? Since <refnamediv> requires a <refname> tag, it doesn't quite work so well as it is currently in cvs. What do you guys think? Daniel ----- Original Message ----- From: Hojtsy Gabor To: 'Damien Seguy' ; 'Hojtsy Gabor' ; 'PHP-Doc list' Sent: Monday, July 09, 2001 5:19 AM Subject: RE: [PHP-DOC] RFC : [PHP-DOC] FAQ porting to the manual? >Create a new directory for FAQ (called "faq"). >All main FAQ entry get its own file >("faq.general","faq.mailing-lists","faq.obtaining","faq.databases"...). Right. Than it will be a new section in the manual, like PEAR. >Each file has the following layout : > > <reference id="faq.obtaining"> > <title>Obtaining PHP</title> > <titleabbrev>Obtaining PHP</titleabbrev> > > <partintro> > <para> > This faq deals with how to obtains PHP, where, when > and why (this may be an optionnal introduction, as usual.). > </para> > </partintro> > > <refentry id="faq.obtaining.where"> > <refnamediv> > <refpurpose>Where can I obtain PHP?</refpurpose> > </refnamediv> > <refsect1> > <title>Description</title> > <para> > You can download PHP from any of the members of the > PHP network of sites. These can be found at > <link linkend="&url.php;">&url.php;</a>. > You can also use anonymous CVS to get the absolute latest > version of the source. For more information, go to > <link linkend="&url.php.cvs;">&url.php.cvs;</a>. > </para> > </refsect1> > </refentry> > </reference> Seems all right :) >Most of the job will be bringing in all URL, and extracting HTML >tag : nothing bad, due to since layout from Jim. URL-s should go to another faqurls.ent file in the faq directory, or should stay as is in the xml files. What do you think? Sorry for the HTML mail, I have set PLAIN TEXT mail in my Outlook, but the server converts it to HTML... Goba

« previous php.doc (#969336036) next »