You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@manifoldcf.apache.org by kw...@apache.org on 2011/09/09 13:39:32 UTC
svn commit: r1167110 - in /incubator/lcf/trunk: ./
site/src/documentation/content/xdocs/
site/src/documentation/resources/images/
Author: kwright
Date: Fri Sep 9 11:39:32 2011
New Revision: 1167110
URL: http://svn.apache.org/viewvc?rev=1167110&view=rev
Log:
Fix for CONNECTORS-240. Include end-user documentation for OpenSearchServer.
Added:
incubator/lcf/trunk/site/src/documentation/resources/images/opensearchserver-connection-parameters.PNG (with props)
incubator/lcf/trunk/site/src/documentation/resources/images/opensearchserver-history-report.PNG (with props)
incubator/lcf/trunk/site/src/documentation/resources/images/opensearchserver-job-parameters.PNG (with props)
incubator/lcf/trunk/site/src/documentation/resources/images/opensearchserver-user.PNG (with props)
Modified:
incubator/lcf/trunk/CHANGES.txt
incubator/lcf/trunk/site/src/documentation/content/xdocs/end-user-documentation.xml
Modified: incubator/lcf/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/CHANGES.txt?rev=1167110&r1=1167109&r2=1167110&view=diff
==============================================================================
--- incubator/lcf/trunk/CHANGES.txt (original)
+++ incubator/lcf/trunk/CHANGES.txt Fri Sep 9 11:39:32 2011
@@ -8,6 +8,9 @@ CONNECTORS-252: Clean up build, dist and
======================= Release 0.3 =========================
+CONNECTORS-240: Add OpenSearchServer end-user documentation.
+(Emmanuel Keller, Karl Wright)
+
CONNECTORS-250: Renew jcifs download site link.
(Shinichiro Abe)
Modified: incubator/lcf/trunk/site/src/documentation/content/xdocs/end-user-documentation.xml
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/site/src/documentation/content/xdocs/end-user-documentation.xml?rev=1167110&r1=1167109&r2=1167110&view=diff
==============================================================================
--- incubator/lcf/trunk/site/src/documentation/content/xdocs/end-user-documentation.xml (original)
+++ incubator/lcf/trunk/site/src/documentation/content/xdocs/end-user-documentation.xml Fri Sep 9 11:39:32 2011
@@ -475,8 +475,31 @@
<section id="osssoutputconnector">
<title>OpenSearchServer Output Connection</title>
- <p>The OpenSearchServer Output Connection allow ManifoldCF to submit documents to an OpenSearchServer instance, via the XML over HTTP API.</p>
- <p>You may also refer to the <a href="http://www.open-search-server.com/documentation">OpenSearchServer's user documentation</a>.</p>
+ <p>The OpenSearchServer Output Connection allow ManifoldCF to submit documents to an OpenSearchServer instance, via the XML over HTTP API. The connector has been designed
+ to be as easy to use as possible.</p>
+ <p>After creating an OpenSearchServer ouput connection, you have to populate the parameters tab. Fill in the fields according your OpenSearchServer configuration. Each
+ OpenSearchServer output connector instance works with one index. To work with muliple indexes, just create one output connector for each index.</p>
+ <figure src="images/opensearchserver-connection-parameters.PNG" alt="OpenSearchServer, parameters tab" width="80%"/>
+ <p>The parameters are:</p><br/>
+ <ul>
+ <li>Server location: An URL that references your OpenSearchServer instance. The default value (http://localhost:8080) is valid if your OpenSearchServer instance runs
+ on the same server than the ManifoldCF instance.</li>
+ <li>Index name: The connector will populate the index defined here.</li>
+ <li>User name and API Key: The credentials required to connect to the OpenSearchServer instance. It can be left empty if no user has been created. The next figure shows
+ where to find the user's informations in the OpenSearchServer user interface.</li>
+ </ul>
+ <figure src="images/opensearchserver-user.PNG" alt="OpenSearchServer, user configuration" width="80%"/>
+ <p>Once you created a new job, having selected the OpenSearchServer output connector, you will have the OpenSearchServer tab. This tab let you:</p><br/>
+ <ul>
+ <li>Fix the maximum size of a document before deciding to index it. The value is in bytes. The default value is 16MB.</li>
+ <li>The allowed mime types. Warning it does not work with all repository connectors.</li>
+ <li>The allowed file extensions. Warning it does not work with all repository connectors.</li>
+ </ul>
+ <figure src="images/opensearchserver-job-parameters.PNG" alt="OpenSearchServer, job parameters" width="80%"/>
+ <p>In the history report you will be able to monitor all the activites. The connector supports three activites: Document ingestion (Indexation), document deletion and
+ index optimization. The targeted index is automatically optimized when the job is ending.</p>
+ <figure src="images/opensearchserver-history-report.PNG" alt="OpenSearchServer, history report" width="80%"/>
+ <p>You may also refer to the <a href="http://www.open-search-server.com/documentation">OpenSearchServer's user documentation</a>.</p>
</section>
<section id="gtsoutputconnector">
Added: incubator/lcf/trunk/site/src/documentation/resources/images/opensearchserver-connection-parameters.PNG
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/site/src/documentation/resources/images/opensearchserver-connection-parameters.PNG?rev=1167110&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/lcf/trunk/site/src/documentation/resources/images/opensearchserver-connection-parameters.PNG
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/lcf/trunk/site/src/documentation/resources/images/opensearchserver-history-report.PNG
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/site/src/documentation/resources/images/opensearchserver-history-report.PNG?rev=1167110&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/lcf/trunk/site/src/documentation/resources/images/opensearchserver-history-report.PNG
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/lcf/trunk/site/src/documentation/resources/images/opensearchserver-job-parameters.PNG
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/site/src/documentation/resources/images/opensearchserver-job-parameters.PNG?rev=1167110&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/lcf/trunk/site/src/documentation/resources/images/opensearchserver-job-parameters.PNG
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/lcf/trunk/site/src/documentation/resources/images/opensearchserver-user.PNG
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/site/src/documentation/resources/images/opensearchserver-user.PNG?rev=1167110&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/lcf/trunk/site/src/documentation/resources/images/opensearchserver-user.PNG
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream