CHANGELOG.md 27.1 KB
Newer Older
mrodzis's avatar
mrodzis committed
1
2
3
4
5
6
7
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

mrodzis's avatar
mrodzis committed
8
9
10
11
12
## [7.9.0] - 20220915

### Changed

- updated eXist-db to 6.0.1
Mathias Goebel's avatar
Mathias Goebel committed
13
14

## [7.8.0] - 20211213
mrodzis's avatar
mrodzis committed
15

Mathias Goebel's avatar
Mathias Goebel committed
16
### Fixed
mrodzis's avatar
mrodzis committed
17

Mathias Goebel's avatar
Mathias Goebel committed
18
19
- moving base image of eXist-db to sepia (harbor.gwdg.de/sub-fe), with updated log4j 2.15.0

20
## [7.7.1] - 20211014
mrodzis's avatar
mrodzis committed
21

22
### Feature
mrodzis's avatar
mrodzis committed
23

24
25
26
- when TextGrid Server is down, items are generated now as well

### Fixed
mrodzis's avatar
mrodzis committed
27

28
29
- surplus annotations generated for `tei:choice` within `tei:damage`

Mathias Goebel's avatar
Mathias Goebel committed
30
## [7.7.0] - 20211011
mrodzis's avatar
mrodzis committed
31

Mathias Goebel's avatar
Mathias Goebel committed
32
### Changes
mrodzis's avatar
mrodzis committed
33

Mathias Goebel's avatar
Mathias Goebel committed
34
35
- source data update

36
## [7.6.4] - 20210927
mrodzis's avatar
mrodzis committed
37

38
### Fixed
mrodzis's avatar
mrodzis committed
39

40
41
- ItemURL in search response now aware of new domain used and set by `$commons:server`

Mathias Goebel's avatar
Mathias Goebel committed
42
## [7.6.3] - 20210921
mrodzis's avatar
mrodzis committed
43

Mathias Goebel's avatar
Mathias Goebel committed
44
### Fixed
mrodzis's avatar
mrodzis committed
45

Mathias Goebel's avatar
Mathias Goebel committed
46
- Salahni manifest creation (type error)
Mathias Goebel's avatar
Mathias Goebel committed
47

Mathias Goebel's avatar
Mathias Goebel committed
48
## [7.6.2] - 20210921
mrodzis's avatar
mrodzis committed
49

Mathias Goebel's avatar
Mathias Goebel committed
50
### Fixed
mrodzis's avatar
mrodzis committed
51

Mathias Goebel's avatar
Mathias Goebel committed
52
53
- remove translation from search API

Mathias Goebel's avatar
Mathias Goebel committed
54
## [7.6.1] - 20210917
mrodzis's avatar
mrodzis committed
55

Mathias Goebel's avatar
Mathias Goebel committed
56
### Changes
mrodzis's avatar
mrodzis committed
57
58

- website: paragraphs from `tei:abstract` are transformed to list items
Mathias Goebel's avatar
Mathias Goebel committed
59
60

### Fixed
mrodzis's avatar
mrodzis committed
61

Mathias Goebel's avatar
Mathias Goebel committed
62
63
- more whitespaces for the annotation panel

Mathias Goebel's avatar
Mathias Goebel committed
64
65
66
## [7.6.0] - 20210910

### Fixed
mrodzis's avatar
mrodzis committed
67

Mathias Goebel's avatar
Mathias Goebel committed
68
69
- issues in preparation of tokenized text (json) for CollateX

Mathias Goebel's avatar
Mathias Goebel committed
70
71
72
## [7.5.0] - 20210908

### Added
mrodzis's avatar
mrodzis committed
73

Mathias Goebel's avatar
Mathias Goebel committed
74
- API providing list of collation results for the website
75
76
77
78

## [7.4.3] - 20210906

### Changes
mrodzis's avatar
mrodzis committed
79
80

- remove `tei:note[@type="original-phrase"]` from text html output
81
82
- minor text change in annotation body value

83
84
85
## [7.4.2] - 20210906

### Fixed
mrodzis's avatar
mrodzis committed
86

87
88
- whitespaces in annotation panel (`tei:corr`)

89
90
91
## [7.4.1] - 20210904

### Fixed
mrodzis's avatar
mrodzis committed
92
93

- wrong URL to content when `tei:pb/@n` contains whitespace (e.g. Syriac: Mosul DFM 430)
94

95
96
97
98
## [7.4.0] - 20210903

### Fixed

mrodzis's avatar
mrodzis committed
99
- missing whitespaces within `tei:choice`
100

Mathias Goebel's avatar
Mathias Goebel committed
101
102
103
## [7.3.0] - 20210902

### Added
mrodzis's avatar
mrodzis committed
104

Mathias Goebel's avatar
Mathias Goebel committed
105
106
107
- font Estrangelo Edessa

