You are here

README.txt in Soft Length Limit 7

Same filename and directory in other branches
  1. 8 README.txt
Soft Length Limit

This module provides a counter that indicates the max. limit of
characters in a certain text field. The soft limit means that the user
will be warned if the content length of the field is exceeded, but he
will still be able to save all data in the field.


It basically does two things:

* Lets the user configure any instance of a text field's widget, to
  have a specific soft limit. This is done in the usual field settings
  for entity types. This counter will always be shown on fields with a
  soft limit, no matter the settings mentioned below.

* Adds a character countdown to form elements that already have a
  maxlength specified.  This functionality can be customized through
  the options specified below.



-- Configuration of behavior of elements with "maxlength" attribute --

The following Drupal variables can be set to change the criteria for
which elements should have the limit counter:



* (bool) soft_length_limit_maxlength_counter_disabled:

If set to TRUE, no fields with maxlength attribute will have a counter.


* (bool) soft_length_limit_maxlength_counter_admin_only:

If set to TRUE, the counter will only be shown when the admin_theme is
active.


* (Array) soft_length_limit_maxlength_counter_themes:

This as an array of theme names for which the counter should be
shown. If empty, all themes show the counter.


* (Array) soft_limit_length_maxlength_exclude_selectors:

This is an array of jQuery selectors (using classes, IDs etc.) for
elements which should be excluded from having a counter, although they
have a defined maxlength, i.e. date fields, autocomplete fields
etc. could be added here.

* The icons for this came from Creative Commons Attribution 3.0
Unported License, and they came from http://icomoon.io/#icons free
package.

File

README.txt
View source
  1. Soft Length Limit
  2. This module provides a counter that indicates the max. limit of
  3. characters in a certain text field. The soft limit means that the user
  4. will be warned if the content length of the field is exceeded, but he
  5. will still be able to save all data in the field.
  6. It basically does two things:
  7. * Lets the user configure any instance of a text field's widget, to
  8. have a specific soft limit. This is done in the usual field settings
  9. for entity types. This counter will always be shown on fields with a
  10. soft limit, no matter the settings mentioned below.
  11. * Adds a character countdown to form elements that already have a
  12. maxlength specified. This functionality can be customized through
  13. the options specified below.
  14. -- Configuration of behavior of elements with "maxlength" attribute --
  15. The following Drupal variables can be set to change the criteria for
  16. which elements should have the limit counter:
  17. * (bool) soft_length_limit_maxlength_counter_disabled:
  18. If set to TRUE, no fields with maxlength attribute will have a counter.
  19. * (bool) soft_length_limit_maxlength_counter_admin_only:
  20. If set to TRUE, the counter will only be shown when the admin_theme is
  21. active.
  22. * (Array) soft_length_limit_maxlength_counter_themes:
  23. This as an array of theme names for which the counter should be
  24. shown. If empty, all themes show the counter.
  25. * (Array) soft_limit_length_maxlength_exclude_selectors:
  26. This is an array of jQuery selectors (using classes, IDs etc.) for
  27. elements which should be excluded from having a counter, although they
  28. have a defined maxlength, i.e. date fields, autocomplete fields
  29. etc. could be added here.
  30. * The icons for this came from Creative Commons Attribution 3.0
  31. Unported License, and they came from http://icomoon.io/#icons free
  32. package.