SvSal v2.0.1

This is a minor release containing a few small enhancements and bug fixes.

Enhancements:

• added endpoints for statistical data to API (#86)
• enhanced commenting on extraction of rdf triples
• added i18n data for div types "dict" and "lemma"

Bug fixes:

• fixed wording of title in stats teaser (works overview)
• made "Load preceding text" button visible in reading view with very small screens
• fixed error handling in index.xqm and stats.xqm

Documentation fixes:

• corrected illustration of TEI/index nodes

Find the easter egg ;-)

SvSal v2.0.0

This is a major update that aims to provide improvements/solutions in three areas, in particular: an enhanced modularization of the different parts of application logic (the app core, the webdata factories, and the API); substantial performance improvements; and full compatibility with eXist-db 5. The revisions include a re-structured xquery module system and new modules, some additional functionalities, optimization of existing functions, and bug fixes.

New Modules and Backwards Compatibility

Due to changes and restructurings in the module system, this release is not fully backwards-compatible with version 1.x. An exhaustive list of changes in xquery functions is not provided here, but changes may be comprehensible through function descriptions in new xquery modules. The following modules are new with this release:

• modules/factory/works/html.xqm
• modules/factory/works/iiif.xqm
• modules/factory/works/index.xqm
• modules/factory/works/txt.xqm
• modules/api/api.xqm
• modules/api/v1/add.xqm
• modules/api/v1/texts.xqm

The following modules have been renamed or moved:

• modules/sutil.xqm (formerly modules/sal-util.xql)
• modules/factory/works/nlp.xqm (formerly modules/nlp.xql)
• modules/factory/works/stats.xqm (formerly modules/stats.xql)

Please also note that all existing library modules have been renamed through the "xqm" file extension (instead of the former "xql" extension, which is now reserved for non-library query modules).

Finally, the following modules have been removed altogether:

• modules/dbtagger.xql
• modules/render.xql

Besides attempting to make the structure of the app more intelligible and easier to maintain, the restructuring and modularization of the module system also shall make it possible, in the future, to outsource parts of the application such as the webdata factory or the API into separate apps/microservices.

Overview

Structural revisions (also, see above):

