[Summary view] [Print] [Text view]

   1  $Id: README.txt,v 1.1.6.1 2009/04/19 21:31:24 greggles Exp $
   2  
   3  Description
   4  ===========
   5  Token module provides a centralized API for text substitution. Unless
   6  you're installing another Drupal module that requires it, this software
   7  is probably unnecessary.
   8  
   9  For more information on tokens see http://groups.drupal.org/tokens
  10  
  11  Benefits
  12  ========
  13  If you're a Drupal developer, check out API.txt for detailed instructions
  14  on using the Token API. It allows every module to announce the placeholder
  15  tokens they can handle, uses simple caching to prevent duplicated work in
  16  a given page-view, and is pretty lightweight. It's nice. You'll like it.
  17  
  18  tokenSTARTER
  19  ============
  20  Want to add your own custom tokens to a site? Not sure how to write a 
  21  module? Worry no more, it's now quite easy.
  22  
  23  1. Copy and rename the tokenSTARTER.info and tokenSTARTER.module replacing
  24     every instance of STARTER with a descriptive, appropriate word.
  25  
  26  2. Edit the .module file and change hook_token_list and hook_token_values
  27     to provide whatever additional tokens or logic your site needs.
  28  
  29  3. Enable the module and enjoy!
  30  
  31  You should also want to read the API.txt.