Doku ergaenzt

ulrich

2017-12-30 c08a3b2b86237a8ea07b8fe590446cef39a784b5

Doku ergaenzt

 README.md

@@ -1,16 +1,14 @@
# app-menu

Ein universelles Menü für Webanwendungen.
Ein Menü für Webanwendungen.

## Beschreibung

Das app-menu ist eine Liste von Auswahlpunkten für eine Webanwendung. Der Benutzer kann aus ihnen wählen um Funktionen auszuführen oder ein weiteres Menü aufzurufen. Eine große Anzahl von Funktionsaufrufen kann auf hierarchisch verschachtelte Menüs verteilt werden, deren Beschreibungen vom app-menu dynamisch geladen werden.

Menüinhalte werden während der Ausführung der Webanwendung aus Beschreibungen geformt, die in der JavaScript Object Notation (JSON) hinterlegt sind.
Menüinhalte werden während der Ausführung der Webanwendung aus Beschreibungen geformt, die in der JavaScript Object Notation (JSON) hinterlegt sind. Die Gestaltung des Menüs wird über ein Cascading Stylesheet (CSS) bestimmt.

Die Gestaltung des Menüs wird über ein Cascading Stylesheet (CSS) bestimmt.

Mit der [Demo-Anwendung](/data/ulrich/demo/app-vorlage/) kann das app-menu direkt im Browser ausprobiert werden. 
Mit der [Demo-Anwendung](/data/ulrich/demo/app-vorlage/) kann das app-menu direkt im Browser ausprobiert werden.

## Einbau des app-menu in eine Webanwendung

@@ -25,9 +23,9 @@

Die obigen Schritte sind nachfolgend im Detail beschrieben.

### Hinzufügen des Ordners `app-menu`
### <a name="add-folder"></a>Hinzufügen des Ordners `app-menu`

Damit eine Webanwendung das app-menu verwenden kann, muss der gesamte Ordner `app-menu` der Webanwendung mitgegeben werden. Für die weitere Beschreibung wird angenommen, dass der Ordner `app-menu` in einem Ordner `jslib` abgelegt wurde und dass eine Datei `index.html` den Einstiegspunkt in die Webanwendung bildet.
Damit eine Webanwendung das app-menu verwenden kann, wird der Inhalt des Ordners `app-menu` der Webanwendung zugänglich gemacht. Für die weitere Beschreibung wird angenommen, dass der Ordner `app-menu` in einem Ordner `jslib` abgelegt wurde und dass eine Datei `index.html` den Einstiegspunkt in die Webanwendung bildet.

```
/webanwendung
@@ -52,7 +50,7 @@

### Einbinden der Stylesheets

Zur Regelung des Erscheinungsbildes von Menüs sowie der Schaltfläche zum ein- und ausblenden des Menüs werden zwei Stylesheets eingebunden.
Zur Regelung des Erscheinungsbildes von Menüs sowie der Schaltfläche zum Ein- und Ausblenden des Menüs werden zwei Stylesheets eingebunden.

```
<link rel="stylesheet" type="text/css" href="jslib/app-menu/nav-toggle.css">
@@ -61,13 +59,13 @@

### Hinzufügen einer Menüschaltfläche

Das app-menu wird über eine Schaltfläche ein- und ausgeblendet, die vom app-menu selbst gesteuert wird. Sie wird in eine Webseite eingebaut, indem ein Element mit der id `nav-toggle` hinzugefügt wird wie z.B. mit
Das app-menu wird über eine Schaltfläche Ein- und ausgeblendet, die vom app-menu selbst gesteuert wird. Sie wird in eine Webseite eingebaut, indem ein Element mit der ID `nav-toggle` hinzugefügt wird wie z.B. mit

```
<a id="nav-toggle" href="#"></a>
```

Das app-menu zeigt dann an dieser Stelle die Schaltfläche zum ein- und ausblenden des Menüs an.
Das app-menu zeigt dann an dieser Stelle die Schaltfläche zum Ein- und Ausblenden des Menüs an.

### Einbinden des Skripts

@@ -117,7 +115,9 @@

Im Element `funktion` eines Menüeintrages wird ein Funktionsname notiert. Die so benannte Funktion wird aufgerufen, wenn das Menü gewählt wird. Eine solche Funktion darf keine Parameter erwarten.

Für jedes Menü, das in der Webanwendung gezeigt werden soll, muss eine Beschreibung im oben angegebenen Format existieren. Menübeschreibungen können beispielsweise in einem Unterordner `menu` abgelegt und der Webanwendung beigegeben werden, wie es im Abschnitt Hinzufügen des Ordners app-menu weiter oben geschildert ist.
Für jedes Menü, das in der Webanwendung gezeigt werden soll, muss eine Beschreibung im oben angegebenen Format existieren. Menübeschreibungen können beispielsweise in einem Unterordner `menu` abgelegt und der Webanwendung beigegeben werden, wie es [weiter oben](#add-folder) geschildert ist.

Beispiele für Menübeschreibungen enthält auch die [Demo-Anwendung](/data/ulrich/demo/app-vorlage/).

## Aufruf des Menüs

@@ -127,7 +127,7 @@
app_menu_init("menu/", "hauptmenue.json", "jslib/app-menu/app-menu.tpl", ".west");
```

Die Funktion zur Initialisierung bewirkt, dass eine Menüschaltfläche zum Ein- und Ausblenden von Menüs an der Stelle des Elements `nav-toggle` erscheint. Beim Betätigen der Schaltfläche wird das Menü eingeblendet, das in der Beschreibung `hauptmenue.json` im Ordner `menu` beschrieben ist. Das Menü wird an der Stelle des Elements mit dem Klassennamen `west` dargestellt. NAchfolgend die Parameter der Funktion `app_menu_init` in der Übersicht.
Die Funktion zur Initialisierung bewirkt, dass eine Menüschaltfläche zum Ein- und Ausblenden von Menüs an der Stelle des Elements mit der ID `nav-toggle` erscheint. Beim Betätigen der Schaltfläche wird das Menü eingeblendet, das in der Beschreibung `hauptmenue.json` im Ordner `menu` beschrieben ist. Das Menü wird an der Stelle des Elements mit dem Klassennamen `west` dargestellt. NAchfolgend die Parameter der Funktion `app_menu_init` in der Übersicht.

1. Name des Unterverzeichnisses mit Menübeschreibungen
1. Name der Menübeschreibung, die zuerst angezeigt werden soll