chunkingtoolguide.tex

Emdros is a text database middleware-layer aimed at storage and retrieval of "text plus information

\documentclass[a4paper]{article}
\usepackage{graphicx}
\usepackage{ucs}
\usepackage{html}
\title{Emdros Chunking Tool User's Guide}
\author{Ulrik Petersen}
\begin{document}
\newenvironment{precode}
        {\begin{list}{}{
        \setlength{\rightmargin}{\leftmargin}
        \setlength{\listparindent}{0pt}% needed for AMS classes
        \raggedright
        \setlength{\itemsep}{0pt}
        \setlength{\parsep}{0pt}
        \normalfont\ttfamily}%
        \item[]}
        {\end{list}}
\maketitle

\tableofcontents

\section{Introduction}




This is the User's Guide to the Emdros Chunking Tool.




The Emdros Chunking Tool allows you to split running text into
lines and then indent those lines with respect to each other.



\subsection{Two versions}



The Emdros Chunking Tool exists in two graphical versions:


\begin{itemize}

     
\item A non-Unicode version

     
\item A Unicode-aware version

\end{itemize}


\subsection{Getting started}

\subsubsection{Introduction}


 



Before running the Emdros Chunking Tool for the first time on a
database, you need to write a configuration file that matches your
database.  This is a one-off thing: Once it's done, you don't need to
bother with it any more.


\subsubsection{Sample configuration file}




A number of sample configuration files are supplied with Emdros.
You can use these as a starting point for writing your own
configuration file.




One supplied configuration file is called "tisch.cfg", while
another is called "wihebrew.cfg".  You can search for these on your
computer to locate where they are, or see the manual page for
chunkingtool to know where they are installed (on Windows, they are
installed in %EMDROSINSTALLPREFIX%$\backslash$etc$\backslash$).  


\subsubsection{Full details}




The "tisch.cfg" file is almost self-documenting.  However, you
can get more information about the details of the configuration file
here:


\begin{itemize}

  
\item Configuring the program

\end{itemize}



\section{Using the program}



We now explain how to use the program.




\subsection{Starting the program}

\subsubsection{Getting started}




Once you open the program, you will be presented with the main
screen.  You will then need to "connect" to a database.  Either choose
the menu-item "File$|$Connect" or press the button \includegraphics[scale=0.5]{connect.png} "Connect to database".


\subsubsection{Connection dialog}




You will then be given a dialog box allowing you to choose the
Connection Settings.  At the top is a drop-down box allowing you to
choose the backend.  Based on this choice, the dialog box will appear
slightly differently depending whether the backend is:


\begin{itemize}
  
\item SQLite 2 or 3, or
  
\item MySQL or PostgreSQL

\end{itemize}  

\subsubsection{Non-Unicode vs. Unicode}




For each backend, the program exists in two versions:


\begin{itemize}

  
\item A non-Unicode version
  
\item A Unicode-aware version

\end{itemize}


\subsubsection{SQLite version}



The Connection Settings dialog looks like this if you have selected
SQLite 2 or 3 as the backend:


\includegraphics[scale=0.5]{SQLiteConnSettings.png}

\paragraph{Set the configuration file}





The first thing you should do is press the "Browse" button next to
the "Configuration" edit box, then navigate to where you have your
configuration file.




Once you've opened the configuration file, the "database" field
will be filled from the "database" value stored in the configuration
file, if any.  If this is not the database you want, simply enter (or
browse for) the database you want.




For example:


\includegraphics[scale=0.5]{SQLiteConnSettingsFilled.png}

\paragraph{Press OK}




Once you're done setting the configuration file and the database,
press "OK".  If you want to quit the program instead, press
"Cancel".




\subsubsection{MySQL/PostgreSQL version}



When you start the Emdros Chunking Tool using the MySQL or the PostgreSQL backend, you will see this dialog:


\includegraphics[scale=0.5]{MyPgSQLConnSettings.png}


\paragraph{Set the configuration file}




The first thing you should do is press the "Browse" button next to
the "Configuration" edit box, then navigate to where you have your
configuration file.


\paragraph{Database}




Once you've opened the configuration file, the "database" field
will be filled from the "database" value stored in the configuration
file, if any.  If this is not the database you want, simply enter the
database you want.


\paragraph{Host, user, password}




Most people can leave the "host" and "user" fields as they are, and
simply write the password.




The "host" field shows which computer to connect to, i.e., the
computer where the MySQL or PostgreSQL backend is running. "localhost"
means the computer where the Chunking Tool is running.




The "user" field is the database user to connect to the backend as.
Note that this may be different from your computer user name.  The
default is "emdf", since that is the recommended default user to
create when you bootstrap the MySQL or PostgreSQL database (see
"bootstrapping.txt" in the Emdros
documentation).




The "password" field is for the password of the database user to
connect as.  This is set either by the database administrator, or by
the one who bootstrapped the MySQL or PostgreSQL database.


\paragraph{Example}



\includegraphics[scale=0.5]{MyPgConnSettingsFilled.png}


\paragraph{Press OK}




Once you're done setting the configuration file and the database,
press "OK".  If you want to quit the program instead, press
"Cancel".





\subsection{The main screen}



Once you've pressed "OK" on the "Connection settings" dialog box,
you will see the main screen:



\includegraphics[scale=0.5]{MainScreen.png}

\subsubsection{Parts}




The main screen consist of these parts:


\begin{itemize}

  
\item A menu at the top. 

  \includegraphics[scale=0.5]{MenuBar.png}

  
\item Below that, a toolbar with
  buttons. 

  \includegraphics[scale=0.5]{ToolBar.png}

  
\item Below that, an area that is to display the text you want to
  chunk.  In the picture above, it is all white.

\end{itemize}

\subsubsection{Next}




Next, we describe each of these parts.



\subsubsection{Toolbar}



The toolbar looks like this:


\includegraphics[scale=0.5]{ToolBar.png}



The buttons represent actions, each of which will be explained
below.


\paragraph{New Connection}




{\bf New Connection}\ \includegraphics[scale=0.5]{connect.png}\ : Connects to a database via a configuration file 


\paragraph{Commit}




{\bf Commit}\ \includegraphics[scale=0.5]{commit.png}\ : Saves the chunking-changes made in the program,
by committing them to the database.


\paragraph{Split, Combine}




{\bf Split}\ \includegraphics[scale=0.5]{flash.png}\ : Splits the current chunk right before the currently
selected box.




{\bf Combine}\ \includegraphics[scale=0.5]{together.png}\ : Combines the chunk containing the currently
selected box with the previous chunk.


\paragraph{Move left, Move right}




{\bf Move left}\ \includegraphics[scale=0.5]{leftarrow.png}\ : Moves the chunk containing the currently selected box
one tab-stop to the left.




{\bf Move right}\ \includegraphics[scale=0.5]{rightarrow.png}\ : Moves the chunk containing the currently selected box
one tab-stop to the right.



\subsubsection{Menus}



There are four menus, each explained on its own:


\begin{enumerate}

  
\item File menu

  
\item Edit menu

  
\item Tools menu

  
\item Help menu

\end{enumerate}



\paragraph{File menu}

\paragraph{Connect...}




The "Connect..." menu item connects to a database via a
configuration file 




equivalent <page\_anchor id="1130">toolbar button:
\includegraphics[scale=0.5]{connect.png}.



\paragraph{Commit}