You are here

Home » API reference » Examples for Developers 7

README.txt in Examples for Developers 7

Same filename and directory in other branches
  1. 6 README.txt
Examples for Developers
=======================

http://drupal.org/project/examples

What Is This?
-------------

This set of modules is intended to provide working examples of Drupal's
features and APIs.  The modules strive to be simple, well documented and
modification friendly, in order to help developers quickly learn their inner
workings.

These examples are meant to teach you about code-level development for Drupal
7. Some solutions might be better served using a contributed module, so that
you don't end up having to re-invent the wheel in PHP.


How To Use The Examples
-----------------------

There are three main ways to interact with the examples in this project:

1. Enable the modules and use them within Drupal. Not all modules will have
obvious things to see within Drupal. For instance, while the Page and Form API
examples will show you forms, the Database API example will not show you much
within Drupal itself.

2. Read the code. Much effort has gone into making the example code readable,
not only in terms of the code itself, but also the extensive inline comments
and documentation blocks.

3. Browse the code and documentation on the web. There are two main places to
do this:

* https://api.drupal.org/api/examples is the main API site for all of Drupal.
It has all manner of cross-linked references between the example code and the
APIs being demonstrated.

* http://drupalcode.org/project/examples.git allows you to browse the git
repository for the Examples project.


How To Install The Modules
--------------------------

1. Install Examples for Developers (unpacking it to your Drupal
/sites/all/modules directory if you're installing by hand, for example).

2. Enable any Example modules in Admin menu > Site building > Modules.

3. Rebuild access permissions if you are prompted to.

4. Profit!  The examples will appear in your Navigation menu (on the left
sidebar by default; you'll need to reenable it if you removed it).

Now you can read the code and its comments and see the result, experiment with
it, and hopefully quickly grasp how things work.

If you find a problem, incorrect comment, obsolete or improper code or such,
please search for an issue about it at http://drupal.org/project/issues/examples
If there isn't already an issue for it, please create a new one.

File

README.txt
View source 
  1. Examples for Developers

  2. =======================

  3. 

  4. http://drupal.org/project/examples

  5. 

  6. What Is This?

  7. -------------

  8. 

  9. This set of modules is intended to provide working examples of Drupal's

  10. features and APIs.  The modules strive to be simple, well documented and

  11. modification friendly, in order to help developers quickly learn their inner

  12. workings.

  13. 

  14. These examples are meant to teach you about code-level development for Drupal

  15. 7. Some solutions might be better served using a contributed module, so that

  16. you don't end up having to re-invent the wheel in PHP.

  17. 

  18. 

  19. How To Use The Examples

  20. -----------------------

  21. 

  22. There are three main ways to interact with the examples in this project:

  23. 

  24. 1. Enable the modules and use them within Drupal. Not all modules will have

  25. obvious things to see within Drupal. For instance, while the Page and Form API

  26. examples will show you forms, the Database API example will not show you much

  27. within Drupal itself.

  28. 

  29. 2. Read the code. Much effort has gone into making the example code readable,

  30. not only in terms of the code itself, but also the extensive inline comments

  31. and documentation blocks.

  32. 

  33. 3. Browse the code and documentation on the web. There are two main places to

  34. do this:

  35. 

  36. * https://api.drupal.org/api/examples is the main API site for all of Drupal.

  37. It has all manner of cross-linked references between the example code and the

  38. APIs being demonstrated.

  39. 

  40. * http://drupalcode.org/project/examples.git allows you to browse the git

  41. repository for the Examples project.

  42. 

  43. 

  44. How To Install The Modules

  45. --------------------------

  46. 

  47. 1. Install Examples for Developers (unpacking it to your Drupal

  48. /sites/all/modules directory if you're installing by hand, for example).

  49. 

  50. 2. Enable any Example modules in Admin menu > Site building > Modules.

  51. 

  52. 3. Rebuild access permissions if you are prompted to.

  53. 

  54. 4. Profit!  The examples will appear in your Navigation menu (on the left

  55. sidebar by default; you'll need to reenable it if you removed it).

  56. 

  57. Now you can read the code and its comments and see the result, experiment with

  58. it, and hopefully quickly grasp how things work.

  59. 

  60. If you find a problem, incorrect comment, obsolete or improper code or such,

  61. please search for an issue about it at http://drupal.org/project/issues/examples

  62. If there isn't already an issue for it, please create a new one.