manuel/uhr
1
0
Fork 0
Code Issues 5 Pull requests Releases Wiki Activity

Adjust README
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse source
This commit is contained in:
Manuel Friedli 2019-05-06 02:39:59 +02:00
parent 3c986d645a
commit 4b64d4a793
1 changed files with 38 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

70
README.md
View file

@ -2,16 +2,19 @@
Du willst Bärneruhr auf deiner Website verwenden? Dank des jQuery-Plugins geht das so einfach, dass es sogar deine Grossmutter tun könnte!
## 1. Benötigte Dateien einbinden
* Binde folgende CSS-Datei im HTML-Dokument ein:
* dist/uhr.min.css
* Binde zusätzlich mindestens eine der folgenden CSS-Dateien im HTML ein, je nach dem, welche Farben deine Uhr unterstützen soll:
* dist/uhr-black.min.css
* dist/uhr-white.min.css
* dist/uhr-red.min.css
* dist/uhr-yellow.min.css
* dist/uhr-green.min.css
* dist/uhr-blue.min.css
* dist/uhr-pink.min.css
**FIXME Folgender Absatz muss angepasst werden**
Binde folgende CSS-Datei im HTML-Dokument ein:
* dist/uhr.min.css
**FIXME Folgender Absatz muss angepasst werden**
Binde zusätzlich mindestens eine der folgenden CSS-Dateien im HTML ein, je nach dem, welche Farben deine Uhr unterstützen soll:
* dist/uhr-black.min.css
* dist/uhr-white.min.css
* dist/uhr-red.min.css
* dist/uhr-yellow.min.css
* dist/uhr-green.min.css
* dist/uhr-blue.min.css
* dist/uhr-pink.min.css
Beim Einbinden muss das attribut `data-class` angegeben werden, welches die CSS-Klasse des Themes definiert. Optional kann mit `data-name` ein im Dropdown anzuzeigender Name angegeben werden. Beispiel:
@ -19,31 +22,32 @@ Beim Einbinden muss das attribut `data-class` angegeben werden, welches die CSS-
<link rel="stylesheet" type="text/css" href="dist/uhr-black.min.css" data-class="black" data-name="Schwarz" />
```
* Binde nach den CSS-Dateien (wichtig!) folgende Javascript-Dateien im HTML-Dokument ein:
* dist/libs.min.js: Dies enthält die minifizierten Versionen von jQuery, jQuery-UI (mit den Komponenten `code` und `widget`) und jQuery-Cookie.
Alternativ kannst Du auch direkt die benötigten Bibliotheken einbinden:
* jquery (getestet mit Version 3.4.1)
* jquery-ui (getestet mit Version 1.12.1)
Binde nach den CSS-Dateien (wichtig: *nicht* vorher) die benötigten Bibliotheken ein:
* jquery (getestet mit Version 3.4.1)
* jquery-ui (getestet mit Version 1.12.1)
* Von jquery-ui wird die Komponente 'widget' benötigt.
* jquery-cookie (getestet mit Version 1.4.1)
Je nach dem, in welchen Sprachen du die Uhr verwenden willst, noch eine der folgenden Dateien:
* dist/jquery.uhr.complete.min.js: Enthält die Hauptdatei sowie alle unterstützten Sprachdateien
* dist/jquery.uhr.base.min.js: Enthält die Hauptdatei sowie Bärndütsch (de_CH)
* dist/jquery.uhr.main.min.js: Enthält ausschliesslich die Hauptdatei. Zusätzlich muss noch mindestens eine Sprachdatei eingebunden werden (siehe unten).
* js-cookie (getestet mit Version 2.2.0)
* Je nach dem, welche der obigen Dateien du eingebunden hast, kannst du noch individuelle Sprachdateien einbinden. Im Einstellungsfenster der Uhr werden diese Sprachen dann in der Reihenfolge zur Auswahl angeboten, in welcher du sie eingebunden hast.
* dist/jquery.uhr.langs.min.js: Enthält alle Sprachen
* dist/jquery.uhr.baselangs.min.js: Enthält alle Sprachen bis auf Bärndütsch (de_CH), welche bereits in dist/jquery.uhr.base.min.js enthalten ist.
* src/uhr-de_CH.js (Bärndütsch)
* src/uhr-de_CH_genau.js (Bärndütsch, siehe unten)
* src/uhr-de.js (Deutsch)
* src/uhr-dk.js (Dänisch)
* src/uhr-en.js (Englisch)
* src/uhr-es.js (Spanisch)
* src/uhr-fr.js (Französisch)
* src/uhr-it.js (Italienisch)
* src/uhr-nl.js (Niederländisch)
* src/uhr-pt.js (Portugiesisch)
**FIXME Folgender Absatz muss angepasst werden**
Je nach dem, in welchen Sprachen du die Uhr verwenden willst, noch eine der folgenden Dateien:
* dist/jquery.uhr.complete.min.js: Enthält die Hauptdatei sowie alle unterstützten Sprachdateien
* dist/jquery.uhr.base.min.js: Enthält die Hauptdatei sowie Bärndütsch (de_CH)
* dist/jquery.uhr.main.min.js: Enthält ausschliesslich die Hauptdatei. Zusätzlich muss noch mindestens eine Sprachdatei eingebunden werden (siehe unten).
**FIXME Folgender Absatz muss angepasst werden**
Je nach dem, welche der obigen Dateien du eingebunden hast, kannst du noch individuelle Sprachdateien einbinden. Im Einstellungsfenster der Uhr werden diese Sprachen dann in der Reihenfolge zur Auswahl angeboten, in welcher du sie eingebunden hast.
* dist/jquery.uhr.langs.min.js: Enthält alle Sprachen
* dist/jquery.uhr.baselangs.min.js: Enthält alle Sprachen bis auf Bärndütsch (de_CH), welche bereits in dist/jquery.uhr.base.min.js enthalten ist.
* src/uhr-de_CH.js (Bärndütsch)
* src/uhr-de_CH_genau.js (Variante von Bärndütsch, siehe unten)
* src/uhr-de.js (Deutsch)
* src/uhr-dk.js (Dänisch)
* src/uhr-en.js (Englisch)
* src/uhr-es.js (Spanisch)
* src/uhr-fr.js (Französisch)
* src/uhr-it.js (Italienisch)
* src/uhr-nl.js (Niederländisch)
* src/uhr-pt.js (Portugiesisch)
`src/uhr-de_CH_genau.js` ist eine Variante von Bärndütsch, bei der zur vollen Stunde zusätzlich das Wort "genau" angezeigt wird (also z.B. um 15:00 Uhr "ES ISCH GENAU DRÜ" anstelle von "ES ISCH DRÜ").