[RFC0007] Add annotations as conversation in single text mode

[tenkus47]

Table of Contents

• Housekeeping
• Named Concepts
• Summary
• Reference-Level Explanation
• Alternatives
  • Rationale
• Drawbacks
• Useful References
• Unresolved questions
• Parts of the system affected
• Future possibilities
• Infrastructure
• Testing
• Documentation
• Version History
• Recordings
• Work Phases

Housekeeping

Please add ref in specified format into RFC title, e.g [RFC9999] if corresponding RFW is [RFW9999].

Please add into this RFC and related PR's titles [RFC_id] e.g [RFC_9999].

ALL BELOW FIELDS ARE REQUIRED

Named Concepts

• Lopenling: An online discourse forum for lopenling community
• SSO: Single sign-on (SSO) is an identification method that enables users to log in to multiple applications and websites with one set of credentials.

Summary

• Medium style conversation panel which refocuses on the selected part of the text. Each edition and translations, commentaries, testimonies and Q&A will have their own lopenling discourse thread. Each edition and commentator will have their own lopenling profile. *

Reference-Level Explanation

The conversation panel app will have Django as backend and React as fontend. hosted at https://parkhang.lopenling.org

Webpage

• User can login or Signup using Lopenling discourse SSO
• Panel includes conversational annotation with text selector
• Each Question on a selected segment of text will create a new discourse thread on lopenling forum
• Panel includes original image source of text
• Each selected Text will have a Video panel ,Audio panel and alternate panel for reference text synced with it. -User can export the selected text in a OOXML format.

Alternatives

Currently there is no alternatives solution with tibetan text

Rationale

• There are some interactive text annotation app but most of which are not compatible with Tibetan text.

Drawbacks

Due to need of annotation on a segment level, each segment of word create a separate DOM element which will lead to a slow rendering experience.

Useful References

• Describe useful parallels and learnings from other requests, or work in previous projects. *
  • U/A
    • This Request may Affect the API call and the Annotation control part of system.

    Future possibilities

    Planning to implement graphql as a database in future

    Infrastructure

    Describe the new infrastructure or changes in current infrastructure required to fulfill this request.

    Testing

    • Developer Testing will include unit testing for each components in React *
    • Beta Testing will be done from different end users in a production environment to encounter any bug or issue related to improving the app. *

    Documentation

    Describe the level of documentation fulfilling this request involves. Consider both end-user documentation and developer documentation.

    Version History

    version 0.0.4

    Recordings

    U/A

    Work Phases

    Non-Coding

    Keep original naming and structure, and keep as first section in Work phases section

    • [x] Planning
    • [x] Documentation
    • [ ] Testing

    Implementation

    Backend

    • [x] Create rest API for interaction with text.
    • [x] Provide SSO information for login support with Lopenling forum.

    Frontend

    • [x] Create a panel for viewing text .
    • [x] Implementation of annotation on a selected Text and store the annotations on database .
    • [x] Create a panel for Video and Audio to sync with selected text
    • [x] Add Button to export the text in a MS Word supported text format
    • [x] Original Image of text will be present in the view panel of text accordingly with the page breakers
    • [x] Change textDetail length for more readability
    • [x] Update position of Annotation control to look like discourse forum
    • [x] Add different styling for each type of annotation
    • [x] embed discourse discussion
    • [x] Add LopenlingApp link in forum and forum link in LopenlingApp
    • [x] Multiple underlying on each thread in text
    • [x] Video alignment to have UI like chapter list in youtube
    • [x] #27
    • [ ] Add button and input field to add answer for each questions
    • [ ] Create iframe page to embed quotes in discourse ( expand context / Voting panel for alternate Spellings)
    • [ ] user annotation to go public as a suggestion

    A list of checkboxes, one per PR. Each PR should have a descriptive name that clearly illustrates what the work phase is about.

[tenkus47]

• [x] transfer annotation control to a portal
• [ ] create a voting panel iframe page for discourse

[tenkus47]

Video sync with Text

https://user-images.githubusercontent.com/42644738/196410003-4ebdf3ab-9370-4e21-bf3d-4e283b2428b2.mp4