uEdition 1.3.1__tar.gz → 2.0.0a1__tar.gz

{uedition-1.3.1 → uedition-2.0.0a1}/.github/workflows/release.yml

@@ -26,12 +26,11 @@ jobs:
 
     - name: Install Base Dependencies
       run: |
-        sudo apt-get install python3-venv
-        sudo pip install hatch
+        pip install --user build
 
     - name: Build the package
       run: |
-        hatch build
+        python -m build
 
     - name: Publish package distributions to PyPI
       uses: pypa/gh-action-pypi-publish@release/v1

{uedition-1.3.1 → uedition-2.0.0a1}/.pre-commit-config.yaml

@@ -1,10 +1,7 @@
 repos:
-  - repo: https://github.com/psf/black
-    rev: 24.1.0
-    hooks:
-      - id: black
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.1.14
+    rev: v0.9.5
     hooks:
       - id: ruff
         args: [--fix]
+      - id: ruff-format

{uedition-1.3.1 → uedition-2.0.0a1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: uEdition
-Version: 1.3.1
+Version: 2.0.0a1
 Project-URL: Documentation, https://github.com/uEdition/uEdition#readme
 Project-URL: Issues, https://github.com/uEdition/uEdition/issues
 Project-URL: Source, https://github.com/uEdition/uEdition
@@ -11,17 +11,22 @@ Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.10
 Requires-Dist: copier<10.0.0,>=9.0.0
-Requires-Dist: jupyter-book<2.0.0,>=1.0.0
 Requires-Dist: livereload
 Requires-Dist: lxml<6.0.0,>=4.9.2
+Requires-Dist: myst-parser<5,>=4.0.1
 Requires-Dist: pydantic-settings<3.0.0,>=2.0.0
 Requires-Dist: pydantic<3.0.0,>=2.0.0
 Requires-Dist: pyyaml<7.0.0,>=6.0.0
-Requires-Dist: typer[all]<1.0.0
+Requires-Dist: sphinx-book-theme<2,>=1.1.4
+Requires-Dist: sphinx-external-toc<2,>=1.0.1
+Requires-Dist: sphinx<9,>=8.2.3
+Requires-Dist: typer<1.0.0
 Description-Content-Type: text/markdown
 
 # μEdition

{uedition-1.3.1 → uedition-2.0.0a1}/docs/.gitignore

@@ -1,5 +1,5 @@
 _build
 site
 _toc.yml
-_config.yml
+conf.py
 _static

{uedition-1.3.1 → uedition-2.0.0a1}/docs/.uEdition.answers

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: v0.1.8
+_commit: v0.6.1
 _src_path: gh:uEdition/uEdition-project-template
 author_email: mark.hall@work.room3b.eu
 author_name: Mark Hall

{uedition-1.3.1 → uedition-2.0.0a1}/docs/de/changelog.md

@@ -1,5 +1,13 @@
 # Änderungsgeschichte
 
+## In Entwicklung
+
+* **Entfernt**: Undokumentierten "check" Kommandozeilenbefehl entfernt
+
+## 1.3.2 (26.02.2024)
+
+* **Bugfix**: Weiteren Fehler in der Sortierung nach Seitenzahlen behoben
+
 ## 1.3.1 (26.02.2024)
 
 * **Bugfix**: Fehler in der Sortierung nach Seitenzahlen behoben

{uedition-1.3.1 → uedition-2.0.0a1}/docs/de/index.md

@@ -5,6 +5,20 @@ die technischen Anforderungen und Hostingkosten geht. Die μEdition bietet ein G
 es ein einfaches Werkzeug anbietet, welches Projekte darin unterstützt einfach (multilinguale) digitale Editionen zu
 erstellen, welche dann über gratis oder billige Hostinglösungen online verfügbar gemacht werden können.
 
+:::{admonition} Hilfe und Unterstützung
+:class: tip
+
+Die μEdition ist noch ein junges Projekt und benötigt Feedback von Nutzern und Nutzerinnen um die Hürden zur Nutzung
+weiter zu reduzieren. Egal ob dies zusätzliche Dokumentation ist, Fehler beheben, oder zusätzliche Funktionalität,
+bitte informiert uns und dann können wir die μEdition besser machen.
+
+Für alle Fragen zur μEdition und zu ihrer Nutzung, nutzt bitte unser GitHub Discussions Forum:
+https://github.com/uEdition/uEdition/discussions.
+
+Wenn Fehler auftreten, dann bitte diese über unsere GitHub Issues melden und dann können wir sie reparieren:
+https://github.com/uEdition/uEdition/issues.
+:::
+
 ## Inhaltsverzeichnis
 
 :::{tableofcontents}
@@ -12,10 +26,11 @@ erstellen, welche dann über gratis oder billige Hostinglösungen online verfüg
 
 ## Schnellstart
 
-Für einen Schnellstart mit der μEdition, folgens sie diesen Schritten (Python 3.10 oder nuer muss bereits installiert sein):
+Für einen Schnellstart mit der μEdition, folgens sie diesen Schritten (Python 3.10 oder neuer und pipx müssen bereits installiert sein):
 
 :::{code} console
-$ pipx install hatch copier
+$ pipx install hatch
+$ pipx install copier
 $ copier copy https://github.com/uEdition/uEdition-project-template my-edition
 🎤 What is the name of your μEdition?
    My Edition
@@ -33,7 +48,7 @@ $ copier copy https://github.com/uEdition/uEdition-project-template my-edition
 🎤 What is the repository branch containing your μEdition?
    main
 
-Copying from template version 0.1.0
+Copying from template version 0.6.1
     create  .
     create  toc.yml
     create  uEdition.yml
@@ -44,7 +59,7 @@ Copying from template version 0.1.0
     create  .gitignore
     create  pyproject.toml
 $ cd my-edition
-$ hatch run uEdition language add cy
+$ hatch run add-language cy
 🎤 What is the language code?
    cy
 🎤 What is the name of the language?

uedition-2.0.0a1/docs/de/user/configuration.md

@@ -0,0 +1,36 @@
+# Die μEdition konfigurieren
+
+Die μEdition und Sphinx sind sehr konfigurable. Sowohl die μEdition, wie auch die Sphinx Funktionalität
+werden über die {file}`uEdition.yml` (im Wurzelverzeichnis der μEdition) konfiguriert. Der folgende Block zeigt alle
+verfügbaren Konfigurationsoptionen:
+
+:::{code-block} yaml
+author:           # Die Autor:innen:information bestehend aus
+  name:           #   Dem Autor:in:namen
+  email:          #   Der E-Mailaddresse der/des Autor:in:s
+sphinx_config:    # Enthält alle zusätzlichen Sphinx Konfigurationseinträge
+languages:        # Die in der μEdition konfigurierten Sprachen. Eine List, in der jeder Eintrag aus folgenden Teilen besteht:
+  - code:         #   Der ISO 639-1 zweistellige Sprachcode
+    label:        #   Der Text der in der Ausgabe für die Sprache angezeigt wird
+    path:         #   Der Dateipfad in dem das sprachspezifische Jupyter Book abgelegt ist
+output:           # Das Ausgabeverzeichnis für die komplette μEdition
+repository:       # Das Git Repository für diese μEdition:
+  url:            #   Die URL für das Repository
+title:            # Der Titel der μEdition in allen konfigurierten Sprachen. Jede konfigurierte Sprache muss vorkommen.
+  en:             #   Abbildung vom ISO 639-1 Sprachcode auf den natürlichsprachlichen Titel
+version: '2'      # Die Version der μEdition Konfigurationsdatei. Muss auf "2" gesetzt sein.
+:::
+
+Alle Konfigurationselement der Datei sind optional und nicht angegebene Werte werden durch funktionierende Standardwerte
+ersetzt.
+
+Alle Sphinx Einstellungen können über den `jsphinx_config` Eintrag konfiguriert werden. Sphinx nutzt eine normale
+Python Datei für die Konfiguration, in der die Konfigurationseinstellungen als Variablen definiert werden und die
+Konfigurationseinstellung dann der Wert ist, der der Variablen zugewiesen wird. In der {file}`uEdition.yml` werden die
+Variablennamen und Einstellung als Schlüssel-Wert Paare im `sphinx_config` Bereich der Datei eingetragen. Zum Beispiel
+könnte das Theme der μEdition mit der folgenden Einstellung umgestellt werden:
+
+:::{code-block} yaml
+sphinx_config:
+  html_theme: mein-theme
+:::

uedition-2.0.0a1/docs/de/user/content.md

@@ -0,0 +1,56 @@
+# Inhalte hinzufügen
+
+Die μEdition nutzt [Jupyter Book](https://jupyterbook.org) um aus den Inhalten eine Webseite zu generieren,
+welche dann veröffentlicht werden kann. Wenn die Webseite generiert wird, generiert die μEdition zuerst die
+Webseiten für die einzelnen Sprachen und fügt dann die notwendigen Element hinzu um die einzelnen Sprachen
+zusammenzufügen. Da die μEdition auf dem Jupyter Book aufbaut, sind der Großteil der Dokumentation des
+Jupyter Book Projekts auch für die μEdition nutzbar. Der einzige Unterschied ist, dass die μEdition eine
+Konfigurationsdatei und ein Inhaltsverzeichnisse für alle Sprachen nutzt.
+
+## Die μEdition strukturieren
+
+Die Struktur der μEdition wird über das Inhaltsverzeichnis definiert, welches in der {file}`toc.yml` Datei
+(im Wurzelverzeichnis der μEdition) konfiguriert wird. Die {file}`toc.yml` Datei nutzt das Format
+[der zugrundeliegenden Jupyter Book Technik](https://jupyterbook.org/en/stable/structure/toc.html). Der
+einzige Unterschied ist, dass die `title` und `caption` Einträge in der μEdition mit sprachspezifischen
+Werten konfiguriert werden. Wenn die μEdition dann generiert wird, werden für jede konfigurierte Sprache
+die jeweils relevanten Werte genutzt:
+
+:::{code-block} yaml
+format: jb-book
+root: index
+parts:
+  - caption:
+      en: Name of Part 1
+      de: Name von Teil 1
+    chapters:
+    - title:
+        en: Chapter 1
+        de: Chapter 2
+      file: path/to/part1/chapter1
+    - file: path/to/part1/chapter2
+:::
+
+## Texte schreiben
+
+Das Jupyter Book nutzt primär MyST (Markedly Structured Text) um die Textinhalte zu erstellen. Dies ist eine Erweiterung
+des Markdownformats für komplexere Texte. Eine gute Übersicht über die Kernfunktionalität
+[findet sich hier](https://myst-parser.readthedocs.io/en/latest/syntax/typography.html). Das Jupyter Book stellte eine
+Reihe von Erweiterungen bereit, welche [hier dokumentiert sind](https://jupyterbook.org/en/stable/content/index.html)
+und welche die einfache Erstellung von Aspekten wie Glossar, Index, Zitierbarkeit, Fußnoten und Layoutstrukturen.
+
+Die μEdition stellt selbst eine Erweiterung zur Verfügung, welche die nutzung von TEI-XML (Text Encoding Initiative)
+sowohl als Eingabe, wie auch als Ausgabeformat bereitstellt.
+
+## Lokaler Server
+
+Während des Schreibprozesses kann es hilfreich sein zu sehen, wie das Ergebnis aussieht. Um dies zu vereinfachen stellt
+die μEdition einen eingebauten Webserver zur verfügung, der die generierte μEdition automatisch aktualisiert, wenn die
+Inhalte bearbeitet werden. Um den Server zu starten wird folgender Befehl genutzt:
+
+:::{code-block} console
+$ hatch run serve
+:::
+
+This generiert die μEdition und macht sie dann unter http://localhost:8000 verfügbar. Wenn die Inhalte geändert werden,
+wird die μEdition automatisch neugeneriert und die Seite im Browser automatisch neugeladen.

{uedition-1.3.1 → uedition-2.0.0a1}/docs/de/user/language-add.md

@@ -6,7 +6,7 @@ einzigen Sprache veröffentlicht werden soll, diese Sprache trotzdem explizit ko
 Um der μEdition eine Sprache hinzuzufügen, führen sie folgenden Befehl aus:
 
 :::{code-block} console
-$ hatch run uEdition language add ORDERNAME
+$ hatch run add-language ORDNERNAME
 :::
 
 Ersetzen sie `ORDNERNAME` mit dem Namen des Orderners in dem die Inhalte in der Sprache gespeichert werden. Der Vorgang

uedition-2.0.0a1/docs/de/user/language-update.md

@@ -0,0 +1,12 @@
+# Eine Sprache aktualisieren
+
+Die μEdition nutzt dieselbe Schablonenfunktion für jede Sprache und diese müssen für jede Sprache einzeln
+aktualisiert werden. Dazu wird folgender Befehl genutzt:
+
+:::{code-block} console
+$ hatch run update-language ORDNERNAME
+:::
+
+Dabei wird `ORDNERNAME` mit dem Namen des Verzeichnisse, in dem das sprachspezifische Jupyter Book sitzt, ersetzt.
+
+Ähnlich wie beim Update der μEdition selbst, sollten alle Änderungen überprüft werden, bevor weitergearbeitet wird.

uedition-2.0.0a1/docs/de/user/publish.md

@@ -0,0 +1,34 @@
+# Die μEdition publizieren
+
+Wenn die μEdition in einem Zustand ist, in dem sie publizert werden kann, dann generiert folgender Befehl
+eine publizierbare Version:
+
+:::{code-block} console
+$ hatch run build
+:::
+
+Die μEdition generiert dann die Webinhalte in das konfigurierte Ausgabeverzeichnis (Standardmäßig das Verzeichnis
+{file}`site`). Der Inhalt kann dann auf eine beliebige Hostinglösung kopiert werden und ist dann öffentlich
+Verfügbar.
+
+## Auf GitHub Pages publizieren
+
+Die μEdition kommt standardmäßig mit Unterstützung um die μEdition über [GitHub Pages](https://pages.github.com/)
+zu publizieren. Damit das funktioniert müssen folgende Vorraussetzungen erfüllt werden:
+
+* Die μEdition muss ein Git Repository nutzen.
+* Ein Benutzerkonto auf [GitHub](https://www.github.com) muss verfügbar sein.
+* Ein Repository muss auf GitHub konfiguriert sein und die μEdition muss in dieses Repository gepushed werden.
+
+Danach in GitHub in dem Repository in den Bereich {guilabel}`Settings` navigieren und dann zu {guilabel}`Pages`.
+Auf der {guilabel}`Pages` Seite muss unter der Überschrift {guilabel}`Build and deployment` die {guilabel}`Source`
+Auswahl auf "GitHub Actions" gesetzt sein.
+
+Um die μEdition manuell zu publizieren, in GitHub im Respository auf {guilabel}`Actions` navigieren und dort links den
+{guilabel}`Publish the site` Workflow auswählen. Dieser Workflow kann manuell getriggered werden. Dazu auf den
+{guilabel}`Run workflow` Knopf klicken und dann auf den grünen {guilabel}`Run workflow` Knopf im Popup klicken.
+Dies startet den Publikationsvorgang und wenn der Workflow abgeschlossen ist, can die μEdition unter der URL, die
+unter {guilabel}`Settings` > {guilabel}`Pages` angezeigt wird, aufgerufen werden.
+
+Der Workflow ist auch so konfiguriert, dass die μEdition automatisch publiziert wird, sobald eine Änderung im
+primären Branch erfolgt.

uedition-2.0.0a1/docs/de/user/update.md

@@ -0,0 +1,13 @@
+# Die μEdition aktualisieren
+
+Die μEdition Projektschablone wird von Zeit zu Zeit aktualisiert. Um die μEdition auf den neuesten Stand zu bringen,
+wird folgender Befehl genutzt:
+
+:::{code-block} console
+$ hatch run update
+:::
+
+Dies wird alle Änderungen der Projektschablone auf die μEdition anwenden.
+
+Der Updatevorgang sollte die μEdition in keiner Weise beschädigen, es wird aber empfohlen alle Änderungen zu überprüfen,
+bevor an der μEdition weitergearbeitet wird.

{uedition-1.3.1 → uedition-2.0.0a1}/docs/en/changelog.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## In Development
+
+* **Removed**: Removed undocumented "check" command
+
+## 1.3.2 (26.02.2024)
+
+* **Bugfix**: Further bugfix in the sorting by page functionality
+
 ## 1.3.1 (26.02.2024)
 
 * **Bugfix**: Fix a bug in sorting by page

{uedition-1.3.1 → uedition-2.0.0a1}/docs/en/index.md

@@ -5,6 +5,20 @@ hurdles, particularly around technical knowledge and hosting costs. The μEditio
 providing a simple tool that supports users in easily building (multi-lingual) digital editions that can then easily be made
 available online using free or low-cost hosting solutions.
 
+:::{admonition} Getting Help
+:class: tip
+
+The μEdition is still a young project and relies on your feedback to further lower the barriers to its use. Whether this is
+adding documentation on how to do things, fixing broken things, or adding extra features, please let us know what is needed
+and then we can make it better.
+
+If you have any questions about anything related to the μEdition, please use our GitHub Discussions forum to ask:
+[https://github.com/uEdition/uEdition/discussions](https://github.com/uEdition/uEdition/discussions).
+
+If you run into any bugs, then please report these via the GitHub Issues and we can get them fixed:
+[https://github.com/uEdition/uEdition/issues](https://github.com/uEdition/uEdition/issues).
+:::
+
 ## Contents
 
 :::{tableofcontents}
@@ -12,10 +26,11 @@ available online using free or low-cost hosting solutions.
 
 ## Quickstart
 
-To quickly get started with the μEdition, follow these steps (assuming you already have Python 3.10 or newer installed):
+To quickly get started with the μEdition, follow these steps (assuming you already have Python 3.10 or newer and pipx installed):
 
 :::{code} console
-$ pipx install hatch copier
+$ pipx install hatch
+$ pipx install copier
 $ copier copy https://github.com/uEdition/uEdition-project-template my-edition
 🎤 What is the name of your μEdition?
    My Edition
@@ -33,7 +48,7 @@ $ copier copy https://github.com/uEdition/uEdition-project-template my-edition
 🎤 What is the repository branch containing your μEdition?
    main
 
-Copying from template version 0.1.0
+Copying from template version 0.6.1
     create  .
     create  toc.yml
     create  uEdition.yml
@@ -44,7 +59,7 @@ Copying from template version 0.1.0
     create  .gitignore
     create  pyproject.toml
 $ cd my-edition
-$ hatch run uEdition language add cy
+$ hatch run add-language cy
 🎤 What is the language code?
    cy
 🎤 What is the name of the language?

{uedition-1.3.1 → uedition-2.0.0a1}/docs/en/user/content.md

@@ -37,19 +37,19 @@ parts:
 Jupter Book primarily uses MyST or Markedly Structured Text for writing text content, which is an extension of Markdown
 designed for publishable content. A good overview over the core functionality can be found
 [here](https://myst-parser.readthedocs.io/en/latest/syntax/typography.html). Jupyter Book provides a range of extensions
-built upon the core MySQ structure, which are documented [here](https://jupyterbook.org/en/stable/content/index.html)
+built upon the core MyST structure, which are documented [here](https://jupyterbook.org/en/stable/content/index.html)
 and which include useful things like glossaries, indices, citations, footnotes, plus elements for structuring the layout
 of the page and its content.
 
 ## Local server
 
 While writing it can be helpful to see what the result will look like. To simplify this, the μEdition provides a built-in
-web-server that automatically re-generates the website when you edit the content. To start this server, run the
+web-server that automatically re-generates your μEdition when you edit the content. To start this server, run the
 following command:
 
 :::{code-block} console
 $ hatch run serve
 :::
 
-This will build the μEdition and then make it available at http://localhost:8000. When you make changes to the content,
-the μEdition will automatically re-build the website and automatically reload the view in the browser.
+This will build your μEdition and then make it available at http://localhost:8000. When you make changes to the content,
+the μEdition will automatically re-build your μEdition and automatically reload the view in the browser.

{uedition-1.3.1 → uedition-2.0.0a1}/docs/en/user/language-add.md

@@ -6,7 +6,7 @@ a single language only, you need to explicitly configure this one language.
 To add a language to your μEdition, run the following command:
 
 :::{code-block} console
-$ hatch run uEdition language add FOLDER_NAME
+$ hatch run add-language FOLDER_NAME
 :::
 
 Replace `FOLDER_NAME` with the name of the folder that the μEdition content for that language is to be placed in. The

{uedition-1.3.1 → uedition-2.0.0a1}/docs/en/user/language-update.md

@@ -4,7 +4,7 @@ The μEdition uses the same template approach for each language that you set up
 from the main update. Run the following command to update a single language:
 
 :::{code-block} console
-$ hatch run uEdition language update PATH
+$ hatch run update-language PATH
 :::
 
 Replace `PATH` with the name of the folder of the language you wish to update.

{uedition-1.3.1 → uedition-2.0.0a1}/docs/en/user/publish.md

@@ -4,7 +4,7 @@ When you have your μEdition in a state that you want to publish it, then run th
 publishable version:
 
 :::{code-block} console
-$ hatch run publish
+$ hatch run build
 :::
 
 The μEdition will build the site into the configured output folder, which by default is {file}`site`. You can then

uedition-2.0.0a1/docs/en/user/working-with-tei.tei

@@ -0,0 +1,46 @@
+<tei:TEI xmlns:tei="http://www.tei-c.org/ns/1.0">
+  <tei:teiHeader>
+    <tei:fileDesc>
+      <tei:titleStmt>
+        <tei:title>Working with TEI</tei:title>
+        <tei:author>
+          <tei:persName>Hall, Mark</tei:persName>
+        </tei:author>
+      </tei:titleStmt>
+    </tei:fileDesc>
+  </tei:teiHeader>
+  <tei:text>
+    <tei:body>
+      <tei:p>
+        <tei:seg>This is an example section.</tei:seg>
+      </tei:p>
+      <tei:p style="align-right">
+        <tei:seg>This paragraph is aligned to the </tei:seg>
+        <tei:hi style="italic">right</tei:hi>
+        <tei:seg>.</tei:seg>
+      </tei:p>
+      <tei:p>
+        <tei:seg>It is also possible to reference elements in another section using </tei:seg>
+        <tei:ref target="#annotation-1">references</tei:ref>
+        <tei:seg>.</tei:seg>
+      </tei:p>
+      <tei:head id="tei-configuration" type="level-1">
+        <tei:seg>Configuring the TEI mapping</tei:seg>
+      </tei:head>
+    </tei:body>
+    <tei:interpGrp>
+      <tei:interp id="annotation-1">
+        <tei:p>
+          <tei:seg>This is the first annotation.</tei:seg>
+        </tei:p>
+      </tei:interp>
+      <tei:interp id="annotation-2">
+        <tei:p>
+          <tei:seg>This is the second annotation. It has a </tei:seg>
+          <tei:ref target="#annotation-1">cross-reference</tei:ref>
+          <tei:seg> to another annotation.</tei:seg>
+        </tei:p>
+      </tei:interp>
+    </tei:interpGrp>
+  </tei:text>
+</tei:TEI>

{uedition-1.3.1 → uedition-2.0.0a1}/docs/pyproject.toml

@@ -18,10 +18,12 @@ Issues = "https://github.com/uEdition/uEdition/-/issues"
 Source = "https://github.com/uEdition/uEdition/-"
 
 [tool.hatch.envs.default]
-dependencies = ["uedition>=0.9.0",]
+dependencies = ["uedition>=1.3.0,<2",]
 skip-install = true
 
 [tool.hatch.envs.default.scripts]
 build = "uEdition build {args}"
 serve = "uEdition serve {args}"
 update = "uEdition update {args}"
+add-language = "uEdition language add {args}"
+update-language = "uEdition language update {args}"

uedition-2.0.0a1/docs/static/overrides.css

@@ -0,0 +1,3 @@
+[data-tei-attribute-style="align-right"] {
+    text-align: right;
+}

{uedition-1.3.1 → uedition-2.0.0a1}/docs/toc.yml

@@ -11,4 +11,5 @@ chapters:
       - file: user/publish
       - file: user/update
       - file: user/language-update
+      - file: user/working-with-tei
   - file: changelog

uedition-2.0.0a1/docs/uEdition.yml

@@ -0,0 +1,73 @@
+author:
+  email: mark.hall@work.room3b.eu
+  name: Mark Hall
+languages:
+  - code: en
+    label: English
+    path: en
+  - code: de
+    label: Deutsch
+    path: de
+output: site
+repository:
+  url: https://github.com/uEdition/uEdition
+title:
+  de: "\u03BCEdition"
+  en: "\u03BCEdition"
+sphinx_config:
+  html_static_path:
+    - _static
+  html_css_files:
+    - overrides.css
+  tei:
+    blocks:
+      - name: paragraph
+        selector: tei:p
+        tag: p
+        attributes:
+          - type: text
+            name: style
+      - name: heading-1
+        selector: tei:head[@type="level-1"]
+        tag: h1
+        attributes:
+          - type: static
+            name: type
+            value: level-1
+      - name: heading-2
+        selector: tei:head[@type="level-2"]
+        tag: h2
+        attributes:
+          - type: static
+            name: type
+            value: level-1
+    marks:
+      - name: emphasis
+        selector: tei:hi[@style="italic"]
+        tag: em
+      - name: annotation-ref
+        selector: tei:ref
+        tag: a
+        attributes:
+          - type: id-ref
+            name: target
+          - type: html-attribute
+            name: target
+            target: href
+    sections:
+      - name: metadata
+        type: metadata
+        selector: /tei:TEI/tei:teiHeader
+        fields:
+          - title: Author
+            type: single
+            selector: tei:fileDesc/tei:titleStmt/tei:author/tei:persName/text()
+      - name: bodytext
+        title: Main text
+        type: text
+        selector: /tei:TEI/tei:text/tei:body
+      - name: annotations
+        type: textlist
+        title: Annotations
+        selector: /tei:TEI/tei:text/tei:interpGrp/tei:interp
+version: "2"