Detailed Table of Contents   [Show simplified...]

• Preface
  • What is FreeMarker?
  • What should I read?
  • Document conventions
  • Contact
  • About this document
• I   Template Author's Guide
  • 1   Getting Started
    • Template + data-model = output
    • The data-model at a glance
    • The template at a glance
      • Examples of directives
        • The if directive
        • The list directive
        • The include directive
      • Using directives together
      • Dealing with missing variables
  • 2   Values, Types
    • Basics
      • What is a value?
      • What is type?
      • The data-model is a hash
    • The types
      • Scalars
      • Containers
      • Subroutines
        • Methods and functions
        • User-defined directives
        • Function/method versus user-defined directive
      • Miscellaneous
        • Nodes
  • 3   The Template
    • Overall structure
    • Directives
    • Expressions
      • Quick overview (cheat sheet)
      • Specify values directly
        • Strings
        • Numbers
        • Booleans
        • Sequences
        • Ranges
        • Hashes
      • Retrieving variables
        • Top-level variables
        • Retrieving data from a hash
        • Retrieving data from a sequence
        • Special variables
      • String operations
        • Interpolation (or concatenation)
        • Getting a character
        • String slicing (substrings)
      • Sequence operations
        • Concatenation
        • Sequence slicing
      • Hash operations
        • Concatenation
      • Arithmetical calculations
      • Comparison
      • Logical operations
      • Built-ins
      • Method call
      • Handling missing values
        • Default value operator
        • Missing value test operator
      • Parentheses
      • White-space in expressions
      • Operator precedence
    • Interpolations
  • 4   Miscellaneous
    • Defining your own directives
      • Basics
      • Parameters
      • Nested content
      • Macros with loop variables
      • More about user-defined directives and macros
    • Defining variables in the template
    • Namespaces
      • Creating a library
      • Writing the variables of imported namespaces
      • Namespaces and data-model
      • The life-cycle of namespaces
      • Writing libraries for other people
    • White-space handling
      • White-space stripping
      • Using compress directive
    • Alternative (square bracket) syntax
• II   Programmer's Guide
  • 1   Getting Started
    • Create a configuration instance
    • Create a data-model
    • Get the template
    • Merging the template with the data-model
    • Putting all together
  • 2   The Data Model
    • Basics
    • Scalars
      • Difficulties with the "date-like" types
    • Containers
      • Hashes
      • Sequences
      • Collections
    • Methods
    • Directives
      • Example 1
      • Example 2
      • Notices
    • Node variables
    • Object wrappers
      • The default object wrapper
      • Custom object wrapping example
  • 3   The Configuration
    • Basics
    • Shared variables
    • Settings
    • Template loading
      • Template loaders
        • Built-in template loaders
        • Loading templates from multiple locations
        • Loading templates from other sources
        • The template name (template path)
      • Template caching
    • Error handling
      • The possible exceptions
      • Customizing the behavior regarding TemplatException-s
      • Explicit error handling in templates
    • The "incompatible improvements" setting
      • What does it do
      • How to set it
  • 4   Miscellaneous
    • Variables, scopes
    • Charset issues
      • The charset of the input
      • The charset of the output
    • Multithreading
    • Bean wrapper
      • TemplateHashModel functionality
      • A word on security
      • TemplateScalarModel functionality
      • TemplateNumberModel functionality
      • TemplateCollectionModel functionality
      • TemplateSequenceModel functionality
      • TemplateMethodModel functionality
      • Unwrapping rules
      • Accessing static methods
      • Accessing enums
    • Logging
      • Logging library selection
      • Logging categories
    • Using FreeMarker with servlets
      • Using FreeMarker for ``Model 2''
      • Including content from other web application resources
      • Using JSP custom tags in FTL
      • Embed FTL into JSP pages
    • Configuring security policy for FreeMarker
    • Legacy XML wrapper implementation
      • TemplateScalarModel
      • TemplateCollectionModel
      • TemplateSequenceModel
      • TemplateHashModel
      • TemplateMethodModel
      • Namespace handling
    • Using FreeMarker with Ant
    • Jython wrapper
      • TemplateHashModel functionality
      • TemplateScalarModel functionality
      • TemplateBooleanModel functionality
      • TemplateNumberModel functionality
      • TemplateSequenceModel functionality
