Grundlagen der Gestaltung Framework

Universität Ulm

Institut für Medienforschung und -entwicklung


Autor: Tobias Lahmann

Datum: Februar 2019


Inhalt


Allgemeines

Alle Dateien können mit beliebigen Textbearbeitungsprogrammen geöffnet und manipuliert werden. Oft nutzen Entwickler Texteditoren die Syntax highlighting anbieten. Für Microsoft Windows nutze ich meistens den Notepad++ Texteditor oder SublimeText. Unter Apple OSX ist der TextMate zu empfehlen. Und unter Unix bietet VIM bzw. GVIM viele hilfreiche Funktionen.

Links zum Download sind weiter unten eingetragen. Auch wenn dort immer die Entwicklerseite angegeben ist, besteht jedoch keine Garantie über die Sicherheit dieser Downloads.

Anleitung

HTML - hypertext markup language

Datei: doku.html

Nachdem die Reinzeichnung der ersten Werke erstellt wurden, können diese direkt in die Doku eingefügt werden. Die Datei “doku.html” im Hauptverzeichnis des Frameworks kann mit jedem beliebigen Texteditor geöffnet werden.

Innerhalb der Datei befindet sich ab Zeile 130 (Stand Mai 2016) der Abschnitt:

< xml id=“data” name=“Maximilian Mustermann” style=“display:none;” >[…]

Es handelt sich hierbei um den Abschnitt der Daten, auf welche das Framework zugreift. Es ist daher wichtig, dass id=“data” und style=“display:none;” nicht verändert werden. Der Name unter name=“Maximilian Mustermann” muss allerdings eurem eigenen Namen entsprechen.

Die Struktur der Dokumentation im Abschnitt data:

<doku>
          <abschnitt titel="text">
            <inhalt titel="text" quelle="pfad"  typ="bild" rahmen="aus">
              <details>text</details>
              ...
            </inhalt>
            ...
          </abschnitt>
          ...
        </doku>
        

Es können beliebig viele Bereiche ‘abschnitt’ in der Dokumentation vorkommen. In jedem ‘abschnitt’ können beliebig viele ‘inhalt’ Bereiche zusammengefasst werden. Und in jedem dieser Bereiche können beliebig viele ‘details’ Bereiche eingeschlossen sein. Es bietet sich an hier etwas herumzuspielen und zu beobachten, welche Änderungen in der Doku eintreten.

Eine alternative Darstellung mittels Dokumenttypdefinition

