summaryrefslogtreecommitdiff
path: root/docs/devel_guide_src/introduction.tex
blob: 3403d7e36c36dc3a90917b21583e0b804bf8567d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Introduction}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Who should read this Guide?}

The Cheetah Developers' Guide is for those who want to learn how Cheetah works
internally, or wish to modify or extend Cheetah.  It is assumed that
you've read the Cheetah Users' Guide and have an intermediate knowledge of
Python.

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Contents}

This Guide takes a behaviorist approach.  First we'll look at what the
Cheetah compiler generates when it compiles a template definition, and
how it compiles the various \$placeholder features and \#directives.
Then we'll stroll through the files in the Cheetah source distribution
and show how each file contributes to the compilation and/or filling of
templates.  Then we'll list every method/attribute inherited by a template
object.  Finally, we'll describe how to submit bugfixes/enhancements to
Cheetah, and how to add to the documentation.

Appendix A will contain a BNF syntax of the Cheetah template language.


% Local Variables:
% TeX-master: "users_guide"
% End: