Browse Source

[DOCUMENTATION] English:
- manual fixes

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

mikaelkael 16 years ago
parent
commit
979f2f4767

+ 48 - 46
documentation/manual/en/module_specs/Zend_Tool_Project-CreateProject.xml

@@ -4,24 +4,29 @@
 
     <title>Create A Project</title>
 
-    <para>
-        Note: the following examples will assume you have the command line interface of
-        Zend_Tool_Framework available to you.
-    </para>
+    <note>
+        <para>
+            The following examples will assume you have the command line interface of
+            <classname>Zend_Tool_Framework</classname> available to you.
+        </para>
+    </note>
 
-    <para>
-        Note: to issue any of the commands for Zend_Tool_Project with CLI, you must be in the directory
-        where the project was initially created.
-    </para>
+    <note>
+        <para>
+            To issue any of the commands for <classname>Zend_Tool_Project</classname> with
+            <acronym>CLI</acronym>, you must be in the directory where the project was
+            initially created.
+        </para>
+    </note>
 
     <para>
-        To get started with Zend_Tool_Project, you simply need to create a project. Creating a project
-        is simple: go to a place on your filesystem, create a directory, change to that directory, then
-        issue the following command:
+        To get started with <classname>Zend_Tool_Project</classname>, you simply need to create a
+        project. Creating a project is simple: go to a place on your filesystem, create a directory,
+        change to that directory, then issue the following command:
     </para>
 
     <para>
-        <code>/tmp/project$ zf create project</code>
+        <command>/tmp/project$ zf create project</command>
     </para>
 
     <para>
@@ -29,7 +34,7 @@
     </para>
 
     <para>
-        <code>$ zf create project /path/to/non-existent-dir</code>
+        <command>$ zf create project /path/to/non-existent-dir</command>
     </para>
 
     <para>
@@ -37,38 +42,35 @@
         you. As you can see in this table, there is a "Project" provider. The Project provider
         has a couple of actions associated to it, and with those actions a number of options that
         can be used to modify the behavior of the action and provider.
-
-        <table id="zend.tool.project.project-provider-table">
-            <title>Project Provider Options</title>
-            <tgroup cols="4">
-                <thead>
-                    <row>
-                        <entry>Provider Name</entry>
-                        <entry>Available Actions</entry>
-                        <entry>Parameters</entry>
-                        <entry>CLI Usage</entry>
-                    </row>
-                </thead>
-                <tbody>
-                    <row>
-                        <entry>
-                            Project
-                        </entry>
-                        <entry>
-                            Create
-                            Show
-                        </entry>
-                        <entry>
-                            create - [path=null, profile='default']
-                        </entry>
-                        <entry>
-                            zf create project some/path
-                        </entry>
-                    </row>
-                </tbody>
-            </tgroup>
-
-        </table>
-
     </para>
+
+    <table id="zend.tool.project.project-provider-table">
+        <title>Project Provider Options</title>
+        <tgroup cols="4">
+            <thead>
+                <row>
+                    <entry>Provider Name</entry>
+                    <entry>Available Actions</entry>
+                    <entry>Parameters</entry>
+                    <entry><acronym>CLI</acronym> Usage</entry>
+                </row>
+            </thead>
+            <tbody>
+                <row>
+                    <entry>
+                        Project
+                    </entry>
+                    <entry>
+                        Create / Show
+                    </entry>
+                    <entry>
+                        create - [path=null, profile='default']
+                    </entry>
+                    <entry>
+                        <command>zf create project some/path</command>
+                    </entry>
+                </row>
+            </tbody>
+        </tgroup>
+    </table>
 </sect1>

+ 106 - 107
documentation/manual/en/module_specs/Zend_Tool_Project-Providers.xml

@@ -4,112 +4,111 @@
     <title>Zend Tool Project Providers</title>
 
     <para>
