README

# Finnish and German: `apertium-fin-deu`

This is an Apertium language pair for translating between Finnish and
German. What you can use this language package for:

* Translating between Finnish and German
* Morphological analysis of Finnish and German
* Part-of-speech tagging of Finnish and German

For information on the latter two points, see subheading "For more
information" below.

The word-form translations are manually inputted with some data scraped from
wiktionary and verified by hand.

## Requirements

You will need the following software installed:

* autoconf
* automake
* pkg-config
* lttoolbox (>= 3.5.1)
* apertium (>= 3.6.1)
* vislcg3 (>= 1.3.1)
* hfst (>= 3.15.1)
* apertium-fin
* apertium-deu

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:

```console
$ autoreconf -fvi
$ ./configure
$ make
# make install
```

You can use `./autogen.sh` instead of `autoreconf` and `./configure` in case
you're compiling from source. If you installed any prerequisite language
packages using a `--prefix` with `./configure`, make sure to use the same
`--prefix` when running `./configure` here.

If any of this doesn't make sense or doesn't work, see
https://wiki.apertium.org/wiki/Install_language_data_by_compiling

## Testing

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

```console
$ echo "talo" | apertium -d . fin-deu
Haus

$ echo "Haus" | apertium -d . deu-fin
talo
```

After installing somewhere in `$PATH`, you should be able to do e.g.

```console
$ echo "talo" | apertium fin-deu
Haus
```

## Files and data

* [`apertium-fin-deu.fin-deu.dix`](apertium-fin-deu.fin-deu.dix) - Bilingual
  dictionary
* [`apertium-fin-deu.fin-deu.rtx`](apertium-fin-deu.fin-deu.rtx) - Structural
  transfer rules for translating into German
* [`apertium-fin-deu.deu-fin.rtx`](apertium-fin-deu.deu-fin.rtx) - Structural
  transfer rules for translating into Finnish
* [`apertium-fin-deu.fin-deu.lrx`](apertium-fin-deu.fin-deu.lrx) - Lexical
  selection rules for translating into German
* [`apertium-fin-deu.deu-fin.lrx`](apertium-fin-deu.deu-fin.lrx) - Lexical
  selection rules for translating into Finnish
* [`modes.xml`](modes.xml) - Translation modes

## For more information

* <https://wiki.apertium.org/wiki/Installation>
* <https://wiki.apertium.org/wiki/apertium-fin-deu>
* <https://wiki.apertium.org/wiki/Using_an_lttoolbox_dictionary>

## 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.

## Cite as

**Flammie A Pirinen** (2018):
*Rule-based machine-translation between Finnish and German* in
[DGfS 2018: 40. Jahrestagung der Deutschen Gesellschaft für Sprachwissenschaft,
CL-Postersession](https://www.dgfs2018.uni-stuttgart.de/DGfS_2018_booklet_ONLINE_FINAL.pdf).

```bibtex
@misc{
    author = {Flammie A Pirinen},
    year = {2018},
    title = {Rule-based machine-translation between Finnish and German},
    booktitle = {DGfS 2018: 40. Jahrestagung der Deutschen Gesellschaft für
        Sprachwissenschaft},
    url =
    {https://www.dgfs2018.uni-stuttgart.de/DGfS_2018_booklet_ONLINE_FINAL.pdf},
    pages = {337}
}
```

A TeX source and author's draft version can be found in [Flammie's academic
publications repository](https://flammie.github.io/purplemonkeydishwasher).