Przeglądaj źródła

[DOCUMENTATION] English:
- manual fixes

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

mikaelkael 16 lat temu
rodzic
commit
209661b965

+ 8 - 8
documentation/manual/en/module_specs/Zend_Console_Getopt-Configuration.xml

@@ -28,8 +28,8 @@ $opts->addRules(
 ]]></programlisting>
         </example>
         <para>
-            The example above shows adding the "<code>--verbose</code>" option
-            with an alias of "<code>-v</code>" to a set of options
+            The example above shows adding the <command>--verbose</command> option
+            with an alias of <command>-v</command> to a set of options
             defined in the call to the constructor. Notice that you can mix
             short format options and long format options in the same instance
             of <classname>Zend_Console_Getopt</classname>.
@@ -98,9 +98,9 @@ $opts->setAliases(
         </example>
         <para>
             In the example above, after declaring these aliases,
-            "<code>-a</code>", "<code>--apple</code>" and
-            "<code>--apfel</code>" are aliases for each other.
-            Also "<code>-p</code>" and "<code>--pear</code>" are aliases
+            <command>-a</command>, <command>--apple</command> and
+            <command>--apfel</command> are aliases for each other.
+            Also <command>-p</command> and <command>--pear</command> are aliases
             for each other.
         </para>
         <para>
@@ -169,7 +169,7 @@ $opts->setArguments(array('-a', '-p', 'p_parameter', 'non_option_arg'));
             <listitem>
                 <para>
                     <constant>Zend_Console_Getopt::CONFIG_DASHDASH</constant> ("dashDash"),
-                    if true, enables the special flag "<code>--</code>" to
+                    if true, enables the special flag <command>--</command> to
                     signify the end of flags. Command-line arguments following
                     the double-dash signifier are not interpreted as options,
                     even if the arguments start with a dash. This configuration
@@ -180,8 +180,8 @@ $opts->setArguments(array('-a', '-p', 'p_parameter', 'non_option_arg'));
                 <para>
                     <constant>Zend_Console_Getopt::CONFIG_IGNORECASE</constant> ("ignoreCase"),
                     if true, makes flags aliases of each other if they differ
-                    only in their case. That is, "<code>-a</code>" and
-                    "<code>-A</code>" will be considered to be synonymous flags.
+                    only in their case. That is, <command>-a</command> and
+                    <command>-A</command> will be considered to be synonymous flags.
                     This configuration option is false by default.
                 </para>
             </listitem>

+ 3 - 3
documentation/manual/en/module_specs/Zend_Console_Getopt-Fetching.xml

@@ -117,7 +117,7 @@ $p_parameter = $opts->p; // null if not set
             <listitem>
                 <para>
                     As a string: use the <methodname>toString()</methodname> method. The options
-                    are returned as a space-separated string of "<code>flag=value</code>"
+                    are returned as a space-separated string of <command>flag=value</command>
                     pairs. The value of an option that does not have a parameter
                     is the literal string "<constant>TRUE</constant>".
                 </para>
@@ -145,8 +145,8 @@ $p_parameter = $opts->p; // null if not set
         <para>
             In all of the above dumping methods, the flag string is the
             first string in the corresponding list of aliases. For example,
-            if the option aliases were declared like "<code>verbose|v</code>",
-            then the first string, "<code>verbose</code>", is used as the
+            if the option aliases were declared like <command>verbose|v</command>,
+            then the first string, <command>verbose</command>, is used as the
             canonical name of the option. The name of the option flag does not
             include any preceding dashes.
         </para>

+ 14 - 14
documentation/manual/en/module_specs/Zend_Console_Getopt-Introduction.xml

@@ -11,9 +11,9 @@
         they execute your application. These arguments have meaning to the
         application, to change the behavior in some way, or choose resources,
         or specify parameters. Many options have developed customary meaning,
-        for example "<code>--verbose</code>" enables extra output from many
+        for example <command>--verbose</command> enables extra output from many
         applications. Other options may have a meaning that is different for
-        each application. For example, "<code>-c</code>" enables different
+        each application. For example, <command>-c</command> enables different
         features in <command>grep</command>, <command>ls</command>, and
         <command>tar</command>.
     </para>
@@ -41,7 +41,7 @@
                 "flag": the first part of an option, identifies
                 the purpose of the option. A flag is preceded
                 conventionally by one or two dashes
-                ("<code>-</code>" or "<code>--</code>").
+                (<command>-</command> or <command>--</command>).
                 A single dash precedes a single-character flag
                 or a cluster of single-character flags.
                 A double-dash precedes a multi-character flag.
@@ -53,19 +53,19 @@
                 "parameter": the secondary part of an option; a data value
                 that may accompany a flag, if it is applicable to the
                 given option. For example, many commands accept a
-                "<code>--verbose</code>" option, but typically
+                <command>--verbose</command> option, but typically
                 this option has no parameter. However, an option like
-                "<code>--user</code>" almost always requires
+                <command>--user</command> almost always requires
                 a following parameter.
             </para>
             <para>
                 A parameter may be given as a separate argument following a
                 flag argument, or as part of the same argument string,
-                separated from the flag by an equals symbol ("<code>=</code>").
+                separated from the flag by an equals symbol (<command>=</command>).
                 The latter form is supported only by long flags.
                 For example,
-                <code>-u username</code>, <code>--user username</code>,
-                and <code>--user=username</code> are forms supported
+                <command>-u username</command>, <command>--user username</command>,
+                and <command>--user=username</command> are forms supported
                 by <classname>Zend_Console_Getopt</classname>.
             </para>
         </listitem>
@@ -82,12 +82,12 @@
         </listitem>
     </itemizedlist>
     <para>
-        For example, in "<code>mysql --user=root mydatabase</code>",
-        "<code>mysql</code>" is a <emphasis>command</emphasis>,
-        "<code>--user=root</code>" is an <emphasis>option</emphasis>,
-        "<code>--user</code>" is a <emphasis>flag</emphasis>,
-        "<code>root</code>" is a <emphasis>parameter</emphasis> to the option,
-        and "<code>mydatabase</code>" is an argument but not an option
+        For example, in <command>mysql --user=root mydatabase</command>,
+        <command>mysql</command> is a <emphasis>command</emphasis>,
+        <command>--user=root</command> is an <emphasis>option</emphasis>,
+        <command>--user</command> is a <emphasis>flag</emphasis>,
+        <command>root</command> is a <emphasis>parameter</emphasis> to the option,
+        and <command>mydatabase</command> is an argument but not an option
         by our definition.
     </para>
     <para>

+ 6 - 6
documentation/manual/en/module_specs/Zend_Console_Getopt-Rules.xml

@@ -31,7 +31,7 @@
             This syntax supports only single-character flags. In a single
             string, you type each of the letters that correspond to flags
             supported by your application. A letter followed by a colon
-            character ("<code>:</code>") indicates a flag that requires a
+            character (<emphasis>:</emphasis>) indicates a flag that requires a
             parameter.
         </para>
         <example id="zend.console.getopt.rules.short.example">
@@ -42,8 +42,8 @@ $opts = new Zend_Console_Getopt('abp:');
         </example>
         <para>
             The example above shows using <classname>Zend_Console_Getopt</classname>
-            to declare that options may be given as "<code>-a</code>",
-            "<code>-b</code>", or "<code>-p</code>". The latter flag
+            to declare that options may be given as <command>-a</command>,
+            <command>-b</command>, or <command>-p</command>. The latter flag
             requires a parameter.
         </para>
         <para>
@@ -111,11 +111,11 @@ $opts = new Zend_Console_Getopt(
         </example>
         <para>
             In the example declaration above, there are three options.
-            "<code>--apple</code>" and "<code>-a</code>" are aliases for each
+            <command>--apple</command> and <command>-a</command> are aliases for each
             other, and the option takes no parameter.
-            "<code>--banana</code>" and "<code>-b</code>" are aliases for each
+            <command>--banana</command> and <command>-b</command> are aliases for each
             other, and the option takes a mandatory integer parameter.
-            Finally, "<code>--pear</code>" and "<code>-p</code>" are aliases
+            Finally, <command>--pear</command> and <command>-p</command> are aliases
             for each other, and the option may take an optional string parameter.
         </para>
     </sect2>