Skip to content

Commit 151bc01

Browse files
author
christopher.pollin@uni.graz.at
committed
add ediarumWeb
1 parent b4dfcd8 commit 151bc01

4 files changed

Lines changed: 11 additions & 71 deletions

File tree

_layouts/default.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,13 @@ <h1 class="site-name">
141141
>TEI Publisher</a
142142
>
143143
</li>
144+
<li>
145+
<a
146+
class="dropdown-item link-dark"
147+
href="{{ site.baseurl }}/ediarumWeb"
148+
>eidarum.Web</a
149+
>
150+
</li>
144151
</ul>
145152
</li>
146153
<li class="nav-item dropdown">

_posts/2023-11-02-webinars.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,5 +43,6 @@ Präsentationen der Webinarreihe Tools & Transitions
4343

4444
### Webinar V - FairCopy → ediarum.WEB (14.11.2023)
4545
<div align="center">Georg Reiter (ZIM - Universität Graz)</div>
46+
<iframe src="../data/webinars/slides/Tools_and_Transitions_V_Faircopy-ediarumWeb.pdf" width="100%" height="480px"></iframe>
4647

4748

_posts/2023-11-12-ediarumWEB.md

Lines changed: 3 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,21 @@ categories: [tool, ediarum.WEB, publikation, tei, opensource]
88

99
excerpt: ediarum.WEB ist eine Bibliothek für die eXist-db, die die schnelle und einfache Publikation von (TEI-)XML-Datein ermöglichen soll
1010

11-
last_modified_at: 2023-11-12
11+
last_modified_at: 2024-01-21
1212

1313
---
1414

15-
1615
# Allgemeine Beschreibung
1716

