Difference between revisions of "Apertium-html-tools/Paradigm dictionary"
		
		
		
		
		
		
		Jump to navigation
		Jump to search
		
				
		
		
		
		
		
		
		
	
Firespeaker (talk | contribs)  | 
				Firespeaker (talk | contribs)   | 
				||
| Line 21: | Line 21: | ||
#* 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 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].  | 
||
#* Make sure your <tt>config.ts</tt> is updated to include the following:  | 
|||
#** <tt>Mode.Dictionary</tt> should be in <tt>enabledModes</tt> list (and can be set as the <tt>defaultMode</tt>)  | 
|||
#** <tt>apyURL</tt> and <tt>htmlUrl</tt> will need to be updated to match your setup  | 
|||
# 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):  | 
||
#* <tt>modes.xml</tt> will need blocks like in [https://github.com/apertium/apertium-uum-eng/blob/01896a5ce3fc58e218c27fe4b97167069683a4a7/modes.xml#L45-L65 uum-eng].  | 
  #* <tt>modes.xml</tt> will need blocks like in [https://github.com/apertium/apertium-uum-eng/blob/01896a5ce3fc58e218c27fe4b97167069683a4a7/modes.xml#L45-L65 uum-eng].  | 
||
Revision as of 14:34, 16 October 2025
Paradigm dictionary mode in HTML-Tools offers bilingual dictionary functionality with paradigms, all based on Apertium data. This is especially useful for language communities where there are few existing resources for learners.
Contents
Overview of functionalilty
Dictionary lookup
- Searches both languages, displays in direction of chosen pair.
 - Based on Apertium bilingual dictionaries.
 - Uses Apertium monolingual analysers: can search any morphological form of a word, will show in results which form the searched form is. (Might not support synchronicity?)
 - Semantic fuzzy search based on word embeddings.
 
Paradigm display
- Generates paradigm per word based on POS.
 - Can select different modes for paradigm display, e.g., learner vs. linguist. Headings are also localised(/localisable),
 
Poster
Installation
- Get APy and HTML-Tools running
- You'll need a version of APy that supports billookup and bilsearch modes, 
currently the embeddings branchin master branch as of 2025-10-14. - You'll need a version of HTML-Tools that supports paradigm dictionary mode, currently the urum branch.
 - Make sure your config.ts is updated to include the following:
- Mode.Dictionary should be in enabledModes list (and can be set as the defaultMode)
 - apyURL and htmlUrl will need to be updated to match your setup
 
 
 - You'll need a version of APy that supports billookup and bilsearch modes, 
 - 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.
 
 
Setting up paradigms
- Add a language module to dictionary/langs/
 - Add a reference to the language file in dictionary/index.ts
 - Localisation for labels is in strings/pos
 
Adding embeddings
Embeddings allow searches to return semantically similar results. This is optional.
Real documentation to become available. For now some hints: