uhr/README.md
2014-01-09 22:28:51 +01:00

2.4 KiB

Bärneruhr

Du willst Bärneruhr auf deiner Website verwenden? Das geht ganz einfach.

  1. Benötigte Dateien einbinden
    • Binde folgende Javascript-Dateien im HTML-Dokument ein:
      • jquery-2.0.3.min.js (Falls nicht bereits vorhanden)
      • jquery.cookie.js (Falls nicht bereits vorhanden)
      • uhr.js
    • Binde mindestens eine der folgenden Javascript-Dateien im HTML ein, je nach dem, welche Sprachen deine Uhr unterstützen soll:
      • uhr-de_CH.js
      • uhr-de.js
      • uhr-en.js
    • Binde folgende CSS-Dateien im HTML-Dokument ein:
      • uhr.css
      • uhr-black.css
      • uhr-blue.css
      • uhr-green.css
      • uhr-red.css
      • uhr-white.css
    • Die möglichen Themes (Farbschemata) sind im Moment noch hartcodiert, deshalb sollten alle Dateien eingebunden werden.
  2. Uhr-Element im HTML-Dokument einfügen Erstelle ein leeres
    mit einer ID:
    <div id="meineuhr"></div>
  3. Uhr per Javascript konfigurieren Initialisiere die Uhr mit einer einzigen Zeile Javascript:
    new Uhr(jQuery('#meineuhr'));
    Als Parameter wird ein jQuery-gewrapptes HTML-Element erwartet. Dies erzeugt eine Uhr in der Standardkonfiguration. Das heisst:
    • Breite ist 100% des Eltenelements
    • Farbe ist Schwarz
    • Sprache ist Bärndütsch
    • Die Uhr ist eingeschaltet Wie du diese Optionen ändern kannst, verrät der nächte Abschnitt.
  4. Weitere Optionen Der Uhr()-Methode kann ein Options-Objekt mitgegeben werden:
    new Uhr(jQuery('#uhrcontainer'), {
    status: 'on', // 'on' oder 'off'
    theme: 'red', // 'black', 'red', 'blue', 'green' oder 'white'
    layout: 'en', // 'de_EC', 'de' oder 'en' (je nach eingebundenen Sprachdateien
    width: '20em' // eine CSS-Grössenangabe
    });
    Viel Spass!

A. Lizenzbestimmungen

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.