Neue MVO eingearbeitet
This commit is contained in:
+17
-3
@@ -21,7 +21,7 @@ Umsetzung: Mista GmbH
|
||||
| Komponente | Technologie |
|
||||
|------------------|--------------------------------------------------|
|
||||
| Build-System | Sphinx (Python) |
|
||||
| Textformat | reStructuredText (rST) |
|
||||
| Textformat | reStructuredText (rST) und/oder Markdown (MyST) |
|
||||
| Templating | Jinja2 (Rahmenkapitel, Titelseite) |
|
||||
| PDF-Erzeugung | LaTeX (pdflatex/lualatex) |
|
||||
| Versionierung | Git (Gitea auf Hetzner) |
|
||||
@@ -102,11 +102,19 @@ transport-docs-base/
|
||||
│ ├── 01_einleitung/
|
||||
│ │ ├── template.de.rst # Jinja2-Template mit Platzhaltern
|
||||
│ │ └── template.en.rst
|
||||
│ ├── 01_zertifikate/
|
||||
│ │ ├── konformitaetserklaerung/
|
||||
│ │ ├── konfigurationsbeschreibung/
|
||||
│ │ ├── einbauerklaerungen/ # Einbauerklärung + Montageanleitung unvollständiger Maschinen
|
||||
│ │ └── konformitaetserklaerungen_komponenten/ # DoCs zugekaufter Komponenten
|
||||
│ ├── 02_sicherheit/
|
||||
│ │ ├── allgemein.de.rst # Immer dabei
|
||||
│ │ ├── allgemein.en.rst
|
||||
│ │ ├── normen_ce.de.rst # EU-Konformität
|
||||
│ │ └── normen_ukca.en.rst # UK-spezifisch
|
||||
│ │ ├── normen_ukca.en.rst # UK-spezifisch
|
||||
│ │ ├── normen/gemeinsame_spezifikationen/ # "gemeinsame Spezifikationen" (VO (EU) 2023/1230, Art. 20)
|
||||
│ │ ├── normen/sonstige_spezifikationen/ # sonstige angewandte techn. Spezifikationen
|
||||
│ │ └── risikobewertung/restrisiken/ # explizite Restrisiken-Section
|
||||
│ ├── 03_anlagenbeschreibung/
|
||||
│ │ └── template.de.rst # Hier werden Module eingefügt
|
||||
│ ├── 04_betrieb/
|
||||
@@ -241,6 +249,8 @@ requires:
|
||||
- antrieb_sew
|
||||
```
|
||||
|
||||
Module können in `02_sicherheit` neben `risikomatrix` optional auch die Section `restrisiken` referenzieren, um modulspezifische Restrisiken gemäß Anhang IV Teil A VO (EU) 2023/1230 auszuweisen. Einbauerklärungen und Komponenten-Konformitätserklärungen (`01_zertifikate/einbauerklaerungen/`, `01_zertifikate/konformitaetserklaerungen_komponenten/`) sind i. d. R. keine Modul-Sections, sondern projekt-/lieferantenweite Dokumente und werden direkt im Projekt-Repo (`overrides/` bzw. `additional/`) oder in `08_lieferantendoku` abgelegt und von dort referenziert.
|
||||
|
||||
### conf.py (Projekt-Konfiguration)
|
||||
|
||||
Importiert die Basiskonfiguration vom gemounteten Base-Repo und setzt projektspezifische Overrides.
|
||||
@@ -316,7 +326,7 @@ Base-Repo hat Semver in `VERSION`. Projekt-Repo kann `"base_version": ">=2.1.0"`
|
||||
|
||||
### Drei Ebenen
|
||||
|
||||
1. **Textbausteine**: Dateinamenskonvention `{name}.{lang}.rst`. Fallback auf `de` bei fehlender Übersetzung.
|
||||
1. **Textbausteine**: Dateinamenskonvention `{name}.{lang}.{rst|md}`. Fallback auf `de` bei fehlender Übersetzung.
|
||||
2. **Bilder**: `localized-figure`-Direktive löst `assets/localized/{lang}/pfad/bild.png` auf. Fallback auf `de`. Optional: Jinja2-SVG-Templates für Diagramme mit Text.
|
||||
3. **Glossar**: CSV pro Sprache (`terms.{lang}.csv`), `glossary_loader.py` erzeugt Sphinx-Glossardirektiven. Im Text via `:term:`Fachbegriff`` verlinkt.
|
||||
|
||||
@@ -324,6 +334,10 @@ Base-Repo hat Semver in `VERSION`. Projekt-Repo kann `"base_version": ">=2.1.0"`
|
||||
|
||||
Gesteuert über `normen_region` in anlage.json. Kapitel 02_sicherheit enthält z.B. `normen_ce.de.rst` (EU) und `normen_ukca.en.rst` (UK), Build wählt nach Region.
|
||||
|
||||
### rST und Markdown gleichwertig (MyST)
|
||||
|
||||
Sphinx liest über die Extension **MyST-Parser** `.rst`- und `.md`-Dateien gleichwertig ein. Beide Dateiformate können projektweit gemischt bzw. gleichwertig verwendet werden – z. B. `beschreibung.de.rst` in einem Modul und `wartung.de.md` in einem anderen, oder auch innerhalb desselben Moduls. Toctree-Einbindung, Sphinx-Direktiven (in MyST via ```` ```{direktive} ```` -Syntax) und die Sprachsuffix-Konvention `{name}.{lang}.{rst|md}` funktionieren für beide Formate identisch. Voraussetzung ist `myst-parser` als Sphinx-Extension in `conf_base.py`. Empfehlung: pro Modul/Kapitel ein einheitliches Format wählen, um die Lesbarkeit im Repo zu erhalten – eine Mischung ist aber technisch unproblematisch und erzwingt keine Migration bestehender rST-Bausteine.
|
||||
|
||||
## Bildverwaltung
|
||||
|
||||
| Kategorie | Pfad | Beispiele |
|
||||
|
||||
Reference in New Issue
Block a user