Northern Sámi and Norwegian Bokmål

                            apertium-sme-nob
===============================================================================

This is an Apertium language pair for translating between Northern
Sámi and Norwegian Bokmål. What you can use this language package for:

* Translating from Northern Sámi to Norwegian Bokmål
* Morphological analysis of Northern Sámi
* Part-of-speech tagging of Northern Sámi

For information on the latter two points, see subheading "For more
information" below. For analysis and POS-tagging of Bokmål, see
http://wiki.apertium.org/wiki/apertium-nn-nb

Requirements
===============================================================================

You will need the following software installed:

* lttoolbox (>= 3.1.2)
* apertium (>= 3.1.1)
* vislcg3 (>= 0.9.7.8188)
* foma (last tested with SVN revision 49)
* hfst3 (last tested with SVN revision 2174, configured with
  ./configure --enable-lexc --enable-proc --with-foma)

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

Compiling
===============================================================================

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

$ ./configure 
$ make
# make install

You can use ./autogen.sh instead of ./configure if you're compiling
from SVN. If you're using a --prefix to ./configure or ./autogen.sh,
make sure it's the same one you used to install apertium itself.

Testing
===============================================================================

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

$ echo "Mus lea oahpahus gaskkal guovtti ja njealji" | apertium -d . sme-nob
Jeg har undervisning mellom to og fire 

The following commands run tests which are on the Apertium wiki page:

$ sh regression-tests.sh 

$ sh pending-tests.sh 

Files and data
===============================================================================

* apertium-sme-nob.sme.lexc            - Monolingual dictionary for Sámi
* apertium-sme-nob.sme.twol            - twolc rules for Sámi dictionary
* apertium-sme-nob.sme-nob.rlx         - Constraint Grammar disambiguator for Sámi
* sme-nob.prob                         - Tagger model for Sámi
* apertium-sme-nob.sme-nob.lex         - Constraint Grammar WSD rules for Sámi
* apertium-sme-nob.sme-nob.dix         - Bilingual dictionary 
* apertium-sme-nob.sme-nob.t1x         - Chunking rules for translating into Bokmål
* apertium-sme-nob.sme-nob.t2x         - Interchunk1 rules for translating into Bokmål
* apertium-sme-nob.sme-nob.t3x         - Interchunk2 rules for translating into Bokmål
* apertium-sme-nob.sme-nob.t4x         - Postchunk rules for translating into Bokmål
* apertium-sme-nob.nob.dix             - Monolingual dictionary for Bokmål
* modes.xml                            - Translation modes

For more information
===============================================================================

* http://wiki.apertium.org/wiki/Installation
* http://wiki.apertium.org/wiki/apertium-sme-nob
* http://wiki.apertium.org/wiki/Using_an_lttoolbox_dictionary
* http://wiki.apertium.org/wiki/HFST
* http://wiki.apertium.org/wiki/Constraint_Grammar

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.freenode.net

See also the file AUTHORS included in this distribution.

Technical information
===============================================================================

Important Giellatekno SVN addresses:

SME Monodix: https://victorio.uit.no/langtech/trunk/gt/sme

Bidix: https://victorio.uit.no/langtech/trunk/words/dicts

==Monodix==

SME:

* The monodix is a subset of the GT sme transducer. 
** The file apertium-sme-nob.sme.twol should be kept up to date with
   twol-sme.txt (or, `tmp/sme-twol.hfst.txt` as produced by
   `make GTLANG=sme hfst` in the giellatekno/trunk/gt folder)
** The file apertium-sme-nob.sme.lexc should be kept up to date using 
   the update-morph/update-lexc.py script

NOB: 

* The monodix should probably be kept up to date with the 
  one in apertium-sme-nob, however
* we allow some differences in closed category words. 

==Bidix==

From the DTD for the GTSVN bidix:

<!--
This document is not quite finished yet...

Here are the pos tags:
 a  = Adjective
 m  = Masculine (nob)
 f  = Feminine (nob) 
 n  = Neuter (nob), noun (sme)
 S  = noun, still not given gender (nob)
 v  = verb
 adv  = adverb
 num = numeral
 pcle = particle
 p  = preposition (nob)
 pr = preposition (sme)
 po = postposition (sme)
 pron  = pronoun
 i  = interjection
 cc  = conjunction
 cs  = subjunction
 im = infinitive mark Ã¥ (nob)
 s  = sentence, or explanation
 x  = still no pos

Documenting
(the tags are short due to a manual cleanup)
r  root
e  entry
l  lemma
lc lemma comment 
m  meaning
re restriction (semantic restriction of the following t)
t  translation
x  example
xt example translation
.g group 
-->
