Autshumato ITE Files

============== Autshumato Document Naming System Plugin for OmegaT ==========

Version: 1.0.1
Compatible with OmegaT version: 4.3.2 and later
License: GNU GPL 3 (or later)
The licence is available in the OmegaT-plugins-Autshumato-GPLv3License.txt document.
Project Page: http://sourceforge.net/projects/autshumatoite/

The Autshumato Document Naming System plugin for OmegaT provides functionality for defining and renaming project documents according to a specific structure.


============== About Autshumato ==========================================

The Autshumato project was initiated by the South African Department of Arts and Culture, and developments are done by the Centre for Text Technology (CTexT®) at the North-West University (Potchefstroom Campus).

The general aim of this project is the development of open source machine-aided translation tools and resources for South African languages. The term "open source" implies that every application developed in this project is freely available to the general public. This definition also extends to the source code of every application.

The objective of establishing this project as an open source project adheres to the South African National Government's policy and strategy for open source implementation. This policy specifies that all new software developed for government should be based on open standards. Furthermore, government also encourages and supports the use of open content and open standards within South Africa.

Website: http://autshumato.sourceforge.net/


============== INSTALL ===================================================

To install the plugin, extract all the contents of "OmegaT-plugins-AutshumatoDNS.zip" file into the /plugins/ directory of your OmegaT installation.
After successful installation the /plugins/ directory should contain (at least) the following files:

/OmegaT/plugins/
- OmegaT-plugins-AutshumatoDNS.jar
- OmegaT-plugins-AutshumatoDNS-GPLv3License.txt
- OmegaT-plugins-AutshumatoDNS-Readme.txt


============== USE =======================================================

Run OmegaT.
After OmegaT has started up, go to Options -> Configure Autshumato DNS... Complete and define the set of Fields to include in the naming system, as well as the separator to include between fields, e.g. full stop(.) or hyphen (-). Once the respective fields have been completed, Click on OK
To rename documents in a particular project, open the project and then go to Options -> Rename documents... In this dialog the new document name will be displayed, and some of the field values can be adjusted to particular documents. Once completed, click on OK, and the documents will be renamed according to the defined naming system.

If the Menu does not contain the new menu item, the installation was not successful. Please ensure that the plugin was extracted to the correct location and that it is not contained within a subdirectory. 


============== TO BUILD ==================================================

To build the plugin, you require the complete OmegaT and Omegat-plugins-AutshumatoDNS sources which are available from: http://sourceforge.net/projects/omegat/ and http://sourceforge.net/projects/autshumatoite/ respectively.
Download and extract the sources. The project was created using the NetBeans IDE 12.1 and it is recommended but not required to use the same environment.
The build uses the Apache Maven build infrastructure, and all required libraries are defined as part of the Maven pom.xml file for each project.


============== BUGS, FEATURE REQUESTS & HELP =============================

To report bugs, request new features, or to obtain additional help, visit the project page at: http://sourceforge.net/projects/autshumatoite/

Bug Reporting: https://sourceforge.net/p/autshumatoite/bug-reports
Feature Requests: https://sourceforge.net/p/autshumatoite/discussion
Help: https://sourceforge.net/projects/autshumatoite/support

For additional Autshumato plugins and resource or to become involved with the Autshumato project visit the website: http://autshumato.sourceforge.net/


============== LIBRARIES & LICENCES ======================================

OmegaT 5.7.1 (GPLv3)
lib-mnemonics (GPLv2)

==========================================================================