[DOCUMENTATION] English:

 - manual fixes

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

documentation/manual/en/module_specs/Zend_Pdf-InteractiveFeatures.xml

@@ -792,7 +792,7 @@ $pdf->resolveDestination(Zend_Pdf_Destination_Named::create('Page3'));
 
             <para>
                 Only <classname>Zend_Pdf_Action_GoTo</classname> actions can be created by
-                user now. It can be done using 
+                user now. It can be done using
                 <methodname>Zend_Pdf_Action_GoTo::create($destination)</methodname> method,
                 where <varname>$destination</varname> is a
                 <classname>Zend_Pdf_Destination</classname> object or string which can be used
@@ -860,19 +860,19 @@ printf("Actions in a tree: %d\n", $actionsCount++); // Prints 'Actions in a tree
 
         <sect3 id="zend.pdf.pages.interactive-features.actions.open-action">
             <title>Document Open Action</title>
-            
+
             <para>
-                Special open action may be specify a destination to be displayed or an action 
+                Special open action may be specify a destination to be displayed or an action
                 to be performed when the document is opened.
             </para>
-            
+
             <para>
-                <methodname>Zend_Pdf_Target Zend_Pdf::getOpenAction()</methodname> method 
+                <methodname>Zend_Pdf_Target Zend_Pdf::getOpenAction()</methodname> method
                 returns current document open action (or null if open action is not set).
             </para>
 
             <para>
-                <methodname>setOpenAction(Zend_Pdf_Target $openAction = null)</methodname> 
+                <methodname>setOpenAction(Zend_Pdf_Target $openAction = null)</methodname>
                 method sets document open action or clean it if <varname>$openAction</varname>
                 is null.
             </para>
@@ -894,28 +894,28 @@ printf("Actions in a tree: %d\n", $actionsCount++); // Prints 'Actions in a tree
             the text of any visible item activates the item, causing the viewer application to
             jump to a destination or trigger an action associated with the item.
         </para>
-        
+
         <para>
-            <classname>Zend_Pdf</classname> class provides public property 
-            <varname>$outlines</varname> which is an array of 
+            <classname>Zend_Pdf</classname> class provides public property
+            <varname>$outlines</varname> which is an array of
             <classname>Zend_Pdf_Outline</classname> objects.
             <programlisting language="php"><![CDATA[
 $pdf = Zend_Pdf::load($path);
 
 // Remove outline item
-unset($pdf->outlines[0]->childOutlines[1]); 
+unset($pdf->outlines[0]->childOutlines[1]);
 
 // Set Outline to be displayed in bold
 $pdf->outlines[0]->childOutlines[3]->setIsBold(true);
 
 // Add outline entry
-$pdf->outlines[0]->childOutlines[5]->childOutlines[] = 
+$pdf->outlines[0]->childOutlines[5]->childOutlines[] =
     Zend_Pdf_Outline::create('Chapter 2', 'chapter_2');
 
 $pdf->save($path, true);
 ]]></programlisting>
         </para>
-        
+
         <para>
             Outline attributes may be retrieved or set using the following methods:
         </para>
@@ -935,7 +935,7 @@ $pdf->save($path, true);
 
             <listitem>
                 <para>
-                    <methodname>boolean isOpen()</methodname> - true if outline is open 
+                    <methodname>boolean isOpen()</methodname> - true if outline is open
                     by default.
                 </para>
             </listitem>
@@ -948,56 +948,56 @@ $pdf->save($path, true);
 
             <listitem>
                 <para>
