Re: [PHP-DOC] Function References not showing up in docs for mixed case function names
>From what I gather it will most likely take place in 4.1.x and there will be a switch to turn this on or off. (Probably on by default.) I think this is a great move and will be glad to see it happen. Daniel - Original Message - From: "Stig Sæther Bakken" <[EMAIL PROTECTED]> To: "James Moore" <[EMAIL PROTECTED]> Cc: "'Lars Torben Wilson'" <[EMAIL PROTECTED]>; "'Daniel Beckham'" <[EMAIL PROTECTED]>; "'phpdoc'" <[EMAIL PROTECTED]> Sent: Monday, May 21, 2001 4:04 AM Subject: Re: [PHP-DOC] Function References not showing up in docs for mixed case function names > ["James Moore" <[EMAIL PROTECTED]>] > > > > bad: Foo() does bar; > > > > good: The function foo() does bar. > > > > > > > > Daniel > > > > > > I agree with your second assertion. I could see a lot of > > > users getting confused if the first were followed blindly, > > > though (say, if one was documenting C). Which is one reason > > > (besides style) why I agree with the second assertion...:) > > > > Im sorry but I feel we should keep all function names lowercase. Take a > > look at http://php.net/manual/en/ref.pdf.php now, that really looks ugly > > too me, there is no reason to have function names at beginning of > > sentences and lets keep the manual consistent, if its all lowercase we > > will encourage people to name their functions properly etc, we are not > > going to start putting PdF_OpeN in the manual just because its supported > > lets keep the manual consistent and keep it lowercase, this has worked > > for the past x years and there is no real reason to change it. > > Just a comment from the side here: keep in mind that there has been > discussion on php-dev about making PHP functions and classes case > sensitive in a future release. It won't happen tomorrow, but it's > something to store in ones subconsciousness. > > - Stig > > -- > Stig Sæther Bakken <[EMAIL PROTECTED]> > Fast Search & Transfer ASA, Trondheim, Norway >
Re: [PHP-DOC] Function References not showing up in docs for mixed case function names
["James Moore" <[EMAIL PROTECTED]>] > > > bad: Foo() does bar; > > > good: The function foo() does bar. > > > > > > Daniel > > > > I agree with your second assertion. I could see a lot of > > users getting confused if the first were followed blindly, > > though (say, if one was documenting C). Which is one reason > > (besides style) why I agree with the second assertion...:) > > Im sorry but I feel we should keep all function names lowercase. Take a > look at http://php.net/manual/en/ref.pdf.php now, that really looks ugly > too me, there is no reason to have function names at beginning of > sentences and lets keep the manual consistent, if its all lowercase we > will encourage people to name their functions properly etc, we are not > going to start putting PdF_OpeN in the manual just because its supported > lets keep the manual consistent and keep it lowercase, this has worked > for the past x years and there is no real reason to change it. Just a comment from the side here: keep in mind that there has been discussion on php-dev about making PHP functions and classes case sensitive in a future release. It won't happen tomorrow, but it's something to store in ones subconsciousness. - Stig -- Stig Sæther Bakken <[EMAIL PROTECTED]> Fast Search & Transfer ASA, Trondheim, Norway
Re: [PHP-DOC] Function References not showing up in docs for mixed case function names
hehe, the PDF fuctions were the reason I started this thread in the first place. They should probably all be changed to lowercase sometime after X-Files is over tonight. =) Daniel - Original Message - From: "James Moore" <[EMAIL PROTECTED]> To: "'Lars Torben Wilson'" <[EMAIL PROTECTED]>; "'Daniel Beckham'" <[EMAIL PROTECTED]> Cc: "'phpdoc'" <[EMAIL PROTECTED]> Sent: Sunday, May 20, 2001 6:08 PM Subject: RE: [PHP-DOC] Function References not showing up in docs for mixed case function names > > > > bad: Foo() does bar; > > > good: The function foo() does bar. > > > > > > Daniel > > > > I agree with your second assertion. I could see a lot of > > users getting confused if the first were followed blindly, > > though (say, if one was documenting C). Which is one reason > > (besides style) why I agree with the second assertion...:) > > Im sorry but I feel we should keep all function names lowercase. Take a > look at http://php.net/manual/en/ref.pdf.php now, that really looks ugly > too me, there is no reason to have function names at beginning of > sentences and lets keep the manual consistent, if its all lowercase we > will encourage people to name their functions properly etc, we are not > going to start putting PdF_OpeN in the manual just because its supported > lets keep the manual consistent and keep it lowercase, this has worked > for the past x years and there is no real reason to change it. > > - James > >
RE: [PHP-DOC] Function References not showing up in docs for mixed case function names
James Moore writes: > > > > bad: Foo() does bar; > > > good: The function foo() does bar. > > > > > > Daniel > > > > I agree with your second assertion. I could see a lot of > > users getting confused if the first were followed blindly, > > though (say, if one was documenting C). Which is one reason > > (besides style) why I agree with the second assertion...:) > > Im sorry but I feel we should keep all function names lowercase. Take a > look at http://php.net/manual/en/ref.pdf.php now, that really looks ugly > too me, there is no reason to have function names at beginning of > sentences and lets keep the manual consistent, if its all lowercase we > will encourage people to name their functions properly etc, we are not > going to start putting PdF_OpeN in the manual just because its supported > lets keep the manual consistent and keep it lowercase, this has worked > for the past x years and there is no real reason to change it. > > - James +1 -- Torben Wilson <[EMAIL PROTECTED]> http://www.thebuttlesschaps.com +1.604.709.0506
RE: [PHP-DOC] Function References not showing up in docs for mixed case function names
> > bad: Foo() does bar; > > good: The function foo() does bar. > > > > Daniel > > I agree with your second assertion. I could see a lot of > users getting confused if the first were followed blindly, > though (say, if one was documenting C). Which is one reason > (besides style) why I agree with the second assertion...:) Im sorry but I feel we should keep all function names lowercase. Take a look at http://php.net/manual/en/ref.pdf.php now, that really looks ugly too me, there is no reason to have function names at beginning of sentences and lets keep the manual consistent, if its all lowercase we will encourage people to name their functions properly etc, we are not going to start putting PdF_OpeN in the manual just because its supported lets keep the manual consistent and keep it lowercase, this has worked for the past x years and there is no real reason to change it. - James
Re: [PHP-DOC] Function References not showing up in docs for mixed case function names
Daniel Beckham writes: > As far as English grammar goes, they should be capitalized if they are the > first word in a sentence. If you are using the function name as the first > word though, you probably could come up with a better way to write it. > > bad: Foo() does bar; > good: The function foo() does bar. > > Daniel I agree with your second assertion. I could see a lot of users getting confused if the first were followed blindly, though (say, if one was documenting C). Which is one reason (besides style) why I agree with the second assertion...:) > - Original Message - > From: "Lars Torben Wilson" <[EMAIL PROTECTED]> > Newsgroups: php.doc > To: <[EMAIL PROTECTED]> > Cc: <[EMAIL PROTECTED]> > Sent: Sunday, May 20, 2001 7:09 AM > Subject: Re: [PHP-DOC] Function References not showing up in docs for mixed > case function names > > > > And that even at the start of a sentence. You also don't write numbers > in > > > uppercase just because they happen to be the first 'word' of a sentence. > > > > Bad example: sentences shouldn't start with digits anyway. Spell the > > word out at the start of a sentence. It remains largely undecided as > > to whether function names should be capitalized when starting a > > sentence--I personally believe they should not be, but not everybody > > thinks that way. :) > > -- Torben Wilson <[EMAIL PROTECTED]> http://www.thebuttlesschaps.com +1.604.709.0506
Re: [PHP-DOC] Function References not showing up in docs for mixed case function names
[EMAIL PROTECTED] writes: > On Sun, May 20, 2001 at 02:56:31AM -0700, Lars Torben Wilson wrote: > > > To be honest, I've never noticed this problem before, and I've been > > working on the manual for 3 years. But then, I always use lowercase > > for function names so I wouldn't necessarily have clued in before > > now. :) > > Add 2 years and your statement is much more correct :) I can remember that > you have done this work from a .se or .fi homepage and have seen your > notice for your movement to the Amerika. Woah...time flies, I guess. :) > If you have time, come over to Germany and visit me on the LinuxDays. > Rasmus told me, he would try to come also. I would absolutely *love* to go. Last year I spent a week with friends in Allgaeu (Nesselwang) and fell in love with it. I'm already going to be doing too much travelling to be able to afford the trip this year, though. :( > -Egon > > -- > LinuxTag, Stuttgart, Germany: July 5-8 2001: http://www.linuxtag.de/ > All known books about PHP and related books: http://php.net/books.php > Concert Band of the University of Hohenheim: http://www.concert-band.de/ > First and second bestselling book in German: http://www.php-buch.de/ -- Torben Wilson <[EMAIL PROTECTED]> http://www.thebuttlesschaps.com +1.604.709.0506
Re: [PHP-DOC] Function References not showing up in docs for mixed case function names
Egon wrote: > Some years ago there have been disscusions and there have recently beens > some discussions to make the function names more user friendly. I have > made the suggestion to make function names with underscores and not with > capitalized letters. I mean the function name ImageCopyResized should be > aliased to image_copy_resized. > > This discussion arise every now and then. I hope the QA team can make some > improvements. I gave it my best shot - IMHO, there is just too much dissention to correct the problems with the function names. :( The issue is not the difficulty of the task - adding aliases is a fairly simple matter - a simple line like the following: PHP_FALIAS(mysql,mysql_db_query, NULL) > I have for myself not the time to change the source code. > I'm only looking for the function prototypes within comments. --zak
Re: [PHP-DOC] Function References not showing up in docs for mixed case function names
You are preaching to the choir. =) I think the obstacle here is the need for the development/qa team to make the necessary changes and implement the necessary standards. As Egon said... we write documentation and don't necessarily have the time or the know-how to make these changes. Daniel - Original Message - From: "Hojtsy Gabor" <[EMAIL PROTECTED]> To: "Daniel Beckham" <[EMAIL PROTECTED]>; "phpdoc" <[EMAIL PROTECTED]> Sent: Sunday, May 20, 2001 3:19 PM Subject: Re: [PHP-DOC] Function References not showing up in docs for mixed case function names > > There should be a function naming standard for all functions... > > Goba > ... . . . . . > Editor of the Hungarian PHP manual, Admin of the Hungarian PHP mirror > >
Re: [PHP-DOC] Function References not showing up in docs for mixed case function names
[EMAIL PROTECTED] writes: > > I took a quick look through the DSSSL before I committed the patch > > which lowercased the Hyperwave tags a couple of days ago, > > and it looked as though case-folding was intended, as did the XSL > > stylesheet. I haven't had time to look up the syntax used and I'm not > > an expert in either though, so I couldn't say for sure and just ended > > up running a script over hw.xml to fix the problem. > > > > To be honest, I've never noticed this problem before, and I've been > > working on the manual for 3 years. But then, I always use lowercase > > for function names so I wouldn't necessarily have clued in before > > now. :) > > Sorry to reply so late, have been on the road in Germany. > > This problem with the functions names have been discussed several times. > Look at the mysql_*() functions, there is everything ok. Zeev made aliases > so we have now easy functions name which can be rememberd by any average > user. Yup--but here I think we were specifically referring to the case used in tags in the manual. But the Great Renaming Debate has certainly been gone over a few times this year. :) > Sure function names are case-insensitive. But can you imagine to rename a > function like ImageCopyMerge() or ImageCopyResampled() to imagecopymerge() > or imagecopyresampled()? Yup, if only because it calls attention to the fact that the function could have been named more carefully in the first place :) Besides, like I said, I'm not as interested in the actual case of the function names in the manual as I am in getting the hyperlinks working: that's the most important thing from the reader's point of view IMHO. > -Egon -- Torben Wilson <[EMAIL PROTECTED]> http://www.thebuttlesschaps.com +1.604.709.0506
Re: [PHP-DOC] Function References not showing up in docs for mixed case function names
On Sun, May 20, 2001 at 03:18:26PM -0500, Daniel Beckham wrote: > > This problem with the functions names have been discussed several times. > > Look at the mysql_*() functions, there is everything ok. Zeev made aliases > > so we have now easy functions name which can be rememberd by any average > > user. > > > Sure function names are case-insensitive. But can you imagine to rename a > > function like ImageCopyMerge() or ImageCopyResampled() to imagecopymerge() > > or imagecopyresampled()? > > It took me a few minutes to understand what you were saying, but I see now > that you mean that it's difficult to read those long function names in code. > What does it take to add aliases for these functions? Is having this many > function aliases ok with the development team, etc.? If this is truly an > issue, can we begin making these transitions? I'm not an native English speaker so I'm not surprised that you needs some minutes :) Some years ago there have been disscusions and there have recently beens some discussions to make the function names more user friendly. I have made the suggestion to make function names with underscores and not with capitalized letters. I mean the function name ImageCopyResized should be aliased to image_copy_resized. This discussion arise every now and then. I hope the QA team can make some improvements. I have for myself not the time to change the source code. I'm only looking for the function prototypes within comments. -Egon -- LinuxTag, Stuttgart, Germany: July 5-8 2001: http://www.linuxtag.de/ All known books about PHP and related books: http://php.net/books.php Concert Band of the University of Hohenheim: http://www.concert-band.de/ First and second bestselling book in German: http://www.php-buch.de/
Re: [PHP-DOC] Function References not showing up in docs for mixed case function names
> It took me a few minutes to understand what you were saying, but I see now > that you mean that it's difficult to read those long function names in code. > What does it take to add aliases for these functions? Is having this many > function aliases ok with the development team, etc.? If this is truly an > issue, can we begin making these transitions? There should be a function naming standard for all functions... Goba ... . . . . . Editor of the Hungarian PHP manual, Admin of the Hungarian PHP mirror
Re: [PHP-DOC] Function References not showing up in docs for mixed case function names
- Original Message - From: <[EMAIL PROTECTED]> To: "Lars Torben Wilson" <[EMAIL PROTECTED]>; "Hojtsy Gabor" <[EMAIL PROTECTED]> Cc: "Daniel Beckham" <[EMAIL PROTECTED]>; "phpdoc" <[EMAIL PROTECTED]>; <[EMAIL PROTECTED]> Sent: Sunday, May 20, 2001 1:23 PM Subject: Re: [PHP-DOC] Function References not showing up in docs for mixed case function names > This problem with the functions names have been discussed several times. > Look at the mysql_*() functions, there is everything ok. Zeev made aliases > so we have now easy functions name which can be rememberd by any average > user. > Sure function names are case-insensitive. But can you imagine to rename a > function like ImageCopyMerge() or ImageCopyResampled() to imagecopymerge() > or imagecopyresampled()? It took me a few minutes to understand what you were saying, but I see now that you mean that it's difficult to read those long function names in code. What does it take to add aliases for these functions? Is having this many function aliases ok with the development team, etc.? If this is truly an issue, can we begin making these transitions? Daniel
Re: [PHP-DOC] Function References not showing up in docs for mixed case function names
On Sun, May 20, 2001 at 02:56:31AM -0700, Lars Torben Wilson wrote: > To be honest, I've never noticed this problem before, and I've been > working on the manual for 3 years. But then, I always use lowercase > for function names so I wouldn't necessarily have clued in before > now. :) Add 2 years and your statement is much more correct :) I can remember that you have done this work from a .se or .fi homepage and have seen your notice for your movement to the Amerika. If you have time, come over to Germany and visit me on the LinuxDays. Rasmus told me, he would try to come also. -Egon -- LinuxTag, Stuttgart, Germany: July 5-8 2001: http://www.linuxtag.de/ All known books about PHP and related books: http://php.net/books.php Concert Band of the University of Hohenheim: http://www.concert-band.de/ First and second bestselling book in German: http://www.php-buch.de/
Re: [PHP-DOC] Function References not showing up in docs for mixed case function names
On Sun, May 20, 2001 at 02:56:31AM -0700, Lars Torben Wilson wrote: > Hojtsy Gabor writes: > > > by Daniel: > > > I would propose that a phpdoc wide change be made so that all functions > > are > > > written in lowercase form. It's not necessary to have them in a mixed > > case > > > created on the author's whim. > > > > > by Jeroen: > > > > > > function-names are NOT case-sensitive in PHP itself... so why not change > > > the stylesheets or something so that it is NOT case-sensitive in the docs > > > either? > > > > > > We've got an excellent DSSSL-fu'er over here :), maybe he or someone > > > else knows how to change that? What do you mean with this? > > XML *IS* case sensitive, and we use XML to make the docs. > > So I think we should be XML compatible with function names too. > > True, but the tool used to document another tool should not define > what is presented to the reader. :) > > I took a quick look through the DSSSL before I committed the patch > which lowercased the Hyperwave tags a couple of days ago, > and it looked as though case-folding was intended, as did the XSL > stylesheet. I haven't had time to look up the syntax used and I'm not > an expert in either though, so I couldn't say for sure and just ended > up running a script over hw.xml to fix the problem. > > To be honest, I've never noticed this problem before, and I've been > working on the manual for 3 years. But then, I always use lowercase > for function names so I wouldn't necessarily have clued in before > now. :) Sorry to reply so late, have been on the road in Germany. This problem with the functions names have been discussed several times. Look at the mysql_*() functions, there is everything ok. Zeev made aliases so we have now easy functions name which can be rememberd by any average user. Sure function names are case-insensitive. But can you imagine to rename a function like ImageCopyMerge() or ImageCopyResampled() to imagecopymerge() or imagecopyresampled()? -Egon -- LinuxTag, Stuttgart, Germany: July 5-8 2001: http://www.linuxtag.de/ All known books about PHP and related books: http://php.net/books.php Concert Band of the University of Hohenheim: http://www.concert-band.de/ First and second bestselling book in German: http://www.php-buch.de/
Re: [PHP-DOC] Function References not showing up in docs for mixed case function names
As far as English grammar goes, they should be capitalized if they are the first word in a sentence. If you are using the function name as the first word though, you probably could come up with a better way to write it. bad: Foo() does bar; good: The function foo() does bar. Daniel - Original Message - From: "Lars Torben Wilson" <[EMAIL PROTECTED]> Newsgroups: php.doc To: <[EMAIL PROTECTED]> Cc: <[EMAIL PROTECTED]> Sent: Sunday, May 20, 2001 7:09 AM Subject: Re: [PHP-DOC] Function References not showing up in docs for mixed case function names > > And that even at the start of a sentence. You also don't write numbers in > > uppercase just because they happen to be the first 'word' of a sentence. > > Bad example: sentences shouldn't start with digits anyway. Spell the > word out at the start of a sentence. It remains largely undecided as > to whether function names should be capitalized when starting a > sentence--I personally believe they should not be, but not everybody > thinks that way. :)
Re: [PHP-DOC] Function References not showing up in docs for mixed case function names
Hmm.. if you are going to do this in an automated way, you need to look at tags also. Those show up on the intro and sidebar nav areas. Daniel - Original Message - From: <[EMAIL PROTECTED]> Newsgroups: php.doc To: <[EMAIL PROTECTED]> Sent: Sunday, May 20, 2001 6:49 AM Subject: Re: [PHP-DOC] Function References not showing up in docs for mixed case function names > > > XML *IS* case sensitive, and we use XML to make the docs. > > > So I think we should be XML compatible with function names too. > > > > True, but the tool used to document another tool should not define > > what is presented to the reader. :) > > I agree, but for a little consistance it would still be a good idea to make > anything lowercase... this can't be too hard, > just a regular expression to find all ...'s, and then > make it lowercase? Or that script, maybe that works well? > > And that even at the start of a sentence. You also don't write numbers in > uppercase just because they happen to be the first 'word' of a sentence. > > In a day or something I'll process the whole documentation (all languages > too). > > Unless someone has any objections of course. > > Greetz, > Jeroen > > >
Re: [PHP-DOC] Function References not showing up in docs for mixed case function names
Same here, acutally. I was making some changes to the PDF functions the other day and noticed the links not working. I always write in lower case. It just makes the most sense to me. Daniel - Original Message - From: "Lars Torben Wilson" <[EMAIL PROTECTED]> To: "Hojtsy Gabor" <[EMAIL PROTECTED]> Cc: "Daniel Beckham" <[EMAIL PROTECTED]>; "phpdoc" <[EMAIL PROTECTED]>; <[EMAIL PROTECTED]> Sent: Sunday, May 20, 2001 4:56 AM Subject: Re: [PHP-DOC] Function References not showing up in docs for mixed case function names > Hojtsy Gabor writes: > > > by Daniel: > > > I would propose that a phpdoc wide change be made so that all functions > > are > > > written in lowercase form. It's not necessary to have them in a mixed > > case > > > created on the author's whim. > > > > > by Jeroen: > > > > > > function-names are NOT case-sensitive in PHP itself... so why not change > > > the stylesheets or something so that it is NOT case-sensitive in the docs > > > either? > > > > > > We've got an excellent DSSSL-fu'er over here :), maybe he or someone > > > else knows how to change that? > > > > XML *IS* case sensitive, and we use XML to make the docs. > > So I think we should be XML compatible with function names too. > > > > Goba > > True, but the tool used to document another tool should not define > what is presented to the reader. :) > > I took a quick look through the DSSSL before I committed the patch > which lowercased the Hyperwave tags a couple of days ago, > and it looked as though case-folding was intended, as did the XSL > stylesheet. I haven't had time to look up the syntax used and I'm not > an expert in either though, so I couldn't say for sure and just ended > up running a script over hw.xml to fix the problem. > > To be honest, I've never noticed this problem before, and I've been > working on the manual for 3 years. But then, I always use lowercase > for function names so I wouldn't necessarily have clued in before > now. :) > > > > -- > Torben Wilson <[EMAIL PROTECTED]> > http://www.thebuttlesschaps.com > +1.604.709.0506 > >
Re: [PHP-DOC] Function References not showing up in docs for mixed case function names
[EMAIL PROTECTED] writes:
> > > XML *IS* case sensitive, and we use XML to make the docs.
> > > So I think we should be XML compatible with function names too.
> >
> > True, but the tool used to document another tool should not define
> > what is presented to the reader. :)
>
> I agree, but for a little consistance it would still be a good idea to make
> anything lowercase... this can't be too hard,
> just a regular expression to find all ...'s, and then
> make it lowercase? Or that script, maybe that works well?
That's what I did, as I mentioned in the snipped part of the above
email. I'm not saying we *should* have mixed-case function names in
the manual--just that whatever we decide upon should be decided upon
for reasons of 'This is the way PHP works', not 'This is the way XML
works'--and in PHP function names are case-insensitive, so this is
largely a matter of aesthetics. I agree that it would be good to have
it all consistent, and that we should clean it up. But until we can
get that done, I think the stylesheets should take care of it: I feel
that the crossreferencing presented by these tags is more important to
the reader than the case of the letters used.
> And that even at the start of a sentence. You also don't write numbers in
> uppercase just because they happen to be the first 'word' of a sentence.
Bad example: sentences shouldn't start with digits anyway. Spell the
word out at the start of a sentence. It remains largely undecided as
to whether function names should be capitalized when starting a
sentence--I personally believe they should not be, but not everybody
thinks that way. :)
> In a day or something I'll process the whole documentation (all
> languages too). Unless someone has any objections of course.
> Greetz, Jeroen
I think this is a good idea. Just run 'make test' when you do. :)
BTW, here's the script:
#!/usr/local/bin/php -q
');
}
if (!$source = implode('', file($argv[1]))) {
die("Failed reading '$sourcefile'\n");
}
echo preg_replace(':(.*?):ise',
'"".strtolower("\1").""',
$source);
?>
--
Torben Wilson <[EMAIL PROTECTED]>
http://www.thebuttlesschaps.com
+1.604.709.0506
Re: [PHP-DOC] Function References not showing up in docs for mixed case function names
> > XML *IS* case sensitive, and we use XML to make the docs. > > So I think we should be XML compatible with function names too. > > True, but the tool used to document another tool should not define > what is presented to the reader. :) I agree, but for a little consistance it would still be a good idea to make anything lowercase... this can't be too hard, just a regular expression to find all ...'s, and then make it lowercase? Or that script, maybe that works well? And that even at the start of a sentence. You also don't write numbers in uppercase just because they happen to be the first 'word' of a sentence. In a day or something I'll process the whole documentation (all languages too). Unless someone has any objections of course. Greetz, Jeroen
Re: [PHP-DOC] Function References not showing up in docs for mixed case function names
Hojtsy Gabor writes: > > by Daniel: > > I would propose that a phpdoc wide change be made so that all functions > are > > written in lowercase form. It's not necessary to have them in a mixed > case > > created on the author's whim. > > > by Jeroen: > > > > function-names are NOT case-sensitive in PHP itself... so why not change > > the stylesheets or something so that it is NOT case-sensitive in the docs > > either? > > > > We've got an excellent DSSSL-fu'er over here :), maybe he or someone > > else knows how to change that? > > XML *IS* case sensitive, and we use XML to make the docs. > So I think we should be XML compatible with function names too. > > Goba True, but the tool used to document another tool should not define what is presented to the reader. :) I took a quick look through the DSSSL before I committed the patch which lowercased the Hyperwave tags a couple of days ago, and it looked as though case-folding was intended, as did the XSL stylesheet. I haven't had time to look up the syntax used and I'm not an expert in either though, so I couldn't say for sure and just ended up running a script over hw.xml to fix the problem. To be honest, I've never noticed this problem before, and I've been working on the manual for 3 years. But then, I always use lowercase for function names so I wouldn't necessarily have clued in before now. :) -- Torben Wilson <[EMAIL PROTECTED]> http://www.thebuttlesschaps.com +1.604.709.0506
Re: [PHP-DOC] Function References not showing up in docs for mixed case function names
> by Daniel: > > Actually, I think that having function names in anything but lower case only > makes the manual less consistant and could even confuse new comers by > possibly making them think that certain functions that are written a certain > way in the docs (ala pdflib) must be written that way in code. > > I would propose that a phpdoc wide change be made so that all functions are > written in lowercase form. It's not necessary to have them in a mixed case > created on the author's whim. > by Jeroen: > > function-names are NOT case-sensitive in PHP itself... so why not change > the stylesheets or something so that it is NOT case-sensitive in the docs > either? > > We've got an excellent DSSSL-fu'er over here :), maybe he or someone > else knows how to change that? XML *IS* case sensitive, and we use XML to make the docs. So I think we should be XML compatible with function names too. Goba ... . . . . . Editor of the Hungarian PHP manual, Admin of the Hungarian PHP mirror
Re: [PHP-DOC] Function References not showing up in docs for mixed case function names
Actually, I think that having function names in anything but lower case only makes the manual less consistant and could even confuse new comers by possibly making them think that certain functions that are written a certain way in the docs (ala pdflib) must be written that way in code. I would propose that a phpdoc wide change be made so that all functions are written in lowercase form. It's not necessary to have them in a mixed case created on the author's whim. My 2 cents... Daniel - Original Message - From: <[EMAIL PROTECTED]> Newsgroups: php.doc To: <[EMAIL PROTECTED]> Sent: Saturday, May 19, 2001 5:10 PM Subject: Re: [PHP-DOC] Function References not showing up in docs for mixed case function names > > Linking is case sensitive. You should use lowercase > > names to have links. > > function-names are NOT case-sensitive in PHP itself... so why not change the > stylesheets or something so that it is NOT case-sensitive in the docs > either? > > We've got an excellent DSSSL-fu'er over here :), maybe he or someone else > knows how to change that? > > Greetz, > Jeroen > > >
Re: [PHP-DOC] Function References not showing up in docs for mixed case function names
How about the issue by the way? I haven't seen anything in CVS yet... Or did you beam it straight to me? Jeroen
Re: [PHP-DOC] Function References not showing up in docs for mixed case function names
[EMAIL PROTECTED] wrote: > > > Linking is case sensitive. You should use lowercase > > names to have links. > > function-names are NOT case-sensitive in PHP itself... so why not change the > stylesheets or something so that it is NOT case-sensitive in the docs > either? > > We've got an excellent DSSSL-fu'er over here :), maybe he or someone else > knows how to change that? already on it this very second -- Hartmut Holzgraefe [EMAIL PROTECTED] http://www.six.de +49-711-99091-77
Re: [PHP-DOC] Function References not showing up in docs for mixed case function names
> Linking is case sensitive. You should use lowercase > names to have links. function-names are NOT case-sensitive in PHP itself... so why not change the stylesheets or something so that it is NOT case-sensitive in the docs either? We've got an excellent DSSSL-fu'er over here :), maybe he or someone else knows how to change that? Greetz, Jeroen
Re: [PHP-DOC] Function References not showing up in docs for mixed case function names
> This is strange, for some reason, function references in the PDF section are > not working. It only bolds the function name, but does not link it to the > actual html document. I also checked the functions in the Graphics section > and some of the links are working, some are not. It appears the difference > between the linked function names and non-linked function names is that the > non-linked function names are mixed case, while any that are all lowercase > work just fine. Anyone know anything about this? Can this be corrected? > > e.g. > http://php.net/manual/en/function.pdf-findfont.php > http://php.net/manual/en/function.imagegif.php Linking is case sensitive. You should use lowercase names to have links. Goba ... . . . . . Editor of the Hungarian PHP manual, Admin of the Hungarian PHP mirror
[PHP-DOC] Function References not showing up in docs for mixed case function names
This is strange, for some reason, function references in the PDF section are not working. It only bolds the function name, but does not link it to the actual html document. I also checked the functions in the Graphics section and some of the links are working, some are not. It appears the difference between the linked function names and non-linked function names is that the non-linked function names are mixed case, while any that are all lowercase work just fine. Anyone know anything about this? Can this be corrected? e.g. http://php.net/manual/en/function.pdf-findfont.php http://php.net/manual/en/function.imagegif.php Daniel
