grammatek/simacorrect

Icelandic spell checker for android

simacorrect's Issues

Import dictionaries

Allowing users to import dictionaries, whether it would be from individuals, institutions or their old phones.

Need to investigate how feasible this really is and if so, how much support can we provide.
Items to investigate:

• Enable users to import dictionaries
• View a collection of dictionaries recommended by institutions, companies or even individuals.

Suggestion process stops if a correction is used by the user.

Example to help describe the bug: Let's say you write 3 words, word a, b and c. The spell checker iterates through all the words, processing 1 at time. Let's say you write those words pretty fast and immediately as you get spell suggestion for word a you use that to correct the word. Meanwhile the spell checker is still "processing" word b and c, and if you use the correction for word a while that is still going on, you somehow stop the spell checking process and you won't get suggestions for word b and c UNLESS you continue writing (for each new word the spell checker iterates through the whole thing.)

Note:
This might only be an issue while the response from the API is as slow as it is currently. Before being able to determine if this issue is worth looking into we need to be able to replicate this after we've setup a proper API with fast response time.

API / Connection management

Create a class that encompasses all the networking stuff required by our application.

• API call handler
• #5
• method to check if there is a valid connection

Rename DeveloperApi => YfirlesturApi

The name DevelopersApi is misleading. We should name it according to a more appropriate name.

Equip spell checker with UserDictionary

Give the spell checker access to the user's dictionary to compare against before correcting words.

Create app file to tie together components in application

Currently this application doesn't have a app.kt and only 1 activity which currently acts as the starting point for the application. We need a proper starting point to initialize all of our components and tie them together.

Add CI to project

CI / Github actions should build the project. Should be looking similar to this.

cache for API calls

After a proper API has been established it should be worth while to explore caching to see if it increases performance by any meaningful amount.

Samsung Keyboard not compatible

Samsung Keyboard doesn't support a custom spell checker so one must use another keyboard such as Gboard.
This is stated in the readme but not indicated in the application itself.
Ideally we need something to identify if a keyboard supports the spellchecker instead of what we do currently, which is:
Redirect users to LanguageSettings, which is fine if users use a compatible keyboard but leaves users with no resolution if the keyboard isnt compatible.

Solution I propose.
Identifying if the keyboard doesen't support a spell checker and instead ask the user if he want's to install Gboard to be able to use the spell checker. If the user has a keyboard installed that is compatible with a spell checker, redirect the user to those settings.

Add internet connectivity checker

Add error handling for lost connection

Add Icelandic I8N

All UI should be available in Icelandic as well

Create info screen

Info screen with information about the app, device, company, e.t.c.

• Add button to main activity to open this activity
• Create activity with "about attributes" Version / URL / e.t.c.
• #9

Robust connection handling

Currently dealt with in a "temporary" manner in #1 but we are in need of a more robust solution.
Currently we just throw a generic exception if the API calls fail but ideally we would need to handle all the different ways things could go wrong.

Simaromur's connection check used as reference point.

• Implement registerNetworkCallback to check on network availability
• Implement a periodic health check

Add privacy notice

We need to create the privacy notice for Simacorrect (or whatever name it will end up). This privacy notice should be added on the Grammatek homepage at an HTML anchor similar to https://www.grammatek.com/legal#simaromur.

• Prepare privacy notice on homepage
• Add anchor into privacy notice dialog inside Simacorrect

Add custom dictionary to spell checker

Spell checker currently has no awareness of built in or custom (user) dictionaries

Suggestions looping bug

If I get 2 suggestions for 1 annotation and select one of them and get a suggestion for the same word I'll get my original word as a suggestion.
E.g. if I write eg dreymi I will get 2 suggestions for eg, ég and mig.
If I select the suggestion ég I will have the text ég dreymi and we don't get any more suggestions at this point.
If I continue typing and add the word að a new API request is triggered to check the input text ég dreymi að, now we get a suggestion again for the first word ég, except in this case Yfirlestur suggests only the word mig but what also comes as a suggestion is eg, the original word typed by the user.

This additional suggestion eg is not being given by the web service nor being stored anywhere in the spell checker service, this is being stored in the UI layer which interfaces text input boxes.

Interestingly enough, this occurs only on android version 12 and newer, meaning I'm unable to reproduce this on android version 11. There were some changes to android.view.textservice on version 12 that are likely causing this but one would need to take a deep dive to investigate this further.