Difference between revisions of "Apertium-html-tools/Paradigm dictionary"

From Apertium
Jump to navigation Jump to search
Line 1: Line 1:
== Installation ==
== Installation ==
# Get [[APy]] and [[HTML-Tools]] running
# Get [[APy]] and [[HTML-Tools]] running
#* You'll need a version of APy that supports billookup and bilsearch modes, currently the [https://github.com/apertium/apertium-apy/tree/embeddings embeddings branch].
#* You'll need a version of APy that supports billookup and bilsearch modes, <s>currently the [https://github.com/apertium/apertium-apy/tree/embeddings embeddings branch]</s> in master branch as of 2025-10-14.
#* You'll need a version of HTML-Tools that supports paradigm dictionary mode, currently the [https://github.com/apertium/apertium-html-tools/tree/urum urum branch].
#* You'll need a version of HTML-Tools that supports paradigm dictionary mode, currently the [https://github.com/apertium/apertium-html-tools/tree/urum urum branch].
# Ensure that at least one language pair has a <tt>billookup</tt> mode and <tt>bilsearch</tt> mode in at least one direction (ideally both):
# Ensure that at least one language pair has a <tt>billookup</tt> mode and <tt>bilsearch</tt> mode in at least one direction (ideally both):

Revision as of 01:35, 15 October 2025

Installation

  1. Get APy and HTML-Tools running
    • You'll need a version of APy that supports billookup and bilsearch modes, currently the embeddings branch in master branch as of 2025-10-14.
    • You'll need a version of HTML-Tools that supports paradigm dictionary mode, currently the urum branch.
  2. Ensure that at least one language pair has a billookup mode and bilsearch mode in at least one direction (ideally both):
    • modes.xml will need blocks like in uum-eng.
  3. Optionally, add embeddings (documentation to follow)
    • You'll need a way to generate embeddings, cf. the scripts in uum-eng
    • You'll need to compile embeddings into a transducer, cf. uum-eng
    • You'll need to add a block to the modes.xml file, cf. uum-eng

Setting up paradigms

  1. Add a language module to dictionary/langs/
  2. Add a reference to the language file in dictionary/index.ts
  3. Localisation for labels is in strings/pos