### Fixed
mrodzis's avatar
mrodzis committed
108

Mathias Goebel's avatar
Mathias Goebel committed
109
110
- missing whitespaces in annotation body value

Mathias Goebel's avatar
Mathias Goebel committed
111
112
113
## [7.2.0] - 20210830

### Added
mrodzis's avatar
mrodzis committed
114

Mathias Goebel's avatar
Mathias Goebel committed
115
116
- `tei:cit` is added to the annotations.

Mathias Goebel's avatar
Mathias Goebel committed
117
118
119
## [7.1.0] - 20210827

### Added
mrodzis's avatar
mrodzis committed
120

Mathias Goebel's avatar
Mathias Goebel committed
121
122
123
- API to provide content for the website (commentary based on `tei:teiHeader`)
- Quotations are now served as annotations

124
125
126
## [7.0.0] - 20210823

### Changed
mrodzis's avatar
mrodzis committed
127

128
129
- feature release for changes from 6.10.0 to 6.12.4 (mostly changes regarding motif processing)

130
131
132
## [6.12.4] - 2021-08-18

### Changed
mrodzis's avatar
mrodzis committed
133

134
135
- collection metadata
- start and end nodes for motifs now with `data-target` attribute
Mathias Goebel's avatar
Mathias Goebel committed
136

Mathias Goebel's avatar
Mathias Goebel committed
137
## [6.12.1] - 2021-08-18
Mathias Goebel's avatar
Mathias Goebel committed
138
139

### Added
mrodzis's avatar
mrodzis committed
140

Mathias Goebel's avatar
Mathias Goebel committed
141
142
143
- tests for the motifs processor

### Fixed
mrodzis's avatar
mrodzis committed
144

Mathias Goebel's avatar
Mathias Goebel committed
145
146
- increased quality of the motifs processor (correct handling of encapsulated annotations)

Mathias Goebel's avatar
Mathias Goebel committed
147
## [6.12.0] - 2021-08-16
Mathias Goebel's avatar
Mathias Goebel committed
148
149

### Changes
mrodzis's avatar
mrodzis committed
150

Mathias Goebel's avatar
Mathias Goebel committed
151
152
- motifs processor: we now enable a range selector for annotations based on `CssSelector` to add empty elements for start and end of annotations. particular useful for motif annotations that are stored as PI `<?oxy_comment_  ?>` in the tei files based on our xml editors comment function in author mode.

Mathias Goebel's avatar
Mathias Goebel committed
153
154
155
## [6.11.0] - 2021-08-11

### Changes
mrodzis's avatar
mrodzis committed
156

Mathias Goebel's avatar
Mathias Goebel committed
157
158
- search: new total stats added (num of manifests, num of matches)

Mathias Goebel's avatar
Mathias Goebel committed
159
160
161
162
163
164
## [6.10.0] - 2021-07-23

### Changes

- new deployment strategy: Website and Ahiqar-Tido are now deploying directly to the server instead of triggering a pipeline here. This reduces the amount of unnecessary pipelines and speeds up the process. Now it is up the specific repos to set the correct parameters corresponding to the branch or deployment stage. This is done with bind mounts in docker mainly.

Mathias Goebel's avatar
Mathias Goebel committed
165
166
167
168
## [6.9.0] - 2021-07-23

### Changes

mrodzis's avatar
mrodzis committed
169
- CI pipeline reflect changes regarding website integration
Mathias Goebel's avatar
Mathias Goebel committed
170

Mathias Goebel's avatar
Mathias Goebel committed
171
172
## [6.8.4] - 2021-07-19

Mathias Goebel's avatar
Mathias Goebel committed
173
174
175
176
### Changes

- search output now summarizes matches

Mathias Goebel's avatar
Mathias Goebel committed
177
178
179
### Fixed

- remove `tei:corr` and `tei:expan` from html serialization
Mathias Goebel's avatar
Mathias Goebel committed
180
181
182
183
184
185
186
187
188
189
190
191

## [6.8.3] - 2021-07-14

### Added

- application icon 🐡
- REST endpoint to import data

### Fixed

- minor fixes for the gitlab ci pipeline

Mathias Goebel's avatar
Mathias Goebel committed
192
193
## [6.8.2] - 2021-07-13

Mathias Goebel's avatar
Mathias Goebel committed
194
195
### Added

Mathias Goebel's avatar
Mathias Goebel committed
196
197
- index config to support queries (search approx 8× faster)

mrodzis's avatar
mrodzis committed
198
199
200
201
202
203
## [6.8.1] - 2021-07-13

### Fixed

- exclude `/` from IDs

Mathias Goebel's avatar
Mathias Goebel committed
204
205
206
207
208
## [6.8.0] - 2021-07-12

### Added

