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 0695c04 FREEMARKER-161 [freemarker-generator] Replace any
"freemarker-cli" invocation with "freemarker-generator"
0695c04 is described below
commit 0695c048a8f518db10608cc7d5a8e553d5c004d6
Author: Siegfried Goeschl <[email protected]>
AuthorDate: Thu Jan 7 21:50:54 2021 +0100
FREEMARKER-161 [freemarker-generator] Replace any "freemarker-cli"
invocation with "freemarker-generator"
---
.../src/site/markdown/cli/concepts/data-sources.md | 51 +++++++++++-----------
.../src/site/markdown/cli/concepts/named-uris.md | 32 +++++++++-----
.../site/markdown/cli/usage/using-dataframes.md | 8 ++--
3 files changed, 51 insertions(+), 40 deletions(-)
diff --git
a/freemarker-generator-cli/src/site/markdown/cli/concepts/data-sources.md
b/freemarker-generator-cli/src/site/markdown/cli/concepts/data-sources.md
index d0cdef7..53dd6bf 100644
--- a/freemarker-generator-cli/src/site/markdown/cli/concepts/data-sources.md
+++ b/freemarker-generator-cli/src/site/markdown/cli/concepts/data-sources.md
@@ -13,75 +13,74 @@ A `DataSource` consists of lazy-loaded data available in
Apache FreeMarker's mod
A `DataSource` can be loaded from the file system, e.g. as positional command
line argument
```
-freemarker-cli -t freemarker-generator/info.ftl README.md
+freemarker-generator -t freemarker-generator/info.ftl README.md
FreeMarker Generator DataSources
------------------------------------------------------------------------------
- [#1], name=README.md, group=default, contentType=text/markdown,
charset=UTF-8, length=57,188 Bytes
- URI :
file:/Users/sgoeschl/work/github/apache/freemarker-generator/freemarker-generator-cli/target/appassembler/README.md
+[#1], name=README.md, group=default, contentType=text/markdown, charset=UTF-8,
length=57,188 Bytes
+URI :
file:/Users/sgoeschl/work/github/apache/freemarker-generator/freemarker-generator-cli/target/appassembler/README.md
```
from an URL
```
-freemarker-cli --data-source xkcd=https://xkcd.com/info.0.json -t
freemarker-generator/info.ftl
+freemarker-generator --data-source xkcd=https://xkcd.com/info.0.json -t
freemarker-generator/info.ftl
FreeMarker Generator DataSources
------------------------------------------------------------------------------
- [#1], name=xkcd, group=default, contentType=application/json,
charset=UTF-8, length=-1 Bytes
- URI : https://xkcd.com/info.0.json
+[#1]: name=xkcd, group=default, fileName=xkcd mimeType=application/json,
charset=UTF-8, length=-1 Bytes
+URI : https://xkcd.com/info.0.json
```
or from an environment variable, e.g. `NGINX_CONF` having a JSON payload
```
export NGINX_CONF='{"NGINX_PORT":"8443","NGINX_HOSTNAME":"localhost"}'
-freemarker-cli -t freemarker-generator/info.ftl -s
conf=env:///NGINX_CONF#mimeType=application/json
+freemarker-generator -t freemarker-generator/info.ftl -s
conf=env:///NGINX_CONF#mimeType=application/json
FreeMarker Generator DataSources
------------------------------------------------------------------------------
- [#1], name=conf, group=default, contentType=application/json,
charset=UTF-8, length=50 Bytes
- URI : env:///NGINX_CONF
+[#1]: name=conf, group=default, fileName=conf mimeType=application/json,
charset=UTF-8, length=50 Bytes
+URI : env:///NGINX_CONF
```
Of course you can load multiple `DataSources` directly
```
-freemarker-cli -t freemarker-generator/info.ftl README.md
xkcd=https://xkcd.com/info.0.json
+freemarker-generator -t freemarker-generator/info.ftl README.md
xkcd=https://xkcd.com/info.0.json
FreeMarker Generator DataSources
------------------------------------------------------------------------------
- [#1], name=README.md, group=default, contentType=text/markdown,
charset=UTF-8, length=57,188 Bytes
- URI :
file:/Users/sgoeschl/work/github/apache/freemarker-generator/freemarker-generator-cli/target/appassembler/README.md
- [#2], name=xkcd, group=default, contentType=application/json,
charset=UTF-8, length=-1 Bytes
- URI : https://xkcd.com/info.0.json
+[#1]:
name=file:/Users/sgoeschl/work/github/apache/freemarker-generator/freemarker-generator-cli/target/appassembler/README.md,
group=default, fileName=README.md mimeType=text/markdown, charset=UTF-8,
length=6,802 Bytes
+URI :
file:/Users/sgoeschl/work/github/apache/freemarker-generator/freemarker-generator-cli/target/appassembler/README.md
+[#2]: name=xkcd, group=default, fileName=xkcd mimeType=application/json,
charset=UTF-8, length=-1 Bytes
+URI : https://xkcd.com/info.0.json
```
or load them from a directory
```
-freemarker-cli -t freemarker-generator/info.ftl -s examples/data
+freemarker-generator -t freemarker-generator/info.ftl -s examples/data
FreeMarker Generator DataSources
------------------------------------------------------------------------------
- [#1], name=combined-access.log, group=default, contentType=text/plain,
charset=UTF-8, length=2,068 Bytes
- URI :
file:/Users/sgoeschl/work/github/apache/freemarker-generator/freemarker-generator-cli/target/appassembler/examples/data/accesslog/combined-access.log
- ...
- [#22], name=swagger-spec.yaml, group=default, contentType=text/yaml,
charset=UTF-8, length=17,555 Bytes
- URI :
file:/Users/sgoeschl/work/github/apache/freemarker-generator/freemarker-generator-cli/target/appassembler/examples/data/yaml/swagger-spec.yaml
-
+[#1]:
name=file:/Users/sgoeschl/work/github/apache/freemarker-generator/freemarker-generator-cli/target/appassembler/examples/data/accesslog/combined-access.log,
group=default, fileName=combined-access.log mimeType=text/plain,
charset=UTF-8, length=2,068 Bytes
+URI :
file:/Users/sgoeschl/work/github/apache/freemarker-generator/freemarker-generator-cli/target/appassembler/examples/data/accesslog/combined-access.log
...
+...
+[#25]:
name=file:/Users/sgoeschl/work/github/apache/freemarker-generator/freemarker-generator-cli/target/appassembler/examples/data/yaml/swagger-spec.yaml,
group=default, fileName=swagger-spec.yaml mimeType=text/yaml, charset=UTF-8,
length=17,555 Bytes
+URI :
file:/Users/sgoeschl/work/github/apache/freemarker-generator/freemarker-generator-cli/target/appassembler/examples/data/yaml/swagger-spec.yaml
```
which can be combined with `include` and `exclude` filters
```
-freemarker-cli -t freemarker-generator/info.ftl -s examples/data
--data-source-include=*.json
+freemarker-generator -t freemarker-generator/info.ftl -s examples/data
--data-source-include='*.json'
FreeMarker Generator DataSources
------------------------------------------------------------------------------
- [#1], name=github-users.json, group=default, contentType=application/json,
charset=UTF-8, length=7,168 Bytes
- URI :
file:/Users/sgoeschl/work/github/apache/freemarker-generator/freemarker-generator-cli/target/appassembler/examples/data/json/github-users.json
- [#2], name=swagger-spec.json, group=default, contentType=application/json,
charset=UTF-8, length=24,948 Bytes
- URI :
file:/Users/sgoeschl/work/github/apache/freemarker-generator/freemarker-generator-cli/target/appassembler/examples/data/json/swagger-spec.json
+[#1]:
name=file:/Users/sgoeschl/work/github/apache/freemarker-generator/freemarker-generator-cli/target/appassembler/examples/data/json/github-users.json,
group=default, fileName=github-users.json mimeType=application/json,
charset=UTF-8, length=7,168 Bytes
+URI :
file:/Users/sgoeschl/work/github/apache/freemarker-generator/freemarker-generator-cli/target/appassembler/examples/data/json/github-users.json
+[#2]:
name=file:/Users/sgoeschl/work/github/apache/freemarker-generator/freemarker-generator-cli/target/appassembler/examples/data/json/swagger-spec.json,
group=default, fileName=swagger-spec.json mimeType=application/json,
charset=UTF-8, length=24,948 Bytes
+URI :
file:/Users/sgoeschl/work/github/apache/freemarker-generator/freemarker-generator-cli/target/appassembler/examples/data/json/swagger-spec.json```
```
### Selecting A DataSource
diff --git
a/freemarker-generator-cli/src/site/markdown/cli/concepts/named-uris.md
b/freemarker-generator-cli/src/site/markdown/cli/concepts/named-uris.md
index b2c2fe3..55bf420 100644
--- a/freemarker-generator-cli/src/site/markdown/cli/concepts/named-uris.md
+++ b/freemarker-generator-cli/src/site/markdown/cli/concepts/named-uris.md
@@ -29,31 +29,43 @@ For our purposes, the scheme and the path components are
especially important, t
The following Named URI loads a "user.csv" and the data source is available as
`my_users`
```
-freemarker-cli -t freemarker-generator/info.ftl
my_users=examples/data/csv/user.csv
-[#1], name=my_users, group=default, contentType=text/csv, charset=UTF-8,
length=376 Bytes
-URI : file:examples/data/csv/user.csv
+freemarker-generator -t freemarker-generator/info.ftl
my_users=examples/data/csv/user.csv
+
+FreeMarker Generator DataSources
+------------------------------------------------------------------------------
+[#1]: name=my_users, group=default, fileName=my_users mimeType=text/csv,
charset=UTF-8, length=376 Bytes
+URI :
file:/Users/sgoeschl/work/github/apache/freemarker-generator/freemarker-generator-cli/target/appassembler/examples/data/csv/user.csv
```
A Named URI allows to pass additional information as part of the fragment,
e.g. the charset of the text file
```
-freemarker-cli -t freemarker-generator/info.ftl
my_users=examples/data/csv/user.csv#charset=UTF-16
-[#1], name=my_users, group=default, contentType=text/csv, charset=UTF-16,
length=376 Bytes
-URI : file:examples/data/csv/user.csv
+freemarker-generator -t freemarker-generator/info.ftl
my_users=examples/data/csv/user.csv#charset=UTF-16
+
+FreeMarker Generator DataSources
+------------------------------------------------------------------------------
+[#1]: name=my_users, group=default, fileName=my_users mimeType=text/csv,
charset=UTF-16, length=376 Bytes
+URI :
file:/Users/sgoeschl/work/github/apache/freemarker-generator/freemarker-generator-cli/target/appassembler/examples/data/csv/user.csv
```
In addition to the simplified file syntax full URIs can be used
```
-freemarker-cli -t freemarker-generator/info.ftl http://google.com?foo=bar
-[#1], name=google.com, group=default, contentType=text/html,
charset=ISO-8859-1, length=-1 Bytes
+freemarker-generator -t freemarker-generator/info.ftl http://google.com?foo=bar
+
+FreeMarker Generator DataSources
+------------------------------------------------------------------------------
+[#1]: name=http://google.com?foo=bar, group=default,
fileName=google.com?foo=bar mimeType=text/html, charset=ISO-8859-1, length=-1
Bytes
URI : http://google.com?foo=bar
```
and also combined with a name
```
-freemarker-cli -t freemarker-generator/info.ftl page=http://google.com?foo=bar
-[#1], name=page, group=default, contentType=text/html, charset=ISO-8859-1,
length=-1 Bytes
+freemarker-generator -t freemarker-generator/info.ftl
page=http://google.com\?foo\=bar
+
+FreeMarker Generator DataSources
+------------------------------------------------------------------------------
+[#1]: name=page, group=default, fileName=page mimeType=text/html,
charset=ISO-8859-1, length=-1 Bytes
URI : http://google.com?foo=bar
```
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 ff19878..893c804 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,13 @@ and create a `DateFrame` using the following code snippet
The example can be executed by running
```
-bin/freemarker-cli -PCSV_SOURCE_FORMAT=DATAFRAME -t
examples/templates/dataframe/example.ftl examples/data/csv/dataframe.csv
+bin/freemarker-generator -PCSV_SOURCE_FORMAT=DATAFRAME -t
examples/templates/dataframe/example.ftl examples/data/csv/dataframe.csv
```
or
```
-bin/freemarker-cli -PCSV_SOURCE_FORMAT=DATAFRAME -t
examples/templates/dataframe/example.ftl
https://raw.githubusercontent.com/nRo/DataFrame/master/src/test/resources/users.csv
+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
```
#### Select By Age
@@ -155,7 +155,7 @@ data being parsed as a list of maps and print the JSON as
dataframe. Technically
it is a list of maps hence we invoke `tools.dataframe.fromMaps()
```
-freemarker-cli \
+freemarker-generator \
-i
'${tools.dataframe.print(tools.dataframe.fromMaps(tools.gson.parse(dataSources?values[0])))}'
\
examples/data/json/github-users.json
@@ -195,7 +195,7 @@ Let's transform an Excel Sheet to a `DataFrame` being
printed using the followin
which is rendered by the following command line invocation
```
-freemarker-cli -t examples/templates/excel/dataframe/transform.ftl
examples/data/excel/test.xls
+freemarker-generator -t examples/templates/excel/dataframe/transform.ftl
examples/data/excel/test.xls
┌────────────┬────────────┬────────────┬────────────┬────────────┬────────────┬────────────┐
│#Text │#Date │#Number │#Currency │#Time │#Percentag
│#Forumula │
