Talk:Documentation

New 'indexes' section

The new 'indexes' section ought to be auto-generated, for easy maintenance. But the current state of article categorisation means the display would be a visual disaster. For now, hand-edited.

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

Official documentation (214 pages) has an error on page 12: 2.2. Data Stream without format. Into that text a picture is projected. Muki987 11:07, 9 April 2009 (UTC)

Standard format for README files

A proposal for a standard format for README files in Apertium. This is for a language pair between Language1 and Language2, using the ISO codes code1 and code2. The note about regression tests would be removed if the language pair has none of course.

Language1 and Language2

                            apertium-code1-code2
===============================================================================

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

* Translating between Language1 and Language2
* Morphological analysis of Language1 and Language2
* Part-of-speech tagging of Language1 and Language2

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

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

You will need the following software installed:

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

If this does not make any sense, we recommend you look at: www.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 you're compiling from
SVN. If you installed any prerequisite language packages using a --prefix
to ./configure, make sure to give the same --prefix to ./configure here.

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

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

$  echo "My hovercraft is full of eels" | apertium -d . code1-code2
My skeertuig is vol palings

$ echo "My skeertuig is vol palings" | apertium -d . code2-code1
My hovercraft is full of eels

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

$  echo "My hovercraft is full of eels" | apertium code1-code2
My skeertuig is vol palings

The following command runs tests which are on the Apertium wiki page:

$ ./regression-tests.sh 

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

* apertium-code1-code2.code1.dix        - Monolingual dictionary for Language1
* apertium-code1-code2.code1-code2.dix  - Bilingual dictionary 
* apertium-code1-code2.code2.dix        - Monolingual dictionary for Language2
* code1-code2.prob                      - Tagger model for Language1
* code2-code1.prob                      - Tagger model for Language2
* apertium-code1-code2.code1.tsx        - Tagger training rules for Language1
* apertium-code1-code2.code2.tsx        - Tagger training rules for Language2
* modes.xml                             - Translation modes

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

* http://wiki.apertium.org/wiki/Installation
* http://wiki.apertium.org/wiki/apertium-code1-code2
* http://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.freenode.net

See also the file AUTHORS included in this distribution.

Here's a template for monolingual packages:

Language1

                            apertium-code1
===============================================================================

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

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

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

You will need the following software installed:

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

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

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

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

$ ./configure
$ make

You can use ./autogen.sh instead of ./configure you're compiling from
SVN.

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):

# make install

You can give a --prefix to ./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:

$  echo "My skeertuig is vol palings" | apertium -d . code1-morph
^My/My<det><pos><sp>/Prpers<prn><obj><p1><mf><sg>$ ^skeertuig/skeertuig<n><sg>$ ^is/wees<vbser><pres>$ ^vol/vol<adj><pred>$ ^palings/paling<n><pl>$

$ echo "My skeertuig is vol palings" | apertium -d . code2-tagger
^My/My<det><pos><sp>$ ^skeertuig/skeertuig<n><sg>$ ^is/wees<vbser><pres>$ ^vol/vol<adj><pred>$ ^palings/paling<n><pl>$

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

* apertium-code1.code1.dix        - Monolingual dictionary
* code1.prob                      - Tagger model
* apertium-code1.code1.rlx        - Constraint Grammar disambiguation rules
* modes.xml                       - Translation modes

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

* http://wiki.apertium.org/wiki/Installation
* http://wiki.apertium.org/wiki/apertium-code1
* http://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.freenode.net

See also the file AUTHORS included in this distribution.