فهرست منبع

DOCUMENTATION English:
- some corrections in Zend_Application

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@15289 44c647ce-9c0f-0410-b52a-842ac1e357ba

mikaelkael 16 سال پیش
والد
کامیت
b7c866019e
16فایلهای تغییر یافته به همراه121 افزوده شده و 111 حذف شده
  1. 1 1
      documentation/manual/en/module_specs/Zend_Application-AvailableResources-Frontcontroller.xml
  2. 1 1
      documentation/manual/en/module_specs/Zend_Application-AvailableResources-Modules.xml
  3. 3 3
      documentation/manual/en/module_specs/Zend_Application-CoreFunctionality-Application.xml
  4. 2 1
      documentation/manual/en/module_specs/Zend_Application-CoreFunctionality-Bootstrap_Bootstrap.xml
  5. 8 4
      documentation/manual/en/module_specs/Zend_Application-CoreFunctionality-Bootstrap_BootstrapAbstract.xml
  6. 9 3
      documentation/manual/en/module_specs/Zend_Application-CoreFunctionality-Bootstrap_ResourceBootstrapper.xml
  7. 3 1
      documentation/manual/en/module_specs/Zend_Application-CoreFunctionality-Resource_Resource.xml
  8. 3 1
      documentation/manual/en/module_specs/Zend_Application-CoreFunctionality-Resource_ResourceAbstract.xml
  9. 2 2
      documentation/manual/en/module_specs/Zend_Application-Examples.xml
  10. 12 17
      documentation/manual/en/module_specs/Zend_Application-QuickStart.xml
  11. 2 2
      documentation/manual/en/module_specs/Zend_Reflection-Reference.xml
  12. 5 5
      documentation/manual/en/module_specs/Zend_Search_Lucene-QueryLanguage.xml
  13. 4 4
      documentation/manual/en/module_specs/Zend_Search_Lucene-Searching.xml
  14. 41 41
      documentation/manual/en/module_specs/Zend_Tool_Framework-CliTool.xml
  15. 6 6
      documentation/manual/en/module_specs/Zend_Tool_Framework-SystemProviders.xml
  16. 19 19
      documentation/manual/en/module_specs/Zend_Tool_Framework-WritingProviders.xml

+ 1 - 1
documentation/manual/en/module_specs/Zend_Application-AvailableResources-Frontcontroller.xml

@@ -20,7 +20,7 @@
 
 
     <para>
     <para>
         Available configuration keys include the following, and are case
         Available configuration keys include the following, and are case
-        insenstitive:
+        insensitive:
     </para>
     </para>
 
 
     <itemizedlist>
     <itemizedlist>

+ 1 - 1
documentation/manual/en/module_specs/Zend_Application-AvailableResources-Modules.xml

@@ -6,7 +6,7 @@
     <para>
     <para>
         <classname>Zend_Application_Resource_Modules</classname> is used to initialize
         <classname>Zend_Application_Resource_Modules</classname> is used to initialize
         your application modules. If your module has a
         your application modules. If your module has a
-        <code>Bootstrap.php</code> file in its root, and it contains a class
+        <filename>Bootstrap.php</filename> file in its root, and it contains a class
         named <code>Module_Bootstrap</code> (where "Module" is the module name),
         named <code>Module_Bootstrap</code> (where "Module" is the module name),
         then it will use that class to bootstrap the module.
         then it will use that class to bootstrap the module.
     </para>
     </para>

+ 3 - 3
documentation/manual/en/module_specs/Zend_Application-CoreFunctionality-Application.xml

@@ -30,8 +30,8 @@
                 <row>
                 <row>
                     <entry><code>phpSettings</code></entry>
                     <entry><code>phpSettings</code></entry>
                     <entry><para>
                     <entry><para>
-                        Array of php.ini settings to use. Keys should be the php.ini
-                        keys.
+                        Array of <filename>php.ini</filename> settings to use. Keys should be the
+                        <filename>php.ini</filename> keys.
                     </para></entry>
                     </para></entry>
                 </row>
                 </row>
 
 
@@ -47,7 +47,7 @@
                     <entry><code>autoloaderNamespaces</code></entry>
                     <entry><code>autoloaderNamespaces</code></entry>
                     <entry><para>
                     <entry><para>
                         Array of additional namespaces to register with the
                         Array of additional namespaces to register with the
-                        <code>Zend_Loader_Autoloader</code> instance.
+                        <classname>Zend_Loader_Autoloader</classname> instance.
                     </para></entry>
                     </para></entry>
                 </row>
                 </row>
 
 

+ 2 - 1
documentation/manual/en/module_specs/Zend_Application-CoreFunctionality-Bootstrap_Bootstrap.xml

@@ -5,7 +5,8 @@
 
 
     <para>
     <para>
         <classname>Zend_Application_Bootstrap_Bootstrap</classname> is a concrete
         <classname>Zend_Application_Bootstrap_Bootstrap</classname> is a concrete
-        implementation of <link linkend="zend.application.core-functionality.bootstrap-bootstrapabstract">Zend_Application_Bootstrap_BootstrapAbstract</link>.
+        implementation of
+        <link linkend="zend.application.core-functionality.bootstrap-bootstrapabstract">Zend_Application_Bootstrap_BootstrapAbstract</link>.
         It's primary feature are that it registers the <link
         It's primary feature are that it registers the <link
             linkend="zend.application.available-resources.frontcontroller">Front
             linkend="zend.application.available-resources.frontcontroller">Front
             Controller resource</link>, and that the <code>run()</code> method
             Controller resource</link>, and that the <code>run()</code> method

+ 8 - 4
documentation/manual/en/module_specs/Zend_Application-CoreFunctionality-Bootstrap_BootstrapAbstract.xml

@@ -4,8 +4,8 @@
     <title>Zend_Application_Bootstrap_BootstrapAbstract</title>
     <title>Zend_Application_Bootstrap_BootstrapAbstract</title>
 
 
     <para>
     <para>
