On 8/6/07, Richard A. Quadling <[EMAIL PROTECTED]> wrote:
>
>
> > -----Original Message-----
> > From: Hannes Magnusson [mailto:[EMAIL PROTECTED]
> > Sent: 04 August 2007 15:01
> > To: phpdoc@lists.php.net
> > Subject: [PHP-DOC] Linking to methods (was cvs: phpdoc
> > /en/reference/http/HttpResponse setCacheControl.xml)
> >
> > HI all
> >
> > I may have forgot to let you guys know..
> > <function>classname::method</function> and
> > <function>classname->method</function> work now.
> >
> > There is a catch though:
> > It does ID lookup, meaning if the ID of the method is
> > camelCased you'll have to
> > <function>className::camelCaseItToo</function>.
> > As per our standard, all IDs should be lowercased so that, in
> > theory, isn't a problem.
> >
> > In the future (once we have fixed all the wrong IDs) I'd like to do
> > strtolower() on the <function /> and then look it up. That
> > will give the OO docs the possibility to camelCaseTheLinks
> > without breaking our ID convention.
> >
> >
> > -Hannes
>
> The wrong IDs is something I was looking at.
>
> Take a look at phpdoc/en/zip/functions/ziparchive-setCommentName.xml
>
> This has an id of function.ziparchive-setCommentName.
>
> If you now look at the function index
> http://www.php.net/manual/en/indexes.php, you'll see that
> ZipArchive::setCommentName() is not a link.
Thats exactly what I was talking about. Due to the fact IDs are mixed
cases we cannot strtolower("ZipArchive::setCommentName") and then look
it up.
If the ID was function.ZipArchive-setCommentName however it would work.
>
> There are MANY like this.
>
> Just over 700 aren't rendered as links.
Many of those will probably be fixed in the next build
>
> Some are also shown with double () and are also not shown as links.
That is a problem with the generation script. It should not add ().
(Which in turn, is the refname fault..)
>
> OOI. In the xCHM manual, they ARE shown as links, but don't link.
>
> The xCHM link is ...
>
> mk:@MSITStore:D:\Personal%20Files\Software\PHP\Manual\php_manual_en.chm:
> :/function.SoapClient-call().html
>
> The whole page name is incorrect. The actual page is ...
>
> mk:@MSITStore:D:\Personal%20Files\Software\PHP\Manual\php_manual_en.chm:
> :/function.soap-soapclient-call.html
>
> The ID in the /phpdoc/en/reference/soap/soap-soapclient-call.xml is
> xml:id="function.soap-soapclient-call". So url name and id match, but
> rendering of id as a link is not.
No, it doesn't match.
<indexentry><primaryie><function>SoapClient->__call()</function></primaryie></indexentry>
>
> I can fix the uppercase ones easily enough, but those like this I don't
> know enough, sorry.
Well... that really is a totally another problem which will break
bunch of things for people...
My suggestion was "fck it. lets fix all those filenames+IDs in one go"
but people didn't really like that idea...
-Hannes
