You are here

Home » API reference » Field Timer 2.x

README.txt in Field Timer 2.x

Same filename and directory in other branches
  1. 8 README.txt
  2. 7.2 README.txt
  3. 7 README.txt
h1. Field Timer

h2. Description

This module provides datetime field formatters to display the field as a
timer or countdown. Module provides 3 field formatters: simple text and
2 formatters based on jQuery plugins: County and jQuery Countdown.

h2. Requirements

County (https://github.com/brilsergei/county)
jQuery Countdown (http://keith-wood.name/countdown.html)

h2. Installation

1. Download the module.
2. Download required JS libraries to drupal library directory and rename
library directories to libraries/county and libraries/jquery.countdown
respectively. This module supports jQuery Countdown 2.1.0.
4. Enable the module using admin module page or drush.

h2. Translation

Translation of 'Text timer or countdown' formatter can be done on the User
interface translation page.
Translation of jQuery Countdown is not compatible with Drupal translation
system. Therefore a special compatibility layer was created in the module.
Translation of 'jQuery Countdown' formatter can be done by 2 ways:
1. In the formatter settings form check option 'Use system language'. In this
case it will use the first langcode from the list - current content language,
default language, 'en', which will be found in jQuery Countdown translation
sets. For example, if content language is Belarusian (by), default language is
Russian (ru), then countdown will be displayed in Russian because there is no
Belarusian for jQuery Countdown.
2. You may specify Language option for each language enabled in the system
separately. In order to do it uncheck option 'Use system language' in the
formatter settings form, export configs with 'drush cex'. After that you need
find appropriate entity_view_mode entity config file in the folder with
exported configurations, copy the file to the language folder which you want
translate to and change in the copied file option 'regional' for your field.
Formatter settings cannot be translated via interface yet. See
https://www.drupal.org/project/drupal/issues/2546212

h2. Issues, Bugs and Feature Requests

Issues, Bugs and Feature Requests should be made on the page at 
https://drupal.org/project/issues/2040519.

h2. Creators

This module was created by Sergei Brill 
("Drupal user sergei_brill": http://drupal.org/user/2306590/)

File

README.txt
View source 
  1. h1. Field Timer

  2. 

  3. h2. Description

  4. 

  5. This module provides datetime field formatters to display the field as a

  6. timer or countdown. Module provides 3 field formatters: simple text and

  7. 2 formatters based on jQuery plugins: County and jQuery Countdown.

  8. 

  9. h2. Requirements

  10. 

  11. County (https://github.com/brilsergei/county)

  12. jQuery Countdown (http://keith-wood.name/countdown.html)

  13. 

  14. h2. Installation

  15. 

  16. 1. Download the module.

  17. 2. Download required JS libraries to drupal library directory and rename

  18. library directories to libraries/county and libraries/jquery.countdown

  19. respectively. This module supports jQuery Countdown 2.1.0.

  20. 4. Enable the module using admin module page or drush.

  21. 

  22. h2. Translation

  23. 

  24. Translation of 'Text timer or countdown' formatter can be done on the User

  25. interface translation page.

  26. Translation of jQuery Countdown is not compatible with Drupal translation

  27. system. Therefore a special compatibility layer was created in the module.

  28. Translation of 'jQuery Countdown' formatter can be done by 2 ways:

  29. 1. In the formatter settings form check option 'Use system language'. In this

  30. case it will use the first langcode from the list - current content language,

  31. default language, 'en', which will be found in jQuery Countdown translation

  32. sets. For example, if content language is Belarusian (by), default language is

  33. Russian (ru), then countdown will be displayed in Russian because there is no

  34. Belarusian for jQuery Countdown.

  35. 2. You may specify Language option for each language enabled in the system

  36. separately. In order to do it uncheck option 'Use system language' in the

  37. formatter settings form, export configs with 'drush cex'. After that you need

  38. find appropriate entity_view_mode entity config file in the folder with

  39. exported configurations, copy the file to the language folder which you want

  40. translate to and change in the copied file option 'regional' for your field.

  41. Formatter settings cannot be translated via interface yet. See

  42. https://www.drupal.org/project/drupal/issues/2546212

  43. 

  44. h2. Issues, Bugs and Feature Requests

  45. 

  46. Issues, Bugs and Feature Requests should be made on the page at 

  47. https://drupal.org/project/issues/2040519.

  48. 

  49. h2. Creators

  50. 

  51. This module was created by Sergei Brill 

  52. ("Drupal user sergei_brill": http://drupal.org/user/2306590/)