forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From thors...@apache.org
Subject svn commit: r496138 - /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.solr/src/documentation/content/xdocs/index.xml
Date Sun, 14 Jan 2007 20:37:55 GMT
Author: thorsten
Date: Sun Jan 14 12:37:54 2007
New Revision: 496138

URL: http://svn.apache.org/viewvc?view=rev&rev=496138
Log:
adding more explanation to the documentation about contracts and the new solr-add contract.
Adding note to use snippet as tiles.
Restructuring document.

Modified:
    forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.solr/src/documentation/content/xdocs/index.xml

Modified: forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.solr/src/documentation/content/xdocs/index.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.solr/src/documentation/content/xdocs/index.xml?view=diff&rev=496138&r1=496137&r2=496138
==============================================================================
--- forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.solr/src/documentation/content/xdocs/index.xml
(original)
+++ forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.solr/src/documentation/content/xdocs/index.xml
Sun Jan 14 12:37:54 2007
@@ -23,51 +23,37 @@
   <body> 
     <section id="overview">
       <title>Apache Forrest - org.apache.forrest.plugin.output.solr Plugin</title>
-      <p>Generates
+      <p> Generates
         <a href="ext:solr">solr</a> documents from xdos. Further when run with
the
-        dispatcher it provides a GUI to manage your project in solr and a search interface
to
+        dispatcher in static mode it allows you to update a Solr server with the content
of your
+        website at the same time you generate the site (
+        <a href="resolve.contract.html.solr-add">solr-add contract</a>). In dynamic
+        mode (as servlet) it provides a GUI to manage your project in solr (
+        <a href="resolve.contract.html.solr-actionbar">solr-actionbar contract</a>
+        ) and a search interface (
+        <a href="resolve.contract.html.solr-search">solr-search contract</a>)
to
         search your solr server. </p>
     </section>
-    
-    <section id="samples">
-      <title>Samples</title>
-      <p>This section includes links to a number of samples using this plugin. The
plugin is
-        intended to be self documenting through these samples. If you require further help
-        please ask on the user mailing list.</p>
-      
-      <ul>
-        <li>
-          <a href="index.solr">index.solr</a> - the xdocs-to-solrDoc.xsl
-          transforms xdocs to solr docs.</li>
-        <li>
-          <a href="index.solr.add">index.solr.add</a> - surround the solr docs
with an
-          add statement.</li>
-        <li>
-          <a href="index.solr.delete">index.solr.delete</a> - surround the solr
docs with a
-          delete statement.</li>
-        <li>
-          <a href="solr.commit">solr.commit</a> - commit statement for solr.
-        </li>
-        <li>
-          <a href="solr.optimize">solr.optimize</a> - optimize statement for
solr.
-        </li>
-        <li>
-          <a href="index-creation.solr.add">index-creation.solr.add</a> - is
-          generating and adding an "add" statement for solr with the whole site as solr docs
as
-          input. This will index your whole project if you add ".do.html" to the url.</li>
-      </ul>
-      <p>Aboves pages suffixed with
-        <code>.do.html</code> will trigger the underlying statment on the solr
server. We
-        do not link them in this document since the links would be broken on the official
-        document server. This is as well the reason why the gui is deactivated. You can
-        see some <a href="/screenshots.html">screenshots</a> and activate it
by using following snippet.</p>
-      <source><![CDATA[    <forrest:contract name="branding-css-links">
+    <section id="dispatcher">
+      <title>Dispatcher activation</title>
+      <p>You can see some
+        <a href="/screenshots.html">screenshots</a> and activate the different
+        contracts by using following snippets. Explanation given within xml comments.</p>
+      <source><![CDATA[    <!-- default plugin CSS -->
+    <forrest:contract name="branding-css-links">
       <forrest:property name="branding-css-links-input">
         <css url="solr.css" media="screen" theme="Pelt"/>
       </forrest:property>
     </forrest:contract>
+    <!-- In static mode solr-add allows you to update a Solr server with the content of
your
+        website at the same time you generate the site. -->
+    <forrest:contract name="solr-add">
+      <forrest:property name="request">#{$getRequest}</forrest:property>
+    </forrest:contract>
     <forrest:hook name="solr">
       <forrest:hook class="solrSearch">
+      <!--Search interface (solr-search contract) to
+        search your solr server. -->
         <forrest:contract name="solr-search">
           <forrest:property name="contextPath">#{$contextPath}</forrest:property>
           <forrest:property name="hidden">
@@ -80,13 +66,30 @@
           </forrest:property>
         </forrest:contract>
       </forrest:hook>
-      <forrest:hook class="solrActionbar">
-        <forrest:contract name="solr-actionbar">
-          <forrest:property name="request">#{$getRequest}</forrest:property>
-          <forrest:property name="contextPath">#{$contextPath}</forrest:property>
-        </forrest:contract>
-      </forrest:hook>
-    </forrest:hook>]]> </source>
+      <!-- If the userAgent is the cocoon crawler then we do not want to 
+      output the actionbar. The cocoon crawler does not provide the request
+      header "User-Agent".-->
+      <!-- HEADSUP 
+        The jx:set var="userAgent" must be defined in the main structurer
+        and cannot go into a tiles! -->
+      <jx:set var="userAgent" value="${cocoon.request.getHeader('User-Agent')}"/>
+      <jx:if test="${!userAgent.equals('')&amp;null!=userAgent}">
+        <forrest:hook class="solrActionbar">
+        <!-- GUI to manage your project in solr. -->
+          <forrest:contract name="solr-actionbar">
+            <forrest:property name="request">#{$getRequest}</forrest:property>
+            <forrest:property name="contextPath">
+              #{$contextPath}</forrest:property>
+          </forrest:contract>
+        </forrest:hook>
+      </jx:if>
+    </forrest:hook>]]> </source> 
+      <p>You can as well use the above aggregated to a tiles, like (make sure you copy
both lines!):</p>
+      <source><![CDATA[<jx:set var="userAgent" value="${cocoon.request.getHeader('User-Agent')}"/>
+<jx:import uri="cocoon://prepare.tiles.solrbar"/>]]></source>
+    </section>
+    <section id="solr">
+      <title>Solr activation</title>
       <p>The host server urls can be configured by adding the following properties
to your
         project forrest.properties.xml in case you do not use the default values.</p>
       <source><![CDATA[<property name="solr.select.url" value="http://localhost:8983/solr/select"/>
@@ -100,6 +103,39 @@
 <field name="abstract" type="text" indexed="true" stored="true"/>
 <field name="version" type="text" indexed="true" stored="true"/>
 <field name="author" type="text" indexed="true" stored="true" multiValued="true"/>]]>
</source>
+    </section>
+    <section id="samples">
+      <title>Samples</title>
+      <p>This section includes links to a number of samples using this plugin. The
plugin is
+        intended to be self documenting through these samples. If you require further help
+        please ask on the user mailing list.</p>
+      
+      <ul>
+        <li>
+          <a href="index.solr">index.solr</a> - the xdocs-to-solrDoc.xsl
+          transforms xdocs to solr docs.</li>
+        <li>
+          <a href="index.solr.add">index.solr.add</a> - surround the solr docs
with an
+          add statement.</li>
+        <li>
+          <a href="index.solr.delete">index.solr.delete</a> - surround the solr
docs id with a
+          delete statement.</li>
+        <li>
+          <a href="solr.commit">solr.commit</a> - commit statement for solr.
+        </li>
+        <li>
+          <a href="solr.optimize">solr.optimize</a> - optimize statement for
solr.
+        </li>
+        <li>
+          <a href="index-creation.solr.add">index-creation.solr.add</a> - is
+          generating and adding an "add" statement for solr with the whole site as solr docs
as
+          input. This will index your whole project if you add ".do.html" to the url.</li>
+      </ul>
+      <p>Aboves pages suffixed with
+        <code>.do.html</code> will trigger the underlying statment on the solr
server. We
+        do not link them in this document since the links would be crawled. This is as well
the
+        reason why the gui is deactivated. Each the gui would trigger the delete,
+        add, commit and optimze statement against the solr server for every page.</p>
     </section>
   </body>
 </document>



Mime
View raw message