[DOCUMENTATION] English:

- manual fixes

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

documentation/manual/en/module_specs/Zend_Acl-Advanced.xml

@@ -10,21 +10,22 @@
 
         <para>
             <classname>Zend_Acl</classname> was designed in such a way that it does not require any
-            particular backend technology such as a database or cache server for storage of the ACL
-            data. Its complete PHP implementation enables customized administration tools to be
-            built upon <classname>Zend_Acl</classname> with relative ease and flexibility. Many
-            situations require some form of interactive maintenance of the ACL, and
-            <classname>Zend_Acl</classname> provides methods for setting up, and querying against,
-            the access controls of an application.
+            particular backend technology such as a database or cache server for storage of the
+            <acronym>ACL</acronym> data. Its complete <acronym>PHP</acronym> implementation enables
+            customized administration tools to be built upon <classname>Zend_Acl</classname> with
+            relative ease and flexibility. Many situations require some form of interactive
+            maintenance of the <acronym>ACL</acronym>, and <classname>Zend_Acl</classname> provides
+            methods for setting up, and querying against, the access controls of an application.
         </para>
 
         <para>
-            Storage of ACL data is therefore left as a task for the developer, since use cases are
-            expected to vary widely for various situations. Because <classname>Zend_Acl</classname>
-            is serializable, ACL objects may be serialized with PHP's
-            <ulink url="http://php.net/serialize"><methodname>serialize()</methodname></ulink>
-            function, and the results may be stored anywhere the developer should desire, such as a
-            file, database, or caching mechanism.
+            Storage of <acronym>ACL</acronym> data is therefore left as a task for the developer,
+            since use cases are expected to vary widely for various situations. Because
+            <classname>Zend_Acl</classname> is serializable, <acronym>ACL</acronym> objects may be
+            serialized with <acronym>PHP</acronym>'s <ulink url="http://php.net/serialize">
+                <methodname>serialize()</methodname></ulink> function, and the results may be
+            stored anywhere the developer should desire, such as a file, database, or caching
+            mechanism.
         </para>
 
     </sect2>

documentation/manual/en/module_specs/Zend_Acl-Refining.xml

@@ -9,20 +9,20 @@
         <title>Precise Access Controls</title>
 
         <para>
-            The basic ACL as defined in the
+            The basic <acronym>ACL</acronym> as defined in the
             <link linkend="zend.acl.introduction">previous section</link> shows how various
-            privileges may be allowed upon the entire ACL (all resources). In practice, however,
-            access controls tend to have exceptions and varying degrees of complexity.
-            <classname>Zend_Acl</classname> allows to you accomplish these refinements in a
-            straightforward and flexible manner.
+            privileges may be allowed upon the entire <acronym>ACL</acronym> (all resources). In
+            practice, however, access controls tend to have exceptions and varying degrees of
+            complexity. <classname>Zend_Acl</classname> allows to you accomplish these refinements
+            in a straightforward and flexible manner.
         </para>
 
         <para>
-            For the example CMS, it has been determined that whilst the 'staff' group covers the
-            needs of the vast majority of users, there is a need for a new 'marketing' group that
-            requires access to the newsletter and latest news in the CMS. The group is fairly
-            self-sufficient and will have the ability to publish and archive both newsletters and
-            the latest news.
+            For the example <acronym>CMS</acronym>, it has been determined that whilst the 'staff'
+            group covers the needs of the vast majority of users, there is a need for a new
+            'marketing' group that requires access to the newsletter and latest news in the
+            <acronym>CMS</acronym>. The group is fairly self-sufficient and will have the ability
+            to publish and archive both newsletters and the latest news.
         </para>
 
         <para>
@@ -66,7 +66,7 @@ $acl->add(new Zend_Acl_Resource('announcement'), 'news');
 
         <para>
             Then it is simply a matter of defining these more specific rules on the target areas of
-            the ACL:
+            the <acronym>ACL</acronym>:
         </para>
 
         <programlisting language="php"><![CDATA[
@@ -86,7 +86,7 @@ $acl->deny(null, 'announcement', 'archive');
 ]]></programlisting>
 
         <para>
