-
-
- - - -
-
-

Alphabetical Index

-
-

-$ | # | < | A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | R | S | T | U | V | W | X

- -
- -

$

-
-
- ${...},  Interpolations -
-
-
- -

#

-
-
- #,  Overall structure, -Directives -
-
- #{...},  #{...}: Numerical interpolation -
-
-
- -

<

-
-
- <#...>,  Directives -
-
- <#--...-->,  Overall structure -
-
-
- -

A

-
-
- ABC,  lower_abc, -upper_abc -
-
- abs built-in,  abs -
-
- absolute value,  abs -
-
- acquisition,  Using acquisition -
-
- adding hashes,  Concatenation -
-
- adding sequences,  Concatenation -
-
- adding strings,  Interpolation and concatenation -
-
- addition,  Arithmetical calculations -
-
- alphabetical ordinals,  lower_abc, -upper_abc -
-
- alternative syntax,  Alternative (square bracket) syntax -
-
- ancestors built-in,  ancestors -
-
- and,  Logical operations -
-
- ant task,  Using FreeMarker with Ant -
-
- api built-in,  api, has_api -
-
- arithmetic,  Arithmetical calculations -
-
- assign directive,  assign -
-
- attempt directive,  attempt, recover -
-
- auto_esc,  Special Variable Reference -
-
- auto-escaping,  Auto-escaping and output formats, -Associating output formats with templates, -autoesc, -noautoesc, -outputformat -
-
- autoesc directive,  autoesc -
-
-
- -

B

-
-
- backward compatibility,  The "incompatible improvements" setting -
-
- beans
-
-
wrapping, Bean wrapper
-
-
- BeansWrapper,  Bean wrapper -
-
- boolean
-
-
built-ins, Built-ins for booleans
-
Java side, Scalars
-
literal, Booleans
-
operations, Logical operations
-
printing, string (when used with a boolean value)
-
the FTL value type, Scalars
-
-
- boolean_format,  setting -
-
- boolean built-in,  boolean -
-
- break directive,  list, else, items, sep, break, -switch, case, default, break -
-
- built-in,  Built-ins, -Built-in Reference, -Alphabetical index -
-
- byte built-in,  byte, double, float, int, long, short -
-
-
- -

C

-
-
- caching,  Template caching -
-
- call a method,  Method call -
-
- cap_first built-in,  cap_first -
-
- capitalize built-in,  capitalize -
-
- case directive,  switch, case, default, break -
-
- catch-all parameter,  macro, nested, return -
-
- c built-in,  c (when used with numerical value), -c (when used with boolean) -
-
- ceiling built-in,  round, floor, ceiling -
-
- charAt,  Getting a character -
-
- charset,  Charset issues, -ftl -
-
- children built-in,  children -
-
- chop_linebreak built-in,  chop_linebreak -
-
- chunk built-in,  chunk -
-
- classic_compatible,  setting -
-
- collection
-
-
Java side, Containers
-
the FTL value type, Containers
-
-
- columnar printing of sequences,  chunk -
-
- command-line,  Using FreeMarker with Ant -
-
- comment,  Overall structure -
-
- comparison operators,  Comparison -
-
- compress directive,  compress -
-
- concatenate hashes,  Concatenation -
-
- concatenate sequences,  Concatenation -
-
- concatenate strings,  Interpolation and concatenation -
-
- configuration,  Create a configuration instance -
-
- Configuration,  The Configuration -
-
- constant,  Specify values directly -
-
- containers
-
-
Java side, Containers
-
-
- contains built-in,  contains -
-
- converting between types,  boolean, -date, time, datetime, -number, -c (when used with numerical value), -string (when used with a numerical value), -date, time, datetime (when used with a date/time/date-time - value), -string (when used with a date/time/date-time value), -c (when used with boolean), -string (when used with a boolean value), -byte, double, float, int, long, short, -number_to_date, number_to_time, number_to_datetime -
-
- converting date to long,  byte, double, float, int, long, short -
-
- converting date to string,  string (when used with a date/time/date-time value) -
-
- converting long to date,  number_to_date, number_to_time, number_to_datetime -
-
- converting string to boolean,  boolean -
-
- converting string to date,  date, time, datetime -
-
- converting string to number,  number -
-
- converting string to time,  date, time, datetime -
-
- converting time to string,  string (when used with a date/time/date-time value) -
-
- counter built-in,  counter -
-
- current_template_name,  Special Variable Reference -
-
- current date-time,  Special Variable Reference -
-
- custom directive,  Defining your own directives -
-
- custom object wrapper,  Custom object wrapping example -
-
- custom tags,  Using FreeMarker with servlets -
-
-
- -

D

-
-
- data-model,  Template + data-model = output -
-
-
assembling with Java, Create a data-model
-
assembling with Java, without object wrapper, Basics
-
-
- date
-
-
built-ins, Built-ins for date/time/date-time values
-
Java API related difficulties, Scalars
-
Java side, Scalars
-
the FTL value type, Scalars
-
-
- date_format,  setting -
-
- date built-in,  date, time, datetime, -date, time, datetime (when used with a date/time/date-time - value) -
-
- datetime
-
-
built-ins, Built-ins for date/time/date-time values
-
-
- date-time
-
-
the FTL value type, Scalars
-
-
- datetime_format,  setting -
-
- datetime built-in,  date, time, datetime, -date, time, datetime (when used with a date/time/date-time - value) -
-
- date to long,  byte, double, float, int, long, short -
-
- date to string,  string (when used with a date/time/date-time value) -
-
- default built-in,  List of deprecated built-ins -
-
- default directive,  switch, case, default, break -
-
- DefaultObjectWrapper,  The default object wrapper -
-
-
extending, Custom object wrapping example
-
-
- default value operator,  Default value operator -
-
- defining macro,  Defining your own directives -
-
- deprecated,  Deprecated FTL constructs -
-
- directive,  Directives, -Directive Reference, -Alphabetical index -
-
-
the FTL value type, User-defined directives
-
user-defined, Defining your own directives
-
-
- directives
-
-
Java side, Directives
-
-
- division,  Arithmetical calculations -
-
- double built-in,  byte, double, float, int, long, short -
-
-
- -

E

-
-
- else directive,  if, else, elseif -
-
- else directive inside list,  list, else, items, sep, break -
-
- elseif directive,  if, else, elseif -
-
- encoding,  Charset issues, -ftl -
-
-
URL, url
-
URL path, url_path
-
-
- ends_with built-in,  ends_with -
-
- ensure_ends_with built-in,  ensure_ends_with, -ensure_starts_with -
-
- enum,  Accessing enums -
-
- error,  Special Variable Reference -
-
- error handling,  Handling missing values, -Error handling, -attempt, recover -
-
- escape directive,  escape, noescape (deprecated) -
-
- escape sequences,  Strings -
-
- escaping,  Auto-escaping and output formats, -autoesc, -noautoesc, -outputformat -
-
-
output, html (deprecated), rtf (deprecated), xhtml (deprecated), xml (deprecated)
-
URL, url
-
URL path, url_path
-
-
- esc built-in,  esc -
-
- eval,  eval -
-
- evaluate string,  eval -
-
- exception handling,  Error handling -
-
- existence test operator,  Missing value test operator -
-
- exists built-in,  List of deprecated built-ins -
-
- expression,  Expressions -
-
- extended Java decimal format,  Extended Java decimal format -
-
-
- -

F

-
-
- fallback directive,  visit, recurse, fallback -
-
- FAQ,  FAQ -
-
- first built-in,  first -
-
- float built-in,  byte, double, float, int, long, short -
-
- floor built-in,  round, floor, ceiling -
-
- flush directive,  flush -
-
- format
-
-
boolean, c (when used with boolean), string (when used with a boolean value), setting
-
date, string (when used with a date/time/date-time value), setting
-
date-time, string (when used with a date/time/date-time value)
-
number, c (when used with numerical value), string (when used with a numerical value), setting
-
time, string (when used with a date/time/date-time value)
-
timestamp, string (when used with a date/time/date-time value)
-
-
- format; boolean,  then -
-
- FTL,  Overall structure -
-
- ftl directive,  ftl -
-
- FTL tag,  Overall structure, -Directives -
-
- function directive,  function, return -
-
-
- -

G