<!ELEMENT doku (abschnitt)+>
        <!ELEMENT abschnitt (inhalt)+>
        <!ATTLIST abschnitt
          titel    CDATA   #REQUIRED
        >
        <!ELEMENT inhalt (details)+>
        <!ATTLIST inhalt
          titel    CDATA   #REQUIRED
          quelle   CDATA   #REQUIRED
          typ      CDATA   #REQUIRED
          rahmen   CDATA   #REQUIRED
        >
        <!ELEMENT details (#PCDATA)>
        

Die Struktur des Ordners ‘inhalte’ kann beliebig gewählt werden. Wichtig für die Anzeige der Inhalte ist die Verlinkung im quelle Attribut des inhalte Tags. Ein Link muss relativ sein. Beispiele für die korrekte Verlinkung können dem Framework entnommen werden.

Der Typ des Inhalts muss im typ Attribut angegeben werden. Wenn dies nicht, oder falsch geschehen ist, werden die Inhalte vom Framework falsch behandelt und werden nicht angezeigt.

Bildformate sind nicht auf PNGs beschränkt. Es können beliebige Formate gewählt und vom Framework angezeigt werden. Für Reinzeichnungen empfohlen ist .png. Für Fotos ist dies .jpg.

Typische Fehler

JavaScript

Datei: asset/lib/animation.js

Die Datei “animation.js” im Unterverzeichnis asset -> lib des Frameworks kann mit jedem beliebigen Texteditor geöffnet werden.

Innerhalb der Datei befindet sich ab Zeile 60 (Stand Mai 2016) der Abschnitt:

// Permutationen
        var permutationen =
        [[
            [8, 7, 6, 5, 4, 3, 2, 1],
            [7, 8, 7, 6, 5, 4, 3, 2],
            [6, 7, 8, 7, 6, 5, 4, 3],
            [5, 6, 7, 8, 7, 6, 5, 4],
            [4, 5, 6, 7, 8, 7, 6, 5],
            [3, 4, 5, 6, 7, 8, 7, 6],
            [2, 3, 4, 5, 6, 7, 8, 7],
            [1, 2, 3, 4, 5, 6, 7, 8]
        ], [
            [5, 1],
            [1, 5]
        ], 
        ...
        

Die Permutationen können beliebig groß oder klein sein. Sie werden vom Framework auf die weiter unten angegebene Größe erweitert. Hierbei kopiert das Framework die Zeilen und oder Spalten nach Bedarf, um eine quadratische Matrix zu erhalten. Sollte die eingegebene Permutation also nur jeweils 2 Zeilen und Spalten umfassen, aber eine benötigte Größe von 7x7 benötigt sein, werden die Zeilen und Spalten rotationsmäßig erweitert.
Aus dem zweiten Beispiel oben

... [
            [5, 1],
            [1, 5]
        ], 
        ...
        

wird dementsprechend intern die folgende Matrix abgeleitet:

... [
            [5, 1, 5, 1, 5, 1, 5],
            [1, 5, 1, 5, 1, 5, 1],
            [5, 1, 5, 1, 5, 1, 5],
            [1, 5, 1, 5, 1, 5, 1],
            [5, 1, 5, 1, 5, 1, 5],
            [1, 5, 1, 5, 1, 5, 1]
        ], 
        ...
        

Demnach sollten Permutationen mindestens 7-8 Zeilen und/oder Spalten beinhalten, da ansonsten die Darstellung darunter leiden kann. Es kann zu unschönen Sprüngen in der Anzeige kommen, da das Verfahren keine ästhetischen Gesichtspunkte berücksichtigt.

Die Angabe der Objekte, welche angezeigt werden sollen, erfolgt ebenfalls in der Datei “animation.js”. Es handelt sich hier um eine verschachtelte JSON.

JSON Schema

{
            "numberOfObjects": "n",
            "elements": "folder1"
        }, 
        ...
        

Unter numberOfObjects wird angegeben, wie viele Objekte aus einem Ordner gelesen werden.

Unter elements wird der Ordner der Permutationsreihen angegeben.

Ab Zeile 112 folgt:

var objekte =
        [{
            "numberOfObjects": "7",
            "elements": "group1"
        },
        {
            "numberOfObjects": "6",
            "elements": "group2"
        }];
        ...
        

Hier sehen wir ein Beispiel für Permutationsreihen.

Die erste Permutationsreihe besitzt eine Version (angegeben in elements) mit dem Namen “group1”. Diese Reihe ist 7 Elemente groß. Also befinden sich 7 Bilder (1.png, 2.png, …, 7.png) im Ordner ./inhalte/animation/group1 .

Die zweite Permutationsreihe besitzt die Version “group2” (angegeben in elements). Diese Reihe ist 6 Elemente groß. Es befinden sich demnach 6 Bilder (1.png, …, 6.png) im Ordner ./inhalte/animation/group2.

Motivation

Die Angabe der Elemente in numberOfObjects ist notwendig, da im Kontext von Webseiten nicht auf ein Dateisystem zugegriffen werden kann. Das Skript hat also keine Möglichkeit zu erfahren wie viele Bilder in dem angegebenen Ordner sind. Die Behelfslösung ist hier mittels JavaScript Image-Objekte zu erstellen, welche einen Link zum Bild darstellen. Um zu erfahren wie viele Bilder das Skript erstellen soll geben wir diese Info an.

Typische Fehler

CSS - cascading style sheet

Datei: asset/css/animation.css

Die Datei “animation.css” im Unterverzeichnis asset -> css des Frameworks kann mit jedem beliebigen Texteditor geöffnet werden.

CSS Regeln werden von einem Webbrowser gelesen und dazu verwendet die zugehörigen Elemente in ihrem Aussehen zu verändern. In css wird zwischen Klassen und IDs unterschieden. Hierbei steht in der css-Datei die Raute (#) für eine ID und der Punkt (.) für eine Klasse. IDs sind in einem html-Dokument eindeutige Bezeichner für ein Element und können nur ein Mal vergeben werden. Klassen sind Gruppierungen von verschiedenen Elementen, welche alle dieselbe Form haben sollen.

In dieser Dokumentation ist es wichtig, dass jeder Button eine eigene Position erhält. Aus diesem Grund werden die Buttons mit eigenen IDs belegt und jede dieser IDs muss in der css-Datei definiert werden.

Innerhalb der Datei befindet sich ab Zeile 40 (Stand Mai 2016) der Abschnitt:

#button1 {
          background-image: url("../../inhalte/buttons/play_1.png");
          width: 75px;
          height: 30px;
          left: 50px;
          top: 50px;
        }
        #button1:hover {
          /* Das Bild ändert sich, wenn die Maus über dem Button 'schwebt' */
          background-image: url("../../inhalte/buttons/play_2.png");
        }
        #button1:active {
          /* Das Bild ändert sich, solange der Button gedrückt (und gehalten) wird */
          background-image: url("../../inhalte/buttons/play_3.png");
        }
        

