[DOCUMENTATION] English:

-  manual fixes

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

documentation/manual/en/module_specs/Zend_Controller-Response.xml

@@ -23,7 +23,7 @@ $front->throwExceptions(true);
 
         <para>
             To send the response output, including headers, use
-            <code>sendResponse()</code>.
+            <methodname>sendResponse()</methodname>.
         </para>
 
         <programlisting language="php"><![CDATA[
@@ -32,12 +32,12 @@ $response->sendResponse();
 
         <note>
             <para>
-                By default, the front controller calls <code>sendResponse()</code>
+                By default, the front controller calls <methodname>sendResponse()</methodname>
                 when it has finished dispatching the request; typically you will
                 never need to call it. However, if you wish to manipulate the
                 response or use it in testing, you can override this
                 behaviour by setting the <code>returnResponse</code> flag with
-                <classname>Zend_Controller_Front::returnResponse(true)</classname>:
+                <methodname>Zend_Controller_Front::returnResponse(true)</methodname>:
             </para>
 
             <programlisting language="php"><![CDATA[
@@ -81,8 +81,8 @@ $this->getResponse()
 
         <para>
             Should an exception occur in an application, check the response object's
-            <code>isException()</code> flag, and retrieve the exception using
-            <code>getException()</code>. Additionally, one may create custom
+            <methodname>isException()</methodname> flag, and retrieve the exception using
+            <methodname>getException()</methodname>. Additionally, one may create custom
             response objects that redirect to error pages, log exception messages,
             do pretty formatting of exception messages (for development
             environments), etc.
@@ -114,8 +114,8 @@ $response->sendResponse();
 
         <para>
             By default, exception messages are not displayed. This behaviour may be
-            overridden by calling <code>renderExceptions()</code>, or enabling the
-            front controller to throwExceptions(), as shown above:
+            overridden by calling <methodname>renderExceptions()</methodname>, or enabling the
+            front controller to <methodname>throwExceptions()</methodname>, as shown above:
         </para>
 
         <programlisting language="php"><![CDATA[
@@ -146,7 +146,7 @@ $front->dispatch();
         <itemizedlist>
             <listitem>
                 <para>
-                    <code>canSendHeaders()</code> is used to determine if
+                    <methodname>canSendHeaders()</methodname> is used to determine if
                     headers have already been sent. It takes an optional flag
                     indicating whether or not to throw an exception if headers
                     have already been sent. This can be overridden by setting
@@ -157,7 +157,7 @@ $front->dispatch();
 
             <listitem>
                 <para>
-                    <code>setHeader($name, $value, $replace = false)</code> is
+                    <methodname>setHeader($name, $value, $replace = false)</methodname> is
                     used to set an individual header. By default, it does not
                     replace existing headers of the same name in the object;
                     however, setting <varname>$replace</varname> to true will force it
@@ -166,7 +166,7 @@ $front->dispatch();
 
                 <para>
                     Before setting the header, it checks with
-                    <code>canSendHeaders()</code> to see if this operation is
+                    <methodname>canSendHeaders()</methodname> to see if this operation is
                     allowed at this point, and requests that an exception be
                     thrown.
                 </para>
@@ -174,13 +174,13 @@ $front->dispatch();
 
             <listitem>
                 <para>
-                    <code>setRedirect($url, $code = 302)</code> sets an HTTP
+                    <methodname>setRedirect($url, $code = 302)</methodname> sets an HTTP
                     Location header for a redirect. If an HTTP status code has
                     been provided, it will use that status code.
                 </para>
 
                 <para>
-                    Internally, it calls <code>setHeader()</code> with the
+                    Internally, it calls <methodname>setHeader()</methodname> with the
                     <varname>$replace</varname> flag on to ensure only one such header
                     is ever sent.
                 </para>
@@ -188,7 +188,7 @@ $front->dispatch();
 
             <listitem>
                 <para>
-                    <code>getHeaders()</code> returns an array of all headers.
+                    <methodname>getHeaders()</methodname> returns an array of all headers.
                     Each array element is an array with the keys 'name' and
                     'value'.
                 </para>
@@ -196,34 +196,34 @@ $front->dispatch();
 
             <listitem>
                 <para>
-                    <code>clearHeaders()</code> clears all registered headers.
+                    <methodname>clearHeaders()</methodname> clears all registered headers.
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <code>setRawHeader()</code> can be used to set headers that
+                    <methodname>setRawHeader()</methodname> can be used to set headers that
                     are not key/value pairs, such as an HTTP status header.
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <code>getRawHeaders()</code> returns any registered raw
+                    <methodname>getRawHeaders()</methodname> returns any registered raw
                     headers.
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <code>clearRawHeaders()</code> clears any registered raw
+                    <methodname>clearRawHeaders()</methodname> clears any registered raw
                     headers.
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <code>clearAllHeaders()</code> clears both regular key/value
+                    <methodname>clearAllHeaders()</methodname> clears both regular key/value
                     headers as well as raw headers.
                 </para>
             </listitem>
@@ -232,8 +232,8 @@ $front->dispatch();
         <para>
             In addition to the above methods, there are accessors for setting
             and retrieving the HTTP response code for the current request,
-            <code>setHttpResponseCode()</code> and
-            <code>getHttpResponseCode()</code>.
+            <methodname>setHttpResponseCode()</methodname> and
+            <methodname>getHttpResponseCode()</methodname>.
         </para>
     </sect2>
 
@@ -250,9 +250,9 @@ $front->dispatch();
         </para>
 
         <para>
-            As an example, you could use a <code>preDispatch()</code> hook to
+            As an example, you could use a <methodname>preDispatch()</methodname> hook to
             add a header to the response object, then have the action controller
-            add body content, and a <code>postDispatch()</code> hook add a
+            add body content, and a <methodname>postDispatch()</methodname> hook add a
             footer:
         </para>
 
@@ -290,7 +290,7 @@ class MyController extends Zend_Controller_Action
 ]]></programlisting>
 
         <para>
-            In the above example, a call to <code>/my/foo</code> will cause the
+            In the above example, a call to <filename>/my/foo</filename> will cause the
             final body content of the response object to have the following
             structure:
         </para>
@@ -315,13 +315,13 @@ array(
         <itemizedlist>
             <listitem>
                 <para>
-                    <code>setBody()</code> and <code>appendBody()</code> both
-                    allow you to pass a second value, <varname>$name</varname>,
+                    <methodname>setBody()</methodname> and <methodname>appendBody()</methodname>
+                    both allow you to pass a second value, <varname>$name</varname>,
                     indicating a named segment. In each case, if you provide
                     this, it will overwrite that specific named segment or
                     create it if it does not exist (appending to the array by
                     default). If no named segment is passed to
-                    <code>setBody()</code>, it resets the entire body content
+                    <methodname>setBody()</methodname>, it resets the entire body content
                     array. If no named segment is passed to appendBody(), the
                     content is appended to the value in the 'default' name
                     segment.
@@ -330,7 +330,7 @@ array(
 
             <listitem>
                 <para>
-                    <code>prepend($name, $content)</code> will create a segment
+                    <methodname>prepend($name, $content)</methodname> will create a segment
                     named <varname>$name</varname> and place it at the beginning of
                     the array. If the segment exists already, it will be removed
                     prior to the operation (i.e., overwritten and replaced).
@@ -339,7 +339,7 @@ array(
 
             <listitem>
                 <para>
-                    <code>append($name, $content)</code> will create a segment
+                    <methodname>append($name, $content)</methodname> will create a segment
                     named <varname>$name</varname> and place it at the end of
                     the array. If the segment exists already, it will be removed
                     prior to the operation (i.e., overwritten and replaced).
@@ -348,8 +348,8 @@ array(
 
             <listitem>
                 <para>
-                    <code>insert($name, $content, $parent = null, $before =
-                        false)</code> will create a segment named
+                    <methodname>insert($name, $content, $parent = null, $before =
+                        false)</methodname> will create a segment named
                     <varname>$name</varname>. If provided with a <varname>$parent</varname>
                     segment, the new segment will be placed either before or
                     after that segment (based on the value of
@@ -361,7 +361,7 @@ array(
 
             <listitem>
                 <para>
-                    <code>clearBody($name = null)</code> will remove a single
+                    <methodname>clearBody($name = null)</methodname> will remove a single
                     named segment if a <varname>$name</varname> is provided (and the
                     entire array otherwise).
                 </para>
@@ -369,8 +369,8 @@ array(
 
             <listitem>
                 <para>
-                    <code>getBody($spec = false)</code> can be used to retrieve a single
-                    array segment if <varname>$spec</varname> is the name of a named
+                    <methodname>getBody($spec = false)</methodname> can be used to retrieve a
+                    single array segment if <varname>$spec</varname> is the name of a named
                     segment. If <varname>$spec</varname> is false, it returns a string
                     formed by concatenating all named segments in order. If
                     <varname>$spec</varname> is true, it returns the body content
@@ -395,28 +395,28 @@ array(
         <itemizedlist>
             <listitem>
                 <para>
-                    <code>setException(Exception $e)</code> allows you to
+                    <methodname>setException(Exception $e)</methodname> allows you to
                     register an exception.
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <code>isException()</code> will tell you if an exception has
+                    <methodname>isException()</methodname> will tell you if an exception has
                     been registered.
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <code>getException()</code> returns the entire
+                    <methodname>getException()</methodname> returns the entire
                     exception stack.
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <code>hasExceptionOfType($type)</code> allows you to
+                    <methodname>hasExceptionOfType($type)</methodname> allows you to
                     determine if an exception of a particular class is in the
                     stack.
                 </para>
@@ -424,7 +424,7 @@ array(
 
             <listitem>
                 <para>
-                    <code>hasExceptionOfMessage($message)</code> allows you to
+                    <methodname>hasExceptionOfMessage($message)</methodname> allows you to
                     determine if an exception with a specific message is in the
                     stack.
                 </para>
@@ -432,7 +432,7 @@ array(
 
             <listitem>
                 <para>
-                    <code>hasExceptionOfCode($code)</code> allows you to
+                    <methodname>hasExceptionOfCode($code)</methodname> allows you to
                     determine if an exception with a specific code is in the
                     stack.
                 </para>
@@ -440,7 +440,7 @@ array(
 
             <listitem>
                 <para>
-                    <code>getExceptionByType($type)</code> allows you to
+                    <methodname>getExceptionByType($type)</methodname> allows you to
                     retrieve all exceptions of a specific class from the stack.
                     It will return false if none are found, and an array of
                     exceptions otherwise.
@@ -449,7 +449,7 @@ array(
 
             <listitem>
                 <para>
-                    <code>getExceptionByMessage($message)</code> allows you to
+                    <methodname>getExceptionByMessage($message)</methodname> allows you to
                     retrieve all exceptions with a specific message from the stack.
                     It will return false if none are found, and an array of
                     exceptions otherwise.
@@ -458,7 +458,7 @@ array(
 
             <listitem>
                 <para>
-                    <code>getExceptionByCode($code)</code> allows you to
+                    <methodname>getExceptionByCode($code)</methodname> allows you to
                     retrieve all exceptions with a specific code from the stack.
                     It will return false if none are found, and an array of
                     exceptions otherwise.
@@ -467,7 +467,7 @@ array(
 
             <listitem>
                 <para>
-                    <code>renderExceptions($flag)</code> allows you to set a
+                    <methodname>renderExceptions($flag)</methodname> allows you to set a
                     flag indicating whether or not exceptions should be emitted
                     when the response is sent.
                 </para>

documentation/manual/en/module_specs/Zend_Controller-Router-Route-Hostname.xml

@@ -13,7 +13,7 @@
         Let's use the example from the standard route and see how it would look
         like in a hostname based way. Instead of calling the user via a path,
         we'd want to have a user to be able to call
-        <code>http://martel.users.example.com</code> to see the information
+        <filename>http://martel.users.example.com</filename> to see the information
         about the user "martel":
     </para>
 
@@ -44,7 +44,7 @@ $router->addRoute('user', $hostnameRoute->chain($plainPathRoute);
         Hostname routes can, but never should be used as is. The reason behind
         that is, that a hostname route alone would match any path. So what you
         have to do is to chain a path route to the hostname route. This is done
-        like in the example by calling <code>$hostnameRoute->chain($pathRoute);</code>.
+        like in the example by calling <methodname>$hostnameRoute->chain($pathRoute)</methodname>.
         By doing this, <varname>$hostnameRoute</varname> isn't modified, but a new
         route (<classname>Zend_Controller_Router_Route_Chain</classname>) is returned,
         which can then be given to the router.

documentation/manual/en/module_specs/Zend_Controller-Router-Route-Regex.xml

@@ -31,7 +31,7 @@ $router->addRoute('archive', $route);
     <para>
         Every defined regex subpattern will be injected to the request
         object. With our above example, after successful matching
-        <code>http://domain.com/archive/2006</code>, the resulting value
+        <filename>http://domain.com/archive/2006</filename>, the resulting value
         array may look like:
     </para>
 
@@ -47,8 +47,8 @@ $values = array(
         <para>
             Leading and trailing slashes are trimmed from the URL in the Router
             prior to a match. As a result, matching the URL
-            <code>http://domain.com/foo/bar/</code>, would involve a regex of
-            <code>foo/bar</code>, and not <code>/foo/bar</code>.
+            <filename>http://domain.com/foo/bar/</filename>, would involve a regex of
+            <filename>foo/bar</filename>, and not <filename>/foo/bar</filename>.
         </para>
     </note>
 
@@ -63,7 +63,7 @@ $values = array(
 
     <note>
         <para>
-            This route class uses the <code>#</code> character for a delimiter.
+            This route class uses the '<emphasis>#</emphasis>' character for a delimiter.
             This means that you will need to escape hash characters ('#') but
             not forward slashes ('/') in your route definitions. Since the '#'
             character (named anchor) is rarely passed to the webserver, you will
@@ -186,7 +186,7 @@ $route = new Zend_Controller_Router_Route_Regex(
 
     <para>
         Which will result in mixed values available in the Request. As an
-        example, the URL <code>http://domain.com/archive/2006/page/10</code>
+        example, the URL <filename>http://domain.com/archive/2006/page/10</filename>
         will result in following values:
     </para>
 
@@ -220,9 +220,9 @@ $route = new Zend_Controller_Router_Route_Regex(
         standard route object, so where's the benefit in using the Regex route,
         you ask?  Primarily, it allows you to describe any type of URL without
         any restrictions. Imagine you have a blog and wish to create URLs like:
-        <code>http://domain.com/blog/archive/01-Using_the_Regex_Router.html</code>,
+        <filename>http://domain.com/blog/archive/01-Using_the_Regex_Router.html</filename>,
         and have it decompose the last path element,
-        <code>01-Using_the_Regex_Router.html</code>, into an article ID and
+        <filename>01-Using_the_Regex_Router.html</filename>, into an article ID and
         article title/description; this is not possible with the standard route.
         With the Regex route, you can do something like the following solution:
     </para>

documentation/manual/en/module_specs/Zend_Controller-Router-Route-Static.xml

@@ -19,8 +19,8 @@ $router->addRoute('login', $route);
 ]]></programlisting>
 
     <para>
-        Above route will match a URL of <code>http://domain.com/login</code>,
-        and dispatch to <code>AuthController::loginAction()</code>.
+        Above route will match a URL of <filename>http://domain.com/login</filename>,
+        and dispatch to <methodname>AuthController::loginAction()</methodname>.
     </para>
 
     <note id="zend.controller.router.routes.static.warning">

documentation/manual/en/module_specs/Zend_Controller-Router-Route.xml

@@ -14,7 +14,7 @@
     <para>
         Let's imagine our fictional application will need some informational
         page about the content authors. We want to be able to point our web
-        browsers to <code>http://domain.com/author/martel</code> to see the
+        browsers to <filename>http://domain.com/author/martel</filename> to see the
         information about this "martel" guy. And the route for such
         functionality could look like:
     </para>
@@ -53,7 +53,7 @@ $router->addRoute('user', $route);
 
     <para>
         This example route should be matched when you point your browser to
-        <code>http://domain.com/author/martel</code>, in which case all its
+        <filename>http://domain.com/author/martel</filename>, in which case all its
         variables will be injected to the <classname>Zend_Controller_Request</classname>
         object and will be accessible in your <code>ProfileController</code>.
         Variables returned by this example may be represented as an array of
@@ -70,7 +70,7 @@ $values = array(
 
     <para>
         Later on, <classname>Zend_Controller_Dispatcher_Standard</classname> should invoke
-        the <code>userinfoAction()</code> method of your
+        the <methodname>userinfoAction()</methodname> method of your
         <code>ProfileController</code> class (in the default module) based on
         these values. There you will be able to access all variables by means of
         the <classname>Zend_Controller_Action::_getParam()</classname> or
@@ -122,8 +122,8 @@ $router->addRoute('archive', $route);
 
         <para>
             The above route will match URLs like
-            <code>http://domain.com/archive/2005</code> and
-            <code>http://example.com/archive</code>. In the latter case the
+            <filename>http://domain.com/archive/2005</filename> and
+            <filename>http://example.com/archive</filename>. In the latter case the
             variable year will have an initial default value of 2006.
         </para>
 
@@ -151,7 +151,7 @@ $router->addRoute('archive', $route);
 
         <para>
             This route will then result in dispatching to the method
-            <code>showAction()</code> of the class
+            <methodname>showAction()</methodname> of the class
             <code>ArchiveController</code>.
         </para>
 
@@ -183,8 +183,8 @@ $router->addRoute('archive', $route);
         <para>
             With a route defined like above, the router will match it only when
             the year variable will contain numeric data, eg.
-            <code>http://domain.com/archive/2345</code>. A URL like
-            <code>http://example.com/archive/test</code> will not be matched and
+            <filename>http://domain.com/archive/2345</filename>. A URL like
+            <filename>http://example.com/archive/test</filename> will not be matched and
             control will be passed to the next route in the chain instead.
         </para>
     </sect4>

documentation/manual/en/module_specs/Zend_Controller-Router.xml

@@ -200,7 +200,7 @@ $router->addRoute('user',
 ]]></programlisting>
 
             <para>
-                Which would result in the href: <code>user/martel</code>.
+                Which would result in the href: <filename>user/martel</filename>.
             </para>
         </note>
 
@@ -216,10 +216,10 @@ $router->addRoute('user',
 
         <para>
             If you need to determine which route was matched, you can use the
-            <code>getCurrentRouteName()</code> method, which will return the
+            <methodname>getCurrentRouteName()</methodname> method, which will return the
             identifier used when registering the route with the router. If you
             want the actual route object, you can use
-            <code>getCurrentRoute()</code>.
+            <methodname>getCurrentRoute()</methodname>.
         </para>
 
         <note>
@@ -266,11 +266,11 @@ $router->addRoute('user',
         <para>
             <classname>Zend_Controller_Router_Rewrite</classname> comes preconfigured with a default
             route, which will match URIs in the shape of
-            <code>controller/action</code>. Additionally, a module name may be
+            <filename>controller/action</filename>. Additionally, a module name may be
             specified as the first path element, allowing URIs of the form
-            <code>module/controller/action</code>. Finally, it will also match
+            <filename>module/controller/action</filename>. Finally, it will also match
             any additional parameters appended to the URI by default -
-            <code>controller/action/var1/value1/var2/value2</code>.
+            <filename>controller/action/var1/value1/var2/value2</filename>.
         </para>
 
         <para>
@@ -333,7 +333,7 @@ $this->addRoute('default', $compat);
             If you do not want this particular default route in your routing
             schema, you may override it by creating your own 'default' route
             (i.e., storing it under the name of 'default') or removing it
-            altogether by using <code>removeDefaultRoutes()</code>:
+            altogether by using <methodname>removeDefaultRoutes()</methodname>:
         </para>
 
         <programlisting language="php"><![CDATA[
@@ -348,9 +348,9 @@ $router->removeDefaultRoutes();
 
         <para>
             The rewrite router can be used in subdirectories (e.g.,
-            <code>http://domain.com/~user/application-root/</code>) in which
+            <filename>http://domain.com/~user/application-root/</filename>) in which
             case the base URL of the application
-            (<code>/~user/application-root</code>) should be automatically
+            (<filename>/~user/application-root</filename>) should be automatically
             detected by <classname>Zend_Controller_Request_Http</classname> and used
             accordingly.
         </para>
@@ -359,7 +359,7 @@ $router->removeDefaultRoutes();
             Should the base URL be detected incorrectly you can override it with
             your own base path by using
             <classname>Zend_Controller_Request_Http</classname> and calling the
-            <code>setBaseUrl()</code> method (see <xref
+            <methodname>setBaseUrl()</methodname> method (see <xref
                 linkend="zend.controller.request.http.baseurl" />):
         </para>
 
@@ -401,7 +401,7 @@ $router->setGlobalParam('lang', 'en');
         <para>
             Sometimes it is more convenient to update a configuration file with
             new routes than to change the code. This is possible via the
-            <code>addConfig()</code> method. Basically, you create a
+            <methodname>addConfig()</methodname> method. Basically, you create a
             <classname>Zend_Config</classname>-compatible configuration, and in your code read it in
             and pass it to the RewriteRouter.
         </para>