From d9cee3fbb32a45988ca92e2f10f91774a8935e4d Mon Sep 17 00:00:00 2001
From: Damien Seguy <dams@php.net>
Date: Wed, 19 May 2004 14:11:51 +0000
Subject: [PATCH] adding cosmetics tags

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@159013 c90b9560-bf6c-de11-be94-00142212c4b1
---
 appendices/about.xml      | 10 ++++----
 appendices/debugger.xml   |  6 ++---
 appendices/history.xml    |  4 ++--
 appendices/migration4.xml |  7 +++---
 appendices/phpdevel.xml   | 49 ++++++++++++++++++++-------------------
 5 files changed, 40 insertions(+), 36 deletions(-)

diff --git a/appendices/about.xml b/appendices/about.xml
index 9711d6d35c..73acd8242d 100644
--- a/appendices/about.xml
+++ b/appendices/about.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.31 $ -->
+<!-- $Revision: 1.32 $ -->
 
 <!--
   TODO: add manual conventions section (eg. how to read
@@ -66,15 +66,17 @@
    </para>
   </note>
   <para>
-   For owners of Palm-compatible handhelds, the Palm document and iSilo
+   For owners of Palm-compatible handhelds, the Palm document and 
+   <productname>iSilo</productname>
    formats are ideal for this platform. You can bring your handheld with you
    on your daily commute and use a <ulink url="&url.palm.doc;">DOC</ulink>
    or <ulink url="&url.palm.isilo;">iSilo</ulink> reader to brush up on your
    PHP knowledge, or just use it as a quick reference.
   </para>
   <para>
-   For Windows platforms, the Windows HTML Help version of the manual soups up
-   the HTML format for use with the Windows HTML Help application. This
+   For Windows platforms, the <productname>Windows HTML Help</productname> 
+   version of the manual soups up the HTML format for use with the 
+   <productname>Windows HTML Help</productname> application. This
    version provides full-text search, a full index, and bookmarking. Many
    popular Windows PHP development environments also integrate with this
    version of the documentation to provide easy access.
diff --git a/appendices/debugger.xml b/appendices/debugger.xml
index e857dcd637..978836b5e9 100644
--- a/appendices/debugger.xml
+++ b/appendices/debugger.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.26 $ -->
+<!-- $Revision: 1.27 $ -->
  <appendix id="debugger">
   <title>Debugging PHP</title>
 
@@ -78,11 +78,11 @@
    <para>
     A line has this format:
     <informalexample>
-     <literallayout>
+     <programlisting>
 <![CDATA[
 date time host(pid) type: message-data
 ]]>
-     </literallayout>
+     </programlisting>
     </informalexample>
    </para>
    <para>
diff --git a/appendices/history.xml b/appendices/history.xml
index 3383b0e753..637a12ba3e 100644
--- a/appendices/history.xml
+++ b/appendices/history.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.23 $ -->
+<!-- $Revision: 1.24 $ -->
 
 <appendix id="history">
  <title>History of PHP and related projects</title>
@@ -313,7 +313,7 @@
   <para>
    Articles about PHP appeared in Dr. Dobbs, Linux Enterprise,
    Linux Magazine and many more. Articles about migrating ASP-based
-   applications to PHP under Windows even appear on Microsoft's
+   applications to PHP under Windows even appear on <productname>Microsoft</productname>'s
    very own <acronym>MSDN</acronym>!
   </para>
  </sect1>
diff --git a/appendices/migration4.xml b/appendices/migration4.xml
index d47918a2cd..df554337b4 100644
--- a/appendices/migration4.xml
+++ b/appendices/migration4.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.36 $ -->
+<!-- $Revision: 1.37 $ -->
  <appendix id="migration4">
   <title>Migrating from PHP 3 to PHP 4</title>
 	
@@ -460,8 +460,9 @@ php_admin_flag [PHP directive name] [On|Off]
     While handling of global variables had the focus on to be easy in
     PHP 3 and early versions of PHP 4, the focus has changed to be more
     secure. While in PHP 3 the following example worked fine, in PHP 4 it
-    has to be unset($GLOBALS["id"]);. This is only one issue of global
-    variable handling. You should always have used $GLOBALS, with
+    has to be unset(<literal>unset($GLOBALS["id"])</literal>);. This is 
+    only one issue of global
+    variable handling. You should always have used <varname>$GLOBALS</varname>, with
     newer versions of PHP 4 you are forced to do so in most cases.
     Read more on this subject in the <link linkend="references.global">
     <literal>global</literal> references section</link>.
diff --git a/appendices/phpdevel.xml b/appendices/phpdevel.xml
index 234fdc8b5c..5be4219952 100644
--- a/appendices/phpdevel.xml
+++ b/appendices/phpdevel.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.24 $ -->
+<!-- $Revision: 1.25 $ -->
 <appendix id="phpdevel">
  <title>Extending PHP 3</title>
 
@@ -60,7 +60,8 @@ if (ARG_COUNT(ht) != 2 || getParameters(ht,2,&arg1,&arg2)==FAILURE) {
     sent by reference or by value, you can either start over with the
     parameter by calling pval_destructor on it, or if it's an ARRAY
     you want to add to, you can use functions similar to the ones in
-    internal_functions.h which manipulate return_value as an ARRAY.</simpara>
+    internal_functions.h which manipulate return_value as an ARRAY.
+   </simpara>
 
    <simpara>
     Also if you change a parameter to IS_STRING make sure you first
@@ -240,7 +241,7 @@ convert_string_to_number(arg1);  /* Converts string to either LONG or DOUBLE dep
   
    <para>
     <example>
-     <title>Checking whether $foo exists in a symbol table</title>
+     <title>Checking whether <varname>$foo</varname> exists in a symbol table</title>
      <programlisting role="c">
 <![CDATA[
 if (hash_exists(active_symbol_table,"foo",sizeof("foo"))) { exists... }
@@ -287,7 +288,7 @@ hash_update(active_symbol_table,"foo",sizeof("foo"),&arr,sizeof(pval),NULL);
      </programlisting>
     </example>
     
-    This code declares a new array, named $foo, in the active symbol
+    This code declares a new array, named <varname>$foo</varname>, in the active symbol
     table. This array is empty.</para>
     
    <simpara>
@@ -326,7 +327,7 @@ hash_next_index_insert(arr.value.ht,&entry,sizeof(pval),NULL);
 
    <simpara>
     hash_next_index_insert() uses more or less the same logic as
-    "$foo[] = bar;" in PHP 2.0.</simpara>
+    <literal>$foo[] = bar;</literal> in PHP 2.0.</simpara>
 
    <simpara>
     If you are building an array to return from a function, you can
@@ -794,7 +795,7 @@ php3_list_delete(resource_id->value.lval);
   </simpara>
 
   <sect2 id="internal.e-notice">
-   <title>E_NOTICE</title>
+   <title><constant>E_NOTICE</constant></title>
    <simpara>
     Notices are not printed by default, and indicate that the script
     encountered something that could indicate an error, but could also
@@ -805,7 +806,7 @@ php3_list_delete(resource_id->value.lval);
   </sect2>
 
   <sect2 id="internal.e-warning">
-   <title>E_WARNING</title>
+   <title><constant>E_WARNING</constant></title>
    <simpara>
     Warnings are printed by default, but do not interrupt script
     execution.  These indicate a problem that should have been trapped
@@ -815,7 +816,7 @@ php3_list_delete(resource_id->value.lval);
   </sect2>
 
   <sect2 id="internal.e-error">
-   <title>E_ERROR</title>
+   <title><constant>E_ERROR</constant></title>
    <simpara>
     Errors are also printed by default, and execution of the script is
     halted after the function returns. These indicate errors that can
@@ -824,7 +825,7 @@ php3_list_delete(resource_id->value.lval);
   </sect2>
 
   <sect2 id="internal.e-parse">
-   <title>E_PARSE</title>
+   <title><constant>E_PARSE</constant></title>
    <simpara>
     Parse errors should only be generated by the parser. The code is
     listed here only for the sake of completeness.
@@ -832,66 +833,66 @@ php3_list_delete(resource_id->value.lval);
   </sect2>
 
   <sect2 id="internal.e-core-error">
-   <title>E_CORE_ERROR</title>
+   <title><constant>E_CORE_ERROR</constant></title>
    <simpara>
-    This is like an E_ERROR, except it is generated by the core
+    This is like an <constant>E_ERROR</constant>, except it is generated by the core
     of PHP. Functions should not generate this type of error.
    </simpara>
   </sect2>
 
   <sect2 id="internal.e-core-warning">
-   <title>E_CORE_WARNING</title>
+   <title><constant>E_CORE_WARNING</constant></title>
    <simpara>
-    This is like an E_WARNING, except it is generated by the core
+    This is like an <constant>E_WARNING</constant>, except it is generated by the core
     of PHP. Functions should not generate this type of error.
    </simpara>
   </sect2>
 
   <sect2 id="internal.e-compile-error">
-   <title>E_COMPILE_ERROR</title>
+   <title><constant>E_COMPILE_ERROR</constant></title>
    <simpara>
-     This is like an E_ERROR, except it is generated by the Zend Scripting
+     This is like an <constant>E_ERROR</constant>, except it is generated by the Zend Scripting
      Engine. Functions should not generate this type of error.
    </simpara>
   </sect2>
 
   <sect2 id="internal.e-compile-warning">
-   <title>E_COMPILE_WARNING</title>
+   <title><constant>E_COMPILE_WARNING</constant></title>
    <simpara>
-     This is like an E_WARNING, except it is generated by the Zend Scripting
+     This is like an <constant>E_WARNING</constant>, except it is generated by the Zend Scripting
      Engine. Functions should not generate this type of error.
    </simpara>
   </sect2>
 
   <sect2 id="internal.e-user-error">
-   <title>E_USER_ERROR</title>
+   <title><constant>E_USER_ERROR</constant></title>
    <simpara>
-     This is like an E_ERROR, except it is generated in PHP code by using
+     This is like an <constant>E_ERROR</constant>, except it is generated in PHP code by using
      the PHP function <function>trigger_error</function>. Functions should 
      not generate this type of error.
    </simpara>
   </sect2>
 
   <sect2 id="internal.e-user-warning">
-   <title>E_USER_WARNING</title>
+   <title><constant>E_USER_WARNING</constant></title>
    <simpara>
-     This is like an E_WARNING, except it is generated  by using the PHP 
+     This is like an <constant>E_WARNING</constant>, except it is generated  by using the PHP 
      function <function>trigger_error</function>. Functions should not 
      generate this type of error.
    </simpara>
   </sect2>
 
   <sect2 id="internal.e-user-notice">
-   <title>E_USER_NOTICE</title>
+   <title><constant>E_USER_NOTICE</constant></title>
    <simpara>
-     This is like an E_NOTICE, except it is generated by using the PHP
+     This is like an <constant>E_NOTICE</constant>, except it is generated by using the PHP
      function <function>trigger_error</function>. Functions should not 
      generate this type of error.
    </simpara>
   </sect2>
   
   <sect2 id="internal.e-all">
-   <title>E_ALL</title>
+   <title><constant>E_ALL</constant></title>
    <simpara>
     All of the above.  Using this error_reporting level will show 
     all error types.