You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by sh...@apache.org on 2002/11/16 00:34:30 UTC

cvs commit: xml-cocoon2/src/documentation/xdocs/userdocs/transformers sourcewriting-transformer.xml

shannon     2002/11/15 15:34:29

  Modified:    src/documentation/xdocs performancetips.xml
               src/documentation/xdocs/userdocs/concepts sitemap.xml
               src/documentation/xdocs/userdocs/xsp logicsheet-forms.xml
               src/documentation/xdocs/userdocs/transformers
                        sourcewriting-transformer.xml
  Log:
  Fixed doc-v10 validation issues
  to facilitate doc-v11 transition.
  
  Revision  Changes    Path
  1.10      +2 -4      xml-cocoon2/src/documentation/xdocs/performancetips.xml
  
  Index: performancetips.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/performancetips.xml,v
  retrieving revision 1.9
  retrieving revision 1.10
  diff -u -r1.9 -r1.10
  --- performancetips.xml	13 Oct 2002 15:09:54 -0000	1.9
  +++ performancetips.xml	15 Nov 2002 23:34:28 -0000	1.10
  @@ -95,7 +95,7 @@
        10% could be achieved (unscientifical observations, do your own
        test).</li>
        
  -     <li>
  +   </ul>
        	<p>
        	Utilize the pipeline <code>expires</code> parameter to dramatically reduce
        	redundand requests. Even the most dynamic application pages have a 
  @@ -137,9 +137,7 @@
   		 load the page with the browser. Notice that after the first time, there are no 
   		 access records in the server logs until the specified time expires.
        	</p>
  -     	
  -     </li>
  -   </ul>
  +
    </s1>
    
    <s1 title="JVM and OS">
  
  
  
  1.13      +0 -3      xml-cocoon2/src/documentation/xdocs/userdocs/concepts/sitemap.xml
  
  Index: sitemap.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/concepts/sitemap.xml,v
  retrieving revision 1.12
  retrieving revision 1.13
  diff -u -r1.12 -r1.13
  --- sitemap.xml	15 Nov 2002 13:36:23 -0000	1.12
  +++ sitemap.xml	15 Nov 2002 23:34:29 -0000	1.13
  @@ -713,8 +713,6 @@
   </map:pipeline> ]]></source>
       </s2>
       <s2 title="Mounting sitemaps">
  -    <br/> <!-- FIXME: Otherwise s2 and s3 will appear on same line -->
  -     <s3 title="Introduction">
       <p>
          Mount points allow sitemaps to be cascaded and site management
          workload to be parallelized. This creates a tree of sitemaps with
  @@ -750,7 +748,6 @@
        structure as the sitemaps are and thus knows which are their parent 
        SitemapComponentManager and can ask it for a SitemapComponent it doesn't know about.
        </p>
  -    </s3>
       <s3 title="Use Cases">
        <p>
        Usually you use the same SitemapComponents over and over again in your sub-sitemaps. 
  
  
  
  1.4       +3 -3      xml-cocoon2/src/documentation/xdocs/userdocs/xsp/logicsheet-forms.xml
  
  Index: logicsheet-forms.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/xsp/logicsheet-forms.xml,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- logicsheet-forms.xml	3 Sep 2002 04:24:57 -0000	1.3
  +++ logicsheet-forms.xml	15 Nov 2002 23:34:29 -0000	1.4
  @@ -129,13 +129,13 @@
       <s3 title="The types recognized by validator and their attributes"/>
       <table>
        <tr>
  -      <td><b>string</b></td><td>nullable="yes|no" default="str"</td>
  +      <td><strong>string</strong></td><td>nullable="yes|no" default="str"</td>
        </tr>
        <tr>
  -      <td><b>long</b></td><td>nullable="yes|no" default="123123"</td>
  +      <td><strong>long</strong></td><td>nullable="yes|no" default="123123"</td>
        </tr>
        <tr>
  -      <td><b>double</b></td><td>nullable="yes|no" default="0.5"</td>
  +      <td><strong>double</strong></td><td>nullable="yes|no" default="0.5"</td>
        </tr>
       </table>
   
  
  
  
  1.3       +7 -28     xml-cocoon2/src/documentation/xdocs/userdocs/transformers/sourcewriting-transformer.xml
  
  Index: sourcewriting-transformer.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/transformers/sourcewriting-transformer.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- sourcewriting-transformer.xml	10 Jul 2002 18:55:49 -0000	1.2
  +++ sourcewriting-transformer.xml	15 Nov 2002 23:34:29 -0000	1.3
  @@ -24,7 +24,6 @@
   			<note>Please beware of putting these samples on a public-facing server.</note>
   		</s1>
   		<s1 title="The Tags">
  -			<p>
   				<source>
   					<![CDATA[
   		<source:write>
  @@ -42,12 +41,10 @@
   		</source:insert>
   					]]>
   				</source>
  -			</p>
   			<p>In the namespace <code>xmlns:source="http://apache.org/cocoon/source/1.0"</code>.</p>
   			<p>The contents of the <code><![CDATA[<source:fragment/>]]></code> tag are written to the specified WriteableSource when the document containing it is transformed by SourceWritingTransformer.</p>
   		</s1>
   		<s1 title="Definition">
  -			<p>
   				<source>
   					<![CDATA[
    <map:transformer name="write-source" 
  @@ -56,20 +53,16 @@
    </map:transformer/>
   					]]>
   				</source>
  -			</p>
   			<p>The SourceWritingTransformer is predefined for you in the main SiteMap.</p>
   		</s1>
   		<s1 title="Invocation">
   			<p>This invokes the SourceWritingTransformer on your pipeline.</p>
  -			<p>
   				<source>
   					<![CDATA[
    <map:transform type="write-source"/>
   					]]>
   				</source>
  -			</p>
   			<p>Or you can over-ride the default serializer here.</p>
  -			<p>
   				<source>
   					<![CDATA[
    <map:transform type="write-source">
  @@ -77,7 +70,6 @@
    </map:transform>
   					]]>
   				</source>
  -			</p>
   		</s1>
   
   		<s1 title="The Tags in detail">
  @@ -91,7 +83,7 @@
   				</s3>
   				<s3 title="source:fragment">
   					<p>The XML Fragment to be written.</p>
  -					<p>eg: 
  +					<p>eg: </p>
   						<source>
   							<![CDATA[
   	<source:fragment><foo>
  @@ -99,7 +91,7 @@
   		</foo></source:fragment>
   							]]>
   						</source> 
  -						or
  +						<p>or</p>
   						<source>
   							<![CDATA[
   	<source:fragment>
  @@ -110,8 +102,8 @@
   	</source:fragment>
   							]]>
   						</source> 
  -						etc.
  -					</p>
  +						<p>etc.</p>
  +
   					<note>The second example type, can only be used when the <code><![CDATA[<source:path/>]]></code> tag has been specified.</note>
   				</s3>
   				<s3 title="source:path">
  @@ -131,7 +123,7 @@
   				</s3>
   				<s3 title="source:fragment">
   					<p>The XML Fragment to be written.</p>
  -					<p>eg: 
  +					<p>eg:</p>
   						<source>
   							<![CDATA[
   	<source:fragment>
  @@ -141,7 +133,7 @@
   	</source:fragment>
   							]]>
   						</source> 
  -						or
  +						<p>or</p>
   						<source>
   							<![CDATA[
   	<source:fragment>
  @@ -152,8 +144,7 @@
   	</source:fragment>
   							]]>
   						</source> 
  -						etc.
  -					</p>
  +						<p>etc.</p>
   				</s3>
   				<s3 title="source:path">
   					<p></p>
  @@ -170,7 +161,6 @@
   				</s3>
    			</s2>
   			<s2 title="Notes">
  -				<p>
   					<ul>
   						<li>if 'replace' is not specified, your 'fragment' is appended as a child of 'path'.</li>
   						<li>if 'replace' is specified and it exists and 'overwrite' is true, your 'fragment' is inserted in 'path', before 'replace' and then 'replace' is deleted.</li>
  @@ -179,13 +169,11 @@
   						<li>if 'replace' is specified and it does not exist and 'overwrite' is false, your 'fragment' is appended as a child of 'path'.</li>
   						<li>if 'reinsert' is specified and it does not exist, no action occurs.</li>
   					</ul>
  -				</p>
   			</s2>
   		</s1>
   		
   		<s1 title="Examples">
   			<s2 title="Simple Write">
  -				<p>
   					<source>
   						<![CDATA[
    <page>
  @@ -203,10 +191,8 @@
    </page>
   						]]>
   					</source>
  -				</p>
   			</s2>
   			<s2 title="Insert at end">
  -				<p>
   					<source>
   						<![CDATA[
    <page>
  @@ -223,10 +209,8 @@
    </page>
   						]]>
   					</source>
  -				</p>
   			</s2>
   			<s2 title="Replace">
  -				<p>
   					<source>
   						<![CDATA[
    <page>
  @@ -243,10 +227,8 @@
    </page>
   						]]>
   					</source>
  -				</p>
   			</s2>
   			<s2 title="Insert at the beginning">
  -				<p>
   					<source>
   						<![CDATA[
    <page>
  @@ -268,11 +250,9 @@
   					</source>
   					<p>This sample does not currently work, see the tests in the scratchpad at <code>http://localhost:8080/cocoon/mount/editor/tests</code>.</p>
   					<note>You must have built Cocoon with the scratchpad included for this link to work.</note>
  -				</p>
   			</s2>
   			<s2 title="Sample of the output of these tags">
   				<p>This is the kind of information that the <code>SourceWritingTransformer</code> outputs to the pipeline, replacing the original <code>source:write</code> and <code>source:insert</code> tags</p>
  -				<p>
   					<source>
   						<![CDATA[
    <page>
  @@ -289,7 +269,6 @@
    </page>
   						]]>
   					</source>
  -				</p>
   			</s2>
   		</s1>
   		<s1 title="Known Problems">
  
  
  

----------------------------------------------------------------------
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


new build target validate-xdocs

Posted by David Crossley <cr...@indexgeo.com.au>.
Enough - my itches have turned into a rash.

Once too often i saw people correcting the simple validation
errors of other people. So i have added a new build target
called "validate-xdocs" which uses Ant to conduct build-time
validation via the DTDs.

As with the "validate-config" target, it is not yet hooked
up into the main build. So for now do:
./build.sh validate-xdocs

--David

shannon@apache.org wrote:
> shannon     2002/11/15 15:34:29
> 
>   Modified:    src/documentation/xdocs performancetips.xml
>                src/documentation/xdocs/userdocs/concepts sitemap.xml
>                src/documentation/xdocs/userdocs/xsp logicsheet-forms.xml
>                src/documentation/xdocs/userdocs/transformers
>                         sourcewriting-transformer.xml
>   Log:
>   Fixed doc-v10 validation issues
>   to facilitate doc-v11 transition.
<snip/>


---------------------------------------------------------------------
To unsubscribe, e-mail: cocoon-dev-unsubscribe@xml.apache.org
For additional commands, email: cocoon-dev-help@xml.apache.org