You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by cz...@apache.org on 2001/10/11 11:35:22 UTC
cvs commit: xml-cocoon2/documentation/xdocs tutorial.xml
cziegeler 01/10/11 02:35:22
Modified: documentation/xdocs tutorial.xml
Log:
The patch to tutorial.xml does this ...
- Replaces every mention of "Cocoon" with "@docname@".
(Note that there are also some other xdocs that do not yet use
the replacement tag.)
- Adds a paragraph to the introduction to explain that the
screenshots come from the "tutorial" webapp, which they
can build themselves.
Submitted by: David Crossley [crossley@indexgeo.com.au]
Revision Changes Path
1.2 +40 -29 xml-cocoon2/documentation/xdocs/tutorial.xml
Index: tutorial.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/documentation/xdocs/tutorial.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- tutorial.xml 2001/10/05 07:15:19 1.1
+++ tutorial.xml 2001/10/11 09:35:22 1.2
@@ -13,25 +13,33 @@
<body>
<s1 title="Introduction">
- <p>Cocoon is an XML publishing framework. It allows you to define XML
+ <p>@docname@ is an XML publishing framework. It allows you to define XML
documents and transformations to be applied on it, to eventually
generate a presentation format of your choice (HTML, PDF, SVG, etc.).
- Cocoon also gives you the possibility to have logic in your XML files
+ @docname@ also gives you the possibility to have logic in your XML files
(so that the XML file itself can become dynamically generated).</p>
- <p>Cocoon is developed on top of the Avalon Server Framework, which is a
+ <p>@docname@ is developed on top of the Avalon Server Framework, which is a
stable and scalable framework. You can find out more about Avalon in
this document: (ref: Avalon White Paper). I highly suggest reading
- this white paper as it covers many concepts that are key to Cocoon,
+ this white paper as it covers many concepts that are key to @docname@,
namely Separation of Concerns (SOC) and Inversion of Control (IoC).
It also covers foundational aspects of the Avalon Framework, so you
- can have a better understanding on how Cocoon is structured.</p>
- <p>Cocoon helps you separate out concern areas for web development.
+ can have a better understanding on how @docname@ is structured.</p>
+ <p>@docname@ helps you separate out concern areas for web development.
The areas addressed are Logic, Content, Style, and Management. There
- are different mechanisms for each. In order to learn how to use Cocoon,
- make sure you install it properly. Please consult the appendix for this,
- or the Cocoon site (http://xml.apache.org/cocoon2).</p>
+ are different mechanisms for each.</p>
+ <p>In order to learn how to use @docname@, first make sure that you
+ <link href="installing.html">install</link> it properly, then investigate
+ the many <link href="overview.html#samples">samples</link>.
+ The following screenshots come from the
+ "<code>tutorial</code>" that is provided with @docname@.
+ After you have built the main source as per the installation
+ instructions, you can also do
+ "<code>build tutorialwebapp</code>" to see this tutorial
+ in action.</p>
+
<s2 title="Separating Concerns">
- <p>Apache Cocoon is designed to allow Developers, Business Analysts,
+ <p>@docname@ is designed to allow Developers, Business Analysts,
Designers, and Administrators to work with each other without breaking
the other person's contribution. The problem with using just JSPs, ASPs,
or ColdFusion templates is that all of the look, feel, and logic are
@@ -61,13 +69,13 @@
<s3 title="Designers">
<p>The designer is the person or group of people who are responsible to
provide the final look and feel of a site. The designer does all the
- graphics and HTML code. In Cocoon, they will be working with the
+ graphics and HTML code. In @docname@, they will be working with the
Transformers that take an input and structure it in a final
presentation.</p>
</s3>
<s3 title="Administrators">
<p>The administrator is responsible for the sitemap which maps the URI
- space to the different pipelines in Cocoon. A pipeline is a path from
+ space to the different pipelines in @docname@. A pipeline is a path from
a Generator to a Serializer. This means, that the administrator
decides that all requests for a resource with a ".html"
extension starts out as XML and ends up as HTML. The Administrator
@@ -182,11 +190,13 @@
</s2>
</s1>
<s1 title="Diving In">
- <p>In order to do anything in Cocoon, you will need a sitemap. At this point
+ <p>In order to do anything in @docname@, you will need a sitemap. At this point
we will not go into detail but we will show you how to put an entry in so
you can see your stuff. In most development situations, the sitemap will
be set up for you. Since we want to start with a clean slate, take the
- sitemap that comes with Cocoon's samples and clear out everything under
+ sitemap that comes with @docname@'s
+ <link href="overview.html#samples">samples</link>
+ and clear out everything under
the <code><map:pipelines></code> tag. Next, you will add an entry
in the same location that looks like this:</p>
<source>
@@ -303,8 +313,8 @@
but that it is harder to maintain in the end. You may decide to start
with the direct SQL access at the beginning of a project, and build
the objects later. With that in mind, we will use some functionality
- that Cocoon has built in to make this approach a little easier.
- Cocoon has a group of Database actions that allow you to map form
+ that @docname@ has built in to make this approach a little easier.
+ @docname@ has a group of Database actions that allow you to map form
fields to dynamically created SQL calls. It also has a logicsheet
that makes creating SQL bound pages a little easier.</p>
<p>Our first form is the "Create a Department" form. The
@@ -339,14 +349,14 @@
<p>It is important to note that the "submit" tag is transformed
into an HTML submit button with the name "cocoon-action".
The "cocoon-action" form parameter is a magic value that
- Cocoon uses to select a specific action from a group of actions that
+ @docname@ uses to select a specific action from a group of actions that
only gets executed during that time. You will find that this page
displays correctly, but does not do anything yet. The handler is
where the navigation goes once you click on the
"Create Department" button on the screen. What we are going
to do is create one confirmation page for all the Department and
Employee pages.</p>
- <p>Cocoon has a FormValidatorAction that will take care of ensuring the
+ <p>@docname@ has a FormValidatorAction that will take care of ensuring the
input results are acceptable. It also has the following database
actions for your convenience: DatabaseAddAction, DatabaseUpdateAction,
DatabaseDeleteAction, and DatabaseAuthenticatorAction. We will only
@@ -399,8 +409,8 @@
as form parameter names.
First we tell the Database Actions that we are using the
- "personnel" connection pool we set up in Cocoon.xconf. This
- file should be set up by the site administrator.
+ "personnel" connection pool we set up in <code>cocoon.xconf</code>.
+ This file should be set up by the site administrator.
We also tell the Database Actions the structure of the table
we will be populating. The keys are used to identify which
@@ -703,7 +713,7 @@
queries to process.</li>
</ul>
<s4 title="A Note About Actions">
- <p>Actions are the bread and butter of logic processing in Cocoon.
+ <p>Actions are the bread and butter of logic processing in @docname@.
There are a number of approaches that you can take when developing
Actions. You can create a specific action for each piece of
business logic. This approach is very heavy handed and requires you
@@ -722,9 +732,9 @@
</s2>
<s2 title="Redirects">
<p>Most web developers agree that redirecting a user based on input is a
- valuable and necessary part of web development. In Cocoon there are
+ valuable and necessary part of web development. In @docname@ there are
only two locations where you can issue redirects: the Sitemap and
- Actions. In essence, Cocoon does require you to plan so that redirects
+ Actions. In essence, @docname@ does require you to plan so that redirects
are only used when necessary.</p>
<p>One approach that is good to use is to require all traffic to go
through a URL controlling action. The Action will test to see if the
@@ -775,8 +785,8 @@
</s3>
</s2>
</s1>
- <s1 title="Cocoon Supplied Components">
- <p>Cocoon supplies a number of different Components for your use. The types
+ <s1 title="@docname@ Supplied Components">
+ <p>@docname@ supplies a number of different Components for your use. The types
of Components we will discuss here are Generators, Transformers,
Serializers, Readers, and Actions. This are the important Components that
allow you to do you job.</p>
@@ -831,8 +841,9 @@
FragmentExtractorTransformer (more on that in the transformers
section). The FragmentExtractorTransformer splits an XML document into
smaller parts so you can treat each smaller part as a unique document.
- To see this in action, check out the Cocoon supplied samples and click
- on the SVG Welcome page.</p>
+ To see this in action, check out the @docname@ supplied
+ <link href="overview.html#samples">samples</link>
+ and click on the SVG Welcome page.</p>
<p>This Generator caches the results from the FragmentExtractorTransformer
for quick retrieval later. It is Cacheable, so the fragments are
generated once and the cached version is read from that point
@@ -934,7 +945,7 @@
</s3>
<s3 title="StatusGenerator">
<p>The StatusGenerator is another debug tool. It provides status
- information for the Cocoon engine. The resultant XML is in the
+ information for the @docname@ engine. The resultant XML is in the
following format:</p>
<source>
<![CDATA[
@@ -1029,7 +1040,7 @@
extraction.</p>
</s3>
<s3 title="I18nTransformer">
- <p>This is Cocoon's port of Infozone Group's I18nProcessor. The
+ <p>This is @docname@'s port of Infozone Group's I18nProcessor. The
word i18n is a shorthand for the longer word
"internationalization" (starts with 'i', ends with
'n', and has 18 letters in the middle). The
----------------------------------------------------------------------
In case of troubles, e-mail: webmaster@xml.apache.org
To unsubscribe, e-mail: cocoon-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: cocoon-cvs-help@xml.apache.org