-                    <methodname>boolean isItalic()</methodname> - true if outline item 
+                    <methodname>boolean isItalic()</methodname> - true if outline item
                     is displayed in italic.
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <methodname>setIsItalic(boolean $isItalic)</methodname> - set 
+                    <methodname>setIsItalic(boolean $isItalic)</methodname> - set
                     isItalic state.
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <methodname>boolean isBold()</methodname> - true if outline item 
+                    <methodname>boolean isBold()</methodname> - true if outline item
                     is displayed in bold.
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <methodname>setIsBold(boolean $isBold)</methodname> - set 
+                    <methodname>setIsBold(boolean $isBold)</methodname> - set
                     isBold state.
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <methodname>Zend_Pdf_Color_Rgb getColor()</methodname> - get outline 
+                    <methodname>Zend_Pdf_Color_Rgb getColor()</methodname> - get outline
                     text color (null means black).
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <methodname>setColor(Zend_Pdf_Color_Rgb $color)</methodname> - set 
+                    <methodname>setColor(Zend_Pdf_Color_Rgb $color)</methodname> - set
                     outline text color (null means black).
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <methodname>Zend_Pdf_Target getTarget()</methodname> - get outline 
+                    <methodname>Zend_Pdf_Target getTarget()</methodname> - get outline
                     target (action or explicit or named destination object).
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <methodname>setTarget(Zend_Pdf_Target|string $target)</methodname> - set 
+                    <methodname>setTarget(Zend_Pdf_Target|string $target)</methodname> - set
                     outline target (action or destination). String may be used to identify
                     named destination. Null means 'no target'.
                 </para>
@@ -1005,14 +1005,14 @@ $pdf->save($path, true);
 
             <listitem>
                 <para>
-                    <methodname>array getOptions()</methodname> - get outline attributes 
-                    as an array. 
+                    <methodname>array getOptions()</methodname> - get outline attributes
+                    as an array.
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <methodname>setOptions(array $options)</methodname> - set outline options. 
+                    <methodname>setOptions(array $options)</methodname> - set outline options.
                     The following options are recognized: 'title', 'open', 'color', 'italic',
                     'bold', and 'target'.
                 </para>
@@ -1020,7 +1020,7 @@ $pdf->save($path, true);
         </itemizedlist>
 
         <para>
-            New outline may be created in two ways:        
+            New outline may be created in two ways:
         </para>
 
         <itemizedlist>
@@ -1038,10 +1038,10 @@ $pdf->save($path, true);
         </itemizedlist>
 
         <para>
-            Each outline object may have child outline items listed in 
+            Each outline object may have child outline items listed in
             <varname>Zend_Pdf_Outline::$childOutlines</varname> public property.
-            It's an array of <classname>Zend_Pdf_Outline</classname> objects, 
-            so outlines are organized in a tree. 
+            It's an array of <classname>Zend_Pdf_Outline</classname> objects,
+            so outlines are organized in a tree.
         </para>
 
         <para>
@@ -1072,7 +1072,7 @@ foreach ($pdf->outlines as $documentRootOutlineEntry) {
 $pdf->save($path, true);
 ]]></programlisting>
         </para>
