diff --git a/src/.vuepress/components/Bar.vue b/src/.vuepress/components/Bar.vue index 307b1a3b0c5d30a9eed2884b9d15c3b1a5292b42..3ece3e6fdcd2edad769a7ae27a3e59281773fb61 100644 --- a/src/.vuepress/components/Bar.vue +++ b/src/.vuepress/components/Bar.vue @@ -82,12 +82,29 @@ </v-list-item> </v-list> </v-menu> - <v-btn - depressed - class="mr-1" - color="primary" - to="/project.html" - >Project</v-btn> + <v-menu offset-y> + <template v-slot:activator="{ on, attrs }"> + <v-btn + color="primary" + dark + depressed + v-bind="attrs" + v-on="on" + class="mr-1" + > + Project + </v-btn> + </template> + <v-list> + <v-list-item + v-for="(item, index) in project" + :key="index" + :to="item.to" + > + <v-list-item-title>{{ item.title }}</v-list-item-title> + </v-list-item> + </v-list> + </v-menu> <v-btn depressed color="primary" @@ -120,6 +137,10 @@ export default { { title: 'Translation of the Arabic version', to: '/arabictranslation.html' }, { title: 'Translation of the Syriac version', to: '/syriacranslation.html' }, ], + project: [ + { title: 'About', to: '/about.html' }, + { title: 'Technical Documentation', to: '/technicaldocumentation.html' }, + ], }), mixins: [ pathUrl diff --git a/src/about.md b/src/about.md new file mode 100644 index 0000000000000000000000000000000000000000..43c132cafeeb92841d13465f9b1113b1cf704b0c --- /dev/null +++ b/src/about.md @@ -0,0 +1,49 @@ +--- +home: false +title: About +layout: Layout +--- + +# {{ $frontmatter.title }}{.text-h1 .mt-4 .mb-6 .primary--text} + +This historical-critical edition of the Syriac and Arabic Ahiqar texts is a project funded by the German Research Foundation. It is hosted by the [Faculty of Theology of the University of Göttingen](https://www.uni-goettingen.de/en/the+faculty/55363.html) and by the [Göttingen State and University Library (SUB)](https://www.sub.uni-goettingen.de/en/). The texts were encoded by the researchers using the [TextGrid Lab](https://textgrid.de/en/web/guest). The SUB Technical Team developed and provided a TEI schema and advised on encoding. For the technical realization of the Digital Edition, a generic TextAPI was developed to deliver the data and the TIDO Viewer to display the data. {.body-2} + +## Management {.text-h4 .mb-3 .primary--text} + +### General {.text-h5 .primary--text} + +[Prof. Dr. Reinhard G. Kratz](https://www.uni-goettingen.de/en/56085.html) ([Faculty of Theology of the University of Göttingen](https://www.uni-goettingen.de/en/the+faculty/55363.html)) {.body-2} + +#### Technical {.text-h5 .primary--text} + +[Zeki Mustafa Doğan](https://www.sub.uni-goettingen.de/en/contact/staff-a-z/staff-details/person/zeki-mustafa-dogan/) (Head of [Digital Library, Göttingen State and University Library](https://www.sub.uni-goettingen.de/kontakt/abteilungen-a-z/abteilungs-und-gruppendetails/abteilunggruppe/digitale-bibliothek/) [SUBUGOE]) {.body-2} + +### Team {.text-h4 .mb-3 .primary--text} + +#### Arabic and Karshuni Edition {.text-h5 .mb-1 .primary--text} + +[Dr. Aly Elrefaei](https://www.uni-goettingen.de/de/dr-aly-elrefaei/545664.html) (Faculty of Theology) {.body-2} + +#### Syriac Edition {.text-h5 .mb-1 .mt-2 .primary--text} + +[Simon Birol](https://uni-goettingen.de/de/56764.html) (Faculty of Theology) {.body-2} + +#### SUBUGOE Technical {.text-h5 .mb-1 .mt-2 .primary--text} + +- [Manikanth Dindigala](https://www.sub.uni-goettingen.de/en/contact/staff-a-z/staff-details/person/manikanth-dindigala/) {.body-2} +- [Mathias Goebel](https://www.sub.uni-goettingen.de/en/contact/staff-a-z/staff-details/person/mathias-goebel/) {.body-2} +- [Kay Liewald](https://www.sub.uni-goettingen.de/en/contact/staff-a-z/staff-details/person/kay-liewald/) {.body-2} +- [Paul Pestov](https://www.sub.uni-goettingen.de/en/contact/staff-a-z/staff-details/person/paul-pestov/) {.body-2} +- [Kristine Schima-Voigt](https://www.sub.uni-goettingen.de/en/contact/staff-a-z/staff-details/person/kristine-schima-voigt/) {.body-2} +- [Frank Schneider](https://www.sub.uni-goettingen.de/en/digital-library/service-digitale-editionen/) {.body-2} +- [Michelle Weidling](https://www.sub.uni-goettingen.de/en/contact/staff-a-z/staff-details/person/michelle-weidling/) {.body-2} +- [Nils Windisch](https://www.sub.uni-goettingen.de/en/contact/staff-a-z/staff-details/person/nils-windisch/) {.body-2} + +#### Consulting SUBUGOE {.text-h5 .mb-1 .mt-2 .primary--text} + +- [Uwe Sikora](https://www.sub.uni-goettingen.de/en/contact/staff-a-z/staff-details/person/uwe-sikora/) and [Christian Mahnke](https://www.sub.uni-goettingen.de/en/contact/staff-a-z/staff-details/person/christian-mahnke/) {.body-2} +- [Service for Digital Editions](https://www.sub.uni-goettingen.de/en/digital-library/service-digitale-editionen/) {.body-2} + +## Contact {.text-h2 .mt-4 .mb-6 .primary--text} + +<Contact/> diff --git a/src/technicaldocumentation.md b/src/technicaldocumentation.md new file mode 100644 index 0000000000000000000000000000000000000000..135f8942ede20904d6ecc4308473c6bfa23dea62 --- /dev/null +++ b/src/technicaldocumentation.md @@ -0,0 +1,67 @@ +--- +home: false +title: Technical Documentation +layout: Layout +--- + +# {{ $frontmatter.title }}{.text-h1 .mt-4 .mb-6 .primary--text} + +The software implemented for the Ahiqar project is realized with several components, which are mainly the following: {.body-2} + +Website, Backend, TIDO Viewer and Collation {.body-2 .font-weight-bold} + +(Backend: all ETL processes / offering TextAPI, AnnotationAPI and SearchAPI) +(Tido Viewer: a viewer meant to display digital editions - and everything else delivered via TextAPI) {.body-2} + +This is the very fist implementation of the TextAPI - a generic API specification to deliver all kinds of texts and related material like images, serializations and annotations. +A backend made with eXist-db is meant to privde the API, a client application within the browser, TiDO, {.body-2} +interacts with the TextAPI to persent all the data in a well-known order (e.g. synoptic view with image and a transcription converted to HTML). {.body-2} +Beforehand the data is prepared with TextGrid. {.body-2} + + + +## Git Repository {.text-h4 .mb-3 .primary--text} + +All the code used for this project is available at our GitLab: [https://gitlab.gwdg.de/subugoe/ahiqar](https://gitlab.gwdg.de/subugoe/ahiqar) {.body-2} + +### GitLab CI {.text-h5 .primary--text} + +Everything is assambled, tested and deployed with the help of GitLab CI. Please see the `.gitlab-ci.yaml` files in all the repositories. {.body-2} + +### Editing TEI {.text-h5 .primary--text} + +For editing, storing and exporting the TEI documents the virtual research environment TextGrid is used. TextGrid offers all facilities to encode, validate, interlink, store and export the data. {.body-2} + +### Schema {.text-h5 .primary--text} + +Based on the ODD file a conversion to RNG is used for validating documents during the process of encoding utilizing Oxygen XML editor as part of the TextGrid Laboratory. {.body-2} +There is no further validation instances used. {.body-2} + +### Export Interfaces {.text-h5 .primary--text} + +Communicating with TextGrid\`s REST interfaces an XQuery client is available to transfer data to eXist-db. The process can be triggered from within the TextGrid Laboratory (requires the “SADE†plug-in) or from eXist-db (manually or programmatically). {.body-2} + +## eXist-db {.text-h4 .mb-3 .primary--text} + +The main component for the backend implementation is eXist-db offering a performant XQuery processor. ETL-processes are bound together in our backend application ([git repo](https://gitlab.gwdg.de/subugoe/ahiqar/backend), [Expath Package](https://ci.de.dariah.eu/exist-repo/packages/ahikar.html)) as well as the instructions for the REST API created with [RESTXQ](http://exquery.github.io/exquery/exquery-restxq-specification/restxq-1.0-specification.html). {.body-2} + +## Interfaces Available to End-Users {.text-h4 .mb-3 .primary--text} + +Most of the interfaces available to end-users are documented with OpenAPI: [https://ahiqar.uni-goettingen.de/openapi/](https://ahiqar.uni-goettingen.de/openapi/) {.body-2} + +In addition, particulary where a desciption is missing at the OpenAPI descriptor file, more extensive documentations can be found via the following URLs: {.body-2} + +* [TextAPI especially for Ahiqar](https://subugoe.pages.gwdg.de/ahiqar/api-documentation/page/text-api-specs/) +* [AnnotationAPI for Ahiqar](https://subugoe.pages.gwdg.de/ahiqar/api-documentation/page/annotation-api-specs/) +* [SearchAPI](https://subugoe.pages.gwdg.de/ahiqar/api-documentation/page/search-api-specs/) + +A restricted version of eXist-db\`s REST interface is available via [https://ahiqar.uni-goettingen.de/rest/](https://ahiqar.uni-goettingen.de/rest/). {.body-2 .pt-3} + +## Website {.text-h4 .mb-3 .primary--text} + +This website, offering static content and the user interface to search only, is prepared with Vue.js, VuePress and Vuetify. {.body-2} +Pages are written in Markdown. {.body-2} + +## Collation {.text-h4 .mb-3 .primary--text} + +Using [CollateX](https://github.com/interedition/collatex) with [tokenized version of the manuscripts](https://ahiqar.uni-goettingen.de/api/content/ahikar-json.zip) the output presented at [https://ahiqar.uni-goettingen.de/website/collation.html](https://ahiqar.uni-goettingen.de/website/collation.html) is prepared. {.body-2}