vrana Wed Sep 7 17:25:37 2005 EDT
Modified files:
/phpdoc/howto scripts.xml
Log:
Document scripts published by me
http://cvs.php.net/diff.php/phpdoc/howto/scripts.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/howto/scripts.xml
diff -u phpdoc/howto/scripts.xml:1.1 phpdoc/howto/scripts.xml:1.2
--- phpdoc/howto/scripts.xml:1.1Wed Sep 7 15:13:10 2005
+++ phpdoc/howto/scripts.xmlWed Sep 7 17:25:36 2005
@@ -10,6 +10,59 @@
explanation and usage tips for each one.
+
+ aspell.php
+
+ This script can be used to escape or unescape manual files for use with
+ aspell. Escaping moves the contents of tags with
+ non-English texts (like ,
+ or )
+ to the attribute aspell so the Aspell will ignore them.
+ Unescaping is the opposite process.
+
+
+ File en.pws contains words not included in the Aspell
+ dictionary but valid in the PHP manual and can be used as the personal
+ dictionary.
+
+
+
+
+ check-references.php
+
+ This script tries to parse the PHP sources and compares the facts about
+ function parameters (their count, types, optionality and the need of
+ passing them as reference) with the documentation. Only easy parsable
+ functions from Zend, extensions, PECL and SAPI sources are checked.
+
+
+ Used rules are not absolutely precise, they are rather heuristics. Thus not
+ everything printed automatically denotes errors and sources should be
+ always read by a human before modifying the documentation. If the sources
+ correspond to the documentation and this script still produces error,
+ function should be added to one of $difficult_* arrays
+ defined in the beginning of this script.
+
+
+
+
+ diff_en_rev.php
+
+ One of the scripts helping translators.
+
+
+ It prints a diff between the current English version and the translated
+ version of a file. It uses the tag to determine the translated version. If the local
+ English file has different revision, cvs diff is
+ executed to obtain the list of changes.
+
+
+ It is possible to pass a directory name instead of file name. In this case,
+ list of modified files in the directory is printed.
+
+
+
extensions.xml.php
@@ -96,6 +149,28 @@
+
+ html_syntax.php
+
+ This script is used in the build process to syntax highlight PHP examples
+ both for the online and downloadable manuals.
+
+
+
+
+ xml-check.php
+
+ Build process of the whole manual can be very slow. This script takes one
+ XML file, creates xml-check.xml in the documentation
+ root with the beginning and ending DocBook tags and parses this file with
+ xmllint. Beginning tags are taken from
+ manual.xml.in.
+
+
+ Detected errors are printed thus empty output means correct file.
+
+
+