Revision: 14903
http://gate.svn.sourceforge.net/gate/?rev=14903&view=rev
Author: valyt
Date: 2012-01-06 11:15:16 +0000 (Fri, 06 Jan 2012)
Log Message:
-----------
- added discussion about the two web applications.
- changed the default index template to use the default annotation set (as it
does now in the default software configuration).
Modified Paths:
--------------
mimir/trunk/doc/admin.tex
mimir/trunk/doc/changes.tex
mimir/trunk/doc/default-index-config.txt
mimir/trunk/doc/indexing.tex
mimir/trunk/doc/mimir-guide.pdf
Modified: mimir/trunk/doc/admin.tex
===================================================================
--- mimir/trunk/doc/admin.tex 2012-01-06 10:28:16 UTC (rev 14902)
+++ mimir/trunk/doc/admin.tex 2012-01-06 11:15:16 UTC (rev 14903)
@@ -50,16 +50,53 @@
modifications for most users.
\end{description}
-\section{Building and Running the mimir-demo Web
+\section{Building and Running a \Mimir{} Web
Application}\label{sec:building}
-The {\tt mimir-demo} module is intended to be the simplest possible
-demonstration of how to use the \Mimir\ grails plugin ({\tt mimir-web})) in a
-Grails application. This application is suitable for experimentation and local
-use, but as it includes no security or authentication support it may not be
-appropriate for production deployment. These concerns are addressed further in
-section~\ref{sec:extend:customapp}.
+\subsection{Which \Mimir{} Web Application}
+\label{sec:webapps}
+The {\tt mimir-core} Java library provides support for indexes that are
+represented as an on-disk directory -- named {\em Local Indexes} in the rest of
+this document (see the discussion about index types in
+Section~\ref{sec:admin:index-types}). To get the full functionality of \Mimir{}
+(including support for {\em Remote} and {\em Federated} indexes, as well as
user
+interfaces for system administration and searching indexes) you will need to
+build and run a web application. All the web elements of \Mimir{} are
+implemented as the {\tt mimir-web} Grails plugin, which can easily be included
+in any Grails-based web application. The standard \Mimir{} distribution
provides
+two such web applications:
+\begin{description}
+\item[mimir-demo] The {\tt mimir-demo} module is intended to be the simplest
+ possible demonstration of how to use the {\tt mimir-web} Grails plugin in a
+ Grails application. This application is suitable for experimentation and
+ local use, but as it includes no security or authentication support it may
not
+ be appropriate for production deployment. These concerns are addressed
further
+ in Section~\ref{sec:extend:customapp}.
+
+ If you are just starting with \Mimir{}, or you are only experimenting with
+ \Mimir{} indexes that you do not intend to open to remote users, then this is
+ the recommended web application to use.
+
+ You should also use {\tt mimir-demo} (as a starting point) if you are an
+ experienced Grails developer and need a basic application to which you intend
+ to add your own security solution.
+\item[mimir-cloud] The {\tt mimir-cloud} application is the actual software
+ implementation behind the {\Mimir} servers deployed on the GATE Cloud
+ platform\footnote{\url{https://gatecloud.net}}. In addition to the \Mimir{}
+ plugin, it also includes some basic support for user authentication (using
+ the Spring Security Grails plugin), and support for packaging and downloading
+ local indexes. This is probably the most suitable choice if you just need a
+ stand-alone web application with \Mimir{} functionality, and you do not
intend
+ to develop your own security solution.
+\end{description}
+
+The rest of this chapter talks about the {\tt mimir-demo} application, as the
+simpler of the two. However, everything said also applies to the {\tt
+mimir-cloud} application.
+
+
+
\subsection{Prerequisites}
To build the \Mimir\ demo app you will need:
@@ -263,8 +300,8 @@
// as the ROOT web application
\end{lstlisting}
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
\section{Indexes in \Mimir}
\subsection{Types of Index}\label{sec:admin:index-types}
Modified: mimir/trunk/doc/changes.tex
===================================================================
--- mimir/trunk/doc/changes.tex 2012-01-06 10:28:16 UTC (rev 14902)
+++ mimir/trunk/doc/changes.tex 2012-01-06 11:15:16 UTC (rev 14903)
@@ -1,6 +1,6 @@
This appendix details the main changes in each \Mimir\ release.
-\section{Version 4.0 (December 2011)}
+\section{Version 4.0 (Mmmm 2012)}
\begin{itemize}
\item Changed the results presentation to be document-centric, as opposed to
hit-centric.
@@ -15,7 +15,8 @@
local, remote and federated indexes).
\item Replaced the old GWT based UI with a new implementation (see
Section~\ref{sec:search:gus}.
- \item Added the mimir-cloud web application to the source tree.
+ \item Added the mimir-cloud web application to the source tree (see
+ Section~\ref{sec:webapps}).
\end{itemize}
\section{Version 3.4.0 (November 2011)}
Modified: mimir/trunk/doc/default-index-config.txt
===================================================================
--- mimir/trunk/doc/default-index-config.txt 2012-01-06 10:28:16 UTC (rev
14902)
+++ mimir/trunk/doc/default-index-config.txt 2012-01-06 11:15:16 UTC (rev
14903)
@@ -3,7 +3,7 @@
/@ 3 @/import gate.mimir.index.OriginalMarkupMetadataHelper
/@ 4 @/import gate.mimir.db.DBSemanticAnnotationHelper as DefaultHelper
/@ 5 @/
-/@ 6 @/tokenASName = "mimir"
+/@ 6 @/tokenASName = ""
/@ 7 @/tokenAnnotationType = ANNIEConstants.TOKEN_ANNOTATION_TYPE
/@ 8 @/tokenFeatures = {
/@ 9 @/ string()
@@ -11,7 +11,7 @@
/@ 11 @/ root()
/@ 12 @/}
/@ 13 @/
-/@ 14 @/semanticASName = "mimir"
+/@ 14 @/semanticASName = ""
/@ 15 @/semanticAnnotations = {
/@ 16 @/ index {
/@ 17 @/ annotation helper:new DefaultHelper(annType:'Sentence')
Modified: mimir/trunk/doc/indexing.tex
===================================================================
--- mimir/trunk/doc/indexing.tex 2012-01-06 10:28:16 UTC (rev 14902)
+++ mimir/trunk/doc/indexing.tex 2012-01-06 11:15:16 UTC (rev 14903)
@@ -58,9 +58,10 @@
The following options can be configured:
\begin{description}
\item[tokenASName] The name of the annotation set in which the token
- annotations can be found. This may be left unspecified (or explicitly set to
- \lstinline!null!, without quotes) to use the default annotation set, which
- has no name.
+ annotations can be found (for example \lstinline!tokenASName = "mimir"!). To
+ use the default annotation set, which has no name, this may be left
+ unspecified, or explicitly set to the empty string: \lstinline!""!, or to
+ \lstinline!null! (without quotes).
\item[tokenAnnotationType] The annotation type that should be used as tokens.
This entry is required, and can generally be simply set to the default
\lstinline!ANNIEConstants.TOKEN_ANNOTATION_TYPE! (with a suitable
Modified: mimir/trunk/doc/mimir-guide.pdf
===================================================================
(Binary files differ)
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
