You are here

Home » API reference » jQuery World Calendars API 3.x

README.txt in jQuery World Calendars API 3.x

Same filename and directory in other branches
  1. 7 README.txt
Description
===========
Brings jQuery World Calendars API to Drupal. The module doesn't do much on its own unless you're developer.
To see what languages and calendar systems are supported by the module, visit the demo page admin/config/user-interface/jquery-calendar/demo

Requirements
============
 - jQuery Calendars library (http://keith-wood.name/calendars.html)
   Accessible via sites/all/libraries/jquery.calendars

Installation (Auto - Recommended)
============
 If you're using Drupal's recommended composer template, you can  install this module alongside its required library
 using: composer require drupal/jquery_calendar
 But before doing it add the following code to your drupal composer.json
 ```
     "extra": {
         "merge-plugin": {
             "include": [
                 "web/modules/contrib/*/composer.json"
             ],
             "recurse": true
         }
     }
 ```
 and run this: composer require wikimedia/composer-merge-plugin

Installation (Manual)
============
 - Download and install Libraries API module as usual.
 - Download jQuery Calendars library from (http://keith-wood.name/calendars.html) and put it in sites/all/libraries/jquery.calendars
 - Enable jQuery Calendar API module
 - Goto admin/config/user-interface/jquery-calendar

API Usage
=========
Please see components section below for all available options, here is an API usage example used in the module itself:
  <?php
    jquery_calendar_add('picker, hebrew, persian, taiwan, thai, islamic, ethiopian, coptic, mayan', 'hebrew-he, persian-fa, gregorian-fr', 'smoothness', 'pack');
  ?>

Available Components
====================
  Library
  =======
   - base: base calendar support.
   - plus: additional features, date parsing, formatting, etc.
   - picker: datepicker with full calendar support and localisation.
   - picker.ext: datepicker extensions.
   - validation: validation plugin support for the datepicker.
   - lang: contains all Gregorian calendar locales.
   - picker.lang: contains all datepicker locales.

  Calendar Implementations
  ========================
   - Gregorian
   - Hebrew
   - Persian
   - Taiwan
   - Thai
   - Julian
   - Islamic
   - Ethiopian
   - Coptic
   - Mayan
   - Discworld
   - Nanakshahi
   - Nepali
   - Ummalqura

  Themes
  ======
  jQuery UI themes will be supported soon.
   - Flora
   - Redmond
   - Humanity
   - Smoothness
   - jQuery Default

  Locales
  =======
   - Many! As per documented in code.

Author and Maintainer
=====================
Sina Salek (http://drupal.org/user/52244)

File

README.txt
View source 
  1. Description

  2. ===========

  3. Brings jQuery World Calendars API to Drupal. The module doesn't do much on its own unless you're developer.

  4. To see what languages and calendar systems are supported by the module, visit the demo page admin/config/user-interface/jquery-calendar/demo

  5. 

  6. Requirements

  7. ============

  8.  - jQuery Calendars library (http://keith-wood.name/calendars.html)

  9.    Accessible via sites/all/libraries/jquery.calendars

  10. 

  11. Installation (Auto - Recommended)

  12. ============

  13.  If you're using Drupal's recommended composer template, you can  install this module alongside its required library

  14.  using: composer require drupal/jquery_calendar

  15.  But before doing it add the following code to your drupal composer.json

  16.  ```

  17.      "extra": {

  18.          "merge-plugin": {

  19.              "include": [

  20.                  "web/modules/contrib/*/composer.json"

  21.              ],

  22.              "recurse": true

  23.          }

  24.      }

  25.  ```

  26.  and run this: composer require wikimedia/composer-merge-plugin

  27. 

  28. Installation (Manual)

  29. ============

  30.  - Download and install Libraries API module as usual.

  31.  - Download jQuery Calendars library from (http://keith-wood.name/calendars.html) and put it in sites/all/libraries/jquery.calendars

  32.  - Enable jQuery Calendar API module

  33.  - Goto admin/config/user-interface/jquery-calendar

  34. 

  35. API Usage

  36. =========

  37. Please see components section below for all available options, here is an API usage example used in the module itself:

  38.   
  39.     jquery_calendar_add('picker, hebrew, persian, taiwan, thai, islamic, ethiopian, coptic, mayan', 'hebrew-he, persian-fa, gregorian-fr', 'smoothness', 'pack');

  40.   ?>

  41. 

  42. Available Components

  43. ====================

  44.   Library

  45.   =======

  46.    - base: base calendar support.

  47.    - plus: additional features, date parsing, formatting, etc.

  48.    - picker: datepicker with full calendar support and localisation.

  49.    - picker.ext: datepicker extensions.

  50.    - validation: validation plugin support for the datepicker.

  51.    - lang: contains all Gregorian calendar locales.

  52.    - picker.lang: contains all datepicker locales.

  53. 

  54.   Calendar Implementations

  55.   ========================

  56.    - Gregorian

  57.    - Hebrew

  58.    - Persian

  59.    - Taiwan

  60.    - Thai

  61.    - Julian

  62.    - Islamic

  63.    - Ethiopian

  64.    - Coptic

  65.    - Mayan

  66.    - Discworld

  67.    - Nanakshahi

  68.    - Nepali

  69.    - Ummalqura

  70. 

  71.   Themes

  72.   ======

  73.   jQuery UI themes will be supported soon.

  74.    - Flora

  75.    - Redmond

  76.    - Humanity

  77.    - Smoothness

  78.    - jQuery Default

  79. 

  80.   Locales

  81.   =======

  82.    - Many! As per documented in code.

  83. 

  84. Author and Maintainer

  85. =====================

  86. Sina Salek (http://drupal.org/user/52244)