-
-
- get character,  Getting a character -
-
- global directive,  global -
-
- groups built-in,  groups -
-
-
- -

H

-
-
- handling null-s,  Handling missing values -
-
- has_api built-in,  api, has_api -
-
- has_content built-in,  has_content -
-
- has_next built-in,  has_next -
-
- hash
-
-
accessing subvariable, Retrieving data from a hash
-
built-ins, Built-ins for hashes
-
concatenate, Concatenation
-
Java side, Containers
-
key type, FAQ
-
literal, Hashes
-
modify, FAQ
-
operations, Hash operations
-
the FTL value type, Containers
-
-
- header,  ftl -
-
- html built-in,  html (deprecated) -
-
- HTML encoding,  Auto-escaping and output formats -
-
- HTML escaping,  Auto-escaping and output formats -
-
- HTTP,  Using FreeMarker with servlets -
-
-
- -

I

-
-
- if_exists built-in,  List of deprecated built-ins -
-
- if directive,  if, else, elseif -
-
- import directive,  import -
-
- include
-
-
JSP, Including content from other web application - resources
-
servlet, Including content from other web application - resources
-
-
- include directive,  include -
-
- incompatible_improvements,  The "incompatible improvements" setting -
-
- incompatibleImprovements,  The "incompatible improvements" setting -
-
- incompatible improvements,  The "incompatible improvements" setting -
-
- incomplatible_improvements,  Special Variable Reference -
-
- index_of built-in,  index_of -
-
- index built-in,  index -
-
- infinite,  is_infinite -
-
- install,  Installing FreeMarker -
-
- instantiating variable,  new -
-
- int built-in,  byte, double, float, int, long, short -
-
- integer division,  Arithmetical calculations -
-
- integer part,  Arithmetical calculations -
-
- interpolation,  Overall structure, -Interpolation and concatenation, -Interpolations -
-
- interpret built-in,  interpret -
-
- is_... built-in,  is_... -
-
- is_even_item built-in,  is_even_item -
-
- is_first built-in,  is_first -
-
- is_infinte built-in,  is_infinite -
-
- is_last built-in,  is_last -
-
- is_nan built-in,  is_nan -
-
- is_odd_item built-in,  is_odd_item -
-
- is null,  Missing value test operator -
-
- iso_... built-ins,  iso_... -
-
- ISO 8601,  setting -
-
- ISO 8601 parsing,  date, time, datetime -
-
- iso built-in,  iso_... -
-
- item_cycle built-in,  item_cycle -
-
- item_parity_cap built-in,  item_parity_cap -
-
- item_parity built-in,  item_parity -
-
- items directive,  list, else, items, sep, break -
-
- iteration state,  list, else, items, sep, break -
-
-
- -

J

-
-
- j_string built-in,  j_string -
-
- JDBC time zone,  setting -
-
- join built-in,  join -
-
- joining hashes,  Concatenation -
-
- joining sequences,  Concatenation -
-
- joining strings,  Interpolation and concatenation -
-
- js_string built-in,  js_string -
-
- json_string built-in,  json_string -
-
- JSP,  Using FreeMarker with servlets, -FAQ -
-
-
include, Including content from other web application - resources
-
taglib, Using FreeMarker with servlets, Using FreeMarker with servlets
-
-
- jython
-
-
wrapping, Jython wrapper
-
-
-
- -

K

-
-
- keep_after_last built-in,  keep_after_last -
-
- keep_after built-in,  keep_after -
-
- keep_before_last built-in,  keep_before_last -
-
- keep_before built-in,  keep_before -
-
- keys built-in,  keys -
-
-
- -

L

-
-
- lang,  Special Variable Reference -
-
- language,  Special Variable Reference -
-
- last_index_of built-in,  last_index_of -
-
- last built-in,  last -
-
- left_pad built-in,  left_pad -
-
- length built-in,  length -
-
- libraries,  Namespaces -
-
- license,  License -
-
- list directive,  list, else, items, sep, break -
-
- listing state,  list, else, items, sep, break -
-
- literal,  Specify values directly -
-
-
boolean, Booleans
-
hash, Hashes
-
-
- loading templates,  Template loading -
-
- local directive,  local -
-
- locale,  setting, -Special Variable Reference -
-
- locale_object,  Special Variable Reference -
-
- localization,  Localized lookup -
-
- local variable,  Defining variables in the template -
-
- Log4j2,  Logging -
-
- logging,  Logging -
-
- logical operations,  Logical operations -
-
- long built-in,  byte, double, float, int, long, short -
-
- long to date,  number_to_date, number_to_time, number_to_datetime -
-
- loop variable,  Macros with loop variables, -Defining variables in the template -
-
- lower_abc built-in,  lower_abc -
-
- lower_case built-in,  lower_case -
-
- lt directive,  t, lt, rt -
-
-
- -

