[DOCUMENTATION] English:

- manual fixes

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

documentation/manual/en/module_specs/Zend_Application-CoreFunctionality-Resource_Resource.xml

@@ -24,8 +24,8 @@
             </thead>
             <tbody>
                 <row>
-                    <entry><code>__construct($options = null)</code></entry>
-                    <entry><code>void</code></entry>
+                    <entry><methodname>__construct($options = null)</methodname></entry>
+                    <entry><type>Void</type></entry>
                     <entry><itemizedlist>
                         <listitem><para>
                             <varname>$options</varname>: <emphasis>optional</emphasis>.
@@ -40,8 +40,8 @@
 
                 <row>
                     <entry>
-                        <code>setBootstrap(Zend_Application_Bootstrap_Bootstrapper
-                        $bootstrap)</code>
+                        <methodname>setBootstrap(Zend_Application_Bootstrap_Bootstrapper
+                            $bootstrap)</methodname>
                     </entry>
                     <entry><classname>Zend_Application_Resource_Resource</classname></entry>
                     <entry><itemizedlist>
@@ -56,7 +56,7 @@
                 </row>
 
                 <row>
-                    <entry><code>getBootstrap()</code></entry>
+                    <entry><methodname>getBootstrap()</methodname></entry>
                     <entry><classname>Zend_Application_Bootstrap_Bootstrapper</classname></entry>
                     <entry>N/A</entry>
                     <entry><para>
@@ -65,7 +65,7 @@
                 </row>
 
                 <row>
-                    <entry><code>setOptions(array $options)</code></entry>
+                    <entry><methodname>setOptions(array $options)</methodname></entry>
                     <entry><classname>Zend_Application_Resource_Resource</classname></entry>
                     <entry><itemizedlist>
                         <listitem><para>
@@ -79,8 +79,8 @@
                 </row>
 
                 <row>
-                    <entry><code>getOptions()</code></entry>
-                    <entry><code>array</code></entry>
+                    <entry><methodname>getOptions()</methodname></entry>
+                    <entry><type>Array</type></entry>
                     <entry>N/A</entry>
                     <entry><para>
                         Retrieve registered options.
@@ -88,8 +88,8 @@
                 </row>
 
                 <row>
-                    <entry><code>init()</code></entry>
-                    <entry><code>mixed</code></entry>
+                    <entry><methodname>init()</methodname></entry>
+                    <entry><type>mixed</type></entry>
                     <entry>N/A</entry>
                     <entry><para>
                         Strategy pattern: run initialization of the resource.

documentation/manual/en/module_specs/Zend_Application-CoreFunctionality-Resource_ResourceAbstract.xml

@@ -12,7 +12,7 @@
     </para>
 
     <para>
-        Note: this abstract class does not implement the <code>init()</code>
+        Note: this abstract class does not implement the <methodname>init()</methodname>
         method; this is left for definition in concrete extensions of the
         class.
     </para>
@@ -30,8 +30,8 @@
             </thead>
             <tbody>
                 <row>
-                    <entry><code>__construct($options = null)</code></entry>
-                    <entry><code>void</code></entry>
+                    <entry><methodname>__construct($options = null)</methodname></entry>
+                    <entry><type>Void</type></entry>
                     <entry><itemizedlist>
                         <listitem><para>
                             <varname>$options</varname>: <emphasis>optional</emphasis>.
@@ -46,8 +46,8 @@
 
                 <row>
                     <entry>
-                        <code>setBootstrap(Zend_Application_Bootstrap_Bootstrapper
-                        $bootstrap)</code>
+                        <methodname>setBootstrap(Zend_Application_Bootstrap_Bootstrapper
+                            $bootstrap)</methodname>
                     </entry>
                     <entry><classname>Zend_Application_Resource_ResourceAbstract</classname></entry>
                     <entry><itemizedlist>
@@ -62,7 +62,7 @@
                 </row>
 
                 <row>
-                    <entry><code>getBootstrap()</code></entry>
+                    <entry><methodname>getBootstrap()</methodname></entry>
                     <entry><classname>Zend_Application_Bootstrap_Bootstrapper</classname></entry>
                     <entry>N/A</entry>
                     <entry><para>
@@ -71,7 +71,7 @@
                 </row>
 
                 <row>
-                    <entry><code>setOptions(array $options)</code></entry>
+                    <entry><methodname>setOptions(array $options)</methodname></entry>
                     <entry><classname>Zend_Application_Resource_ResourceAbstract</classname></entry>
                     <entry><itemizedlist>
                         <listitem><para>
@@ -85,8 +85,8 @@
                 </row>
 
                 <row>
-                    <entry><code>getOptions()</code></entry>
-                    <entry><code>array</code></entry>
+                    <entry><methodname>getOptions()</methodname></entry>
+                    <entry><type>Array</type></entry>
                     <entry>N/A</entry>
                     <entry><para>
                         Retrieve registered options.

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

