ILIAS-Scripts

In diesem Repository werden verschiedene bash-Skripte für die ILIAS-Entwicklung bereitgestellt.
Die Entwicklung erfolgt unter WSL 2 mit Ubuntu 24.04.1 LTS.

Alle Skripte sind in WSL für Ubuntu 24.04.1 LTS erstellt worden.
In der Regel können alle Skripte auch auf anderen Linux-Versionen ausgeführt werden.

ILIAS Delos-Skin Creation

Beschreibung

Eine ILIAS-Installation liefert automatisch alle Dateien für den Delos-Skin (ILIAS Standard-Skin) mit. Aus diesen Dateien wird der Delos-Skin als Basis für eigene Entwicklungen erstellt. Das Skript create-delos-skin.sh generiert dabei die Verzeichnisstruktur und kopiert alle benötigten Dateien in die entsprechende Struktur.
Die Struktur orientiert sich an der Struktur, welche von der HSU für Skins, Styles und Substyles verwendet wird. Das Skript passt dabei verschiedene Dateien so an, dass der Skin mit dem Delos-Style direkt verwednet werden kann.
Da es sich bei Delos um den Standard-Style handelt, wird dieser im Verzeichnis /delos/default mit der zentralen SASS-Datei delos.scss angelegt. Hier befinden sich auch alle weiteren SASS-Dateien für den Style in den jeweiligen Unterverzeichnissen. Weitere Substyles können dann in weiteren Verzeichnissen unter /delos angelegt werden.

Alle Template-Dateien werden in die Verzeichnisse /delos/UI, /delos/Modules oder /delos/Services kopiert.

Im Verzeichnis /delos/default/090-custom können eigene SASS-Dateien eingefügt werden, welche neue Features implementieren oder bestehenden SASS-Code überschreiben.

Verzeichnisstruktur

  
  {ILIAS-Version}  
  └─ delos  
     ├─ images  
     ├─ fonts  
     ├─ Modules  
     ├─ Services  
     ├─ UI  
     ├─ default  
     │  ├─ 010-settings  
     │  ├─ 020-dependancies  
     │  ├─ 030-tools  
     │  ├─ 040-normalize  
     │  ├─ 050-layout  
     │  ├─ 060-element  
     │  ├─ 070-components  
     │  ├─ 080-hacks  
     │  ├─ 090-custom  
     │  ├─ less  
     │  *  
     └─ template.xml  

Script

create-delos-skin.sh

Verwendung

1. Kopiere das Skript creeate-delos-skin.sh in ein lokales Verzeichnis

2. Mache das Skript ausführbar
   chmod +x create-delos-skin.sh

3. Führe das Skript aus
   bash create-delos-skin.sh {ILIAS-Branch-Version}

   {ILIAS-Branch-Version}
   9 = release_9
   10 = release_10

   Beispiel:
   Delos-Skin für die aktuelle ILIAS 9 - Version erstellen

   bash create-delos-skin.sh 9

Skin-Delivery

Um den Skin in ILIAS zu verwenden, muss das gesamte Verzeichnis /delos in das Verzeichnis /public/Customizing/skin kopiert werden.

Hinweis
Bis einschließlich der ILIAS-Version 9 muss der Skin in das Verzeichnis /Customizing/global/skin kopiert werden.

Multiple SASS-Compiler

Beschreibung

An der HSU / UniBw H haben wir uns entschieden, einen Skin mit mehreren Substyles zu für verschiedene Bereiche zu verwenden. Dabei bleibt der Basis-Style erhalten und einzelne Farben und Elemente (wie z.B. der Footer) werden in den Substyles angepasst.
Um im Rahmen der Entwicklung alle Substyles zu überwachen und bei Änderungen zu kompilieren, wird das Tool tmux verwendet.

Einrichtung von tmux

sudo apt install tmux

Verwendung des Skripts

1. Herunterladen des Skripts in ein lokales Verzeichnis

2. Modifizieren des Skripts
   Um das Skript verwenden zu können, muss dieses zunächst auf die einzelnen Substyles eingestellt werden.
   Dazu muss in der Section Pfade zu den Unterprojekten die einzelnen Pfade der Substyles eingefügt werden. Danach muss in der Section tmux-Session starten die einzelnen SASS-Dateien der zu kompilierenden Styles mit SASS {datei}.scss {datei}.css -w eingefügt werden.

3. Das Skript ausführbar machen

   chmod +x sass-compile.sh

4. Skript ausführen

   bash sass-compile.sh ./delos

Disclaimer

Die bereitgestellten Skripte, Dateien und Anleitungen in diesem Repository werden ohne jede Gewährleistung bereitgestellt. Die Nutzung erfolgt auf eigene Gefahr. Die Helmut-Schmidt-Univeristät / Universität der Bundeswehr Hamburg oder die Autorin übernehmen keine Haftung für direkte oder indirekte Schäden, Datenverluste oder sonstige Konsequenzen, die aus der Verwendung der hier veröffentlichten Inhalte entstehen könnten.

Durch die Nutzung der bereitgestellten Skripte erklärst du dich ausdrücklich damit einverstanden, dass keine Garantie auf Funktionalität, Sicherheit oder Eignung für einen bestimmten Zweck besteht, keinerlei Support- oder Wartungsverpflichtung besteht, und die Autorin nicht für eventuelle Schäden haftbar.gemacht werden kann.

Autorin

Bettina Solzbacher, M. Eng.
Technische Leitung der ILIAS-Supportteam
Koordinationsstelle E-Lernen

Versions-History

Version 1.0: Initiale Version