You are here

README.txt in Mobile Codes 7.2

Same filename and directory in other branches
  1. 6.2 README.txt
  2. 6 README.txt
The Mobile Codes module provides the ability to render Text, URLs or any other
form of informaton as a Mobile Code, including but not limited to the QR and
Datamatrix formats, providing a simple way of transfering said information from
the screen to a Mobile phone.

Mobile Codes was written and is maintained by Stuart Clark (deciphered).
- http://stuar.tc/lark



Features
--------------------------------------------------------------------------------

* User definable and Features exportable Mobile Code Providers and Presets.
  * Defaults provided:
    * Six (6) External Providers.
    * One (1) Internal Provider (see below).
    * Three (3) to five (5) Presets (based on installed modules).
* Render Mobile Codes via:
  * Field/Views formatters:
    * File module.
    * Image modules.
    * Link module.
    * Text module.
    * plus example Custom Formatters for extended support.
  * Pseudo field via Content Types.
  * Input filter.
  * Tokens:
    * Text field tokens.
    * URL tokens.
    * User vCard tokens.
  * Drupal API Theme() call.
* Blocks:
  * Node URL block - Creates a Mobile Code of the current Node URL.
  * User vCard - Uses the vCard module to provide a vCard Mobile Code from a
    Nodes Author or a users profile.
  * Mobile Code generator - An Admin module optimized helper block.
* Support for:
  * Drupal core Image module - Use an Image style on the Mobile Codes.
  * Shorten module - Shorten URLs in Mobile Codes.
  * Variable module - Configure the settings via various methods.



Required modules
--------------------------------------------------------------------------------

* Chaos tool suite module.



Recommended modules
--------------------------------------------------------------------------------

* Custom Formatters module.
* Drupal core Image module.
* Libraries API module.



Configuration
--------------------------------------------------------------------------------

All configuration for Mobile Codes can be found at:
  Administer > Configuration > Content authoring > Mobile Codes
  http://[www.yoursite.com/path/to/drupal]/admin/config/content/mobile_codes


Note: When using the Input filter, be sure to enable the <IMG> tag on your Text
      format or the Mobile Code will be filtered out.



Advanced configuration
--------------------------------------------------------------------------------

* Setting up an internal Provider with the PHP QR Code library:

  1. Download, install and enable the Libraries API module.
       http://drupal.org/project/libraries

  2. Download the PHP QR Code library.
       http://sourceforge.net/projects/phpqrcode/files/releases/phpqrcode-2010100721_1.1.4.zip/download

  3. Extract the PHP QR Code library to your Libraries directory.
       e.g. sites/all/libraries/phpqrcode

  4. Clear cached data from the Perfomance page.
       Administer > Configuration > Development > Performance
       http://[www.yoursite.com/path/to/drupal]/admin/config/development/performance


  Note: Mobile Codes will automatically detect the PHP QR Code library once
        installed as above and add a new PHP QR Code Provider to the list.



Makefile entries
--------------------------------------------------------------------------------

For easy downloading of Mobile Codes and it's required/recommended modules
and/or libraries, you can use the following entries in your makefile:


  projects[ctools][subdir] = contrib
  projects[ctools][version] = 1.3

  projects[libraries][subdir] = contrib
  projects[libraries][version] = 2.1

  libraries[phpqrcode][download][type] = get
  libraries[phpqrcode][download][url] = http://sourceforge.net/projects/phpqrcode/files/releases/phpqrcode-2010100721_1.1.4.zip/download

File

README.txt
View source
  1. The Mobile Codes module provides the ability to render Text, URLs or any other
  2. form of informaton as a Mobile Code, including but not limited to the QR and
  3. Datamatrix formats, providing a simple way of transfering said information from
  4. the screen to a Mobile phone.
  5. Mobile Codes was written and is maintained by Stuart Clark (deciphered).
  6. - http://stuar.tc/lark
  7. Features
  8. --------------------------------------------------------------------------------
  9. * User definable and Features exportable Mobile Code Providers and Presets.
  10. * Defaults provided:
  11. * Six (6) External Providers.
  12. * One (1) Internal Provider (see below).
  13. * Three (3) to five (5) Presets (based on installed modules).
  14. * Render Mobile Codes via:
  15. * Field/Views formatters:
  16. * File module.
  17. * Image modules.
  18. * Link module.
  19. * Text module.
  20. * plus example Custom Formatters for extended support.
  21. * Pseudo field via Content Types.
  22. * Input filter.
  23. * Tokens:
  24. * Text field tokens.
  25. * URL tokens.
  26. * User vCard tokens.
  27. * Drupal API Theme() call.
  28. * Blocks:
  29. * Node URL block - Creates a Mobile Code of the current Node URL.
  30. * User vCard - Uses the vCard module to provide a vCard Mobile Code from a
  31. Nodes Author or a users profile.
  32. * Mobile Code generator - An Admin module optimized helper block.
  33. * Support for:
  34. * Drupal core Image module - Use an Image style on the Mobile Codes.
  35. * Shorten module - Shorten URLs in Mobile Codes.
  36. * Variable module - Configure the settings via various methods.
  37. Required modules
  38. --------------------------------------------------------------------------------
  39. * Chaos tool suite module.
  40. Recommended modules
  41. --------------------------------------------------------------------------------
  42. * Custom Formatters module.
  43. * Drupal core Image module.
  44. * Libraries API module.
  45. Configuration
  46. --------------------------------------------------------------------------------
  47. All configuration for Mobile Codes can be found at:
  48. Administer > Configuration > Content authoring > Mobile Codes
  49. http://[www.yoursite.com/path/to/drupal]/admin/config/content/mobile_codes
  50. Note: When using the Input filter, be sure to enable the tag on your Text
  51. format or the Mobile Code will be filtered out.
  52. Advanced configuration
  53. --------------------------------------------------------------------------------
  54. * Setting up an internal Provider with the PHP QR Code library:
  55. 1. Download, install and enable the Libraries API module.
  56. http://drupal.org/project/libraries
  57. 2. Download the PHP QR Code library.
  58. http://sourceforge.net/projects/phpqrcode/files/releases/phpqrcode-2010100721_1.1.4.zip/download
  59. 3. Extract the PHP QR Code library to your Libraries directory.
  60. e.g. sites/all/libraries/phpqrcode
  61. 4. Clear cached data from the Perfomance page.
  62. Administer > Configuration > Development > Performance
  63. http://[www.yoursite.com/path/to/drupal]/admin/config/development/performance
  64. Note: Mobile Codes will automatically detect the PHP QR Code library once
  65. installed as above and add a new PHP QR Code Provider to the list.
  66. Makefile entries
  67. --------------------------------------------------------------------------------
  68. For easy downloading of Mobile Codes and it's required/recommended modules
  69. and/or libraries, you can use the following entries in your makefile:
  70. projects[ctools][subdir] = contrib
  71. projects[ctools][version] = 1.3
  72. projects[libraries][subdir] = contrib
  73. projects[libraries][version] = 2.1
  74. libraries[phpqrcode][download][type] = get
  75. libraries[phpqrcode][download][url] = http://sourceforge.net/projects/phpqrcode/files/releases/phpqrcode-2010100721_1.1.4.zip/download