-================= Autshumato TMS =================-

Autshumato Terminology Management Solution (TMS) is a free web application for the management of multilingual terminology databases (termbanks).

Version: 1.0.0
Platform: Web based and in essence platform independent. It is however recommended to access the application using the latest version of the Mozilla Firefox browser.
License: Apache License version 2.0
The license is present in the "APACHE LICENSE-2.0.txt" document. The used components and equivalent licenses are listed in the "TMS Components & Licenses.txt" document. 
The licenses for the various components are also available in the "/Documentation/Licenses/" directory.

Project page: http://sourceforge.net/projects/autshumatotms
Developer: Centre for Text Technology (CTexT) at the North-West University (Potchefstroom Campus) in collaboration with the University of Pretoria.

Documentation:
Readme: This document
Server Setup: TMS Server Setup.odt
Help Guide: /Help/index.html
Components & Licenses: TMS Components & Licenses.txt
License: APACHE LICENSE-2.0.txt
Component Licenses: /Documentation/Licenses/


On the project page the complete source code and binaries can be downloaded. There are also sections where bugs and feature requests can be submitted. Check it regularly for the latest distribution.

-=== Build ===-
To build the application from the source code the following components are required:
- Eclipse IDE
	Although the application was created using Eclipse most IDEs should be able to build the application if all the requirements are met.
- PostgreSQL 8.4 (or later)
	The database for the system is a PostgreSQL database.
- Google Web Toolkit SDK 2.3.0 (or later)
	This can be downloaded from: http://code.google.com/webtoolkit/
	Complete installation instructions can also be found at the mentioned website.

Download and install Eclipse or the IDE of your choice. 

Go to the Google Web Toolkit website (http://code.google.com/webtoolkit/), download and install the GWT SDK and all relevant plugings. Complete steps on how this is done are available on the website. 

Download and extract the Autshumato TMS source code from the project page: http://sourceforge.net/projects/autshumatotms

Download PostgreSQL from http://www.postgresql.org/. Install PostgreSQL and define the default user as "postgres" with the password of your choice. 

Run the pgAdmin tool that should have been installed with PostgreSQL. Use this tool to create a new database named "tms" and create a new schema named "tms" under the created database. The owner of the schema should be the postgres user defined on installation.

Open a terminal (or console) and navigate to the PostgreSQL installation directory. Find the psql executable (should be in PostgreSQL/8.4/bin/). Then enter the following into the console:
psql -h localhost -p 5432 -U postgres -d tms < "/pathToTMSsource/Documentation/SQL.DACB.TMS-cleaned.sql"
pathToTMSsource is the path where you extracted the TMS source code.

The default database will now load into PostgreSQL. This database contains the default administrator user, user categories, fields, presets, data types and inputmodel with relevant access rights.

Edit the /pathToTMSsource/properties/AppConfig.properties file and change the password to the password you specified when installing PostgreSQL. (In this way the username can also be changed)

Start Eclipse (or your choice IDE) and import the TMS project into a workspace.
If everything installed and were configured correctly you should be able to run the TMS project as a web application.
The first time you run the application in development mode your browser will prompt you to install the gwt plugin. By completing the installation the system will load and run in the browser.

If you have any questions or problems post a message on the project page.


-=== Run ===-
- The application would have to been setup on a server with the database and configuration files properly implemented. This procedure is available in the "/Documentation/TMS Server Setup.odt" document.
- Internet browser
	We recommend using the latest Mozilla Firefox browser.
- Address to the application hosted on a server.
	You should be provided with the address of the application on a server from the person responsible for installing the application.


-=== Using the application ===-
For a complete guide on using the Autshumato TMS refer to the Help documentation which can be found in the /Help/ directory. The Help guide should also be available through the application.

The system can be accessed by anyone but without a valid user account you will have limited functionality. Signed on users will enjoy most of the functionality determined by the access rights of the specific user or user category to which the user belongs.

The administrator of the system is responsible for creating users, user categories, input models, fields, presets as well as the assigning of access rights. 


-=== Questions, Errors, etc. ===-
For any question or bug reports kindly post them on the project page and it will gain attention.