@@ -31,10 +31,10 @@ resources.frontController.controllerDirectory = APPLICATION_PATH "/controllers"
 
     <para>
         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 <emphasis>_init</emphasis>
         to specify discrete code to bootstrap. These methods will be called by
-        <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
+        <methodname>bootstrap()</methodname>, and can also be called as if they were public methods:
+        <methodname>bootstrap&lt;resource&gt;()</methodname>. They should accept an optional
         array of options.
     </para>
 
@@ -42,7 +42,7 @@ resources.frontController.controllerDirectory = APPLICATION_PATH "/controllers"
         If your resource method returns a value, it will be stored in a
         container in the bootstrap. This can be useful when different resources
         need to interact (such as one resource injecting itself into another).
-        The method <code>getResource()</code> can then be used to retrieve those
+        The method <methodname>getResource()</methodname> can then be used to retrieve those
         values.
     </para>
 
@@ -76,7 +76,7 @@ class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
 ]]></programlisting>
 
     <para>
-        Note in this example the call to <code>bootstrap()</code>;
+        Note in this example the call to <methodname>bootstrap()</methodname>;
         this ensures that the front controller has been initialized prior to
         calling this method. That call may trigger either a resource or another
         method in the class.
@@ -109,7 +109,7 @@ class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
     <para>
         Resource plugins implement <classname>Zend_Application_Bootstrap_Resource</classname>,
         which defines simply that they allow injection of the caller and
-        options, and that they have an <code>init()</code> method. As an
+        options, and that they have an <methodname>init()</methodname> method. As an
         example, a custom "View" bootstrap resource might look like the
         following:
     </para>
@@ -220,7 +220,7 @@ echo $service->handle();
 ]]></programlisting>
 
     <para>
-        Instead of using the <code>bootstrap()</code> method to call the
+        Instead of using the <methodname>bootstrap()</methodname> method to call the
         internal methods or resources, you may also use overloading:
     </para>
 

documentation/manual/en/module_specs/Zend_Application-QuickStart.xml

@@ -7,7 +7,7 @@
         There are two paths to getting started with
         <classname>Zend_Application</classname>, and they depend on how you start your
         project. In each case, you always start with creating a
-        <code>Bootstrap</code> class, and a related configuration file.
+        <emphasis>Bootstrap</emphasis> class, and a related configuration file.
     </para>
 
     <para>
@@ -23,11 +23,11 @@
         <para>
             The quickest way to start using <classname>Zend_Application</classname> is to use
             <classname>Zend_Tool</classname> to generate your project. This will also create
-            your <code>Bootstrap</code> class and file.
+            your <emphasis>Bootstrap</emphasis> class and file.
         </para>
 
         <para>
-            To create a project, execute the <code>zf</code> command (on *nix systems):
+            To create a project, execute the <command>zf</command> command (on *nix systems):
         </para>
 
         <programlisting language="sh"><![CDATA[
@@ -35,7 +35,7 @@
 ]]></programlisting>
 
         <para>
-            Or the Windows <code>zf.bat</code> command:
+            Or the Windows <filename>zf.bat</filename> command:
         </para>
 
         <programlisting language="dos"><![CDATA[
@@ -88,7 +88,7 @@ class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
 
         <para>
             You'll also note that a configuration file,
-            <code>newproject/application/configs/application.ini</code>, is
+            <filename>newproject/application/configs/application.ini</filename>, is
             created. It has the following contents:
         </para>
 
@@ -164,7 +164,7 @@ $application->bootstrap()
         <itemizedlist>
             <listitem><para>
                 Create an <filename>application/Bootstrap.php</filename> file, with the
-                class <code>Bootstrap</code>.
+                class <emphasis>Bootstrap</emphasis>.
             </para></listitem>
 
             <listitem><para>
@@ -180,7 +180,7 @@ $application->bootstrap()
         </itemizedlist>
 
         <para>
-            First, create your <code>Bootstrap</code> class. Create a file,
+            First, create your <emphasis>Bootstrap</emphasis> class. Create a file,
             <filename>application/Bootstrap.php</filename>, with the following contents:
         </para>
 
@@ -374,7 +374,7 @@ phpSettings.display_errors = 1
             Now, we'll add a custom view resource. When initializing the view,
             we'll want to set the HTML DocType and a default value for the title
             to use in the HTML head. This can be accomplished by editing your
-            <code>Bootstrap</code> class to add a method:
+            <emphasis>Bootstrap</emphasis> class to add a method:
         </para>
 
         <programlisting language="php"><![CDATA[

documentation/manual/en/module_specs/Zend_Application-TheoryOfOperation.xml

@@ -179,15 +179,15 @@ interface Zend_Application_Bootstrap_Bootstrapper
                 The <classname>Zend_Application_Bootstrap_BootstrapAbstract</classname>
                 implementation provides a simple convention for defining class
                 resource methods. Any protected method beginning with a name
-                prefixed with <code>_init</code> will be considered a resource
+                prefixed with <emphasis>_init</emphasis> will be considered a resource
                 method.
             </para>
 
             <para>
                 To bootstrap a single resource method, use the
-                <code>bootstrap()</code> method, and pass it the name of the
+                <methodname>bootstrap()</methodname> method, and pass it the name of the
                 resource. The name will be the method name minus the
-                <code>_init</code> prefix.
+                <emphasis>_init</emphasis> prefix.
             </para>
 
             <para>
@@ -220,7 +220,7 @@ class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
 ]]></programlisting>
 
             <para>
-                To bootstrap just the <code>_initFoo()</code> method, do the
+                To bootstrap just the <methodname>_initFoo()</methodname> method, do the
                 following:
             </para>
 
@@ -229,8 +229,8 @@ $bootstrap->bootstrap('foo');
 ]]></programlisting>
 
             <para>
