crossdics/README

   1 QUICK START
   2
   3 1) Download the package cross-dics.tar.gz and linguistic data.
   4
   5 2) Unpack cross-dics and do:
   6    $ gunzip cross-dics.tar.gz
   7    $ tar xvf cross-dics.tar
   8    $ cd cross-dics
   9
  10 3) Compile source files
  11    $ ant compile
  12
  13 4) Copy linguistic data into folder "dics"
  14
  15    - Bilingual dictionary A-B:   apertium-bb-aa.bb-aa.dix
  16    - Bilingual dictionary B-C:   apertium-bb-cc.bb-cc.dix
  17    - Morphological dictionary A:  apertium-bb-aa.aa.dix
  18    - Morphological dictionary C:  apertium-bb-cc.cc.dix
  19
  20    Please note that:
  21
  22    - all dictionaries must be in the form:
  23         * apertium-xx-yy.xx-yy.dix (bilingual dictionaries)
  24         * apertium-xx-yy.xx.dix (morphological dictionaries)
  25    - the common language (B) must be in the left side, that is, dictionaries
  26      in the form B-A and B-C
  27
  28 5) Edit build.xml and indicate the set of dictionaries as follows:
  29
  30         <property name="bil-AB"  value="apertium-bb-aa.bb-aa.dix" />
  31         <property name="bil-BC"  value="apertium-bb-cc.bb-cc.dix" />
  32         <property name="monol-A" value="apertium-bb-aa.aa.dix" />
  33         <property name="monol-C" value="apertium-bb-cc.cc.dix" />
  34         <property name="mod-AB"  value="-n" />
  35         <property name="mod-BC" value="-n" />
  36
  37         Note:   use "-r" instead of "-n" if the dictionary has to be reversed.
  38                 (apertium-aa-bb.aa-bb.dix to apertium-bb-aa.bb-aa.dix)
  39
  40         Do "ant help" to know how to use the command line instead of editing
  41 build.xml.
  42
  43 6) Edit schemas/cross-model-test.xml file and customize the patterns if needed.
  44
  45 7) Use the tool:
  46
  47    $ ant cross
  48
  49 8) Crossed dictionaries can be found in folder "dix". The tool will generate
  50 the following files:
  51
  52         Crossed dictionaries ("safe crosssing")
  53         - apertium-aa-cc.aa-cc-crossed.dix
  54         - apertium-aa-cc.aa-crossed.dix
  55         - apertium-aa-cc.cc-crossed.dix
  56
  57         Speculations
  58         - apertium-aa-cc.aa-cc-crossed-specul.dix
  59         - apertium-aa-cc.aa-crossed-specul.dix
  60         - apertium-aa-cc.cc-crossed-specul.dix
  61
  62         Consistent dictionaries (without not common entries)
  63         - apertium-bb-aa.bb-aa-consistent.dix
  64         - apertium-bb-aa.aa-consistent.dix
  65         - apertium-bb-cc.bb-cc-consistent.dix
  66         - apertium-bb-cc.cc-consistent.dix
  67
  68         Dictionaries with not common entries
  69         - apertium-bb-aa.bb-aa-not-common.dix
  70         - apertium-bb-aa.aa-not-common.dix
  71         - apertium-bb-cc.bb-cc-not-common.dix
  72         - apertium-bb-cc.cc-not-common.dix
  73
  74 9) Have a look at the source file 'HowTo.java' in src/ to see an simple example
  75 using this library.
  76
  77         Do "ant howto" to run this demo.
  78
  79
  80
  81