{"id":20137844,"url":"https://github.com/scdh/ox4alea","last_synced_at":"2025-08-04T03:32:36.034Z","repository":{"id":91217570,"uuid":"489072215","full_name":"SCDH/ox4alea","owner":"SCDH","description":"An oXygen framework for TEI-based digital editions, developed for arabic lyrics","archived":false,"fork":false,"pushed_at":"2022-06-28T16:54:12.000Z","size":1338,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-07-20T04:56:45.412Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"XSLT","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.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:46:13.000Z","updated_at":"2022-05-13T08:30:35.000Z","dependencies_parsed_at":null,"dependency_job_id":"777fd6fd-f85d-4524-83bd-a9eae2f635f9","html_url":"https://github.com/SCDH/ox4alea","commit_stats":null,"previous_names":[],"tags_count":75,"template":false,"template_full_name":null,"purl":"pkg:github/SCDH/ox4alea","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SCDH%2Fox4alea","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SCDH%2Fox4alea/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SCDH%2Fox4alea/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SCDH%2Fox4alea/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SCDH","download_url":"https://codeload.github.com/SCDH/ox4alea/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SCDH%2Fox4alea/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268644206,"owners_count":24283333,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-04T02:00:09.867Z","response_time":79,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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:54.025Z","updated_at":"2025-08-04T03:32:35.954Z","avatar_url":"https://github.com/SCDH.png","language":"XSLT","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ALEA \u0026lt;oXygen/\u003e Framework #\n\n![release](https://github.com/scdh/ox4alea/actions/workflows/release.yml/badge.svg)\n![tests](https://github.com/scdh/ox4alea/actions/workflows/test-main.yml/badge.svg)\n\n\nAn \u0026lt;oXygen/\u003e extension developed for the edition of the works of\nIbn Nubata al Misri by the ALEA research group.\n\n## Installation\n\nInstall from [https://scdh.github.io/ox4alea/descriptor.xml](https://scdh.github.io/ox4alea/descriptor.xml).\n\nThe framework can be installed with \u0026lt;oXygen/\u003e's installation and\nupdate mechanism. Therefore, the above URL has to be entered into\nthe form \"Show addons from:\" of the dialogue box from \"Help\" -\u003e\n\"Install new addons...\".\n\nThis framework works on top of oXbytei and oXbytao, which must also be\ninstalled.\n\n- [oXbytei](https://github.com/SCDH/oxbytei)\n- [oXbytao](https://github.com/SCDH/oxbytoa)\n\nAlternative installation methods are explained in [oXbytei's\ndocumentation](https://github.com/SCDH/oxbytei#installation) and can\nbe applied analogously.\n\n\n## Features and Usage ##\n\nThis framework adds only a thin layer of additional functions on top\nof oXbytei and oXbytao.\n\n- shortcut actions for encoding\n  - verbatim citations from the holy text and other sources\n  - references to encyclopedia articles: this simply collects\n    bibliographic entries marked with `type=\"encyclopedia\"` from your\n    bibliography and presents them for selection\n  - etc.\n  \n- an HTML preview with a line-referencing critical apparatus and two\n  column text presentation for verses with caesura\n\n- transformations useful for editing multiple recensions of the same text\n\n### Project specific CSS ###\n\nIn order to get nice rendering in author mode, you should provide CSS\nfor the used languages through the project specific CSS file (see\n[oXbytao](https://github.com/scdh/oxbytao#css)). Here is an example:\n\n```{css}\n@namespace xml \"http://www.w3.org/XML/1998/namespace\";\n\n[xml|lang=\"ar\"] {\n    direction: rtl !important;\n}\n\n[xml|lang=\"de\"] {\n    direction: ltr !important;\n}\n\n[xml|lang=\"en\"] {\n    direction: ltr !important;\n}\n\n[xml|lang=\"ar-DE\"] {\n    direction: ltr !important;\n}\n```\n\n\n## Unit Tests\n\nThere are unit tests for the XSL transformations based on\n[`XSpec`](https://github.com/xspec/xspec) in `test/xspec`. The tests\ncan easily be run with maven from the root directory of the\nrepository:\n\n\tmvn test\n\nMaven will install all required packages for running the tests,\ne.g. `XSpec` and `Saxon-HE`. A detailed test report can be viewed with\nthe browser in `target/xspec-reports/index.html`.\n\nThe test suite or single tests can also be run from the root of this\nrepository with\n\n\t\u003cpath-to/xspec.sh\u003e -catalog catalog.xml test/xspec/*.xspec\n\nThis requires `XSpec` and `Saxon-HE` and the [XML\nResolver](https://mvnrepository.com/artifact/xml-resolver/xml-resolver)\ninstalled. Provided that you've run maven before and maven caches its\ndownloads under the `~/.m2/repository` folder you can set an\nenvironment variable as follows:\n\n\texport SAXON_CP=~/.m2/repository/net/sf/saxon/Saxon-HE/9.9.1-6/Saxon-HE-9.9.1-6.jar:~/.m2/repository/xml-resolver/xml-resolver/1.2/xml-resolver-1.2.jar\n\nThe test result is in `test/xspec/xspec/*-review.html`.\n\n\n# License #\n\nGPL v3\n\nSome icons where taken from the web:\n\n- [Encyclopedia icons created by Freepik - Flaticon](https://www.flaticon.com/free-icons/encyclopedia)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscdh%2Fox4alea","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscdh%2Fox4alea","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscdh%2Fox4alea/lists"}