[PHP-DOC] Re: [PEAR-DEV] documenting and releasing a PHP extension
On Sat, 23 Jun 2001 16:10:12 -0700, Dan Libby wrote: 1) Is there a better place to ask these questions? ie, is there a list or forum for discussing 3rd party extensions? IMHO [EMAIL PROTECTED] is better for questions about programming style etc. 4) Is there a standard process for creating documentation for extension API's? I've seen mention of the proto keyword and some vague references to a doc/genfuncsummary script in the CODING_STANDARDS document distributed with php. Checkout the module phpdoc from cvs. There you'll find genfuncsummary. ps, the extension is a simple templating system similar to FastTemplate but much faster and with a couple extra features. Do you already know APL (http://www.twisd.de/apl/apl_kurzinfo.php)? That seems very similar to your extension. - Martin
Re: [PHP-DOC] cvs: phpdoc /cs/features http-auth.xml /cs/functions apache.xml array.xml aspell.xml com.xml dir.xml exec.xml filesystem.xml funchand.xml gettext.xml http.xml info.xml mail.xml misc.xml nis.xml readline.xml strings.xml url.xml /de/functio
It is IMHO wrong to make the function names as first word in a sentence lower case. Yes, I have looked several times into The Chicago Manual of Style. PHP functions are case insensitive. There was no need to change this. We discussed this earlier and ended up in making all the function names lowercase, to avoid confusion. As I can remember. Goba ... . . . . . Editor of the Hungarian PHP manual, Admin of the Hungarian PHP mirror
[PHP-DOC] cvs: phpdoc / TODO
jeroen Sun Jun 24 13:37:47 2001 EDT Added files: /phpdoc TODO Log: Add TODO file to phpdoc-repo
[PHP-DOC] cvs: phpdoc / manual.xml.in /en language-defs.ent language-snippets.ent /en/functions misc.xml var.xml
jeroen Sun Jun 24 13:45:37 2001 EDT Added files: /phpdoc/en language-snippets.ent Modified files: /phpdoc manual.xml.in /phpdoc/en language-defs.ent /phpdoc/en/functionsmisc.xml var.xml Log: Added snippets-file, where you can locate common snippets. See highlight-string for an example. Index: phpdoc/manual.xml.in diff -u phpdoc/manual.xml.in:1.68 phpdoc/manual.xml.in:1.69 --- phpdoc/manual.xml.in:1.68 Fri Jun 22 22:34:00 2001 +++ phpdoc/manual.xml.inSun Jun 24 13:45:37 2001 @@ -2,9 +2,11 @@ !DOCTYPE book PUBLIC -//Norman Walsh//DTD DocBk XML V1.7//EN @srcdir@/dbxml/docbookx.dtd [ -!ENTITY % language-defsSYSTEM @srcdir@/@LANGDIR@/language-defs.ent +!ENTITY % language-defs SYSTEM @srcdir@/@LANGDIR@/language-defs.ent +!ENTITY % language-snippets SYSTEM @srcdir@/@LANGDIR@/language-snippets.ent %language-defs; +%language-snippets; !-- Defaults for entities that should be defined in language-defs -- !ENTITY % global.entities SYSTEM @srcdir@/global.ent Index: phpdoc/en/language-defs.ent diff -u phpdoc/en/language-defs.ent:1.2 phpdoc/en/language-defs.ent:1.3 --- phpdoc/en/language-defs.ent:1.2 Thu Mar 8 03:45:53 2001 +++ phpdoc/en/language-defs.ent Sun Jun 24 13:45:37 2001 @@ -6,5 +6,3 @@ !ENTITY FunctionReference Function Reference !ENTITY AppendixesAppendixes !ENTITY PEAR PEAR: the PHP Extension and Application Repository - -!ENTITY available available in Index: phpdoc/en/functions/misc.xml diff -u phpdoc/en/functions/misc.xml:1.47 phpdoc/en/functions/misc.xml:1.48 --- phpdoc/en/functions/misc.xml:1.47 Sat Jun 23 22:10:51 2001 +++ phpdoc/en/functions/misc.xmlSun Jun 24 13:45:37 2001 @@ -510,7 +510,7 @@ The functionhighlight_file/function function prints out a syntax higlighted version of the code contained in parameterfilename/parameter using the colors defined in the built-in syntax highlighter for PHP. - It returns true on success, false otherwise (PHP 4). +return.success; /simpara note simpara @@ -586,6 +586,7 @@ /para /example /para + tip.ob-capture; simpara See also functionhighlight_string/function, functionshow_source/function. @@ -610,8 +611,9 @@ The functionhighlight_string/function function prints out a syntax highlighted version of parameterstr/parameter using the colors defined in the built-in syntax highlighter for PHP. - It returns true on success, false otherwise (PHP 4). +return.success; /simpara + tip.ob-capture; simpara See also functionhighlight_file/function, functionshow_source/function. Index: phpdoc/en/functions/var.xml diff -u phpdoc/en/functions/var.xml:1.55 phpdoc/en/functions/var.xml:1.56 --- phpdoc/en/functions/var.xml:1.55Sun Jun 24 07:11:35 2001 +++ phpdoc/en/functions/var.xml Sun Jun 24 13:45:37 2001 @@ -876,6 +876,7 @@ pointer to the end. Use functionreset/function to bring it back to beginning. /simpara + tip.ob-capture; simpara Compare functionprint_r/function to functionvar_dump/function. @@ -1288,6 +1289,7 @@ that includes its type and value. Arrays are explored recursively with values indented to show structure. /simpara + tip.ob-capture; simpara Compare functionvar_dump/function to functionprint_r/function. Index: phpdoc/en/language-snippets.ent +++ phpdoc/en/language-snippets.ent !ENTITY tip.ob-capture 'tipsimparaAs with anything that outputs its result directly to the browser, you can use the link linkend=ref.outcontroloutput-control functions/link to capture the output of this function, and save it - for example - in a typestring/type./simpara/tip' !ENTITY return.success 'Returns constantTRUE/constant on succes, constantFALSE/constant on failure.' !ENTITY note.not-bin-safe 'warningsimparaThis function is not (yet) binary safe!/simpara/warning' !ENTITY note.bin-safe 'notesimparaThis function is binary-safe/simpara/note' !ENTITY note.no-windows 'notesimparaThis function is not implemented on Windows-platforms/simpara/note' !ENTITY note.no-safemode 'notesimparaThis function is disabled when safe-mode is enabled./simpara/note'
Re: [PHP-DOC] cvs: phpdoc /en/functions var.xml
Anyway, when they add a new function, I'm sure they want it to be mentioned in the documentation, otherwise nobody uses it... Good point, But we cannot list all contributors on the author list. I suggest therefore into the starting section a list of contributors with full name and mail-address. I'm afraid you didn't understand me right. I meant, that when a DEVELOPPER makes a new function, he wants it (the function) to be mentioned in the docs. Of course, it's impossible to add all contributors there. The usual 'substantial contributor' rule should be applied. I'll add the TODO file soon, then. Can you add then the missing functions? Look at Hartmut's functions tables in the statistics page at: http://www.zugeschaut-und-mitgebaut.de/php or http://zend.com/phpfunc I haven't done that yet, if someone feels he should add it, please, go ahead :) Otherwise, I'll do it sometime next week. I know Hartmut very well, and he has done so many contributions for the PHP manual and the German translation. If nobody have something against, I put him on the author list. I haven't been following the phpdoc-proj for a long time, but I think he should be mentioned. Please don't make such megapatches. After deleting over 700 emails I could again get access to my mailbox. I'm sorry! But wouldn't it have been even worse if it were all separate commits? Goba wrote: We discussed this earlier and ended up in making all the function names lowercase, to avoid confusion. As I can remember. That is what I remembered... Of course it doesn't matter because funcnames are case-insensiteve (though on Zend you can read somewhere (don't know anymore where)) what maybe that will change), but for the sake of uniformity and clarity, I'm still standing in favor of the all-lowercase policy. -Egon Jeroen
[PHP-DOC] cvs: phpdoc /cs language-snippets.ent /de language-snippets.ent /es language-snippets.ent /fr language-snippets.ent /hk language-snippets.ent /hu language-snippets.ent /it language-snippets.ent /ja language-snippets.ent /kr language-snippets.ent /nl language-snippets.ent
jeroen Sun Jun 24 15:35:43 2001 EDT Added files: /phpdoc/cs language-snippets.ent /phpdoc/de language-snippets.ent /phpdoc/es language-snippets.ent /phpdoc/fr language-snippets.ent /phpdoc/hk language-snippets.ent /phpdoc/hu language-snippets.ent /phpdoc/it language-snippets.ent /phpdoc/ja language-snippets.ent /phpdoc/kr language-snippets.ent /phpdoc/nl language-snippets.ent Log: Make the snippets-file also exist for other languages. (oops...) Index: phpdoc/cs/language-snippets.ent +++ phpdoc/cs/language-snippets.ent !ENTITY tip.ob-capture 'tipsimparaAs with anything that outputs its result directly to the browser, you can use the link linkend=ref.outcontroloutput-control functions/link to capture the output of this function, and save it - for example - in a typestring/type./simpara/tip' !ENTITY return.success 'Returns constantTRUE/constant on succes, constantFALSE/constant on failure.' !ENTITY note.not-bin-safe 'warningsimparaThis function is not (yet) binary safe!/simpara/warning' !ENTITY note.bin-safe 'notesimparaThis function is binary-safe/simpara/note' !ENTITY note.no-windows 'notesimparaThis function is not implemented on Windows-platforms/simpara/note' !ENTITY note.no-safemode 'notesimparaThis function is disabled when safe-mode is enabled./simpara/note' Index: phpdoc/de/language-snippets.ent +++ phpdoc/de/language-snippets.ent !ENTITY tip.ob-capture 'tipsimparaAs with anything that outputs its result directly to the browser, you can use the link linkend=ref.outcontroloutput-control functions/link to capture the output of this function, and save it - for example - in a typestring/type./simpara/tip' !ENTITY return.success 'Returns constantTRUE/constant on succes, constantFALSE/constant on failure.' !ENTITY note.not-bin-safe 'warningsimparaThis function is not (yet) binary safe!/simpara/warning' !ENTITY note.bin-safe 'notesimparaThis function is binary-safe/simpara/note' !ENTITY note.no-windows 'notesimparaThis function is not implemented on Windows-platforms/simpara/note' !ENTITY note.no-safemode 'notesimparaThis function is disabled when safe-mode is enabled./simpara/note' Index: phpdoc/es/language-snippets.ent +++ phpdoc/es/language-snippets.ent !ENTITY tip.ob-capture 'tipsimparaAs with anything that outputs its result directly to the browser, you can use the link linkend=ref.outcontroloutput-control functions/link to capture the output of this function, and save it - for example - in a typestring/type./simpara/tip' !ENTITY return.success 'Returns constantTRUE/constant on succes, constantFALSE/constant on failure.' !ENTITY note.not-bin-safe 'warningsimparaThis function is not (yet) binary safe!/simpara/warning' !ENTITY note.bin-safe 'notesimparaThis function is binary-safe/simpara/note' !ENTITY note.no-windows 'notesimparaThis function is not implemented on Windows-platforms/simpara/note' !ENTITY note.no-safemode 'notesimparaThis function is disabled when safe-mode is enabled./simpara/note' Index: phpdoc/fr/language-snippets.ent +++ phpdoc/fr/language-snippets.ent !ENTITY tip.ob-capture 'tipsimparaAs with anything that outputs its result directly to the browser, you can use the link linkend=ref.outcontroloutput-control functions/link to capture the output of this function, and save it - for example - in a typestring/type./simpara/tip' !ENTITY return.success 'Returns constantTRUE/constant on succes, constantFALSE/constant on failure.' !ENTITY note.not-bin-safe 'warningsimparaThis function is not (yet) binary safe!/simpara/warning' !ENTITY note.bin-safe 'notesimparaThis function is binary-safe/simpara/note' !ENTITY note.no-windows 'notesimparaThis function is not implemented on Windows-platforms/simpara/note' !ENTITY note.no-safemode 'notesimparaThis function is disabled when safe-mode is enabled./simpara/note' Index: phpdoc/hk/language-snippets.ent +++ phpdoc/hk/language-snippets.ent !ENTITY tip.ob-capture 'tipsimparaAs with anything that outputs its result directly to the browser, you can use the link linkend=ref.outcontroloutput-control functions/link to capture the output of this function, and save it - for example - in a typestring/type./simpara/tip' !ENTITY return.success 'Returns constantTRUE/constant on succes, constantFALSE/constant on failure.' !ENTITY note.not-bin-safe 'warningsimparaThis function is not (yet) binary safe!/simpara/warning' !ENTITY note.bin-safe 'notesimparaThis function is binary-safe/simpara/note' !ENTITY note.no-windows 'notesimparaThis function is not implemented on Windows-platforms/simpara/note' !ENTITY note.no-safemode 'notesimparaThis function is disabled when safe-mode is enabled./simpara/note' Index: phpdoc/hu/language-snippets.ent +++ phpdoc/hu/language-snippets.ent !ENTITY tip.ob-capture 'tipsimparaAs with anything that outputs its result directly to the browser, you can use the link
Re: [PHP-DOC] cvs: phpdoc /cs/features http-auth.xml /cs/functionsapache.xml array.xml aspell.xml com.xml dir.xml exec.xml filesystem.xmlfunchand.xml gettext.xml http.xml info.xml mail.xml misc.xml nis.xmlreadline.xml strings.xml url.xml /de
[EMAIL PROTECTED] wrote: PHP functions are case insensitive. There was no need to change this. But they won't stay case insensitive. -- sebastian bergmann[EMAIL PROTECTED] http://www.sebastian-bergmann.de Meet the PHP Project at LinuxTag, Booth 5.0.334/2 - http://phpinfo.de/
Re: [PHP-DOC] cvs: phpdoc /en/functions var.xml
I don't think it's necessary to quote the developers when writing
documentation. Many people probably have no idea who Andi is and it's even
(very remotely) possible that he may not be involved in PHP development in
the future. The PHP docs are the definitive source for PHP documentation
and they already indirectly reflect the ideas and thoughts of the
development team, without having to quote them. Besides, the documentation
should be written in a confident style without having to support itself with
quotes or references.
What do you guys think?
Daniel
- Original Message -
From: Zak Greant [EMAIL PROTECTED]
To: [EMAIL PROTECTED]
Sent: Sunday, June 24, 2001 12:11 AM
Subject: [PHP-DOC] cvs: phpdoc /en/functions var.xml
zak Sun Jun 24 07:11:35 2001 EDT
Modified files:
/phpdoc/en/functions var.xml
Log:
Added note on behavior of is_scalar() with regards to resource type
values
Index: phpdoc/en/functions/var.xml
diff -u phpdoc/en/functions/var.xml:1.54 phpdoc/en/functions/var.xml:1.55
--- phpdoc/en/functions/var.xml:1.54 Sat Jun 23 22:10:51 2001
+++ phpdoc/en/functions/var.xml Sun Jun 24 07:11:35 2001
@@ -747,6 +747,14 @@
/para
note
para
+ Note that the PHP resource type is not considered a scalar value.
+ Andi Gutmans states: [Resources] are abstract datatypes which
+ happen to be in ID (integer) form ... people should [not] count
+ on it being an integer as this could change one day.
+ /para
+/note
+note
+ para
This function was added to the CVS code after the release of PHP
4.0.4pl1
/para
@@ -1291,7 +1299,7 @@
lt;?php
$a = array (1, 2, array (a, b, c));
var_dump ($a);
-
+
/* output:
array(3) {
[0]=
Re: [PHP-DOC] Re: [PHP-DEV] About ext/sockets/
This brings me to another point, since not-so-long-ago there is a phpdoc/TODO file, and we would greatly appreciate it that an entry is added whenever there is a substantial change to PHP which should be documented. Of course, it'd even better if you instead update the docs yourself ;-). Updating the TODO will increase the likelyhood that the documentation will be updated soon. If you don't have Karma to phpdoc, get it, or simply mail [EMAIL PROTECTED] Jeroen you only posted this (as I can see) to phpdoc. You should mail a copy of this para to php-dev and all lists and forums, where developers communicate with each other. Goba ... . . . . . Editor of the Hungarian PHP manual, Admin of the Hungarian PHP mirror
Re: [PHP-DOC] cvs: phpdoc /en/functions var.xml
I don't think it's necessary to quote the developers when writing documentation. Many people probably have no idea who Andi is and it's even (very remotely) possible that he may not be involved in PHP development in the future. The PHP docs are the definitive source for PHP documentation and they already indirectly reflect the ideas and thoughts of the development team, without having to quote them. Besides, the documentation should be written in a confident style without having to support itself with quotes or references. What do you guys think? + Note that the PHP resource type is not considered a scalar value. + Andi Gutmans states: [Resources] are abstract datatypes which + happen to be in ID (integer) form ... people should [not] count + on it being an integer as this could change one day. Yes, you are right, that the average PHP programmer will just be confused about why Andi's name is there... Goba
[PHP-DOC] cvs: phpdoc / make_chm.bat
tom Sun Jun 24 18:14:40 2001 EDT Modified files: /phpdoc make_chm.bat Log: makes fancy-dir automatically now, and cleans up .hh*-files Index: phpdoc/make_chm.bat diff -u phpdoc/make_chm.bat:1.5 phpdoc/make_chm.bat:1.6 --- phpdoc/make_chm.bat:1.5 Sat Feb 3 12:04:01 2001 +++ phpdoc/make_chm.bat Sun Jun 24 18:14:40 2001 @@ -1,50 +1,55 @@ -@echo off - -rem !! Please read the make_chm.README file for information -rem !! about how to build a manual_lang.chm file. - -rem Path of the PHP CGI executable -set PHP_PATH=D:\progra~1\php404\php.exe - -rem Path of the Help Compiler command line tool -set PHP_HELP_COMPILER=D:\progra~1\helpwo~1\hhc.exe - -rem The language of the manual to compile -set PHP_HELP_COMPILE_LANG=en - -rem The source directory with the original DSSSL made HTML -set PHP_HELP_COMPILE_DIR=html - -rem The index file in this directory (manual.html or idex.html) -set PHP_HELP_COMPILE_INDEX=index.html - -rem The directory, where the fancy files need to be copied -set PHP_HELP_COMPILE_FANCYDIR=fancy - -rem == -rem !DO NOT MODIFY ANYTHING BELOW THIS LINE ! -rem == - -echo. - -if a%1a == anormala goto skipfancy - -echo Now generating the fancy manual in %PHP_HELP_COMPILE_FANCYDIR% dir... -%PHP_PATH% -q make_chm_fancy.php - -goto normal - -:skipfancy -set PHP_HELP_COMPILE_FANCYDIR= -echo Skipping fancy manual generation... - -:normal - -echo Now running the toc and project file generator script... -%PHP_PATH% -q make_chm.php - -echo Compiling the actual helpfile (manual-%PHP_HELP_COMPILE_LANG%-date.chm)... -%PHP_HELP_COMPILER% manual-%PHP_HELP_COMPILE_LANG%.hhp - -echo Done! -echo. +@echo off + +rem !! Please read the make_chm.README file for information +rem !! about how to build a manual_lang.chm file. + +rem Path of the PHP CGI executable +set PHP_PATH=D:\progra~1\php404\php.exe + +rem Path of the Help Compiler command line tool +set PHP_HELP_COMPILER=D:\progra~1\helpwo~1\hhc.exe + +rem The language of the manual to compile +set PHP_HELP_COMPILE_LANG=en + +rem The source directory with the original DSSSL made HTML +set PHP_HELP_COMPILE_DIR=html + +rem The index file in this directory (manual.html or index.html) +set PHP_HELP_COMPILE_INDEX=index.html + +rem The directory, where the fancy files need to be copied +set PHP_HELP_COMPILE_FANCYDIR=fancy + +rem == +rem !DO NOT MODIFY ANYTHING BELOW THIS LINE ! +rem == + +echo. + +if a%1a == anormala goto skipfancy + +echo Now generating the fancy manual in %PHP_HELP_COMPILE_FANCYDIR% dir... +IF NOT EXIST %PHP_HELP_COMPILE_FANCYDIR%\NUL md %PHP_HELP_COMPILE_FANCYDIR% +%PHP_PATH% -q make_chm_fancy.php + +goto normal + +:skipfancy +set PHP_HELP_COMPILE_FANCYDIR= +echo Skipping fancy manual generation... + +:normal + +echo Now running the toc and project file generator script... +%PHP_PATH% -q make_chm.php + +echo Compiling the actual helpfile (manual-%PHP_HELP_COMPILE_LANG%-date.chm)... +%PHP_HELP_COMPILER% manual-%PHP_HELP_COMPILE_LANG%.hhp + +echo. +echo Cleaning up the directory +del manual-%PHP_HELP_COMPILE_LANG%.hh? + +echo Done! +echo.
[PHP-DOC] cvs: phpdoc / make_chm_fancy.php
tom Sun Jun 24 18:17:23 2001 EDT Modified files: /phpdoc make_chm_fancy.php Log: looks now directly in lang-dir for the fancy-index Index: phpdoc/make_chm_fancy.php diff -u phpdoc/make_chm_fancy.php:1.5 phpdoc/make_chm_fancy.php:1.6 --- phpdoc/make_chm_fancy.php:1.5 Sun Jun 3 19:14:23 2001 +++ phpdoc/make_chm_fancy.php Sun Jun 24 18:17:23 2001 @@ -17,8 +17,13 @@ } closedir($handle); + // Look for chm-index-file (snap-downloader, cvs-usr with/without lang-support) + if ( false == ($content = join(, file(make_chm_index_$language.html))) ) +if ( false == ($content = join(, +file($language/make_chm_index_$language.html))) ) + $content = join(, file(en/make_chm_index_en.html)); + + // make GENTIME the actual date/time - $content = join(, file(make_chm_index_$language.html)); $content = preg_replace(/\\[GENTIME\\]/, date(D M d H:i:s Y), $content); $fp = fopen($fancydir/fancy-index.html, w); fputs($fp, $content);
Re: [PHP-DOC] Re: [PHP-DEV] About ext/sockets/
Jeroen you only posted this (as I can see) to phpdoc. I replied to PHP-DEV, and CC'ed to phpdoc. It is not the emailheaders indeed, because the reply was via NNTP, and the CC via SMTP. But maybe that para should be more prominently posted in phpdev, now it is by-the-way'tje... Tnx for the warning anyway, jeroen
Re: [PHP-DOC] cvs: phpdoc /en/functions var.xml
I don't think it's necessary to quote the developers when writing documentation. Many people probably have no idea who Andi is and it's even (very remotely) possible that he may not be involved in PHP development in the future. The PHP docs are the definitive source for PHP documentation and they already indirectly reflect the ideas and thoughts of the development team, without having to quote them. Besides, the documentation should be written in a confident style without having to support itself with quotes or references. What do you guys think? Agreed. -Rasmus
[PHP-DOC] cvs: phpdoc / make_chm.README
tom Sun Jun 24 18:20:03 2001 EDT Modified files: /phpdoc make_chm.README Log: complete rewrite for an easier newbie-start, incl. adapted file-sizes etc.) Index: phpdoc/make_chm.README diff -u phpdoc/make_chm.README:1.5 phpdoc/make_chm.README:1.6 --- phpdoc/make_chm.README:1.5 Sat Feb 3 12:04:01 2001 +++ phpdoc/make_chm.README Sun Jun 24 18:20:03 2001 @@ -1,127 +1,107 @@ - -This is a README file about building the manual in -Windows Help File (.chm) format. This README is written -by Gabor Hojtsy ([EMAIL PROTECTED]). Contact him, or the phpdoc -list if you have any questions or suggestions... - -Note: Where 'lang' is mentioned in this doc, it is the -actual language code of the manual you are compiling, -not the 'lang' word itself! - -=== -You have two options to build the .chm manual: - - a) Use only the traditional DSSSL made html manual - b) Use a fancy html manual (converted from the DSSSL made html) - -In both cases you need Microsoft(r) HTML Help Workshop. -You can download it freely at: -http://msdn.microsoft.com/library/tools/htmlhelp/chm/hh1start.htm -You need the complete workshop package install (about 4 Megs). -Of cource you need one Microsoft(r) Windows to run that software. - -Now you need the html manual. You have two alternatives: - - a) Donwload the actual html manual from - http://snaps.php.net/manual/lang/ - and untar the distribution in a directory - a) Build the html manual yourself using Jade and the other - tools needed (look into the README or README.win32 - file to see how to build it yourself) - -=== -You need the .chm manual generator files (from cvs.php.net): - - make_chm.bat - The only file you need to run yourself. - make_chm.php - Auto toc generator. - -To make the fancy manual additional files needed: - - make_chm_fancy.php - Convert the normal html files to - good looking pages and correct - some pages (original index, copyright.html) - make_chm_index_lang.html - Fancy index. I recommend you - to use a fancy index in the language - of the actual compiled maunal (look into - phpdoc/lang dir if it exists). - make_chm_spc.gif - GIF file needed by the fancy pages. - make_chm_style.css - This adds some good style to html files. - -Note that you NEED make_chm.php and make_chm.bat to make the -fancy manual too! - -Now put the above listed make_chm_* files to one directory. -Put the html manual (~1700 files) under a subdir in this -directory (eg. html). - -You need to decide what method to use (normal or fancy). -The output .chm file for the tested English and Hungarian version -were nearly in the same size, the fancy manual .chm took 30k more space. -This is not significant, as the .chm files are ~1.5Megs in size. - -=== -To make manual-lang-date.chm using the normal HTML pages: - -Open make_chm.bat in a text editor and set the appropriate -environment variables. You need to - - - set PHP_PATH to the full path of the CGI php.exe on -your machine (including php.exe). - - set PHP_HELP_COMPILER to the full path of hhc.exe on -your machine (including hhc.exe). - - set PHP_HELP_COMPILE_LANG to the language code of the -actual manual (use the code from cvs.php.net, eg. hu) - - set PHP_HELP_COMPILE_DIR to the directory of the -html manual (eg. html) - - set PHP_HELP_COMPILE_INDEX to the index filename in -the directory you set above. This used to be manual.html -for a long time, but it seems it is now index.html. - -Now the batch file is ready to run. To compile the normal -manual, use the 'normal' command line option (without quotes): - -make_chm.bat normal - -It will generate manual-lang.hhp, manual-lang.hhc in the -same directory, and run hhc to finalize the process -and compile manual-lang-date.chm. - -=== -To make manual-lang-date.chm using the fancy style: - -See make_chm.bat and make all the modifications described above. -One more thing you need to set here is the PHP_HELP_COMPILE_FANCYDIR -environment variable, which is the container for the directory name -where the fancy pages will go. - -You can decide not to sacrifice any more space for the fancy dir -(it takes up 55 megs on my FAT16 system), and set this variable -to the same as PHP_HELP_COMPILE_DIR. Then your old HTML files -will be rewritten to be fancy ones. - -In any case make sure that the directory named in -PHP_HELP_COMPILE_FANCYDIR exists. I pesonally used fancy -as the value of this variable (without quotes). - -Now the batch file is ready to run. To
Re: [PHP-DOC] cvs: phpdoc /en/functions var.xml
Good point - thanks! :) How is this? para functionis_scalar/function does not consider resource type values to be scalar values. This behavior is intentional: Resources are abstract datatypes which are currently based on integers. This implementation detail should not be relied upon, as it may change. /para --zak Daniel Beckham wrote: I don't think it's necessary to quote the developers when writing documentation. Many people probably have no idea who Andi is and it's even (very remotely) possible that he may not be involved in PHP development in the future. The PHP docs are the definitive source for PHP documentation and they already indirectly reflect the ideas and thoughts of the development team, without having to quote them. Besides, the documentation should be written in a confident style without having to support itself with quotes or references.
[PHP-DOC] cvs: phpdoc /de/functions array.xml
tom Sun Jun 24 18:54:46 2001 EDT Modified files: /phpdoc/de/functionsarray.xml Log: added changes en-v1.68 to 1.71, now equiv. to v 1.72 Index: phpdoc/de/functions/array.xml diff -u phpdoc/de/functions/array.xml:1.14 phpdoc/de/functions/array.xml:1.15 --- phpdoc/de/functions/array.xml:1.14 Sat Jun 23 22:35:07 2001 +++ phpdoc/de/functions/array.xml Sun Jun 24 18:54:46 2001 @@ -14,6 +14,11 @@ aus Datenbankabfragen in Arrays speichern, und verschiedene andere Funktionen, die Arrays als Rückgabewerte haben. /simpara + para + In der Sektion link linkend=language.types.arrayArrays/link + finden Sie eine detailierte Erklärung, wie Arrays in PHP implementiert + sind und wie sie benutzt werden. + /para para Siehe auch functionis_array/function, functionexplode/function, functionimplode/function, functionsplit/function, @@ -104,7 +109,7 @@ 8 war. /para para - Dieses Beispiel erstellt ein auf dem Index 1 basierendes Array. + Dieses Beispiel erstellt ein auf dem Index 1 basierendes Array. example title1-basierter Index mit functionarray/function/title programlisting role=php @@ -194,6 +199,7 @@ /para para Dies speichert literalarray(blau);/literal in varname$result/varname. + Mehrfache Vorkommen in $array1 werden auf die gleiche Weise behandelt. /para para Siehe auch functionarray_intersect/function. @@ -1296,14 +1302,20 @@ titlefunctionarray_splice/function Beispiele/title programlisting role=php $input = array (rot, grün, blau, gelb); +array_splice ($input, 2); +// $input ist nun array (rot, grün) -array_splice ($input, 2); // $input ist nun array (rot, grün) -array_splice ($input, 1, -1); // $input ist nun array (rot, gelb) +$input = array (rot, grün, blau, gelb); +array_splice ($input, 1, -1); +// $input ist nun array (rot, gelb) + +$input = array (rot, grün, blau, gelb); array_splice ($input, 1, count($input), orange); - // $input ist nun array (rot, orange) +// $input ist nun array (rot, orange) + +$input = array (rot, grün, blau, gelb); array_splice ($input, -1, 1, array(schwarz, braun)); - // $input ist nun array (rot, grün, - // blau, schwarz, braun) +// $input ist nun array (rot, grün, blau, schwarz, braun) /programlisting /example /para @@ -1770,15 +1782,14 @@ /funcprototype /funcsynopsis para - Liefert die Anzahl von Elementen in parametervar/parameter, - welche typischerweise ein Array ist (da alles andere ein Element - enthält). + Liefert die Anzahl von Elementen in parametervar/parameter, welche + typischerweise ein Array ist (da alles andere ein Element enthält). /para para Gibt 1 zurück, wenn die Variable kein Array ist. /para para - Gibt 0 zurück, wenn die Variable nicht gesetzt ist. + Gibt 0 zurück, wenn die Variable nicht gesetzt, oder ein leeres Array ist. warning para functioncount/function kann 0 zurückgeben wenn die Variable @@ -1790,6 +1801,11 @@ /warning /para para + In der Sektion link linkend=language.types.arrayArrays/link + finden Sie eine detailierte Erklärung, wie Arrays in PHP implementiert + sind und wie sie benutzt werden. +/para +para example titlefunctioncount/function/title programlisting role=php @@ -1798,9 +1814,21 @@ $a[2] = 5; $result = count ($a); //$result == 3 + +$b[0] = 7; +$b[5] = 9; +$b[10] = 11; +$result = count ($b); +// $result == 3; /programlisting /example /para + note +para + Die Funktion functionsizeof/function ist ein Alias für + functioncount/function. +/para + /note para Siehe auch: functionsizeof/function, functionisset/function, und @@ -2806,18 +2834,18 @@ refentry id=function.sizeof refnamediv refnamesizeof/refname -refpurposeLiefert die Anzahl Elemente eines Arrays/refpurpose +refpurposeLiefert die Anzahl Elemente einer Variable/refpurpose /refnamediv refsect1 titleBeschreibung/title funcsynopsis funcprototype funcdefint functionsizeof/function/funcdef - paramdefarray parameterarray/parameter/paramdef + paramdefmixed parametervar/parameter/paramdef /funcprototype /funcsynopsis para - Gibt die Anzahl der in einem Array enthaltenen Elemente zurück. + Die Funktion functionsizeof/function ist ein Alias für +functioncount/function. /para para Siehe auch functioncount/function.
[PHP-DOC] cvs: phpdoc /de/functions filesystem.xml
tom Sun Jun 24 19:00:26 2001 EDT Modified files: /phpdoc/de/functionsfilesystem.xml Log: added changes from en-v1.65 to 1.68, is now ready till en-v1.69 Index: phpdoc/de/functions/filesystem.xml diff -u phpdoc/de/functions/filesystem.xml:1.24 phpdoc/de/functions/filesystem.xml:1.25 --- phpdoc/de/functions/filesystem.xml:1.24 Sat Jun 23 22:35:08 2001 +++ phpdoc/de/functions/filesystem.xml Sun Jun 24 19:00:26 2001 @@ -15,11 +15,15 @@ funcprototype funcdefstring functionbasename/function/funcdef paramdefstring parameterpath/parameter/paramdef + paramdefstring parameteroptionalsuffix/optional/parameter/paramdef /funcprototype /funcsynopsis para Diese Funktion extrahiert aus einer vollständigen Pfadangabe den - Namen der Datei und gibt diesen zurück. + Namen der Datei und gibt diesen zurück. Endet der Dateiname mit + parametersuffix/parameter, wird dieses Ende ebenfalls + abgeschnitten (der Parameter parametersuffix/parameter wurde + in PHP 4.0.7 eingeführt). /para para Unter Windows wird sowohl der Slash (literal//literal) als @@ -33,6 +37,7 @@ programlisting role=php $path = /home/httpd/html/index.php3; $file = basename($path); // $file enthält den Wert index.php3 +$file = basename ($path,.php3); // $file enthält den Wert index /programlisting /example /para
[PHP-DOC] cvs: phpdoc /de Translators
tom Sun Jun 24 19:02:35 2001 EDT Modified files: /phpdoc/de Translators Log: changed ready-status for array filesystem Index: phpdoc/de/Translators diff -u phpdoc/de/Translators:1.170 phpdoc/de/Translators:1.171 --- phpdoc/de/Translators:1.170 Sat Jun 23 11:12:45 2001 +++ phpdoc/de/Translators Sun Jun 24 19:02:35 2001 @@ -59,7 +59,7 @@ --- functions --- adabas.xml Johann-Peter Hartmann fertig apache.xml Johann-Peter Hartmann fertig -array.xml Thomas Schöfbeckfertig (bis V 1.68) +array.xml Thomas Schöfbeckfertig (bis V 1.72) aspell.xml Uwe Steinmann fertig bc.xml Uwe Steinmann fertig bzip2.xml Thomas Schöfbeckin Arbeit @@ -82,7 +82,7 @@ exec.xmlWolfgang Drews in Arbeit fdf.xml filepro.xml Martin Jansen fertig -filesystem.xml Wolfgang Drews + Thomas fertig (bis V. 1.65) +filesystem.xml Wolfgang Drews + Thomas fertig (bis V. 1.69) ftp.xml Thomas Schuermann fertig gettext.xml Sebastian Bergmann fertig http.xmlThomas Schuermann fertig (bis V. 1.13)
Re: [PHP-DOC] cvs: phpdoc /en/functions var.xml
Perfect, I think it conveys the idea even better than the first version. Thanks, Daniel - Original Message - From: Zak Greant [EMAIL PROTECTED] To: Hojtsy Gabor [EMAIL PROTECTED]; Daniel Beckham [EMAIL PROTECTED]; [EMAIL PROTECTED]; Rasmus Lerdorf [EMAIL PROTECTED] Sent: Sunday, June 24, 2001 11:50 AM Subject: Re: [PHP-DOC] cvs: phpdoc /en/functions var.xml Good point - thanks! :) How is this? para functionis_scalar/function does not consider resource type values to be scalar values. This behavior is intentional: Resources are abstract datatypes which are currently based on integers. This implementation detail should not be relied upon, as it may change. /para --zak Daniel Beckham wrote: I don't think it's necessary to quote the developers when writing documentation. Many people probably have no idea who Andi is and it's even (very remotely) possible that he may not be involved in PHP development in the future. The PHP docs are the definitive source for PHP documentation and they already indirectly reflect the ideas and thoughts of the development team, without having to quote them. Besides, the documentation should be written in a confident style without having to support itself with quotes or references.
[PHP-DOC] cvs: phpdoc /en/functions var.xml
zak Sun Jun 24 19:47:13 2001 EDT Modified files: /phpdoc/en/functionsvar.xml Log: Reworded note on behavior of is_scalar() in regards to resource type values - thanks Daniel! Index: phpdoc/en/functions/var.xml diff -u phpdoc/en/functions/var.xml:1.56 phpdoc/en/functions/var.xml:1.57 --- phpdoc/en/functions/var.xml:1.56Sun Jun 24 13:45:37 2001 +++ phpdoc/en/functions/var.xml Sun Jun 24 19:47:13 2001 @@ -747,10 +747,11 @@ /para note para - Note that the PHP resource type is not considered a scalar value. - Andi Gutmans states: [Resources] are abstract datatypes which - happen to be in ID (integer) form ... people should [not] count - on it being an integer as this could change one day. + functionis_scalar/function does not consider resource + type values to be scalar values. This behavior is intentional: + Resources are abstract datatypes which are currently based on + integers. This implementation detail should not be relied upon, + as it may change. /para /note note
[PHP-DOC] cvs: phpdoc / TODO /en/functions domxml.xml satellite.xml shmop.xml
jeroen Mon Jun 25 01:13:23 2001 EDT Modified files: /phpdoc TODO /phpdoc/en/functionsdomxml.xml satellite.xml shmop.xml Log: Fixed some identifiers. Updated TODO Index: phpdoc/TODO diff -u phpdoc/TODO:1.2 phpdoc/TODO:1.3 --- phpdoc/TODO:1.2 Sun Jun 24 17:27:21 2001 +++ phpdoc/TODO Mon Jun 25 01:13:22 2001 @@ -8,38 +8,9 @@ URGENT: - Note in sockets that the documentation is outdated, that -it has always been experimental (until 4.0.6, that is), - and that scripts that worked with PHP = 4.0.5 will - definitely NOT work with 4.0.6 or above. Not only - has there been renaming, the way the funcs work also - changed dramatically. - - Check out wether there are more experimental modules, -and CLEARLY state so in the documentation. - - ( find php4 | grep EXPERIMENTAL : - ./ext/crack/EXPERIMENTAL - ./ext/ctype/EXPERIMENTAL - ./ext/dbx/EXPERIMENTAL - ./ext/domxml/EXPERIMENTAL - ./ext/dotnet/EXPERIMENTAL - ./ext/fbsql/EXPERIMENTAL - ./ext/iconv/EXPERIMENTAL - ./ext/ingres_ii/EXPERIMENTAL - ./ext/mailparse/EXPERIMENTAL - ./ext/mbstring/EXPERIMENTAL - ./ext/ming/EXPERIMENTAL - ./ext/muscat/EXPERIMENTAL - ./ext/ncurses/EXPERIMENTAL - ./ext/openssl/EXPERIMENTAL - ./ext/pcntl/EXPERIMENTAL - ./ext/qtdom/EXPERIMENTAL - ./ext/sablot/EXPERIMENTAL - ./ext/satellite/EXPERIMENTAL - ./ext/skeleton/EXPERIMENTAL - ./ext/sockets/EXPERIMENTAL - ./ext/vpopmail/EXPERIMENTAL - ./ext/xslt/EXPERIMENTAL - ) +it has always been experimental. + The API may be changing soon. Currently it is discussed + in PHP-DEV. GENERAL: @@ -61,6 +32,8 @@ - print_r will NOT continue forever anymore on recursive arr's. - var_dump also not, but vardump simply quits at a too-high nesting level. + - Remark in shmop.xml whether or not the old shm_* funcnames still +work in the current version of PHP. (search for the TODO mark) (from php4/TODO): - improve documentation for the sablotron extension Index: phpdoc/en/functions/domxml.xml diff -u phpdoc/en/functions/domxml.xml:1.13 phpdoc/en/functions/domxml.xml:1.14 --- phpdoc/en/functions/domxml.xml:1.13 Sun Jun 24 17:27:21 2001 +++ phpdoc/en/functions/domxml.xml Mon Jun 25 01:13:22 2001 @@ -491,7 +491,7 @@ /refsect1 /refentry - refentry id=function.domxml_root + refentry id=function.domxml-root refnamediv refnamedomxml_root/refname refpurpose @@ -554,7 +554,7 @@ /refsect1 /refentry - refentry id=function.domxml_add_root + refentry id=function.domxml-add-root refnamediv refnamedomxml_add_root/refname refpurpose @@ -580,18 +580,18 @@ programlisting lt;?php $doc = new_xmldoc(1.0); -$root = $doc-add_root(HTML); -$head = $root-new_child(HEAD, ); -$head-new_child(TITLE, Hier der Titel); -echo $doc-dumpmem(); -? +$root = $doc-gt;add_root(HTML); +$head = $root-gt;new_child(HEAD, ); +$head-gt;new_child(TITLE, Hier der Titel); +echo $doc-gt;dumpmem(); +?gt; /programlisting /example /para /refsect1 /refentry - refentry id=function.domxml_dumpmem + refentry id=function.domxml-dumpmem refnamediv refnamedomxml_dumpmem/refname refpurpose @@ -617,7 +617,7 @@ /refsect1 /refentry - refentry id=function.domxml_attributes + refentry id=function.domxml-attributes refnamediv refnamedomxml_attributes/refname refpurpose @@ -639,7 +639,7 @@ /refsect1 /refentry - refentry id=function.domxml_get_attribute + refentry id=function.domxml-get-attribute refnamediv refnamedomxml_get_attribute/refname refpurpose @@ -665,7 +665,7 @@ /refsect1 /refentry - refentry id=function.domxml_set_attribute + refentry id=function.domxml-set-attribute refnamediv refnamedomxml_set_attribute/refname refpurpose @@ -706,7 +706,7 @@ /refsect1 /refentry - refentry id=function.domxml_children + refentry id=function.domxml-children refnamediv refnamedomxml_children/refname refpurpose @@ -745,7 +745,7 @@ /refsect1 /refentry - refentry id=function.domxml_new_child + refentry id=function.domxml-new-child refnamediv refnamedomxml_new_child/refname refpurpose @@ -767,7 +767,7 @@ /refsect1 /refentry - refentry id=function.domxml_new_xmldoc + refentry id=function.domxml-new-xmldoc refnamediv refnamedomxml_new_xmldoc/refname refpurpose @@ -791,7 +791,7 @@ /refsect1 /refentry - refentry id=function.xpath_new_context + refentry id=function.xpath-new-context refnamediv refnamexpath_new_context/refname refpurpose @@ -814,7 +814,7 @@ /refsect1 /refentry - refentry id=function.xpath_eval + refentry id=function.xpath-eval refnamediv refnamexpath_eval/refname refpurpose Index:
