You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@freemarker.apache.org by dd...@apache.org on 2020/08/03 23:19:28 UTC
[freemarker-generator] 01/01: FREEMARKER-154 Added very early
version of freemarker-generator-website module,
which will generate the website and documentation,
using Docgen. Currently it depends on a SNAPSHOT Docgen version,
and most of the Markdown content is not copied into it yet.
This is an automated email from the ASF dual-hosted git repository.
ddekany pushed a commit to branch FREEMARKER-154
in repository https://gitbox.apache.org/repos/asf/freemarker-generator.git
commit 04b8224792d6c972782809087b9f244180c8a78d
Author: ddekany <dd...@apache.org>
AuthorDate: Sun Aug 2 12:32:11 2020 +0200
FREEMARKER-154 Added very early version of freemarker-generator-website module, which will generate the website and documentation, using Docgen. Currently it depends on a SNAPSHOT Docgen version, and most of the Markdown content is not copied into it yet.
---
freemarker-generator-website/README.md | 5 +
freemarker-generator-website/pom.xml | 72 +++
.../src/main/docgen/book.xml | 677 +++++++++++++++++++++
.../main/docgen/docgen-misc/googleAnalytics.html | 14 +
.../src/main/docgen/docgen.cjson | 97 +++
.../src/main/docgen/favicon.png | Bin 0 -> 1291 bytes
.../src/main/docgen/images/examples/contract.png | Bin 0 -> 220123 bytes
.../main/docgen/images/examples/excel-to-html.png | Bin 0 -> 50262 bytes
.../src/main/docgen/images/examples/github.png | Bin 0 -> 90424 bytes
.../images/examples/locker-test-users-pdf.png | Bin 0 -> 46207 bytes
.../main/docgen/images/examples/transactions.png | Bin 0 -> 385913 bytes
.../src/main/docgen/logo.png | Bin 0 -> 10134 bytes
pom.xml | 1 +
13 files changed, 866 insertions(+)
diff --git a/freemarker-generator-website/README.md b/freemarker-generator-website/README.md
new file mode 100644
index 0000000..2f928b8
--- /dev/null
+++ b/freemarker-generator-website/README.md
@@ -0,0 +1,5 @@
+Apache FreeMarker Generator Website
+=============================================================================
+
+Generates the FreeMarker Generator website, which also contains the documentation;
+this is used internally.
diff --git a/freemarker-generator-website/pom.xml b/freemarker-generator-website/pom.xml
new file mode 100644
index 0000000..0207fdd
--- /dev/null
+++ b/freemarker-generator-website/pom.xml
@@ -0,0 +1,72 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+
+ <modelVersion>4.0.0</modelVersion>
+
+ <parent>
+ <groupId>org.apache.freemarker.generator</groupId>
+ <artifactId>freemarker-generator</artifactId>
+ <version>0.1.0-SNAPSHOT</version>
+ </parent>
+
+ <artifactId>freemarker-generator-website</artifactId>
+ <name>Website</name>
+ <description>Apache FreeMarker Generator Website</description>
+
+ <properties>
+ <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+ <maven.compiler.source>1.8</maven.compiler.source>
+ <maven.compiler.target>1.8</maven.compiler.target>
+
+ <websiteOutputDirectory>${project.build.directory}/website</websiteOutputDirectory>
+ </properties>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.freemarker.docgen</groupId>
+ <artifactId>freemarker-docgen-maven</artifactId>
+ <version>0.0.2-SNAPSHOT</version>
+ <executions>
+ <execution>
+ <phase>package</phase>
+ <goals>
+ <goal>transform</goal>
+ </goals>
+ </execution>
+ </executions>
+ <configuration>
+ <sourceDirectory>src/main/docgen</sourceDirectory>
+ <outputDirectory>${websiteOutputDirectory}</outputDirectory>
+ <offline>true</offline>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+
+ <repositories>
+ <!-- This is need this only when we have freemarker-docgen-maven SNAPSHOT dependency -->
+ <repository>
+ <id>apache-snapshot-repository</id>
+ <url>https://repository.apache.org/content/repositories/snapshots/</url>
+ <releases><enabled>false</enabled></releases>
+ <snapshots><enabled>true</enabled></snapshots>
+ </repository>
+ </repositories>
+</project>
diff --git a/freemarker-generator-website/src/main/docgen/book.xml b/freemarker-generator-website/src/main/docgen/book.xml
new file mode 100644
index 0000000..c0c81fb
--- /dev/null
+++ b/freemarker-generator-website/src/main/docgen/book.xml
@@ -0,0 +1,677 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<book conformance="docgen" version="5.0" xml:lang="en"
+ xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:ns5="http://www.w3.org/1998/Math/MathML"
+ xmlns:ns4="http://www.w3.org/1999/xhtml"
+ xmlns:ns3="http://www.w3.org/2000/svg"
+ xmlns:ns="http://docbook.org/ns/docbook">
+ <info>
+ <title>Apache FreeMarker Generator Manual</title>
+
+ <titleabbrev>FreeMarker Generator Manual</titleabbrev>
+
+ <productname>Apache FreeMarker Generator 0.1.0</productname>
+ </info>
+
+ <chapter role="index.html" xml:id="about">
+ <title>What's FreeMarker Generator?</title>
+
+ <remark>Up until "Quick fasts", this is mostly new content compared to the
+ Markdown version.</remark>
+
+ <warning>
+ <para><emphasis>No backward compatibility is promised!</emphasis>
+ FreeMarker Generator is in early stage of development, and so new
+ versions can break backward compatibility. However, the template engine
+ itself (FreeMarker) keeps backward compatibility, so hopefully the bulk
+ of your work can be migrated to a future versions of FreeMarker
+ Generator, should you decide to upgrade.</para>
+ </warning>
+
+ <para>FreeMarker Generator is a command line tool that generates files
+ based on FreeMarker template files, and data that's typically provided in
+ files (such as JSON files, CSV files, etc.) as well. It can be used to
+ generated source code, configuration files, etc.</para>
+
+ <para>Quick facts:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Requires Java 8+ on Linux, Mac OS X, or Windows</para>
+ </listitem>
+
+ <listitem>
+ <para>Uses stdin, files, and URL-s to load data and templates</para>
+ </listitem>
+
+ <listitem>
+ <para>Reads a variety of structured data formats such as access logs,
+ CSV, Excel, JSON, HTML, YAML, XML</para>
+ </listitem>
+
+ <listitem>
+ <para>Provides JSONPath, XPath and DataFrames for advanced data
+ manipulation</para>
+ </listitem>
+
+ <listitem>
+ <para>Transform a directory with a single command-line
+ invocation</para>
+ </listitem>
+
+ <listitem>
+ <para>Made for the heavy lifting of data by using lazy-loading and
+ streaming</para>
+ </listitem>
+ </itemizedlist>
+
+ <note>
+ <para>Currently, FreeMarker Generator can only be invoked via command
+ line interface (CLI). In the future, we might add other interfaces, like
+ a Maven plugin. Actually, there's already a FreeMarker Generator Maven
+ plugin, but that doesn't share code, or concepts with the CLI. In the
+ future, we hope to unite these into a common engine. But for now the
+ Maven plugin is considered to be a legacy artifact. However, it works,
+ and you can use it. But anything you see in this documentation is not
+ applicable there, except this: [TODO copy and link plugin Maven
+ site]</para>
+ </note>
+ </chapter>
+
+ <chapter>
+ <title>Getting started</title>
+
+ <section>
+ <title>Getting started</title>
+
+ <simplesect>
+ <title>Installation</title>
+
+ <itemizedlist>
+ <listitem>
+ <para>Requires Java 1.8+ on Linux, Mac OS X and Windows</para>
+ </listitem>
+
+ <listitem>
+ <para><link linkend="download">Download</link> the binary release
+ of the FreeMarker Generator command line tool. Unpack the archive
+ in a directory of your choice.</para>
+ </listitem>
+
+ <listitem>
+ <para>Add the <literal>bin/freemarker-cli</literal> or
+ <literal>bin/freemarker-cli.bat</literal> to your
+ <literal>PATH</literal> variable</para>
+ </listitem>
+ </itemizedlist>
+ </simplesect>
+
+ <simplesect>
+ <title>Verify Installation</title>
+
+ <para>On my local box (Mac OS 10.15.5) I use the following
+ setup:</para>
+
+ <programlisting>export FREEMARKER_CLI_HOME=/Applications/Java/freemarker-cli-2.0.0
+export PATH=$PATH:$FREEMARKER_CLI_HOME/bin</programlisting>
+
+ <para>Afterwards Apache FreeMarker CLI can be executed from the
+ command line:</para>
+
+ <programlisting>> which freemarker-cli
+/Applications/Java/freemarker-cli-2.0.0/bin/freemarker-cli</programlisting>
+
+ <para>and check the version of Apache FreeMarker CLI</para>
+
+ <programlisting>> freemarker-cli -V
+version=0.1.0-SNAPSHOT, time=2020-06-25T21:48:02+0200, commit=b320d00094be8789086ad6153d9d3fcaf4b8c75f
+</programlisting>
+ </simplesect>
+
+ <simplesect>
+ <title>Command Line Options</title>
+
+ <para>Apache FreeMarker CLI provides command line help as shown
+ below:</para>
+
+ <programlisting>> freemarker-cli -h
+ Usage: freemarker-cli (-t=<templates> [-t=<templates>]... |
+ -i=<interactiveTemplate>) [-hV] [--stdin] [-b=<baseDir>]
+ [--config=<configFile>]
+ [--data-source-exclude=<dataSourceExcludePattern>]
+ [--data-source-include=<dataSourceIncludePattern>]
+ [-e=<inputEncoding>] [-l=<locale>]
+ [--output-encoding=<outputEncoding>] [--times=<times>]
+ [-D=<String=String>]... [-m=<dataModels>]...
+ [-o=<outputs>]... [-P=<String=String>]...
+ [-s=<dataSources>]... [<sources>...]
+ Apache FreeMarker CLI
+ [<sources>...] data source files and/or directories
+ -b, --basedir=<baseDir> additional template base directory
+ --config=<configFile> FreeMarker CLI configuration file
+ -D, --system-property=<String=String>
+ set system property
+ --data-source-exclude=<dataSourceExcludePattern>
+ file exclude pattern for data sources
+ --data-source-include=<dataSourceIncludePattern>
+ file include pattern for data sources
+ -e, --input-encoding=<inputEncoding>
+ encoding of data source
+ -h, --help Show this help message and exit.
+ -i, --interactive=<interactiveTemplate>
+ interactive template to process
+ -l, --locale=<locale> locale being used for the output, e.g. 'en_US'
+ -m, --data-model=<dataModels>
+ data model used for rendering
+ -o, --output=<outputs> output files or directories
+ --output-encoding=<outputEncoding>
+ encoding of output, e.g. UTF-8
+ -P, --param=<String=String>
+ set parameter
+ -s, --data-source=<dataSources>
+ data source used for rendering
+ --stdin read data source from stdin
+ -t, --template=<templates>
+ templates to process
+ --times=<times> re-run X times for profiling
+ -V, --version Print version information and exit.
+</programlisting>
+ </simplesect>
+
+ <simplesect>
+ <title>The Info Template</title>
+
+ <para>The distribution ships with a couple of FreeMarker templates and
+ the <literal>templates/info.ftl</literal> is particularly helpful to
+ better understand Apache FreeMarker CLI.</para>
+
+ <programlisting>> freemarker-cli -t templates/info.ftl
+FreeMarker CLI Information
+------------------------------------------------------------------------------
+FreeMarker version : 2.3.30
+Template name : templates/info.ftl
+Language : en
+Locale : en_US
+Timestamp : Jun 26, 2020 10:44:15 AM
+Output encoding : UTF-8
+Output format : plainText
+
+FreeMarker CLI Template Loader Directories
+------------------------------------------------------------------------------
+[#1] /Users/sgoeschl/work/github/apache/freemarker-generator
+[#2] /Users/sgoeschl/.freemarker-cli
+[#3] /Applications/Java/freemarker-cli-2.0.0
+
+FreeMarker CLI Tools
+------------------------------------------------------------------------------
+- CSVTool : Process CSV files using Apache Commons CSV (see https://commons.apache.org/proper/commons-csv/)
+- DataFrameTool : Bridge to [nRo/DataFrame](https://github.com/nRo/DataFrame)
+- ExcelTool : Process Excels files (XLS, XLSX) using Apache POI (see https://poi.apache.org)
+- ExecTool : Execute command line tools using Apache Commons Exec (see https://commons.apache.org/proper/commons-exec/)
+- FreeMarkerTool : Expose advanced Apache FreeMarker classes
+- GrokTool : Process text files using Grok expressions (see https://github.com/thekrakken/java-grok)
+- GsonTool : Process JSON files using GSON (see https://github.com/google/gson)
+- JsonPathTool : Process JSON files using Java JSON Path (see https://github.com/json-path/JsonPath)
+- JsoupTool : Process HTML files using Jsoup (see https://jsoup.org)
+- PropertiesTool : Process JDK properties files
+- SystemTool : Expose System-related utility methods
+- UUIDTool : Create UUIDs
+- XmlTool : Process XML files using Apache FreeMarker (see https://freemarker.apache.org/docs/xgui.html)
+- YamlTool : Process YAML files using SnakeYAML(see https://bitbucket.org/asomov/snakeyaml/wiki/Home)
+
+FreeMarker CLI Data Model
+---------------------------------------------------------------------------
+- CSVTool
+- DataFrameTool
+- DataSources
+- ExcelTool
+- ExecTool
+- FreeMarkerTool
+- GrokTool
+- GsonTool
+- JsonPathTool
+- JsoupTool
+- PropertiesTool
+- SystemTool
+- UUIDTool
+- XmlTool
+- YamlTool</programlisting>
+
+ <para>Above:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>The <quote>FreeMarker CLI Information</quote> section
+ provides insights into configuration and currently processed
+ template.</para>
+ </listitem>
+
+ <listitem>
+ <para>The <quote>FreeMarker CLI Template Loader
+ Directories</quote> shows the template directories being searched
+ to resolve a template path</para>
+ </listitem>
+
+ <listitem>
+ <para>The <quote>FreeMarker CLI Tools</quote> section list the
+ available tools</para>
+ </listitem>
+
+ <listitem>
+ <para>The <quote>FreeMarker CLI Data Model</quote> section shows
+ all available entries in the current FreeMarker context </para>
+ </listitem>
+ </itemizedlist>
+ </simplesect>
+ </section>
+
+ <section>
+ <title>Running the examples</title>
+
+ <para>TODO</para>
+ </section>
+ </chapter>
+
+ <chapter>
+ <title>Concepts</title>
+
+ <section>
+ <title>Design goals</title>
+
+ <para>TODO</para>
+ </section>
+
+ <section>
+ <title>Named URI-s</title>
+
+ <para>TODO</para>
+ </section>
+
+ <section>
+ <title>Data sources</title>
+
+ <para>TODO</para>
+ </section>
+
+ <section>
+ <title>Data Models</title>
+
+ <para>TODO</para>
+ </section>
+
+ <section>
+ <title>Passing Configuration Data</title>
+
+ <para>TODO</para>
+ </section>
+
+ <section>
+ <title>Template Loading</title>
+
+ <para>TODO</para>
+ </section>
+
+ <section>
+ <title>Transformation</title>
+
+ <para>TODO</para>
+ </section>
+
+ <section>
+ <title>Tools</title>
+
+ <para>TODO</para>
+ </section>
+ </chapter>
+
+ <chapter>
+ <title>Usage details</title>
+
+ <remark role="editorialNote">In the markdown version this chapter was
+ "Usage", but I though that clashes with "Getting Started" in
+ meaning.</remark>
+
+ <section>
+ <title>Transforming Directories</title>
+
+ <section>
+ <title>Transforming Directories</title>
+
+ <para>TODO</para>
+ </section>
+
+ <section>
+ <title>Using DataFrames</title>
+
+ <para>TODO</para>
+ </section>
+
+ <section>
+ <title>Transforming CSV</title>
+
+ <para>TODO</para>
+ </section>
+ </section>
+ </chapter>
+
+ <chapter>
+ <title>Advanced topics</title>
+
+ <section>
+ <title>FreeMarker CLI Configuration</title>
+
+ <para>TODO</para>
+ </section>
+ </chapter>
+
+ <chapter>
+ <title>Appendixes</title>
+
+ <section xml:id="download">
+ <title>Download</title>
+
+ <simplesect>
+ <title>Latest release: 0.1.0</title>
+
+ <para>Released on 2020-[FIXME]-[FIXME]. Requires Java 1.8 or
+ higher.</para>
+
+ <para><link linkend="version_0_1_0">See what's new...</link></para>
+
+ <para>Downloads:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para><link
+ xlink:href="https://www.apache.org/dyn/closer.cgi/freemarker/generator/0.1.0/binaries/apache-freemarker-generator-cli-0.1.0-bin.tar.gz">Binary
+ release of the command line tool (tar.gz)</link> [<link
+ xlink:href="https://www.apache.org/dyn/closer.cgi/freemarker/generator/0.1.0/binaries/apache-freemarker-generator-cli-0.1.0-bin.tar.gz.sha512">SHA512</link>]
+ [<link
+ xlink:href="https://www.apache.org/dyn/closer.cgi/freemarker/generator/0.1.0/binaries/apache-freemarker-generator-cli-0.1.0-bin.tar.gz.asc">ASC</link>]</para>
+ </listitem>
+
+ <listitem>
+ <para><link
+ xlink:href="https://www.apache.org/dyn/closer.cgi/freemarker/generator/0.1.0/binaries/apache-freemarker-generatori-0.1.0-src.tar.gz">Source
+ release (tar.gz)</link> [<link
+ xlink:href="https://www.apache.org/dyn/closer.cgi/freemarker/generator/0.1.0/binaries/apache-freemarker-generatori-0.1.0-src.tar.gz.sha512">SHA512</link>]
+ [<link
+ xlink:href="https://www.apache.org/dyn/closer.cgi/freemarker/generator/0.1.0/binaries/apache-freemarker-generatori-0.1.0-src.tar.gz.asc">ASC</link>]</para>
+ </listitem>
+ </itemizedlist>
+ </simplesect>
+ </section>
+
+ <section xml:id="versionsHistory">
+ <title>Version history</title>
+
+ <section xml:id="version_0_1_0">
+ <title>0.1.0</title>
+
+ <para>This is the first release at Apache. The previous version of the
+ project was here: <link
+ xlink:href="https://github.com/sgoeschl/freemarker-cli">https://github.com/sgoeschl/freemarker-cli</link>.
+ Compared to that, the most important changes are these:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>[TODO]</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ </section>
+
+ <section xml:id="legal">
+ <title>Legal matters</title>
+
+ <section xml:id="license">
+ <title>License</title>
+
+ <para>Bellow license applies to the FreeMarker Generator source code.
+ Binary distributions of FreeMarker Generator may bundles 3rd party
+ dependencies, in which case see the license included in the binary
+ distribution for more information about the licenses of bundled
+ dependencies!</para>
+
+ <programlisting role="unspecified">
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+==============================================================================
+END LICENSE</programlisting>
+ </section>
+
+ <section xml:id="export_control">
+ <title>Export Control</title>
+
+ <para>The FreeMarker Generator source code doesn't include
+ cryptography. Furthermore its binary (downloadable) forms don't
+ include any cryptography software. Hence, FreeMarker has no Export
+ Control Classification Number (ECCN). Where an ECCN should be filled,
+ the label "not subject to EAR" could be used.</para>
+
+ <para>FreeMarker Generator itself doesn't add any exporting
+ limitations.</para>
+ </section>
+ </section>
+ </chapter>
+</book>
diff --git a/freemarker-generator-website/src/main/docgen/docgen-misc/googleAnalytics.html b/freemarker-generator-website/src/main/docgen/docgen-misc/googleAnalytics.html
new file mode 100644
index 0000000..759564e
--- /dev/null
+++ b/freemarker-generator-website/src/main/docgen/docgen-misc/googleAnalytics.html
@@ -0,0 +1,14 @@
+<!--
+ This snippet was generated by Google Analytics.
+ Thus, the standard FreeMarker copyright comment was intentionally omitted.
+ <#DO_NOT_UPDATE_COPYRIGHT>
+-->
+<script>
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-55420501-1', 'auto');
+ ga('send', 'pageview');
+</script>
diff --git a/freemarker-generator-website/src/main/docgen/docgen.cjson b/freemarker-generator-website/src/main/docgen/docgen.cjson
new file mode 100644
index 0000000..ddca35e
--- /dev/null
+++ b/freemarker-generator-website/src/main/docgen/docgen.cjson
@@ -0,0 +1,97 @@
+//charset: UTF-8
+
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+deployUrl: "https://freemarker.apache.org/generator/"
+onlineTrackerHTML: "docgen-misc/googleAnalytics.html"
+cookieConsentScriptURL: "https://cdn.jsdelivr.net/npm/cookie-bar/cookiebar-latest.min.js"
+searchKey: "003127866208504630097:arjqbv_znfw" // TODO Creat a seach key for the subdirectory
+validation: {
+ programlistingsRequireRole
+ // programlistingsRequireLanguage
+ maximumProgramlistingWidth: 100
+}
+showXXELogo
+
+copyrightHolder: "The Apache Software Foundation"
+copyrightHolderSite: "https://apache.org/"
+copyrightSuffix: "Apache FreeMarker Generator, FreeMarker Generator, Apache FreeMarker, FreeMarker, Apache Incubator, Apache, the Apache FreeMarker logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners."
+copyrightStartYear: 2020
+
+logo: {
+ href: "https://freemarker.apache.org"
+ src: logo.png,
+ alt: "FreeMarker"
+}
+
+olinks: {
+ freemarkerHome: "https://freemarker.apache.org/"
+ freemarkerManual: "https://freemarker.apache.org/docs/"
+
+ mailing-lists: "https://freemarker.apache.org/mailing-lists.html"
+ githubProject: "https://github.com/apache/freemarker-generator"
+
+ // External URL-s:
+ onlineTemplateTester: "http://try.freemarker.org/"
+ twitter: "https://twitter.com/freemarker"
+ newBugReport: "https://issues.apache.org/jira/browse/FREEMARKER/"
+ newStackOverflowQuestion: "https://stackoverflow.com/questions/ask?tags=freemarker-generator" // TODO Create SO tag if when we get to release
+ devMailingList: "mailto:dev@freemarker.apache.org"
+}
+
+internalBookmarks: {
+ // May will add some as the manual becomes more complex.
+}
+
+tabs: {
+ "FreeMarker Home": "olink:freemarkerHome"
+ "Generator Manual": "" // Empty => We are here
+}
+
+secondaryTabs: {
+ // TODO "Contribute": { class: "icon-heart", href: "olink:contribute" }
+ "Report a Bug": { class: "icon-bug", href: "olink:newBugReport" } // TODO Can w pre-fill component
+ "Download": { class: "icon-download", href: "id:download" }
+}
+
+footerSiteMap: {
+ "Frequently used": {
+ "Download": "id:download"
+ "Version history": "id:versionsHistory"
+ "FreeMarker Manual": "olink:freemarkerManual"
+ "Try template online": "olink:onlineTemplateTester"
+ }
+ "Community": {
+ "FreeMarker on Github": "olink:githubProject"
+ "Follow us on Twitter": "olink:twitter"
+ "Report a bug": "olink:newBugReport"
+ "Ask a question": "olink:newStackOverflowQuestion"
+ "Mailing lists": "olink:mailing-lists"
+ }
+}
+
+socialLinks: {
+ "Github": { class: "github", href: "olink:githubProject" }
+ "Twitter": { class: "twitter", href: "olink:twitter" }
+ "Stack Overflow": { class: "stack-overflow", href: "olink:newStackOverflowQuestion" }
+}
+
+validation: {
+ // TODO: Remove this later, as we don't want autoid_${n}.html-s as output.
+ outputFilesCanUseAutoID
+}
diff --git a/freemarker-generator-website/src/main/docgen/favicon.png b/freemarker-generator-website/src/main/docgen/favicon.png
new file mode 100644
index 0000000..ce0de20
Binary files /dev/null and b/freemarker-generator-website/src/main/docgen/favicon.png differ
diff --git a/freemarker-generator-website/src/main/docgen/images/examples/contract.png b/freemarker-generator-website/src/main/docgen/images/examples/contract.png
new file mode 100644
index 0000000..e69f0eb
Binary files /dev/null and b/freemarker-generator-website/src/main/docgen/images/examples/contract.png differ
diff --git a/freemarker-generator-website/src/main/docgen/images/examples/excel-to-html.png b/freemarker-generator-website/src/main/docgen/images/examples/excel-to-html.png
new file mode 100644
index 0000000..ddb561f
Binary files /dev/null and b/freemarker-generator-website/src/main/docgen/images/examples/excel-to-html.png differ
diff --git a/freemarker-generator-website/src/main/docgen/images/examples/github.png b/freemarker-generator-website/src/main/docgen/images/examples/github.png
new file mode 100644
index 0000000..e39415a
Binary files /dev/null and b/freemarker-generator-website/src/main/docgen/images/examples/github.png differ
diff --git a/freemarker-generator-website/src/main/docgen/images/examples/locker-test-users-pdf.png b/freemarker-generator-website/src/main/docgen/images/examples/locker-test-users-pdf.png
new file mode 100644
index 0000000..67a9eb7
Binary files /dev/null and b/freemarker-generator-website/src/main/docgen/images/examples/locker-test-users-pdf.png differ
diff --git a/freemarker-generator-website/src/main/docgen/images/examples/transactions.png b/freemarker-generator-website/src/main/docgen/images/examples/transactions.png
new file mode 100644
index 0000000..d7d0fc1
Binary files /dev/null and b/freemarker-generator-website/src/main/docgen/images/examples/transactions.png differ
diff --git a/freemarker-generator-website/src/main/docgen/logo.png b/freemarker-generator-website/src/main/docgen/logo.png
new file mode 100644
index 0000000..193dc11
Binary files /dev/null and b/freemarker-generator-website/src/main/docgen/logo.png differ
diff --git a/pom.xml b/pom.xml
index 4e132e8..0aae301 100644
--- a/pom.xml
+++ b/pom.xml
@@ -78,6 +78,7 @@
<module>freemarker-generator-tools</module>
<module>freemarker-generator-cli</module>
<module>freemarker-generator-maven-plugin</module>
+ <module>freemarker-generator-website</module>
</modules>
<properties>