M

-
-
- macro,  Defining your own directives -
-
-
the FTL value type, User-defined directives
-
-
- macro directive,  macro, nested, return -
-
- main_template_name,  Special Variable Reference -
-
- markup_string built-in,  markup_string -
-
- markup output
-
-
the FTL value type, Markup output
-
-
- matches built-in,  matches -
-
- math,  Arithmetical calculations -
-
- merging,  Merging the template with the data-model -
-
- method
-
-
call, Method call
-
defining with FTL, function, return
-
Java side, Methods
-
the FTL value type, Methods and functions
-
-
- MIME type,  Auto-escaping and output formats -
-
- missing value test operator,  Missing value test operator -
-
- missing variable,  Handling missing values -
-
- Model 2,  Using FreeMarker with servlets -
-
- modify hashes,  FAQ -
-
- modify sequences,  FAQ -
-
- modulus,  Arithmetical calculations -
-
- multithreading,  Multithreading -
-
- Multi-typed value,  Basics -
-
-
- -

N

-
-
- namespace built-in,  namespace -
-
- namespaces,  Namespaces -
-
- NaN,  is_nan -
-
- nested directive,  macro, nested, return -
-
- new built-in,  new -
-
- new FTL syntax,  Old FTL syntax -
-
- next_sibling built-in,  next_sibling -
-
- no_esc built-in,  no_esc -
-
- noautoesc directive,  noautoesc -
-
- node
-
-
built-ins, Built-ins for nodes (for XML)
-
Java side, Node variables
-
the FTL value type, Nodes
-
-
- node_name built-in,  node_name -
-
- node_namespace built-in,  node_namespace -
-
- node_type built-in,  node_type -
-
- noescape directive,  escape, noescape (deprecated) -
-
- noparse directive,  noparse -
-
- not,  Logical operations -
-
- now,  Special Variable Reference -
-
- nt directive,  nt -
-
- null,  Handling missing values, -FAQ -
-
- number
-
-
built-ins, Built-ins for numbers
-
Java side, Scalars
-
literal, Numbers
-
the FTL value type, Scalars
-
-
- number_format,  setting -
-
- number_to_date built-in,  number_to_date, number_to_time, number_to_datetime -
-
- number_to_datetime built-in,  number_to_date, number_to_time, number_to_datetime -
-
- number_to_time built-in,  number_to_date, number_to_time, number_to_datetime -
-
- number built-in,  number -
-
- numerical range expression,  Sequences -
-
- numerical sequence,  Sequences -
-
-
- -

O

-
-
- object wrapper,  Basics, -Object wrappers -
-
-
custom, Custom object wrapping example
-
default, The default object wrapper
-
-
- old FTL syntax,  Old FTL syntax -
-
- operator precedence,  Operator precedence -
-
- or,  Logical operations -
-
- output
-
-
generate with Java, Merging the template with the data-model
-
-
- output_encoding,  setting -
-
- output_format,  Special Variable Reference -
-
- output charset,  Charset issues, -url, -Special Variable Reference -
-
- output encoding,  Charset issues, -url, -Special Variable Reference -
-
- output format,  Output formats, -Associating output formats with templates, -Special Variable Reference -
-
- outputformat directive,  outputformat -
-
-
- -

P

-
-
- padding,  left_pad, -right_pad -
-
- parent built-in,  parent -
-
- parentheses,  Parentheses -
-
- parse string as boolean,  boolean -
-
- parse string as number,  number -
-
- parsing string as date,  date, time, datetime -
-
- parsing string as time,  date, time, datetime -
-
- path,  Template loading -
-
- positional parameter passing,  Positional parameter passing -
-
- precedence,  Operator precedence -
-
- previous_sibling built-in,  previous_sibling -
-
-
- -

