{"id":20137835,"url":"https://github.com/scdh/tei-xpointer-schemes","last_synced_at":"2025-09-21T06:32:30.961Z","repository":{"id":173085102,"uuid":"635638508","full_name":"SCDH/tei-xpointer-schemes","owner":"SCDH","description":"Implementation of the TEI XPointer schemes","archived":false,"fork":false,"pushed_at":"2023-09-24T13:09:52.000Z","size":274,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-03T22:41:41.661Z","etag":null,"topics":["oxygenxml","saxon","saxonica","tei","tei-xml","xpointer"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SCDH.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"security.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-03T06:10:38.000Z","updated_at":"2023-12-26T16:59:13.000Z","dependencies_parsed_at":null,"dependency_job_id":"9e809bf8-1baf-4223-90e6-58ab6361574b","html_url":"https://github.com/SCDH/tei-xpointer-schemes","commit_stats":null,"previous_names":["scdh/tei-xpointer-schemes"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/SCDH/tei-xpointer-schemes","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SCDH%2Ftei-xpointer-schemes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SCDH%2Ftei-xpointer-schemes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SCDH%2Ftei-xpointer-schemes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SCDH%2Ftei-xpointer-schemes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SCDH","download_url":"https://codeload.github.com/SCDH/tei-xpointer-schemes/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SCDH%2Ftei-xpointer-schemes/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276204814,"owners_count":25602738,"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-09-21T02:00:07.055Z","response_time":72,"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":["oxygenxml","saxon","saxonica","tei","tei-xml","xpointer"],"created_at":"2024-11-13T21:29:50.654Z","updated_at":"2025-09-21T06:32:30.677Z","avatar_url":"https://github.com/SCDH.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Implementation of the TEI XPointer Schemes\n\nThis project is an implementation of the TEI XPointer scheme as\noutlined in the [SATS\nsection](https://www.tei-c.org/release/doc/tei-p5-doc/de/html/SA.html#SATS)\nin the TEI guidelines.\n\nUsing this implementation, TEI XPointers can be parsed and evaluated\neither through a Java API or from XSLT and XQuery through [XPath\nextension functions](doc/xpath-functions.md).\n\n### State\n\ndevelopment, testing\n\nimplemented XPointer schemes: `xpath()`, `left()`, `right()`,\n`string-index()`, `range()`, `string-range()`\n\nnot (yet) implemented: `match()` TEI XPointer scheme, and the\n`xmlns()` scheme for binding namespaces to prefixes; chaining pointers\n\n## Modules\n\n- `grammar`: an ANTLR4-based grammar of the TEI XPointer schemes\n- `xpath-extension`: definitions of XPath functions for processing XPointers\n- `saxon`: an implementation of a XPointer processor based on Saxon's\n  s9api\n- `oxygen`: the implementation of the TEI XPointer scheme packetized\n  as a plugin for the Oxygen XML editor\n\n## Getting started\n\n### Oxygen plugin\n\nInstallation of the Oxygen plugin is done through the extension\nmanager (menu **Help** -\u003e **Install new add-ons**) with the following\nURL:\n\n```\nhttps://scdh.github.io/tei-xpointer-schemes/descriptor.xml\n```\n\nThe plugin will enable you to evaluate TEI XPointers using the [XPath\nextension functions](doc/xpath-functions.md).\n\n\n### Evaluating TEI XPointers with XSLT and XQuery from the command line\n\nFor building, testing and packetizing locally run the following\ncommand from the root of the cloned repository:\n\n```{shell}\nmvn clean package verify\n```\n\nAfter running `mvn package` there are scripts in `saxon/target/bin`\nfor running Saxon from commandline. These scripts set the classpath\ncorrectly, so that the TEI XPointer processor is available.\n\nNote that you might have to run `chmod +x` on these scripts.\n\nHere are two example invokations of an XSLT stylesheet from the\ntestsuite:\n\n```{shell}\nsaxon/target/bin/xslt.sh -config:saxon/saxon-config.xml -xsl:testsamples/systematic/sequences.xsl -it pointer=\"rn04.txt\"\n```\n\n```{shell}\nsaxon/target/bin/xslt.sh -config:saxon/saxon-config.xml -xi:on -s:testsamples/realworld/Annotationen.xml -xsl:testsamples/realworld/extract-annotated-spans.xsl\n```\n\nNote the `-config:saxon/saxon-config.xml` commandline parameter: It\npasses the Saxon configuration in\n[`saxon/saxon-config.xml`](saxon/saxon-config.xml) to Saxon, so that\nthe XPath functions defined in this project are available to the XSLT\nprocessor.\n\nThe XSLT in `testsamples/realworld/extract-annotated-spans.xsl` or the\nimported `libref.xsl` evaluates TEI XPointers with the new\n[`xptr:get-sequence()` XPath function](doc/xpath-functions.md). It\ntakes two `xs:string` arguments, one for the file URL and one for the\npointer, and returns a sequence of nodes.\n\n\n### Java API\n\nJava API docs are present in `target/site/apidocs/index.html` after\nrunning the following command:\n\n```{shell}\nmvn javadoc:aggregate\n```\n\n\n### Inspecting the parse tree\n\nIf you want to investigate, how a TEI XPointer is parsed, you can use\nthe script `grammar/target/bin/antlr-grun` which is present after\nrunning `mvn package`. You may need to run `chmod +x` on it.\n\nFor example, to inspect the parse tree of the pointer in\n`testsuite/systematic/rn09.txt`, you can run the following command:\n\n```{shell}\ngrammar/target/bin/antlr-grun org.teic.teixptr.grammar.TEIXPointer fragm -gui \u003c testsamples/systematic/rn09.txt\n```\n\nHere, `org.teic.teixptr.grammar.TEIXPointer` is the name of the\ngrammar and `fragm` is the name of the grammar's start rule. Try the\nsame command with the `-tokens` or `-tree` option, instead.\n\n## Security\n\nPlease read the [security instruction](security.md) before using.\n\n# Further reading\n\n- [Getting started with\n  ANTLR](https://github.com/antlr/antlr4/blob/master/doc/getting-started.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscdh%2Ftei-xpointer-schemes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscdh%2Ftei-xpointer-schemes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscdh%2Ftei-xpointer-schemes/lists"}