You are here

Home » API reference » Token 6

README.txt in Token 6

Same filename and directory in other branches
  1. 5 README.txt
  2. 7 README.txt
Description
===========
Token module provides a centralized API for text substitution. Unless
you're installing another Drupal module that requires it, this software
is probably unnecessary.

For more information on tokens see http://groups.drupal.org/tokens

Benefits
========
If you're a Drupal developer, check out API.txt for detailed instructions
on using the Token API. It allows every module to announce the placeholder
tokens they can handle, uses simple caching to prevent duplicated work in
a given page-view, and is pretty lightweight. It's nice. You'll like it.

tokenSTARTER
============
Want to add your own custom tokens to a site? Not sure how to write a 
module? Worry no more, it's now quite easy.

1. Copy and rename the tokenSTARTER.info and tokenSTARTER.module replacing
   every instance of STARTER with a descriptive, appropriate word.

2. Edit the .module file and change hook_token_list and hook_token_values
   to provide whatever additional tokens or logic your site needs.

3. Enable the module and enjoy!

You should also want to read the API.txt.

File

README.txt
View source 
  1. 

  2. Description

  3. ===========

  4. Token module provides a centralized API for text substitution. Unless

  5. you're installing another Drupal module that requires it, this software

  6. is probably unnecessary.

  7. 

  8. For more information on tokens see http://groups.drupal.org/tokens

  9. 

  10. Benefits

  11. ========

  12. If you're a Drupal developer, check out API.txt for detailed instructions

  13. on using the Token API. It allows every module to announce the placeholder

  14. tokens they can handle, uses simple caching to prevent duplicated work in

  15. a given page-view, and is pretty lightweight. It's nice. You'll like it.

  16. 

  17. tokenSTARTER

  18. ============

  19. Want to add your own custom tokens to a site? Not sure how to write a 

  20. module? Worry no more, it's now quite easy.

  21. 

  22. 1. Copy and rename the tokenSTARTER.info and tokenSTARTER.module replacing

  23.    every instance of STARTER with a descriptive, appropriate word.

  24. 

  25. 2. Edit the .module file and change hook_token_list and hook_token_values

  26.    to provide whatever additional tokens or logic your site needs.

  27. 

  28. 3. Enable the module and enjoy!

  29. 

  30. You should also want to read the API.txt.