[Feature] Figure metadata editor

[michael]

Description

Improved editing for figure metadata.

Status: In development

Considerations

• Create multiple keywords for a keyword category
• Quickly add a new keyword to an existing list
• Use keyboard navigation only to add, edit, delete a keyword
• Ability to achieve all tasks also without keyboard shortcuts

XML requirements

Figure Metadata keywords:

<fig>
<kwd-group kwd-group-type="exp-system">
  <label>Exp. System</label>
  <kwd>immunostaining</kwd>
  <kwd>confocal microscopy</kwd>
</kwd-group>
<kwd-group kwd-group-type="measured-variables">
  <label>Measured-Variables</label>
  <kwd>immunostaining</kwd>
  <kwd>confocal microscopy</kwd>
</kwd-group>
</fig>

Proposal

Clicking on a keyword field, opens a dialog for editing. Cursor can be placed in any keyword item in the list. Initially the cursor is set to the "enter new keyword" field, which when confirmed with ENTER (or the create button) adds a new keyword item.

• multiple new keywords canbe entered with a simple click > type > ENTER > type > ENTER sequence
• navigation possible via keyboard, cursor jumps to nearby fields
• keyboard shortcut (delete = fn+backspace) will remove the selected keyword

Future

• Auto completion
• Semantic concept linking

[michael]

@Melissa37 we are aware this currently only addresses source data user stories. We'd like to have the additional user stories of eLife and the others, so if you could give that a priority and create separate tickets for your use-cases with user stories. We will try to consider those in the design of this one, but not necessary address all user stories in the first iteration, which has the goal to allow SourceData starting their piloting phase.

[Melissa37]

@michael we will prioritise this - it was in week 7. We'll try to give you something next week. @NickDuf could you look at the visuals for this so far?

Thanks!

[michael]

Thank you @Melissa37. We thought that the first stage here is basic plain text keyword editing, with a minimal interface, this should work for the basic article level keywords. Next we could extend this with:

• Auto suggestion: Keywords from a dictionary
• Semantic linking: E.g. for contributor roles (Credit Taxonomy)

[NickDuf]

@Melissa37 do we have any user stories for this feature from our end?

[Melissa37]

@michael do you mind if I rename this to Keywords and categories and add our user stories to it from the Consortium? I can do this today with your approval.

I think we need better user stories for the Source Data requirement. It would be good to understand better about this, I have a little understanding from the call we had with them.

We are lucky that JATS4R has a draft proposal out for public comment to help guide us

[michael]

@Melissa37 sounds good.

I renamed this ticket to "Figure metadata editor" - we are already working on this. I will create a separate new ticket "Keywords and categories" where you can capture all requirements and then at a later point refine the existing implementation (which currently only has the goal to improve figure metadata editing).