R

-
-
- range expression,  Sequences -
-
- raw string literal,  Strings -
-
- recover directive,  attempt, recover -
-
- recurse directive,  visit, recurse, fallback -
-
- recursion
-
-
iterate, visit, recurse, fallback
-
-
- regular expression
-
-
built-ins, Common flags
-
-
- remove_beginning built-in,  remove_beginning -
-
- remove_ending built-in,  remove_ending -
-
- replace built-in,  replace -
-
- reserved name,  Reserved names in FTL -
-
- return directive,  function, return, -macro, nested, return -
-
- reverse built-in,  reverse -
-
- right_pad built-in,  right_pad -
-
- root built-in,  root -
-
- round built-in,  round, floor, ceiling -
-
- rounding,  round, floor, ceiling -
-
- rt directive,  t, lt, rt -
-
- rtf built-in,  rtf (deprecated) -
-
-
- -

S

-
-
- scalar
-
-
Java side, Scalars
-
-
- scopes,  Variables, scopes -
-
- security,  Configuring security policy for FreeMarker -
-
-
user-provided templates, FAQ
-
-
- sep directive,  list, else, items, sep, break -
-
- seq_contains built-in,  seq_contains -
-
- seq_index_of built-in,  seq_index_of -
-
- seq_last_index_of built-in,  seq_last_index_of -
-
- sequence
-
-
accessing subvariable, Retrieving data from a sequence
-
built-ins, Built-ins for sequences
-
concatenate, Concatenation
-
iterate, list, else, items, sep, break
-
Java side, Containers
-
literal, Sequences
-
modify, FAQ
-
operations, Sequence operations
-
slice, Sequence slicing
-
sorting, sort, sort_by
-
the FTL value type, Containers
-
-
- sequence slice,  Sequence slicing -
-
- servlet
-
-
include, Including content from other web application - resources
-
-
- Servlet,  Using FreeMarker with servlets -
-
- setting,  Settings -
-
- setting directive,  setting -
-
- shared variable,  Shared variables -
-
- short built-in,  byte, double, float, int, long, short -
-
- size built-in,  size -
-
- SLF4J,  Logging -
-
- sort_by built-in,  sort_by -
-
- sort built-in,  sort -
-
- special variable,  Special Variable Reference -
-
- special variables,  Special variables -
-
- split built-in,  split -
-
- square bracket syntax,  Alternative (square bracket) syntax -
-
- starts_with built-in,  starts_with -
-
- static method
-
-
accessing from templates, Bean wrapper
-
-
- stop directive,  stop -
-
- storing templates,  Template loading -
-
- strict syntax,  Old FTL syntax -
-
- string
-
-
built-ins, Built-ins for strings
-
concatenate, Interpolation and concatenation
-
interpolation, Interpolation and concatenation
-
Java side, Scalars
-
literal, Strings
-
operations, String operations
-
slice, String slicing (substrings)
-
substring, String slicing (substrings)
-
the FTL value type, Scalars
-
-
- string built-in,  string (when used with a numerical value), -string (when used with a date/time/date-time value), -string (when used with a boolean value) -
-
- string slicing,  String slicing (substrings) -
-
- string to boolean,  boolean -
-
- string to date,  date, time, datetime -
-
- string to number,  number -
-
- string to time,  date, time, datetime -
-
- Struts,  Using FreeMarker with servlets -
-
- subsequence,  Sequence slicing -
-
- substring,  String slicing (substrings), -substring (deprecated) -
-
- substring built-in,  substring (deprecated) -
-
- subtraction,  Arithmetical calculations -
-
- subvariable
-
-
accessing, Top-level variables, Retrieving data from a hash, Retrieving data from a sequence
-
-
- switch built-in,  switch -
-
- switch directive,  switch, case, default, break -
-
- switch expression,  switch -
-
-
- -

T