-        
+
         <note>
             <para>
                 All outline items with unresolved destinations (or destinations of GoTo
@@ -1084,20 +1084,20 @@ $pdf->save($path, true);
 
     <sect2 id="zend.pdf.pages.interactive-features.annotations">
         <title>Annotations</title>
-        
+
         <para>
-            An annotation associates an object such as a note, sound, or movie with a location 
-            on a page of a PDF document, or provides a way to interact with the user by means 
+            An annotation associates an object such as a note, sound, or movie with a location
+            on a page of a PDF document, or provides a way to interact with the user by means
             of the mouse and keyboard.
         </para>
-        
+
         <para>
-            All annotations are represented by <classname>Zend_Pdf_Annotation</classname> 
+            All annotations are represented by <classname>Zend_Pdf_Annotation</classname>
             abstract class.
         </para>
 
         <para>
-            Annotation may be attached to a page using 
+            Annotation may be attached to a page using
             <methodname>Zend_Pdf_Page::attachAnnotation(Zend_Pdf_Annotation $annotation)</methodname>
             method.
         </para>
@@ -1105,12 +1105,12 @@ $pdf->save($path, true);
         <para>
             Three types of annotations may be created by user now:
         </para>
-        
+
         <itemizedlist>
             <listitem>
                 <para>
                     <methodname>Zend_Pdf_Annotation_Link::create($x1, $y1, $x2, $y2, $target)</methodname>
-                    where <varname>$target</varname> is an action object or a destination or 
+                    where <varname>$target</varname> is an action object or a destination or
                     string (which may be used in place of named destination object).
                 </para>
             </listitem>
@@ -1127,20 +1127,20 @@ $pdf->save($path, true);
                 </para>
             </listitem>
         </itemizedlist>
-        
+
         <para>
-            A link annotation represents either a hypertext link to a destination elsewhere in 
+            A link annotation represents either a hypertext link to a destination elsewhere in
             the document or an action to be performed.
         </para>
-        
+
         <para>
             A text annotation represents a "sticky note" attached to a point in the PDF document.
         </para>
-        
+
         <para>
             A file attachment annotation contains a reference to a file.
         </para>
-        
+
         <para>
             The following methods are shared between all annotation types:
         </para>
@@ -1186,17 +1186,17 @@ $pdf->save($path, true);
                 <para><methodname>string getText()</methodname></para>
             </listitem>
         </itemizedlist>
-        
+
         <para>
-            Text annotation property is a text to be displayed for the annotation or, if this 
-            type of annotation does not display text, an alternate description of the annotation’s 
+            Text annotation property is a text to be displayed for the annotation or, if this
+            type of annotation does not display text, an alternate description of the annotation’s
             contents in human-readable form.
         </para>
 
         <para>
             Link annotation objects also provide two additional methods:
         </para>
-   
+
         <itemizedlist>
             <listitem>
                 <para>

documentation/manual/en/module_specs/Zend_Tool_Framework-Extending.xml

@@ -1,198 +1,185 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- Reviewed: no -->
 <sect1 id="zend.tool.framework.extending">
-
     <title>Extending and Configuring Zend_Tool_Framework</title>
 
     <sect2 id="zend.tool.framework.console-client">
         <title>Customizing Zend_Tool Console Client</title>
-    
+
         <para>
-			As of ZF 1.9, Zend_Tool_Framework allows developers to
-			store information, provider specific configuration values,
-			and custom files in a special location on the developers 
-			machine.  These configuration values and files can be used 
-			by providers to extend functionality, customize
-			functionality, or any other reasons a provider sees fit.
-	    </para>
-	    
-	    <para>
-			The primary purpose, and the purpose most immediately
-			used by existing providers is to allow developers to
-			customize the way the "out of the box" providers do work.
-	    </para>
+            As of Zend Framework 1.9, <classname>Zend_Tool_Framework</classname>
+            allows developers to store information, provider specific configuration
+            values, and custom files in a special location on the developers
+            machine. These configuration values and files can be used
+            by providers to extend functionality, customize
+            functionality, or any other reasons a provider sees fit.
+        </para>
 
         <para>
-			One of the more commonly requested features is to be able 
-			to provide custom project profiles to Zend_Tool_Project's 
-			Project Provider.  This would allow developers to store a 
-			custom profile in a special place that can be used repeatedly 
-			by the Zend_Tool system in order to build custom profiles.
-			Another commonly requested feature is to be able to configure
-			the behavior of providers with a configuration setting.  In
-			order to achieve this, not only do we have to have a 
-			Zend_Tool configuration file, but we also have to have a place
-			to find this configuration file. 
+            The primary purpose, and the purpose most immediately
+            used by existing providers is to allow developers to
+            customize the way the "out of the box" providers do work.
+        </para>
+
+        <para>
+            One of the more commonly requested features is to be able
+            to provide custom project profiles to <classname>Zend_Tool_Project</classname>'s
+            Project Provider. This would allow developers to store a
+            custom profile in a special place that can be used repeatedly
+            by the <classname>Zend_Tool</classname> system in order to build custom profiles.
+            Another commonly requested feature is to be able to configure
+            the behavior of providers with a configuration setting. In
+            order to achieve this, not only do we have to have a
+            <classname>Zend_Tool</classname> configuration file, but we also have to have a place
+            to find this configuration file.
         </para>
 
         <sect3 id="zend.tool.framework.console-client.home-directory">
             <title>The Home Directory</title>
-            
+
             <para>
-				Before the Console Client can start searching for a Zend_Tool
-				configuration file or a local storage directory, it must
-				first be able to identify where the "home directory" is
-				located.
-		    </para>
-				
-		    <para>
-				On *nix-based machines, PHP will be populated with an environment
-				variable named HOME with a path to the current users
-				home directory.  Typically, this path will be very similar
-				to /home/myusername.
-			</para>
-				
-			<para>
-				On Windows-based machines, PHP will typically be populated with
-				an environment variable named HOMEPATH with the current
-				users home directory.  This directory is usually found
-				in either C:\Documents and Settings\Username\ or, in Vista:
-				C:\Users\Username.
-			</para>
-			
-			<para>
-				If either a home directory cannot be found, or you wish to
-				change the location of where Zend_Tool_Frameworks Console
-				Client finds the home directory, you can provide an environment
-				variable named ZF_HOME to specify where to find the home
-				directory.
+                Before the Console Client can start searching for a <classname>Zend_Tool</classname>
+                configuration file or a local storage directory, it must
+                first be able to identify where the "home directory" is
+                located.
             </para>
-        
-        
-        </sect3>
 
+            <para>
+                On *nix-based machines, <acronym>PHP</acronym> will be populated with an environment
+                variable named <constant>HOME</constant> with a path to the current users
+                home directory. Typically, this path will be very similar
+                to <filename>/home/myusername</filename>.
+            </para>
+
+            <para>
+                On Windows-based machines, <acronym>PHP</acronym> will typically be populated with
+                an environment variable named <constant>HOMEPATH</constant> with the current
+                users home directory. This directory is usually found
+                in either <filename>C:\Documents and Settings\Username\</filename> or, in Vista:
+                <filename>C:\Users\Username</filename>.
+            </para>
+
+            <para>
+                If either a home directory cannot be found, or you wish to
+                change the location of where <classname>Zend_Tool_Framework</classname> Console
+                Client finds the home directory, you can provide an environment
+                variable named <constant>ZF_HOME</constant> to specify where to find the home
+                directory.
+            </para>
+        </sect3>
 
         <sect3 id="zend.tool.framework.console-client.local-storage">
             <title>Local Storage</title>
-            
+
             <para>
-				Once a home directory can be located, Zend_Tool_Framework's 
-				Console Client can either autodiscover the local storage
-				directory, or it can be told where to expect the local
-				storage directory.
+                Once a home directory can be located, <classname>Zend_Tool_Framework</classname>'s
+                Console Client can either autodiscover the local storage
+                directory, or it can be told where to expect the local
+                storage directory.
             </para>
-            
+
             <para>
-				Assuming the home directory has been found (here noted 
-				as $HOME), the Console Client will then look for the
-				local storage directory in $HOME/.zf/.  If found, it will
-				set the local storage directory to this location.
+                Assuming the home directory has been found (here noted
+                as <varname>$HOME</varname>), the Console Client will then look for the
+                local storage directory in <filename>$HOME/.zf/</filename>. If found, it will
+                set the local storage directory to this location.
             </para>
-            
+
             <para>
-				If the directory cannot be found, or the developer wishes
-				to override this location, that can be done via setting
-				and environment variable.  Regardless if $HOME has been
-				previously set or not, the developer may supply the 
-				environment variable ZF_STORAGE_DIRECTORY.  
+                If the directory cannot be found, or the developer wishes
+                to override this location, that can be done via setting
+                and environment variable. Regardless if <varname>$HOME</varname> has been
+                previously set or not, the developer may supply the
+                environment variable <constant>ZF_STORAGE_DIRECTORY</constant>.
             </para>
-            
+
             <para>
-				Once the path to a local storage directory is found, the
-				directory MUST exist for it to be passed into the
-				Zend_Tool_Framework runtime, as it will not be created
-				for you.
+                Once the path to a local storage directory is found, the
+                directory <emphasis>must</emphasis> exist for it to be passed into the
+                <classname>Zend_Tool_Framework</classname> runtime, as it will not be created
+                for you.
             </para>
-            
         </sect3>
 
         <sect3 id="zend.tool.framework.console-client.configuration-file">
             <title>User Configuration</title>
 
-
             <para>
-				Like local storage, once a home directory can be located,
-				Zend_Tool_Framework's Console Client can then either
-				attempt to autodiscover the path to a configuration
-				file, or it can be told specifically where to find
-				the configuration file.
+                Like local storage, once a home directory can be located,
+                <classname>Zend_Tool_Framework</classname>'s Console Client can then either
+                attempt to autodiscover the path to a configuration
+                file, or it can be told specifically where to find
+                the configuration file.
             </para>
-            
+
             <para>
-				Assuming the home directory has been found (here noted
-				as $HOME), the Console Client will then attempt to
-				look for the existence of a configuration file located
-				at $HOME/.zf.ini.  This file, if found, will be used
-				as the configuration file for Zend_Tool_Framework.
+                Assuming the home directory has been found (here noted
+                as <varname>$HOME</varname>), the Console Client will then attempt to
+                look for the existence of a configuration file located
+                at <filename>$HOME/.zf.ini</filename>. This file, if found, will be used
+                as the configuration file for <classname>Zend_Tool_Framework</classname>.
             </para>
-            
+
             <para>
-				If that location does not exist, but a local storage 
-				directory does, then the Console Client will then
-				attempt to locate the configuration file within the
-				local storage directory.  Assuming the local storage
-				directory exists in $LOCAL_STORAGE, then if a file
-				exists as $LOCAL_STORAGE/zf.ini, it will be found
-				by the Console Client and utilized as the 
-				Zend_Tool_Framework configuration file.
-			</para>
+                If that location does not exist, but a local storage
+                directory does, then the Console Client will then
+                attempt to locate the configuration file within the
+                local storage directory. Assuming the local storage
+                directory exists in <varname>$LOCAL_STORAGE</varname>, then if a file
+                exists as <filename>$LOCAL_STORAGE/zf.ini</filename>, it will be found
+                by the Console Client and utilized as the
+                <classname>Zend_Tool_Framework</classname> configuration file.
+            </para>
 
             <para>
-				If the file cannot be autodiscovered or the developer
-				wishes to specify the location of location of the
-				configuration file, the developer can do so by
-				setting an evironment variable.  If the environment
-				variable ZF_CONFIG_FILE is set, then its value will
-				be used as the location of the configuration file
-				to use with the Console Client.
+                If the file cannot be autodiscovered or the developer
+                wishes to specify the location of location of the
+                configuration file, the developer can do so by
+                setting an evironment variable. If the environment
+                variable <constant>ZF_CONFIG_FILE</constant> is set, then its value will
+                be used as the location of the configuration file
+                to use with the Console Client.
             </para>
 
             <para>
-				If the file does not exist in either the autodiscovered
-				or the provided location, it will not be used as 
-				Zend_Tool_Framework does not attempt to create the
-				file automatically.
-			</para>
-        
+                If the file does not exist in either the autodiscovered
+                or the provided location, it will not be used as
+                <classname>Zend_Tool_Framework</classname> does not attempt to create the
+                file automatically.
+            </para>
         </sect3>
 
         <sect3 id="zend.tool.framework.console-client.configuration-content">
             <title>User Configuration File Content</title>
-            
+
             <para>
-				The configuration file should be structured as 
-				a Zend_Config configuration file, in ini format, and
-				without any sections being defined.  First level
-				keys should be used by the provider searching for
-				a specific value.  For example, if the "Project"
-				provider is expecting a "profiles" directory, 
-				then it should typically be understood that
-				it will search for the following ini key value pair:
+                The configuration file should be structured as
+                a <classname>Zend_Config</classname> configuration file, in ini format, and
+                without any sections being defined. First level
+                keys should be used by the provider searching for
+                a specific value. For example, if the "Project"
+                provider is expecting a "profiles" directory,
+                then it should typically be understood that
+                it will search for the following ini key value pair:
             </para>
-            
+
             <programlisting language="php"><![CDATA[
 project.profile = some/path/to/some-directory
 ]]></programlisting>
-        
+
             <para>
-				The only reserved ini prefix is the value "php".
-				The "php" prefix to values will be reserved to
-				store names and values of runtime settable php values,
-				such as: include_path or error_reporting.  To override
-				the include_path and error_reporting with an ini value, 
-				a developer would set:
+                The only reserved ini prefix is the value "php".
+                The "php" prefix to values will be reserved to
+                store names and values of runtime settable php values,
+                such as: include_path or error_reporting. To override
+                the <property>include_path</property> and <property>error_reporting</property>
+                with an ini value, a developer would set:
             </para>
-            
+
             <programlisting language="php"><![CDATA[
 php.include_path = "/path/to/includes1:/path/to/includes2"
 php.error_reporting = 1
 ]]></programlisting>
-
         </sect3>
-	    
     </sect2>
-    
-    
-
-
-</sect1>
+</sect1>