{"id":20137851,"url":"https://github.com/scdh/edition-data-template-cx","last_synced_at":"2026-03-19T14:04:18.446Z","repository":{"id":91217563,"uuid":"489073157","full_name":"SCDH/edition-data-template-cx","owner":"SCDH","description":"Data template for digital editions with continuoues quality reports and xar-packetizing","archived":false,"fork":false,"pushed_at":"2023-04-18T21:35:14.000Z","size":220,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-03-02T23:13:37.816Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"XQuery","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SCDH.png","metadata":{"files":{"readme":"README.md","changelog":"changeLog.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-05-05T17:49:14.000Z","updated_at":"2022-09-16T17:30:12.000Z","dependencies_parsed_at":"2023-05-13T03:45:49.956Z","dependency_job_id":null,"html_url":"https://github.com/SCDH/edition-data-template-cx","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/SCDH/edition-data-template-cx","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SCDH%2Fedition-data-template-cx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SCDH%2Fedition-data-template-cx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SCDH%2Fedition-data-template-cx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SCDH%2Fedition-data-template-cx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SCDH","download_url":"https://codeload.github.com/SCDH/edition-data-template-cx/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SCDH%2Fedition-data-template-cx/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29777632,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-24T04:54:30.205Z","status":"ssl_error","status_checked_at":"2026-02-24T04:53:58.628Z","response_time":75,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T21:29:55.901Z","updated_at":"2026-02-24T09:05:06.832Z","avatar_url":"https://github.com/SCDH.png","language":"XQuery","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Data Template for Digital Editions, with Continuous Quality Control\n\n- Continuous quality control (CQC): [Overview of formal\n  issues](https://scdh.github.io/edition-data-template-cx/)\n\n\nThis repository is a template for collections of TEI documents like\nthe\n[tei-publisher-data-template](https://github.com/eeditiones/tei-publisher-data-template)\nwhich it is based on, but it comes with automation of common processes\non top.\n\n- validation of TEI documents against schema files (Relax NG and\n  Schematron). A patched version of the Xerces XML parser is used for\n  validation, so that XIncludes with XPointers with bare names (IDs)\n  are correctly expanded.\n\n- [human-readable\n  reports](https://scdh.github.io/edition-data-template-cx/) of the\n  Relax NG and the schematron validation generated continuously and\n  published on gitlab/github pages on each push to the repository\n  (i.e. continuous integration for TEI documents)\n\n- automatic generation of an Expath-Package (XAR) on each push, if and\n  only if the validation has been successful. The TEI documents can be\n  transformed via XSLT before being assembled into the package. The\n  default transformation is simply the identity transformation.\n\n- automatic deployment of the XAR package to a running eXist-db\n  instance on each push, if and only if the validation has been\n  successful. (WIP)\n  \nThe automation is driven with Maven in order to make it platform\nindependent and to encapsulate jar management.\n\nIt runs in the CI/CD pipelines of gitlab runner, see\n[.gitlab-ci.yml](.gitlab-ci.yml), and github actions, see\n[workflows](.github/workflows/gh-pages.yml).\n\n\n# Usage\n\nTo use this template, I suggest to download one of the zip files in the\ncurrent\n[release](https://github.com/SCDH/edition-data-template-cx/releases)\nand unzip it to your edition's root folder.\n\n[Maven](https://maven.apache.org/) is required. Maven will install all\nother required software (Saxon, etc.) on the first run.\n\nMake the package:\n\n```shell\nmvn package\n```\n\nGenerate the human-readable reports:\n\n```shell\nmvn test -l target/mvn.log || mvn compile\n```\n\nThe package and the report will be in the `target` folder.\n\nFor running in CI/CD pipelines have a look at `.gitlab-ci.yml`\n(gitlab) and `.github/workflows` (github). The presence of these files\nwill trigger pipelines on each push to the `main` branch.\n\n\nAll configuration can be done in the maven build file `pom.xml`. See\nthe comments in there and have a look at [technical documentation\n(german)](resources/README.md) for details of adaption.\n\nThe file `resources/assembly.xml` determines which files go into the\nxar package. You can set inclusion and exclusion patterns for TEI\ndocuments there.\n\n\n# Roadmap\n\n- Automatic deployment on running eXist-db instance\n\n- Replace Maven with Gradle, because Gradle is an incremental build\n  system and DAG processor and speeds things up.\n\n- Parse TEI documents for `model` PIs and use these for validation,\n  use default schema if no PI present.\n\n# License\n\nWritten in 2021, 2022 by Christian Lück\n\nTo the extent possible under law, the author(s) have dedicated all\ncopyright and related and neighboring rights to this software to the\npublic domain worldwide. This software is distributed without any\nwarranty.\n\nYou should have received a copy of the CC0 Public Domain Dedication\nalong with this software. If not, see\n[http://creativecommons.org/publicdomain/zero/1.0/](http://creativecommons.org/publicdomain/zero/1.0/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscdh%2Fedition-data-template-cx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscdh%2Fedition-data-template-cx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscdh%2Fedition-data-template-cx/lists"}