- `match` field to search output
mrodzis's avatar
mrodzis committed
209
- generic metadata getter added to `commons` module
Mathias Goebel's avatar
Mathias Goebel committed
210
211
212

### Fixed

mrodzis's avatar
mrodzis committed
213
- resolve language aggregation for search hits
Mathias Goebel's avatar
Mathias Goebel committed
214

215
216
217
218
219
220
## [6.7.7] - 2021-07-12

### Fixed

- retrieving valid URIs for ZIP creation

221
## [6.7.6] - 2021-07-12
Mathias Goebel's avatar
Mathias Goebel committed
222
223
224
225
226

### Fixed

- correctly process init password from env var

227
228
229
230
231
232
## [6.7.5] - 2021-07-12

### Changed

- the ID of tokens has been enhanced with a prefix `t_` in order to have standard compliant IDs only.

Mathias Goebel's avatar
Mathias Goebel committed
233
234
235
236
237
238
239
240
241
## [6.7.4] - 2021-07-10

### Added

- cache: a new collection `$commons:tmp` for temporary data (intermediate format) is introduced

### Fixed

- improved import performance together with the motifs expansion by factor 13 (approx.)
242

mrodzis's avatar
mrodzis committed
243
244
245
246
247
## [6.7.2] - 2020-07-09

### Removed

- REST-API endpoint `deploy/version/{$number}` which wasn't in use and cause the `deploy_app` stage to fail since the update to eXist 5.3.0.
Mathias Goebel's avatar
Mathias Goebel committed
248

Mathias Goebel's avatar
Mathias Goebel committed
249
250
251
252
253
254
## [6.7.1] - 2021-07-08

### Added

- data import script

255
256
257
258
259
260
## [6.7.0] - 2021-07-08

### Added

- when creating the metadata on manifest level, the Salhani print is now considered as well.

261
## [6.6.0] - 2021-07-02
mrodzis's avatar
mrodzis committed
262
263
264

### Changed

265
- the collection title now provides information about the type of manuscripts the collection contains.
Mathias Goebel's avatar
Mathias Goebel committed
266

Mathias Goebel's avatar
Mathias Goebel committed
267
## [6.5.0] - 2021-06-25
Mathias Goebel's avatar
Mathias Goebel committed
268
269
270
271

### Added

- basic search api and lucene configuration
mrodzis's avatar
mrodzis committed
272

273
274
275
276
277
278
279
## [6.2.3] - 2021-06-25

### Fixed

- annotation items that are stored during the creation/update of a document are now always stored in an array.
Before this fix a singular item on an AnnotationPage has been provided as object which caused errors in TIDO.

280
281
282
283
284
285
286
## [6.2.2] - 2021-06-25

### Fixed

- refined XPath to main title of the project.
In the Salhani print we have several main titles which hasn't been considered when selecting the element for displaying the main title of the project.

mrodzis's avatar
mrodzis committed
287
288
289
290
291
292
293
294
295
296
## [6.2.1] - 2021-06-21

### Fixed

- fonts are now provided as expected.

### Changed

- the font file format has been altered to WOFF instead of OTF.

297
298
299
300
301
302
303
## [6.2.0] - 2021-06-10

### Changed

- in order to improve the performance of the database triggers, calling commons:get-page-fragments() several times has been reduced to calling it once per document.
This also reduces the calls to me:main(), a relatively costly operation, which is called during commons:get-page-fragments().

304
305
306
307
308
309
## [6.1.0] - 2021-06-08

### Changed

- in the AnnotationAPI the correction of faulty text now provides information about the person responsible for the correction.

310
311
312
313
314
315
## [6.0.0] - 2021-06-08

### Changed

- the fields `total` and `startIndex` have been removed from the AnnotationAPI.

mrodzis's avatar
mrodzis committed
316
317
318
319
320
321
322
## [5.16.0] - 2021-06-04

### Changed

- the HTML are now serialized after pushing TEI files to the database and stored by text type (transcription, transliteration) and page.
The TextAPI uses these pre-rendered files instead of creating them on the fly, thus saving time when a user visits a page in TIDO.

323
324
325
326
327
328
329
## [5.15.1] - 2021-06-07

### Fixed

- the computation of total annotations per manuscript/collection now uses the preprocessed annotation items as a basis.
This saves a lot of time since the annotations doesn't have to be recreated for counting.

mrodzis's avatar
mrodzis committed
330
331
332
333
334
335
336
337
## [5.15.0] - 2021-06-03

### Added

- annotation items are now preprocessed and stored to the database.
When an application wants to access an Annotation Page, the database retrieves the items from the stored files while the rest of the Page is created dynamically.
Also, a database trigger has been added that updated the stored annotation items for a TEI document each time is updated in the `data` collection.

338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
## [5.14.2] - 2021-05-21

