diff --git a/tmkproject.rst b/tmkproject.rst index f17e650..89bd35f 100644 --- a/tmkproject.rst +++ b/tmkproject.rst @@ -202,11 +202,19 @@ editing the ``tokens`` file provided with the program distribution. This file is read every time you generate a new project. The left-hand column is the name of the substitution token and the -right-hand column is the substitution text. The right-hand entry can -be any combination of variable references (assuming they are defined) -and literal text. *Bear in mind that this has to make sense to ``sed`` -which is used to do the actual substitutions!* For example, you will -see ``$`` and ``/`` escaped so that ``sed`` does the right thing. +right-hand column is the substitution text. + +The right-hand entry can be any combination of variable references +(assuming they are defined) and literal text. *Bear in mind that this +has to make sense to* ``sed`` *which is used to do the actual +substitutions!* For example, you will see ``$`` and ``/`` escaped so +that ``sed`` does the right thing. This escaping has to be done +appropriately in both the ``tokens`` file and anywhere a variable is +defined that is referenced in a substitution token definition. For +example, ``__WEBSITE__`` refers to ``${WEBSITE}`` which actaully gets +defined in ``mkproject.sh``. If you look there, you will see that all +the forward slashes have been escaped in anticipation of the fact that +we're going to feed the string to ``sed``. OTHER @@ -244,7 +252,7 @@ :: - $Id: tmkproject.rst,v 1.113 2012/06/05 16:50:16 tundra Exp $ + $Id: tmkproject.rst,v 1.114 2012/06/05 17:00:49 tundra Exp $ You can find the latest version of this program at: