Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support adding and editing code descriptions while coding #120

Closed
tanius opened this issue Mar 31, 2020 · 2 comments
Closed

Support adding and editing code descriptions while coding #120

tanius opened this issue Mar 31, 2020 · 2 comments

Comments

@tanius
Copy link
Member

tanius commented Mar 31, 2020

We recently re-enabled the Annotator.js comment field for adding and editing comments about annotations (#118). However, this turned out to be not what the customer wanted 🙂 Instead: while keeping the user interface exactly the same, the content of the comment field should instead be saved to the description field of the code.

This is workable, as we use Annotator.js in such a way that one annotation can only contain one tag ("code"). So the code description can be added and edited via the comment field.

The behavior would have to be like this:

  • When creating codes on the fly by entering a name of a not-yet-existing tag, the comment field's content would be added as the description of that code.

  • When selecting an existing code in the Annotator.js overlay by clicking on an entry in the auto-suggestion list, the comment field would be initialized at that time with that code's description. The description can be edited and will be saved to the code when saving the annotation.

  • When entering an existing code's name into the Annotator.js overlay (without clicking on an entry in the auto-suggestion list), the comment field should not be filled. Because otherwise, it would have to be re-filled on every keypress event, and it may lead a user to lose content from the comment field when correcting the name of a code before submitting. And to prevent data loss when submitting a code alongside with an empty comment field, as can happen in the case described above, the code description field must not be deleted but should stay unchanged.

@tanius
Copy link
Member Author

tanius commented Mar 31, 2020

This issue is blocked right now as the proposal is waiting for confirmation here.

@tanius
Copy link
Member Author

tanius commented Apr 6, 2020

It turns out that adding and editing code descriptions on the fly was not a very important requirement, and users rather want a way to add code translations on the fly.

For this feature, it seems more appropriate to just make it faster and more comfortable to add code descriptions, namely by providing a tabular view that allows to edit them together with code names and their translations. This is managed in #121.

@tanius tanius closed this as completed Apr 6, 2020
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants