Andere Kapitelstruktur aufgesetzt, Bsp. Fortna
This commit is contained in:
@@ -28,7 +28,7 @@ Python-Code kommt nach `lib/`, Konfiguration nach `cfg/`. Die `bin/`-Skripte set
|
||||
|
||||
Dieses Repo (`docu_build`) dient als Entwicklungs- und Planungsumgebung. Das Zielsystem besteht aus zwei getrennten Repos:
|
||||
|
||||
- **transport-docs-base** (Gitea): Wiederverwendbare Inhalte – Sphinx-Extensions (`_ext/`), Module (`modules/`), Kapitelgerüste (`chapters/`), Assets, Glossar, LaTeX-Templates. Semver-versioniert via `VERSION`-Datei.
|
||||
- **transport-docs-base** (Gitea, = dieses Repo): Wiederverwendbare Inhalte – Sphinx-Extensions (`_ext/`), Module (`modules/`), Kapitelgerüste (`chapters/`), Assets, Glossar, LaTeX-Templates. Semver-versioniert via `VERSION`-Datei.
|
||||
- **projekt-kunde-xyz** (pro Anlage): `anlage.json` (ERP-Export), projektspezifische Bilder, Overrides, `conf.py`, `build.py`. Bindet Base-Repo als `transport-docs-base/` ein (Symlink/Mount).
|
||||
|
||||
### Technologie-Stack
|
||||
@@ -49,6 +49,24 @@ Sphinx + reStructuredText + Jinja2-Templating → LaTeX → PDF. Konfiguration v
|
||||
|
||||
**meta.yaml** (pro Modul): Definiert `display_name` (mehrsprachig), `chapters` (Kapitelzuordnung mit Sections), `images` (shared/localized/module_local), `requires` (Abhängigkeiten).
|
||||
|
||||
### Kapitelstruktur (`chapters/`)
|
||||
|
||||
```text
|
||||
00_inhaltsverzeichnis – Inhaltsverzeichnis (wird generiert)
|
||||
01_zertifikate – CE/UKCA-Konformität, Konfigurationsbeschreibung
|
||||
02_sicherheit – Allgemein, Normen, Risikobewertung
|
||||
03_anlagenbeschreibung – Module werden hier via meta.yaml eingefügt
|
||||
04_betrieb – Betriebsanleitung
|
||||
05_wartung – Wartungsanleitung, Schmierplan
|
||||
06_steuerung – Funktionsbeschreibungen pro Steuerungssystem
|
||||
07_ersatzteile – Ersatzteillisten
|
||||
08_lieferantendoku – Antriebe, Elektrik, Pneumatik, Stahlbau, Sicherheitseinr.
|
||||
09_technische_unterlagen – Layouts, Schaltpläne, Notstopp, Bereichsstopp
|
||||
10_anhang – Prüfberichte, Abnahmeprotokolle
|
||||
```
|
||||
|
||||
Details siehe `doc/kapitelstruktur.md`.
|
||||
|
||||
### Sphinx-Extensions (zu implementieren in `_ext/`)
|
||||
|
||||
- **anlagen_builder.py**: JSON + meta.yaml → toctree-Einträge, Abhängigkeitsauflösung (topologisch), Override-Logik
|
||||
|
||||
@@ -496,9 +496,6 @@
|
||||
│ │ └── 04_IU-Distrib_Rozdělovač_CZ.pdf
|
||||
│ └── 02_ITS
|
||||
│ └── KC-0167-00-01-4 Air distributor.pdf
|
||||
├── FUNKTION_CONTROL_LoadingLoop_500592_V2.2_EN.docx
|
||||
├── FUNKTION_STEUERUNG_LoadingLoop_500592_V2.2.docx
|
||||
├── RB_Fortna_H+M_500592_EV12_20260311.docx
|
||||
└── RB_Fortna_H+M_500592_V12_20260311.docx
|
||||
|
||||
123 directories, 378 files
|
||||
|
||||
123 directories, 374 files
|
||||
@@ -0,0 +1,150 @@
|
||||
# Kapitelstruktur - Mapping Fortna-Referenz
|
||||
|
||||
Abgeleitet aus dem realen Projekt Fortna (doc/Fortna.txt, 374 Dateien, 123 Ordner).
|
||||
Angepasst auf deutsche Ordnernamen, Sprachtrennung auf Top-Level.
|
||||
|
||||
## Kapitel-Uebersicht
|
||||
|
||||
| Nr | Ordner | Inhalt | Fortna-Quelle |
|
||||
|----|--------|--------|---------------|
|
||||
| 00 | `00_inhaltsverzeichnis` | Inhaltsverzeichnis, Dokumentennotizen | 00_CONTENTS_NOTES |
|
||||
| 01 | `01_zertifikate` | CE/UKCA-Konformitaetserklaerungen, Konfigurationsbeschreibung | 01_CERTIFICATES |
|
||||
| 02 | `02_sicherheit` | Allgemeine Sicherheit, Normen, Risikobewertung | (neu, teilweise 04_TECHNICAL_DOC) |
|
||||
| 03 | `03_anlagenbeschreibung` | Maschinenmodule (via meta.yaml eingefuegt) | (neu) |
|
||||
| 04 | `04_betrieb` | Betriebsanleitung | 02_INSTRUCTIONS (Betriebsanleitung) |
|
||||
| 05 | `05_wartung` | Wartungsanleitung, Schmierplan | 02_INSTRUCTIONS (Wartungsanleitung) |
|
||||
| 06 | `06_steuerung` | Funktionsbeschreibungen Steuerung | 02_INSTRUCTIONS (Funktion_Steuerung_*) |
|
||||
| 07 | `07_ersatzteile` | Ersatzteillisten | 03_SPARE_PARTS |
|
||||
| 08 | `08_lieferantendoku` | Lieferantendokumentation | 05_SUPPLIER_DOC |
|
||||
| 09 | `09_technische_unterlagen` | Layouts, Schaltplaene, Not-/Bereichsstopp | 04_TECHNICAL_DOC |
|
||||
| 10 | `10_anhang` | Pruefberichte, Abnahmeprotokolle | 04_TECHNICAL_DOC/REPORTS |
|
||||
|
||||
## Detailstruktur
|
||||
|
||||
### 00_inhaltsverzeichnis
|
||||
|
||||
Wird vom Build-Prozess generiert. Enthaelt Gesamtinhaltsverzeichnis und ggf. Dokumentennotizen/Revisionshistorie.
|
||||
|
||||
### 01_zertifikate
|
||||
|
||||
```text
|
||||
01_zertifikate/
|
||||
konformitaetserklaerung/ # CE-/UKCA-Erklaerungen (Fortna: 01_SCHOENENBERGER)
|
||||
konfigurationsbeschreibung/ # Konfigurationsbeschreibung fuer CE (Fortna: 02_KONFIGURATIONSBESCHREIBUNG)
|
||||
```
|
||||
|
||||
Fortna-Beispieldokumente:
|
||||
- EC Declaration of Conformity_V2_EN.pdf
|
||||
- Konfigurationsbeschreibung_fuer_CE_V2.pdf
|
||||
|
||||
### 02_sicherheit
|
||||
|
||||
```text
|
||||
02_sicherheit/
|
||||
allgemein/ # Allgemeine Sicherheitshinweise
|
||||
normen/ # CE (EU), UKCA (UK) - je nach normen_region in anlage.json
|
||||
risikobewertung/ # Risikomatrizen, Gefahrenanalysen
|
||||
```
|
||||
|
||||
### 03_anlagenbeschreibung
|
||||
|
||||
Keine feste Unterstruktur - Module werden hier durch den Build-Prozess via meta.yaml eingefuegt. Jedes Modul liefert seine Beschreibung, technische Daten etc.
|
||||
|
||||
### 04_betrieb
|
||||
|
||||
```text
|
||||
04_betrieb/
|
||||
betriebsanleitung/ # Fortna: 01_BETRIEBSANLEITUNG_500592_V2.3.pdf
|
||||
```
|
||||
|
||||
Fortna-Beispieldokumente:
|
||||
- BETRIEBSANLEITUNG_500592_V2.3.pdf
|
||||
|
||||
### 05_wartung
|
||||
|
||||
```text
|
||||
05_wartung/
|
||||
wartungsanleitung/ # Fortna: 02_WARTUNGSANLEITUNG_500592_V2.2.pdf
|
||||
schmierplan/ # Schmierstellen, Intervalle, Schmiermittel
|
||||
```
|
||||
|
||||
### 06_steuerung
|
||||
|
||||
```text
|
||||
06_steuerung/
|
||||
(pro Steuerungssystem ein Unterordner)
|
||||
ils/ # Fortna: 03_FUNKTION_STEUERUNG_ILS_500592_V2.1.pdf
|
||||
omniflo/ # Fortna: 04_FUNKTION_STEUERUNG_OMNIFLO_500592_V1.0.pdf
|
||||
loading_loop/ # Fortna: 05_FUNKTION_STEUERUNG_LoadingLoop_500592_V2.2.pdf
|
||||
```
|
||||
|
||||
Unterordner werden projektspezifisch angelegt je nach verbauten Steuerungssystemen.
|
||||
|
||||
### 07_ersatzteile
|
||||
|
||||
Ersatzteillisten, ggf. mit Explosionszeichnungen.
|
||||
|
||||
Fortna-Beispiel: SPARE_PARTS_500592_EN_V2.1.pdf
|
||||
|
||||
### 08_lieferantendoku
|
||||
|
||||
```text
|
||||
08_lieferantendoku/
|
||||
antriebe/ # SEW, NORD, Leantechnik (Anleitungen + Datenblaetter)
|
||||
elektrik/ # Siemens, Leuze, Cognex, Werma, Phoenix, Murrelektronik, etc.
|
||||
pneumatik/ # Aventics, ITS
|
||||
stahlbau/ # MiTek (As-Built, Statik, Zertifikate, Handover)
|
||||
sicherheitseinrichtungen/ # ABS Sicherheitslinie, Schmersal etc.
|
||||
```
|
||||
|
||||
Fortna-Lieferanten (Beispiele):
|
||||
- SEW: Motor/Getriebe-Anleitungen, Movimot-DBC
|
||||
- NORD: Getriebe/Motor LoadingLoop
|
||||
- Siemens: 60+ Datenblaetter (SPS, HMI, Schuetze, Sicherungen)
|
||||
- Leuze: Sensoren (Datenblaetter + CE-Zertifikate)
|
||||
- Cognex: Scanner (DM280, DM370 Referenzhandbuecher)
|
||||
- MiTek: Stahlbau (As-Built, Structural Calcs, Steel/Bolt/Paint Certs, RAMS, Handover)
|
||||
- ABS: Sicherheitslinie (Anleitungen, Montage, Pruefbuch, Zeichnungen, Zertifikate)
|
||||
- Aventics: Pneumatik (Filter, Druckregler, Absperrventil, Verteiler)
|
||||
|
||||
### 09_technische_unterlagen
|
||||
|
||||
```text
|
||||
09_technische_unterlagen/
|
||||
layouts/
|
||||
mechanisch/ # Fortna: 04_TECHNICAL_DOC/01_LAYOUT/01_MECHANICAL
|
||||
elektrisch/ # Fortna: 04_TECHNICAL_DOC/01_LAYOUT/02_ELECTRICAL
|
||||
schaltplaene/ # Fortna: 04_DIAGRAMS (pro Steuerungsbereich/Controlarea)
|
||||
notstopp/ # Fortna: 03_EMERGENCY_STOP (Plaene + E-Stop-Matrix)
|
||||
bereichsstopp/ # Fortna: 02_AREA_STOP
|
||||
```
|
||||
|
||||
Fortna-Beispieldokumente:
|
||||
- Layout: 500592_10_5.14_Layout_V2.1_EN.pdf, Bereiche_V2.1_EN.pdf
|
||||
- Schaltplaene: Circuit diagrams_Controlarea 1-7_EN.pdf (je Steuerungsbereich)
|
||||
- Notstopp: ES500592_10_5-14_ILS-OF_cpl.-E-Stop-[EN].pdf + Emergency_Stop_Matrix_V1.5.pdf
|
||||
- Bereichsstopp: ES500592_10_5-14_ILS-OF-Area-Stop-cpl.-[EN].pdf
|
||||
|
||||
### 10_anhang
|
||||
|
||||
```text
|
||||
10_anhang/
|
||||
pruefberichte/ # Fortna: 04_TECHNICAL_DOC/05_REPORTS
|
||||
abnahmeprotokolle/ # Abnahmedokumentation
|
||||
```
|
||||
|
||||
Fortna-Beispieldokumente:
|
||||
- Schutz_gegen_automatischen_Wiederanlauf_V1.1.pdf
|
||||
- Drehrichtung_Asynchronmotoren.pdf
|
||||
- Erprobung_Anzeige_Bediengeraete.pdf
|
||||
|
||||
## Sprachtrennung
|
||||
|
||||
Fortna verwendet Unterordner pro Sprache innerhalb jedes Kapitels:
|
||||
`01_DE_original/`, `02_EN/`, `03_CZ/`
|
||||
|
||||
Neues Konzept: Pro Sprache ein kompletter Dokumentenbaum auf Top-Level:
|
||||
- `chapters/` = Deutsche Dokumentation (Standard/Master)
|
||||
- Zukuenftig: `chapters_en/`, `chapters_cz/` etc. als eigenstaendige Kopien
|
||||
|
||||
Fallback-Mechanismus: Fehlt ein Dokument in einer Fremdsprache, wird die deutsche Version verwendet.
|
||||
Reference in New Issue
Block a user