Dictionary alias

[khaitruong922]

#569

• Add field alias to dictionary settings, which has default value of title
• Make dictionary title editable

[khaitruong922]

TO DO:

• Make popup displays alias instead of title.
• Update preview popup whenever the alias is changed.

Need advice
Currently DOMDataBinder only binds input element, which does not work for contenteditable. Currently my workaround is to create a hidden input field which updates whenever the contenteditable element is updated. This is probably not a good pracitce. I'm not too sure of how DOMDataBinder class works. Is it possible to add a binding for elements with contenteditable === "true"?

[codspeed-hq]

CodSpeed Performance Report

Merging #1270 will not alter performance

_{Comparing khaitruong922:dictionary-alias (ee153cd) with master (9ef85b5)}

Summary

✅ 5 untouched benchmarks

[jamesmaa]

Currently DOMDataBinder only binds input element, which does not work for contenteditable. Currently my workaround is to create a hidden input field which updates whenever the contenteditable element is updated. This is probably not a good pracitce. I'm not too sure of how DOMDataBinder class works. Is it possible to add a binding for elements with contenteditable === "true"?

@Kuuuube could you help out with this if you happen to know something?

[Kuuuube]

From a quick look I dont see any reason why adding a div or other contenteditable element is an issue. DOMDataBinder doesnt seem particularly complex either.

Creating a hidden element to mirror the setting sounds like a future hell-bug waiting to happen.

[khaitruong922]

Should we use dictionary alias or original dictionary name in Anki glossary field?

[Casheeew]

Should we use dictionary alias or original dictionary name in Anki glossary field?

I believe so. We should only use the original dictionary name for keying purposes (I believe that's how it's implemented currently?) but basically use the dictionary alias everywhere else for consistency.

[Kuuuube]

Can this be fixed? When clicking on empty space next to the dict name it starts editing the name of the dict below it something like this:

[Kuuuube]

Not seeing any way to revert the alias also. There should be a button or something somewhere to revert it. Maybe on the kebab menu.

[khaitruong922]

The user can empty the alias to reset it back to the original name. Adding an option on kebab menu sounds fine.

[khaitruong922]

• Move alias edit inside modal which is opened kebab menu and use input instead.
• Remove contenteditable and add element type in dom-data-binder
• Add Reset button to set the input to dictionary name.

Please give feedback on wording, UI/UX of new design.

[StefanVukovic99]

I think it's good.
I'd maybe like to have the Set Alias be called Rename to be easier to understand. The {dictionary} and {dictionary-alias} handlebars might then be less understandable, but I don't think they get much use anyway.

[khaitruong922]

I would prefer something in between like changing the menu option to Rename but the help message will be kept as Input the alias for X dictionary:. It should be clear that this is not a complete rename (the user cannot rename then add the same dictionary) but just a visual change for pop-up and Anki. The user can still recall what alias is after they have done the renaming.

[StefanVukovic99]

The term Display name might also be helpful somewhere as an alternative to alias

[khaitruong922]

Documentation and menu updated with new texts. Still keeps the alias for code naming and Anki marker,