-                To bootstrap the <code>_initFoo()</code> and
-                <code>_initBar()</code> methods, do the following:
+                To bootstrap the <methodname>_initFoo()</methodname> and
+                <methodname>_initBar()</methodname> methods, do the following:
             </para>
 
             <programlisting language="php"><![CDATA[
@@ -238,7 +238,7 @@ $bootstrap->bootstrap(array('foo', 'bar));
 ]]></programlisting>
 
             <para>
-                To bootstrap all resource methods, call <code>bootstrap()</code>
+                To bootstrap all resource methods, call <methodname>bootstrap()</methodname>
                 with no arguments:
             </para>
 
@@ -334,8 +334,8 @@ $application = new Zend_Application(APPLICATION_ENV, array(
 
             <para>
                 As an example, let's assume you have custom resource plugins in
-                <code>APPLICATION_PATH/resources/</code> and that they share the
-                common class prefix of <code>My_Resource</code>. You would then
+                <filename>APPLICATION_PATH/resources/</filename> and that they share the
+                common class prefix of <classname>My_Resource</classname>. You would then
                 pass that information to the application object as follows:
             </para>
 
@@ -357,7 +357,7 @@ $application = new Zend_Application(APPLICATION_ENV, array(
             </para>
 
             <para>
-                Just like resource methods, you use the <code>bootstrap()</code>
+                Just like resource methods, you use the <methodname>bootstrap()</methodname>
                 method to execute resource plugins. Just like with resource
                 methods, you can specify either a single resource plugin,
                 multiple plugins (via an array), or all plugins. Additionally,
@@ -397,11 +397,11 @@ $bootstrap->bootstrap();
                 object. Resources are then registered as properties named after
                 the resource name. By default, an instance of
                 <classname>Zend_Registry</classname> is used, but you may also specify any
-                other object you wish. The methods <code>setContainer()</code>
-                and <code>getContainer()</code> may be used to manipulate the
-                container itself. <code>getResource($resource)</code> can be
+                other object you wish. The methods <methodname>setContainer()</methodname>
+                and <methodname>getContainer()</methodname> may be used to manipulate the
+                container itself. <methodname>getResource($resource)</methodname> can be
                 used to fetch a given resource from the container, and
-                <code>hasResource($resource)</code> to check if the resource has
+                <methodname>hasResource($resource)</methodname> to check if the resource has
                 actually been registered.
             </para>
 
@@ -444,7 +444,7 @@ if (isset($container->view)) {
                 means that you need access to the bootstrap in order to fetch
                 resources. <classname>Zend_Application_Bootstrap_Bootstrap</classname>
                 provides some convenience for this: during its
-                <code>run()</code> execution, it registers itself as the front
+                <methodname>run()</methodname> execution, it registers itself as the front
                 controller parameter "bootstrap", which allows you to fetch it
                 from the router, dispatcher, plugins, and action controllers.
             </para>
@@ -487,7 +487,7 @@ class FooController extends Zend_Controller_Action
 
             <para>
                 As noted previously, all resources -- whether methods or plugins
-                -- are bootstrapped by calling <code>bootstrap($resource)</code>,
+                -- are bootstrapped by calling <methodname>bootstrap($resource)</methodname>,
                 where <varname>$resource</varname> is the name of a resource, an array
                 of resources, or, left empty, indicates all resources should be
                 run.
@@ -495,7 +495,7 @@ class FooController extends Zend_Controller_Action
 
             <para>
                 If a resource depends on another resource, it should call
-                <code>bootstrap()</code> within its code to ensure that resource
+                <methodname>bootstrap()</methodname> within its code to ensure that resource
                 has been executed. Subsequent calls to it will then be ignored.
             </para>