Revision: 14886
http://gate.svn.sourceforge.net/gate/?rev=14886&view=rev
Author: valyt
Date: 2012-01-05 14:51:09 +0000 (Thu, 05 Jan 2012)
Log Message:
-----------
Quick(-ish) start chapter now done.
Modified Paths:
--------------
mimir/trunk/doc/mimir-guide.pdf
mimir/trunk/doc/preamble.tex
mimir/trunk/doc/quickstart.tex
Modified: mimir/trunk/doc/mimir-guide.pdf
===================================================================
(Binary files differ)
Modified: mimir/trunk/doc/preamble.tex
===================================================================
--- mimir/trunk/doc/preamble.tex 2012-01-05 14:26:53 UTC (rev 14885)
+++ mimir/trunk/doc/preamble.tex 2012-01-05 14:51:09 UTC (rev 14886)
@@ -47,6 +47,7 @@
\usepackage{fancyhdr}
\usepackage{listings}
\usepackage{longtable}
+\usepackage{txfonts}
\usepackage[text={5in,8.5in}, hmarginratio=1:1, vmarginratio=1:1]{geometry}
% packages with mode detection
\ifpdf
@@ -89,13 +90,10 @@
\fi
\fi
-
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% HTML support commands
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
% some utility definitions of HTML commands using the hyperref package
-
% \htlink{target URL}{link text} - hypertext link
\newcommand{\htlink}[2]{\href{#1}{#2}}
\newcommand{\htlinkplain}[1]{\href{#1}{#1}}
@@ -202,6 +200,8 @@
\newcommand{\omitted}[1]{{\small \sf =OMITTED=}}
\newcommand{\thing}{book}
+\definecolor{cmdcol}{RGB}{0, 0, 128}
+\newcommand{\cmd}[1]{\textcolor{cmdcol}{\textbf{\texttt{#1}}}}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% sectioning commands
Modified: mimir/trunk/doc/quickstart.tex
===================================================================
--- mimir/trunk/doc/quickstart.tex 2012-01-05 14:26:53 UTC (rev 14885)
+++ mimir/trunk/doc/quickstart.tex 2012-01-05 14:51:09 UTC (rev 14886)
@@ -4,6 +4,7 @@
necessarilly understand how it all fits together. For that, please read the
remainder of this guide.
+\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.
@@ -15,26 +16,104 @@
Oracle\footnote{\url{http://www.oracle.com/technetwork/java/javase/downloads/index.html}}.
Make sure you get the JDK and not the Java Runtime Environment (JRE), as that
would not be suitable. Once installed, make sure your \verb!JAVA_HOME!
- environment variable points to the location where the JDK was installed.
+ environment variable points to the location where the JDK was installed.
Make
+ sure that the \verb!$JAVA_HOME/bin! location is on your \verb!PATH!.
\item[Apache ANT] version 1.8.1 or later. You can download it from
\url{http://ant.apache.org/}. Once installed, make sure your \verb!ANT_HOME!
environment variable points to the top-level directory of your installation.
\item[Grails] version 1.3.7. You can download this from
\url{http://grails.org}. Once installed, make sure your \verb!GRAILS_HOME!
- environment variable points to the top-level directory of your installation.
+ environment variable points to the top-level directory of your installation.
+ \item[Working Internet Connection] The next step, described below, is the
+ building of the \Mimir{} library. This starts by automatically downloading
all
+ the required dependencies, so it requires a working internet connection. Once
+ the software is built, it can work without an remote conenction.
+ \item[GATE Developer] \Mimir{} is an indexer for GATE Documents. The simplest
+ way of generating some GATE documents to be indexed is by using the GATE
+ Developer tool\footnote{GATE Developer is available at
+ \url{http://gate.ac.uk/download/}. Usage of GATE Developer is beyond the
scope
+ of this document, so we assume you have a basic understanding of how to use
+ it. If not, a good place to start is the tutorials page at
+ \url{http://gate.ac.uk/demos/developer-videos/}.}.
\end{description}
-
-After all these prerequisites are installed, we can move to building a \Mimir{}
+%
+\section{Build and Run a \Mimir{} Web Application}
+%
+After all the prerequisites are installed, we can move to building a \Mimir{}
application. For the purposes of this demo, we will build the {\tt mimir-demo}
application. In a real deployment you may find the alternative application
({\tt
mimir-cloud}) more suitable.
-To build {\tt mimir-demo} follow these steps:
+The following steps will help you build the {\tt mimir-demo} application.
+Commands that you have to execute are formatted in a distinctive font
+\cmd{like this}.
\begin{enumerate}
- \item download \Mimir{}
- \item build the library
- \item generate the demo application
- \item build the demo application
+ \item {\bf Download the \Mimir{} sources}, if you have not done so already,
+ from \url{http://gate.svn.sourceforge.net/viewvc/gate/mimir/tags/}. Pick the
+ required version, then click on the {\em Download GNU tarball} link. Unpack
+ the downloaded file to a location on your computer. If using Windows we
+ recommend not using the default archive unpacking utility, as that sometimes
+ mangles the file names. Other free archive management tools (such as 7-Zip)
+ are available.
+ \item {\bf Build the library:} change to the top level directory where you
+ unpacked the downloaded \Mimir{} sources. If you can see the {\tt
mimir-core},
+ {\tt mimir-client}, {\em etc.} directories, then you are in the correct
+ directory. Execute the \cmd{ant} command. This will download all the
+ required dependencies, compile all the \Mimir{} libraries, and build the {\tt
+ mimir-web} Grails plugin.
+ \item {\bf Generate the demo application:} to use \Mimir{} you need a web
+ application that you can access from your browser. The simplest
\Mimir{}-based
+ web application is {\tt mimir-demo}, which can be automatically generated
+ and built by executing the \cmd{ant mimir-demo} command. This will produce a
+ new directory, named {\tt mimir-demo}, located under the top level \Mimir{}
+ directory.
+ \item {\bf Run the demo application:} change to the newly created {\tt
+ mimir-demo} directory (\cmd{cd mimir-demo}) and execute the \cmd{grails prod
+ run-app} command. This will start the application and will notify you which
+ URL you should use in your browser to access it (normally
+ \url{http://localhost:8080/mimir-demo/}).
\end{enumerate}
-
-
+%
+\section{Create, Populate, and Search an Index}
+%
+\begin{enumerate}
+\setcounter{enumi}{4}
+ \item {\bf Set-up your new \Mimir{} application:}
+ navigate to the administration page. You will be prompted to configure your
\Mimir{} instance.
+ After clicking the link, enter the path to a local writeable directory
+ where new indexes will be created, and click the {\em Update}.button.
+ \item \label{step:create} {\bf Create a new index:} navigate back to the
+ administration page (by clicking the link at the top of the page). Under the
{\em Local Indexes}
+ section, click the {\em create a new local index} link. Give it a name (e.g.
+ {\tt `test'}), and click the {\em create} button. Back on the administration
+ page, click the name of the newly created index. This will take you to the
+ index details page, where you can find the {\em Index URL} attribute. Make a
+ note of its value, as you will need it later.
+ \item {\bf Populate the new index:}
+ \begin{enumerate}
+ \item Start GATE Developer, load the ANNIE application (Main Menu
+ $\rightarrow$ File $\rightarrow$ Load ANNIE System $\rightarrow$ with
+ Defaults).
+ \item Open the CREOLE Plugin Manager ((Main Menu $\rightarrow$ File
+ $\rightarrow$ Manage CREOLE Plugins), and add a new plugin directory
+ pointing at the {\tt mimir-client} directory inside the \Mimir{}
+ distribution. Make sure the new plugin is loaded by checking the
+ appropriate checkbox.
+ \item Load a new instance of {\em \Mimir{} Indexing PR} (Main Menu
+ $\rightarrow$ File $\rightarrow$ New Processing Resource $\rightarrow$
+ \Mimir{} Indexing PR), and add it to the end of the ANNIE application.
+ \item Make sure that the {\tt mimirIndexUrl} parameter for the new PR is
set
+ to the {\em Index URL} value obtained at Step~\ref{step:create}.
+ \item Load some test documents (e.g. some web pages from news web sites),
+ create a GATE Corpus, aadd all the documents to the corpus, and set the
+ newly corpus as the target for the ANNIE application.
+ \item Run the ANNIE application. This will annotate the documents created
+ during the previous step. The \Mimir{} Indexing PR instance will make
+ sure the annotated documents are sent for indexing to your new Local Index.
+ \end{enumerate}
+ \item Go back to the index details page in your browser. Click the {\em
Close}
+ button, and wait for the index to finish closing. When done, go back to the
+ main administration page.
+ \item {\bf You can now search the new index} by clicking the {\em search}
link
+ next to your index name.
+\end{enumerate}
\ No newline at end of file
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