### Fixed

- the serialization of simple motifs is now able to deal with motifs spanning over a page's end.
Motifs that encompass more than one line are connected via a `data-next` attribute in HTML.
The AnnotationAPI exposes the first part of a motif available on a page.
- the entry point of the front end is set correctly during the CI pipelines (depending on the branch executing them).

### Changed

- the processing instructions which represent the motifs are transformed to XML elements to simplify processing the data.
- some of the Docker images in the CI config have been exchanged with smaller versions.

## [5.14.1] - 2021-05-17
mrodzis's avatar
mrodzis committed
353
354
355
356
357

### Added

- logging to `expath-repo.log` when an error is thrown in the TextAPI at collection level

358
359
360
361
362
363
364
365
366
367
368
369
## [5.14.0] - 2021-05-07

### Added

- an intermediate format that transforms simple (i.e. non-nested) motifs (encoded as processing instructions) into TEI elements.
This new intermediate format serves as a basis for the HTML creation in which the simple motifs are now considered, too.

### Changed

- the ID creation within `motifs.xqm` has been altered to fit the new intermediate format.

## [5.13.0] - 2021-05-07
370
371
372

### Added

mrodzis's avatar
mrodzis committed
373
- the HTML serialization now provides a `@dir="rtl"` attribute.
374

375
376
377
378
379
380
## [5.12.1] - 2021-05-06

### Changed

- `annotation.xqm` has been refactored to separate concerns and to speed the process up by avoiding duplicate function calls.

381
382
383
384
385
386
## [5.12.0] - 2021-05-03

### Added

- the motifs have been added to the AnnotationAPI.

387
## [5.11.2] - 2021-04-29
mrodzis's avatar
mrodzis committed
388
389
390
391
392

### Changed

- the ant based approach for installing this project now gets eXist-db from GitHub (and not Bintray).

393
394
395
396
397
398
## [5.11.1] - 2021-04-27

### Removed

