docref_root and docref_ext

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@92302 c90b9560-bf6c-de11-be94-00142212c4b1

chapters/config.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.71 $ -->
+<!-- $Revision: 1.72 $ -->
  <chapter id="configuration">
   <title>Configuration</title>
 
@@ -395,11 +395,57 @@ include_path = ".;c:\php\lib"
        </term>
        <listitem>
         <para>
-         Turn off HTML tags in error messages.
+         Turn off HTML tags in error messages. The new format for html errors produces
+         clickable messages that direct the user to a page describing the error or 
+         function in causing the error. These references are affected by 
+         <link linkend="ini.docref-root">docref_root</link> and
+         <link linkend="ini.docref-ext">docref_ext</link>.
         </para>
        </listitem>
       </varlistentry>
       
+      <varlistentry id="ini.docref-root">
+       <term>
+        <parameter>docref_root</parameter>
+        <type>string</type>
+       </term>
+       <listitem>
+        <para>
+         The new error format contains a reference to a page describing the error or 
+         function in causing the error. In case of manual pages you can download the 
+         manual in your language and set this ini directive to the url of your local
+         copy. If your local copy of the manual can be reached by '/manual/' you can
+         simply use <userinput>docref_root=/manual/</userinput>. Additional you have 
+         to set docref_ext to match the fileextensions of your copy 
+         <userinput>docref_ext=.html</userinput>. It is possible to use external 
+         references. For example you can use 
+         <userinput>docref_root=http://manual/en/</userinput>.
+        </para>
+        <note>
+         <para>
+          The value of docref_root must end with a slash '/'.
+         </para>
+        </note>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry id="ini.docref-ext">
+       <term>
+        <parameter>docref_ext</parameter>
+        <type>string</type>
+       </term>
+       <listitem>
+        <para>
+         See <link linkend="ini.docref-root">docref_root</link>.
+        </para>
+        <note>
+         <para>
+          The value of docref_ext must begin with a dot '.'.
+         </para>
+        </note>
+       </listitem>
+      </varlistentry>
+
       <varlistentry id="ini.open-basedir">
        <term>
         <parameter>open_basedir</parameter>