This is an automated email from the ASF dual-hosted git repository.
sgoeschl pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/freemarker-generator.git
The following commit(s) were added to refs/heads/master by this push:
new 652fa4d FREEMARKER-161 [freemarker-generator] Update documentation to
be in sync with previous refactorings
652fa4d is described below
commit 652fa4d2dcd02b9fcdd1996743884b99d37eeb0d
Author: Siegfried Goeschl <[email protected]>
AuthorDate: Thu Jan 7 22:01:46 2021 +0100
FREEMARKER-161 [freemarker-generator] Update documentation to be in sync
with previous refactorings
---
.../src/site/markdown/cli/usage/transforming-csv.md | 6 +++---
.../site/markdown/cli/usage/transforming-directories.md | 2 +-
.../src/site/markdown/cli/usage/using-dataframes.md | 14 ++++++++++----
3 files changed, 14 insertions(+), 8 deletions(-)
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 d87fa6c..e062b99 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
@@ -20,7 +20,7 @@ freemarker-generator \
-PCSV_TARGET_FORMAT=EXCEL \
-PCSV_TARGET_DELIMITER=SEMICOLON \
-t freemarker-generator/csv/csv/transform.ftl \
-
https://raw.githubusercontent.com/apache/freemarker-generator/master/freemarker-generator-cli/examples/data/csv/contract.csv
+
https://raw.githubusercontent.com/apache/freemarker-generator/master/freemarker-generator-cli/src/app/examples/data/csv/contract.csv
```
The command line invocation seems a bit complex at first so let's look at it
more closely
@@ -40,7 +40,7 @@ The following command line prints the resulting MarkDown to
`stdout`
freemarker-generator \
-PCSV_SOURCE_FORMAT=DEFAULT \
-t freemarker-generator/csv/md/transform.ftl \
-
https://raw.githubusercontent.com/apache/freemarker-generator/master/freemarker-generator-cli/examples/data/csv/contract.csv
+
https://raw.githubusercontent.com/apache/freemarker-generator/master/freemarker-generator-cli/src/app/examples/data/csv/contract.csv
```
Please note that most MarkDown tools expect a header row (see [Create a table
without a header in
Markdown](https://stackoverflow.com/questions/17536216/create-a-table-without-a-header-in-markdown))
@@ -53,7 +53,7 @@ Of course it is possible to convert a CSV to HTML as well
freemarker-generator \
-PCSV_SOURCE_FORMAT=DEFAULT \
-t freemarker-generator/csv/html/transform.ftl \
-
https://raw.githubusercontent.com/apache/freemarker-generator/master/freemarker-generator-cli/examples/data/csv/contract.csv
+
https://raw.githubusercontent.com/apache/freemarker-generator/master/freemarker-generator-cli/src/app/examples/data/csv/contract.csv
```
### CSV Configuration Options
diff --git
a/freemarker-generator-cli/src/site/markdown/cli/usage/transforming-directories.md
b/freemarker-generator-cli/src/site/markdown/cli/usage/transforming-directories.md
index 4eec217..2aa4e7f 100644
---
a/freemarker-generator-cli/src/site/markdown/cli/usage/transforming-directories.md
+++
b/freemarker-generator-cli/src/site/markdown/cli/usage/transforming-directories.md
@@ -41,7 +41,7 @@ If no output directory is provided all output is written to
`stdout`
```
freemarker-generator -t examples/data/template/
# == application.properties ==================================================
-server.name=localhost
+server.name=127.0.0.1
server.logs=/var/log/nginx
# == nginx-conf ==============================================================
server {
diff --git
a/freemarker-generator-cli/src/site/markdown/cli/usage/using-dataframes.md
b/freemarker-generator-cli/src/site/markdown/cli/usage/using-dataframes.md
index 893c804..9fbf9d2 100644
--- a/freemarker-generator-cli/src/site/markdown/cli/usage/using-dataframes.md
+++ b/freemarker-generator-cli/src/site/markdown/cli/usage/using-dataframes.md
@@ -38,13 +38,19 @@ and create a `DateFrame` using the following code snippet
The example can be executed by running
```
-bin/freemarker-generator -PCSV_SOURCE_FORMAT=DATAFRAME -t
examples/templates/dataframe/example.ftl examples/data/csv/dataframe.csv
+freemarker-generator \
+-PCSV_SOURCE_FORMAT=DATAFRAME \
+-t examples/templates/dataframe/example.ftl \
+examples/data/csv/dataframe.csv
```
or
```
-bin/freemarker-generator -PCSV_SOURCE_FORMAT=DATAFRAME -t
examples/templates/dataframe/example.ftl
https://raw.githubusercontent.com/nRo/DataFrame/master/src/test/resources/users.csv
+freemarker-generator \
+-PCSV_SOURCE_FORMAT=DATAFRAME \
+-t examples/templates/dataframe/example.ftl \
+https://raw.githubusercontent.com/nRo/DataFrame/master/src/test/resources/users.csv
```
#### Select By Age
@@ -156,8 +162,8 @@ it is a list of maps hence we invoke
`tools.dataframe.fromMaps()
```
freemarker-generator \
- -i
'${tools.dataframe.print(tools.dataframe.fromMaps(tools.gson.parse(dataSources?values[0])))}'
\
- examples/data/json/github-users.json
+-i
'${tools.dataframe.print(tools.dataframe.fromMaps(tools.gson.parse(dataSources?values[0])))}'
\
+examples/data/json/github-users.json
┌────────────┬────────────┬────────────┬────────────┬────────────┬────────────┬────────────┬────────────┬────────────┬────────────┬────────────┬────────────┬────────────┬────────────┬────────────┬────────────┬────────────┐
│#login │#id │#avatar_ur │#gravatar_ │#url │#html_url
│#followers │#following │#gists_url │#starred_u │#subscript │#organizat
│#repos_url │#events_ur │#received_ │#type │#site_admi │
