Skip to content

Feature/#76 collation based on sections

Michelle Weidling requested to merge feature/#75-collation-based-on-sections into develop

Feature

Summary

This MR provides plain texts according to the semantic divisions of a text which are indicated by tei:milestone.

Even if a manuscript doesn't provide a certain section, the corresponding TXT is created so that the collation results do not get distorted.

Each semantic division is stored in a separate *.txt at /txt/ and provided as a ZIP at content/ahikar-plain-text.zip.

Compliance to “Definition of Done”

  • Unit tests passed
  • Code reviewed
  • Acceptance criteria met
  • Functional tests passed
  • Non-Functional requirements met
  • Product Owner accepts the User Story

Use Cases

This feature is necessary for collating the text based on their semantic divisions. This allows for parallelizing the collation and thus speeding it ip.

Documentation

  • I updated the README (if applicable)
  • I provided my functions with appropriate documentation
  • I updated existing documentation

Tests

Are we able to test this new feature?

  • Yes, everything can be done via unit tests.
  • Yes, you can test by following these steps:
  1. eventually re-run a pipeline for this branch
  2. curl https://ahikar-test.sub.uni-goettingen.de/api/content/ahikar-plain-text.zip --output ahikar-plain-text.zip

OR

  1. Build the database locally
  2. Load some Ahiqar data
  3. Import tapi-txt.xqm to a new XQuery script and run tapi-txt:main()
  4. See the results in SADE's txt collection

Changelog

  • I added a statement to the CHANGELOG.

Version number

  • I bumped the version number in build.properties.

Related Tickets

Closes

Closes #76 (closed).

/cc Mathias Göbel, Frank Schneider, Michelle Weidling

Edited by Michelle Weidling

Merge request reports