README.txt 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. DESCRIPTION
  2. --------------
  3. Timefield is a Field API field that can store 3 types of time values: a simple
  4. time value, a start time and end time, or a combination of these two with a
  5. basic weekly repeat value. The values are stored in the database as integer
  6. offsets from 12AM. If the second value continues into the next day,
  7. i.e. 8PM - 2AM, the second value is stored as an offset +1 day.
  8. The goal of this field is to provide time storage that is not dependent on the
  9. Gregorian calendar.
  10. INSTALLATION
  11. ------------
  12. 1) Start by copying the module files into your 'modules' directory. For more
  13. information: http://drupal.org/documentation/install/modules-themes/modules-7
  14. 2) The Timefield module utilizes a jQuery plugin to assist with the input of
  15. time values. The use of this plugin is facilitated by the Libraries module. If
  16. not already installed, download, enable, and configure the latest versions of
  17. the Libraries module. See:
  18. http://drupal.org/project/libraries
  19. 3) Acquire the timepicker plugin. There are a few ways to do this.
  20. a) Direct Download:
  21. You can either download a zip or tarball file from github:
  22. https://github.com/fgelinas/timepicker/downloads
  23. Or you can download the plugin from the author's site:
  24. http://fgelinas.com/code/timepicker
  25. Once you have the compressed file, unzip it to the libraries folder to a
  26. subfolder called "jquery.timepicker".
  27. The main javascript file should have a path like this:
  28. /sites/all/libraries/jquery.timepicker/jquery.ui.timepicker.js
  29. b) You can also clone the repository directly:
  30. From your libraries subfolder, execute this command:
  31. git clone https://github.com/fgelinas/timepicker.git jquery.timepicker
  32. c) If you have drush installed, you can use the command
  33. "drush timefield-plugin" to automatically download and install this library.
  34. USAGE
  35. -------
  36. Timefield module provides a field type 'timefield' with a default JQuery widget.
  37. The timefield can have an optional 'to time' and various input formats,
  38. depending on your preference. While this field is multi-value capable,
  39. I am not really sure about a use-case for this.
  40. There are a three display formatters, time (with optional to time, duration,
  41. and a mini-calendar output. You can configure various output formats in the
  42. format settings dialog option on the "Manage Display" section of the Field API
  43. UI.