Was können wir verbessern?

Dokumentation

Struktur

Beschreibung

Die vorrausgesetzte Struktur ist für eine richtige Funktionsweise innerhalb von IP-Symcon nötig. Nur wenn die Struktur eingehalten wird, funktioniert das Einbinden über Module Control.

  • Die "library.json" ist das Kernstück einer jeden Modulentwicklung.
  • Die "module.php" und "module.json" bilden zusammen das eigentliche Modul.
  • Für die Einrichtung der Konfigurationsseite kann die form.json genutzt werden.
  • Für mögliche Übersetzungen dient die locale.json.
  • Der Modulordnername (hier: Modul1, Modul2) sollte den gleichen Namen haben, wie der Klassenname in der module.php.

Ordner, welche keine module.json beinhalten, werden als fehlerhaft markiert. Ausnahme bilden die Ordner:

  • libs/ (ab Version 4.2)
  • docs/ (ab Version 4.2)
  • imgs/ (ab Version 4.2)
  • tests/ (ab Version 4.4)

Diese Ordner werden nicht als Modul eingebunden und bieten die Möglichkeit externe Libraries, Dokumente, Bilder und Tests zur Verfügung zu stellen.

Verzeichnisstruktur

Bibliothek
|
- Modul1
|    |
|    - module.php
|    |
|    - module.json
|    |
|    - form.json (optional)
|    |
|    - locale.json (optional)
|
- Modul2
|    |
|    - module.php
|    |
|    - module.json
|    |
|    - form.json (optional)
|    |
|    - locale.json (optional)
|
- libs (optional)
|    |
|    - beliebige Libraries
|
- docs (optional)
|    |
|    - beliebige Dokumente
|
- imgs (optional)
|    |
|    - beliebgie Mediendateien
|
- tests (optional)
|    |
|    - beliebige Testdateien
|
- library.json
|
- README.txt (optional)
Haben Sie noch Fragen?