Documentation? [#1057468]

Hi
I am a php developer new to Drupal module development. I've looked at the QR Codes modules and it seems to be the perfect match for a project I am building. However I fail to grasp how to use the module and would love if I could get some code examples.
I am willing to write a documentation page to help other users in my situation.
Thanks in advance.
Richard

Comments

Comment #1

IncrediblyKenzi CreditAttribution: IncrediblyKenzi commented 14 February 2011 at 19:43

Hey Richard,

I'm down to get assistance on this.. we probably need a handbook/documentation page that outlines getting started with the QR code module. By itself (e.g. out of the box) without doing anything, the module is dormant.. You need to activate it through the block configuration page and select "Configure" to tell it what to encode as a QR Code image. The real power of the module comes into play when using token module in conjunction with it, allowing you to create dynamic QR code blocks for the current page, for example.

In terms of developer access, the only useful function would be the theme('qr_codes', ... ) function, which tells QR_Codes to generate a block for use anywhere.

Does this help?

Comment #2

IncrediblyKenzi CreditAttribution: IncrediblyKenzi commented 14 February 2011 at 19:43

Status:

Active

» Needs review

Comment #3

rlustemberg CreditAttribution: rlustemberg commented 14 February 2011 at 19:55

Hi Aaron:
Thanks for your reply!
I already figured out how to use (actually is quite simple), by looking at the issues and learning something about the theme() function. I'll write up a simple how to which perhaps might be of use to other newbies like me :-)
I'll post it when I am less busy, perhaps you'll want to add something I'm missing.
Thanks for the module, it does a great job!
I was using qrlib in another project ... Would there be any advantage in using that library instead of the Google Chart API or the libqrencode code?

Comment #4

IncrediblyKenzi CreditAttribution: IncrediblyKenzi commented 15 February 2011 at 01:49

Status:

Needs review

» Closed (works as designed)

Others may speak on the advantage of libqrencode vs Google Chart API.. haven't done any work with qrlib personally, so can't speak to that.

What I can say is that using libqrencode means one less roundtrip to google, and you don't need to give them your information in order to generate things. Other than that, they perform essentially the same function.