You are here

Home » API reference » Timefield 7

README.txt in Timefield 7 

DESCRIPTION
--------------

Timefield is a Field API field that can store 3 types of time values: a simple
time value, a start time and end time, or a combination of these two with a 
basic weekly repeat value.  The values are stored in the database as integer 
offsets from 12AM.  If the second value continues into the next day, 
i.e. 8PM - 2AM, the second value is stored as an offset +1 day.

The goal of this field is to provide time storage that is not dependent on the 
Gregorian calendar.

INSTALLATION
------------

1) Start by copying the module files into your 'modules' directory.  For more
information: http://drupal.org/documentation/install/modules-themes/modules-7

2) The Timefield module utilizes a jQuery plugin to assist with the input of
time values.  The use of this plugin is facilitated by the Libraries module. If 
not already installed, download, enable, and configure the latest versions of 
the Libraries module. See:
http://drupal.org/project/libraries

3) Acquire the timepicker plugin.  Please be sure to get a version compatible
with your version of jQuery.  There are a few ways to download the library.


a) If you have drush installed, you can use the command
"drush timefield-plugin" to automatically download and install this library.
This will install the version of the timepicker plugin compatible with Drupal 7's
core version of jQuery.

b) Direct Download:
You can either download a zip or tarball file from github:
https://github.com/fgelinas/timepicker/downloads
Or you can download the plugin from the author's site:
http://fgelinas.com/code/timepicker
Once you have the compressed file, unzip it to the libraries folder to a
subfolder called "jquery.timepicker".
The main javascript file should have a path like this:
/sites/all/libraries/jquery.timepicker/jquery.ui.timepicker.js

c) You can also clone the repository directly:
From your libraries subfolder, execute this command:
git clone https://github.com/fgelinas/timepicker.git jquery.timepicker

USAGE
-------
Timefield module provides a field type 'timefield' with a default JQuery widget.
The timefield can have an optional 'to time' and various input formats, 
depending on your preference.  While this field is multi-value capable, 
I am not really sure about a use-case for this.  
There are a three display formatters, time (with optional to time, duration,
and a mini-calendar output.  You can configure various output formats in the 
format settings dialog option on the "Manage Display" section of the Field API 
UI.

File

README.txt
View source 
  1. DESCRIPTION

  2. --------------

  3. 

  4. Timefield is a Field API field that can store 3 types of time values: a simple

  5. time value, a start time and end time, or a combination of these two with a 

  6. basic weekly repeat value.  The values are stored in the database as integer 

  7. offsets from 12AM.  If the second value continues into the next day, 

  8. i.e. 8PM - 2AM, the second value is stored as an offset +1 day.

  9. 

  10. The goal of this field is to provide time storage that is not dependent on the 

  11. Gregorian calendar.

  12. 

  13. INSTALLATION

  14. ------------

  15. 

  16. 1) Start by copying the module files into your 'modules' directory.  For more

  17. information: http://drupal.org/documentation/install/modules-themes/modules-7

  18. 

  19. 2) The Timefield module utilizes a jQuery plugin to assist with the input of

  20. time values.  The use of this plugin is facilitated by the Libraries module. If 

  21. not already installed, download, enable, and configure the latest versions of 

  22. the Libraries module. See:

  23. http://drupal.org/project/libraries

  24. 

  25. 3) Acquire the timepicker plugin.  Please be sure to get a version compatible

  26. with your version of jQuery.  There are a few ways to download the library.

  27. 

  28. 

  29. a) If you have drush installed, you can use the command

  30. "drush timefield-plugin" to automatically download and install this library.

  31. This will install the version of the timepicker plugin compatible with Drupal 7's

  32. core version of jQuery.

  33. 

  34. b) Direct Download:

  35. You can either download a zip or tarball file from github:

  36. https://github.com/fgelinas/timepicker/downloads

  37. Or you can download the plugin from the author's site:

  38. http://fgelinas.com/code/timepicker

  39. Once you have the compressed file, unzip it to the libraries folder to a

  40. subfolder called "jquery.timepicker".

  41. The main javascript file should have a path like this:

  42. /sites/all/libraries/jquery.timepicker/jquery.ui.timepicker.js

  43. 

  44. c) You can also clone the repository directly:

  45. From your libraries subfolder, execute this command:

  46. git clone https://github.com/fgelinas/timepicker.git jquery.timepicker

  47. 

  48. USAGE

  49. -------

  50. Timefield module provides a field type 'timefield' with a default JQuery widget.

  51. The timefield can have an optional 'to time' and various input formats, 

  52. depending on your preference.  While this field is multi-value capable, 

  53. I am not really sure about a use-case for this.  

  54. There are a three display formatters, time (with optional to time, duration,

  55. and a mini-calendar output.  You can configure various output formats in the 

  56. format settings dialog option on the "Manage Display" section of the Field API 

  57. UI.