• Stars
    star
    895
  • Rank 51,027 (Top 2 %)
  • Language
    Java
  • License
    Apache License 2.0
  • Created about 9 years ago
  • Updated about 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Apache Freemarker

Apache FreeMarker {version}

Build status

For the latest version or to report bugs visit: https://freemarker.apache.org/

Regarding pull requests on Github

By sending a pull request you grant the Apache Software Foundation sufficient rights to use and release the submitted work under the Apache license. You grant the same rights (copyright license, patent license, etc.) to the Apache Software Foundation as if you have signed a Contributor License Agreement. For contributions that are judged to be non-trivial, you will be asked to actually signing a Contributor License Agreement.

What is Apache FreeMarker?

FreeMarker is a "template engine"; a generic tool to generate text output (anything from HTML to auto generated source code) based on templates. It's a Java package, a class library for Java programmers. It's not an application for end-users in itself, but something that programmers can embed into their products. FreeMarker is designed to be practical for the generation of HTML Web pages, particularly by servlet-based applications following the MVC (Model View Controller) pattern.

Licensing

FreeMarker is licensed under the Apache License, Version 2.0.

See the LICENSE file for more details!

Documentation

Online: https://freemarker.apache.org/docs/

Offline: The full documentation is available in the binary distribution in the documentation/index.html directory.

Installing

If you are using Maven, just add this dependency:

  <!--
  Attention: Be sure nothing pulls in an old dependency with groupId
  "freemarker" (without the "org."), because then you will end up with
  two freemarker.jar-s and unpredictable behavior on runtime!
  -->
  <dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker-gae</artifactId>
    <version>{version}</version>
  </dependency>

Otherwise, simply copy freemarker.jar to a location where your Java application's ClassLoader will find it. For example, if you are using FreeMarker in a web application, you probably want to put freemarker.jar into the WEB-INF/lib directory of your web application.

FreeMarker has no required dependencies. It has several optional dependencies, but usually you don't have to deal with them, because if you are using an optional feature that's certainly because your application already uses the related library.

Attention: If you upgrade to OpenJDK 9 or later, and you are using XPath queries in templates, you will need to add Apache Xalan as a dependency, as freemarker.ext.dom can't use the XPath support included in OpenJDK anymore. It's not needed on Oracle Java 9, or if FreeMarker is configured to use Jaxen for XPath.

The minimum required Java version is currently Java SE 8. (The presence of a later version may be detected on runtime and utilized by FreeMarker.)

Change log

Online (for stable releases only): https://freemarker.apache.org/docs/app_versions.html

Offline: In the binary release, open documentation/index.html, and you will find the link.

Building FreeMarker

If you haven't yet, download the source release, or checkout FreeMarker from the source code repository. See repository locations here: https://freemarker.apache.org/sourcecode.html

You need JDK 8, JDK 16 and JDK 17 (only for some tests) to be installed (and visible to Gradle).

Be sure that your default Java version (which Gradle should use automatically) is at least 16!

If you are building from the official source release (not from source that you got from Git), gradle/wrapper/gradle-wrapper.jar is missing from that, and you have to add it yourself! You can download it from GitHub source code page! (Or, use your own Gradle installation instead of gradlew.)

To build freemarker.jar, just issue ./gradlew jar in the project root directory, and it should download all dependencies automatically and build freemarker.jar.

To run all JUnit tests and some other checks, issue ./gradlew check. (Avoid the test task, as that will only run the tests of the core source set.)

To generate documentation, issue ./gradlew javadoc and ./gradlew manualOffline.

To see how the project would be deployed to Maven Central, issue ./gradlew publishAllPublicationsToLocalRepository, and check the build/local-deployment directory.

To build the distribution artifacts (the tgz-s that people can download), run ./gradlew build.However,

For a stable (non-SNAPSHOT) version number, you will need to set up signing, or disable that verification; see gradle.properties in this project for those!

See gradle.properties for some Gradle properties that you may what to set, especially if you are building a release.

Reproducible builds: If the resulting freemarker.jar is not identical with the official jar, see the build environment in the .buildinfo file packed into the official source distribution, and also into the Maven "sources" artifact!

IDE setup

Eclipse

