Revision: 14441
http://gate.svn.sourceforge.net/gate/?rev=14441&view=rev
Author: valyt
Date: 2011-10-26 09:39:25 +0000 (Wed, 26 Oct 2011)
Log Message:
-----------
Updated the docs to reflect the new names for the mimir-web plugin and the
mimir-demo web application. Also added details about the Ant target for
generating the mimir-demo application.
Modified Paths:
--------------
mimir/trunk/doc/admin.tex
mimir/trunk/doc/mimir-guide.pdf
mimir/trunk/doc/searching.tex
Modified: mimir/trunk/doc/admin.tex
===================================================================
--- mimir/trunk/doc/admin.tex 2011-10-26 08:33:54 UTC (rev 14440)
+++ mimir/trunk/doc/admin.tex 2011-10-26 09:39:25 UTC (rev 14441)
@@ -30,24 +30,27 @@
\item[mimir-client] The client side of the \Mimir\ remote protocol, to support
distributed indexing and querying.
-\item[grails-plugin-mimir] A Grails plugin (\url{http://grails.org}) providing
+\item[mimir-web] A Grails plugin (\url{http://grails.org}) providing
both the user interface to create and query indexes over the web, and also the
server side of the remote protocol to expose several distributed \Mimir\
indexes as a single {\em federated} index for clients. This is provided as a
plugin rather than an application to make it more easily customizable.
-\item[demo-web-app] The simplest possible Grails application using the above
-plugin. This is ready to use as-is or as a base for customization to add
-security, look and feel customization, etc.
+\item[mimir-demo] The simplest possible Grails application using the above
+plugin. This application is not actaully included in the source tree; it is
+instead generated by the build process. See Section~\ref{sec:building} for
+details on how to do that. Once created, it is ready to use as-is or as a base
+for customization to add security, look and feel customization, etc.
\end{description}
-\section{Building and running the demo-web-app}
+\section{Building and running the mimir-demo web
+application}\label{sec:building}
-The {\tt demo-web-app} module is intended to be the simplest possible
-demonstration of how to use the \Mimir\ 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
+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{Prerequisites}
@@ -57,13 +60,12 @@
\item A Java 6 JDK. \Mimir\ has been tested with the Sun/Oracle and OpenJDK
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 and demo app were
- developed with version 1.3.5 but later 1.3.x versions should also work (you
- will need to run {\tt grails upgrade} in the grails-plugin-mimir and
- demo-web-app directories if you use a version other than 1.3.5). 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 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.2.0
@@ -83,19 +85,29 @@
\subsection{Building}
There is a top-level Ant build.xml file that should build all the modules in
-the correct order. To build them manually the correct order is as follows:
+the correct order. To do that simply change to the top level directory
+containing the \Mimir\ source code, and run the {\tt ant} command. To perform
+the same build process manually, you need to change to the following
directories
+and run the following {\tt ant} commands in this order:
\begin{enumerate}
-\item {\tt mimir-core} - {\tt ant publish}
-\item {\tt mimir-client} - {\tt ant publish}
-\item {\tt plugins} - run {\tt ant} in each subdirectory of the plugins
+\item {\tt mimir-core}: {\tt ant publish}
+\item {\tt mimir-client}: {\tt ant publish}
+\item {\tt plugins}: run {\tt ant} in each subdirectory of the plugins
directory in turn (order is not important here, the plugins do not depend on
one another).
-\item {\tt grails-plugin-mimir} - {\tt grails compile} followed by {\tt grails
+\item {\tt mimir-web} - {\tt grails compile} followed by {\tt grails
compile-gwt-modules}.
\end{enumerate}
-Once the plugin is built you need to configure the demo application.
+Once the plugin is built you need to generate the source folder for the demo
+application. You can do that by running the {\tt ant mimir-demo} command in the
+top level folder of the \Mimir\ source tree. This will create a new directory
+(named {\tt mimir-demo}) inside the top level directory, which contains a
simple
+Grails-based web application, that uses the \Mimir\ Grails plugin.
+The next step is to configure the {\tt mimir-demo} web application, and is
+described in the following Section.
+
\subsection{Configuring}\label{sec:admin:config}
When the \Mimir\ Grails plugin is installed into a Grails application, it
@@ -244,7 +256,7 @@
\end{verbatim}
To shut down a web app started using {\tt run-app} or {\tt run-war}, simply
-create an empty file in the {\tt demo-web-app} directory named
+create an empty file in the {\tt mimir-demo} directory named
``{\tt .kill-run-app}''. Grails watches for this file and will shut down
gracefully when it detects that the file has been created.
Modified: mimir/trunk/doc/mimir-guide.pdf
===================================================================
(Binary files differ)
Modified: mimir/trunk/doc/searching.tex
===================================================================
--- mimir/trunk/doc/searching.tex 2011-10-26 08:33:54 UTC (rev 14440)
+++ mimir/trunk/doc/searching.tex 2011-10-26 09:39:25 UTC (rev 14441)
@@ -255,8 +255,8 @@
that can be accessed through a simple HTTP interface. All requests are
performed
by calling an action with a set of parameters; the results of a call are
encoded
in XML and returned as the response to the request. All the example URLs in
-this section assume the {\tt demo-web-app} application with its default URL
-mappings, running on {\tt localhost} port 8080.
+this section assume the {\tt mimir-demo} application with its
+default URL mappings, running on {\tt localhost} port 8080.
The \Mimir\ web service can be accessed at a URL like:\\
{\tt http://localhost:8080/mimir-demo/\{index ID\}/search/\{action\}},
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
The demand for IT networking professionals continues to grow, and the
demand for specialized networking skills is growing even more rapidly.
Take a complimentary Learning@Cisco Self-Assessment and learn
about Cisco certifications, training, and career opportunities.
http://p.sf.net/sfu/cisco-dev2dev
_______________________________________________
GATE-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/gate-cvs
