You are here

README.txt in Grammar Parser Library 7

Same filename and directory in other branches
  1. 7.2 README.txt
CONTENTS OF THIS FILE
---------------------

 * Author
 * Description
 * Installation
 * Usage

AUTHOR
------
Jim Berry ("solotandem", http://drupal.org/user/240748)

DESCRIPTION
-----------
This module provides a library interface to the Grammar Parser library code
available at http://drupal.org/project/grammar_parser. This interface enables
automatic loading of the classes defined in the library. The Drush Make file
included with this project will install this code library for use with the
Libraries API.

INSTALLATION
------------
To use this module, install it and the Libraries module in a modules directory.
See http://drupal.org/node/895232 for further information. Also, download the
Grammar Parser library and extract its files in a libraries directory (e.g.,
sites/all/libraries).

From the modules page on your site, enable this module and that should trigger
enabling its dependent module. Do not enable the Grammar Parser library (it
should not be an option if you place it in a proper libraries directory).

The included Drush Make file provides a convenient method of downloading and
installing the correct versions of the Libraries API (>=2) and the Grammar
Parser (>=1.2,<2.0) dependencies. From a command line, simply invoke:

  drush make --yes --no-core gplib.make

USAGE
-----
To use the Grammar Parser library in a module, add this module as a dependency
in the .info file:

  dependencies[] = gplib

and load the library files before any calls to library code:

  libraries_load('grammar_parser');

See http://drupal.org/node/1342238 for more information on the Libraries API.
For examples of using this module to interface with the Grammar Parser library,
see the Coder Upgrade module (part of the Coder project) and the Grammar Parser
UI module.

File

README.txt
View source
  1. CONTENTS OF THIS FILE
  2. ---------------------
  3. * Author
  4. * Description
  5. * Installation
  6. * Usage
  7. AUTHOR
  8. ------
  9. Jim Berry ("solotandem", http://drupal.org/user/240748)
  10. DESCRIPTION
  11. -----------
  12. This module provides a library interface to the Grammar Parser library code
  13. available at http://drupal.org/project/grammar_parser. This interface enables
  14. automatic loading of the classes defined in the library. The Drush Make file
  15. included with this project will install this code library for use with the
  16. Libraries API.
  17. INSTALLATION
  18. ------------
  19. To use this module, install it and the Libraries module in a modules directory.
  20. See http://drupal.org/node/895232 for further information. Also, download the
  21. Grammar Parser library and extract its files in a libraries directory (e.g.,
  22. sites/all/libraries).
  23. From the modules page on your site, enable this module and that should trigger
  24. enabling its dependent module. Do not enable the Grammar Parser library (it
  25. should not be an option if you place it in a proper libraries directory).
  26. The included Drush Make file provides a convenient method of downloading and
  27. installing the correct versions of the Libraries API (>=2) and the Grammar
  28. Parser (>=1.2,<2.0) dependencies. From a command line, simply invoke:
  29. drush make --yes --no-core gplib.make
  30. USAGE
  31. -----
  32. To use the Grammar Parser library in a module, add this module as a dependency
  33. in the .info file:
  34. dependencies[] = gplib
  35. and load the library files before any calls to library code:
  36. libraries_load('grammar_parser');
  37. See http://drupal.org/node/1342238 for more information on the Libraries API.
  38. For examples of using this module to interface with the Grammar Parser library,
  39. see the Coder Upgrade module (part of the Coder project) and the Grammar Parser
  40. UI module.