Re: Commandline manual lookup script like perldoc for PHP
| From: | Stefan Walk | Date: | Mon, 21 Apr 2003 22:51:01 +0000 |
| Subject: | Re: Commandline manual lookup script like perldoc for PHP | ||
| References: | 1 2 | Groups: | php.doc php.pear.dev |
| Request: | Send a blank email to pear-dev+get-15295@lists.php.net to get a copy of this message | ||
On Mon, Apr 21, 2003 at 11:33:36PM +0200, Gabor Hojtsy wrote:
> Hi Stefan!
>
> Nice work ;) I like it, though I will probably never use it...
Thanks!
> Some points to consider:
>
> - we do have a somewhat working manpage generator, which works from
> the XML sources with regexps, and generates manpages out of PHP
> function documentation (see scripts/make_man.php in phpdoc)
Hm. Looks suitable, but then there is the problem of fetching the right
XML file since cvs.php.net/function does not work ;) Anyway, i will have
a look at that, it should be easy to transform that into something that
fits my needs.
> - we can generate some kind of text format (I guess the 'individual
> HTML files' format filtered through lynx would be OK) if that does
> not take much time for our build system, and it significantly helps
> this command line tool
Well, you can add /print to a page at the right point and get the
printer-friendly version. If you could add /docbook and get the xml
sources, it would be great.
So would be a text version, because...
> - why don't you run the HTML through lynx before playing with the file?
> as you expect net connection, you may also expect lynx :) I guess
> windows users won't prefer your reference browser ;)) This would be
> better as
>
> -> relying on the structure of the generated HTML files is a bad
> way (it may change from time to time)
>
> -> generating a different format for your script takes time on
> the build machine, takes bandwidth to rsync, takes bandwidth
> and time to download for the users and the mirror sites
... I don't like to exclude Users because they use a different OS.
If possible, i will keep this pure PHP, without the need of exotic
extensions or binaries.
Thanks for your answer,
Stefan Walk