- The changes made in [5.11.0](#5110-2021-04-27) have been removed due to performance issues.

399
## [5.11.0] - 2021-04-27
400
401
402
403
404

### Added

- the variants have been added to the AnnotationAPI.

mrodzis's avatar
mrodzis committed
405
406
407
408
409
410
411
## [5.10.0] - 2021-04-22

### Changed

- introduced a simple collction at `/textapi/http-status-test/collection/collection.json` that has items which return the HTTP status codes `403`, `404`, `405`, `500` and `503`, respectively.
For this, the unused end points introduced at [5.8.0](#580-2021-04-15) have been removed.

412
413
414
415
416
417
## [5.9.1] - 2021-04-22

### Fixed

- the `Person` and `Place` annotations now provide the actual person/place name in the annotation body instead of a dummy string.

418
## [5.9.0] - 2021-04-14
419
420
421
422
423

### Added

- the license ID for manifests now contains a link to the legal code of the license.

424
425
426
427
428
429
## [5.8.0] - 2021-04-15

### Added

- temporarily added the end points "/http-403", "/http-404", "/http-500", "/http-503" for testing TIDO's behavior when getting these status codes.

mrodzis's avatar
mrodzis committed
430
431
432
433
434
435
## [5.7.1] - 2021-04-13

### Fixed

- the CSS file now updated when changes have been made in ahiqar-tido.

436
## [5.7.0] - 2021-03-23
437
438
439
440
441

### Added

- the editorial comments as well as the references have been added to the AnnotationAPI.

442
443
444
445
446
447
## [5.6.1] - 2021-03-29

### Fixed

- consider encoding for Harvard 80 and references works in tokenization

448
449
450
451
452
453
## [5.6.0] - 2021-03-26

### Changed

- adapt ID/IDNO handling in the JSON creation to how they are handled during the tokenization.

mrodzis's avatar
mrodzis committed
454
455
456
457
## [5.5.3] - 2021-03-23

### Fixed

mrodzis's avatar
mrodzis committed
458
- sample data is no longer considered when creating the JSON files needed for the collation.
mrodzis's avatar
mrodzis committed
459

460
461
462
463
464
465
## [5.5.2] - 2021-03-23

### Fixed

- the HTML creation now reacts gracefully to variations in the rendition attribute for the rubrication.

466
467
468
469
470
471
## [5.5.1] - 2021-03-22

### Fixed

- an item of an Arabic manuscript now only has the transscription in its Content Object.

472
## [5.5.0] - 2021-03-15
473

474
475
### Changed

476
477
478
479
- the different text types, transcription and transliteration, are now considered for the HTML creation and the annotations.
The HTML endpoint now not only has a key word to distinguish the two types, but also provides the different texts now.
The AnnotationAPI now consideres both the transcription and the transliteration (where present) for the Annotation Pages so that annotations can be shown for both text types in TIDO.

480
## [5.4.0] - 2021-03-15
481
482
483
484
485
486
487
488
489
490

### Added

- the API endpoint `content/ahikar-json.zip` which returns a JSON file per line of transmission and semantic section.

### Removed

- from this version on we use JSON as an input for CollateX.
As a consequence, the TXT API has become obsolete and has been removed.

491
## [5.3.0] - 2021-03-08
mrodzis's avatar
mrodzis committed
492
493
494
495
496

### Removed

- the changes made in [4.4.0](#440-2021-02-18)

497
498
499
500
501
502
## [5.2.0] - 2021-03-09

### Added

- the fonts needed for the edition as well as an endpoint to deliver them.

mrodzis's avatar
mrodzis committed
503
504
505
506
507
508
509
510
511
512
## [5.1.0] - 2021-03-08

### Added

- a separate endpoint for the project specific CSS at `/content/ahikar.css`.

### Changed

- the Support Object no longer relies on GitLab but references the CSS stored in the database.

mrodzis's avatar
mrodzis committed
513
514
515
516
517
518
519
## [5.0.1] - 2021-03-05

### Fixed

- the CSS file in the Support Object now points to the raw CSS file in GitLab.
This way it is fully parsable.

520
## [5.0.0] - 2021-03-05
521
522
523
524
525
526
527
528
529
530

### Changed

- The API has been adjusted to the generic TextAPI's change that allows for several Content Objects instead of one content item.
- As a result of said API change, `content/some_page.html` has been changed to `content/${html-type}/some_page.html`.
This way the two relevant HTML serialization of the Ahiqar material, `transcription` and `transliteration` can easily be distinguised.
Cf. <https://gitlab.gwdg.de/subugoe/ahiqar/backend/-/issues/27> on this topic.
NOTE: Only the endpoint has been changed.
The functionality is not implemented yet.

531
## [4.9.4] - 2021-03-05
532
533
534
535
536
537
538

### Fixed

- the license key on Manifest level now provides an array of License Objects instead of a simple string.
To achieve this, the XML based structure of the manifest data has been moved to maps.
Additionally, the module has been slightly refactored.

539
## [4.9.3] - 2021-03-02
540
541
542
543
544
545

### Fixed

- the title on Item level now provides an array of Title Objects instead of a single one.
To achieve this, we changed the XML based structure of the `tapi-item.xqm` module to a map based one.

546
## [4.9.2] - 2021-03-02
mrodzis's avatar
mrodzis committed
547
548
549
550
551
552

### Fixed

- during the HTML serialization, a white space is set after each token
Not having set this let to the text nodes being displayed as one long text node.

553
554
555
556
557
558
559
## [4.9.1] - 2021-02-24

### Fixed

- the HTTP request to TextGrid for public images now has a sessionID.
While we won't need it once the images have been published in the TextGrid Repository, the sessionID is still needed in the meantime for requesting images.

560
## [4.9.0] - 2021-02-23
561
562
563

### Added

mrodzis's avatar
mrodzis committed
564
- a word-level tokenization of the relevant text. words are wrapped in a `tei:w` before further processing and equipped with a unique ID to address them.
565

mrodzis's avatar
mrodzis committed
566
## [4.8.2] - 2021-02-23
567
568
569
570
571
572

### Fixed

- the variable $APP_DEPLOY_TOKEN which is expected in `deploy.xqm` is now part of Docker's environment and can actually be used for conditionals.
Also, this variable has been added as a query parameter to the API call.

573
## [4.8.1] - 2021-02-23
574
575
576
577

### Fixed

- restructered the tests in a way that developers can execute them locally even if they don't have the credentials necessary for getting data from TextGrid.
mrodzis's avatar
mrodzis committed
578
These tests are only executed if the respective environment variable, `TGLOGIN`, is available.
579

mrodzis's avatar
mrodzis committed
580
581
582
583
584
585
586
587
## [4.8.0] - 2021-02-22

### Added

- An endpoint `deploy/$VERSION` which allows for installing a specific version of the application.
This is mainly relevant for the test server on which the application version aren't always installed in a chronological way.

## [4.7.0] - 2021-02-22
588
589
590
591
592

### Changed

- The license information for texts is retrieved from the TEI/XML files instead of setting a generic one.

593
594
595
596
597
598
599
## [4.6.0] - 2021-02-22

### Changed

- Instead of having a simple string body in the annotations, we switched to a Body Object that holds a custom parameter, `x-content-type`, which enables us to easily distinguish the annotations of different types.
Cf. <https://subugoe.pages.gwdg.de/ahiqar/api-documentation/page/annotation-api-specs/#body-object>.

600
## [4.5.0] - 2021-02-18
Mathias Goebel's avatar
Mathias Goebel committed
601
602
603

### Fixed

604
- move to dynamic sessionId
Mathias Goebel's avatar
Mathias Goebel committed
605

606
607
608
609
610
611
## [4.4.0] - 2021-02-18

### Added

- a separate endpoint for the sample file available at `/textapi/ahikar/sample/collection.json` for accessing the sample file

612
## [4.3.0] - 2021-02-16
mrodzis's avatar
mrodzis committed
613
614
615
616
617

### Added

- the manifests now have a Support Object which holds the URL of the project specific CSS

618
619
620
621
622
623
## [4.2.0] - 2021-02-15

### Changed

- U+073C and U+073F are sorted out during the normalization process.

624
## [4.1.1] - 2021-02-05
625
626
627
628
629

### Fixed

- introduced try/catch blocks with fitting error messages for all server requests.

630
631
632
633
634
635
## [4.1.0] - 2021-02-05

### Added

- license information within the image field on item level. As a consequence, each image is now connected with an SPDX identifier (if possible) and further notes about the image's creator.

636
637
638
639
640
641
## [4.0.1] - 2021-02-04

### Fixed

- a proper error is thrown if an image URI cannot be found in TextGrid Rep

642
## [4.0.0] - 2021-02-04
mrodzis's avatar
mrodzis committed
643
644
645
646
647
648
649
650

### Changed

- The URLs for the images have changed depending on whether an image is accessible for the public
or if it has restricted access due to license terms.
Public images are available at `images/public/${uri}` plus image section.
Restricted images are available at `images/restricted/${uri}` plus image section.

651
652
653
654
655
656
657
658
## [3.2.0] - 2021-02-04

### Changed

- the project specific metadata has been moved from separate items on manifest level to the Metadata Object on manifest level.
This allows us to use the generic Metadata Object support in the viewer instead of having to add extra code that supports
keys starting with 'x-'.

659
660
661
662
663
664
665
666
## [3.1.1] - 2021-01-27

### Fixed

- rename `master.build.properties` to `main.build.properties` to match the actual branch names.
This is necessary to build a package and upload it to our package store (ci.de.dariah.eu).

## [3.1.0] - 2021-01-27
667
668
669
670
671

### Changed

- provide two instances of the viewer, one for Syriac and one for Arabic/Karshuni texts

mrodzis's avatar
mrodzis committed
672
673
674
675
676
677
## [3.0.1] - 2021-01-27

### Changed

- `local:truncate` in `tapi-img.xqm` has been renamed to `local:round` to better grasp what the function does.

678
679
680
681
682
683
684
685
## [3.0.0] - 2021-01-18

### Changed

- The Text- and AnnotationAPI no longer accept URIs as `collection` parameter.
Callers have to choose between `syriac` or `arabic-karshuni` as `collection`.
This satifies the requirement of having one separate endpoint for the TIDO instance serving the Syriac and the Arabic/Karshuni collections each.

686
687
688
689
690
691
## [2.5.2] - 2021-01-25

### Changed

- added API health check for deploy API

692
693
694
695
696
## [2.5.1] - 2021-01-22

### Fixed

- a broken path in the CI config
697
698
- faulty implementation of the Item Object's title key: Provides now a Title Object according to the
TextAPI specs instead of a string.
699

700
701
## [2.5.0] - 2021-01-14

702
### Changed
703
704
705
706

- switched from SADE to TextGrid Connect Standalone as a means to get data from TextGrid

## [2.4.0] - 2021-01-13
mrodzis's avatar
mrodzis committed
707

708
709
### Changed

mrodzis's avatar
mrodzis committed
710
711
- updated the eXist application's name since it was misleading

712
## [2.3.0] - 2021-01-13
mrodzis's avatar
mrodzis committed
713
714
715
716
717
718
719
720
721
722

### Changed

- Some parts of `annotation.xqm` have been refactored to improve the code and/or make it testable.
- `test-runner.xq` now produces machine-readable output and only displays the tests that fail.

### Added

- Tests for the AnnotationAPI.

mrodzis's avatar
mrodzis committed
723
724
725
726
727
728
## [2.2.2.] - 2021-01-11

### Fixed

- semantic errors that lead to the application not being installed properly.

mrodzis's avatar
mrodzis committed
729
## [2.2.1] - 2020-11-16
730
731
732
733
734
735

## Changed

- When extracting the relevant plain text sections, the semantic divisions of the texts are now considered.
Each semantic division, which is indicated in the texts by a tei:milestone, is now stored in a separate file.

736
737
738
739
740
741
742
743
744
745
## [2.1.0] - 2020-11-12

### Changed

- prepared for changed endpoints at Text-API (document-page to document/page)

### Fixed

- wrong Annotation IDs

746
747
748
749
750
751
## [2.0.0] - 2020-11-06

### Changed

- The AnnotationAPI is now served at `/api/annotations` instead of `/api/textapi`.

mrodzis's avatar
mrodzis committed
752
753
754
755
756
757
758
759
760
761
## [1.13.1] - 2020-10-06

### Fixed

- Unit tests are executed again.

### Changed

- The CI tests if 1. the unit test API is available and 2. the XML file resulting from the test exists.

Mathias Goebel's avatar
Mathias Goebel committed
762
763
764
765
766
767
## [1.13.0] - 2020-10-13

### Added

- exist application sets admin password from env var (optionally)

768
769
770
771
772
773
774
775
776
777
778
779
## [1.12.0] - 2020-10-01

### Added

- `tei2html.xqm` and `tei2html-textprocessing.xqm` for transforming TEI documents that comply to the
Ahiqar schema to XHTML.

### Changed

- The `/content/${document}-${page}` endpoint no longer relies on TEI's XSLTs and uses a custom
XQuery module, `tei2html.xqm`, instead.

mrodzis's avatar
mrodzis committed
780
781
782
783
784
785
786
787
## [1.11.0] - 2020-09-22

### Changed

- In order to improve the clearity of the application, `tapi.xqm` now only holds the RESTXQ endpoints of the TextAPI.
All further functionality has been moved to separate module and furnished with tests.
- The test runner has been designed to be self-reporting, i.e. only faulty results are displayed fully.

mrodzis's avatar
mrodzis committed
788
789
790
791
792
793
## [1.10.1] - 2020-09-24

### Fixed

- Faulty link to OpenAPI documentation of the RESTXQ endpoints has been corrected.

mrodzis's avatar
mrodzis committed
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
## [1.10.0] - 2020-09-18

### Added

- `collate.xqm` has been introduced.
It provides plain text versions of XMLs files while only considering text passages that follow tei:milestone.
- `commons.xqm` has been introduced.
It provides variables and functions used in several other modules.

### Changed

- All functionality that deals with creating a plain text version of a given XML file has been moved to `collate.xqm`.
- `tapi.xqm` and `annotations.xqm` outsourced some variable to `commons.xqm`.

### Fixed

- The RESTAPI endpoint returning txt-files has been fixed and is available again.

812
813
## [1.9.3] - 2020-09-18

mrodzis's avatar
mrodzis committed
814
### Changed
815
816
817

- The data directory of eXist-db is mounted to a volume instead of a bind mount.

mrodzis's avatar
mrodzis committed
818
### Fixed
819
820
821

- The maximum amount of memory usable by eXist-db's Docker container has been reduced to 1GB.

mrodzis's avatar
mrodzis committed
822
823
## [1.9.2] - 2020-09-10

mrodzis's avatar
mrodzis committed
824
### Changed
mrodzis's avatar
mrodzis committed
825
826
827
828

- The GitLab templates have been tidied up according to their actual usage.
Also, a passage about updating the README as been added.

829
830
831
832
833
834
835
## [1.9.1] - 2020-08-31

### Fixed

- Certain manifests are excluded from being listed in a collection.
These aren't "real" editions and shouldn't be displayed in the front end.

mrodzis's avatar
mrodzis committed
836
837
838
839
840
841
842
## [1.9.0] - 2020-08-28

### Added

- Manifest Objects (i.e. editions) now hold information about the edition's editor(s), where and when the corresponding manuscript has been created and where it is stored now.
For this, we introduced the keys `x-editor`, `x-date`, `x-origin`, and `x-location`.

mrodzis's avatar
mrodzis committed
843
844
845
846
847
848
849
## [1.8.2] - 2020-08-27

### Changed

- The build process with `docker-compose` has been slightly adapted.
Instead of hard-coding the bind mounts' sources on the host these are now specified in `.env`.
For this, `set-env-for-docker-compose.sh` has been updated.
850
851
852
853
854
- The API endpoint `/api/info` changed to `/info` since the prefix `/api` is added automatically by Apache.

### Fixed

- The pipeline for deploying the app to the database now fails if the deployment API isn't available.
mrodzis's avatar
mrodzis committed
855

856
857
858
859
860
861
862
863
864
## [1.8.1] - 2020-08-05

### Fixed

- The endpoint design of all AnnotationAPI endpoints requires a leading `/api` on the servers due to the Apache configuration (this doesn't hold for the entrypoint).
This hasn't been the case so far and has been fixed in this version.
- The file `ahiqar_collection.xml` listed a dummy file and several original files in its aggregation.
This caused the AnnotationAPI function that determines to which collection a file belongs to crash since the original files listed in said XML had two possible collections they could belong to.

865
## [1.8.0] - 2020-07-17
mrodzis's avatar
mrodzis committed
866

867
868
869
870
871
872
873
### Fixed

- both the TextAPI and the AnnotationAPI have been checked for their compliance with the generic TextAPI and the W3C Annotation Model, respectively.
Any non-matching fields have been altered to ensure compliance.
The APIs are now documented at <https://subugoe.pages.gwdg.de/ahiqar/api-documentation/>.

## [1.7.2] - 2020-07-15
mrodzis's avatar
mrodzis committed
874
875
876
877
878
879

### Fixed

- when getting a zipped dump of the Ahikar texts, only documents with content are created.
The created documents are prefixed with the respective language which are needed for the collation.

mrodzis's avatar
mrodzis committed
880
881
882
883
884
885
886
887
888
889
890
891
## [1.7.1] - 2020-07-10

### Fixed

- consider processing instruction when serializing HTML.
We didn't before and that caused an error while assigning IDs to elements.

## [1.7.0] - 2020-06-30

### Added

- the AnnotationAPI which is compliant to the W3C Annotation Model.
mrodzis's avatar
mrodzis committed
892
With this API, we can expose annotations to TIDO which can then be serialized in different ways.
mrodzis's avatar
mrodzis committed
893
894
895
896
897
898

### Changed

- added a field 'annotationCollection' to Collection, Manifest and Item Objects.
This connects the TextAPI with the AnnotationAPI.

mrodzis's avatar
mrodzis committed
899
900
901
902
903
904
905
## [1.6.0] - 2020-06-19

### Added

- unit tests for the genuine backend functions.
this helps us verify if everything works as intended.

906
907
908
909
910
911
912
913
914
915
916
917
918
## [1.5.0] - 2020-06-17

### Added

- an endpoint for getting the plain text of a resource.
this encompasses edition objects as well as XML resources.
the endpoint is available at textapi/ahikar/{$collection}/{$document}.txt and distinguishes between the different text types that exists in the Ahikar project

### Removed

- the function that returns the plain text of Sado 9, Harvard 80 and Strasbourg S4122.
instead, we now focus on an approach to meet this requirement by using the API.

919
## [1.4.0] - 2020-06-15
920
921
922

### Added

923
924
- a function that returns the plain text of Sado 9, Harvard 80 and Strasbourg S4122.
This is necessary in order to evaluate CollateX.
925
926
- OpenAPI as a means to get human readable API documentation.

927
928
929
930
931
### Changed

- the plain text is not only created for the transcriptions but also for the transliteration.
- removed unused function parameter from signature of tapi:item.

mrodzis's avatar
mrodzis committed
932
933
## [1.3.1] - 2020-06-15

934
935
936
937
### Changed

- merge request templates now explicitly mention the version number in the eXist app's build properties.
this should help to remember increasing it.
938
- instead of just checking the API status for the staging server, the health of an endpoint is now checked after a merge as well
939

mrodzis's avatar
mrodzis committed
940
941
942
943
944
945
### Fixed

- make API more specific in where it looks up data. When people fork SADE, a new SADE application is created
in the backend which also contains project data.
This lead to error when looking up metadata for a given colleciton.

946
## [1.3.0] - 2020-06-10
947
948
949
950
951
952
953

### Changed

- exclude notes from the creation of plain text.
notes are text passages that have been added at a later stage by one or more scribes.
thus, they do not belong to the running text in a stricter sense.

mrodzis's avatar
mrodzis committed
954
955
956
957
958
## [1.2.0] - 2020-06-09

### Added

- a License file that clearifies the terms under which the backend software could be reused.
mrodzis's avatar
mrodzis committed
959
960
961
962
963
964
- HTTP HEAD added to the API.
This way the status of all the API's parts can be requested with e.g. `curl --head` for testing purposes.

### Fixed

- failing pipeline due to buffering problems of cURL
mrodzis's avatar
mrodzis committed
965

966
967
968
969
970
971
972
## [1.1.1] - 2020-06-09

## Added

- the Readme now offers a section on the interplay of front- and backend.
It has also been supplemented with missing categories according to [this gist](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2).

mrodzis's avatar
mrodzis committed
973
974
975
976
977
978
979
## [1.1.0] - 2020-06-05

### Added

- suggestions for serializing the TEI sources.
these have been added to the sample file at exist-app/data/ahiqar_sample.xml.

mrodzis's avatar
mrodzis committed
980
981
982
983
984
985
986
987
988
989
990
991
992
993
## [1.0.1] - 2020-06-05

### Added

- a CI stage that checks the API status after each deployment.

### Changed

- moved the redeployment functionality to a separate module to make the API more robust.

### Fixed

- removed faulty parameter type for the redeploment token.

994
995
996
997
998
999
1000
## [1.0.0] - 2020-06-04

### Added

- add document specific retrieval of metadata.
this mainly refers to the document's name as well as the languages it comprises.

For faster browsing, not all history is shown. View entire blame