Es werden eigene Abschnitte für jeden Button definiert. Im Beispiel oben sehen wir die zum Ersten gehörende Definition. Dieser ist 75px breit und 30 px hoch. Er befindet sich 50px von der linken Kante des Animationsbereichs und 50px von der oberen Kante entfernt.

Css-Regeln können gruppiert auf mehrere IDs oder Klassen gleichzeitig angewendet werden, wie es beispielsweise einige Zeilen darüber geschehen ist. Zeile 15-18 gruppiert mehrere Buttons und wendet die darunter befindlichen Regeln auf alle an. Die IDs sind mit Komma getrennt.

In css werden die verfügbaren Regeln von oben nach unten gelesen und eventuell später im Dokument vorkommende Regeln überschreiben weiter oben befindliche.

Typische Fehler

Beispiele

Beispiel 1

Animation: Button löschen

  1. (HTML) Lösche das Element < imput id="… aus der Datei doku.html
  2. (CSS) Darstellung anpassen

Beispiel 2

Animation: Button hinzufügen

  1. (HTML) Kopiere ein Button-Element < imput id="… in der Datei doku.html und vergebe eine neue, eindeutige ID.
  2. (CSS) Darstellung anpassen

Beispiel 3

Doku: Eine zweite Animations “Folie” wird benötigt

  1. Leider gibt es hierfür keine direkte Lösung. Wer sich damit auskennt kann gerne die Aufgabe in Angriff nehmen. Wer sich nicht so gut damit auskennt kann gerne eine E-Mail schreiben.

Fragen und Antworten

F: Darf ich die Farbe des Frameworks in der css verändern?

A: Nein. Das Framework darf nicht verändert werden, nur die Inhalte.

F: Darf ich Musik in meinem Framework verwenden?

A: Nein. Es geht hier um visuelle Effekte und nicht um Musik. Mach dafür einfach GdG II mit.

Hilfreiche Links

Tutorials


Downloads

Zusätzliche Information

Test:

Framework wurde in folgenden Browsern getestet und die Funktionsweise bestätigt:


Lizenz

Grundlagen der Gestaltung 1 Framework © by Institut für Medienforschung und Medienentwicklung, Ulm

Grundlagen der Gestaltung 1 Framework is licensed under a
Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License.

You should have received a copy of the license along with this
work. If not, see http://creativecommons.org/licenses/by-nc-nd/3.0/.