<?xml version="1.0"?>
<doc title="Administrator's Guide">
  <overview>
    <p>
      This document describes how to obtain, install, and configure
      the application.
    </p>
  </overview>

  <toc/>

  <section title="Minimum Requirements" id="reqmts">
    <p>
      In order to use this application, you must obtain the following
      components, install them, and configure them to interoperate
      (which is beyond the scope of this manual):
    </p>
    <ul>
      <li class="spaced">
        An application server that supports the following:
        <ul>
          <li><link dest="http://java.sun.com/products/servlet/">Java Servlet Specification 2.3 or later</link></li>
          <li><link dest="http://java.sun.com/products/jsp/">Java Server Pages Specification 1.2 or later</link></li>
        </ul>
        For example:
        <ul>
          <li><link dest="http://jakarta.apache.org/tomcat/index.html">Apache Jakarta Tomcat (tested on 4.1.27 through 4.1.29)</link></li>
          <li><link dest="http://www.jboss.org/products/jbossas">JBoss AS</link></li>
          <li><link dest="http://www.macromedia.com/software/coldfusion/">Macromedia Coldfusion</link> or <link dest="http://www.macromedia.com/software/jrun/">Macromedia JRun</link></li>
          <li><link dest="http://enhydra.objectweb.org/">Enhydra Server</link></li>
        </ul>
      </li>
      <li class="spaced">
        A database server that supports the following:
        <ul>
          <li><link dest="http://java.sun.com/products/jdbc/">JDBC 2.0 or later</link></li>
          <li>Auto-increment/auto-generation of primary keys.</li>
        </ul>
        For example:
        <ul>
          <li>
            <link dest="http://www.mysql.com/products/mysql/">MySQL (tested on 4.0.16 through 4.1.11)</link> and
            <link dest="http://www.mysql.com/products/connector-j/">MySQL Connector/J (tested on 3.1.1 through 3.1.8)</link>.
          </li>
        </ul>
      </li>
    </ul>
    <p>
      Consult your user support services team, system administrator, or
      account provider if you are unsure whether or not your systems meet
      these minimum requirements.
    </p>
  </section>

  <section title="Obtaining the Application" id="obtain">
    <p>
      After you have ensured that you meet the
      <link dest="#reqmts">minimum requirements</link>,
      download the latest release from
      <link dest="http://surjey.sourceforge.net/">SourceForge</link>.
    </p>
    <p>
      Unpack the distribution using an appropriate unarchiving tool.
      <link dest="http://www.7-zip.org/">7-Zip</link> is one such utility,
      and is also free, light-weight, and feature-rich.
    </p>
  </section>

  <section title="Installing the Application" id="install">
    <p>
      After you have
      <link dest="#obtain">obtained a release</link>,
      you will need to install it.
      The following instructions are fairly general to allow for variations
      between databases and container products and configurations.
    </p>
    <ol>
      <li class="spaced">
        If you are installing this application for the first time, you will
        need to create the database instance, named <litcode>surjey</litcode>,
        all the tables, and populate it with some sample data.
        If you are using MySQL for your database, you can use the provided SQL
        script, <file>tools/db/init_database.sql</file>, to do so.
        If you are using a different database, you can customize the SQL scripts
        in the <file>tools/db</file> directory, or inspect them to determine how
        to create the tables manually.
      </li>
      <li class="spaced">
        Deploy the application WAR file, <file>dist/surjey.war</file>, into
        your application server.
      </li>
      <li class="spaced">
        Access the application using a Web browser at the server path for
        your container followed by the context path you chose when you
        deployed the application in the previous step.
        For example, if you are using Tomcat with the default configuration,
        this address should be:
        <link dest="http://localhost:8080/surjey/">http://localhost:8080/surjey/</link>.
      </li>
    </ol>
  </section>

  <section title="Changes in Recent Releases" id="changes">
    <p>
      Release 0.3 simplifies the process of building a survey by combining
      the many of the separate screens together into master/detail screens.
    </p>
    <p>
      Release 0.3 includes some enhancements in the look and feel one
      experiences while building a survey.
    </p>
    <p>
      Release 0.2 includes a complete refactoring of the code within the
      Model, which is transparent for users, but is a significant improvement
      for developers.
    </p>
  </section>

  <section title="Known Issues" id="bugs">
    <p>None.</p>
  </section>

  <section title="Participate in Development" id="developer">
    <p>
      Please consult the <doclink dest="dev_guide.html">Developer's Guide</doclink>
      to find out how to participate in development.
    </p>
  </section>

  <section title="License and Copyright Information" id="license">
    <p>
      <copyright/>
    </p>
    <p>
      This program is free software; you can redistribute it and/or modify
      it under the terms of the <link dest="license.txt">GNU General Public License</link> as published by
      the Free Software Foundation; either version 2 of the License, or
      (at your option) any later version.
    </p>
    <p>
      This program is distributed in the hope that it will be useful,
      but WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      <link dest="license.txt">GNU General Public License</link> for more details.
    </p>
  </section>

</doc>