Keyword Data Structure Integration

[LorenzoGrama]

Proposal for Keyword Data Structure Integration

Introduction

At SISSA Medialab we are planning to introduce a custom version of the submission process which enables authors to submit articles by using arXiv submission as a source of metadata.

We plan to support a different set of keywords for each arXiv category for the same journal, and we thus need to organise keywords in a hierarchy.

We planned the implementation to be entirely optional to preserve full compatibility with the current Janeway implementation and the model, logic classes and manager level, to avoid any additional modification on the other users of Janeway.

We are currently planning to provide a full implementation of the model changes described below and the manager changes needed to manage the hierarchy. Enriched widgets to support hierarchy - weight selection in the plain Janeway submission are still to be planned, as we will likely implement a different flow of submission using a bootstrap based template.

Technical detail

The proposal to integrate the following keyword data structure into Janeway has two main objectives:

• Enable the author, during submission, to select keywords from a list of structured groups and subgroups, and to assign a weight to each of the selected keywords
• Enable back-office users to manage these groups and the keywords contained within them. This includes:
  • Creation and deactivation of keywords
  • Creation of groups
  • Insertion or removal of keywords within groups
  • Modification of the display order of these groups
  • Addition of personal notes

The following is an overview of the changes that would be introduced by this proposal:

• KeywordGroup
  • parent_group - ForeignKey to "self"
    • Allows the construction of the hierarchical structure of keyword groups.
  • order - IntegerField
    • Useful for display purposes, especially to allow modifications by back-office users.
  • notes - TextField
• Keyword
  • group - ForeignKey to KeywordGroup
  • created - DateTimeField
  • deactivated - DateTimeField
    • Tracks the deactivation date of a keyword, useful for differentiating inactive keywords from active ones.
  • notes - TextField
• KeywordArticle
  • weight - IntegerField
    • Allows the author to assign a weight to each of the selected keywords during submission.

[ajrbyers]

I've read over this proposal and it sounds great - its something we'd really like to have as an option in core. Do you think it would be possible to develop it as part of the core and have it be enabled via a setting? This might make the process easier for you as well.

[LorenzoGrama]

Yes, that's exactly what we were thinking about. We'll follow up with a PR soon, thanks!