... | ... | @@ -9,15 +9,25 @@ Sollten viele Änderungen am Quellcode vorgenommen werden, bietet es sich eventu |
|
|
Zur weiteren Anpassung des Systems sollten die Dokumentationen der JS- und PHP-Skripte eingesehen werden.
|
|
|
Die Dokumentation des JS-Codes ist zu finden in [JSDoc](/docs/JSDoc) und die des PHP-Backends in [phpDoc](/docs/phpDoc).
|
|
|
|
|
|
## Links, Logos und Texte
|
|
|
## Logos
|
|
|
|
|
|
Hierbei können die HTML-Dateien bearbeitet werden. Der Grundaufbau ist in der [index.html](https://zivgitlab.uni-muenster.de/secdoc/secdoc/-/blob/master/index.html) Datei zu finden. Die verschiedenen Unterseiten, die je nach Modus geladen werden, und die Titelseite für die PDF-Generierung können im Ordner [/assets/html/](https://zivgitlab.uni-muenster.de/secdoc/secdoc/-/blob/master/assets/html/) gefunden und angepasst werden.
|
|
|
Die beiden Logos oben in den Ecken sowie das Favicon können einfach durch Austausch der Dateien unter [/assets/img/](https://zivgitlab.uni-muenster.de/secdoc/secdoc/-/blob/master/assets/img/) geändert werden.
|
|
|
|
|
|
## Links und Texte
|
|
|
|
|
|
Hierfür können die HTML-Dateien bearbeitet werden. Der Grundaufbau ist in der [index.html](https://zivgitlab.uni-muenster.de/secdoc/secdoc/-/blob/master/index.html) Datei zu finden. Die verschiedenen Unterseiten, die je nach Modus geladen werden, und die Templates für die Datenschutzerklärung bzw. die Titelseite des VVTs können im Ordner [/assets/html/](https://zivgitlab.uni-muenster.de/secdoc/secdoc/-/blob/master/assets/html/) gefunden und angepasst werden.
|
|
|
|
|
|
Zukünftig sollen einige Texte und Verlinkungen über den Installationswizard angepasst werden können.
|
|
|
|
|
|
## Textvorschläge
|
|
|
|
|
|
Für einige Eingabefelder stellt das Tool Vorschläge für den Nutzer zur Verfügung. Diese werden, bis auf die aktuellen Nutzergruppen und Systeme, alle aus der SQLite Datenbank ausgelesen. Zu diesen Daten zählen Personen, Organisationseinheiten, IVVen und CPE-Einträge. Die benötigten Tabellen werden beim ersten Start der Anwendung angelegt und müssen nur befüllt werden. Die Tabellendefinitionen können in [DBCon.class.php](/assets/ajax/DBCon.class.php) gefunden werden. Diese können dafür genutzt werden, um die Tabelle z.B. mittels einer SQL-Importdatei über das CLI von SQLite zu befüllen und regelmäßig aktuell zu halten.
|
|
|
Für einige Eingabefelder stellt das Tool Vorschläge für den Nutzer zur Verfügung.
|
|
|
|
|
|
Für generelle Felder der Dokumentation werden standardmäßige Vorschläge mitgeliefert, um dem Nutzer das Ausfüllen zu vereinfachen. Diese Vorschläge sind in der Tabelle `suggestions` in der lokalen Datenbank gespeichert und können natürlich bei Bedarf ergänzt oder verändert werden. Die Standardvorschläge können in der Datei [/assets/php/Default_Suggestions.sql](https://zivgitlab.uni-muenster.de/secdoc/secdoc/-/blob/master/assets/php/Default_Suggestions.sql) gefunden werden. Dies kann auch als Ausgangspunkt für eine eigene Liste dienen. Vorschläge für neue Eingabehilfen nehmen wir auch gerne entgegen!
|
|
|
|
|
|
Eingabefelder, die die Auswhal von Gruppen oder Nutzern zulassen, zeigen Vorschläge aus dem AD/LDAP oder der lokalen Datenbank an. Dies kann in den Einstellungen zu "Datenquellen" verwaltet werden.
|
|
|
|
|
|
Eingabefelder für Organisationseinheiten, IVVen oder CPE-Einträge werden aktuell separat gehandhabt und müssen lokal angepasst werden. Dafür sind die Tabellen `organisationseinheiten`, `ivven` und `cpe` in der Datenbank vorhanden. Für CPE-Einträge existiert ein Update-Skript unter [/assets/php/cpe-update.php](https://zivgitlab.uni-muenster.de/secdoc/secdoc/-/blob/master/assets/php/cpe-update.php). Für eine vorgefüllte CPE-Tabelle kann die Demo-Datenbank verwendet werden.
|
|
|
|
|
|
## Backend
|
|
|
|
... | ... | @@ -25,4 +35,6 @@ Für Anpassungen im Backend, die über die möglichen Konfigurationen in der [se |
|
|
|
|
|
* [verwaltung.php](https://zivgitlab.uni-muenster.de/secdoc/secdoc/-/blob/master/assets/ajax/verwaltung.php) - Beantwortet alle API Aufrufe der SecDoc Oberfläche; zuständig für E-Mail Versand und PDF-Generierung
|
|
|
* [Utils.class.php](https://zivgitlab.uni-muenster.de/secdoc/secdoc/-/blob/master/assets/ajax/Utils.class.php) - Enthält diverse Funktionen für verschiedene Abfragen (z.B. AD/LDAP)
|
|
|
* [DBCon.class.php](https://zivgitlab.uni-muenster.de/secdoc/secdoc/-/blob/master/assets/ajax/DBCon.class.php) - Verwaltet die Datenbank-Aufrufe zur internen SQLite Datenbank |
|
|
\ No newline at end of file |
|
|
* [DBCon.class.php](https://zivgitlab.uni-muenster.de/secdoc/secdoc/-/blob/master/assets/ajax/DBCon.class.php) - Verwaltet die Datenbank-Aufrufe zur internen SQLite Datenbank
|
|
|
* Unter [/assets/ajax/auth/](https://zivgitlab.uni-muenster.de/secdoc/secdoc/-/blob/master/assets/ajax/auth) befinden sich die Implementierungen der Authentifzierungsmethoden
|
|
|
* Unter [/assets/ajax/docmgmt/](https://zivgitlab.uni-muenster.de/secdoc/secdoc/-/blob/master/assets/ajax/docmgmt) befinden sich die Implementierungen für die Dokumentenverwaltung |
|
|
\ No newline at end of file |