phpxpath-users

html Documentation

[Peter R. <php...@pe...>]

Much improved - many thanks. A couple of small points:

1. the sample code at the end of the php file does not appear in the html (or 
xml) documentation, so the usage text isn't correct :-)
2. the internal links in the html file have never worked and I've just 
investigated why. The # should be removed from all the names in the anchors - 
<a name="function"> not <a name="#function"> Fixing this (looks like this is 
in the xslt script) would make the html documentation much easier to use 
:-)

Re: html Documentation

[Nigel S. <nig...@us...>]

> Much improved - many thanks. A couple of small points:
>
> 1. the sample code at the end of the php file does not appear in the html
(or
> xml) documentation, so the usage text isn't correct :-)

The documentation is all automatically built from the php source file using
a perl script.  The sample usage appears at the end of the php file, but not
the xml/html file, and the perl script doesn't parse out the example test
script.  I've altered the comment in the php file to help to indicate that
the usage is not in the .html file.

I want the GeneratePhpDocumentation.pl script to be as generic as possible,
so I am very reluctant to alter it to pick out the sample usage as well to
put in the .html doc.

> 2. the internal links in the html file have never worked and I've just
> investigated why. The # should be removed from all the names in the
anchors -
> <a name="function"> not <a name="#function"> Fixing this (looks like this
is
> in the xslt script) would make the html documentation much easier to use
> :-)

Ah thanks.  IE wasn't bothered by this, so I hadn't noticed.  Have updated
the XSL.

Nigel

Re: html Documentation

[Peter R. <php...@pe...>]

On Sunday 12 May 2002 2:16, Nigel Swinson wrote:
>
> The documentation is all automatically built from the php source file using
> a perl script. 

just out of curiosity - why did you write this in Perl rather than php?

Re: html Documentation

[Nigel S. <nig...@us...>]

> > The documentation is all automatically built from the php source file
using
> > a perl script.
>
> just out of curiosity - why did you write this in Perl rather than php?

a) I'd learnt Perl before PHP and was therefore more fluent in Perl.
b) I already had a "framework" for building scripts like this.  ie analyse a
file and produce an XML file.
c) I've always thought of PHP as a server side pre-processor rather than a
language for building utility scripts in.  The output of php is naturally
html, which isn't ideal if you want to drive it from a batch file.  With
perl your output can be whatever you want it to be.

Were I to build the doc generator again from scratch then I don't know
whether I would have chosen PHP or Perl.  The a and b reasons above were 90%
of the reason it was Perl rather than PHP.

:o)

Nigel

===========================
For the most recent version of Php.XPath, and an archive of this list visit:
http://www.sourceforge.net/projects/phpxpath