18-
[In Bearbeitung]
19-
2017
ediarum.WEB ist ein sich in Entwicklung befindliches Modul von [ediarum](https://www.ediarum.org/index.html), einem Open-Source-Softwareprojekt der TELOTA-Initiative der Berlin-Brandenburgischen Akademie der Wissenschaften. Bei ediarum.WEB handelt es sich um eine Bibliothek für die [eXist-db](http://www.exist-db.org), die es zum Ziel hat, das schnelle und einfache Publizieren von (TEI-)XML-Dateien zu ermöglichen.
2118

2219

2320
## Anwendungsbereiche
2421

25-
26-
2722
* Webpublikation von (TEI-)XML-Daten
2823

29-
3024
## Funktionsübersicht
3125

32-
33-
3426
* Erstellung von digitalen Editionen
3527
* Einfaches Anlegen von sogenannten Objekten (z. B. Briefen, Personen, Orte und Organisationen im Falle unserer Briefedition) und Beziehungen zwischen den Objekten (z. B. Person A als Absender von Brief B oder Nennung von Ort X in Brief Y)
3628
* Anlegen von Filtern bei Objekten (z. B. nach Jahreszahlen bei Briefen oder nach Alphabet bei Personen) möglich
@@ -41,33 +33,24 @@ ediarum.WEB ist ein sich in Entwicklung befindliches Modul von [ediarum](https:/
4133

4234
## Voraussetzungen
4335

44-
4536
Jedes Tool kann einerseits bestimmte Vorkenntnisse der Benutzer:innen voraussetzen und andererseits auch hinsichtlich der Software-Umgebung gewisse Anforderungen stellen.
4637

47-
4838
### **Erforderliche Kenntnisse**
4939

50-
51-
5240
* TEI-XML
5341
* XPath
5442
* XQuery
5543
* XSLT
5644
* HTML/CSS-Grundkenntnisse
57-
* [Bootstrap](https://getbootstrap.com/)-Grundkenntnisse
58-
45+
* JavaScript
5946

6047
### **Benötigte Software**
6148

62-
63-
6449
* eXist-db
65-
* Docker Desktop (für eine weniger fehleranfällige Installation von eXist-db)
66-
50+
* Docker Desktop (für eine einfachere Installation von eXist-db)
6751

6852
## Tool-Kompatibilität
6953

70-
7154
<table>
7255
<tr>
7356
<td>
@@ -112,11 +95,8 @@ Jedes Tool kann einerseits bestimmte Vorkenntnisse der Benutzer:innen voraussetz
11295
</table>
11396

11497

115-
11698
## Kostenübersicht
11799

118-
119-
120100
* **_ediarum.WEB_ & _eXist-db_:**
121101
* kostenlos
122102

@@ -125,11 +105,8 @@ Jedes Tool kann einerseits bestimmte Vorkenntnisse der Benutzer:innen voraussetz
125105

126106
Da jedes Projekt unterschiedliche Anforderungen mit sich bringt, sollen nachfolgend mögliche Vor- und Nachteile des getesteten Tools dargestellt werden.
127107

128-
129108
## Stärken
130109

131-
132-
133110
* Vorkonfiguriertes Basislayout, das adaptiert werden kann
134111
* Basale digitale Editionen mit typischen Funktionalitäten (z. B. Filter bei Objekten wie Personen (z. B. alphabetisch) und Texten (z. B. nach Jahreszahl) schnell und relativ einfach umsetzbar
135112
* Rückgriff auf eine große Menge an vordefinierten XQuery-Funktionen möglich, um eine Vielzahl an potentiell gewünschten Funktionalitäten umzusetzen
@@ -151,8 +128,6 @@ Anhand eines[Beispielprojekts](https://digedtnt.github.io/about/#briefsammlung-p
151128

152129
## 1. Installation einzelner Komponenten
153130

154-
155-
156131
* **Installation der XML-Datenbank eXist-db:** Da es sich bei ediarum.WEB um eine Bibliothek für eXist-db handelt, müssen wir diese Datenbank zunächst installieren. Wir entscheiden uns für die Installation via Docker Desktop, die [hier](https://digedtnt.github.io/docker-exist/) erläutert wird.
157132
* **Installation von _ediarum.WEB_ in _eXist-db_:** Im nächsten Schritt muss nun ediarum-WEB in eXist-db eingerichtet werden.
158133
* Dafür laden wir aus dem _[ediarum.WEB-GitHub-Repository](https://github.com/ediarum/ediarum.WEB/releases)_ die aktuellste Version (2.1.1) von _ediarum.WEB_ als XAR-Datei herunter.
@@ -167,13 +142,8 @@ Anhand eines[Beispielprojekts](https://digedtnt.github.io/about/#briefsammlung-p
167142

168143
{% include image.html url="../data/pipelines/pipeline_2/ediarum_web/img/ediarum_web_installiert.png" description="ediarum.WEB in der eXide-IDE" %}
169144

170-
* **Erzeugen eines Projekttemplates mittels Apache Ant:** [In Bearbeitung]
171-
172-
173145
## 2. Einrichtung des Projekts
174146

175-
176-
177147
* Zunächst müssen wir unsere XML-Dateien, die Briefe Hugo Schuchardts und das Named-Entity-Register, in eXist-db hochladen. Dazu öffnen wir eXide, wählen im Reiter “File” und daraus “Manage” aus, woraufhin sich der Dateimanager öffnet.
178148
{% include image.html url="../data/pipelines/pipeline_2/ediarum_web/img/exide_create_collection.png" description="Der eXide-Dateimanager" %}
179149

@@ -183,14 +153,9 @@ Auf der Ebene der Ordner “apps” und “system” legen wir einen Ordner name
183153
Danach navigieren wir in den Ordner “letters”, klicken auf das Wolkensymbol und laden die fünf Briefe Hugo Schuchardts hoch. Ist dies erledigt, kehren wir mittels Klick auf “done” zur Navigationsansicht zurück und laden in gleicher Weise das Named-Entity-Register in den Ordner “register” hoch.
184154

185155
{% include image.html url="../data/pipelines/pipeline_2/ediarum_web/img/upload_xml.png" description="Das Hochladen der Briefe" %}
186-
187-
188-
189156

190157
## 3. Bearbeitung der Dokumente
191158

192-
193-
194159
* **Anpassen des Titels der Indexsseite:** Zuerst wollen wir den Titel unseres Projekts abändern und navigieren dazu über eXide in den Ordner “templates” und öffnen die Datei “page.html”. Dort ändern wir die beiden Vorkommnisse von “Workshop” auf “Hugo Schuchardt: Briefe” ab, speichern die Datei und laden dann die Indexseite neu.
195160

196161
{% include image.html url="../data/pipelines/pipeline_2/ediarum_web/img/landing_page_schuchardt.png" description="Die neue Indexsseite" %}
@@ -202,10 +167,8 @@ Danach navigieren wir in den Ordner “letters”, klicken auf das Wolkensymbol
202167

203168
{% include image.html url="../data/pipelines/pipeline_2/ediarum_web/img/appconf.png" description="Die Datei appconf.xml" %}
204169

205-
206170
Wir ändern die dort im `<project>`-Element vorhandenen Daten wie folgt ab:
207171

208-
209172
```xml
210173
<config
211174
xmlns="http://www.bbaw.de/telota/software/ediarum/web/appconf">
@@ -217,7 +180,6 @@ Danach navigieren wir in den Ordner “letters”, klicken auf das Wolkensymbol
217180
</config>
218181
```
219182

220-
221183
Folgende Informationen werden hier mittels XML-Elemente festgelegt:
222184

223185
* `<name>`: Hier wird der Projektname festgelegt, der Name dient auch als ID
@@ -648,7 +610,6 @@ Danach navigieren wir in den Ordner “letters”, klicken auf das Wolkensymbol
648610
</parts>
649611
```
650612

651-
652613
Die Attribute `@separator` und `@prefix` müssen verpflichtend angegeben werden. Ersteres legt fest, wie Teile und Unterteile im Falle von Verschachtelung abgeteilt würden (also z. B. durch Punkt wie in unserem Fall). Zweiteres legt fest, wie die Namespaces (`@starts-with`) von den Werten getrennt werden (also z. B. durch Bindestrich in unserem Fall wie etwa “page-1”). `<root>` legt wieder das Wurzelelement des Teils fest, in unserem Fall die Seiten (`<tei:pb>`), `<id>` gibt die ID des Teils an, in unserem Fall das `@n`.
653614

654615

@@ -686,21 +647,11 @@ Danach navigieren wir in den Ordner “letters”, klicken auf das Wolkensymbol
686647
</div>
687648
</div>
688649
```
689-
690-
691650
Navigieren wir nun zu der Detailansicht eines Briefes, zeigt sich, dass nur die erste Seite angezeigt wird und ein Navigationsmenü zur Verfügung steht, mit dem zwischen den einzelnen Seiten umgeschaltet werden kann.
692651

693652

694653
{% include image.html url="../data/pipelines/pipeline_2/ediarum_web/img/briefe_pages.png" description="Das Menü zum Umschalten zwischen den einzelnen Briefseiten" %}
695654

696-
* **Einfügen einer Suchfunktion:** [In Arbeit]
697-
698-
699-
## 5. Export
700-
701-
[In Arbeit]
702-
703-
704655
# Kontakt
705656

706657
**Unternehmensgröße:**
@@ -717,36 +668,17 @@ Danach navigieren wir in den Ordner “letters”, klicken auf das Wolkensymbol
717668
</tr>
718669
</table>
719670

720-
721-
722671
# Ressourcen
723672

724-
725673
## Dokumentation
726674

727-
728-
729675
* [GitHub](https://github.com/ediarum/ediarum.WEB) (API.md, APPCONF.md, FEATURES.md, LIBRARIES.md, README.md)
730676

731677
## Tutorials
732678

733679
* [Erste Schritte](https://www.ediarum.org/docs/ediarum-web-step-by-step/index.html#/)
734680

735681

736-
## Projekte, die dieses Tool genutzt haben
737-
738-
739-
740-
*
741-
742-
743-
## Literatur
744-
745-
746-
747-
* Derzeit ist keine Literatur zu _ediarum.WEB_ bekannt
748-
749-
750682
# Factsheet
751683

752684
[In Arbeit]
Binary file not shown.

0 commit comments

Comments
 (0)