Revision: 13703
          http://gate.svn.sourceforge.net/gate/?rev=13703&view=rev
Author:   nirajaswani
Date:     2011-04-19 12:13:35 +0000 (Tue, 19 Apr 2011)

Log Message:
-----------
details of the improvements made to lucene based searchable serial datastores

Modified Paths:
--------------
    userguide/trunk/annic.tex
    userguide/trunk/recent-changes.tex

Modified: userguide/trunk/annic.tex
===================================================================
--- userguide/trunk/annic.tex   2011-04-19 12:09:54 UTC (rev 13702)
+++ userguide/trunk/annic.tex   2011-04-19 12:13:35 UTC (rev 13703)
@@ -54,17 +54,26 @@
 \begin{enumerate}
 \item In GATE Developer, right click on `Datastores' and select `Create 
Datastore'.
 \item From a drop-down list select `Lucene Based Searchable DataStore'.
-\item Here, you will see an input window. Please provide these parameters:
+\item Here, you will see a file dialog. Please select an empty folder for your
+datastore. This is similar to the procedure of creating a serial datastore.
+\item After this, you will see an input window. Please provide these 
parameters:
 \begin{enumerate}
-\item DataStore URL:  Select an empty folder where the DS is created.
-\item Index Location:  Select an empty folder.  This is where the index will be
-created.
+\item DataStore URL:  This is the URL of the datastore folder selected in the 
+previous step.
+\item Index Location:  By default, the location of index is calculated from 
the 
+datastore location. It is done by appending `-index' to the datastore location.
+If user wants to change this location, it is possible to do so by clicking on 
+the folder icon and selecting another empty folder.  If the selected folder
+exists already, the system will check if it is an empty folder. If the 
selected 
+folder does not exist, the system tries to create it.
 \item Annotation Sets:  Here, you can provide one or more annotation sets that
-you wish to index or exclude from being indexed. In order to be able
-to index the default annotation set, you must click on the edit list
-icon and add an empty field to the list. If there are no annotation
-sets provided, all the annotation sets in all documents are
-indexed.
+you wish to index or exclude from being indexed. By default, the default 
+annotation set and the `Key' annotation set are included.  User can change 
this 
+selection by clicking on the edit list icon and removing or adding appropriate 
+annotation set names.  In order to be able to readd the default annotation 
set, 
+you must click on the edit list icon and add an empty field to the list. If 
+there are no annotation sets provided, all the annotation sets in all 
documents 
+are indexed.
 \item Base-Token Type:  (e.g. Token or Key.Token)  These are the basic tokens 
of
 any document.  Your documents must have the annotations of
 Base-Token-Type in order to get indexed.  These basic tokens are used for
@@ -75,12 +84,12 @@
 does not provide any annotation set name (e.g. Token), the system searches in 
 all the annotation sets to be indexed and the base-tokens from the first 
 annotation set with the base token annotations are taken. Please note that the 
-documents with no base-tokens are not indexed. However, if the "create tokens 
-automatically" option is selected, the SSD creates base-tokens automatically. 
+documents with no base-tokens are not indexed. However, if the `create tokens 
+automatically' option is selected, the SSD creates base-tokens automatically. 
 Here, each string delimited with white space is considered as a token.
 \item Index Unit Type: (e.g. Sentence, Key.Sentence) This specifies the unit 
of 
 Index. In other words, annotations lying within the boundaries of these 
-annotations are indexed (e.g. in the case of ``Sentences'', no annotations that
+annotations are indexed (e.g. in the case of `Sentences', no annotations that
 are spanned across the boundaries of two sentences are considered for 
indexing).
 User can specify from which annotation set the index unit annotations should be
 considered.  If user does not provide any annotation set, the SSD searches 
among
@@ -99,6 +108,12 @@
 the required annotations, that document is skipped and not indexed.
 \end{enumerate}
 
+SSDs are portable and can be moved across different systems. However, the 
+relative positions of both the datastore folder and the respective index folder
+must be maintained. If it is not possible to maintain the relative positions,
+the new location of the index must be specified inside the 
+`\_\_GATE\_SerialDataStore\_\_' file inside the datastore folder.
+
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 \sect[sec:annic:search-gui]{Search GUI}
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

Modified: userguide/trunk/recent-changes.tex
===================================================================
--- userguide/trunk/recent-changes.tex  2011-04-19 12:09:54 UTC (rev 13702)
+++ userguide/trunk/recent-changes.tex  2011-04-19 12:13:35 UTC (rev 13703)
@@ -35,6 +35,10 @@
 with JAPE expressions, and also allows namespace scope to be added to new 
annotations
 when serialized to XML. See  \ref{sec:corpora:input} for details.
 
+Searchable Serial Datastores (Lucene-based) are now portable and can be moved
+across different systems. Also, several GUI improvements have been made to ease
+the creation of Lucene datastores. See \ref{sec:misc-creole:annic} for details.
+
 \rcSectNoLabel{March 2011}
 
 A new creole repository, Teamware\_Tools, contains a new PR called QA 
Summariser


This was sent by the SourceForge.net collaborative development platform, the 
world's largest Open Source development site.

------------------------------------------------------------------------------
Benefiting from Server Virtualization: Beyond Initial Workload 
Consolidation -- Increasing the use of server virtualization is a top
priority.Virtualization can reduce costs, simplify management, and improve 
application availability and disaster protection. Learn more about boosting 
the value of server virtualization. http://p.sf.net/sfu/vmware-sfdev2dev
_______________________________________________
GATE-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/gate-cvs

Reply via email to