svn commit: r533134 - in /lenya/docu/src/documentation/content/xdocs/docs/modules: languageselector/index.xml lucene/index.xml

[an...@apache.org]

Author: andreas
Date: Fri Apr 27 08:15:53 2007
New Revision: 533134

URL: http://svn.apache.org/viewvc?view=rev&rev=533134
Log:
Added more docs about languageselector and lucene module

Modified:
    lenya/docu/src/documentation/content/xdocs/docs/modules/languageselector/index.xml
    lenya/docu/src/documentation/content/xdocs/docs/modules/lucene/index.xml

Modified: lenya/docu/src/documentation/content/xdocs/docs/modules/languageselector/index.xml
URL: http://svn.apache.org/viewvc/lenya/docu/src/documentation/content/xdocs/docs/modules/languageselector/index.xml?view=diff&rev=533134&r1=533133&r2=533134
==============================================================================
--- lenya/docu/src/documentation/content/xdocs/docs/modules/languageselector/index.xml (original)
+++ lenya/docu/src/documentation/content/xdocs/docs/modules/languageselector/index.xml Fri Apr 27 08:15:53 2007
@@ -31,5 +31,15 @@
         XHTML widget to switch languages on a website.
       </p>
     </section>
+    <section>
+      <title>Adding Custom Flags</title>
+      <p>
+        More flags can be obtained from 
+        <a href="http://en.wikipedia.org/wiki/Gallery_of_sovereign_state_flags">Wikipedia</a>.
+      </p>
+      <p>
+        Be sure to rename them according to <code><![CDATA[<two-letter-language-code>.svg]]></code>.
+      </p>
+    </section>
   </body>
 </document>

Modified: lenya/docu/src/documentation/content/xdocs/docs/modules/lucene/index.xml
URL: http://svn.apache.org/viewvc/lenya/docu/src/documentation/content/xdocs/docs/modules/lucene/index.xml?view=diff&rev=533134&r1=533133&r2=533134
==============================================================================
--- lenya/docu/src/documentation/content/xdocs/docs/modules/lucene/index.xml (original)
+++ lenya/docu/src/documentation/content/xdocs/docs/modules/lucene/index.xml Fri Apr 27 08:15:53 2007
@@ -30,5 +30,41 @@
         The <code>lucene</code> module integrates the Lucene search engine.
       </p>
     </section>
+    
+    <section>
+      <title>Configuration</title>
+      <p>
+        Each publication has a configuration at <code>$PUB_HOME/config/search/lucene_index.xml</code>
+        which is being defined by
+        <code>org.pache.cocoon.components.search.components.impl.IndexManagerImpl</code>.
+      </p>
+    </section>
+    
+    <section>
+      <title>Indexing</title>
+      <p>
+        Indexing is typically triggered by the <code>org.apache.lenya.cms.lucene.IndexUpdaterImpl</code>,
+        which attaches itself as a listener to the repository on startup.
+      </p>
+      <p>
+        Indexing can also be executed explicitely by calling the <code>lucene.index</code>
+        usecase which is defined
+        by <code>config/cocoon-xconf/usecase-lucene.index.xconf</code> and uses as main
+        entry point <code>org.apache.lenya.cms.lucene.IndexDocument</code>.
+      </p>
+      <p>
+        In order to make a resource type indexable one needs to add the format luceneIndex to the
+        resource type configuration (e.g. <code>src/modules/xhtml/config/cocoon-xconf/resource-type-xhtml.xconf</code>)
+        One needs to create or reuse a pipeline for this format within the specified sitemap.
+      </p>
+    </section>
+    
+    <section>
+      <title>Searching</title>
+      <p>
+        To be documented.
+      </p>
+      
+    </section>
   </body>
 </document>



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@lenya.apache.org
For additional commands, e-mail: commits-help@lenya.apache.org