auto-generation of peardoc2 from phpDocumentor
| From: | Greg Beaver | Date: | Fri, 15 Nov 2002 07:31:07 +0000 |
| Subject: | auto-generation of peardoc2 from phpDocumentor | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-22@lists.php.net to get a copy of this message | ||
Hi,
I've started work on a Converter for phpDocumentor to peardoc2. This will
make things a whole lot easier for documentation, as you can imagine. I
have some technical questions that aren't answered by any FAQ I can find.
First: I need to generate automatic section or sub-section ids for each
documented element (this will allow all of phpDocumentor's powerful linking
to occur). I am investigating <link
linkend="package.whatever.thing.subthing"></link> where thing is either a
class or a procedural file. What are the character limitations for the id?
To generate unique id's, I would like to use the name of the thing, so for
variables, that could be $var_name, and for constants it gets more
complicated yet. can I just urlencode them, or should I follow another
process?
Second: for the new standard, I need to know how the peardoc2 maintainers
would like things structured by the auto-generated manual output. I'd love
to be in direct contact with someone who is directing the vision over there
so I can match up ours over here. With proper assistance here, we should
have this thing up and running very quickly.
Thanks,
Greg