Below you find the step-by-step setup for Eclipse (originally done on Mars.1):

  • Start Eclipse
  • You may prefer to start a new workspace (File -> "Switch workspace"), but it's optional.
  • Window -> Preferences
    • General -> Workspace, set the text file encoding to "UTF-8". (Or, you can set the same later on project level instead.)
    • General -> Editors -> Text Editors, set:
      • Insert space for tabs
      • Show print margin, 120 columns
    • Java -> Code Style -> Formatter -> Import... Select src\ide-settings\Eclipse\Formatter-profile-FreeMarker.xml inside the FreeMarker project directory. (On IntelliJ IDEA, import src/ide-settings/IntelliJ-IDEA/Java-code-style-FreeMarker.xml instead) This profile uses space-only indentation policy and 120 character line width, and formatting rules that are pretty much standard in modern Java.
    • Java -> Code Style -> Organize imports (On IntelliJ IDEA, this was already configured by the Java code style import earlier.) The order is this (the Eclipse default): java, javax, org, com. Number of imports required for .: 99 Number of static imports needed for .: 1
    • Java -> Installed JRE-s: Ensure that you have JDK 16 installed, and that it was added to Eclipse. Note that it's not JRE, but JDK.
    • Java -> Compiler -> Javadoc: "Malformed Javadoc comments": Error "Only consider members as visible": Private "Validate tag arguments": true "Missing tag descriptions": Validate @return tags "Missing Javadoc tags": Ignore "Missing Javadoc comments": Ignore
  • Import the project as any other Gradle project.
  • Eclipse will indicate many errors at this point; it's expected, read on.
  • Project -> Properties -> Java Compiler
    • In Errors/Warnings, check in "Enable project specific settings", then set "Forbidden reference (access rules)" from "Error" to "Warning".
  • You will still have errors on these java files (because different java files depend on different versions of the same library, and Eclipse can't handle that). Exclude those java files from the Build Path (in the Package Explorer, right-click on the problematic file -> "Build Path" -> "Exclude"): _Jython20*.java, _Jython22*.java, _FreeMarkerPageContext2.java, FreeMarkerJspFactory2.java, Also, close these files if they are open. Now you shouldn't have any errors.
  • At Project -> Properties -> Java Code Style -> Formatter, check in "Enable project specific settings", and then select "FreeMarker" as active profile.
  • At Project -> Properties -> Java Editor -> Save Actions, check "Enable project specific settings", then "Perform the selected actions on save", and have only "Organize imports" and "Additional actions" checked (the list for the last should contain "Add missing @Override annotations", "Add missing @Override annotations to implementations of interface methods", "Add missing @Deprecated annotations", and "Remove unnecessary cast").
  • Right click on the project -> Run As -> JUnit Test It should run without problems (all green).
  • It's highly recommended to use the Eclipse FindBugs plugin.
    • Install it from Eclipse Marketplace (3.0.1 as of this writing)
    • Window -> Preferences -> Java -> FindBugs: Set all bug marker ranks from Warning to Error. (For false alarms we add @SuppressFBWarnings(value = "...", justification = "...") annotations.)
    • Project -> Properties -> FindBugs -> [x] Run Automatically
    • There should 0 errors. But sometimes the plugin fails to take the @SuppressFBWarnings annotations into account; then use Project -> Clean.

IntelliJ IDEA

Originally done on IntelliJ IDEA Community 2023.3.2:

  • "File" -> "Open": Select the "settings.gradle.kts" within the freemarker root directory.

  • If the project fails to load (or build), then adjust the following configuration in "File" -> "Settings" -> "Build, Execution, Deployment" -> "Build Tools" -> "Gradle":

    • Gradle JVM: JDK 16 (or higher)
    • Build and run using: "Gradle"
    • Run tests using: "Gradle"
  • "File" -> "Settings"

    • Under "Editor" / "Code style", import and use freemarker/src/ide-settings/IntelliJ-IDEA/Java-code-style-FreeMarker.xml
    • Under "Editor" / "Inspections", import and use freemarker/src/ide-settings/IntelliJ-IDEA/Editor-Inspections-FreeMarker.xml
    • Copy the copyright header comment from some of the java files, then under "Editor" / "Copyright" / "Copyright Profiles" click "+", enter "ASL2" as name, then paste the copyright header. Delete the /* and */ lines, and the * prefixes (to select columns of text, hold Alt while selecting with the mouse.) Then go back to "Copyright" in the tree, and set "Default project copyright" to "ASL2".

More Repositories

1

echarts

Apache ECharts is a powerful, interactive charting and data visualization library for browser
TypeScript
56,321
star
2

superset

Apache Superset is a Data Visualization and Data Exploration Platform
TypeScript
55,051
star
3

dubbo

The java implementation of Apache Dubbo. An RPC and microservice framework.
Java
40,333
star
4

spark

Apache Spark - A unified analytics engine for large-scale data processing
Scala
36,719
star
5

airflow

Apache Airflow - A platform to programmatically author, schedule, and monitor workflows
Python
36,241
star
6

kafka

Mirror of Apache Kafka
Java
28,624
star
7

incubator-seata

๐Ÿ”ฅ Seata is an easy-to-use, high-performance, open source distributed transaction solution.
Java
24,602
star
8

skywalking

APM, Application Performance Monitoring System
Java
22,610
star
9

flink

Apache Flink
Java
22,197
star
10

mxnet

Lightweight, Portable, Flexible Distributed/Mobile Deep Learning with Dynamic, Mutation-aware Dataflow Dep Scheduler; for Python, R, Julia, Scala, Go, Javascript and more
C++
20,572
star
11

shardingsphere

Distributed SQL transaction & query engine for data sharding, scaling, encryption, and more - on any database.
Java
19,710
star
12

rocketmq

Apache RocketMQ is a cloud native messaging and streaming platform, making it simple to build event-driven applications.
Java
18,578
star
13

arrow

Apache Arrow is the universal columnar format and multi-language toolbox for fast data interchange and in-memory analytics
C++
14,481
star
14

brpc

brpc is an Industrial-grade RPC framework using C++ Language, which is often used in high performance system such as Search, Storage, Machine learning, Advertisement, Recommendation etc. "brpc" means "better RPC".
C++
14,261
star
15

incubator-weex

Apache Weex (Incubating)
C++
13,884
star
16

hadoop

Apache Hadoop
Java
13,855
star
17

pulsar

Apache Pulsar - distributed pub-sub messaging system
Java
13,062
star
18

druid

Apache Druid: a high performance real-time analytics database.
Java
12,843
star
19

predictionio

PredictionIO, a machine learning server for developers and ML engineers.
Scala
12,556
star
20

doris

Apache Doris is an easy-to-use, high performance and unified analytics database.
Java
12,490
star
21

zookeeper

Apache ZooKeeper
Java
11,532
star
22

incubator-answer

A Q&A platform software for teams at any scales. Whether it's a community forum, help center, or knowledge management platform, you can always count on Apache Answer.
Go
11,487
star
23

apisix

The Cloud-Native API Gateway
Lua
11,031
star
24

thrift

Apache Thrift
C++
9,900
star
25

dolphinscheduler

Apache DolphinScheduler is the modern data workflow orchestration platform with powerful user interface, dedicated to solving complex task dependencies in the data pipeline and providing various types of jobs available `out of the box`
Java
9,619
star
26

cassandra

Mirror of Apache Cassandra
Java
8,187
star
27

shardingsphere-elasticjob

Distributed scheduled job
Java
7,965
star
28

seatunnel

SeaTunnel is a next-generation super high-performance, distributed, massive data integration tool.
Java
7,854
star
29

tvm

Open deep learning compiler stack for cpu, gpu and specialized accelerators
Python
7,828
star
30

beam

Apache Beam is a unified programming model for Batch and Streaming data processing.
Java
7,737
star
31

shenyu

Apache ShenYu is a Java native API Gateway for service proxy, protocol conversion and API governance.
Java
7,541
star
32

jmeter

Apache JMeter open-source load testing tool for analyzing and measuring the performance of a variety of services
Java
7,335
star
33

tomcat

Apache Tomcat
Java
6,926
star
34

storm

Apache Storm
Java
6,480
star
35

iceberg

Apache Iceberg
Java
6,271
star
36

zeppelin

Web-based notebook that enables data-driven, interactive data analytics and collaborative documents with SQL, Scala and more.
Java
6,162
star
37

openwhisk

Apache OpenWhisk is an open source serverless cloud platform
Scala
6,130
star
38

couchdb

Seamless multi-master syncing database with an intuitive HTTP/JSON API, designed for reliability
Erlang
5,810
star
39

iotdb

Apache IoTDB
Java
5,582
star
40

incubator-kie-drools

Drools is a rule engine, DMN engine and complex event processing (CEP) engine for Java.
Java
5,542
star
41

pinot

Apache Pinot - A realtime distributed OLAP datastore
Java
5,430
star
42

dubbo-spring-boot-project

Spring Boot Project for Apache Dubbo
Java
5,355
star
43

mesos

Apache Mesos
Java
5,111
star
44

hive

Apache Hive
Java
5,053
star
45

camel

Apache Camel is an open source integration framework that empowers you to quickly and easily integrate various systems consuming or producing data.
Java
5,042
star
46

groovy

Apache Groovy: A powerful multi-faceted programming language for the JVM platform
Java
4,977
star
47

hbase

Apache HBase
Java
4,971
star
48

incubator-weex-ui

๐Ÿ„ A rich interaction, lightweight, high performance UI library based on Weex.
Vue
4,788
star
49

ignite

Apache Ignite
Java
4,548
star
50

rocketmq-externals

Mirror of Apache RocketMQ (Incubating)
Java
4,474
star
51

incubator-pagespeed-ngx

Automatic PageSpeed optimization module for Nginx
C++
4,381
star
52

lucene-solr

Apache Lucene and Solr open-source search software
4,349
star
53

dubbo-go

Go Implementation For Apache Dubbo
Go
4,315
star
54

shiro

Apache Shiro
Java
4,164
star
55

calcite

Apache Calcite
Java
4,028
star
56

nifi

Apache NiFi
Java
4,006
star
57

maven

Apache Maven core
Java
3,836
star
58

hudi

Upserts, Deletes And Incremental Processing on Big Data.
Java
3,804
star
59

dubbo-admin

The ops and reference implementation for Apache Dubbo
Java
3,707
star
60

incubator-heron

Apache Heron (Incubating) is a realtime, distributed, fault-tolerant stream processing engine from Twitter
Java
3,646
star
61

cordova-android

Apache Cordova Android
JavaScript
3,539
star
62

kylin

Apache Kylin
Java
3,526
star
63

httpd

Mirror of Apache HTTP Server. Issues: http://issues.apache.org
C
3,510
star
64

linkis

Apache Linkis builds a computation middleware layer to facilitate connection, governance and orchestration between the upper applications and the underlying data engines.
Java
3,298
star
65

incubator-kie-optaplanner

AI constraint solver in Java to optimize the vehicle routing problem, employee rostering, task assignment, maintenance scheduling, conference scheduling and other planning problems.
Java
3,152
star
66

logging-log4j2

Apache Log4j 2 is a versatile, feature-rich, efficient logging API and backend for Java.
Java
3,151
star
67

fury

A blazingly fast multi-language serialization framework powered by JIT and zero-copy.
Java
3,000
star
68

arrow-datafusion

Apache Arrow DataFusion SQL Query Engine
Rust
2,998
star
69

curator

Apache Curator
Java
2,997
star
70

singa

a distributed deep learning platform
C++
2,968
star
71

avro

Apache Avro is a data serialization system.
Java
2,872
star
72

incubator-streampark

StreamPark, Make stream processing easier! easy-to-use streaming application development framework and operation platform
Scala
2,820
star
73

nutch

Apache Nutch is an extensible and scalable web crawler
Java
2,653
star
74

netbeans

Apache NetBeans
Java
2,643
star
75

guacamole-server

Mirror of Apache Guacamole Server
C
2,601
star
76

incubator-devlake

Apache DevLake is an open-source dev data platform to ingest, analyze, and visualize the fragmented data from DevOps tools, extracting insights for engineering excellence, developer experience, and community growth.
Go
2,578
star
77

commons-lang

Apache Commons Lang
Java
2,539
star
78

flume

Mirror of Apache Flume
Java
2,458
star
79

geode

Apache Geode
Java
2,244
star
80

gobblin

A distributed data integration framework that simplifies common aspects of big data integration such as data ingestion, replication, organization and lifecycle management for both streaming and batch data ecosystems.
Java
2,209
star
81

incubator-seata-samples

seata-samples
Java
2,196
star
82

maven-mvnd

Apache Maven Daemon
Java
2,191
star
83

activemq

Mirror of Apache ActiveMQ
Java
2,184
star
84

incubator-hugegraph

A graph database that supports more than 100+ billion data, high performance and scalability (Include OLTP Engine & REST-API & Backends)
Java
2,156
star
85

parquet-mr

Apache Parquet
Java
2,153
star
86

kvrocks

Kvrocks is a distributed key value NoSQL database that uses RocksDB as storage engine and is compatible with Redis protocol.
C++
2,147
star
87

pdfbox

Mirror of Apache PDFBox
Java
2,131
star
88

cordova-ios

Apache Cordova iOS
JavaScript
2,130
star
89

mahout

Mirror of Apache Mahout
Java
2,095
star
90

lucenenet

Apache Lucene.NET
C#
2,031
star
91

ambari

Apache Ambari simplifies provisioning, managing, and monitoring of Apache Hadoop clusters.
Java
1,990
star
92

incubator-pegasus

Apache Pegasus - A horizontally scalable, strongly consistent and high-performance key-value store
C++
1,962
star
93

libcloud

Apache Libcloud is a Python library which hides differences between different cloud provider APIs and allows you to manage different cloud resources through a unified and easy to use API.
Python
1,956
star
94

cloudstack

Apache CloudStack is an opensource Infrastructure as a Service (IaaS) cloud computing platform
Java
1,945
star
95

tika

The Apache Tika toolkit detects and extracts metadata and text from over a thousand different file types (such as PPT, XLS, and PDF).
Java
1,860
star
96

drill

Apache Drill is a distributed MPP query layer for self describing data
Java
1,841
star
97

dubbo-samples

samples for Apache Dubbo
Java
1,839
star
98

servicecomb-java-chassis

ServiceComb Java Chassis is a Software Development Kit (SDK) for rapid development of microservices in Java, providing service registration, service discovery, dynamic routing, and service management features
Java
1,829
star
99

tinkerpop

Apache TinkerPop - a graph computing framework
Java
1,825
star
100

trafficserver

Apache Traffic Serverโ„ข is a fast, scalable and extensible HTTP/1.1 and HTTP/2 compliant caching proxy server.
C++
1,804
star