Uspantek: `apertium-usp`
===============================================================================

This is an Apertium monolingual language package for Uspantek. 
What you can use this language package for:

* Morphological analysis of Uspantek
* Morphological generation of Uspantek
* Part-of-speech tagging of Uspantek

Requirements
-------------------------------------------------------------------------------

You will need the following software installed:

* lttoolbox (>= 3.3.0)
* apertium (>= 3.3.0)
* vislcg3 (>= 0.9.9.10297)
* hfst (>= 3.8.2)

If this does not make any sense, we recommend you look at: apertium.org.

Compiling
-------------------------------------------------------------------------------

Given the requirements being installed, you should be able to just run:

```bash
$ ./configure
$ make
```

You can use `./autogen.sh` instead of `./configure` if you're compiling
from source.

If you're doing development, you don't have to install the data, you
can use it directly from this directory.

If you are installing this language package as a prerequisite for an
Apertium translation pair, then do (typically as root / with sudo):

```bash
$ make install
```

You can use a `--prefix` with `./configure` to install as a non-root user,
but make sure to use the same prefix when installing the translation
pair and any other language packages.

Testing
-------------------------------------------------------------------------------

If you are in the source directory after running make, the following
commands should work:

```console
$ echo "Xinloqʼ jun aakʼ wuuq." | apertium -d . usp-morph
^Xinloqʼ/<perf><o_pl3><s_sg1>loqʼ<v><tv>/<perf><o_sg3><s_sg1>loqʼ<v><tv>$ ^jun/jun<det>$ ^aakʼ/aakʼ<adj>$ ^wuuq/<px1sg>uuq<n>$

$ echo "Xinloqʼ jun aakʼ wuuq." | apertium -d . usp-tagger
^loqʼ<v><tv><perf><o_sg3><s_sg1>$ ^jun<det>$ ^aakʼ<adj>$ ^uuq<n><px1sg>$

$ echo "Xinloqʼ jun aakʼ wuuq." | apertium -d . usp-phone
^Xinloqʼ/ʃinloqʼ$ ^jun/xun$ ^aakʼ/aːkʼ$ ^wuuq/wuːqʰ$

$ echo "Xinloqʼ jun aakʼ wuuq." | apertium -d . usp-segmenter
^Xinloqʼ/X>>in>loqʼ$ ^jun/jun$ ^aakʼ/aakʼ$ ^wuuq/w>uuq$
```

Files and data
-------------------------------------------------------------------------------

* [`apertium-usp.usp.lexc`](apertium-usp.usp.lexc) - Morphotactic dictionary
* [`apertium-usp.usp.phon`](apertium-usp.usp.phon) - Grapheme to phoneme convertor
* [`apertium-usp.usp.twol`](apertium-usp.usp.twol) - Morphophonological rules
* [`apertium-usp.usp.spellrelax`](apertium-usp.usp.spellrelax) - Spelling relaxation rules 
* [`apertium-usp.usp.rlx`](apertium-usp.usp.rlx) - Constraint Grammar disambiguation rules
* [`apertium-usp.usp.tagged`](apertium-usp.usp.tagged) - Tagged corpus
* [`usp.prob`](usp.prob) - Tagger model
* [`modes.xml`](modes.xml) - Translation modes

For more information
-------------------------------------------------------------------------------

* https://wiki.apertium.org/wiki/Installation
* https://wiki.apertium.org/wiki/apertium-usp

Help and support
-------------------------------------------------------------------------------

If you need help using this language pair or data, you can contact:

* Mailing list: apertium-stuff@lists.sourceforge.net
* IRC: `#apertium` on irc.oftc.net (irc://irc.oftc.net/#apertium)

See also the file [`AUTHORS`](AUTHORS), included in this distribution.

Sources
-------------------------------------------------------------------------------

* Can Pixabaj, Telma Angelina (2007) *Jkemiik yoloj li uspanteko* "Gramática uspanteca". (Guatemala: Cholsamaj).

