Ver código fonte

[MANUAL] English:

- manual fixes

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@19437 44c647ce-9c0f-0410-b52a-842ac1e357ba
thomas 16 anos atrás
pai
commit
59d16e0123

+ 69 - 34
documentation/manual/en/module_specs/Zend_View-Helpers-HeadScript.xml

@@ -4,40 +4,75 @@
     <title>HeadScript Helper</title>
     <title>HeadScript Helper</title>
 
 
     <para>
     <para>
-        The HTML <code>&lt;script&gt;</code> element is used to either provide
+        The HTML <emphasis>&lt;script&gt;</emphasis> element is used to either provide
         inline client-side scripting elements or link to a remote resource
         inline client-side scripting elements or link to a remote resource
-        containing client-side scripting code. The <code>HeadScript</code>
+        containing client-side scripting code. The <classname>HeadScript</classname>
         helper allows you to manage both.
         helper allows you to manage both.
     </para>
     </para>
 
 
     <para>
     <para>
-        The <code>HeadScript</code> helper supports the following methods for
+        The <classname>HeadScript</classname> helper supports the following methods for
         setting and adding scripts:
         setting and adding scripts:
     </para>
     </para>
 
 
     <itemizedlist>
     <itemizedlist>
-        <listitem><para><code>appendFile($src, $type = 'text/javascript',
-                    $attrs = array())</code></para></listitem>
-        <listitem><para><code>offsetSetFile($index, $src, $type = 'text/javascript',
-                    $attrs = array())</code></para></listitem>
-        <listitem><para><code>prependFile($src, $type = 'text/javascript',
-                    $attrs = array())</code></para></listitem>
-        <listitem><para><code>setFile($src, $type = 'text/javascript',
-                    $attrs = array())</code></para></listitem>
-        <listitem><para><code>appendScript($script, $type = 'text/javascript',
-                    $attrs = array())</code></para></listitem>
-        <listitem><para><code>offsetSetScript($index, $script, $type = 'text/javascript',
-                    $attrs = array())</code></para></listitem>
-        <listitem><para><code>prependScript($script, $type = 'text/javascript',
-                    $attrs = array())</code></para></listitem>
-        <listitem><para><code>setScript($script, $type = 'text/javascript',
-                    $attrs = array())</code></para></listitem>
+        <listitem>
+            <para>
+                <command>appendFile($src, $type = 'text/javascript', $attrs = array())</command>
+            </para>
+        </listitem>
+
+        <listitem>
+            <para>
+                <command>offsetSetFile($index, $src, $type = 'text/javascript', $attrs =
+                    array())</command>
+            </para>
+        </listitem>
+
+        <listitem>
+            <para>
+                <command>prependFile($src, $type = 'text/javascript', $attrs = array())</command>
+            </para>
+        </listitem>
+
+        <listitem>
+            <para>
+                <command>setFile($src, $type = 'text/javascript', $attrs = array())</command>
+            </para>
+        </listitem>
+
+        <listitem>
+            <para>
+                <command>appendScript($script, $type = 'text/javascript', $attrs =
+                    array())</command>
+            </para>
+        </listitem>
+
+        <listitem>
+            <para>
+                <command>offsetSetScript($index, $script, $type = 'text/javascript', $attrs =
+                    array())</command>
+            </para>
+        </listitem>
+
+        <listitem>
+            <para>
+                <command>prependScript($script, $type = 'text/javascript', $attrs =
+                    array())</command>
+            </para>
+        </listitem>
+
+        <listitem>
+            <para>
+                <command>setScript($script, $type = 'text/javascript', $attrs = array())</command>
+            </para>
+        </listitem>
     </itemizedlist>
     </itemizedlist>
 
 
     <para>
     <para>
-        In the case of the <code>*File()</code> methods, <varname>$src</varname> is
+        In the case of the *<methodname>File()</methodname> methods, <varname>$src</varname> is
         the remote location of the script to load; this is usually in the form
         the remote location of the script to load; this is usually in the form
-        of a <acronym>URL</acronym> or a path. For the <code>*Script()</code> methods,
+        of a <acronym>URL</acronym> or a path. For the *<methodname>Script()</methodname> methods,
         <varname>$script</varname> is the client-side scripting directives you wish to
         <varname>$script</varname> is the client-side scripting directives you wish to
         use in the element.
         use in the element.
     </para>
     </para>
