You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@freemarker.apache.org by sg...@apache.org on 2020/06/27 16:21:03 UTC
[freemarker-generator] 02/02: FREEMARKER-147 Complete Maven site
documenation
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
commit 03d800ffa99edcc4a6d5eca8c6dfc6edeaf788d5
Author: Siegfried Goeschl <si...@gmail.com>
AuthorDate: Sat Jun 27 18:20:45 2020 +0200
FREEMARKER-147 Complete Maven site documenation
---
freemarker-generator-cli/pom.xml | 3 ---
.../src/site/markdown/cli/concepts/data-models.md | 2 +-
.../src/site/markdown/cli/concepts/data-sources.md | 12 ++++++------
.../src/site/markdown/cli/concepts/named-uris.md | 8 ++++----
.../src/site/markdown/cli/concepts/passing-data.md | 6 +++---
.../markdown/cli/usage/transforming-directories.md | 18 +++++++++---------
6 files changed, 23 insertions(+), 26 deletions(-)
diff --git a/freemarker-generator-cli/pom.xml b/freemarker-generator-cli/pom.xml
index db85554..2ff67d5 100644
--- a/freemarker-generator-cli/pom.xml
+++ b/freemarker-generator-cli/pom.xml
@@ -73,9 +73,6 @@
<target>
<copy file="README.md" todir="./target/appassembler" />
<copy file="./src/main/scripts/run-examples.sh" todir="./target/appassembler" />
- <copy todir="./target/appassembler/site">
- <fileset dir="site" />
- </copy>
<copy todir="./target/appassembler/templates">
<fileset dir="templates" />
</copy>
diff --git a/freemarker-generator-cli/src/site/markdown/cli/concepts/data-models.md b/freemarker-generator-cli/src/site/markdown/cli/concepts/data-models.md
index 7c53574..25bb3f9 100644
--- a/freemarker-generator-cli/src/site/markdown/cli/concepts/data-models.md
+++ b/freemarker-generator-cli/src/site/markdown/cli/concepts/data-models.md
@@ -74,7 +74,7 @@ The following snippet shows a more advanced example
> export DB_CONFIG='{"db_default_user":"scott","db_default_password":"tiger"}'
> echo $DB_CONFIG
{"db_default_user":"scott","db_default_password":"tiger"}
-> bin/freemarker-cli -m config=env:///DB_CONFIG#mimetype=application/json -i '<#list config as name,value>${name}=${value}${"\n"}</#list>'
+> freemarker-cli -m config=env:///DB_CONFIG#mimetype=application/json -i '<#list config as name,value>${name}=${value}${"\n"}</#list>'
db_default_user=scott
db_default_password=tiger
```
\ No newline at end of file
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 c97873c..1a921fc 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,7 +13,7 @@ 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
```
-bin/freemarker-cli -t templates/info.ftl README.md
+freemarker-cli -t templates/info.ftl README.md
FreeMarker CLI DataSources
------------------------------------------------------------------------------
@@ -24,7 +24,7 @@ FreeMarker CLI DataSources
from an URL
```
-bin/freemarker-cli --data-source xkcd=https://xkcd.com/info.0.json -t templates/info.ftl
+freemarker-cli --data-source xkcd=https://xkcd.com/info.0.json -t templates/info.ftl
FreeMarker CLI DataSources
------------------------------------------------------------------------------
@@ -36,7 +36,7 @@ or from an environment variable, e.g. `NGINX_CONF` having a JSON payload
```
export NGINX_CONF='{"NGINX_PORT":"8443","NGINX_HOSTNAME":"localhost"}'
-bin/freemarker-cli -t templates/info.ftl -s conf=env:///NGINX_CONF#mimetype=application/json
+freemarker-cli -t templates/info.ftl -s conf=env:///NGINX_CONF#mimetype=application/json
FreeMarker CLI DataSources
------------------------------------------------------------------------------
@@ -47,7 +47,7 @@ FreeMarker CLI DataSources
Of course you can load multiple `DataSources` directly
```
-bin/freemarker-cli -t templates/info.ftl README.md xkcd=https://xkcd.com/info.0.json
+freemarker-cli -t templates/info.ftl README.md xkcd=https://xkcd.com/info.0.json
FreeMarker CLI DataSources
------------------------------------------------------------------------------
@@ -60,7 +60,7 @@ FreeMarker CLI DataSources
or load them from a directory
```
-bin/freemarker-cli -t templates/info.ftl -s examples/data
+freemarker-cli -t templates/info.ftl -s examples/data
FreeMarker CLI DataSources
------------------------------------------------------------------------------
[#1], name=combined-access.log, group=default, contentType=text/plain, charset=UTF-8, length=2,068 Bytes
@@ -74,7 +74,7 @@ FreeMarker CLI DataSources
which can be combined with `include` and `exclude` filters
```
-bin/freemarker-cli -t templates/info.ftl -s examples/data --data-source-include=*.json
+freemarker-cli -t templates/info.ftl -s examples/data --data-source-include=*.json
FreeMarker CLI DataSources
------------------------------------------------------------------------------
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 693efac..58f9faa 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,7 +29,7 @@ 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`
```
-bin/freemarker-cli -t templates/info.ftl my_users=examples/data/csv/user.csv
+freemarker-cli -t templates/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
```
@@ -37,7 +37,7 @@ URI : file: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
```
-bin/freemarker-cli -t templates/info.ftl my_users=examples/data/csv/user.csv#charset=UTF-16
+freemarker-cli -t templates/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
```
@@ -45,7 +45,7 @@ URI : file:examples/data/csv/user.csv
In addition to the simplified file syntax full URIs can be used
```
-bin/freemarker-cli -t templates/info.ftl http://google.com?foo=bar
+freemarker-cli -t templates/info.ftl http://google.com?foo=bar
[#1], name=google.com, group=default, contentType=text/html, charset=ISO-8859-1, length=-1 Bytes
URI : http://google.com?foo=bar
```
@@ -53,7 +53,7 @@ URI : http://google.com?foo=bar
and also combined with a name
```
-bin/freemarker-cli -t templates/info.ftl page=http://google.com?foo=bar
+freemarker-cli -t templates/info.ftl page=http://google.com?foo=bar
[#1], name=page, group=default, contentType=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/concepts/passing-data.md b/freemarker-generator-cli/src/site/markdown/cli/concepts/passing-data.md
index 71f1b75..eb6110e 100644
--- a/freemarker-generator-cli/src/site/markdown/cli/concepts/passing-data.md
+++ b/freemarker-generator-cli/src/site/markdown/cli/concepts/passing-data.md
@@ -23,7 +23,7 @@ User-supplied parameters allow to pass additional information to an Apache FreeM
Pass a simple name/value pair on the command line
```
-> bin/freemarker-cli -t templates/info.ftl -P key=value
+> freemarker-cli -t templates/info.ftl -P key=value
User Supplied Parameters
------------------------------------------------------------------------------
@@ -33,7 +33,7 @@ User Supplied Parameters
By providing a `group` you can create nested maps
```
-> bin/freemarker-cli -t templates/info.ftl -P foo1:group=bar1 -P foo2:group=bar2
+> freemarker-cli -t templates/info.ftl -P foo1:group=bar1 -P foo2:group=bar2
User Supplied Parameters
------------------------------------------------------------------------------
@@ -43,7 +43,7 @@ User Supplied Parameters
It is also possible to mix and match the two approaches
```
-> bin/freemarker-cli -t templates/info.ftl -P foo1:group=bar1 -P foo2:group=bar2 -P key=value
+> freemarker-cli -t templates/info.ftl -P foo1:group=bar1 -P foo2:group=bar2 -P key=value
User Supplied Parameters
------------------------------------------------------------------------------
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 412a057..ad694fb 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
@@ -39,7 +39,7 @@ server {
If no output directory is provided all output is written to `stdout`
```
-bin/freemarker-cli -t examples/data/template/
+freemarker-cli -t examples/data/template/
# == application.properties ==================================================
server.name=localhost
server.logs=/var/log/nginx
@@ -60,7 +60,7 @@ The transformed templates are written to an `out` directory
* `nginx.conf.ftl` was changed to `nginx.conf" during the transformation
```
-bin/freemarker-cli -t examples/data/template/ -o out; tree out
+freemarker-cli -t examples/data/template/ -o out; tree out
out
|-- application.properties
`-- nginx
@@ -74,7 +74,7 @@ out
A user-supplied parameter `NGINX_HOSTNAME` is used to render the templates
```
-bin/freemarker-cli -t examples/data/template/ -P NGINX_HOSTNAME=localhost
+freemarker-cli -t examples/data/template/ -P NGINX_HOSTNAME=localhost
# == application.properties ==================================================
server.name=localhost
server.logs=/var/log/nginx
@@ -97,7 +97,7 @@ All environment variables can be copied to the top-level data model by providing
```
export NGINX_PORT=8080
-bin/freemarker-cli -t examples/data/template/ -m env:///
+freemarker-cli -t examples/data/template/ -m env:///
# == application.properties ==================================================
server.name=localhost
server.logs=/var/log/nginx
@@ -117,7 +117,7 @@ Instead of environment variables an environment file (aka properties file) can b
```
echo "NGINX_PORT=8080" > nginx.env
-bin/freemarker-cli -t examples/data/template/ -m nginx.env
+freemarker-cli -t examples/data/template/ -m nginx.env
# == application.properties ==================================================
server.name=localhost
server.logs=/var/log/nginx
@@ -137,7 +137,7 @@ Another option is passing the information as JSON file
```
echo '{"NGINX_PORT":"8443","NGINX_HOSTNAME":"localhost"}' > nginx.json
-bin/freemarker-cli -t examples/data/template/ -m nginx.json
+freemarker-cli -t examples/data/template/ -m nginx.json
# == application.properties ==================================================
server.name=localhost
server.logs=/var/log/nginx
@@ -157,7 +157,7 @@ Yet another option is using a YAML file
```
echo -e "- NGINX_PORT": "\"8443\"\n- NGINX_HOSTNAME": "localhost" > nginx.yaml
-bin/freemarker-cli -t examples/data/template/ -m nginx.yaml
+freemarker-cli -t examples/data/template/ -m nginx.yaml
# == application.properties ==================================================
server.name=localhost
server.logs=/var/log/nginx
@@ -180,7 +180,7 @@ In the cloud it is common to pass JSON configuration as environment variable
```
export NGINX_CONF='{"NGINX_PORT":"8443","NGINX_HOSTNAME":"localhost"}'
-bin/freemarker-cli -t examples/data/template/ -m env:///NGINX_CONF#mimetype=application/json
+freemarker-cli -t examples/data/template/ -m env:///NGINX_CONF#mimetype=application/json
# == application.properties ==================================================
server.name=localhost
server.logs=/var/log/nginx
@@ -200,7 +200,7 @@ For testing purpose it is useful to override certain settings
```
export NGINX_CONF='{"NGINX_PORT":"8443","NGINX_HOSTNAME":"localhost"}'
-bin/freemarker-cli -t examples/data/template/ -PNGINX_HOSTNAME=www.mydomain.com -m env:///NGINX_CONF#mimetype=application/json
+freemarker-cli -t examples/data/template/ -PNGINX_HOSTNAME=www.mydomain.com -m env:///NGINX_CONF#mimetype=application/json
# == application.properties ==================================================
server.name=www.mydomain.com
server.logs=/var/log/nginx