From d6e9ce97b4944df08873a19f200e551403522760 Mon Sep 17 00:00:00 2001
From: Christian Boulanger <boulanger@lhlt.mpg.de>
Date: Mon, 30 Sep 2024 13:34:45 +0200
Subject: [PATCH] Update documentation
---
convert-anystyle-data/anystyle-to-tei.ipynb | 3 +--
convert-anystyle-data/anystyle-to-txt.ipynb | 16 +++++++++-------
convert-anystyle-data/tei-to-bibformats.ipynb | 7 ++++++-
convert-anystyle-data/tei-to-prodigy.ipynb | 9 ++++++---
4 files changed, 22 insertions(+), 13 deletions(-)
diff --git a/convert-anystyle-data/anystyle-to-tei.ipynb b/convert-anystyle-data/anystyle-to-tei.ipynb
index 1081662..0db2104 100644
--- a/convert-anystyle-data/anystyle-to-tei.ipynb
+++ b/convert-anystyle-data/anystyle-to-tei.ipynb
@@ -7,7 +7,6 @@
"\n",
"References: \n",
"- https://www.tei-c.org/release/doc/tei-p5-doc/en/html/CO.html#COBI (Overview)\n",
- "- https://www.tei-c.org/release/doc/tei-p5-doc/en/html/CO.html#COBIOT (Mapping to other bibliographic formats)\n",
"- https://www.tei-c.org/release/doc/tei-p5-doc/en/html/ref-bibl.html (`<bibl>`)\n",
"- https://www.tei-c.org/release/doc/tei-p5-doc/en/html/ref-biblStruct.html (`biblStruct`)\n",
"- https://epidoc.stoa.org/gl/latest/supp-bibliography.html (Examples)\n",
@@ -69,7 +68,7 @@
{
"cell_type": "markdown",
"source": [
- "This generates JSON data with information on the tags used, extracting from the schema and from the documentation pages"
+ "This generates JSON data with information on the tags used, extracting from the schema and from the documentation pages."
],
"metadata": {
"collapsed": false
diff --git a/convert-anystyle-data/anystyle-to-txt.ipynb b/convert-anystyle-data/anystyle-to-txt.ipynb
index 766ff06..d213968 100644
--- a/convert-anystyle-data/anystyle-to-txt.ipynb
+++ b/convert-anystyle-data/anystyle-to-txt.ipynb
@@ -1,14 +1,16 @@
{
"cells": [
{
- "cell_type": "code",
- "execution_count": null,
- "id": "initial_id",
+ "cell_type": "markdown",
+ "source": [
+ "# Convert AnyStyle GT back to original strings\n",
+ "\n",
+ "The AnyStyle format is easily converted to the original raw reference string by simply stripping all XML tags."
+ ],
"metadata": {
- "collapsed": true
+ "collapsed": false
},
- "outputs": [],
- "source": "# Convert AnyStyle GT back to original strings"
+ "id": "1d998503d27b0be9"
},
{
"metadata": {
@@ -60,7 +62,7 @@
"cell_type": "code",
"outputs": [],
"execution_count": null,
- "source": "",
+ "source": [],
"id": "f55d360989a07f5d"
}
],
diff --git a/convert-anystyle-data/tei-to-bibformats.ipynb b/convert-anystyle-data/tei-to-bibformats.ipynb
index b971668..8b0d7e4 100644
--- a/convert-anystyle-data/tei-to-bibformats.ipynb
+++ b/convert-anystyle-data/tei-to-bibformats.ipynb
@@ -4,7 +4,12 @@
"metadata": {},
"cell_type": "markdown",
"source": [
- "# Convert the generated TEI to bibliographic formats\n"
+ "# Convert the generated TEI to bibliographic formats\n",
+ "\n",
+ "References:\n",
+ " - https://www.tei-c.org/release/doc/tei-p5-doc/en/html/CO.html#COBIOT (Mapping of TEI to other bibliographic formats)\n",
+ " - https://github.com/OpenArabicPE/convert_tei-to-bibliographic-data (XSLT for conversion of bibl/biblStruct to MODS)\n",
+ " - https://www.loc.gov/standards/mods/mods-conversions.html (XSLT for conversion of MODS to other formats) "
],
"id": "2cdf8ba1eefa38e0"
},
diff --git a/convert-anystyle-data/tei-to-prodigy.ipynb b/convert-anystyle-data/tei-to-prodigy.ipynb
index 355c629..500e2ff 100644
--- a/convert-anystyle-data/tei-to-prodigy.ipynb
+++ b/convert-anystyle-data/tei-to-prodigy.ipynb
@@ -6,9 +6,12 @@
"source": [
"# Convert TEI files to the Prodigy format\n",
"\n",
- "Uses https://github.com/standoff-nlp/standoffconverter and https://spacy.io/\n",
+ "This notebook converts the TEI/bibl annotations to a JSON format which can be imported into prodigy annotation tool.\n",
"\n",
- "based on https://github.com/standoff-nlp/standoffconverter/blob/master/examples/tei-spacy-tei.ipynb"
+ "Resources:\n",
+ " - https://github.com/standoff-nlp/standoffconverter \n",
+ " - https://spacy.io\n",
+ " - https://github.com/standoff-nlp/standoffconverter/blob/master/examples/tei-spacy-tei.ipynb"
],
"id": "cb631197c03a0768"
},
@@ -66,7 +69,7 @@
"cell_type": "code",
"outputs": [],
"execution_count": null,
- "source": "",
+ "source": [],
"id": "f67a3774493ffd9"
}
],
--
GitLab