From 2d2257c977a5061735ef431abe3c54eab44fc640 Mon Sep 17 00:00:00 2001 From: othermachines Date: Mon, 18 Feb 2013 13:04:53 -0700 Subject: [PATCH] Issue #1704384 by P3t3r, othermachines: Update help documentation in README.txt. --- README.txt | 54 ++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 44 insertions(+), 10 deletions(-) diff --git a/README.txt b/README.txt index 5dc5bca..94f39fb 100644 --- a/README.txt +++ b/README.txt @@ -1,8 +1,8 @@ Custom Tokens ---------------------- -Authors ---- +Authors: +------- Ariel Barreiro (hanoii) http://drupal.org/user/23157 abarrei@gmail.com @@ -11,8 +11,9 @@ ggaspaio@gmail.com Overview: -------- -It gives the user the ability to create custom tokens using standart input filters. -If the php filter is enabled, you can use php code to access token arguments (i.e. the $data array). +It gives the user the ability to create custom tokens using standard input +filters. If the "PHP filter" module is enabled, you can use php code to access +token arguments (i.e. the $data array). See "To create custom For additional options and help elements install the Token module. Token. @@ -21,9 +22,42 @@ For additional options and help elements install the Token module. Installation: ------------ -1. Copy the token_custom directory to the Drupal sites/<...>/modules/ directory. -2. Go to "Administer" -> "Modules" and enable the module. -3. Go to "Administer" -> "Build" -> "Tokens" and start creating the tokens you -need. -4. You need to assign proper permissions to any role you would like to be able -to create additional PHP tokens. +1. Copy the token_custom directory to the Drupal sites/<...>/modules/ + directory. + +2. Go to admin/modules and enable the module. + +Usage: +----- + +A) To create a custom token: + + 1. Go to admin/structure/token-custom. + + 2. Fill in the form fields: + + * Token name: The token's readable name (e.g. "User's favorite color"). + + * Machine name: This is the text for the token (e.g. "favorite-color"). + It must only contain lowercase letters, numbers, and underscores. + + * Token description: A description of the token (e.g. "The favorite + color of the user."). + + * Token type: The token type determines the availability of the token + according to the data in the $data array (e.g. "Users" requires + $data['user']). + + * Content: The output of this token. + +B) To create tokens using PHP: + + 1. Go to admin/modules and enable the "PHP filter" module (core). + + 2. To restrict the filter for certain roles, enable or disable the permission + "Use PHP for settings" at admin/people/permissions. Warning: enable for + trusted roles only! + + 3. When adding a new custom token, select "PHP code" as the text format for + the "Content" field. + -- 1.8.0.msysgit.0