# jDigiClock

## Digital Clock (HTC Hero inspired)

Author: Radoslav Dimov
Version: 2.1 (Changelog)
Download: jdigiclock.zip
Licence: Dual licensed under the MIT and GPL licenses.

### Contents

1. Introduction
2. Examples
3. Getting started
4. Configuration
5. Compatibility

### Introduction

jDigiClock is a jQuery plugin inspired from HTC Hero Clock Widget.

### Examples

### Getting started

To use the jDigiClock plugin, include the jQuery library, the jDigiClock source file and jDigiClock core stylesheet file inside the `<head>` tag of your HTML document:

    <link rel="stylesheet" type="text/css" href="css/jquery.jdigiclock.css" />
    <script type="text/javascript" src="lib/jquery-1.3.2.min.js"></script>
    <script type="text/javascript" src="lib/jquery.jdigiclock.js"></script>

To setup jDigiClock, add the following code inside the `<head>` tag of your HTML document:

    <script type="text/javascript">
        $(document).ready(function() {
            $('#digiclock').jdigiclock({
                // Configuration goes here
            });
        });
    </script>

jDigiClock accepts a lot of configuration options, see chapter "Configuration" for further informations.

jDigiClock expects a very basic HTML markup structure inside your HTML document:

    <div id="digiclock"></div>

### Configuration

jDigiClock accepts a list of options to control the appearance and behaviour of the Digital Clock. Here is the list of options you may set:

Property | Type | Default | Description
--- | --- | --- | ---
clockImagesPath | string | "images/clock/" | Clock images path.
weatherImagesPath | string | "images/weather/" | Weather images path.
am_pm | boolean | false | Specifies the AM/PM option.
weatherLocationCode | string | "EUR|BG|BU002|BOURGAS" | Weather location code (see: WeatherLocationDatabase.txt).
weatherMetric | string | "C" | Specifies the weather metric mode: C or F.
weatherUpdate | integer | 0 | Weather update in minutes.
proxyType | string | "php" | Specifies proxy type: php or asp (see: README.txt).

### Compatibility

jDigiClock has been tested and works on the following browsers:

- Internet Explorer 7 (PC)
- FireFox 3.5 (PC/Linux)
- Google Chrome 3.0 (PC)
- Safari 4.0 (PC)