You are here

README.txt in Mobile Codes 6

Same filename and directory in other branches
  1. 6.2 README.txt
  2. 7.2 README.txt
Mobile Codes generates Datamatrix or QR Code mobile barcodes that can be read by
many camera phones. The codes can contain URLs, Text or Phone Numbers, making it
easy to pass data directly to a mobile phone.

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


Features
---------

* Input filter.
* CCK/Views formatter.
* Drupal API Theme() call.
* Configurable Presets.


Usage
---------

* via Input Filter:
  [mobilecodes type="type" data="data type" size="size" name="name" tinyurl="tinyurl"]content[/mobilecode]
  [mobilecodes profile="profile"]content[/mobilecode]

* via CCK/Views formatter:
  Select a Mobile Codes preset in a text field display options.

* via theme_mobilecode():
  Use the theme_mobilecode() function at the theme/module level with the
  following format:
  theme('mobilecode', 'content', array(arguments))


Arguments
---------

Arguments to be used by Input Filter and theme_mobilecode().

* preset - Mobile Codes Preset:
  * Default - (module default)
  * User defined

* data - Mobile barcode data type:
  * link - URL (module default)
  * phone - Phone Number
  * text - Text

* type - Mobile barcode type:
  * dm - Datamatrix (module default)
  * qr - QR Code

* data - Mobile barcode data type:
  * link - URL (module default)
  * phone - Phone Number
  * text - Text

* size - Size of mobile barcode:
  * small  - Small
  * medium - Medium (module default)
  * large  - Large

* name - Name of your mobile barcode
  * User defined

* tinyurl - TinyURL behaviour (for URLs only)
  * 0 - Only convert to TinyURL if URL is longer than 60 characters (module default)
  * 1 - Always convert to TinyURL

* content - Data to embed into mobile code (required)
  * User defined

Note: The only required argument is content as all others will default to either
a user defined default or the module defined default, or in the Dev build it
will default to the Default profile.

File

README.txt
View source
  1. Mobile Codes generates Datamatrix or QR Code mobile barcodes that can be read by
  2. many camera phones. The codes can contain URLs, Text or Phone Numbers, making it
  3. easy to pass data directly to a mobile phone.
  4. Mobile Codes was written and is maintained by Stuart Clark (deciphered).
  5. - http://stuar.tc/lark
  6. Features
  7. ---------
  8. * Input filter.
  9. * CCK/Views formatter.
  10. * Drupal API Theme() call.
  11. * Configurable Presets.
  12. Usage
  13. ---------
  14. * via Input Filter:
  15. [mobilecodes type="type" data="data type" size="size" name="name" tinyurl="tinyurl"]content[/mobilecode]
  16. [mobilecodes profile="profile"]content[/mobilecode]
  17. * via CCK/Views formatter:
  18. Select a Mobile Codes preset in a text field display options.
  19. * via theme_mobilecode():
  20. Use the theme_mobilecode() function at the theme/module level with the
  21. following format:
  22. theme('mobilecode', 'content', array(arguments))
  23. Arguments
  24. ---------
  25. Arguments to be used by Input Filter and theme_mobilecode().
  26. * preset - Mobile Codes Preset:
  27. * Default - (module default)
  28. * User defined
  29. * data - Mobile barcode data type:
  30. * link - URL (module default)
  31. * phone - Phone Number
  32. * text - Text
  33. * type - Mobile barcode type:
  34. * dm - Datamatrix (module default)
  35. * qr - QR Code
  36. * data - Mobile barcode data type:
  37. * link - URL (module default)
  38. * phone - Phone Number
  39. * text - Text
  40. * size - Size of mobile barcode:
  41. * small - Small
  42. * medium - Medium (module default)
  43. * large - Large
  44. * name - Name of your mobile barcode
  45. * User defined
  46. * tinyurl - TinyURL behaviour (for URLs only)
  47. * 0 - Only convert to TinyURL if URL is longer than 60 characters (module default)
  48. * 1 - Always convert to TinyURL
  49. * content - Data to embed into mobile code (required)
  50. * User defined
  51. Note: The only required argument is content as all others will default to either
  52. a user defined default or the module defined default, or in the Dev build it
  53. will default to the Default profile.