You are here

README.txt in Real Estate Mortgage Calculator 7

Real Estate Mortgage Calculator module is a simple mortgage calculator.
It is designed to operate with the Drupal Real Estate module
( http://drupal.org/project/real_estate ), but also can be used on
any other Drupal sites.

For calculation used a mortgage algorithm -
http://www.moneychimp.com/articles/finworks/fmmortgage.htm
Payment Frequency -
http://www.gailvazoxlade.com/articles/home_sweet_home/payment_frequency.html

For now exist two types of the blocks:
    Mortgage Calculator - used a submit form
    Mortgage Calculator JS - used a JS calculation


INSTALLATION:

1. Download and enable the Real Estate Mortgage Calculator module.
2. Visit the /mortgage-calculator page
3. Go to /admin/structure/block for managing an enabled Mortgage Calculator
block or enabling Mortgage Calculator JS block.


MORTGAGE CALCULATOR BLOCK - configuration

For the Mortgage Calculator block can be selected payment frequency methods: Monthly,
Yearly, Semi-monthly, Bi-weekly, Weekly, Accelerated Bi-weekly, Accelerated Weekly.
That can be done from the block configuration
/admin/structure/block/manage/mortgage_calculator/mortgage_calculator_1/configure

For populating the forms' values can be used tokens. For showing it should be enabled the
Token module https://drupal.org/project/token .
The tokens should be placed in appropriated fields of "Default values" section
of the block configuration
/admin/structure/block/manage/mortgage_calculator/mortgage_calculator_1/configure


MORTGAGE CALCULATOR JS BLOCK - configuration

For the Mortgage Calculator JS block can be selected payment frequency methods: Monthly,
Yearly, Semi-monthly, Bi-weekly, Weekly, Accelerated Bi-weekly, Accelerated Weekly.
That can be done from a block configuration
/admin/structure/block/manage/mortgage_calculator/mortgage_calculator_js_1/configure
By default selected - Monthly. (In that case will not shown a checkbox for selecting
a payment frequency method.)

For embedding Mortgage Calculator JS somewhere in a text, may be used filters:
  [mortgage_calculator_js:PRICE;RATE;YEARS]
  (where values: PRICE,RATE,YEARS must be replaced by appropriate values. For
  example: [mortgage_calculator_js:10000;4.5;10])

For enabling them, go to admin/config/content/formats, select appropriate format
and enable 'Set values for Mortgage Calculator'
More details https://drupal.org/node/778976

For populating the forms' values can be used tokens. For showing it should be enabled the
Token module https://drupal.org/project/token .
The tokens should be placed in appropriated fields of "Default values" section
of the block configuration
/admin/structure/block/manage/mortgage_calculator/mortgage_calculator_js_1/configure

File

README.txt
View source
  1. Real Estate Mortgage Calculator module is a simple mortgage calculator.
  2. It is designed to operate with the Drupal Real Estate module
  3. ( http://drupal.org/project/real_estate ), but also can be used on
  4. any other Drupal sites.
  5. For calculation used a mortgage algorithm -
  6. http://www.moneychimp.com/articles/finworks/fmmortgage.htm
  7. Payment Frequency -
  8. http://www.gailvazoxlade.com/articles/home_sweet_home/payment_frequency.html
  9. For now exist two types of the blocks:
  10. Mortgage Calculator - used a submit form
  11. Mortgage Calculator JS - used a JS calculation
  12. INSTALLATION:
  13. 1. Download and enable the Real Estate Mortgage Calculator module.
  14. 2. Visit the /mortgage-calculator page
  15. 3. Go to /admin/structure/block for managing an enabled Mortgage Calculator
  16. block or enabling Mortgage Calculator JS block.
  17. MORTGAGE CALCULATOR BLOCK - configuration
  18. For the Mortgage Calculator block can be selected payment frequency methods: Monthly,
  19. Yearly, Semi-monthly, Bi-weekly, Weekly, Accelerated Bi-weekly, Accelerated Weekly.
  20. That can be done from the block configuration
  21. /admin/structure/block/manage/mortgage_calculator/mortgage_calculator_1/configure
  22. For populating the forms' values can be used tokens. For showing it should be enabled the
  23. Token module https://drupal.org/project/token .
  24. The tokens should be placed in appropriated fields of "Default values" section
  25. of the block configuration
  26. /admin/structure/block/manage/mortgage_calculator/mortgage_calculator_1/configure
  27. MORTGAGE CALCULATOR JS BLOCK - configuration
  28. For the Mortgage Calculator JS block can be selected payment frequency methods: Monthly,
  29. Yearly, Semi-monthly, Bi-weekly, Weekly, Accelerated Bi-weekly, Accelerated Weekly.
  30. That can be done from a block configuration
  31. /admin/structure/block/manage/mortgage_calculator/mortgage_calculator_js_1/configure
  32. By default selected - Monthly. (In that case will not shown a checkbox for selecting
  33. a payment frequency method.)
  34. For embedding Mortgage Calculator JS somewhere in a text, may be used filters:
  35. [mortgage_calculator_js:PRICE;RATE;YEARS]
  36. (where values: PRICE,RATE,YEARS must be replaced by appropriate values. For
  37. example: [mortgage_calculator_js:10000;4.5;10])
  38. For enabling them, go to admin/config/content/formats, select appropriate format
  39. and enable 'Set values for Mortgage Calculator'
  40. More details https://drupal.org/node/778976
  41. For populating the forms' values can be used tokens. For showing it should be enabled the
  42. Token module https://drupal.org/project/token .
  43. The tokens should be placed in appropriated fields of "Default values" section
  44. of the block configuration
  45. /admin/structure/block/manage/mortgage_calculator/mortgage_calculator_js_1/configure