This is an automated email from the ASF dual-hosted git repository.
sgoeschl pushed a commit to branch FREEMARKER-147
in repository https://gitbox.apache.org/repos/asf/freemarker-generator.git
The following commit(s) were added to refs/heads/FREEMARKER-147 by this push:
new 9dbbdf0 FREEMARKER-147 Complete Maven site documenation
9dbbdf0 is described below
commit 9dbbdf01148e32776860ea433e3f87c1b3dd31b1
Author: Siegfried Goeschl <[email protected]>
AuthorDate: Fri Jun 26 10:55:27 2020 +0200
FREEMARKER-147 Complete Maven site documenation
---
.../markdown/cli/introduction/getting-started.md | 72 ++++++++++++++++++++++
.../site/markdown/cli/usage/transforming-csv.md | 2 +-
2 files changed, 73 insertions(+), 1 deletion(-)
diff --git
a/freemarker-generator-cli/src/site/markdown/cli/introduction/getting-started.md
b/freemarker-generator-cli/src/site/markdown/cli/introduction/getting-started.md
index 5883b5a..a288348 100644
---
a/freemarker-generator-cli/src/site/markdown/cli/introduction/getting-started.md
+++
b/freemarker-generator-cli/src/site/markdown/cli/introduction/getting-started.md
@@ -21,10 +21,20 @@ Afterwards `Apache FreeMarker CLI` can be executed from the
command line
```
> which freemarker-cli
/Applications/Java/freemarker-cli-2.0.0/bin/freemarker-cli
+```
+
+and check the version of `Apache FreeMarker CLI`
+```
> freemarker-cli -V
version=0.1.0-SNAPSHOT, time=2020-06-25T21:48:02+0200,
commit=b320d00094be8789086ad6153d9d3fcaf4b8c75f
+```
+### Command Line Options
+
+`Apache FreeMarker CLI` provides command line help as shown below
+
+```
> freemarker-cli -h
Usage: freemarker-cli (-t=<templates> [-t=<templates>]... |
-i=<interactiveTemplate>) [-hV] [--stdin] [-b=<baseDir>]
@@ -67,4 +77,66 @@ Apache FreeMarker CLI
-V, --version Print version information and exit.
```
+### The Info Template
+
+The distribution ships with a couple of FreeMarker templates and the
`templates/info.ftl` is particularly helpful
+to better understand `Apache FreeMarker CLI`
+
+```
+> 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
+```
+* The "FreeMarker CLI Information" section provides insights into
configuration and currently processed template.
+* The "FreeMarker CLI Template Loader Directories" shows the template
directories being searched to resolve a template path
+* The "FreeMarker CLI Tools" section list the available tools
+* The "FreeMarker CLI Data Model" section shows all available entries in the
current FreeMarker context
diff --git
a/freemarker-generator-cli/src/site/markdown/cli/usage/transforming-csv.md
b/freemarker-generator-cli/src/site/markdown/cli/usage/transforming-csv.md
index ce54659..e6c056d 100644
--- a/freemarker-generator-cli/src/site/markdown/cli/usage/transforming-csv.md
+++ b/freemarker-generator-cli/src/site/markdown/cli/usage/transforming-csv.md
@@ -74,7 +74,7 @@ The delimiters are passed as symbolic names since passing
seperators breaks comm
* COMMA
* HASH
* PIPE
-* RS (ASCII record seperator)
+* RS (ASCII record separator)
* SEMICOLON
* SPACE
* TAB
