You are here

Home » API reference » Mobile Codes 6.2

README.txt in Mobile Codes 6.2

Same filename and directory in other branches
  1. 6 README.txt
  2. 7.2 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:
  * CCK/Views formatters:
    * CCK Text module.
    * FileField module.
    * Link module.
    * plus an example Custom Formatter for extended support.
  * Input filter.
  * 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:
  * Mobile Tools module - Redirect internal Mobile Code URLs to Mobile site URL.
  * Redirecting Click Bouncer module - Track URLs accessed via Mobile Codes.
  * Shorten module - Shorten URLs in Mobile Codes.


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

* Chaos tool suite module.


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

* Custom Formatters module.
* Libraries API module.


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

All configuration for Mobile Codes can be found at:
  Administer > Site configuration > Mobile Codes
  http://[www.yoursite.com/path/to/drupal]/admin/settings/mobile_codes


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 > Site configuration > Performance
       http://[www.yoursite.com/path/to/drupal]/admin/settings/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.

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. 

  6. Mobile Codes was written and is maintained by Stuart Clark (deciphered).

  7. - http://stuar.tc/lark

  8. 

  9. 

  10. Features

  11. --------------------------------------------------------------------------------

  12. 

  13. * User definable and Features exportable Mobile Code Providers and Presets.

  14.   * Defaults provided:

  15.     * Six (6) External Providers.

  16.     * One (1) Internal Provider (see below).

  17.     * Three (3) to five (5) Presets (based on installed modules).

  18. * Render Mobile Codes via:

  19.   * CCK/Views formatters:

  20.     * CCK Text module.

  21.     * FileField module.

  22.     * Link module.

  23.     * plus an example Custom Formatter for extended support.

  24.   * Input filter.

  25.   * Drupal API Theme() call.

  26. * Blocks:

  27.   * Node URL block - Creates a Mobile Code of the current Node URL.

  28.   * User vCard - Uses the vCard module to provide a vCard Mobile Code from a

  29.     Nodes Author or a users profile.

  30.   * Mobile Code generator - An Admin module optimized helper block.

  31. * Support for:

  32.   * Mobile Tools module - Redirect internal Mobile Code URLs to Mobile site URL.

  33.   * Redirecting Click Bouncer module - Track URLs accessed via Mobile Codes.

  34.   * Shorten module - Shorten URLs in Mobile Codes.

  35. 

  36. 

  37. Required modules

  38. --------------------------------------------------------------------------------

  39. 

  40. * Chaos tool suite module.

  41. 

  42. 

  43. Recommended modules

  44. --------------------------------------------------------------------------------

  45. 

  46. * Custom Formatters module.

  47. * Libraries API module.

  48. 

  49. 

  50. Configuration

  51. --------------------------------------------------------------------------------

  52. 

  53. All configuration for Mobile Codes can be found at:

  54.   Administer > Site configuration > Mobile Codes

  55.   http://[www.yoursite.com/path/to/drupal]/admin/settings/mobile_codes

  56. 

  57. 

  58. Advanced configuration

  59. --------------------------------------------------------------------------------

  60. 

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

  62. 

  63.   1. Download, install and enable the Libraries API module.

  64.        http://drupal.org/project/libraries

  65. 

  66.   2. Download the PHP QR Code library.

  67.        http://sourceforge.net/projects/phpqrcode/files/releases/phpqrcode-2010100721_1.1.4.zip/download

  68. 

  69.   3. Extract the PHP QR Code library to your Libraries directory.

  70.        e.g. sites/all/libraries/phpqrcode

  71. 

  72.   4. Clear cached data from the Perfomance page.

  73.        Administer > Site configuration > Performance

  74.        http://[www.yoursite.com/path/to/drupal]/admin/settings/performance

  75. 

  76. 

  77.   Note: Mobile Codes will automatically detect the PHP QR Code library once

  78.         installed as above and add a new PHP QR Code Provider to the list.