cocoon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hu...@apache.org
Subject cvs commit: xml-cocoon2/src/documentation/xdocs/userdocs/generators linkstatus-generator.xml book.xml generators.xml
Date Sun, 30 Jun 2002 16:40:43 GMT
huber       2002/06/30 09:40:43

  Modified:    src/documentation/xdocs/userdocs/generators book.xml
                        generators.xml
  Added:       src/documentation/xdocs/userdocs/generators
                        linkstatus-generator.xml
  Log:
  Simple user documentation of LinkStatusGenerator
  
  Revision  Changes    Path
  1.2       +1 -0      xml-cocoon2/src/documentation/xdocs/userdocs/generators/book.xml
  
  Index: book.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/generators/book.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- book.xml	3 Jan 2002 12:31:04 -0000	1.1
  +++ book.xml	30 Jun 2002 16:40:42 -0000	1.2
  @@ -31,6 +31,7 @@
       <menu-item label="Profile Generator" href="profile-generator.html"/>
       <menu-item label="Error Generator" href="error-generator.html"/>
       <menu-item label="Search Generator" href="search-generator.html"/>
  +    <menu-item label="LinkStatus Generator" href="linkstatus-generator.html"/>
     </menu>
     <menu label="Optional">
       <menu-item label="Php Generator" href="php-generator.html"/>
  
  
  
  1.3       +1 -0      xml-cocoon2/src/documentation/xdocs/userdocs/generators/generators.xml
  
  Index: generators.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/generators/generators.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- generators.xml	30 May 2002 17:47:33 -0000	1.2
  +++ generators.xml	30 Jun 2002 16:40:42 -0000	1.3
  @@ -43,6 +43,7 @@
   				<li><link href="profile-generator.html">Profile Generator</link></li>
   				<li><link href="error-generator.html">Error Generator</link></li>
   				<li><link href="search-generator.html">Search Generator</link></li>
  +				<li><link href="linkstatus-generator.html">LinkStatus Generator</link></li>
   				<li><link href="php-generator.html">Php Generator</link> (optional)</li>
   				<li><link href="xmldb-generator.html">XML:DB Generator</link> (optional)</li>
   				<li><link href="xmldbcollection-generator.html">XML:DB Collection Generator</link>
(optional)</li>
  
  
  
  1.1                  xml-cocoon2/src/documentation/xdocs/userdocs/generators/linkstatus-generator.xml
  
  Index: linkstatus-generator.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" "../../dtd/document-v10.dtd">
  
  <document>
   <header>
    <title>LinkStatus Generator</title>
    <subtitle>in @doctitle@</subtitle>
    <version>0.9</version>
    <type>Technical document</type>
    <authors>
     <person name="Bernhard Huber" email="huber@apache.org"/>
    </authors>
    <abstract>This document describes the LinkStatus generator.</abstract>
   </header>
   <body>
    <s1 title="LinkStatus Generator">
     <p>
      The LinkStatus Generator emits a list of links that are reachable.
     </p>
     <p>
      The LinkStatusGenerator has serveral configuration options.
     </p>
     <dl>
       <dt>include-name</dt>
       <dd>RE pattern for including links
         <br/>
         By default <code>include-name</code> is empty.
       </dd>
       <dt>exclude-name</dt>
       <dd>RE pattern for excluding links.
         <br/>
         By default <code>exclude-name</code> is defined as
         <code>.*\.gif(\?.*)?$,
           .*\.png(\?.*)?$,
           .*\.jpe?g(\?.*)?$,
           .*\.js(\?.*)?$,
           .*\.css(\?.*)?$
         </code>.
       </dd>
       <dt>link-content-type</dt>
       <dd>expected MIME type of xml document requested on view
         <em>link-query-view</em>
         <br/>
         By default <code>link-content-type</code> is set to 
         <code>application/x-cocoon-links</code>.
       </dd>
       <dt>link-view-query</dt>
       <dd>A query-string appended to the crawling URL
         <br/>
         By default <code>link-view-query</code> is set to
         <code>cocoon-view=links</code>.
       </dd>
       <dt>user-agent</dt>
       <dd>HTTP user-agent for requesting links,
         By default <code>user-agent</code> is set to
         value of <code>org.apache.cocoon.Constants.COMPLETE_NAME</code>,
         ie. <code>Apache Cocoon 2.1-dev</code>
       </dd>
       <dt>accept</dt>
       <dd>Not currently used</dd>
     </dl>
     <ul>
      <li>Name : linkStatus</li>
      <li>Class: org.apache.cocoon.generation.LinkStatusGenerator</li>
      <li>Cacheable: no.</li>
     </ul>
     <p>
      A simple example might help to use the LinkStatusGenerator effectivly:
     </p>
     <p>
      Add the LinkStatusGenerator to the components in your sitemap.xmap
     </p>
  <source><![CDATA[
  ...
  <map:components>
  ...
    <map:generators default="file">
    ...
      <map:generator name="linkStatus"
        src="org.apache.cocoon.generation.LinkStatusGenerator"/>
    </map:generators>
    <map:serialize default="html">
      <map:serializer name="links"
        src="org.apache.cocoon.serialization.LinkSerializer"/>
    </map:serialize>
  </map:components>
  <map:views>
    <map:view>
      <map:view from-position="last" name="links">
        <map:serialize type="links"/>
      </map:view>
      ...
  </map:view>
  ]]></source>
     <p>
       Next define in your pipeline to use the LinkStatusGenerator
     </p>
  <source><![CDATA[
  <map:match pattern="/linkStatus">
    <map:generate type="linkStatus" name="my-root"/>
    ...
    <map:serialize/>
  </map:match>
  ]]></source>
  
    </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


Mime
View raw message