-
-
- tabular printing of sequences,  chunk -
-
- tag
-
-
user-defined, Defining your own directives
-
-
- taglib,  Using FreeMarker with servlets -
-
- t directive,  t, lt, rt -
-
- template,  The Template -
-
-
Java side, Get the template
-
-
- template_name,  Special Variable Reference -
-
- template caching,  Template caching -
-
- template loaders,  Template loading -
-
- template loading,  Template loading -
-
- template name,  Template loading -
-
- template path,  Template loading -
-
- temporary variable,  Defining variables in the template -
-
- ternary operator,  then -
-
- testing for missing,  Missing value test operator -
-
- testing for null,  Missing value test operator -
-
- testing for undefined,  Missing value test operator -
-
- text,  Overall structure -
-
- then built-in,  then -
-
- thread-safety,  Multithreading -
-
- time
-
-
built-ins, Built-ins for date/time/date-time values
-
Java API related difficulties, Scalars
-
Java side, Scalars
-
the FTL value type, Scalars
-
-
- time_format,  setting -
-
- time_zone,  setting, -setting -
-
- time built-in,  date, time, datetime, -date, time, datetime (when used with a date/time/date-time - value) -
-
- timestamp
-
-
built-ins, Built-ins for date/time/date-time values
-
-
- time to string,  string (when used with a date/time/date-time value) -
-
- transform,  Defining your own directives -
-
- transform directive,  Transform directive -
-
- tree nodes,  Node variables -
-
- trees,  Node variables -
-
- trim built-in,  trim -
-
- trimmer directives,  nt, -t, lt, rt -
-
- type-casting,  boolean, -date, time, datetime, -number, -c (when used with numerical value), -string (when used with a numerical value), -date, time, datetime (when used with a date/time/date-time - value), -string (when used with a date/time/date-time value), -c (when used with boolean), -string (when used with a boolean value), -byte, double, float, int, long, short, -number_to_date, number_to_time, number_to_datetime -
-
- type checking,  is_... -
-
-
- -

U

-
-
- uncap_first built-in,  uncap_first -
-
- undefined variable,  Handling missing values -
-
- upper_abc built-in,  upper_abc -
-
- upper_case built-in,  upper_case -
-
- url_escaping_charset,  url, -setting -
-
- url_path built-in,  url_path -
-
- url built-in,  url -
-
- URL encoding,  url, -url_path -
-
- URL escaping,  url, -url_path -
-
- URL escaping charset,  Special Variable Reference, -Special Variable Reference -
-
- user-defined directive,  Defining your own directives, -User-defined directive (<@...>) -
-
-
the FTL value type, User-defined directives
-
-
-
- -

V

-
-
- value,  What is a value? -
-
- values built-in,  values -
-
- variable,  Defining variables in the template -
-
- variable number of parameters,  macro, nested, return -
-
- variables,  Variables, scopes -
-
-
names, FAQ
-
-
- variable scopes,  Variables, scopes -
-
- version,  Special Variable Reference -
-
- visit directive,  visit, recurse, fallback -
-
-
- -

W

-
-
- web_safe built-in,  List of deprecated built-ins -
-
- Web application framework,  Using FreeMarker with servlets -
-
- white-space removal,  White-space handling -
-
-
compress, White-space handling, compress
-
stripping, White-space stripping, ftl, nt
-
trimming, nt, t, lt, rt
-
-
- word_list built-in,  word_list -
-
- wrapper,  Basics, -Object wrappers -
-
- wrapping
-
-
beans, Bean wrapper
-
jython, Jython wrapper
-
reflection, Bean wrapper
-
-
-
- -

X

-
-
- xhtml built-in,  xhtml (deprecated) -
-
- XML
-
-
declarative processing, Declarative XML processing
-
exposing, Exposing XML documents
-
imperative processing, Imperative XML processing
-
-
- xml built-in,  xml (deprecated) -
-
- XML encoding,  Auto-escaping and output formats -
-
- XML escaping,  Auto-escaping and output formats -
-
- XML namespace
-
-
in imperative processing, Basics
-
-
- XML namespaces
-
-
in declarative processing, Details
-
-
- XML Schema date parsing,  date, time, datetime -
-
- XML Schema date rendering,  setting -
-
- XML Schema dateTime rendering,  setting -
-
- XML Schema time parsing,  date, time, datetime -
-
- XML Schema time rendering,  setting -
-
- XSLT,  Declarative XML processing -
-
-
-