-        <classname>Zend_Application_Bootstrap_BootstrapAbstract</classname> is an abstract class which
-        provides the base functionallity of a common bootstrap. It implements
+        <classname>Zend_Application_Bootstrap_BootstrapAbstract</classname> is an abstract class
+        which provides the base functionality of a common bootstrap. It implements
         both <link linkend="zend.application.core-functionality.bootstrap-bootstrapper">
         both <link linkend="zend.application.core-functionality.bootstrap-bootstrapper">
             Zend_Application_Bootstrap_Bootstrapper</link> and <link
             Zend_Application_Bootstrap_Bootstrapper</link> and <link
             linkend="zend.application.core-functionality.bootstrap-resourcebootstrapper">
             linkend="zend.application.core-functionality.bootstrap-resourcebootstrapper">
@@ -111,7 +111,9 @@
                 <row>
                 <row>
                     <entry><code>setApplication(Zend_Application |
                     <entry><code>setApplication(Zend_Application |
                             Zend_Application_Bootstrap_Bootstrapper $application)</code></entry>
                             Zend_Application_Bootstrap_Bootstrapper $application)</code></entry>
-                    <entry><classname>Zend_Application_Bootstrap_BootstrapAbstract</classname></entry>
+                    <entry>
+                        <classname>Zend_Application_Bootstrap_BootstrapAbstract</classname>
+                    </entry>
                     <entry><itemizedlist>
                     <entry><itemizedlist>
                             <listitem><para>
                             <listitem><para>
                                 <code>$application</code>: <emphasis>required</emphasis>.
                                 <code>$application</code>: <emphasis>required</emphasis>.
@@ -168,7 +170,9 @@
 
 
                 <row>
                 <row>
                     <entry><code>setContainer($container)</code></entry>
                     <entry><code>setContainer($container)</code></entry>
-                    <entry><classname>Zend_Application_Bootstrap_BootstrapAbstract</classname></entry>
+                    <entry>
+                        <classname>Zend_Application_Bootstrap_BootstrapAbstract</classname>
+                    </entry>
                     <entry><itemizedlist>
                     <entry><itemizedlist>
                         <listitem><para>
                         <listitem><para>
                             <code>$container</code>, <emphasis>required</emphasis>.
                             <code>$container</code>, <emphasis>required</emphasis>.

+ 9 - 3
documentation/manual/en/module_specs/Zend_Application-CoreFunctionality-Bootstrap_ResourceBootstrapper.xml

@@ -32,7 +32,9 @@
                 <row>
                 <row>
                     <entry><code>registerPluginResource($resource, $options =
                     <entry><code>registerPluginResource($resource, $options =
                             null)</code></entry>
                             null)</code></entry>
-                    <entry><classname>Zend_Application_Bootstrap_ResourceBootstrapper</classname></entry>
+                    <entry>
+                        <classname>Zend_Application_Bootstrap_ResourceBootstrapper</classname>
+                    </entry>
                     <entry><itemizedlist>
                     <entry><itemizedlist>
                         <listitem><para>
                         <listitem><para>
                             <code>$resource</code>: <emphasis>required</emphasis>.
                             <code>$resource</code>: <emphasis>required</emphasis>.
@@ -55,7 +57,9 @@
 
 
                 <row>
                 <row>
                     <entry><code>unregisterPluginResource($resource)</code></entry>
                     <entry><code>unregisterPluginResource($resource)</code></entry>
-                    <entry><classname>Zend_Application_Bootstrap_ResourceBootstrapper</classname></entry>
+                    <entry>
+                        <classname>Zend_Application_Bootstrap_ResourceBootstrapper</classname>
+                    </entry>
                     <entry><itemizedlist>
                     <entry><itemizedlist>
                         <listitem><para>
                         <listitem><para>
                             <code>$resource</code>: <emphasis>required</emphasis>.
                             <code>$resource</code>: <emphasis>required</emphasis>.
@@ -108,7 +112,9 @@
                 <row>
                 <row>
                     <entry><code>setPluginLoader(Zend_Loader_PluginLoader_Interface
                     <entry><code>setPluginLoader(Zend_Loader_PluginLoader_Interface
                             $loader)</code></entry>
                             $loader)</code></entry>
-                    <entry><classname>Zend_Application_Bootstrap_ResourceBootstrapper</classname></entry>
+                    <entry>
+                        <classname>Zend_Application_Bootstrap_ResourceBootstrapper</classname>
+                    </entry>
                     <entry><itemizedlist>
                     <entry><itemizedlist>
                         <listitem><para>
                         <listitem><para>
                             <code>$loader</code>: <emphasis>required</emphasis>.
                             <code>$loader</code>: <emphasis>required</emphasis>.

+ 3 - 1
documentation/manual/en/module_specs/Zend_Application-CoreFunctionality-Resource_Resource.xml

@@ -39,7 +39,9 @@
                 </row>
                 </row>
 
 
                 <row>
                 <row>
-                    <entry><code>setBootstrap(Zend_Application_Bootstrap_Bootstrapper $bootstrap)</code></entry>
+                    <entry>
+                        <code>setBootstrap(Zend_Application_Bootstrap_Bootstrapper $bootstrap)</code>
+                    </entry>
                     <entry><classname>Zend_Application_Resource_Resource</classname></entry>
                     <entry><classname>Zend_Application_Resource_Resource</classname></entry>
                     <entry><itemizedlist>
                     <entry><itemizedlist>
                             <listitem><para>
                             <listitem><para>

+ 3 - 1
documentation/manual/en/module_specs/Zend_Application-CoreFunctionality-Resource_ResourceAbstract.xml

@@ -44,7 +44,9 @@
                 </row>
                 </row>
 
 
                 <row>
                 <row>