-            We can now query the ACL with respect to the latest changes:
+            We can now query the <acronym>ACL</acronym> with respect to the latest changes:
         </para>
 
         <programlisting language="php"><![CDATA[
@@ -130,11 +130,11 @@ echo $acl->isAllowed('administrator', 'announcement', 'archive') ?
         <title>Removing Access Controls</title>
 
         <para>
-            To remove one or more access rules from the ACL, simply use the available
-            <methodname>removeAllow()</methodname> or <methodname>removeDeny()</methodname> methods.
-            As with <methodname>allow()</methodname> and <methodname>deny()</methodname>, you may
-            provide a <constant>NULL</constant> value to indicate application to all roles,
-            resources, and/or privileges:
+            To remove one or more access rules from the <acronym>ACL</acronym>, simply use the
+            available <methodname>removeAllow()</methodname> or
+            <methodname>removeDeny()</methodname> methods. As with <methodname>allow()</methodname>
+            and <methodname>deny()</methodname>, you may provide a <constant>NULL</constant> value
+            to indicate application to all roles, resources, and/or privileges:
         </para>
 
         <programlisting language="php"><![CDATA[

documentation/manual/en/module_specs/Zend_Acl.xml

@@ -5,8 +5,9 @@
 
     <para>
         <classname>Zend_Acl</classname> provides a lightweight and flexible access control list
-        (ACL) implementation for privileges management. In general, an application may utilize such
-        ACL's to control access to certain protected objects by other requesting objects.
+        (<acronym>ACL</acronym>) implementation for privileges management. In general, an
+        application may utilize such <acronym>ACL</acronym>'s to control access to certain
+        protected objects by other requesting objects.
     </para>
 
     <para>
@@ -36,8 +37,8 @@
     </para>
 
     <para>
-        Through the specification and use of an ACL, an application may control how roles are
-        granted access to resources.
+        Through the specification and use of an <acronym>ACL</acronym>, an application may control
+        how roles are granted access to resources.
     </para>
 
     <sect2 id="zend.acl.introduction.resources">
@@ -157,10 +158,12 @@ echo $acl->isAllowed('someUser', 'someResource') ? 'allowed' : 'denied';
         <title>Creating the Access Control List</title>
 
         <para>
-            An Access Control List (ACL) can represent any set of physical or virtual objects that
-            you wish. For the purposes of demonstration, however, we will create a basic Content
-            Management System (CMS) ACL that maintains several tiers of groups over a wide variety
-            of areas. To create a new ACL object, we instantiate the ACL with no parameters:
+            An Access Control List (<acronym>ACL</acronym>) can represent any set of physical or
+            virtual objects that you wish. For the purposes of demonstration, however, we will
+            create a basic Content Management System (<acronym>CMS</acronym>)
+            <acronym>ACL</acronym> that maintains several tiers of groups over a wide variety of
+            areas. To create a new <acronym>ACL</acronym> object, we instantiate the
+            <acronym>ACL</acronym> with no parameters:
         </para>
 
         <programlisting language="php"><![CDATA[
@@ -179,16 +182,17 @@ $acl = new Zend_Acl();
         <title>Registering Roles</title>
 
         <para>
-            CMS's will nearly always require a hierarchy of permissions to determine the authoring
-            capabilities of its users. There may be a 'Guest' group to allow limited access for
-            demonstrations, a 'Staff' group for the majority of CMS users who perform most of the
-            day-to-day operations, an 'Editor' group for those responsible for publishing,
-            reviewing, archiving and deleting content, and finally an 'Administrator' group whose
-            tasks may include all of those of the other groups as well as maintenance of sensitive
-            information, user management, back-end configuration data, backup and export. This set
-            of permissions can be represented in a role registry, allowing each group to inherit
-            privileges from 'parent' groups, as well as providing distinct privileges for their
-            unique group only. The permissions may be expressed as follows:
+            <acronym>CMS</acronym>'s will nearly always require a hierarchy of permissions to
+            determine the authoring capabilities of its users. There may be a 'Guest' group to
+            allow limited access for demonstrations, a 'Staff' group for the majority of
+            <acronym>CMS</acronym> users who perform most of the day-to-day operations, an 'Editor'
+            group for those responsible for publishing, reviewing, archiving and deleting content,
+            and finally an 'Administrator' group whose tasks may include all of those of the other
+            groups as well as maintenance of sensitive information, user management, back-end
+            configuration data, backup and export. This set of permissions can be represented in a
+            role registry, allowing each group to inherit privileges from 'parent' groups, as well
+            as providing distinct privileges for their unique group only. The permissions may be
+            expressed as follows:
         </para>
 
         <table id="zend.acl.introduction.role_registry.table.example_cms_access_controls">
@@ -261,13 +265,13 @@ $acl->addRole(new Zend_Acl_Role('administrator'));
         <title>Defining Access Controls</title>
 
         <para>
-            Now that the ACL contains the relevant roles, rules can be established that define how
-            resources may be accessed by roles. You may have noticed that we have not defined any
-            particular resources for this example, which is simplified to illustrate that the rules
-            apply to all resources. <classname>Zend_Acl</classname> provides an implementation
-            whereby rules need only be assigned from general to specific, minimizing the number of
-            rules needed, because resources and roles inherit rules that are defined upon their
-            ancestors.
+            Now that the <acronym>ACL</acronym> contains the relevant roles, rules can be
+            established that define how resources may be accessed by roles. You may have noticed
+            that we have not defined any particular resources for this example, which is simplified
+            to illustrate that the rules apply to all resources. <classname>Zend_Acl</classname>
+            provides an implementation whereby rules need only be assigned from general to
+            specific, minimizing the number of rules needed, because resources and roles inherit
+            rules that are defined upon their ancestors.
         </para>
 
         <note>
@@ -322,9 +326,10 @@ $acl->allow('administrator');
         <title>Querying an ACL</title>
 
         <para>
-            We now have a flexible ACL that can be used to determine whether requesters have
-            permission to perform functions throughout the web application. Performing queries is
-            quite simple using the <methodname>isAllowed()</methodname> method:
+            We now have a flexible <acronym>ACL</acronym> that can be used to determine whether
+            requesters have permission to perform functions throughout the web application.
+            Performing queries is quite simple using the <methodname>isAllowed()</methodname>
+            method:
         </para>
 
         <programlisting language="php"><![CDATA[

documentation/manual/en/module_specs/Zend_Amf-Server.xml

@@ -59,7 +59,7 @@ echo $response;
             The <classname>Zend_Amf_Server</classname> also allows services to be dynamically
             loaded based on a supplied directory path. You may add as many directories as you wish
             to the server. The order that you add the directories to the server will be the
-            order that the <emphasis>LIFO</emphasis> search will be performed on the directories to
+            order that the <acronym>LIFO</acronym> search will be performed on the directories to
             match the class. Adding directories is completed with the
             <methodname>addDirectory()</methodname> method.
         </para>
@@ -71,7 +71,7 @@ $server->addDirectory(dirname(__FILE__) .'/../package/');
 
         <para>
             When calling remote services your source name can have underscore ("_") and dot (".")
-            directory delimiters. When an underscore is used <emphasis>PEAR</emphasis> and Zend
+            directory delimiters. When an underscore is used <acronym>PEAR</acronym> and Zend
             Framework class naming conventions will be respected. This means that if you call the
             service <classname>com_Foo_Bar</classname> the server will look for the file
             <filename>Bar.php</filename> in the each of the included paths at
@@ -227,8 +227,8 @@ class World
         </para>
 
         <para>
-            Within our Flex <emphasis>MXML</emphasis> files, we need to bind a RemoteObject to the
-            service. In <emphasis>MXML</emphasis>, this might be done as follows:
+            Within our Flex <acronym>MXML</acronym> files, we need to bind a RemoteObject to the
+            service. In <acronym>MXML</acronym>, this might be done as follows:
         </para>
 
         <programlisting language="xml"><![CDATA[
@@ -351,7 +351,7 @@ echo $response;
         <title>Typed Objects</title>
 
         <para>
-            Similar to <emphasis>SOAP</emphasis>, AMF allows passing objects between the client and
+            Similar to <acronym>SOAP</acronym>, AMF allows passing objects between the client and
             server. This allows a great amount of flexibility and coherence
             between the two environments.
         </para>

documentation/manual/en/module_specs/Zend_Cache-Theory.xml

@@ -4,18 +4,18 @@
     <title>The Theory of Caching</title>
     <para>
         There are three key concepts in <classname>Zend_Cache</classname>. One is the unique identifier (a string) that is used
-        to identify cache records. The second one is the <code>'lifetime'</code> directive as seen in the
+        to identify cache records. The second one is the <emphasis>'lifetime'</emphasis> directive as seen in the
         examples; it defines for how long the cached resource is considered 'fresh'. The third key concept
         is conditional execution so that parts of your code can be skipped entirely, boosting performance.
         The main frontend function (eg. <classname>Zend_Cache_Core::get()</classname>) is always designed to return
         false for a cache miss if that makes sense for the nature of a frontend. That enables end-users to
-        wrap parts of the code they would like to cache (and skip) in <code>if(){ ... }</code> statements where
+        wrap parts of the code they would like to cache (and skip) in <emphasis>if(){ ... }</emphasis> statements where
         the condition is a <classname>Zend_Cache</classname> method itself. On the end if these blocks you must save what you've
         generated, however (eg. <classname>Zend_Cache_Core::save()</classname>).
     </para>
     <note><para>
         The conditional execution design of your generating code is not necessary in some frontends
-        (<code>Function</code>, for an example) when the whole logic is implemented inside the frontend.
+        (<emphasis>Function</emphasis>, for an example) when the whole logic is implemented inside the frontend.
     </para></note>
     <note><para>
         'Cache hit' is a term for a condition when a cache record is found, is valid and is 'fresh' (in other
@@ -63,7 +63,7 @@ $cache = Zend_Cache::factory($frontendName,
     <sect2 id="zend.cache.tags">
         <title>Tagging Records</title>
         <para>
-            Tags are a way to categorize cache records. When you save a cache with the <code>save()</code>
+            Tags are a way to categorize cache records. When you save a cache with the <methodname>save()</methodname>
             method, you can set an array of tags to apply for this record. Then you will be
             able to clean all cache records tagged with a given tag (or tags):
         </para>
@@ -71,21 +71,21 @@ $cache = Zend_Cache::factory($frontendName,
 $cache->save($huge_data, 'myUniqueID', array('tagA', 'tagB', 'tagC'));
 ]]></programlisting>
         <note><para>
-            note than the <code>save()</code> method accepts an optional fourth argument : <varname>$specificLifetime</varname>
+            note than the <methodname>save()</methodname> method accepts an optional fourth argument : <varname>$specificLifetime</varname>
             (if != false, it sets a specific lifetime for this particular cache record)
         </para></note>
     </sect2>
     <sect2 id="zend.cache.clean">
         <title>Cleaning the Cache</title>
         <para>
-            To remove/invalidate in particular cache id, you can use the <code>remove()</code>
+            To remove/invalidate in particular cache id, you can use the <methodname>remove()</methodname>
             method :
         </para>
         <programlisting language="php"><![CDATA[
 $cache->remove('idToRemove');
 ]]></programlisting>
         <para>
-            To remove/invalidate several cache ids in one operation, you can use the <code>clean()</code>
+            To remove/invalidate several cache ids in one operation, you can use the <methodname>clean()</methodname>
             method. For example to remove all cache records :
         </para>
         <programlisting language="php"><![CDATA[
@@ -123,9 +123,9 @@ $cache->clean(
 );
 ]]></programlisting>
         <para>
-            Available cleaning modes are: <code>CLEANING_MODE_ALL</code>, <code>CLEANING_MODE_OLD</code>,
-            <code>CLEANING_MODE_MATCHING_TAG</code>, <code>CLEANING_MODE_NOT_MATCHING_TAG</code> and
-            <code>CLEANING_MODE_MATCHING_ANY_TAG</code>.
+            Available cleaning modes are: <constant>CLEANING_MODE_ALL</constant>, <constant>CLEANING_MODE_OLD</constant>,
+            <constant>CLEANING_MODE_MATCHING_TAG</constant>, <constant>CLEANING_MODE_NOT_MATCHING_TAG</constant> and
+            <constant>CLEANING_MODE_MATCHING_ANY_TAG</constant>.
             The latter are, as their names suggest, combined with an array of tags in cleaning operations.
         </para>
     </sect2>

documentation/manual/en/module_specs/Zend_Captcha-Adapters.xml

@@ -33,41 +33,41 @@
 
         <itemizedlist>
             <listitem><para>
-                <code>setWordLen($length)</code> and <code>getWordLen()</code>
+                <methodname>setWordLen($length)</methodname> and <methodname>getWordLen()</methodname>
                 allow you to specify the length of the generated "word" in
                 characters, and to retrieve the current value.
             </para></listitem>
 
             <listitem><para>
-                <code>setTimeout($ttl)</code> and <code>getTimeout()</code>
+                <methodname>setTimeout($ttl)</methodname> and <methodname>getTimeout()</methodname>
                 allow you to specify the time-to-live of the session token, and
                 to retrieve the current value. <varname>$ttl</varname> should be
                 specified in seconds.
             </para></listitem>
 
             <listitem><para>
-                <code>setSessionClass($class)</code> and
-                <code>getSessionClass()</code> allow you to specify an
+                <methodname>setSessionClass($class)</methodname> and
+                <methodname>getSessionClass()</methodname> allow you to specify an
                 alternate <classname>Zend_Session_Namespace</classname> implementation to
                 use to persist the CAPTCHA token and to retrieve the
                 current value.
             </para></listitem>
 
             <listitem><para>
-                <code>getId()</code> allows you to retrieve the current token
+                <methodname>getId()</methodname> allows you to retrieve the current token
                 identifier.
             </para></listitem>
 
             <listitem><para>
-                <code>getWord()</code> allows you to retrieve the generated
+                <methodname>getWord()</methodname> allows you to retrieve the generated
                 word to use with the CAPTCHA. It will generate the word for you if
                 none has been generated yet.
             </para></listitem>
 
             <listitem><para>
-                <code>setSession(Zend_Session_Namespace $session)</code> allows
+                <methodname>setSession(Zend_Session_Namespace $session)</methodname> allows
                 you to specify a session object to use for persisting the
-                CAPTCHA token. <code>getSession()</code> allows you to retrieve
+                CAPTCHA token. <methodname>getSession()</methodname> allows you to retrieve
                 the current session object.
             </para></listitem>
         </itemizedlist>
@@ -75,10 +75,10 @@
         <para>
             All word CAPTCHAs allow you to pass an array of options to the
             constructor, or, alternately, pass them to
-            <code>setOptions()</code>. You can also pass a <classname>Zend_Config</classname>
-            object to <code>setConfig()</code>. By default, the
-            <code>wordLen</code>, <code>timeout</code>, and
-            <code>sessionClass</code> keys may all be used. Each concrete
+            <methodname>setOptions()</methodname>. You can also pass a <classname>Zend_Config</classname>
+            object to <methodname>setConfig()</methodname>. By default, the
+            <emphasis>wordLen</emphasis>, <emphasis>timeout</emphasis>, and
+            <emphasis>sessionClass</emphasis> keys may all be used. Each concrete
             implementation may define additional keys or utilize the options in
             other ways.
         </para>
@@ -138,8 +138,8 @@
 
         <itemizedlist>
             <listitem><para>
-                <code>setExpiration($expiration)</code> and
-                <code>getExpiration()</code> allow you to specify a maximum
+                <methodname>setExpiration($expiration)</methodname> and
+                <methodname>getExpiration()</methodname> allow you to specify a maximum
                 lifetime the CAPTCHA image may reside on the filesystem. This is
                 typically a longer than the session lifetime. Garbage
                 collection is run periodically each time the CAPTCHA object is
@@ -148,14 +148,14 @@
             </para></listitem>
 
             <listitem><para>
-                <code>setGcFreq($gcFreq)</code> and <code>getGcFreg()</code>
+                <methodname>setGcFreq($gcFreq)</methodname> and <methodname>getGcFreg()</methodname>
                 allow you to specify how frequently garbage collection should
-                run. Garbage collection will run every <code>1/$gcFreq</code>
+                run. Garbage collection will run every <emphasis>1/$gcFreq</emphasis>
                 calls. The default is 100.
             </para></listitem>
 
             <listitem><para>
-                <code>setFont($font)</code> and <code>getFont()</code> allow
+                <methodname>setFont($font)</methodname> and <methodname>getFont()</methodname> allow
                 you to specify the font you will use. <varname>$font</varname>
                 should be a fully qualified path to the font file.
                 This value is required; the CAPTCHA will throw an
@@ -163,37 +163,37 @@
             </para></listitem>
 
             <listitem><para>
-                <code>setFontSize($fsize)</code> and <code>getFontSize()</code>
+                <methodname>setFontSize($fsize)</methodname> and <methodname>getFontSize()</methodname>
                 allow you to specify the font size in pixels for
                 generating the CAPTCHA. The default is 24px.
             </para></listitem>
 
             <listitem><para>
-                <code>setHeight($height)</code> and <code>getHeight()</code>
+                <methodname>setHeight($height)</methodname> and <methodname>getHeight()</methodname>
                 allow you to specify the height in pixels of the generated
                 CAPTCHA image. The default is 50px.
             </para></listitem>
 
             <listitem><para>
-                <code>setWidth($width)</code> and <code>getWidth()</code>
+                <methodname>setWidth($width)</methodname> and <methodname>getWidth()</methodname>
                 allow you to specify the width in pixels of the generated
                 CAPTCHA image. The default is 200px.
             </para></listitem>
 
             <listitem><para>
-                <code>setImgDir($imgDir)</code> and <code>getImgDir()</code>
+                <methodname>setImgDir($imgDir)</methodname> and <methodname>getImgDir()</methodname>
                 allow you to specify the directory for storing CAPTCHA images.
                 The default is "./images/captcha/", relative to the bootstrap script.
             </para></listitem>
 
             <listitem><para>
-                <code>setImgUrl($imgUrl)</code> and <code>getImgUrl()</code>
+                <methodname>setImgUrl($imgUrl)</methodname> and <methodname>getImgUrl()</methodname>
                 allow you to specify the relative path to a CAPTCHA image to
                 use for HTML markup. The default is "/images/captcha/".
             </para></listitem>
 
             <listitem><para>
-                <code>setSuffix($suffix)</code> and <code>getSuffix()</code>
+                <methodname>setSuffix($suffix)</methodname> and <methodname>getSuffix()</methodname>
                 allow you to specify the filename suffix for the CAPTCHA image. The
                 default is ".png". Note: changing this value will not change the
                 type of the generated image.
@@ -219,22 +219,22 @@
 
         <itemizedlist>
             <listitem><para>
-                <code>setPrivKey($key)</code> and <code>getPrivKey()</code>
+                <methodname>setPrivKey($key)</methodname> and <methodname>getPrivKey()</methodname>
                 allow you to specify the private key to use for the ReCaptcha
                 service. This must be specified during construction, although it
                 may be overridden at any point.
             </para></listitem>
 
             <listitem><para>
-                <code>setPubKey($key)</code> and <code>getPubKey()</code>
+                <methodname>setPubKey($key)</methodname> and <methodname>getPubKey()</methodname>
                 allow you to specify the public key to use with the ReCaptcha
                 service. This must be specified during construction, although it
                 may be overridden at any point.
             </para></listitem>
 
             <listitem><para>
-                <code>setService(Zend_Service_ReCaptcha $service)</code> and
-                <code>getService()</code> allow you to set and get
+                <methodname>setService(Zend_Service_ReCaptcha $service)</methodname> and
+                <methodname>getService()</methodname> allow you to set and get
                 the ReCaptcha service object.
             </para></listitem>
         </itemizedlist>