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 2010/07/07 21:36:59 UTC

svn commit: r961485 - in /incubator/lcf/site: publish/ src/documentation/content/xdocs/

Author: kwright
Date: Wed Jul  7 19:36:58 2010
New Revision: 961485

URL: http://svn.apache.org/viewvc?rev=961485&view=rev
Log:
Document JDBC connector metadata, and make a couple of other minor site improvements.

Modified:
    incubator/lcf/site/publish/developer-resources.pdf
    incubator/lcf/site/publish/end-user-documentation.html
    incubator/lcf/site/publish/end-user-documentation.pdf
    incubator/lcf/site/publish/faq.pdf
    incubator/lcf/site/publish/index.html
    incubator/lcf/site/publish/index.pdf
    incubator/lcf/site/publish/linkmap.pdf
    incubator/lcf/site/publish/mail.pdf
    incubator/lcf/site/publish/who.pdf
    incubator/lcf/site/src/documentation/content/xdocs/end-user-documentation.xml
    incubator/lcf/site/src/documentation/content/xdocs/index.xml

Modified: incubator/lcf/site/publish/developer-resources.pdf
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/developer-resources.pdf?rev=961485&r1=961484&r2=961485&view=diff
==============================================================================
Binary files - no diff available.

Modified: incubator/lcf/site/publish/end-user-documentation.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/end-user-documentation.html?rev=961485&r1=961484&r2=961485&view=diff
==============================================================================
--- incubator/lcf/site/publish/end-user-documentation.html (original)
+++ incubator/lcf/site/publish/end-user-documentation.html Wed Jul  7 19:36:58 2010
@@ -1862,7 +1862,7 @@ document.write("Last Published: " + docu
                     
 <li>Given a set of document identifiers, find the corresponding version strings (see below)</li>
                     
-<li>Given a set of document identifiers and version strings, find information about the document, consisting of the document's data and access URL</li>
+<li>Given a set of document identifiers and version strings, find information about the document, consisting of the document's data, access URL, and metadata</li>
                 
 </ul>
 <br>
@@ -1962,6 +1962,10 @@ document.write("Last Published: " + docu
                 
 </table>
 <br>
+<p>When you create a job based on a general database connection, the job's queries are initially populated with examples.  These examples should give you a good idea of
+                        what columns your queries should return - in most cases, the only columns you need to return are the ones that appear in the example queries.  However,
+                        for the file data query, you may also return columns that are not specified in the example.  When you do this, the extra return column values will be passed
+                        to the index as metadata for the document.  The metadata name used will be the corresponding column name of the resultset.</p>
 <p>The "Security" tab simply allows you to add specific access tokens to all documents indexed with a general database job.  In order for you to know what tokens
                        to add, you must decide with what authority connection these documents will be secured, and understand the form of the access tokens used by that authority connection
                        type.  This is what the "Security" tab looks like:</p>
@@ -1972,10 +1976,10 @@ document.write("Last Published: " + docu
 <br>
 <br>
 <p>Enter a desired access token, and click the "Add" button.  You may enter multiple access tokens.</p>
-<a name="N10B3B"></a><a name="filenetrepository"></a>
+<a name="N10B3E"></a><a name="filenetrepository"></a>
 <h3 class="h4">IBM FileNet P8 Repository Connection</h3>
 <p>More here later</p>
-<a name="N10B45"></a><a name="documentumrepository"></a>
+<a name="N10B48"></a><a name="documentumrepository"></a>
 <h3 class="h4">EMC Documentum Repository Connection</h3>
 <p>The EMC Documentum connection type allows you index content from a Documentum Content Server instance.  A single connection allows you
                     to reach all documents contained on a single Content Server instance.  Multiple connections are therefore required to reach documents from multiple Content Server instances.</p>
@@ -2030,7 +2034,7 @@ document.write("Last Published: " + docu
 <p>For example, suppose you had a rule which had ".*/(.*)/(.*)/.*" as a match expression, and "$(1) $(2)" as the replace string.  If presented with the path
                     <span class="codefrag">Project/Folder_1/Folder_2/Filename</span>, it would output the string <span class="codefrag">Folder_1 Folder_2</span>.</p>
 <p>If more than one rule is present, the rules are all executed in sequence.  That is, the output of the first rule is modified by the second rule, etc.</p>
-<a name="N10BAB"></a><a name="livelinkrepository"></a>
+<a name="N10BAE"></a><a name="livelinkrepository"></a>
 <h3 class="h4">OpenText LiveLink Repository Connection</h3>
 <p>The OpenText LiveLink connection type allows you to index content from LiveLink repositories.  LiveLink has a rich variety of different document types and metadata, which include
                     basic documents, as well as compound documents, folders, workspaces, and projects.  A LiveLink connection is able to discover documents contained within all of these constructs.</p>
@@ -2125,7 +2129,7 @@ document.write("Last Published: " + docu
 <p>For example, suppose you had a rule which had ".*/(.*)/(.*)/.*" as a match expression, and "$(1) $(2)" as the replace string.  If presented with the path
                     <span class="codefrag">Project/Folder_1/Folder_2/Filename</span>, it would output the string <span class="codefrag">Folder_1 Folder_2</span>.</p>
 <p>If more than one rule is present, the rules are all executed in sequence.  That is, the output of the first rule is modified by the second rule, etc.</p>
-<a name="N10C5A"></a><a name="mexexrepository"></a>
+<a name="N10C5D"></a><a name="mexexrepository"></a>
 <h3 class="h4">Memex Patriarch Repository Connection</h3>
 <p>A Memex Patriarch connection allows you to index documents from a Memex server.</p>
 <p>Documents described by Memex connections are typically secured by a Memex authority.  If you have not yet created a Memex authority, but would like your
@@ -2159,7 +2163,7 @@ document.write("Last Published: " + docu
 <p></p>
 <p>Jobs based on Memex connections have the following special tabs: "Record Criteria", "Entities", and "Security".</p>
 <p>More here later</p>
-<a name="N10C9F"></a><a name="meridiorepository"></a>
+<a name="N10CA2"></a><a name="meridiorepository"></a>
 <h3 class="h4">Autonomy Meridio Repository Connection</h3>
 <p>An Autonomy Meridio connection allows you to index documents from a set of Meridio servers.  Meridio's architecture allows you to separate services on multiple machines -
                     e.g. the document services can run on one machine, and the records services can run on another.  A Meridio connection type correspondingly is configured to describe each
@@ -2233,7 +2237,7 @@ document.write("Last Published: " + docu
 <p></p>
 <p>Jobs based on Meridio connections have the following special tabs: "Search Paths", "Content Types", "Categories", "Data Types", "Security", and "Metadata".</p>
 <p>More here later</p>
-<a name="N10D25"></a><a name="sharepointrepository"></a>
+<a name="N10D28"></a><a name="sharepointrepository"></a>
 <h3 class="h4">Microsoft SharePoint Repository Connection</h3>
 <p>The Microsoft SharePoint connection type allows you to index documents from a Microsoft SharePoint site.  Bear in mind that a single SharePoint installation actually represents
                     a set of sites.  Some sites

Modified: incubator/lcf/site/publish/end-user-documentation.pdf
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/end-user-documentation.pdf?rev=961485&r1=961484&r2=961485&view=diff
==============================================================================
Files incubator/lcf/site/publish/end-user-documentation.pdf (original) and incubator/lcf/site/publish/end-user-documentation.pdf Wed Jul  7 19:36:58 2010 differ

Modified: incubator/lcf/site/publish/faq.pdf
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/faq.pdf?rev=961485&r1=961484&r2=961485&view=diff
==============================================================================
Files incubator/lcf/site/publish/faq.pdf (original) and incubator/lcf/site/publish/faq.pdf Wed Jul  7 19:36:58 2010 differ

Modified: incubator/lcf/site/publish/index.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/index.html?rev=961485&r1=961484&r2=961485&view=diff
==============================================================================
--- incubator/lcf/site/publish/index.html (original)
+++ incubator/lcf/site/publish/index.html Wed Jul  7 19:36:58 2010
@@ -208,10 +208,13 @@ document.write("Last Published: " + docu
 <a href="#News">News</a>
 <ul class="minitoc">
 <li>
-<a href="#12+Jan.+2010+-+Lucene+Connectors+Framework+launches%21">12 Jan. 2010 - Lucene Connectors Framework launches!</a>
+<a href="#07+July+2010+-+Lucene+Connectors+Framework+first+release+proposed">07 July 2010 - Lucene Connectors Framework first release proposed</a>
+</li>
+<li>
+<a href="#21+May+2010+-+Lucene+Connectors+Framework+in+Prague">21 May 2010 - Lucene Connectors Framework in Prague</a>
 </li>
 <li>
-<a href="#21+May.+2010+-+Lucene+Connectors+Framework+in+Prague">21 May. 2010 - Lucene Connectors Framework in Prague</a>
+<a href="#12+Jan.+2010+-+Lucene+Connectors+Framework+launches%21">12 Jan. 2010 - Lucene Connectors Framework launches!</a>
 </li>
 </ul>
 </li>
@@ -253,12 +256,15 @@ document.write("Last Published: " + docu
 <a name="N10042"></a><a name="News"></a>
 <h2 class="h3">News</h2>
 <div class="section">
-<a name="N10048"></a><a name="12+Jan.+2010+-+Lucene+Connectors+Framework+launches%21"></a>
+<a name="N10048"></a><a name="07+July+2010+-+Lucene+Connectors+Framework+first+release+proposed"></a>
+<h3 class="h4">07 July 2010 - Lucene Connectors Framework first release proposed</h3>
+<p>Criteria for LCF's first official release proposed</p>
+<a name="N10052"></a><a name="21+May+2010+-+Lucene+Connectors+Framework+in+Prague"></a>
+<h3 class="h4">21 May 2010 - Lucene Connectors Framework in Prague</h3>
+<p>LCF introductory talk planned for Lucene/Solr Eurocon, Prague, Czech Republic</p>
+<a name="N1005C"></a><a name="12+Jan.+2010+-+Lucene+Connectors+Framework+launches%21"></a>
 <h3 class="h4">12 Jan. 2010 - Lucene Connectors Framework launches!</h3>
 <p>LCF is now officially an incubating project of the Apache Software Foundation</p>
-<a name="N10052"></a><a name="21+May.+2010+-+Lucene+Connectors+Framework+in+Prague"></a>
-<h3 class="h4">21 May. 2010 - Lucene Connectors Framework in Prague</h3>
-<p>LCF introductory talk planned for Lucene/Solr Eurocon, Prague, Czech Republic</p>
 </div>
 
   

Modified: incubator/lcf/site/publish/index.pdf
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/index.pdf?rev=961485&r1=961484&r2=961485&view=diff
==============================================================================
Binary files - no diff available.

Modified: incubator/lcf/site/publish/linkmap.pdf
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/linkmap.pdf?rev=961485&r1=961484&r2=961485&view=diff
==============================================================================
Binary files - no diff available.

Modified: incubator/lcf/site/publish/mail.pdf
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/mail.pdf?rev=961485&r1=961484&r2=961485&view=diff
==============================================================================
Binary files - no diff available.

Modified: incubator/lcf/site/publish/who.pdf
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/who.pdf?rev=961485&r1=961484&r2=961485&view=diff
==============================================================================
Binary files - no diff available.

Modified: incubator/lcf/site/src/documentation/content/xdocs/end-user-documentation.xml
URL: http://svn.apache.org/viewvc/incubator/lcf/site/src/documentation/content/xdocs/end-user-documentation.xml?rev=961485&r1=961484&r2=961485&view=diff
==============================================================================
--- incubator/lcf/site/src/documentation/content/xdocs/end-user-documentation.xml (original)
+++ incubator/lcf/site/src/documentation/content/xdocs/end-user-documentation.xml Wed Jul  7 19:36:58 2010
@@ -1191,7 +1191,7 @@
                 <ul>
                     <li>Obtain a list of document identifiers corresponding to changes and additions that occurred within a specified time window (see below)</li>
                     <li>Given a set of document identifiers, find the corresponding version strings (see below)</li>
-                    <li>Given a set of document identifiers and version strings, find information about the document, consisting of the document's data and access URL</li>
+                    <li>Given a set of document identifiers and version strings, find information about the document, consisting of the document's data, access URL, and metadata</li>
                 </ul>
                 <br/>
                 <p>The Framework uses a unique document identifier to describe every document within the confines of a defined repository connection.  This document identifier is used
@@ -1246,6 +1246,10 @@
                     <tr><td>Sybase (10+)</td><td>datetime</td><td><code>DATEADD(ms, $(STARTTIME), '19700101')</code></td></tr>
                 </table>
                 <br/>
+                <p>When you create a job based on a general database connection, the job's queries are initially populated with examples.  These examples should give you a good idea of
+                        what columns your queries should return - in most cases, the only columns you need to return are the ones that appear in the example queries.  However,
+                        for the file data query, you may also return columns that are not specified in the example.  When you do this, the extra return column values will be passed
+                        to the index as metadata for the document.  The metadata name used will be the corresponding column name of the resultset.</p>
                 <p>The "Security" tab simply allows you to add specific access tokens to all documents indexed with a general database job.  In order for you to know what tokens
                        to add, you must decide with what authority connection these documents will be secured, and understand the form of the access tokens used by that authority connection
                        type.  This is what the "Security" tab looks like:</p>

Modified: incubator/lcf/site/src/documentation/content/xdocs/index.xml
URL: http://svn.apache.org/viewvc/incubator/lcf/site/src/documentation/content/xdocs/index.xml?rev=961485&r1=961484&r2=961485&view=diff
==============================================================================
--- incubator/lcf/site/src/documentation/content/xdocs/index.xml (original)
+++ incubator/lcf/site/src/documentation/content/xdocs/index.xml Wed Jul  7 19:36:58 2010
@@ -37,13 +37,17 @@
     <section>
         <title>News</title>
             <section>
-                <title>12 Jan. 2010 - Lucene Connectors Framework launches!</title>
-                <p>LCF is now officially an incubating project of the Apache Software Foundation</p>
+                <title>07 July 2010 - Lucene Connectors Framework first release proposed</title>
+                <p>Criteria for LCF's first official release proposed</p>
             </section>
             <section>
-                <title>21 May. 2010 - Lucene Connectors Framework in Prague</title>
+                <title>21 May 2010 - Lucene Connectors Framework in Prague</title>
                 <p>LCF introductory talk planned for Lucene/Solr Eurocon, Prague, Czech Republic</p>
             </section>
+            <section>
+                <title>12 Jan. 2010 - Lucene Connectors Framework launches!</title>
+                <p>LCF is now officially an incubating project of the Apache Software Foundation</p>
+            </section>
 
     </section>