-        Below is a table of all of the providers shipped with Zend Tool Project.
-
-        <table id="zend.tool.project.project-provider">
-            <title>Project Provider Options</title>
-            <tgroup cols="4">
-                <thead>
-                    <row>
-                        <entry>Provider Name</entry>
-                        <entry>Available Actions</entry>
-                        <entry>Parameters</entry>
-                        <entry>CLI Usage</entry>
-                    </row>
-                </thead>
-                <tbody>
-                    <row>
-                        <entry>
-                            Controller
-                        </entry>
-                        <entry>
-                            Create
-                        </entry>
-                        <entry>
-                            create - [name, indexActionIncluded=true]
-                        </entry>
-                        <entry>
-                            zf create controller foo
-                        </entry>
-                    </row>
-                    <row>
-                        <entry>
-                            Action
-                        </entry>
-                        <entry>
-                            Create
-                        </entry>
-                        <entry>
-                            create - [name, controllerName=index, viewIncluded=true]
-                        </entry>
-                        <entry>
-                            zf create action bar foo
-                            (OR zf create action --name bar --controlller-name=foo)
-                        </entry>
-                    </row>
-                    <row>
-                        <entry>
-                            Controller
-                        </entry>
-                        <entry>
-                            Create
-                        </entry>
-                        <entry>
-                            create - [name, indexActionIncluded=true]
-                        </entry>
-                        <entry>
-                            zf create controller foo
-                        </entry>
-                    </row>
-                    <row>
-                        <entry>
-                            Profile
-                        </entry>
-                        <entry>
-                            Show
-                        </entry>
-                        <entry>
-                            show - []
-                        </entry>
-                        <entry>
-                            zf show profile
-                        </entry>
-                    </row>
-                    <row>
-                        <entry>
-                            View
-                        </entry>
-                        <entry>
-                            Create
-                        </entry>
-                        <entry>
-                            create - [controllerName,actionNameOrSimpleName]
-                        </entry>
-                        <entry>
-                            zf create view foo bar
-                            (or zf create view -c foo -a bar)
-                        </entry>
-                    </row>
-                    <row>
-                        <entry>
-                            Test
-                        </entry>
-                        <entry>
-                            Create
-                            Enable
-                            Disable
-                        </entry>
-                        <entry>
-                            create - [libraryClassName]
-                        </entry>
-                        <entry>
-                            zf create test My_Foo_Baz
-                            zf disable test
-                            zf enable test
-                        </entry>
-                    </row>
-                </tbody>
-            </tgroup>
-        </table>
+        Below is a table of all of the providers shipped with
+        <classname>Zend_Tool_Project</classname>.
     </para>
+
+    <table id="zend.tool.project.project-provider">
+        <title>Project Provider Options</title>
+        <tgroup cols="4">
+            <thead>
+                <row>
+                    <entry>Provider Name</entry>
+                    <entry>Available Actions</entry>
+                    <entry>Parameters</entry>
+                    <entry><acronym>CLI</acronym> Usage</entry>
+                </row>
+            </thead>
+            <tbody>
+                <row>
+                    <entry>
+                        Controller
+                    </entry>
+                    <entry>
+                        Create
+                    </entry>
+                    <entry>
+                        create - [name, indexActionIncluded=true]
+                    </entry>
+                    <entry>
+                        <command>zf create controller foo</command>
+                    </entry>
+                </row>
+                <row>
+                    <entry>
+                        Action
+                    </entry>
+                    <entry>
+                        Create
+                    </entry>
+                    <entry>
+                        create - [name, controllerName=index, viewIncluded=true]
+                    </entry>
+                    <entry>
+                        <command>zf create action bar foo</command>
+                        (or <command>zf create action --name bar --controlller-name=foo</command>)
+                    </entry>
+                </row>
+                <row>
+                    <entry>
+                        Controller
+                    </entry>
+                    <entry>
+                        Create
+                    </entry>
+                    <entry>
+                        create - [name, indexActionIncluded=true]
+                    </entry>
+                    <entry>
+                        <command>zf create controller foo</command>
+                    </entry>
+                </row>
+                <row>
+                    <entry>
+                        Profile
+                    </entry>
+                    <entry>
+                        Show
+                    </entry>
+                    <entry>
+                        show - []
+                    </entry>
+                    <entry>
+                        <command>zf show profile</command>
+                    </entry>
+                </row>
+                <row>
+                    <entry>
+                        View
+                    </entry>
+                    <entry>
+                        Create
+                    </entry>
+                    <entry>
+                        create - [controllerName,actionNameOrSimpleName]
+                    </entry>
+                    <entry>
+                        <command>zf create view foo bar</command>
+                        (or <command>zf create view -c foo -a bar</command>)
+                    </entry>
+                </row>
+                <row>
+                    <entry>
+                        Test
+                    </entry>
+                    <entry>
+                        Create / Enable / Disable
+                    </entry>
+                    <entry>
+                        create - [libraryClassName]
+                    </entry>
+                    <entry>
+                        <command>zf create test My_Foo_Baz</command> /
+                        <command>zf disable test</command> /
+                        <command>zf enable test</command>
+                    </entry>
+                </row>
+            </tbody>
+        </tgroup>
+    </table>
 </sect1>

