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/09/17 09:02:29 UTC
cvs commit: xml-cocoon2/xdocs mail-lists.xml request.xml uc2.xml xsp-internals.xml xsp.xml
cziegeler 01/09/17 00:02:29
Modified: xdocs mail-lists.xml request.xml uc2.xml
xsp-internals.xml xsp.xml
Log:
Patch for making docs compliant to document-v10.dtd
Submitted by: Marcelo F. Ochoa (mochoa@ieee.org)
Revision Changes Path
1.5 +1 -1 xml-cocoon2/xdocs/mail-lists.xml
Index: mail-lists.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/xdocs/mail-lists.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- mail-lists.xml 2001/07/19 14:20:23 1.4
+++ mail-lists.xml 2001/09/17 07:02:29 1.5
@@ -59,7 +59,7 @@
<p>If you would like to make commercial solicitations, please ask permission from
one of the list moderators (currently <link href="mailto:greenrd@hotmail.com">
- Robin Green</link> and <link href="pati_giacomo@yahoo.com">Giacomo Pati</link>)
+ Robin Green</link> and <link href="mailto:pati_giacomo@yahoo.com">Giacomo Pati</link>)
<strong>prior</strong> to doing so.</p>
<note>This list is moderated, so the first time you post, there will be a
1.6 +2 -2 xml-cocoon2/xdocs/request.xml
Index: request.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/xdocs/request.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- request.xml 2001/07/22 20:16:06 1.5
+++ request.xml 2001/09/17 07:02:29 1.6
@@ -50,7 +50,7 @@
]]></source>
<p>You may then use any of the elements in the <em>request</em> namespace described
-in the <link href="request.html#elements">Elements Reference</link> section below.</p>
+in the <link href="request.html#id_el">Elements Reference</link> section below.</p>
</s1>
@@ -139,7 +139,7 @@
</s1>
-<anchor id="elements"/>
+<anchor id="id_el"/>
<s1 title="Elements Reference">
<p>All Request elements which require or allow for additional information allow
1.9 +19 -20 xml-cocoon2/xdocs/uc2.xml
Index: uc2.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/xdocs/uc2.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- uc2.xml 2001/08/14 14:44:33 1.8
+++ uc2.xml 2001/09/17 07:02:29 1.9
@@ -1,10 +1,9 @@
<?xml version="1.0"?>
-<!--
<!DOCTYPE document SYSTEM "./dtd/document-v10.dtd">
--->
<document>
<header>
<title>Understanding @Name@</title>
+ <subtitle>Understanding @Name@ Architecture</subtitle>
<authors>
<person name="Pankaj Kumar" email="pankaj_kumar@hp.com"/>
<person name="Davanum Srinivas" email="dims@yahoo.com"/>
@@ -71,33 +70,33 @@
<s1 title="Prerequisites">
<p>What You Should know:</p>
<ul>
- <li>XML, XML Namespaces</li>
- <li>Basics of XPath, XSLT</li>
- <li>Java language</li>
- <li>Servlets, HTTP</li>
+ <li>XML, XML Namespaces</li>
+ <li>Basics of XPath, XSLT</li>
+ <li>Java language</li>
+ <li>Servlets, HTTP</li>
</ul>
<p>What You need not know:</p>
<ul>
- <li>@docname@ 1</li>
+ <li>@docname@ 1</li>
</ul>
</s1>
<anchor id="a-little-history"/>
<s1 title="A Little History">
<s2 title="@docname@1">
<ul>
- <li>@docname@ project was founded in Jan. 1999 by Stefano Mazzocchi as an open source project under Apache Software Foundation.</li>
- <li>Started as a simple servlet for XSL styling of XML content.</li>
- <li>Was based on DOM level 1 API. This choice turned out to be quite limiting for speed/memory efficiency.</li>
- <li>Used reactor pattern to connect components. This allowed the reaction instructions to be placed inside the documents. Though appealing, it caused difficulties in managing highly dynamic web-sites.</li>
- <li>Allowed context overlap to happen by having processing instructions in documents/stylesheets.</li>
+ <li>@docname@ project was founded in Jan. 1999 by Stefano Mazzocchi as an open source project under Apache Software Foundation.</li>
+ <li>Started as a simple servlet for XSL styling of XML content.</li>
+ <li>Was based on DOM level 1 API. This choice turned out to be quite limiting for speed/memory efficiency.</li>
+ <li>Used reactor pattern to connect components. This allowed the reaction instructions to be placed inside the documents. Though appealing, it caused difficulties in managing highly dynamic web-sites.</li>
+ <li>Allowed context overlap to happen by having processing instructions in documents/stylesheets.</li>
</ul>
</s2>
<s2 title="@doctitle@">
<ul>
- <li>A separate codebase to incorporate @docname@1 learnings.</li>
- <li>Designed for execution speed/memory efficiency and scalability to process very large documents by switching processing model from DOM to SAX.</li>
- <li>Centralizes the management functions by allowing processing pipeline specification in a sitemap (an XML file), replacing the embedded processing instruction model.</li>
- <li>Better support for pre-compilation, pre-generation and caching for better performance.</li>
+ <li>A separate codebase to incorporate @docname@1 learnings.</li>
+ <li>Designed for execution speed/memory efficiency and scalability to process very large documents by switching processing model from DOM to SAX.</li>
+ <li>Centralizes the management functions by allowing processing pipeline specification in a sitemap (an XML file), replacing the embedded processing instruction model.</li>
+ <li>Better support for pre-compilation, pre-generation and caching for better performance.</li>
</ul>
</s2>
</s1>
@@ -123,8 +122,8 @@
</ul>
<figure src="images/basic-mechanism.gif" alt="Basic Mechanisms"/>
<s2 title="Pipeline Processing">
- <li>Sequence of Interactions<figure src="images/interaction-sequence.gif" alt="Interaction Sequence"/></li>
- <li>Pipeline<figure src="images/pipeline.gif" alt="Pipeline"/></li>
+ <p>Sequence of Interactions</p><figure src="images/interaction-sequence.gif" alt="Interaction Sequence"/>
+ <p>Pipeline</p><figure src="images/pipeline.gif" alt="Pipeline"/>
</s2>
</s1>
<anchor id="c2-architecture"/>
@@ -509,8 +508,8 @@
</ul>
<p>@docname@ keeps the generated .java files in a directory tree
- starting at (by default):</p>
- <code>$TOMCAT_HOME/webapps/work/localhost_8080%2Fcocoon/org/apache/cocoon/www</code>.
+ starting at (by default):<br/>
+ <code>$TOMCAT_HOME/webapps/work/localhost_8080%2Fcocoon/org/apache/cocoon/www</code>.</p>
<p>You can find sitemap_xmap.java here.</p>
1.6 +34 -36 xml-cocoon2/xdocs/xsp-internals.xml
Index: xsp-internals.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/xdocs/xsp-internals.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- xsp-internals.xml 2001/07/28 03:13:53 1.5
+++ xsp-internals.xml 2001/09/17 07:02:29 1.6
@@ -1,8 +1,6 @@
<?xml version="1.0"?>
-<!--
<!DOCTYPE document SYSTEM "./dtd/document-v10.dtd">
--->
<?xml-stylesheet href="document2html.xsl" type="text/xsl"?>
<document>
@@ -134,7 +132,7 @@
<p>
As a rule, XSP pages are translated into @docname@
<link href="javadocs/org/apache/cocoon/generators/Generator.html">
- <code><em>Generator</em></code>'s.
+ <code>Generator</code>'s.
</link>
</p>
@@ -142,7 +140,7 @@
<p>
<code>Generator</code>'s created by XSP are invoked exclusively through
<link href="javadocs/org/apache/cocoon/generators/ServerPagesGenerator.html">
- <code><em>ServerPagesGenerator</em></code>,
+ <code>ServerPagesGenerator</code>,
</link>
a proxy that uses @docname@'s
<jump anchor="program-generator"><code>ProgramGenerator</code></jump>
@@ -285,8 +283,8 @@
<p>
<code>AbstractServerPage</code> implements <code>Modifiable</code>
by means of two <em>static</em> variables:
- <code><em>dateCreated</em></code> and
- <code><em>dependencies</em></code> (a, possibly empty, array of
+ <code>dateCreated</code> and
+ <code>dependencies</code> (a, possibly empty, array of
<code>File</code>'s pointing to logicsheets and other files included
during the code generation stage).
</p>
@@ -323,29 +321,29 @@
</p>
<ul>
- <li><code><em>load</em></code>.
+ <li><code>load</code>.
Load a program from a file in a given directory,
compiling it, if necessary, using a given encoding.
</li>
- <li><code><em>instantiate</em></code>
+ <li><code>instantiate</code>
Create a new instance of a previously loaded program
</li>
- <li><code><em>unload</em></code>
+ <li><code>unload</code>
Discard a previously loaded program performing any
necessary cleanup
</li>
- <li><code><em>getSourceExtension</em></code>
+ <li><code>getSourceExtension</code>
Return the canonical source file extension used by
this programming language
</li>
- <li><code><em>getCodeFormatter</em></code>
+ <li><code>getCodeFormatter</code>
Return an (optional) instance of
<link href="javadocs/org/apache/cocoon/components/language/programming/CodeFormatter.html">
<code>CodeFormatter</code>
</link>
used to beautify source code written in this programming language
</li>
- <li><code><em>quoteString</em></code>
+ <li><code>quoteString</code>
Escape a string constant according to the programming language rules
</li>
</ul>
@@ -368,13 +366,13 @@
</p>
<p>
- The <code><em>baseDirectory</em></code> should be an absolute pathname
+ The <code>baseDirectory</code> should be an absolute pathname
pointing to the top-level directory (also known as <em>repository</em>)
containing the program file.
</p>
<p>
- The <code><em>filename</em></code> is a path, <em>relative to the
+ The <code>filename</code> is a path, <em>relative to the
<code>baseDirectory</code></em>, pointing to the program file.
</p>
@@ -633,8 +631,8 @@
<anchor id="object-extension"/>
<s2 title="Object Extensions">
- All compiled languages are required to return a <em>source extension</em>.
- This extension is used to locate object files for subsequent loading.
+ <p>All compiled languages are required to return a <em>source extension</em>.
+ This extension is used to locate object files for subsequent loading.</p>
</s2>
<anchor id="object-load"/>
@@ -907,11 +905,11 @@
<li>NetRexx</li>
<li>Jacl</li>
<li>JPython</li>
- <li>VBScript</li> (Win32 only)
- <li>JScript</li> (Win32 only)
- <li>PerlScript</li> (Win32 only)
- <li>BML</li> (Not applicable to server pages)
- <li>LotusXSL</li> (Not applicable to server pages)
+ <li>VBScript (Win32 only)</li>
+ <li>JScript (Win32 only)</li>
+ <li>PerlScript (Win32 only)</li>
+ <li>BML (Not applicable to server pages)</li>
+ <li>LotusXSL (Not applicable to server pages)</li>
</ul>
<note>
@@ -1123,9 +1121,9 @@
<s2 title="Named Logicsheets">
<p>
As explained in
- <jump href="logicsheet-concepts.html" anchor="logicsheet-object">
+ <link href="logicsheet-concepts.html#logicsheet-object">
Logicsheet Concepts,
- </jump>
+ </link>
logicsheets are typically associated with a single object type whose
methods it wraps to make them available as
<em>markup commands</em>.
@@ -1139,9 +1137,9 @@
<p>
Class
<link href="javadocs/org/apache/cocoon/components/language/markup/NamedLogicsheet.html">
- <code>NamedLogicsheet</code>
+ <code>NamedLogicsheet</code>
</link>
- extends <code>Logicsheet</code>
+ extends <code>Logicsheet</code>
to associate it with a namespace. This class exposes the following
additional methods:
</p>
@@ -1198,10 +1196,10 @@
<p>
Class
<link
- href="javadocs/org/apache/cocoon/components/language/markup/LogicsheetCodeGenerator.html">
- <code>LogicsheetCodeGenerator</code>
+ href="javadocs/org/apache/cocoon/components/language/markup/LogicsheetCodeGenerator.html">
+ <code>LogicsheetCodeGenerator</code>
</link>
- exposes the following methods:
+ exposes the following methods:
</p>
<ul>
@@ -1218,8 +1216,8 @@
<p>
Though "regular" logicsheets as such do not emit source code,
<code>LogicsheetCodeGenerator</code> expects its <em>last</em>
- stylesheet to produce <em>a single element</em> containing only
- a text node.
+ stylesheet to produce <em>a single element</em> containing only
+ a text node.
</p>
<p>
@@ -1235,8 +1233,8 @@
<note>
<code>LogicsheetCodeGenerator</code> is currently implemented as a
- class. It should be defined as an interface in order to the decouple
- the code generator abstraction from its logicsheet-based implementation.
+ class. It should be defined as an interface in order to the decouple
+ the code generator abstraction from its logicsheet-based implementation.
This would allow for alternative code-generation strategies to
be plugged.
</note>
@@ -1309,9 +1307,9 @@
This section describes how the above described framework is
used to implement XSP in particular. For a description of
logicsheet authoring requirements for XSP in Java, see
- <jump href="logicsheet-concepts" anchor="java-logicsheets">
+ <link href="logicsheet-concepts#java-logicsheets">
XSLT Logicsheets and XSP for Java.
- </jump>
+ </link>
</p>
@@ -1326,13 +1324,13 @@
<anchor id="xsp-encoding"/>
<s2 title="Markup Encoding">
- Method <code>getEncoding</code> is implemented by class
+ <p>Method <code>getEncoding</code> is implemented by class
<link
href="javadocs/org/apache/cocoon/components/language/markup/xsp/XSPMarkupLanguage.html">
<code>XSPMarkupLanguage</code>
</link>
by retrieving the attribute named
- <code>encoding</code> in the root <code><xsp:page></code> element.
+ <code>encoding</code> in the root <code><xsp:page></code> element.</p>
<note>
In absence of a <code><xsp:page></code> root element, the
1.3 +21 -14 xml-cocoon2/xdocs/xsp.xml
Index: xsp.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/xdocs/xsp.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- xsp.xml 2001/07/19 14:20:23 1.2
+++ xsp.xml 2001/09/17 07:02:29 1.3
@@ -1,20 +1,27 @@
<?xml version="1.0"?>
<!DOCTYPE document SYSTEM "dtd/document-v10.dtd">
<document>
+ <header>
+ <title>XSP learning map</title>
+ <authors>
+ <person name="Ricardo Rocha" email="ricardo@apache.org"/>
+ </authors>
+ </header>
+
<body>
- <s1 title="XSP learning map">
- <p>As I find that there is enough information about XSP available (only
- not together), I give you a list of pointers in the sequence you should read
- them.</p>
- <ol>
- <li>Get @doctitle@ <link href="install.html">up and running</link>. Surf
- to <code>[webhost]/cocoon/slides/slides?section=4</code> and following. This
- gives you a first insight in the XSP ground idea.</li>
- <li>Read the XSP Logicsheets page. This tells you how to use and make
- your own XSP logicsheets and XSP pages.</li>
- <li>If you're still hungry for more, read the XSP Internals page. This
- describes how XSP's are handled internally by @docname@.</li>
- </ol>
- </s1>
+ <s1 title="XSP learning map">
+ <p>As I find that there is enough information about XSP available (only
+ not together), I give you a list of pointers in the sequence you should read
+ them.</p>
+ <ol>
+ <li>Get @doctitle@ <link href="installing.html">up and running</link>. Surf
+ to <code>[webhost]/cocoon/slides/slides?section=4</code> and following. This
+ gives you a first insight in the XSP ground idea.</li>
+ <li>Read the XSP Logicsheets page. This tells you how to use and make
+ your own XSP logicsheets and XSP pages.</li>
+ <li>If you're still hungry for more, read the XSP Internals page. This
+ describes how XSP's are handled internally by @docname@.</li>
+ </ol>
+ </s1>
</body>
</document>
----------------------------------------------------------------------
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