summaryrefslogtreecommitdiff
path: root/docs/users_guide_src/output.tex
diff options
context:
space:
mode:
authorhierro <hierro>2001-11-07 09:18:09 +0000
committerhierro <hierro>2001-11-07 09:18:09 +0000
commit5952cd6abe22eb3046328ddc533c97d90fbad5aa (patch)
treef3e232a0d8506d4a9c9cca86937439cbac631b20 /docs/users_guide_src/output.tex
parent5401820263835a9345e066b7ec26bcf0ebe0b8e4 (diff)
downloadpython-cheetah-5952cd6abe22eb3046328ddc533c97d90fbad5aa.tar.gz
Now not recommending a '$' before filter arguments.
Diffstat (limited to 'docs/users_guide_src/output.tex')
-rw-r--r--docs/users_guide_src/output.tex15
1 files changed, 11 insertions, 4 deletions
diff --git a/docs/users_guide_src/output.tex b/docs/users_guide_src/output.tex
index 185e011..6c6d2c3 100644
--- a/docs/users_guide_src/output.tex
+++ b/docs/users_guide_src/output.tex
@@ -211,12 +211,14 @@ the filter just returns a string representation of the placeholder's value,
unless it is \code{'None'}, in which case it returns an empty string.
Certain filters take optional arguments to modify their behaviour. To pass
-arguments, use the long placeholder syntax and precede each argument by a comma.
-For instance, the MaxLen filter takes an argument 'maxlen':
+arguments, use the long placeholder syntax and precede each filter argument by
+a comma. Filter arguments don't take a \code{\$} prefix, to avoid clutter in
+the placeholder tag which already has plenty of dollar signs. For instance,
+the MaxLen filter takes an argument 'maxlen':
\begin{verbatim}
-$\{placeholderName, $maxlen=20\}
-${functionCall($functionArg), $maxlen=$myMaxLen}
+${placeholderName, maxlen=20}
+${functionCall($functionArg), maxlen=$myMaxLen}
\end{verbatim}
To change the output filter, use the \code{'filter'} keyword to the
@@ -291,6 +293,11 @@ for the latest ideas.
%% @@MO: Tavis TODO: fix the description of the Pager filter. It needs a howto.
+%% @@MO: How about using settings to provide default arguments for filters?
+%% Each filter could look up FilterName (or FilterNameDefaults) setting,
+%% whose value would be a dictionary containing keyword/value pairs. These
+%% would be overridden by same-name keys passed by the placeholder.
+
% Local Variables:
% TeX-master: "users_guide"