-                    <entry><code>setBootstrap(Zend_Application_Bootstrap_Bootstrapper $bootstrap)</code></entry>
+                    <entry>
+                        <code>setBootstrap(Zend_Application_Bootstrap_Bootstrapper $bootstrap)</code>
+                    </entry>
                     <entry><classname>Zend_Application_Resource_ResourceAbstract</classname></entry>
                     <entry><classname>Zend_Application_Resource_ResourceAbstract</classname></entry>
                     <entry><itemizedlist>
                     <entry><itemizedlist>
                             <listitem><para>
                             <listitem><para>

+ 2 - 2
documentation/manual/en/module_specs/Zend_Application-Examples.xml

@@ -33,7 +33,7 @@ resources.frontController.controllerDirectory = APPLICATION_PATH "/controllers"
         However, should custom initialization be necessary, you have two
         However, should custom initialization be necessary, you have two
         choices. First, you can write methods prefixed with <code>_init</code>
         choices. First, you can write methods prefixed with <code>_init</code>
         to specify discrete code to bootstrap. These methods will be called by
         to specify discrete code to bootstrap. These methods will be called by
-        bootstrap(), and can also be called as if they were public methods:
+        <code>bootstrap()</code>, and can also be called as if they were public methods:
         <code>bootstrap&lt;resource&gt;()</code>. They should accept an optional
         <code>bootstrap&lt;resource&gt;()</code>. They should accept an optional
         array of options.
         array of options.
     </para>
     </para>
@@ -90,7 +90,7 @@ class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
     <itemizedlist>
     <itemizedlist>
         <listitem>
         <listitem>
             <para>
             <para>
-                When instantiating the Zend_Application object
+                When instantiating the <classname>Zend_Application</classname> object
             </para>
             </para>
         </listitem>
         </listitem>
         <listitem>
         <listitem>

+ 12 - 17
documentation/manual/en/module_specs/Zend_Application-QuickStart.xml

@@ -76,7 +76,7 @@ newproject
 
 
         <para>
         <para>
             In the above diagram, your bootstrap is in
             In the above diagram, your bootstrap is in
-            <code>newproject/application/Bootstrap.php</code>, and looks like
+            <filename>newproject/application/Bootstrap.php</filename>, and looks like
             the following at first:
             the following at first:
         </para>
         </para>
 
 
@@ -119,12 +119,11 @@ phpSettings.display_errors = 1
 
 
         <para>
         <para>
             Another file of interest is the
             Another file of interest is the
-            <code>newproject/public/index.php</code> file, which invokes
+            <filename>newproject/public/index.php</filename> file, which invokes
             <classname>Zend_Application</classname> and dispatches it.
             <classname>Zend_Application</classname> and dispatches it.
         </para>
         </para>
 
 
         <programlisting role="php"><![CDATA[
         <programlisting role="php"><![CDATA[
-<?php
 // Define path to application directory
 // Define path to application directory
 defined('APPLICATION_PATH')
 defined('APPLICATION_PATH')
     || define('APPLICATION_PATH',
     || define('APPLICATION_PATH',
@@ -164,29 +163,28 @@ $application->bootstrap()
 
 
         <itemizedlist>
         <itemizedlist>
             <listitem><para>
             <listitem><para>
-                Create an <code>application/Bootstrap.php</code> file, with the
+                Create an <filename>application/Bootstrap.php</filename> file, with the
                 class <code>Bootstrap</code>.
                 class <code>Bootstrap</code>.
             </para></listitem>
             </para></listitem>
 
 
             <listitem><para>
             <listitem><para>
-                Create an <code>application/configs/application.ini</code>
+                Create an <filename>application/configs/application.ini</filename>
                 configuration file with the base configuration necessary for
                 configuration file with the base configuration necessary for
                 <classname>Zend_Application</classname>.
                 <classname>Zend_Application</classname>.
             </para></listitem>
             </para></listitem>
 
 
             <listitem><para>
             <listitem><para>
-                Modify your <code>public/index.php</code> to utilize
+                Modify your <filename>public/index.php</filename> to utilize
                 <classname>Zend_Application</classname>.
                 <classname>Zend_Application</classname>.
             </para></listitem>
             </para></listitem>
         </itemizedlist>
         </itemizedlist>
 
 
         <para>
         <para>
             First, create your <code>Bootstrap</code> class. Create a file,
             First, create your <code>Bootstrap</code> class. Create a file,
-            <code>application/Bootstrap.php</code>, with the following contents:
+            <filename>application/Bootstrap.php</filename>, with the following contents:
         </para>
         </para>
 
 
         <programlisting role="php"><![CDATA[
         <programlisting role="php"><![CDATA[
-<?php
 class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
 class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
 {
 {
 }
 }
@@ -196,7 +194,7 @@ class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
             Now, create your configuration. For this tutorial, we will use an INI
             Now, create your configuration. For this tutorial, we will use an INI
             style configuration; you may, of course, use an XML or PHP
             style configuration; you may, of course, use an XML or PHP
             configuration file as well. Create the file
             configuration file as well. Create the file
-            <code>application/configs/application.ini</code>, and provide the
+            <filename>application/configs/application.ini</filename>, and provide the
             following contents:
             following contents:
         </para>
         </para>
 
 
@@ -222,12 +220,11 @@ phpSettings.display_errors = 1
 
 
         <para>
         <para>
             Now, let's modify your gateway script,
             Now, let's modify your gateway script,
-            <code>public/index.php</code>. If the file does not exist, create
+            <filename>public/index.php</filename>. If the file does not exist, create
             it; otherwise, replace it with the following contents:
             it; otherwise, replace it with the following contents:
         </para>
         </para>
 
 
         <programlisting role="php"><![CDATA[
         <programlisting role="php"><![CDATA[
-<?php
 // Define path to application directory
 // Define path to application directory
 defined('APPLICATION_PATH')
 defined('APPLICATION_PATH')
     || define('APPLICATION_PATH',
     || define('APPLICATION_PATH',
@@ -262,9 +259,9 @@ $application->bootstrap()
             You may note that the application environment constant value looks
             You may note that the application environment constant value looks
             for an environment variable "APPLICATION_ENV". We recommend setting
             for an environment variable "APPLICATION_ENV". We recommend setting
             this in your web server environment. In Apache, you can set this
             this in your web server environment. In Apache, you can set this
-            either in your vhost definition, or in your <code>.htaccess</code>
+            either in your vhost definition, or in your <filename>.htaccess</filename>
             file. We recommend the following contents for your
             file. We recommend the following contents for your
-            <code>public/.htacces</code> file:
+            <filename>public/.htacces</filename> file:
         </para>
         </para>
 
 
         <programlisting role="conf"><![CDATA[
         <programlisting role="conf"><![CDATA[
@@ -276,7 +273,6 @@ RewriteCond %{REQUEST_FILENAME} -l [OR]
 RewriteCond %{REQUEST_FILENAME} -d
 RewriteCond %{REQUEST_FILENAME} -d
 RewriteRule ^.*$ - [NC,L]
 RewriteRule ^.*$ - [NC,L]
 RewriteRule ^.*$ index.php [NC,L]
 RewriteRule ^.*$ index.php [NC,L]
-
 ]]></programlisting>
 ]]></programlisting>
 
 
         <note>
         <note>
@@ -349,8 +345,8 @@ phpSettings.display_errors = 1
 
 
         <para>
         <para>
             If you haven't already, create the directory
             If you haven't already, create the directory
-            <code>application/layouts/scripts/</code>, and the file
-            <code>layout.phtml</code> within that directory. A good starting
+            <filename>application/layouts/scripts/</filename>, and the file
+            <filename>layout.phtml</filename> within that directory. A good starting
             layout is as follows (and ties in with the view resource covered
             layout is as follows (and ties in with the view resource covered
             next):
             next):
         </para>
         </para>
@@ -382,7 +378,6 @@ phpSettings.display_errors = 1
         </para>
         </para>
 
 
         <programlisting role="php"><![CDATA[
         <programlisting role="php"><![CDATA[
-<?php
 class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
 class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
 {
 {
     protected function _initView()
     protected function _initView()

+ 2 - 2
documentation/manual/en/module_specs/Zend_Reflection-Reference.xml

@@ -280,7 +280,7 @@
 
 
     <sect2 id="zend.reflection.reference.extension">
     <sect2 id="zend.reflection.reference.extension">
         <title>Zend_Reflection_Extension</title>
         <title>Zend_Reflection_Extension</title>
-        
+
         <para>
         <para>
             <code>Zend_Reflection_Extension</code> extends
             <code>Zend_Reflection_Extension</code> extends
             <code>ReflectionExtension</code>, and follows its API. It overrides
             <code>ReflectionExtension</code>, and follows its API. It overrides
@@ -312,7 +312,7 @@
             <code>Zend_Reflection_Function</code> adds a method for retrieving
             <code>Zend_Reflection_Function</code> adds a method for retrieving
             the function return type, as well as overrides several methods to
             the function return type, as well as overrides several methods to
             allow specifying the reflection class to use for returned reflection
             allow specifying the reflection class to use for returned reflection
-            objects. 
+            objects.
         </para>
         </para>
 
 
         <itemizedlist>
         <itemizedlist>

+ 5 - 5
documentation/manual/en/module_specs/Zend_Search_Lucene-QueryLanguage.xml

@@ -131,15 +131,15 @@ test*
 ]]></programlisting>
 ]]></programlisting>
             It searches for "write", "wrote", "written", "rewrite", "rewrote" and so on.
             It searches for "write", "wrote", "written", "rewrite", "rewrote" and so on.
         </para>
         </para>
-        
+
         <para>
         <para>
             Starting from ZF 1.7.7 wildcard patterns need some non-wildcard prefix. Default prefix length is 3 (like in Java Lucene).
             Starting from ZF 1.7.7 wildcard patterns need some non-wildcard prefix. Default prefix length is 3 (like in Java Lucene).
             So "*", "te?t", "*wr?t*" terms will cause an exception<footnote>
             So "*", "te?t", "*wr?t*" terms will cause an exception<footnote>
-            <para>Please note, that it's not a <code>Zend_Search_Lucene_Search_QueryParserException</code>, but a 
-            <code>Zend_Search_Lucene_Exception</code>. It's thrown during query rewrite (execution) operation.</para></footnote>.  
+            <para>Please note, that it's not a <code>Zend_Search_Lucene_Search_QueryParserException</code>, but a
+            <code>Zend_Search_Lucene_Exception</code>. It's thrown during query rewrite (execution) operation.</para></footnote>.
         </para>
         </para>
         <para>
         <para>
-            It can be altered using <code>Zend_Search_Lucene_Search_Query_Wildcard::getMinPrefixLength()</code> and 
+            It can be altered using <code>Zend_Search_Lucene_Search_Query_Wildcard::getMinPrefixLength()</code> and
             <code>Zend_Search_Lucene_Search_Query_Wildcard::setMinPrefixLength()</code> methods.
             <code>Zend_Search_Lucene_Search_Query_Wildcard::setMinPrefixLength()</code> methods.
         </para>
         </para>
     </sect2>
     </sect2>
@@ -215,7 +215,7 @@ roam~0.8
         <para>
         <para>
             So Zend_Search_Lucene sets a limit of matching terms per query (subquery). This limit can be retrieved and set using
             So Zend_Search_Lucene sets a limit of matching terms per query (subquery). This limit can be retrieved and set using
             <code>Zend_Search_Lucene::getTermsPerQueryLimit()</code>/<code>Zend_Search_Lucene::setTermsPerQueryLimit($limit)</code>
             <code>Zend_Search_Lucene::getTermsPerQueryLimit()</code>/<code>Zend_Search_Lucene::setTermsPerQueryLimit($limit)</code>
-            methods. 
+            methods.
         </para>
         </para>
         <para>
         <para>
             Default matched terms per query limit is 1024.
             Default matched terms per query limit is 1024.

+ 4 - 4
documentation/manual/en/module_specs/Zend_Search_Lucene-Searching.xml

@@ -406,7 +406,7 @@ $highlightedHTML = $query->highlightMatches($sourceHTML);
         <para>
         <para>
             Optional second parameter is a default HTML document encoding. It's used if encoding is not specified using
             Optional second parameter is a default HTML document encoding. It's used if encoding is not specified using
             Content-type HTTP-EQUIV meta tag.
             Content-type HTTP-EQUIV meta tag.
-        </para> 
+        </para>
         <para>
         <para>
             Optional third parameter is a highlighter object which has to implement
             Optional third parameter is a highlighter object which has to implement
             <code>Zend_Search_Lucene_Search_Highlighter_Interface</code> interface:
             <code>Zend_Search_Lucene_Search_Highlighter_Interface</code> interface:
@@ -451,9 +451,9 @@ interface Zend_Search_Lucene_Search_Highlighter_Interface
             your own highlighter or just extend the default and redefine color table.
             your own highlighter or just extend the default and redefine color table.
         </para>
         </para>
         <para>
         <para>
-            <code>Zend_Search_Lucene_Search_Query->htmlFragmentHighlightMatches()</code> has similar behavior. The only differenece 
-            is that it takes as an input and returns HTML fragment without &lt;>HTML>, &lt;HEAD>, &lt;BODY> tags. 
-            Nevertheless, fragment is automatically transformed to valid XHTML. 
+            <code>Zend_Search_Lucene_Search_Query->htmlFragmentHighlightMatches()</code> has similar behavior. The only differenece
+            is that it takes as an input and returns HTML fragment without &lt;>HTML>, &lt;HEAD>, &lt;BODY> tags.
+            Nevertheless, fragment is automatically transformed to valid XHTML.
         </para>
         </para>
     </sect2>
     </sect2>
 </sect1>
 </sect1>

+ 41 - 41
documentation/manual/en/module_specs/Zend_Tool_Framework-CliTool.xml

@@ -2,7 +2,7 @@
 <!-- Reviewed: no -->
 <!-- Reviewed: no -->
 <sect1 id="zend.tool.framework.clitool">
 <sect1 id="zend.tool.framework.clitool">
     <title>Using the CLI Tool</title>
     <title>Using the CLI Tool</title>
-    
+
     <para>
     <para>
         The CLI, or command line tool (internally known as the console tool), is
         The CLI, or command line tool (internally known as the console tool), is
         currently the primary interface for dispatching <code>Zend_Tool</code>
         currently the primary interface for dispatching <code>Zend_Tool</code>
@@ -12,10 +12,10 @@
         also has a common implementation in windows with the
         also has a common implementation in windows with the
         <code>cmd.exe</code>, console2 and also with the Cygwin project.
         <code>cmd.exe</code>, console2 and also with the Cygwin project.
     </para>
     </para>
-    
+
     <sect2 id="zend.tool.framework.clitool.setup-general">
     <sect2 id="zend.tool.framework.clitool.setup-general">
         <title>Setting up the CLI tool</title>
         <title>Setting up the CLI tool</title>
-    
+
         <para>
         <para>
             To issue tooling requests via the command line client, you first
             To issue tooling requests via the command line client, you first
             need to setup the client so that your system can handle the "zf"
             need to setup the client so that your system can handle the "zf"
@@ -24,7 +24,7 @@
             your Zend Framework distribution.  In trunk, it can be found here:
             your Zend Framework distribution.  In trunk, it can be found here:
             <ulink url="http://framework.zend.com/svn/framework/standard/trunk/bin/">http://framework.zend.com/svn/framework/standard/trunk/bin/</ulink>
             <ulink url="http://framework.zend.com/svn/framework/standard/trunk/bin/">http://framework.zend.com/svn/framework/standard/trunk/bin/</ulink>
         </para>
         </para>
-        
+
         <para>
         <para>
             As you can see, there are 3 files in the <code>bin/</code>
             As you can see, there are 3 files in the <code>bin/</code>
             directory: a <code>zf.php</code>, <code>zf.sh</code>, and
             directory: a <code>zf.php</code>, <code>zf.sh</code>, and
@@ -39,12 +39,12 @@
             what is provided on the command line to the proper library component
             what is provided on the command line to the proper library component
             for dispatching.
             for dispatching.
         </para>
         </para>
-        
+
         <para>
         <para>
             Ultimately, you want to ensure two things to make everything work
             Ultimately, you want to ensure two things to make everything work
             regardless of the operating system you are on:
             regardless of the operating system you are on:
         </para>
         </para>
-            
+
         <orderedlist>
         <orderedlist>
             <listitem>
             <listitem>
                 <para>
                 <para>
@@ -52,46 +52,46 @@
                     path.  This is the ability to call <code>zf</code> from
                     path.  This is the ability to call <code>zf</code> from
                     anywhere on your command line, regardless of what your
                     anywhere on your command line, regardless of what your
                     current working directory is.
                     current working directory is.
-	            </para>
-	        </listitem>
-	        <listitem>
-	            <para>
+                </para>
+            </listitem>
+            <listitem>
+                <para>
                     ZendFramework/library is in your <code>include_path</code>.
                     ZendFramework/library is in your <code>include_path</code>.
                 </para>
                 </para>
             </listitem>
             </listitem>
         </orderedlist>
         </orderedlist>
-        
+
         <para>
         <para>
             <emphasis>Note:</emphasis> while the above are the most ideal
             <emphasis>Note:</emphasis> while the above are the most ideal
             requirements, you can simply download Zend Framework and expect it
             requirements, you can simply download Zend Framework and expect it
             to work as <code>./path/to/zf.php</code> some command.
             to work as <code>./path/to/zf.php</code> some command.
         </para>
         </para>
-        
+
     </sect2>
     </sect2>
 
 
     <sect2 id="zend.tool.framework.clitool.setup-starnix">
     <sect2 id="zend.tool.framework.clitool.setup-starnix">
         <title>Setting up the CLI tool on Unix-like Systems</title>
         <title>Setting up the CLI tool on Unix-like Systems</title>
-        
+
         <para>
         <para>
             The most common setup in the *nix environment, is to copy the
             The most common setup in the *nix environment, is to copy the
             <code>zf.sh</code> and <code>zf.php</code> into the same directory
             <code>zf.sh</code> and <code>zf.php</code> into the same directory
             as your PHP binary.  This can generally be found in one of the
             as your PHP binary.  This can generally be found in one of the
             following places:
             following places:
         </para>
         </para>
-        
+
         <programlisting role="text"><![CDATA[
         <programlisting role="text"><![CDATA[
 /usr/bin
 /usr/bin
 /usr/local/bin
 /usr/local/bin
 /usr/local/ZendServer/bin/
 /usr/local/ZendServer/bin/
 /Applications/ZendServer/bin/
 /Applications/ZendServer/bin/
 ]]></programlisting>
 ]]></programlisting>
-        
+
         <para>
         <para>
             To find out the location of your PHP binary, you can execute 'which
             To find out the location of your PHP binary, you can execute 'which
             php' on the command line.  This will return the location of the php
             php' on the command line.  This will return the location of the php
             binary you will be using to run php scripts in this environment.
             binary you will be using to run php scripts in this environment.
         </para>
         </para>
-        
+
         <para>
         <para>
             The next order of business is to ensure that the Zend Framework
             The next order of business is to ensure that the Zend Framework
             library is setup correctly inside of the system PHP
             library is setup correctly inside of the system PHP
@@ -104,7 +104,7 @@
             similar), ensure that the contents of the library/ directory are put
             similar), ensure that the contents of the library/ directory are put
             inside your <code>include_path</code> specified directory.
             inside your <code>include_path</code> specified directory.
         </para>
         </para>
-        
+
         <para>
         <para>
             Once you have done those two things, you should be able to issue a
             Once you have done those two things, you should be able to issue a
             command and get back the proper response like this:
             command and get back the proper response like this:
@@ -119,13 +119,13 @@
             If you do not see this type of output, go back and check your setup
             If you do not see this type of output, go back and check your setup
             to ensure you have all of the necessary peices in the proper place.
             to ensure you have all of the necessary peices in the proper place.
         </para>
         </para>
-        
+
         <para>
         <para>
             There are a couple of alternative setups you might want to employ
             There are a couple of alternative setups you might want to employ
             depending on your servers configuration, your level of access, or
             depending on your servers configuration, your level of access, or
             for other reasons.
             for other reasons.
         </para>
         </para>
-        
+
         <para>
         <para>
             <emphasis>ALTERNATIVE SETUP</emphasis> involves keeping the Zend
             <emphasis>ALTERNATIVE SETUP</emphasis> involves keeping the Zend
             Framework download together as is, and creating a link from a PATH
             Framework download together as is, and creating a link from a PATH
@@ -135,50 +135,50 @@
             like <code>/home/username/lib/ZendFramework</code>, and creating a
             like <code>/home/username/lib/ZendFramework</code>, and creating a
             symbolic link to the <code>zf.sh</code>.
             symbolic link to the <code>zf.sh</code>.
         </para>
         </para>
-        
+
         <para>
         <para>
             Assuming you want to put the link inside <code>/usr/local/bin</code>
             Assuming you want to put the link inside <code>/usr/local/bin</code>
             (this could also work for placing the link inside
             (this could also work for placing the link inside
             <code>/home/username/bin/</code> for example) you would issue a
             <code>/home/username/bin/</code> for example) you would issue a
             command similar to this: </para>
             command similar to this: </para>
-            
+
         <programlisting role="sh"><![CDATA[
         <programlisting role="sh"><![CDATA[
 ln -s /usr/local/share/ZendFramework/bin/zf.sh /usr/local/bin/zf
 ln -s /usr/local/share/ZendFramework/bin/zf.sh /usr/local/bin/zf
 
 
 # OR (for example)
 # OR (for example)
 ln -s /home/username/lib/ZendFramework/bin/zf.sh /home/username/bin/zf
 ln -s /home/username/lib/ZendFramework/bin/zf.sh /home/username/bin/zf
 ]]></programlisting>
 ]]></programlisting>
-           
+
         <para>
         <para>
             This will create a link which you should be able to access globally
             This will create a link which you should be able to access globally
             on the command line.
             on the command line.
         </para>
         </para>
 
 
     </sect2>
     </sect2>
-    
+
     <sect2 id="zend.tool.framework.clitool.setup-windows">
     <sect2 id="zend.tool.framework.clitool.setup-windows">
         <title>Setting up the CLI tool on Windows</title>
         <title>Setting up the CLI tool on Windows</title>
-        
+
         <para>
         <para>
             The most common setup in the Windows Win32 environment, is to copy
             The most common setup in the Windows Win32 environment, is to copy
             the <code>zf.sh</code> and <code>zf.php</code> into the same
             the <code>zf.sh</code> and <code>zf.php</code> into the same
             directory as your PHP binary.  This can generally be found in one of
             directory as your PHP binary.  This can generally be found in one of
             the following places:
             the following places:
         </para>
         </para>
-        
+
         <programlisting role="text"><![CDATA[
         <programlisting role="text"><![CDATA[
 C:\PHP
 C:\PHP
 C:\Program Files\ZendServer\bin\
 C:\Program Files\ZendServer\bin\
 C:\WAMP\PHP\bin
 C:\WAMP\PHP\bin
 ]]></programlisting>
 ]]></programlisting>
-        
+
         <para>
         <para>
             You should be able to run <code>php.exe</code> on the command line.
             You should be able to run <code>php.exe</code> on the command line.
             If you are not able to, first check the documentation that came with
             If you are not able to, first check the documentation that came with
             your PHP distribution, or ensure that the path to php.exe is in your
             your PHP distribution, or ensure that the path to php.exe is in your
             windows PATH environment variable.
             windows PATH environment variable.
         </para>
         </para>
-        
+
         <para>
         <para>
             The next order of business is to ensure that the Zend Framework
             The next order of business is to ensure that the Zend Framework
             library is setup correctly inside of the system PHP
             library is setup correctly inside of the system PHP
@@ -193,28 +193,28 @@ C:\WAMP\PHP\bin
             that the contents of the library/ directory are put inside your
             that the contents of the library/ directory are put inside your
             <code>include_path</code> specified directory.
             <code>include_path</code> specified directory.
         </para>
         </para>
-        
+
         <para>
         <para>
             Once you have done those two things, you should be able to issue a
             Once you have done those two things, you should be able to issue a
             command and get back the proper response like this:
             command and get back the proper response like this:
         </para>
         </para>
-        
+
         <para>
         <para>
             <inlinegraphic scale="100" align="center" valign="middle"
             <inlinegraphic scale="100" align="center" valign="middle"
                 fileref="figures/zend.tool.framework.cliversionwin32.png" format="PNG" />
                 fileref="figures/zend.tool.framework.cliversionwin32.png" format="PNG" />
         </para>
         </para>
-        
-        <para>    
+
+        <para>
             If you do not see this type of output, go back and check your setup
             If you do not see this type of output, go back and check your setup
             to ensure you have all of the necessary pieces in the proper place.
             to ensure you have all of the necessary pieces in the proper place.
         </para>
         </para>
-        
+
         <para>
         <para>
             There are a couple of alternative setups you might want to employ
             There are a couple of alternative setups you might want to employ
             depending on your server's configuration, your level of access, or
             depending on your server's configuration, your level of access, or
             for other reasons.
             for other reasons.
         </para>
         </para>
-        
+
         <para>
         <para>
             <emphasis>ALTERNATIVE SETUP</emphasis> involves keeping the Zend
             <emphasis>ALTERNATIVE SETUP</emphasis> involves keeping the Zend
             Framework download together as is, and altering both your system
             Framework download together as is, and altering both your system
@@ -228,10 +228,10 @@ C:\WAMP\PHP\bin
         </para>
         </para>
 
 
     </sect2>
     </sect2>
-    
+
     <sect2 id="zend.tool.framework.clitool.setup-othernotes">
     <sect2 id="zend.tool.framework.clitool.setup-othernotes">
         <title>Other Setup Considerations</title>
         <title>Other Setup Considerations</title>
-        
+
         <para>
         <para>
             If for some reason you do not want the Zend Framework library inside
             If for some reason you do not want the Zend Framework library inside
             your <code>include_path</code>, there is another option.  There are
             your <code>include_path</code>, there is another option.  There are
@@ -239,14 +239,14 @@ C:\WAMP\PHP\bin
             utilize to determine the location of your Zend Framework
             utilize to determine the location of your Zend Framework
             installation.
             installation.
         </para>
         </para>
-        
+
         <para>
         <para>
             The first is <code>ZEND_TOOL_INCLUDE_PATH_PREPEND</code>, which will
             The first is <code>ZEND_TOOL_INCLUDE_PATH_PREPEND</code>, which will
             prepend the value of this environment variable to the system
             prepend the value of this environment variable to the system
             (<code>php.ini</code>) <code>include_path</code> before loading the
             (<code>php.ini</code>) <code>include_path</code> before loading the
             client.
             client.
         </para>
         </para>
-        
+
         <para>
         <para>
             Alternatively, you might want to use
             Alternatively, you might want to use
             <code>ZEND_TOOL_INCLUDE_PATH</code> to completely
             <code>ZEND_TOOL_INCLUDE_PATH</code> to completely
@@ -255,21 +255,21 @@ C:\WAMP\PHP\bin
             command line tool.
             command line tool.
         </para>
         </para>
     </sect2>
     </sect2>
-    
+
     <sect2 id="zend.tool.framework.clitool.continuing">
     <sect2 id="zend.tool.framework.clitool.continuing">
         <title>Where To Go Next?</title>
         <title>Where To Go Next?</title>
-        
+
         <para>
         <para>
             At this point, your should be setup to start initiating some more
             At this point, your should be setup to start initiating some more
             "interesting" commands.  To get going, you can issue the <code>zf
             "interesting" commands.  To get going, you can issue the <code>zf
                 --help</code> command to see what is available to you.
                 --help</code> command to see what is available to you.
         </para>
         </para>
-        
+
         <para>
         <para>
             <inlinegraphic scale="100" align="center" valign="middle"
             <inlinegraphic scale="100" align="center" valign="middle"
                 fileref="figures/zend.tool.framework.clihelp.png" format="PNG" />
                 fileref="figures/zend.tool.framework.clihelp.png" format="PNG" />
         </para>
         </para>
-        
+
         <para>
         <para>
             Continue on to the <code>Zend_Tool_Project</code> "Create Project"
             Continue on to the <code>Zend_Tool_Project</code> "Create Project"
             section to understand how to use the <code>zf</code> script for
             section to understand how to use the <code>zf</code> script for

+ 6 - 6
documentation/manual/en/module_specs/Zend_Tool_Framework-SystemProviders.xml

@@ -15,22 +15,22 @@
 
 
     <sect2 id="zend.tool.framework.system-providers.version">
     <sect2 id="zend.tool.framework.system-providers.version">
         <title>The Version Provider</title>
         <title>The Version Provider</title>
-        
+
         <para>
         <para>
             The Version provider is included so that you may determine which
             The Version provider is included so that you may determine which
             version of the framework that the <code>zf</code> or
             version of the framework that the <code>zf</code> or
             <code>Zend_Tool</code> is currently set to work with.
             <code>Zend_Tool</code> is currently set to work with.
         </para>
         </para>
-        
+
         <para>
         <para>
             Through the command line, simply run <code>zf show version</code>.
             Through the command line, simply run <code>zf show version</code>.
         </para>
         </para>
-        
+
     </sect2>
     </sect2>
-    
+
     <sect2 id="zend.tool.framework.system-providers.manifest">
     <sect2 id="zend.tool.framework.system-providers.manifest">
         <title>The Manifest Provider</title>
         <title>The Manifest Provider</title>
-        
+
         <para>
         <para>
             The Manifest provider is included so that you may determine what
             The Manifest provider is included so that you may determine what
             kind of "manifest" information is available during the
             kind of "manifest" information is available during the
@@ -41,7 +41,7 @@
             Data found in the manifest can be used by any provider or client on
             Data found in the manifest can be used by any provider or client on
             an as-needed basis.
             an as-needed basis.
         </para>
         </para>
-        
+
         <para>
         <para>
             Through the command line, simply run <code>zf show manifest</code>.
             Through the command line, simply run <code>zf show manifest</code>.
         </para>
         </para>

+ 19 - 19
documentation/manual/en/module_specs/Zend_Tool_Framework-WritingProviders.xml

@@ -2,7 +2,7 @@
 <!-- Reviewed: no -->
 <!-- Reviewed: no -->
 <sect1 id="zend.tool.framework.writing-providers">
 <sect1 id="zend.tool.framework.writing-providers">
     <title>Creating Providers to use with Zend_Tool_Framework</title>
     <title>Creating Providers to use with Zend_Tool_Framework</title>
-    
+
     <para>
     <para>
         In general, a provider, on its own, is nothing more than the shell for a
         In general, a provider, on its own, is nothing more than the shell for a
         developer to bundle up some capabilities they wish to dispatch with the
         developer to bundle up some capabilities they wish to dispatch with the
@@ -13,17 +13,17 @@
     <sect2 id="zend.tool.framework.writing-providers.basic">
     <sect2 id="zend.tool.framework.writing-providers.basic">
         <title>Basic Instructions for Creating Providers</title>
         <title>Basic Instructions for Creating Providers</title>
 
 
-	    <para>
-		    As an example, if a developer wants to add the capability of showing
-		    the version of a datafile that his 3rd party component is working
-		    from, there is only one class the developer would need to implement.
-		    Assuming the component is called <code>My_Component</code>, he would
-		    create a class named <code>My_Component_HelloProvider</code> in a
-		    file named <code>HelloProvider.php</code> somewhere on the
-		    <code>include_path</code>.  This class would implement
-		    <classname>Zend_Tool_Framework_Provider_Interface</classname>, and the body of
-		    this file would only have to look like the following:
-		</para>
+        <para>
+            As an example, if a developer wants to add the capability of showing
+            the version of a datafile that his 3rd party component is working
+            from, there is only one class the developer would need to implement.
+            Assuming the component is called <code>My_Component</code>, he would
+            create a class named <code>My_Component_HelloProvider</code> in a
+            file named <code>HelloProvider.php</code> somewhere on the
+            <code>include_path</code>.  This class would implement
+            <classname>Zend_Tool_Framework_Provider_Interface</classname>, and the body of
+            this file would only have to look like the following:
+        </para>
 
 
         <programlisting role="php"><![CDATA[
         <programlisting role="php"><![CDATA[
 class My_Component_HelloProvider
 class My_Component_HelloProvider
@@ -47,10 +47,10 @@ class My_Component_HelloProvider
 Hello from my provider!
 Hello from my provider!
 ]]></programlisting>
 ]]></programlisting>
     </sect2>
     </sect2>
-    
+
     <sect2 id="zend.tool.framework.writing-providers.advanced">
     <sect2 id="zend.tool.framework.writing-providers.advanced">
         <title>Advanced Development Information</title>
         <title>Advanced Development Information</title>
-    
+
         <para>
         <para>
             The above "Hello World" example is great for simple commands, but
             The above "Hello World" example is great for simple commands, but
             what about something more advanced?  As your scripting and tooling
             what about something more advanced?  As your scripting and tooling
@@ -58,7 +58,7 @@ Hello from my provider!
             variables.  Much like function signatures have parameters, your
             variables.  Much like function signatures have parameters, your
             tooling requests can also accept parameters.
             tooling requests can also accept parameters.
         </para>
         </para>
-        
+
         <para>
         <para>
             Just as each tooling request can be isolated to a method within a
             Just as each tooling request can be isolated to a method within a
             class, the parameters of a tooling request can also be isolated in a
             class, the parameters of a tooling request can also be isolated in a
@@ -68,7 +68,7 @@ Hello from my provider!
             example, if you wanted to accept a name in the above example, you
             example, if you wanted to accept a name in the above example, you
             would probably do this in OO code:
             would probably do this in OO code:
         </para>
         </para>
-    
+
         <programlisting role="php"><![CDATA[
         <programlisting role="php"><![CDATA[
 class My_Component_HelloProvider
 class My_Component_HelloProvider
     implements Zend_Tool_Framework_Provider_Interface
     implements Zend_Tool_Framework_Provider_Interface
@@ -79,7 +79,7 @@ class My_Component_HelloProvider
     }
     }
 }
 }
 ]]></programlisting>
 ]]></programlisting>
-    
+
         <para>
         <para>
             The above example can then be called via the command line <code>zf
             The above example can then be called via the command line <code>zf
                 say hello Joe</code>.  "Joe" will be supplied to the provider as
                 say hello Joe</code>.  "Joe" will be supplied to the provider as
@@ -97,9 +97,9 @@ class My_Component_HelloProvider
             information about what it <emphasis>would</emphasis> do without
             information about what it <emphasis>would</emphasis> do without
             actually doing it.  This might be an important notion when doing
             actually doing it.  This might be an important notion when doing
             heavy database or filesystem modifications that the user might not
             heavy database or filesystem modifications that the user might not
-            otherwise want to do. 
+            otherwise want to do.
         </para>
         </para>
-        
+
         <para>
         <para>
             Pretendability is easy to implement.  There are two parts to this
             Pretendability is easy to implement.  There are two parts to this
             feature: 1) marking the provider as having the ability to "pretend",
             feature: 1) marking the provider as having the ability to "pretend",