Edition VE - Word Based editing - Proof of Concept

[IanMcCrabb]

Develop the initial proof of concept phase of a word-based editing model.

• This will encompass an API that passes TokenID, EdtionID and new text sting to a READ service.
• The existing READ save services will be leveraged with a service that aligns the new text string with the constituent entities of the existing Token and resolves the READ data model accordingly.
• Develop minimal UI only. User to be at Word object level and UI to allow free text modification of Token label in Properties pane on the basis that user has rights to edit the edition.

Scope of first sprint to include:

• Free text editing with validation of Token string disallowing spaces and hyphens (report invalid use of tokenisation characters).
• Free text entry of TCM - with validation of valid nested TCM (report invalid TCM).
• Heterogenous ownership of Tokens.
• Prevent editing of cross-line or cross syllable tokens.

Explore solutions for later sprint (but not develop)

• cross token syllables.
• cross line tokens.
• sandhi.

[IanMcCrabb]

Quite some time has elapsed since we first outlined the specification for this POC and upon review there are issues which we may have addressed but escape me now.

Foremost is how we anticipate coping with the the insertion or deletion of a syllable. Did we plan to not support mismatches in syllable count and instead require the user to insert or delete a syllable in the edition VE prior to free text editing of that word?

[IanMcCrabb]

We went back and forward over some months as to whether free text editing was feasible and affordable (design is rarely unanimous, and always contentious) and ended up landing on a word-based model that supports editing per syllable from the properties pane. It is worth noting that this could be an optional addition to READ for those who want it, rather than replacing the existing methods. After 2 rounds of consultation have put together a preliminary design. The objectives are to provide an editing experience that maximizes the potential for users to become independently competent and minimizes the opportunities for error occasioning critical support issues.

This will of course be unpacked into a detailed specification prior to development but appreciate any and all feedback.

Word Based Syllable Editing UI.pptx