[PHP-DOC] cvs: phpdoc /howto scripts.xml

[Jakub Vrana]

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.1        Wed Sep  7 15:13:10 2005
+++ phpdoc/howto/scripts.xml    Wed Sep  7 17:25:36 2005
@@ -10,6 +10,59 @@
   explanation and usage tips for each one.
  </para>
 
+ <sect1 id="scripts.aspell.php">
+  <title>aspell.php</title>
+  <para>
+   This script can be used to escape or unescape manual files for use with
+   <command>aspell</command>. Escaping moves the contents of tags with
+   non-English texts (like <literal>&lt;type&gt;</literal>,
+   <literal>&lt;parameter&gt;</literal> or <literal>&lt;function&gt;</literal>)
+   to the attribute <literal>aspell</literal> so the Aspell will ignore them.
+   Unescaping is the opposite process.
+  </para>
+  <para>
+   File <filename>en.pws</filename> contains words not included in the Aspell
+   dictionary but valid in the PHP manual and can be used as the personal
+   dictionary.
+  </para>
+ </sect1>
+ 
+ <sect1 id="scripts.check-references.php">
+  <title>check-references.php</title>
+  <para>
+   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.
+  </para>
+  <para>
+   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 <varname>$difficult_*</varname> arrays
+   defined in the beginning of this script.
+  </para>
+ </sect1>
+ 
+ <sect1 id="scripts.diff-en-rev.php">
+  <title>diff_en_rev.php</title>
+  <para>
+   One of the scripts helping translators.
+  </para>
+  <para>
+   It prints a diff between the current English version and the translated
+   version of a file. It uses the <literal>&lt;!-- EN-Revision
+   --&gt;</literal> tag to determine the translated version. If the local
+   English file has different revision, <command>cvs diff</command> is
+   executed to obtain the list of changes.
+  </para>
+  <para>
+   It is possible to pass a directory name instead of file name. In this case,
+   list of modified files in the directory is printed.
+  </para>
+ </sect1>
+ 
  <sect1 id="scripts.extensions.xml.php">
   <title>extensions.xml.php</title>
   <para>
@@ -96,6 +149,28 @@
   </note>
  </sect1>
   
+ <sect1 id="scripts.html-syntax.php">
+  <title>html_syntax.php</title>
+  <para>
+   This script is used in the build process to syntax highlight PHP examples
+   both for the online and downloadable manuals.
+  </para>
+ </sect1>
+ 
+ <sect1 id="scripts.xml-check.php">
+  <title>xml-check.php</title>
+  <para>
+   Build process of the whole manual can be very slow. This script takes one
+   XML file, creates <filename>xml-check.xml</filename> in the documentation
+   root with the beginning and ending DocBook tags and parses this file with
+   <command>xmllint</command>. Beginning tags are taken from
+   <filename>manual.xml.in</filename>.
+  </para>
+  <para>
+   Detected errors are printed thus empty output means correct file.
+  </para>
+ </sect1>
+ 
 </chapter>
 
 <!-- Keep this comment at the end of the file