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

Initiate Line Entity Class #48

Open
cubap opened this issue Feb 9, 2024 · 1 comment · Fixed by #53
Open

Initiate Line Entity Class #48

cubap opened this issue Feb 9, 2024 · 1 comment · Fixed by #53
Assignees
Labels
OSS An issue which is appropriate for OSS to work on.

Comments

@cubap
Copy link
Member

cubap commented Feb 9, 2024

A module for a "Line" is needed for use by the other services. In TPEN, a Line is a single Annotation with an id that is referenced in an Annotation Page items array. This Annotation Page is a single Page in an Layer (Annotation Collection). The module should support the methods needed for the api services.

A snip from the relevant document includes:

Single TPEN annotation as a “line” contains Canvas fragment and transcription content

  • Consider membership reference to parent Annotation Page
  • Consider previous and next lines
  • Parameterize
    • Only text content as string
    • Only Image link as URL
    • Get parent/sibling/project
    • Embed referenced documents
    • Metadata only
    • HTML document

The module should be created and importable, but all the methods can just stub out. Tests come first and can simply expect that methodName typeof === "function".

The clip above is a GET but there is also update and delete things to include.

@cubap cubap added the OSS An issue which is appropriate for OSS to work on. label Feb 9, 2024
@cubap
Copy link
Member Author

cubap commented Feb 9, 2024

use the attached branch 48-initiate-line-entity-class to add failing tests and start building.

@BhanuKandula5030 BhanuKandula5030 linked a pull request Feb 19, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
OSS An issue which is appropriate for OSS to work on.
Projects
None yet
2 participants