You are here

README.txt in API Tokens 7

Same filename and directory in other branches
  1. 8.2 README.txt
  2. 8 README.txt
-- SUMMARY --

The API Tokens module provides an input filter that allows to replace custom
parametric tokens with rendered content. Each declared token binds to its
handler function, that returns content, token will be replaced with. Token may
contain parameters that will be passed to its handler function.

For example, you can declare a token which will render a current date on each
page reload as follows:
  [api:date/],
or render blocks:
  [api:block["module", "delta"]/],
or even views:
  [api:view["view_name", "display_id"]/] - without arguments
  [api:view["view_name", "display_id", ["arg1", "arg2"]]/] - with arguments.

Each module is able to define its own parametric tokens and corresponding
render functions. Module provides flexible caching mechanism.

Since API tokens accept parameters, it is highly advisable to add all required
checks to your render functions to avoid performance impact and fatal errors.

Note that API Tokens module does not provide any visible functions to the user
on its own, it just provides handling services for other modules.


For a full description of the module, visit the project page:
  http://drupal.org/project/api_tokens

To submit bug reports and feature suggestions, or to track changes:
  http://drupal.org/project/issues/api_tokens


-- REQUIREMENTS --

None.


-- INSTALLATION --

* Install as usual, see https://drupal.org/node/895232 for further information.


-- CONFIGURATION --

* Go to /admin/config/content/formats and enable the API Tokens filter for any
  of your existing text formats or create a new one.

* List of all registered tokens available at admin/config/content/api-tokens.


-- CONTACT --

Current maintainers:
* Alex Zhulin (Alex Zhulin) - https://drupal.org/user/2659881

This project has been sponsored by:
* Blink Reaction
  A leader in Enterprise Drupal Development, delivering robust,
  high-performance websites for dynamic companies. Blink creates scalable and
  flexible web solutions that provide the best in customer experience and meet
  brand, marketing, and business goals.

File

README.txt
View source
  1. -- SUMMARY --
  2. The API Tokens module provides an input filter that allows to replace custom
  3. parametric tokens with rendered content. Each declared token binds to its
  4. handler function, that returns content, token will be replaced with. Token may
  5. contain parameters that will be passed to its handler function.
  6. For example, you can declare a token which will render a current date on each
  7. page reload as follows:
  8. [api:date/],
  9. or render blocks:
  10. [api:block["module", "delta"]/],
  11. or even views:
  12. [api:view["view_name", "display_id"]/] - without arguments
  13. [api:view["view_name", "display_id", ["arg1", "arg2"]]/] - with arguments.
  14. Each module is able to define its own parametric tokens and corresponding
  15. render functions. Module provides flexible caching mechanism.
  16. Since API tokens accept parameters, it is highly advisable to add all required
  17. checks to your render functions to avoid performance impact and fatal errors.
  18. Note that API Tokens module does not provide any visible functions to the user
  19. on its own, it just provides handling services for other modules.
  20. For a full description of the module, visit the project page:
  21. http://drupal.org/project/api_tokens
  22. To submit bug reports and feature suggestions, or to track changes:
  23. http://drupal.org/project/issues/api_tokens
  24. -- REQUIREMENTS --
  25. None.
  26. -- INSTALLATION --
  27. * Install as usual, see https://drupal.org/node/895232 for further information.
  28. -- CONFIGURATION --
  29. * Go to /admin/config/content/formats and enable the API Tokens filter for any
  30. of your existing text formats or create a new one.
  31. * List of all registered tokens available at admin/config/content/api-tokens.
  32. -- CONTACT --
  33. Current maintainers:
  34. * Alex Zhulin (Alex Zhulin) - https://drupal.org/user/2659881
  35. This project has been sponsored by:
  36. * Blink Reaction
  37. A leader in Enterprise Drupal Development, delivering robust,
  38. high-performance websites for dynamic companies. Blink creates scalable and
  39. flexible web solutions that provide the best in customer experience and meet
  40. brand, marketing, and business goals.