Revision: 14907
http://gate.svn.sourceforge.net/gate/?rev=14907&view=rev
Author: valyt
Date: 2012-01-06 12:24:15 +0000 (Fri, 06 Jan 2012)
Log Message:
-----------
Spell-checking and various small fixes.
Modified Paths:
--------------
mimir/trunk/doc/admin.tex
mimir/trunk/doc/extending.tex
mimir/trunk/doc/introduction.tex
mimir/trunk/doc/mimir-guide.pdf
mimir/trunk/doc/plugins.tex
mimir/trunk/doc/quickstart.tex
mimir/trunk/doc/searching.tex
Modified: mimir/trunk/doc/admin.tex
===================================================================
--- mimir/trunk/doc/admin.tex 2012-01-06 11:54:35 UTC (rev 14906)
+++ mimir/trunk/doc/admin.tex 2012-01-06 12:24:15 UTC (rev 14907)
@@ -105,16 +105,11 @@
JVMs on Linux and the Apple JVM on Mac OS X.
\item Apache Ant 1.8.1 or later.
\item Grails (\url{http://grails.org}). The \Mimir\ plugin was developed with
-version 1.3.7 but later 1.3.x versions should also work (you will need to run
-{\tt grails upgrade} in the {\tt mimir-web} directory if you use a version
other
-than 1.3.7). You need to set the JAVA\_HOME environment variable to point to
-your JDK, the GRAILS\_HOME environment variable to point to your Grails
-installation and put \$GRAILS\_HOME/bin on your PATH.
-\item Google Web Toolkit (\url{http://code.google.com/webtoolkit}). The GUS
- web interface is implemented in GWT, using the Grails gwt plugin, but a
- standalone installation of GWT is required to build the app. Version 2.4.0
- or later is required, and you need to set the GWT\_HOME environment
- variable to point to your GWT installation.
+ version 1.3.7 but later 1.3.x versions should also work (you will need to run
+ {\tt grails upgrade} in the {\tt mimir-web} directory if you use a version
+ other than 1.3.7). You need to set the JAVA\_HOME environment variable to
+ point to your JDK, the GRAILS\_HOME environment variable to point to your
+ Grails installation and put \$GRAILS\_HOME/bin on your PATH.
\end{itemize}
While not strictly a pre-requisite, \Mimir\ performs much better on 64-bit
@@ -207,7 +202,7 @@
in {\tt run-app} and in WAR deployments, but plugins specified as relative
paths are treated slightly differently. They will be loaded directly from the
specified paths in {\tt run-app}, but when building a WAR file the referenced
-plugins will be packaged inside the WAR file and loaded from there at runtime.
+plugins will be packaged inside the WAR file and loaded from there at run-time.
\begin{lstlisting}
queryTokeniserGapp =
@@ -235,10 +230,10 @@
Note that because of the special handling at build time of plugins referenced
as relative paths (see above), if you want to load additional plugins into a
-WAR-packaged \Mimir\ using runtime settings in an external configuration file,
+WAR-packaged \Mimir\ using run-time settings in an external configuration file,
then the plugins must be specified using absolute URLs, i.e.
{\tt gate.mimir.plugins.custom = "file:/opt/mimir/plugins/custom"}. Relative
-plugin paths are ignored at runtime by \Mimir\ when running from a WAR
+plugin paths are ignored at run-time by \Mimir\ when running from a WAR
deployment. However, since \Mimir\ plugins are simply standard GATE CREOLE
plugins and the \Mimir\ Grails plugin initialises GATE Embedded using Spring
you can load extra plugins relative to your web app by using Spring
@@ -282,7 +277,7 @@
configured by default with a security manager that interferes with \Mimir.
When deployed to a servlet container the demo application reads configuration
-at runtime from two locations using the Grails standard ``externalised
+at run-time from two locations using the Grails standard ``externalised
configuration'' mechanism:
\begin{itemize}
\item {\tt WEB-INF/classes/mimir-app-config.groovy} inside the web application.
@@ -559,8 +554,5 @@
Note that the IDs required here are not the URIs that were provided with the
documents when they were indexed, but the internal \Mimir\ document IDs which
-are numbers starting from 0, as returned in the hit lists and ``docStats'' by
-the \Mimir\ query APIs (see section~\ref{sec:search:service}). In the GUS
-interface (section~\ref{sec:search:gus}) the document ID is part of the URL to
-the ``cached'' document text,
-{\tt .../search/gusDocument/{\it $<$documentID$>$}?queryId=...}.
+are numbers starting from 0, as returned in the hit lists and ``getDocumentId''
+by the \Mimir\ query APIs (see section~\ref{sec:search:service}).
\ No newline at end of file
Modified: mimir/trunk/doc/extending.tex
===================================================================
--- mimir/trunk/doc/extending.tex 2012-01-06 11:54:35 UTC (rev 14906)
+++ mimir/trunk/doc/extending.tex 2012-01-06 12:24:15 UTC (rev 14907)
@@ -104,7 +104,7 @@
There is a second overloading of this method specified in the interface which
is a convenience for callers when all the constraints are simple feature value
-equality constraints, but generally implementors of new SAH types can ignore
+equality constraints, but generally implementers of new SAH types can ignore
this as \Mimir\ provides an abstract base class that converts the Map form of
constraints into the more general List$<$Constraint$>$ form and calls the other
method.
@@ -169,15 +169,15 @@
(again, in sequence in one thread). The index is now closed and the SAH
objects can be garbage collected.
-The index configuration, including all the SAH objects, is serialized to XML
+The index configuration, including all the SAH objects, is serialised to XML
using XStream (\url{http://xstream.codehaus.org}). Therefore it is important to
mark as \lstinline!transient! any fields of your helper class that should not
be
-serialized (e.g. temporary in-memory caches, etc.).
+serialised (e.g. temporary in-memory caches, etc.).
-When an index is opened for searching the XML configuration is deserialized to
+When an index is opened for searching the XML configuration is deserialised to
re-create the helper objects, and their {\tt init(QueryEngine)} methods are
-called. Note that as with Java object serialization XStream does {\em not}
-call object constructors when deserializing, so any initialization must happen
+called. Note that as with Java object serialisation XStream does {\em not}
+call object constructors when de-serialising, so any initialisation must happen
in the init method or in a {\tt readResolve} method, and not in the
constructor.
@@ -239,7 +239,7 @@
\lstinline!gate.mimir.search.score.DelegatingScoringQueryExecutor! class which
can be used to wrap one of the scorer implementations provided by MG4J. If none
of those are suitable, you can write your own custom implementations and make
-them avaialble to \Mimir{} in the form of a GATE CREOLE plugin. This will
ensure
+them available to \Mimir{} in the form of a GATE CREOLE plugin. This will
ensure
the new classes are added to the classpath and can be found by the system. See
Section~\ref{sec:extend-package-plugins} for a description of how to declare
new
plugins, and Section~\ref{sec:admin:config} for information about loading
@@ -289,7 +289,7 @@
through the {\tt mimir-client} library, which relies on a base URL to which
it
adds known suffixes to access given functionality (e.g. the search actions
are all found under {\tt /\{indexId\}/search/\{actionName\}}). The
- mimir-client library is used, for example, in the implemenation of remote
+ mimir-client library is used, for example, in the implementation of remote
indexes.
\eit
@@ -325,7 +325,7 @@
/images, /plugins, /\{yourindex\}/search, etc.)
\item Install a security plugin such as spring-security-core or nimble, and
restrict the \Mimir\ pages to certain users. For example the /admin pages
- could be restricted to administrative users, the gus pages to registered
+ could be restricted to administrative users, the Web UI pages to registered
searchers, etc. This is how the {\tt mimir-cloud} application is set up.
\item If your \Mimir\ instance is a slave in a federated index, use firewall
rules or a Grails filter to restrict access to the */search URLs to only the
Modified: mimir/trunk/doc/introduction.tex
===================================================================
--- mimir/trunk/doc/introduction.tex 2012-01-06 11:54:35 UTC (rev 14906)
+++ mimir/trunk/doc/introduction.tex 2012-01-06 12:24:15 UTC (rev 14907)
@@ -59,7 +59,7 @@
typically at least partially derived from semantic annotation over documents.
KB data is used to reach a higher level of abstraction over the information in
the documents which enables conceptual queries such as ``find all mentions of
-{\tt Person}s who are employed by any organization based in Yorkshire''.
+{\tt Person}s who are employed by any organisation based in Yorkshire''.
A KB that is pre-populated with appropriate world knowledge can perform other
generalisations that are natural to humans users, such as being able to
identify
Modified: mimir/trunk/doc/mimir-guide.pdf
===================================================================
(Binary files differ)
Modified: mimir/trunk/doc/plugins.tex
===================================================================
--- mimir/trunk/doc/plugins.tex 2012-01-06 11:54:35 UTC (rev 14906)
+++ mimir/trunk/doc/plugins.tex 2012-01-06 12:24:15 UTC (rev 14907)
@@ -103,20 +103,20 @@
The GATE {\tt Tagger\_Measurements} plugin, introduced in GATE 6.1, is able to
recognise many different kinds of measurement expressions in text. It
-normalizes the value and unit of each measurement into the SI system of
+normalises the value and unit of each measurement into the SI system of
measurements and stores these values as features of the Measurement annotation.
-For example, the text ``45 cm'' would be annotated with a normalized unit of
-metres and a normalized value of 0.45, the text ``18 in'' would also be
-normalized to metres, in this case with a normalized value of 0.4572.
+For example, the text ``45 cm'' would be annotated with a normalised unit of
+metres and a normalised value of 0.45, the text ``18 in'' would also be
+normalised to metres, in this case with a normalised value of 0.4572.
The \Mimir\ {\tt measurements} plugin provides a SAH that implements the same
-normalization on queries. It processes queries for a ``synthetic'' feature
+normalisation on queries. It processes queries for a ``synthetic'' feature
called ``spec'' which represents a measurement specification in a controlled
language and converts constraints on this feature into the corresponding
-constraints on the real normalized value and unit features that have been
+constraints on the real normalised value and unit features that have been
indexed. For example, a search for \{Measurement spec="1 to 3 feet"\} would be
-treated as a query for measurements whose normalized unit is metres and whose
-normalized value is between 0.3048 and 0.9144, which would match both the ``45
+treated as a query for measurements whose normalised unit is metres and whose
+normalised value is between 0.3048 and 0.9144, which would match both the ``45
cm'' and ``18 in'' examples above.
\subsection{Configuring the Measurements SAH}
@@ -185,7 +185,7 @@
search method to support the ``spec'' feature.
When a query including a spec feature constraint is received, the helper parses
-this spec using the measurements parser to obtain a normalized unit and value
+this spec using the measurements parser to obtain a normalised unit and value
or values for the measurement sought. It then constructs a number of new
constraint sets that match annotations compatible with the spec and then for
each of these alternatives, runs these constraints in combination with the
@@ -215,7 +215,7 @@
treated as a match for the {\tt sparql} constraint. This process is described
in detail below.
-For example, given a helper configured for the public DBpedia endpoint
+For example, given a helper configured for the public DBPedia endpoint
{\tt http://dbpedia.org/sparql}, the following \Mimir\ query:
\begin{verbatim}
{Person sparql = "SELECT DISTINCT ?inst WHERE {
Modified: mimir/trunk/doc/quickstart.tex
===================================================================
--- mimir/trunk/doc/quickstart.tex 2012-01-06 11:54:35 UTC (rev 14906)
+++ mimir/trunk/doc/quickstart.tex 2012-01-06 12:24:15 UTC (rev 14907)
@@ -7,7 +7,7 @@
\section{Set Up Your Environment}
We suggest you try this on a 64~bit operating system, as that is better suited
for running \Mimir{}. A 32~bit system would also work, but the maximum sizes
for
-the indexes wold be limited.
+the indexes would be limited.
In order to build and run a \Mimir{} server you will need the following pieces
of software installed on your system:
Modified: mimir/trunk/doc/searching.tex
===================================================================
--- mimir/trunk/doc/searching.tex 2012-01-06 11:54:35 UTC (rev 14906)
+++ mimir/trunk/doc/searching.tex 2012-01-06 12:24:15 UTC (rev 14907)
@@ -299,11 +299,8 @@
\begin{longtable}{|p{1.8cm}|p{10.2cm}|}
\multicolumn{2}{l}{\tt \bf postQuery} \\
\hline
-Function & Starts a new query. The query will execute asynchronously in a
-background thread, and will initially run until it has found a maximum of 1
-million hits or has been running for 30 seconds, whichever comes first. If the
-query runner hits one of these limits before the search is complete it can be
-restarted by calling the {\tt getMoreHits} action. \\
+Function & Starts a new query. This call returns immediately, as the query will
+execute asynchronously in a background thread.\\
\hline
Parameters & \begin{minipage}[t]{10.2cm}
\begin{description}
@@ -387,7 +384,7 @@
\hline
Returns & \begin{minipage}[t]{10.2cm}
An XML message encapsulating a numeric value, or an error message if there
were
-any problems. After the search compeltes, the value returned is identical to
+any problems. After the search completes, the value returned is identical to
that returned by calling {\tt documentsCount}.
Example request:\\
@@ -761,9 +758,9 @@
\subsection{Embedding \Mimir\ in a Grails Application}
\label{sec:search:grails}
-Both the XML web service and the GUS interface ultimately use a Grails service
-provided by the \Mimir\ plugin to search their indexes. If you install the
-\Mimir\ plugin into your own Grails application this service will be your
+Both the XML web service and the Web UI interface ultimately use a Grails
+service provided by the \Mimir\ plugin to search their indexes. If you install
+the \Mimir\ plugin into your own Grails application this service will be your
primary entry point to make use of \Mimir\ functionality, so this section
explains what you need to know to use it effectively.
@@ -801,8 +798,8 @@
while the query is currently active. Once the query completes, this method
returns the same value as {\tt getDocumentsCount}.
\item[getDocumentHits(rank)] Gets the details for the hits found inside a given
- document. The document is pecified by its rank (the position in the list of
- result documents). The value supplied for the {\tt rank} paramter must be
+ document. The document is specified by its rank (the position in the list of
+ result documents). The value supplied for the {\tt rank} parameter must be
between $0$ (inclusive) and the value returned by {\tt getDocumentsCount()}
(exclusive). The return value from this method is a list of {\tt Binding}
objects, each representing one hit.
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
Ridiculously easy VDI. With Citrix VDI-in-a-Box, you don't need a complex
infrastructure or vast IT resources to deliver seamless, secure access to
virtual desktops. With this all-in-one solution, easily deploy virtual
desktops for less than the cost of PCs and save 60% on VDI infrastructure
costs. Try it free! http://p.sf.net/sfu/Citrix-VDIinabox
_______________________________________________
GATE-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/gate-cvs
