Search index registry
=====================

.. |add_icon| image:: /images/shared/add_icon.png

.. |db_gear_icon| image:: /images/shared/db_gear_icon.png

.. |open_icon| image:: /images/shared/open_icon.png

| In the main screen of Lingomancy there's a "Search" text input which can be used to find entries in several parts of your dictionary.  
| To start using this feature click on the |db_gear_icon| button to access the registry's list.  

| In this screen you'll find the list of each search index registry you have created for your languages.  
| This list and its names are independant of your languages.  

.. figure:: /images/examples/registry.png
	:align: left

| Start by typing a name (only letters and underscores are accepted, no spaces) of a file to save your registry, then hit enter or click the |add_icon| button.  
| This will create a new entry in your browser to store the data needed to make the search feature work.  

Building the registry
#####################

| When you first create your registry, or each time you click the |db_gear_icon| icon of a registry, all the necessary indexes of the registry will be generated.  
| This process has the following steps:  

- Generate all inflections of all words in your language.  
- Retrieve all free input fields of your words (i.e. definitions and translations).  
- Retrieve all phrases in your phrasebook.  
- Retrieve all entries in your grammar, processing them to retrieve only the text.  
- Initialize individual indexes for the retrieved data.  
- Compress and save indexes to the entry created in your browser.  

.. note:: 
	Lingomancy will not automatically update the indexes, since, with large dictionaries, it could take a long time, specially on low-end devices.  
	When your dictionary has been updated you'll have to return to this screen and click the |db_gear_icon| button of the corresponding registry.  

Loading and using the registry
##############################

Once the registry has been created, or loaded with the |open_icon| button, each time you access Lingomancy the indexes will be loaded and will be available in the main and filter screens with dedicated search fields.  

- Filter screen: You can search in the inflections index.  
- Main screen: You can search in all indexes.  
  Each entry in this field has a way to know which entity of your conlang matches your search.  

  - F: Fields of the words: Click to filter the dictionary list.  
  - I: Inflections of the words: Click to open the :doc:`inflection's search screen<inflection_search>`.  
  - P: Phrases in your phrasebook: Click to open the :doc:`phrasebook<phrasebook>` with the selected phrase in the edit modal.  
  - G: Grammar section: Click to open the :doc:`grammar<grammar>` screen with the section open.