• III   Template Language Reference
  • 1   Built-in Reference
    • Alphabetical index
    • Built-ins for strings
      • boolean
      • cap_first
      • capitalize
      • chop_linebreak
      • contains
      • date, time, datetime
      • ends_with
      • ensure_ends_with
      • ensure_starts_with
      • groups
      • html
      • index_of
      • j_string
      • js_string
      • json_string
      • keep_after
      • keep_after_last
      • keep_before
      • keep_before_last
      • last_index_of
      • left_pad
      • length
      • lower_case
      • matches
      • number
      • replace
      • right_pad
      • remove_beginning
      • remove_ending
      • rtf
      • split
      • starts_with
      • string (when used with a string value)
      • substring (deprecated)
      • trim
      • uncap_first
      • upper_case
      • url
      • url_path
      • word_list
      • xhtml
      • xml
      • Common flags
    • Built-ins for numbers
      • abs
      • c (when used with numerical value)
      • is_infinite
      • is_nan
      • lower_abc
      • round, floor, ceiling
      • string (when used with a numerical value)
      • upper_abc
    • Built-ins for date/time/date-time values
      • date, time, datetime (when used with a date/time/date-time value)
      • date_if_unknown, time_if_unknown, datetime_if_unknown
      • iso_...
      • string (when used with a date/time/date-time value)
    • Built-ins for booleans
      • c (when used with boolean)
      • string (when used with a boolean value)
    • Built-ins for sequences
      • chunk
      • first
      • join
      • last
      • reverse
      • seq_contains
      • seq_index_of
      • seq_last_index_of
      • size
      • sort
      • sort_by
    • Built-ins for hashes
      • keys
      • values
    • Built-ins for nodes (for XML)
      • ancestors
      • children
      • node_name
      • node_namespace
      • node_type
      • parent
      • root
    • Seldom used and expert built-ins
      • api, has_api
      • byte, double, float, int, long, short
      • eval
      • has_content
      • interpret
      • is_...
      • namespace
      • new
      • number_to_date, number_to_time, number_to_datetime
  • 2   Directive Reference
    • Alphabetical index
    • assign
      • Synopsis
      • Description
    • attempt, recover
      • Synopsis
      • Description
    • compress
      • Synopsis
      • Description
    • escape, noescape
      • Synopsis
      • Description
    • flush
      • Synopsis
      • Description
    • ftl
      • Synopsis
      • Description
    • function, return
      • Synopsis
      • Description
    • global
      • Synopsis
      • Description
    • if, else, elseif
      • Synopsis
      • Description
    • import
      • Synopsis
      • Description
    • include
      • Synopsis
      • Description
        • Using acquisition
        • Localized lookup
    • list, break
      • Synopsis
      • Description
    • local
      • Synopsis
      • Description
    • macro, nested, return
      • Synopsis
      • Description
        • nested
        • return
    • noparse
      • Synopsis
      • Description
    • nt
      • Synopsis
      • Description
    • setting
      • Synopsis
      • Description
    • stop
      • Synopsis
      • Description
    • switch, case, default, break
      • Synopsis
      • Description
    • t, lt, rt
      • Synopsis
      • Description
    • User-defined directive (<@...>)
      • Synopsis
      • Description
        • End-tag
        • Loop variables
        • Positional parameter passing
    • visit, recurse, fallback
      • Synopsis
      • Description
        • Visit
        • Recurse
        • Fallback
  • 3   Special Variable Reference
  • 4   Reserved names in FTL
  • 5   Deprecated FTL constructs
    • List of deprecated directives
    • List of deprecated built-ins
    • Old-style macro and call directives
      • Synopsis
      • Description
    • Transform directive
      • Synopsis
      • Description
    • Old FTL syntax
    • #{...}: Numerical interpolation
      • Synopsis
      • Description
• IV   XML Processing Guide
  • Preface
  • 1   Exposing XML documents
    • The DOM tree
    • Putting the XML into the data-model
  • 2   Imperative XML processing
    • Basics
      • Accessing elements by name
      • Accessing attributes
      • Exploring the tree
      • Using XPath expressions
      • XML namespaces
      • Don't forget escaping!
    • Details
      • Node sequences
  • 3   Declarative XML processing
    • Basics
    • Details
      • Default handlers
      • Visiting a single node
      • XML namespaces
• V   Appendixes
  • A   FAQ
  • B   Version history
    • 2.3.22
      • Changes on the FTL side
      • Changes on the Java side
      • Notes
    • 2.3.21
      • Changes on the FTL side
      • Changes on the Java side
      • Other changes
    • 2.3.20
      • Changes on the FTL side
      • Changes on the Java side
      • Other changes
    • 2.3.19
      • Changes on the FTL side
      • Changes on the Java side
    • 2.3.18
      • Changes on the Java side
      • Other changes
    • 2.3.17
      • Changes on the FTL side
      • Changes on the Java side
      • Other changes
    • 2.3.16
      • Changes on the Java side
      • Changes on the FTL side
    • 2.3.15
      • Changes on the FTL side
      • Changes on the Java side
    • 2.3.14
      • Changes on the FTL side
      • Changes on the Java side
    • 2.3.13
      • Changes on the FTL side
      • Changes on the Java side
    • 2.3.12
      • Changes on the Java side
    • 2.3.11
      • Changes on the FTL side
      • Changes on the Java side
      • Documentation changes
    • 2.3.10
      • Changes on the Java side
      • Changes on the FTL side
    • 2.3.9
      • Changes on the Java side
    • 2.3.8
      • Changes on the Java side
    • 2.3.7
      • Changes on the Java side
      • Changes on the FTL side
    • 2.3.7 RC1
      • Changes on the Java side
      • Changes on the FTL side
    • 2.3.6
      • Changes on the Java side
    • 2.3.5
      • Changes on the FTL side
      • Changes on the Java side
    • 2.3.4
      • Changes on the FTL side
      • Changes on the Java side
      • Other changes
    • 2.3.3
      • Changes on the FTL side
      • Changes on the Java side
      • Other changes
    • 2.3.2
      • Changes on the Java side
    • 2.3.1
      • Possible backward compatibility issue
      • Changes on the FTL side
      • Changes on the Java side
      • Other changes
      • The history of the releases before the final version
        • Differences between the preview release and final release
    • 2.3
      • Non backward-compatible changes!
      • Changes on the FTL side
      • Changes on the Java side
      • Other changes
      • The history of the releases before the final version
        • Differences between the final release and Release Candidate 4
        • Differences between the Release Candidate 4 and Release Candidate 3
        • Differences between the Release Candidate 3 and Release Candidate 2
        • Differences between the Release Candidate 2 and Release Candidate 1
        • Differences between the Release Candidate 1 and Preview 16 releases
        • Differences between the Preview 16 and Preview 15 releases
        • Differences between the Preview 15 and Preview 14 releases
        • Differences between the Preview 14 and Preview 13 releases
        • Differences between the Preview 13 and Preview 12 releases
        • Differences between the Preview 12 and Preview 11 releases
        • Differences between the Preview 11 and Preview 10 releases
        • Differences between the Preview 10 and Preview 9 releases
        • Differences between the Preview 9 and Preview 8 releases
        • Differences between the Preview 8 and Preview 7 releases
        • Differences between the Preview 7 and Preview 6 releases
        • Differences between the Preview 6 and Preview 5 releases
        • Differences between the Preview 5 and Preview 4 releases
        • Differences between the Preview 4 and Preview 3 releases
        • Differences between the Preview 3 and Preview 2 releases
        • Differences between the Preview 2 and Preview 1 releases
    • 2.2.8
      • Changes on the FTL side
      • Changes on the Java side
      • Other changes
    • 2.2.7
      • Changes on the Java side
    • 2.2.6
      • Changes on the FTL side
      • Changes on the Java side
      • Other changes
    • 2.2.5
      • Changes on the Java side
    • 2.2.4
      • Changes on the Java side
      • Other changes
    • 2.2.3
      • Changes on the FTL side
      • Changes on the Java side
    • 2.2.2
      • Changes on the Java side
    • 2.2.1
      • Changes on the FTL side
      • Changes on the Java side
    • 2.2
      • Non backward-compatible changes!
      • Changes in FTL (FreeMarker Template Language)
      • Changes on the Java side
      • Other changes
      • The history of the releases before the final version
        • Differences between the final and RC2 releases
        • Differences between the RC2 and RC1 releases
        • Differences between the Preview 2 and RC1 releases
        • Differences between the Preview 1 and Preview 2 releases
    • 2.1.5
      • Changes on the Java side
    • 2.1.4
      • Changes on the Java side
    • 2.1.3
      • Changes on the FTL side
      • Other changes
    • 2.1.2
      • Changes in FTL (FreeMarker Template Language)
      • Other changes
    • 2.1.1
      • Changes in FTL (FreeMarker Template Language)
      • Changes on the Java side
    • 2.1
      • Changes in FTL (FreeMarker Template Language)
      • Changes on the Java side
      • Other changes
      • Differences between the RC1 and final release
    • 2.01
    • 2.0
      • Bugfixes
      • Changes to the Template language
      • Changes to the API
      • Miscellany
    • 2.0 RC3
      • Bug Fixes
      • Changes to the Template Language
      • API changes
    • 2.0 RC2
      • Changes to Template Language
      • API Changes
    • 2.0 RC1
      • Support for Numerical operations, both arithmetic and boolean, as well as numerical ranges.
      • API Changes
      • Syntactical Miscellany
  • C   Installing FreeMarker
  • D   Legal
    • License
    • Export Control
• Glossary
• Alphabetical Index