+ 22 - 19
documentation/manual/en/module_specs/Zend_Tool_Project.xml

@@ -1,35 +1,38 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- Reviewed: no -->
 <sect1 id="zend.tool.project.introduction">
-    <title>Zend_Tool_Project Introduction</title>
+    <title>Introduction</title>
 
     <para>
-        Zend_Tool_Project builds on and extends the capabilities of Zend_Tool_Framework to that
-        of managing a "project". In general, a "project" is a planned endeavor or an initiative.
-        In the computer world, projects generally are a collection of resources. These resources
-        can be files, directories, databases, schemas, images, styles, and more.
+        <classname>Zend_Tool_Project</classname> builds on and extends the capabilities of
+        <classname>Zend_Tool_Framework</classname> to that of managing a "project". In general, a
+        "project" is a planned endeavor or an initiative. In the computer world, projects generally
+        are a collection of resources. These resources can be files, directories, databases,
+        schemas, images, styles, and more.
     </para>
 
     <para>
-        This same concept applies to Zend Framework projects. In ZF projects, you have controllers,
-        actions, views, models, databases and so on and so forth. In terms of Zend_Tool, we need a
-        way to track these types of resources - thus Zend_Tool_Project.
+        This same concept applies to Zend Framework projects. In Zend Framework projects, you have
+        controllers, actions, views, models, databases and so on and so forth. In terms of
+        <classname>Zend_Tool</classname>, we need a way to track these types of resources - thus
+        <classname>Zend_Tool_Project</classname>.
     </para>
 
     <para>
-        Zend_Tool_Project is capable of tracking project resources throughout the development
-        of a project. So, for example, if in one command you created a controller, and in the next
-        command you wish to create an action within that controller, Zend_Tool_Project is gonna have
-        to <emphasis>know</emphasis> about the controller file you created so that you can (in the next action),
-        be able to append that action to it. This is what keeps our projects up to date and
-        <emphasis>stateful</emphasis>.
+        <classname>Zend_Tool_Project</classname> is capable of tracking project resources throughout
+        the development of a project. So, for example, if in one command you created a controller,
+        and in the next command you wish to create an action within that controller,
+        <classname>Zend_Tool_Project</classname> is gonna have to <emphasis>know</emphasis> about
+        the controller file you created so that you can (in the next action), be able to append that
+        action to it. This is what keeps our projects up to date and <emphasis>stateful</emphasis>.
     </para>
 
     <para>
-        Another important point to understand about projects is that typically, resources are organized
-        in a hierarchical fashion. With that in mind, Zend_Tool_Project is capable of serializing the
-        current project into a internal representation that allows it to keep track of not only
-        <emphasis>what</emphasis> resources are part of a project at any given time, but also
-        <emphasis>where</emphasis> they are in relation to one another.
+        Another important point to understand about projects is that typically, resources are
+        organized in a hierarchical fashion. With that in mind,
+        <classname>Zend_Tool_Project</classname> is capable of serializing the current project into
+        a internal representation that allows it to keep track of not only <emphasis>what</emphasis>
+        resources are part of a project at any given time, but also <emphasis>where</emphasis> they
+        are in relation to one another.
     </para>
 </sect1>