@@ -46,8 +81,8 @@
         <title>Setting Conditional Comments</title>
         <title>Setting Conditional Comments</title>
 
 
         <para>
         <para>
-            <code>HeadScript</code> allows you to wrap the script tag in conditional comments,
-            which allows you to hide it from specific browsers. To add the conditional
+            <classname>HeadScript</classname> allows you to wrap the script tag in conditional
+            comments, which allows you to hide it from specific browsers. To add the conditional
             tags, pass the conditional value as part of the <varname>$attrs</varname> parameter in
             tags, pass the conditional value as part of the <varname>$attrs</varname> parameter in
             the method calls.
             the method calls.
         </para>
         </para>
@@ -66,7 +101,7 @@ $this->headScript()->appendFile(
     </note>
     </note>
 
 
     <para>
     <para>
-        <code>HeadScript</code> also allows capturing scripts; this can be
+        <classname>HeadScript</classname> also allows capturing scripts; this can be
         useful if you want to create the client-side script programmatically,
         useful if you want to create the client-side script programmatically,
         and then place it elsewhere. The usage for this will be showed in an
         and then place it elsewhere. The usage for this will be showed in an
         example below.
         example below.
@@ -83,17 +118,17 @@ $this->headScript()->appendFile(
     </para>
     </para>
 
 
     <para>
     <para>
-        <code>HeadScript</code> overrides each of <methodname>append()</methodname>,
+        <classname>HeadScript</classname> overrides each of <methodname>append()</methodname>,
         <methodname>offsetSet()</methodname>, <methodname>prepend()</methodname>, and
         <methodname>offsetSet()</methodname>, <methodname>prepend()</methodname>, and
         <methodname>set()</methodname> to enforce usage of the special methods as listed above.
         <methodname>set()</methodname> to enforce usage of the special methods as listed above.
-        Internally, it stores each item as a <code>stdClass</code> token, which it later
+        Internally, it stores each item as a <property>stdClass</property> token, which it later
         serializes using the <methodname>itemToString()</methodname> method. This allows you
         serializes using the <methodname>itemToString()</methodname> method. This allows you
         to perform checks on the items in the stack, and optionally modify these
         to perform checks on the items in the stack, and optionally modify these
         items by simply modifying the object returned.
         items by simply modifying the object returned.
     </para>
     </para>
 
 
     <para>
     <para>
-        The <code>HeadScript</code> helper is a concrete implementation of the
+        The <classname>HeadScript</classname> helper is a concrete implementation of the
         <link linkend="zend.view.helpers.initial.placeholder">Placeholder
         <link linkend="zend.view.helpers.initial.placeholder">Placeholder
             helper</link>.
             helper</link>.
     </para>
     </para>
@@ -102,10 +137,10 @@ $this->headScript()->appendFile(
         <title>Use InlineScript for HTML Body Scripts</title>
         <title>Use InlineScript for HTML Body Scripts</title>
 
 
         <para>
         <para>
-            <code>HeadScript</code>'s sibling helper, <link
+            <classname>HeadScript</classname>'s sibling helper, <link
                 linkend="zend.view.helpers.initial.inlinescript">InlineScript</link>,
                 linkend="zend.view.helpers.initial.inlinescript">InlineScript</link>,
             should be used when you wish to include scripts inline in the HTML
             should be used when you wish to include scripts inline in the HTML
-            <code>body</code>. Placing scripts at the end of your document is a
+            <emphasis>body</emphasis>. Placing scripts at the end of your document is a
             good practice for speeding up delivery of your page, particularly
             good practice for speeding up delivery of your page, particularly
             when using 3rd party analytics scripts.
             when using 3rd party analytics scripts.
         </para>
         </para>
@@ -115,8 +150,8 @@ $this->headScript()->appendFile(
         <title>Arbitrary Attributes are Disabled by Default</title>
         <title>Arbitrary Attributes are Disabled by Default</title>
 
 
         <para>
         <para>
-            By default, <code>HeadScript</code> only will render
-            <code>&lt;script&gt;</code> attributes that are blessed by the W3C.
+            By default, <classname>HeadScript</classname> only will render
+            <emphasis>&lt;script&gt;</emphasis> attributes that are blessed by the W3C.
             These include 'type', 'charset', 'defer', 'language', and 'src'.
             These include 'type', 'charset', 'defer', 'language', and 'src'.
             However, some javascript frameworks, notably <ulink
             However, some javascript frameworks, notably <ulink
                 url="http://www.dojotoolkit.org/">Dojo</ulink>, utilize custom
                 url="http://www.dojotoolkit.org/">Dojo</ulink>, utilize custom
@@ -181,8 +216,8 @@ $this->headScript()->prependFile('/js/prototype.js');
             Sometimes you need to generate client-side scripts programmatically.
             Sometimes you need to generate client-side scripts programmatically.
             While you could use string concatenation, heredocs, and the like,
             While you could use string concatenation, heredocs, and the like,
             often it's easier just to do so by creating the script and
             often it's easier just to do so by creating the script and
-            sprinkling in <acronym>PHP</acronym> tags. <code>HeadScript</code> lets you do just
-            that, capturing it to the stack:
+            sprinkling in <acronym>PHP</acronym> tags. <classname>HeadScript</classname> lets you do
+            just that, capturing it to the stack:
         </para>
         </para>
 
 
         <programlisting language="php"><![CDATA[
         <programlisting language="php"><![CDATA[
@@ -212,7 +247,7 @@ $('foo_form').action = action;
 
 
             <listitem><para>
             <listitem><para>
                     If you wish to specify any additional attributes for the
                     If you wish to specify any additional attributes for the
-                    <code>&lt;script&gt;</code> tag, pass them in an array as
+                    <emphasis>&lt;script&gt;</emphasis> tag, pass them in an array as
                     the third argument to <methodname>captureStart()</methodname>.
                     the third argument to <methodname>captureStart()</methodname>.
             </para></listitem>
             </para></listitem>
         </itemizedlist>
         </itemizedlist>

+ 39 - 23
documentation/manual/en/module_specs/Zend_View-Helpers-HeadStyle.xml

@@ -4,8 +4,9 @@
     <title>HeadStyle Helper</title>
     <title>HeadStyle Helper</title>
 
 
     <para>
     <para>
-        The HTML <code>&lt;style&gt;</code> element is used to include
-        <acronym>CSS</acronym> stylesheets inline in the HTML <code>&lt;head&gt;</code> element.
+        The HTML <emphasis>&lt;style&gt;</emphasis> element is used to include
+        <acronym>CSS</acronym> stylesheets inline in the HTML <emphasis>&lt;head&gt;</emphasis>
+        element.
     </para>
     </para>
 
 
     <note>
     <note>
@@ -13,40 +14,55 @@
 
 
         <para>
         <para>
             <link linkend="zend.view.helpers.initial.headlink">HeadLink</link>
             <link linkend="zend.view.helpers.initial.headlink">HeadLink</link>
-            should be used to create <code>&lt;link&gt;</code> elements for
-            including external stylesheets. <code>HeadStyle</code> is used when
+            should be used to create <emphasis>&lt;link&gt;</emphasis> elements for
+            including external stylesheets. <classname>HeadStyle</classname> is used when
             you wish to define your stylesheets inline.
             you wish to define your stylesheets inline.
         </para>
         </para>
     </note>
     </note>
 
 
     <para>
     <para>
-        The <code>HeadStyle</code> helper supports the following methods for
+        The <classname>HeadStyle</classname> helper supports the following methods for
         setting and adding stylesheet declarations:
         setting and adding stylesheet declarations:
     </para>
     </para>
 
 
     <itemizedlist>
     <itemizedlist>
-        <listitem><para><code>appendStyle($content, $attributes =
-                    array())</code></para></listitem>
-        <listitem><para><code>offsetSetStyle($index, $content, $attributes =
-                    array())</code></para></listitem>
-        <listitem><para><code>prependStyle($content, $attributes =
-                    array())</code></para></listitem>
-        <listitem><para><code>setStyle($content, $attributes =
-                    array())</code></para></listitem>
+        <listitem>
+            <para>
+                <command>appendStyle($content, $attributes = array())</command>
+            </para>
+        </listitem>
+
+        <listitem>
+            <para>
+                <command>offsetSetStyle($index, $content, $attributes = array())</command>
+            </para>
+        </listitem>
+
+        <listitem>
+            <para>
+                <command>prependStyle($content, $attributes = array())</command>
+            </para>
+        </listitem>
+
+        <listitem>
+            <para>
+                <command>setStyle($content, $attributes = array())</command>
+            </para>
+        </listitem>
     </itemizedlist>
     </itemizedlist>
 
 
     <para>
     <para>
         In all cases, <varname>$content</varname> is the actual <acronym>CSS</acronym> declarations.
         In all cases, <varname>$content</varname> is the actual <acronym>CSS</acronym> declarations.
         <varname>$attributes</varname> are any additional attributes you wish to provide to the
         <varname>$attributes</varname> are any additional attributes you wish to provide to the
-        <code>style</code> tag: lang, title, media, or dir are all permissible.
+        <property>style</property> tag: lang, title, media, or dir are all permissible.
     </para>
     </para>
 
 
     <note>
     <note>
         <title>Setting Conditional Comments</title>
         <title>Setting Conditional Comments</title>
 
 
         <para>
         <para>
-            <code>HeadStyle</code> allows you to wrap the style tag in conditional comments,
-            which allows you to hide it from specific browsers. To add the conditional
+            <classname>HeadStyle</classname> allows you to wrap the style tag in conditional
+            comments, which allows you to hide it from specific browsers. To add the conditional
             tags, pass the conditional value as part of the <varname>$attributes</varname> parameter
             tags, pass the conditional value as part of the <varname>$attributes</varname> parameter
             in the method calls.
             in the method calls.
         </para>
         </para>
@@ -61,7 +77,7 @@ $this->headStyle()->appendStyle($styles, array('conditional' => 'lt IE 7'));
     </note>
     </note>
 
 
     <para>
     <para>
-        <code>HeadStyle</code> also allows capturing style declarations; this
+        <classname>HeadStyle</classname> also allows capturing style declarations; this
         can be useful if you want to create the declarations programmatically,
         can be useful if you want to create the declarations programmatically,
         and then place them elsewhere. The usage for this will be showed in an
         and then place them elsewhere. The usage for this will be showed in an
         example below.
         example below.
@@ -75,17 +91,17 @@ $this->headStyle()->appendStyle($styles, array('conditional' => 'lt IE 7'));
     </para>
     </para>
 
 
     <para>
     <para>
-        <code>HeadStyle</code> overrides each of <methodname>append()</methodname>,
+        <classname>HeadStyle</classname> overrides each of <methodname>append()</methodname>,
         <methodname>offsetSet()</methodname>, <methodname>prepend()</methodname>, and
         <methodname>offsetSet()</methodname>, <methodname>prepend()</methodname>, and
         <methodname>set()</methodname> to enforce usage of the special methods as listed above.
         <methodname>set()</methodname> to enforce usage of the special methods as listed above.
-        Internally, it stores each item as a <code>stdClass</code> token, which it later
+        Internally, it stores each item as a <property>stdClass</property> token, which it later
         serializes using the <methodname>itemToString()</methodname> method. This allows you
         serializes using the <methodname>itemToString()</methodname> method. This allows you
         to perform checks on the items in the stack, and optionally modify these
         to perform checks on the items in the stack, and optionally modify these
         items by simply modifying the object returned.
         items by simply modifying the object returned.
     </para>
     </para>
 
 
     <para>
     <para>
-        The <code>HeadStyle</code> helper is a concrete implementation of the
+        The <classname>HeadStyle</classname> helper is a concrete implementation of the
         <link linkend="zend.view.helpers.initial.placeholder">Placeholder
         <link linkend="zend.view.helpers.initial.placeholder">Placeholder
             helper</link>.
             helper</link>.
     </para>
     </para>
@@ -139,8 +155,8 @@ $this->headStyle()->prependStyle($firstStyles);
             Sometimes you need to generate <acronym>CSS</acronym> style declarations
             Sometimes you need to generate <acronym>CSS</acronym> style declarations
             programmatically. While you could use string concatenation,
             programmatically. While you could use string concatenation,
             heredocs, and the like, often it's easier just to do so by creating
             heredocs, and the like, often it's easier just to do so by creating
-            the styles and sprinkling in <acronym>PHP</acronym> tags. <code>HeadStyle</code> lets
-            you do just that, capturing it to the stack:
+            the styles and sprinkling in <acronym>PHP</acronym> tags.
+            <classname>HeadStyle</classname> lets you do just that, capturing it to the stack:
         </para>
         </para>
 
 
         <programlisting language="php"><![CDATA[
         <programlisting language="php"><![CDATA[
@@ -165,7 +181,7 @@ body {
 
 
             <listitem><para>
             <listitem><para>
                     If you wish to specify any additional attributes for the
                     If you wish to specify any additional attributes for the
-                    <code>&lt;style&gt;</code> tag, pass them in an array as
+                    <emphasis>&lt;style&gt;</emphasis> tag, pass them in an array as
                     the second argument to <methodname>captureStart()</methodname>.
                     the second argument to <methodname>captureStart()</methodname>.
             </para></listitem>
             </para></listitem>
         </itemizedlist>
         </itemizedlist>

+ 14 - 14
documentation/manual/en/module_specs/Zend_View-Helpers-HtmlObject.xml

@@ -4,8 +4,8 @@
     <title>HTML Object Helpers</title>
     <title>HTML Object Helpers</title>
 
 
     <para>
     <para>
-        The HTML <code><![CDATA[
-<object>]]></code> element is used for embedding
+        The HTML <emphasis><![CDATA[
+<object>]]></emphasis> element is used for embedding
         media like Flash or QuickTime in web pages. The object view helpers take
         media like Flash or QuickTime in web pages. The object view helpers take
         care of embedding media with minimum effort.
         care of embedding media with minimum effort.
     </para>
     </para>
@@ -17,25 +17,25 @@
     <itemizedlist>
     <itemizedlist>
         <listitem>
         <listitem>
             <para>
             <para>
-                <code>htmlFlash</code>
+                <methodname>htmlFlash()</methodname>
                 Generates markup for embedding Flash files.
                 Generates markup for embedding Flash files.
             </para>
             </para>
         </listitem>
         </listitem>
         <listitem>
         <listitem>
             <para>
             <para>
-                <code>htmlObject</code>
+                <methodname>htmlObject()</methodname>
                 Generates markup for embedding a custom Object.
                 Generates markup for embedding a custom Object.
             </para>
             </para>
         </listitem>
         </listitem>
         <listitem>
         <listitem>
             <para>
             <para>
-                <code>htmlPage</code>
+                <methodname>htmlPage()</methodname>
                 Generates markup for embedding other (X)HTML pages.
                 Generates markup for embedding other (X)HTML pages.
             </para>
             </para>
         </listitem>
         </listitem>
         <listitem>
         <listitem>
             <para>
             <para>
-                <code>htmlQuicktime</code>
+                <methodname>htmlQuicktime()</methodname>
                 Generates markup for embedding QuickTime files.
                 Generates markup for embedding QuickTime files.
             </para>
             </para>
         </listitem>
         </listitem>
@@ -75,9 +75,9 @@
 
 
     <para>
     <para>
         Additionally you can specify attributes, parameters and content that can
         Additionally you can specify attributes, parameters and content that can
-        be rendered along with the <code><![CDATA[
-<object>]]></code>. This will
-        be demonstrated using the <code>htmlObject</code> helper.
+        be rendered along with the <emphasis><![CDATA[
+<object>]]></emphasis>. This will
+        be demonstrated using the <methodname>htmlObject()</methodname> helper.
     </para>
     </para>
 
 
     <example id="zend.view.helpers.initial.object.object">
     <example id="zend.view.helpers.initial.object.object">
@@ -86,14 +86,14 @@
         <para>
         <para>
             The first argument in the object helpers is always required. It is
             The first argument in the object helpers is always required. It is
             the <acronym>URI</acronym> to the resource you want to embed. The second argument is
             the <acronym>URI</acronym> to the resource you want to embed. The second argument is
-            only required in the <code>htmlObject</code> helper. The other helpers
+            only required in the <methodname>htmlObject()</methodname> helper. The other helpers
             already contain the correct value for this argument. The third
             already contain the correct value for this argument. The third
             argument is used for passing along attributes to the object element.
             argument is used for passing along attributes to the object element.
-            It only accepts an array with key-value pairs. The <code>classid</code>
-            and <code>codebase</code> are examples of such attributes. The fourth
+            It only accepts an array with key-value pairs. <property>classid</property>
+            and <property>codebase</property> are examples of such attributes. The fourth
             argument also only takes a key-value array and uses them to create
             argument also only takes a key-value array and uses them to create
-            <code><![CDATA[
-<param>]]></code> elements. You will see an example
+            <emphasis><![CDATA[
+<param>]]></emphasis> elements. You will see an example
             of this shortly. Lastly, there is the option of providing additional
             of this shortly. Lastly, there is the option of providing additional
             content to the object. Now for an example which utilizes all arguments.
             content to the object. Now for an example which utilizes all arguments.
         </para>
         </para>