From 4c1ea9e1cd7a26518d5611b45cf885b619087f24 Mon Sep 17 00:00:00 2001 From: Manuel Friedli Date: Sat, 28 Jun 2014 13:57:10 +0200 Subject: [PATCH] update documentation --- info/index.html | 54 +++++++++++++++++++++++-------------------------- 1 file changed, 25 insertions(+), 29 deletions(-) diff --git a/info/index.html b/info/index.html index 0348a73..e52adcf 100644 --- a/info/index.html +++ b/info/index.html @@ -16,23 +16,17 @@ along with this program. If not, see . Die Zeit im Wort - Informationen + + + + + + - - - - - - - - - - - -

Die Zeit im Wort

@@ -81,21 +75,23 @@ along with this program. If not, see .

Einbinden in HTML

Javascript- und CSS-Dateien im <head>

-

Füge folgende Zeilen im <head>-Tag deines HTML-Dokumentes ein:
- <script type="text/javascript" src="jquery-2.1.0.min.js"></script> +

Füge folgende Zeilen im <head>-Tag deines HTML-Dokumentes ein. Beachte dabei, dass die CSS-Dateien vor den Javascript eingebunden werden.
+ <link rel="stylesheet" type="text/css" href="uhr.css" /> +<link rel="stylesheet" type="text/css" href="uhr-black.css" data-class="black" data-name="Schwarz" /> +<link rel="stylesheet" type="text/css" href="uhr-blue.css" data-class="blue" data-name="Blau" /> +<link rel="stylesheet" type="text/css" href="uhr-green.css" data-class="green" data-name="Grün" /> +<link rel="stylesheet" type="text/css" href="uhr-red.css" data-class="red" data-name="Rot" /> +<link rel="stylesheet" type="text/css" href="uhr-white.css" data-class="white" data-name="Weiss" /> +<link rel="stylesheet" type="text/css" href="uhr-pink.css" data-class="pink" data-name="Pink" /> +<script type="text/javascript" src="jquery-2.1.0.min.js"></script> <script type="text/javascript" src="jquery-ui-1.10.4.custom.min.js"></script> <script type="text/javascript" src="jquery-cookie-1.4.0.js"></script> <script type="text/javascript" src="uhr.js"></script> <script type="text/javascript" src="uhr-de_CH.js"></script> <script type="text/javascript" src="uhr-de.js"></script> -<script type="text/javascript" src="uhr-en.js"></script> -<link rel="stylesheet" type="text/css" href="uhr.css" /> -<link rel="stylesheet" type="text/css" href="uhr-black.css" /> -<link rel="stylesheet" type="text/css" href="uhr-blue.css" /> -<link rel="stylesheet" type="text/css" href="uhr-green.css" /> -<link rel="stylesheet" type="text/css" href="uhr-red.css" /> -<link rel="stylesheet" type="text/css" href="uhr-white.css" /> +<script type="text/javascript" src="uhr-en.js"></script>

+

Von den Stylesheets zwingend ist uhr.css und mindestens eines der Farbschema-Stylesheets. Die Attribute data-class bzw. data-name definieren dabei die im Stylesheet deklarierte Klasse bzw. den im Auswahlmenu anzuzeigenden Namen. Der Name kann frei gewählt werden, die Style-Klasse muss mit der im Stylesheet definierten übereinstimmen.

Uhr-Element auf der Seite

Definiere an der Stelle, wo die Uhr angezeigt werden soll, ein leeres <div>-Element:
<div id="meine-uhr"></div> @@ -108,7 +104,7 @@ along with this program. If not, see . }); </script>

-

Die Uhr wird so in der Standardkonfiguration angezeigt, das heisst: Berndeutsche Sprache, schwarzer Hintergrund, eingeschaltet, Breite 100% des Elternelementes. Wenn dies nicht deinen Bedürfnissen entspricht, lässt sich die Uhr wie im folgenden Abschnitt beschrieben konfigurieren. Die Konfiguration wird der .uhr()-Methode als JSON-Objekt übergeben, beispielsweise so:
+

Die Uhr wird so in der Standardkonfiguration angezeigt, das heisst: Berndeutsche Sprache, in der Farbe der ersten eingebundenen CSS-Datei (im Beispiel also Schwarz), eingeschaltet, Breite 100% des Elternelementes. Wenn dies nicht deinen Bedürfnissen entspricht, lässt sich die Uhr wie im folgenden Abschnitt beschrieben konfigurieren. Die Konfiguration wird der .uhr()-Methode als JSON-Objekt übergeben, beispielsweise so:
jQuery('#uhr').uhr({ width: '200px', theme: 'red' @@ -130,9 +126,9 @@ along with this program. If not, see .
Typ: String
Default: 'de_CH'

theme
-
Die anfänglich ausgewählte Farbe der Uhr. Unterstütze Werte sind zur Zeit 'black' (schwarz), 'red' (rot), 'blue' (blau), 'green' (grün) und 'white' (weiss). +
Die anfänglich ausgewählte Farbe der Uhr. Welche Farben unterstützt werden, hängt davon ab, welche CSS-Dateien eingebunden werden. Bis anhin unterstützte Farben sind zur Zeit 'black' (schwarz), 'red' (rot), 'blue' (blau), 'green' (grün), 'white' (weiss) und 'pink' (pink).
Typ: String -
Default: 'black'
+
Default: Farbe der ersten eingebundenen CSS-Datei
force
Legt fest, ob die in der Konfiguration angegebenen Werte allfällig in einem Browser-Cookie gespeicherte Einstellungen überschreiben sollen oder nicht. Mögliche Werte sind true (Konfiguration überschreibt Cookie-Werte) oder false (Cookie-Werte haben Vorrang).
Typ: boolean @@ -144,12 +140,12 @@ along with this program. If not, see .