• refactored API with RestXQ, now residing under "modules/api"
• separated logic for deriving webdata formats from tei data into dedicated modules in the new "modules/factory" directory
• separated gui/html-related logic from config.xqm into new module gui.xqm (#80)

Compatibility with eXist v5.x (#76):

• implemented http requests by means of the EXPath Http Client
• replaced deprecated eXist library functions
• syntactical revisions of xquery code

Speed/performance improvements (#38):

• revised i18n templating and processing
• simplified dependencies between xqm modules
• revised access of files for web crawlers (robots.txt)
• replaced xsl transformations from within xquery modules by means of xquery typeswitch functions

Additional functionality:

• differentiated (scholarly or technical) work editors in catalogue records
• added links from profile pages of editors to the works they contributed to (#83)
• added options for creating statistical data for works from the administrator interface
• added basic corpus statistics to works' overview
• added link from a work's image view to its reading view (#15)

Bug fixes:

• improved server-side error handling through enhanced accessibility of error modules/functions
• fixed responsiveness of placeholder image for dictionary

Miscellaneous:

• added and improved docs for xquery functions and modules, and extended API docs and technical docs

SvSal v1.5.1

This is a minor release with some smaller revisions and fixes.

Revisions/additions:

• Added new Working Paper (WP0013)
• Created corpus statistics through admin interface
• Enhanced linking with multivolume works (#72 )
• Removed stale "news" data and templates
• Added docs for search in single volumes (#57 )
• Added module for tokenizing texts (and other nlp tasks in the future)
• Updated Mirador to v2.7.0

Fixes:

• Fixed issue with illegal whitespace when exporting xml data (#74 )
• Fixed titles and wordings in project descriptions

SvSal 1.5.0

Enhancements

• Refactor HTML rendering in XQuery for enhanced cohesion, performance, and testability
• Separate node indexing from HTML rendering, enhancing testability
• Re-design and extend citation dialogues in reading view, including more options for linking and exporting text fragments
• Add i18n functionalities in reading view (TOC, teasers) and in search results view (e.g., #55)
• Make TEI exportable per passage
• Introduce passage-specific citation recommendations
• Add structural TEI element types to HTML, snippets, and RDF (e.g., tei:signed, tei:argument, tei:label)
• Search results: make text snippets more concise, allowing for displaying of a larger amount of results
• Add pages for the project team members (#21)
• Add webdata-admin query for pipelined generation of derived data formats
• Differentiate work editors (scholarly or technical editors) in catalogue records
• Differentiate standalone image viewer and reading-view image viewer, with separate sets of links/buttons
• Improved HTML rendering of tables, arguments, marginal notes, etc.
• Make (sub-)lists citable in reading view
• Make URIs in work TOC canonical
• Various performance improvements (see #38)
• Add further API endpoints for iiif and jpg formats
• Enhance separation of modules and import dependencies

Bug fixes

• Search results: fix highlighting of terms (#56)
• Prevent text from occurring in multiple search snippets (overlapping text selection when creating Sphinx snippets)
• Several layout fixes with lists in reading view, and fixed type-checking for lists during HTML rendering
• Add missing cover image for WP0012
• Make citation anchors for title pages (#45)
• Citation recommendations: base access date on client time (rather than server time)
• TXT format and search snippets: fix coherence of words interrupted by marginal notes
• Prevent hard errors in search/reading view in case Sphinx returns malformed HTML (see #53)
• Normalize 'long s' character in 'edit' TXT
• Prevent LOD IDs from occurring in search results (#58)
• Resolve links that contain a page break (#43)
• Removed obsolete HTML files (#66)

SvSal v1.4.0

This is a maintenance and bugfix release.

Maintenance:

• new separation of TEI research data, derived research data (and intermediate formats), and app logic

Fixes:

• reading view: rendering of gaps & blank pages
• API: special cases with query parameters & passage IDs
• multiple read/write issue with corpus creation
• longstanding bug with HTML rendering, which required double renderings for yielding correct fragment URIs
• analysis of a TEI work's fragmentation depth
• removed stale index files
• smaller fixes in pages' texts, wordings, usability

SvSal v1.3.0

This is a feature release with additional functionality, revisions and updates, and technical fixes and enhancements.

Additional functionality:

• uniform API for text and image resources: see https://github.com/digicademy/svsal/blob/master/docs/API.md
• new format of works' catalogue records, separating digital edition's from bibliographical data and offering downloads in different formats
• corpus download in txt format as a zip file
• citation recommendations for works/volumes
• list of all work sources
• filter option for works according to their publication status

Revisions/updates:

• additional navigation options in works overview and image view
• additional and improved rules for HTML rendering of certain TEI elements
• additional RDF statements for work metadata
• additional i18n data for Spanish, English and German
• improved documentation
• better separation of TEI work metadata from app logic
• more intuitive switching of diplomatic and constitutive reading views
• revised displaying of normalizations and page links in reading view
• updated Fontawesome icons to v5.7.2
• updated oXygen plugin

Fixes and enhancements:

• fixed sorting in works list
• enhanced server- and application-side error handling
• enhanced input sanitization for HTML resources
• improved stability and security of admin tasks
• great memory and speed improvements with RDF extraction
• fixed creation of invalid IIIF json resources
• much faster delivery of IIIF resources
• accelerated sal:index creation and HTML rendering
• accelerated work-related HTML rendering based on templating model
• enhanced scaling and delivery of images in HTML views
• code clean-ups, restructurings, and enhanced comments
• fixed image download links

SvSal v1.2.1

This is a minor release with some additions and revisions, and a few small fixes.

Additions and revisions:

• Small additions of descriptive content on the website, e.g. with regards to legal information.
• Smaller additions within the SalTEI schema.
• Revision and extension of the list of special characters, especially regarding small letters with macron.
• Updated the SvSal oXygen framework.
• Added a new styling for marginal notes in the reading view, making them more neatly arranged and expansible on the spot.
• Added more specific rules for transforming TEI elements to HTML.

Bugfixes:

• Fixed the differentiation between bibliographic metadata for the edition at hand and the first edition (if available) in works overview.
• Smaller fixes with Mirador.

SvSal v1.2.0

This is a minor release with some additions and revisions (especially with regards to the documentation sections) as well as some fixes.

Additions and Revisions:

• Smaller revisions of the SalTEI (Relax NG) schema, including an introduction of new editing statuses for works.
• Extensive revision of the edition guidelines and addition of English and Spanish versions.
• Addition of English and Spanish versions for the search functionalities' help/documentation.
• Smaller revision of generic TEI work metadata.
• Extension of information on privacy policy of the web application and legal aspects of the project.

Notable Fixes:

• Fixed the corpus creation and download functionalities.
• Fixed some deployment and package indexing routines.
• IIIF manifests now include "startCanvas" and "thumbnail" properties with appropriate values.

Maintenance release

This is a minor release with a few technical fixes:

• added placeholder page for dictionary
• localization enhancements, also with regard to the image viewer
• fixes in rdfization routines
• disable works with status < f_enriched

Initial public release

Although this application does not develop in discrete releases and the present state is not well tested, it should be mostly working and one can see how things are supposed to work. Most likely, the main interest in this release is not seeing it as an out-of-the-box digital edition environment, but providing ways to see how particular details are implemented.

In our project, we expect the software to soon go into production mode with only very few modifications based on this release, when we have established a number of source texts of sufficient quality for the website to be promoted.