StringTemplate 3 Documentation

• StringTemplate 3.0 Users' Guide as single page (printable)

  StringTemplate 3.0 Users' Guide individual topic pages: Introductory Topics Introduction StringTemplate cheat sheet Defining Templates Setting the expression delimiters Template Groups and subtemplates Group Files Group interfaces Template inheritance Template regions Conditionally included subtemplates Expressions and object rendering Expressions Object rendering Expression options Automatic formatting Auto-indentation Automatic line wrapping Output Filters Template and attribute lookup rules StringTemplate Grammars Debugging Language-specific notes Python Notes Acknowledgements

• Complementary documents:
  • Five minute Introduction

  • StringTemplate Condensed

    • StringTemplate Condensed as a single page

      StringTemplate Condensed individual topics pages: ST condensed -- Introduction ST condensed -- Key topics ST condensed -- Templates and groups ST condensed -- Templates and expressions ST condensed -- File syntax ST condensed -- API annotated ST condensed -- API -- StringTemplate ST condensed -- API -- StringTemplateGroup

  • Tutorials
    • unicode_escapes
    • simple_group_example
    • Building StringTemplate with Maven2

• Release Notes
  • 3.2 Release Notes
  • 3.2.1 Release Notes
  • 3.1 Release Notes
  • 3.0 Release Notes

• StringTemplate FAQ
  • FAQ - General
    • Is there any way to ask a template for a list of all the Attributes it uses?
  • FAQ - StringTemplate groups
    • How can load templates from a group file or directory?
  • FAQ - Miscellaneous
    • Can I use StringTemplate with Perl?
  • FAQ - Expressions
    • How do I distinguish between true, false, and null?
  • FAQ - StringTemplate and the CLR
    • Does ST run on the .NET platform?
    • Does ST run on Mono?
  • FAQ - Attributes
  • FAQ - Syntax
    • How to Allow Double Angle Brackets as a String
    • How to construct separators?

• Tools
  • STST - StringTemplate Standalone Tool

• Prior Versions
  • StringTemplate 2.2 Documentation

• On stringtemplate.org and elsewhere
  • API, javadocs StringTemplate API documentation
  • Bugs
  • Changes
  • Contributed articles
  • Course Notes (TP at USF)

Related material

Principles

• It is highly recommended that you read the (academically-oriented) paper, Enforcing Model-View Separation in Template Engines.
• DRAFT A Functional Language For Generating Structured Text
• Internationalization and Localization of Web Applications In Action
• Language Translation Using ANTLR and StringTemplate
• Intelligent Web Site Page Generation
• The Role of Template Engines in Code Generation

Alerts to Developers

• The StringTemplates distribution includes many unit tests that also represent a useful set of examples. The tests are defined in:

  Java	TestStringTemplate.java
  C#	TestStringTemplate.cs
  Python	TestStringTemplate.py

• Please see the Release Notes, changes, and Bugs page
  • These pages generally discuss the Java version of StringTemplate but, some of the information they contain might apply to other implementations.