You are here

README.txt in Measured Value Field 6

Same filename and directory in other branches
  1. 7 README.txt
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Measured Value Field module.
;;
;; Started as fork of Money CCK field (http://drupal.org/project/money)
;;
;; Credit goes to Money CCK module maintainers:
;;   markus_petrux (http://drupal.org/user/39593)
;;   Wim Leers (original author) (http://drupal.org/user/99777)
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

OVERVIEW
========

Most values in our life are not simple numbers, but numbers with units. Many 
CCK fields have mechanics to display units together with values via "suffix" 
and "prefix" settings. There is problem with that: these settings are 
configured once at field level and don't change. Also, user can't choose the 
unit together with value, which sometimes is a problem too. 
Measured Value Field module tries to overcome these problems. MVF 
implements value that has number and unit of measurement. 
MVF supports both single values, and value ranges, which means each range is 
pair of values that is treated like single value of field.
MVF module uses the Units module API, to get a list of units to work with. 
Thanks to this flexibility MVF can be used to setup: distances, weghts, 
currencies, percentages, speeds, calories... list is endless. It only depends
on what units you make available to Units module. 

DETAILS
=======

The form element for values is reused from the Formatted Number CCK module.
Decimal points and thousands separators are formatted using the Format Number
API module, where these options are configured from site and/or user settings.

Single values are stored as pairs too: just their "To" value is equal to the 
"From" one.
For ranges there are also advanced Views filters: you can filter using range 
overlap, and "in between" filter operator
 
Since MVF is using Units module, every unit available in Units also becomes 
available as part of Measured Value field. 


REQUIREMENTS
============

- CCK (http://drupal.org/project/cck)
- Format Number API (http://drupal.org/project/format_number)
- Formatted Number CCK (http://drupal.org/project/formatted_number)
- Units module (http://drupal.org/project/units)
- One or more Units integration modules enabled:
  Units module itself doesn't provide units, only API. So one needs to have 
  another module using it's API to provide units. For example, Currency Units 
  module, that is bundled together with Units, provides Currencies implemented 
  in Currency Exchange module.


INSTALLATION
============

- Please, make sure all required modules are installed first.

- Copy all contents of this package to your modules directory preserving
  subdirectory structure.

- Goto Administer > Site building > Modules to install this module.

- For maximum comfort, goto Administer > Content management  > Units and setup 
  site-wide list of enabled units. This will save you lot of time, because
  each MVF instance will use globally enabled units as a base.

- Create or edit content types and start adding Measured Value Fields.
  Note, that you need to have some units provided by the Units module for
  this module to work.

File

README.txt
View source
  1. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  2. ;; Measured Value Field module.
  3. ;;
  4. ;; Started as fork of Money CCK field (http://drupal.org/project/money)
  5. ;;
  6. ;; Credit goes to Money CCK module maintainers:
  7. ;; markus_petrux (http://drupal.org/user/39593)
  8. ;; Wim Leers (original author) (http://drupal.org/user/99777)
  9. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  10. OVERVIEW
  11. ========
  12. Most values in our life are not simple numbers, but numbers with units. Many
  13. CCK fields have mechanics to display units together with values via "suffix"
  14. and "prefix" settings. There is problem with that: these settings are
  15. configured once at field level and don't change. Also, user can't choose the
  16. unit together with value, which sometimes is a problem too.
  17. Measured Value Field module tries to overcome these problems. MVF
  18. implements value that has number and unit of measurement.
  19. MVF supports both single values, and value ranges, which means each range is
  20. pair of values that is treated like single value of field.
  21. MVF module uses the Units module API, to get a list of units to work with.
  22. Thanks to this flexibility MVF can be used to setup: distances, weghts,
  23. currencies, percentages, speeds, calories... list is endless. It only depends
  24. on what units you make available to Units module.
  25. DETAILS
  26. =======
  27. The form element for values is reused from the Formatted Number CCK module.
  28. Decimal points and thousands separators are formatted using the Format Number
  29. API module, where these options are configured from site and/or user settings.
  30. Single values are stored as pairs too: just their "To" value is equal to the
  31. "From" one.
  32. For ranges there are also advanced Views filters: you can filter using range
  33. overlap, and "in between" filter operator
  34. Since MVF is using Units module, every unit available in Units also becomes
  35. available as part of Measured Value field.
  36. REQUIREMENTS
  37. ============
  38. - CCK (http://drupal.org/project/cck)
  39. - Format Number API (http://drupal.org/project/format_number)
  40. - Formatted Number CCK (http://drupal.org/project/formatted_number)
  41. - Units module (http://drupal.org/project/units)
  42. - One or more Units integration modules enabled:
  43. Units module itself doesn't provide units, only API. So one needs to have
  44. another module using it's API to provide units. For example, Currency Units
  45. module, that is bundled together with Units, provides Currencies implemented
  46. in Currency Exchange module.
  47. INSTALLATION
  48. ============
  49. - Please, make sure all required modules are installed first.
  50. - Copy all contents of this package to your modules directory preserving
  51. subdirectory structure.
  52. - Goto Administer > Site building > Modules to install this module.
  53. - For maximum comfort, goto Administer > Content management > Units and setup
  54. site-wide list of enabled units. This will save you lot of time, because
  55. each MVF instance will use globally enabled units as a base.
  56. - Create or edit content types and start adding Measured Value Fields.
  57. Note, that you need to have some units provided by the Units module for
  58. this module to work.