Skip to content
This repository has been archived by the owner on Nov 12, 2023. It is now read-only.

Backlog

Jeff Zohrab edited this page Nov 11, 2023 · 2 revisions

This documentation is deprecated/obsolete. Lute v2 has been replaced by Lute v3, a full Python rewrite. Please see the Lute v3 manual which includes notes on installation. If you have Lute v2, you can easily migrate to v3. Thank you!


Below are features that would be nice to have. Some of these are already listed in Lute's GitHub issues. These are not listed in any particular order.

In addition to the feature and dev backlog, the massive task of the Lute v3 rewrite to Python is always present.

Feature backlog

Improved language support

  • Support non-consecutive multi-word terms - issue 58
  • Change how dictionaries are defined and used - issue 39
    • Add Kobo dictionary support - issue 41
    • Integrate Golden dict app with Lute - issue 5

Reading experience

  • change book reading so that page content is ajaxed in, instead of moving to new URL. This allows for audio player support.
  • Add navigate to arbitrary page in book -- -- e.g. when on page 600 and want to go back to page 21. maybe enter in a text box, dropdown, or vertical/horizontal slider.
  • Hotkey status update should update the form if it's displayed - issue 45
  • add "chapters" markings somehow to books, so I can build a table of contents, and see when a chapter ends
  • add "force page break" markers to text imports, e.g. "---" forces a break.
  • add book text search
  • arrow up and down to increase/decrease status number
  • add "Autopopulate" button for the parent term. In most languages, the parent is pretty visibly related to the child, but with a few letter changes. It´d be nice not to have to copy the whole word from below, but just press a button and then type the end of the word.

Audio

  • Add Audio controls to play text mp3. This requires page content to be ajaxed in, not URL-per-page.
  • Add word pronunciation. Audio files could be stored in user's data folder, and files could be found by md5 of term, e.g.

Backup

  • if a DB update is going to run, first back up the existing DB
  • on book export page (e.g. http://localhost:7777/mapparents/export_book/414), have a link to run the import as well
  • if backup is automatic, when the backup completes, auto-redirect to home page
  • show the file created and its size on the backup page
  • on main page, if backup was done, show the last date and last file name and size

Misc features

  • Add "term export" - issue 48
  • Add selective export to CSV for import into Anki or similar - issue 24
  • Possibly ignore word accents when saving terms in DB - issue 17
  • add bulk term delete
  • Add stats
    • words read today/cumulative
    • terms created today/cumulative
    • statuses by date/cumulative
    • click on link to see filtered list in terms page - need more complex filtering
  • editing text/sentence doesn't change the book WordCount. setWordCount is called when book is first created, on setFullText. If text is edited, should first save the old count, then update the book count

Dev/code backlog

Code maintenance/improvements. Doing these help deliver features or a better experience.

misc

  • Increase acceptance test coverage (master list) - issue 35
  • Drop extra fields from texts table (sourceuri, mediauri, lgid, isarchived). Started in branch hack_remove_texts_fields
  • save SeTextLC in sentences, use SeTextLC when looking up references
  • change statuses - null/0 unknown, 1-5, 6 = wellknown; 7 = ignored (currently 98 = ignored, good enough? or -1?)
  • RenderableSentence.php: public static function getParagraphs should not parse, move parsing to the facade
  • findTermsInText should use zws to join things, not null string. Add tests for "Tengo un gato" - "Tengo un" "tengo un gato", "tengo un gat", "un gato", "un gat"
  • remove languages.islgremovespaces field
  • change book "is archived" cycle? - active -> completed -> archived
  • try not saving and retrieving entities, see if orm can get them

docker (better user installs)

  • Consider docker pre-built images - issue 20
  • Creating a registry for the app image in Docker Hub - issue 59
  • Try smaller docker image
  • Try CI for testing docker on multiple platforms
Clone this wiki locally