Cheetah User’s Guide¶

• Introduction
  • Who should read this Guide?
  • What is Cheetah?
  • What is the philosophy behind Cheetah?
  • Give me an example!
  • Give me an example of a Webware servlet!
  • How mature is Cheetah?
  • Where can I get news?
  • How can I contribute?
  • Acknowledgements
• Vocabulary
• Getting Started
  • Requirements
  • Installation
  • Files
  • Uninstalling
  • The ‘cheetah’ command
  • Testing your installation
  • Quickstart tutorial
• Language Overview
  • Language Constructs - Summary
  • Placeholder Syntax Rules
  • Where can you use placeholders?
  • Are all those dollar signs really necessary?
  • NameMapper Syntax
  • Namespace cascading and the searchList
  • Missing Values
  • Directive Syntax Rules
• Comments
  • Docstring Comments
  • Header Comments
• Generating, Caching and Filtering Output
  • Output from complex expressions: #echo
  • Executing expressions without output: #silent
  • One-line #if
  • Caching Output
  • #raw
  • #include
  • #slurp
  • #indent
  • Ouput Filtering and #filter
• Import, Inheritance, Declaration and Assignment
  • #import and #from directives
  • #extends
  • #implements
  • #set
  • #del
  • #attr
  • #def
  • #block ... #end block
• Flow Control
  • #for ... #end for
  • #repeat ... #end repeat
  • #while ... #end while
  • #if ... #else if ... #else ... #end if
  • #unless ... #end unless
  • #break and #continue
  • #pass
  • #stop
  • #return
• Error Handling
  • #try ... #except ... #end try, #finally, and #assert
  • #errorCatcher and ErrorCatcher objects
• Instructions to the Parser/Compiler
  • #breakpoint
  • #compiler-settings
• Tips, Tricks and Troubleshooting
  • Placeholder Tips
  • Diagnostic Output
  • When to use Python methods
  • Calling superclass methods, and why you have to
  • All methods
  • Optimizing templates
  • PSP-style tags
  • Makefiles
  • Using Cheetah in a Multi-Threaded Application
  • Using Cheetah with gettext
• Using Cheetah with Webware
  • Installing Cheetah on a Webware system
  • Containment vs Inheritance
  • Site frameworks
  • Directory structure
  • Initializing your template-servlet with Python code
  • Form processing
  • Form input, cookies, session variables and web server variables
  • More examples
  • Other Tips
• Non-HTML Output
  • Python source code
• Batteries included: templates and other libraries
  • ErrorCatchers
  • FileUtils
  • Filters
  • SettingsManager
  • Templates
  • Tools
  • Utils
• Visual Editors
• Useful Web Links
  • Cheetah Links
  • Third-party Cheetah Stuff
  • Webware Links
  • Python Links
  • Other Useful Links
• Examples
  • Syntax examples
  • Webware Examples
• Cheetah vs. Other Template Engines
  • Which features are unique to Cheetah
  • Cheetah vs. Velocity
  • Cheetah vs. WebMacro
  • Cheetah vs. Zope’s DTML
  • Cheetah vs. Zope Page Templates
  • Cheetah vs. PHP’s Smarty templates
  • Cheetah vs. PHPLib’s Template class
  • Cheetah vs. PSP, PHP, ASP, JSP, Embperl, etc.