[DOC] Add Documentation

This commit is contained in:
Christian Seyfferth 2020-05-12 18:06:44 +02:00
parent d33450aa42
commit 08e83f0e91
2 changed files with 38 additions and 1 deletions

36
README.md Normal file
View File

@ -0,0 +1,36 @@
# Restaurant1894 Webseite
Webseitendaten für die Homepage des Theaterrestaurants 1894.
[Link zur Webseite](http://restaurant1894.de)
## Bilder in der Gallerie verwalten
In der Datei `js/chrosey.slideshow.js` werden die Bilder und deren Metadaten verwaltet.
im Bereich `// Anzuzeigende Bilder`
wird der Bildname aus dem Ordner `img/gallery/` entnommen (ohne `.jpg`). Folgende Struktur steht zur Verwaltung eines einzelnen Bildes zur Verfügung:
```js
{
path: "Restaurant14",
alt: "Eine dampfende Espressotasse mit Anrichtung",
title: "Wie wäre es mit einem Espresso?"
},
```
- `path` ist der Bildname:
die Datei muss im oben genannten Verzeichnis vorhanden sein (am besten auch in `img/gallery/thumbs/`)
- `alt` ist der Alternativtext (wird für Blinde vorgelesen):
er sollte immer eine Beschreibung des gezeigten enthalten (Barrierefreiheit)
- `title` erscheint unter dem Angezeigtem Bild als Text:
er kann Freitext enthalten (wenn nicht vorhanden wird stattdessen `alt` unter dem Bild angezeigt)
## Bilder für die Webseite skalieren
Ein neues Bild:
- Format `.jpg`
- Maximale Auflösung
- für Galleriebilder `1200px * 900px` und
- für deren Vorschaubilder `100px * 100px`
- für Hindergrundbilder `2400px * 1800px`
- progressiv sein, damit es für langsame Verbindungen besser dargestellt wird
- einen passenden Namen haben
- im entsprechenden Ordner abgelegt werden (`img/(gallery|backgrounds`))

View File

@ -23,7 +23,7 @@ $(function () {
'top': galleryMargin 'top': galleryMargin
}) })
} }
// Anzuzeigende Bilder
let imagesToLoad = [{ let imagesToLoad = [{
path: "Restaurant06", path: "Restaurant06",
alt: "Eingang zu unserem Restaurant vom Theaterfoyer" alt: "Eingang zu unserem Restaurant vom Theaterfoyer"
@ -165,6 +165,7 @@ $(function () {
alt: "So geht es in der Küche zu" alt: "So geht es in der Küche zu"
} }
]; ];
// Ende Anzuzeigende Bilder
imagesToLoad.forEach(function (element) { imagesToLoad.forEach(function (element) {
var item = '<li><a href="img/gallery/' + var item = '<li><a href="img/gallery/' +