Merge pull request #61 from bamaer/HOP-2641
Hop 2641 escaped incorrect asciidoc parameter, variable evaluations
diff --git a/hop-user-manual/modules/ROOT/pages/hop-vs-kettle/hop-vs-kettle.adoc b/hop-user-manual/modules/ROOT/pages/hop-vs-kettle/hop-vs-kettle.adoc
index 9cbf6c9..77b5a50 100644
--- a/hop-user-manual/modules/ROOT/pages/hop-vs-kettle/hop-vs-kettle.adoc
+++ b/hop-user-manual/modules/ROOT/pages/hop-vs-kettle/hop-vs-kettle.adoc
@@ -1,5 +1,7 @@
[[HopvsKettle]]
:imagesdir: ../assets/images
+:openvar: ${
+:closevar: }
= Hop vs Kettle - A Quick Comparison
@@ -25,13 +27,13 @@
[width="90%", cols="2,3,3", options="header"]
|===
|Configuration|Kettle|Hop
-|System variables|${KETTLE_HOME}/.kettle/kettle.properties|${HOP_CONFIG_FOLDER}/hop-config.json or ./config/hop-config.json
-|GUI preferences (fonts, colors, preferences…)|${KETTLE_HOME}/.kettle/kettle.properties|${HOP_CONFIG_FOLDER}/hop-config.json or ./config/hop-config.json
-|Language choice|${KETTLE_HOME}/.kettle/.languageChoice|${HOP_CONFIG_FOLDER}/hop-config.json or ./config/hop-config.json
-|Shared objects|${KETTLE_HOME}/.kettle/shared.xml|All stored in Hop shared metadata
-|GUI usage information|${KETTLE_HOME}/.kettle/kettle.properties|${HOP_AUDIT_FOLDER}/<project>/
-|Shared metadata|${PENTAHO_METASTORE_FOLDER} or ${HOME}/.pentaho/metastore|${HOP_METADATA_FOLDER} or ${HOP_CONFIG_FOLDER}/metadata
-|Environment/Project configurations|${KETTLE_HOME}/.kettle/environment/metastore|${HOP_CONFIG_FOLDER}/hop-config.json or ./config/hop-config.json
+|System variables|{openvar}KETTLE_HOME{closevar}/.kettle/kettle.properties|{openvar}HOP_CONFIG_FOLDER{closevar}/hop-config.json or ./config/hop-config.json
+|GUI preferences (fonts, colors, preferences…)|{openvar}KETTLE_HOME{closevar}/.kettle/kettle.properties|{openvar}HOP_CONFIG_FOLDER{closevar}/hop-config.json or ./config/hop-config.json
+|Language choice|{openvar}KETTLE_HOME{closevar}/.kettle/.languageChoice|{openvar}HOP_CONFIG_FOLDER{closevar}/hop-config.json or ./config/hop-config.json
+|Shared objects|{openvar}KETTLE_HOME{closevar}/.kettle/shared.xml|All stored in Hop shared metadata
+|GUI usage information|{openvar}KETTLE_HOME{closevar}/.kettle/kettle.properties|{openvar}HOP_AUDIT_FOLDER{closevar}/<project>/
+|Shared metadata|{openvar}PENTAHO_METASTORE_FOLDER{closevar} or {openvar}HOME{closevar}/.pentaho/metastore|{openvar}HOP_METADATA_FOLDER{closevar} or {openvar}HOP_CONFIG_FOLDER{closevar}/metadata
+|Environment/Project configurations|{openvar}KETTLE_HOME{closevar}/.kettle/environment/metastore|{openvar}HOP_CONFIG_FOLDER{closevar}/hop-config.json or ./config/hop-config.json
|===
== Engines
diff --git a/hop-user-manual/modules/ROOT/pages/pipeline/create-pipeline.adoc b/hop-user-manual/modules/ROOT/pages/pipeline/create-pipeline.adoc
index 6d045d1..d10f0a2 100644
--- a/hop-user-manual/modules/ROOT/pages/pipeline/create-pipeline.adoc
+++ b/hop-user-manual/modules/ROOT/pages/pipeline/create-pipeline.adoc
@@ -151,4 +151,5 @@
|Property|Description|Type
|Enable transform performance monitoring|Enable performance monitoring for the transforms in this pipeline|boolean
|Transform performance measurement interval (ms)|The interval (milliseconds) to monitor the performance for the transforms in this pipeline|integer
-|Maximum number of snapshots in memory|the number of performance monitoring snapshots to keep in memory for the transforms in this pipeline|integer
\ No newline at end of file
+|Maximum number of snapshots in memory|the number of performance monitoring snapshots to keep in memory for the transforms in this pipeline|integer
+|===
\ No newline at end of file
diff --git a/hop-user-manual/modules/ROOT/pages/plugins/projects/projects.adoc b/hop-user-manual/modules/ROOT/pages/plugins/projects/projects.adoc
index 062d8da..4f15fc5 100644
--- a/hop-user-manual/modules/ROOT/pages/plugins/projects/projects.adoc
+++ b/hop-user-manual/modules/ROOT/pages/plugins/projects/projects.adoc
@@ -17,6 +17,9 @@
:documentationPath: /plugins/projects/
:language: en_US
:page-alternativeEditUrl: https://github.com/apache/incubator-hop/edit/master/plugins/misc/projects/src/main/doc/projects.adoc
+:openvar: ${
+:closevar: }
+
= Projects & Environments
This document explains the basic structure and working of the 'projects' plugin
@@ -273,7 +276,7 @@
* By referencing the ```samples``` project Hop knows where the project is located (```config/projects/samples```)
* Since we know the location of the project, we can specify pipelines and workflows with a relative path
* The project knows where its metadata is stored (```config/projects/samples/metadata```) so it knows where to find the ```Direct``` pipeline run configuration (```config/projects/samples/metadata/pipeline-run-configuration/Direct.json```)
-* This run configuration defines its own pipeline engine specific variables, in this case the output folder : ```DATA_OUTPUT=${PROJECT_HOME}/beam/output/```
+* This run configuration defines its own pipeline engine specific variables, in this case the output folder : ```DATA_OUTPUT={openvar}PROJECT_HOME{closevar}/beam/output/```
* The output of the samples is as such written to ```config/projects/samples/beam/output```
To reference an environment you can execute using ```-e``` or ```--environment```. The only difference is that you'll have a number of extra environment variables set while executing.
diff --git a/hop-user-manual/modules/ROOT/pages/plugins/transforms/dropboxinput.adoc b/hop-user-manual/modules/ROOT/pages/plugins/transforms/dropboxinput.adoc
index 2d240fc..9c5e088 100644
--- a/hop-user-manual/modules/ROOT/pages/plugins/transforms/dropboxinput.adoc
+++ b/hop-user-manual/modules/ROOT/pages/plugins/transforms/dropboxinput.adoc
@@ -24,7 +24,7 @@
NOTE: create a Dropbox api key in the Dropbox https://www.dropbox.com/developers/apps/create[console].
-### Fields
+## Fields
[width="90%", options="header"]
|===
diff --git a/hop-user-manual/modules/ROOT/pages/plugins/transforms/dropboxoutput.adoc b/hop-user-manual/modules/ROOT/pages/plugins/transforms/dropboxoutput.adoc
index a5f5b62..847d063 100644
--- a/hop-user-manual/modules/ROOT/pages/plugins/transforms/dropboxoutput.adoc
+++ b/hop-user-manual/modules/ROOT/pages/plugins/transforms/dropboxoutput.adoc
@@ -24,7 +24,7 @@
NOTE: create a Dropbox api key in the Dropbox https://www.dropbox.com/developers/apps/create[console].
-### Fields
+## Fields
[width="90%", options="header"]
|===
diff --git a/hop-user-manual/modules/ROOT/pages/projects/environments.adoc b/hop-user-manual/modules/ROOT/pages/projects/environments.adoc
index 77e2486..cf45896 100644
--- a/hop-user-manual/modules/ROOT/pages/projects/environments.adoc
+++ b/hop-user-manual/modules/ROOT/pages/projects/environments.adoc
@@ -1,5 +1,7 @@
[[HopEnvironments]]
:imagesdir: ../../../assets/images
+:openvar: ${
+:closevar: }
= Environments
@@ -33,9 +35,9 @@
|Description|A description for this environment|No|No|
|Company|The company this environment belongs to|No|No|
|Department|The department this environment is created for|No|No|
-|Metadata base folder|The folder where this environment's metadata will be stored|Yes|Yes|${ENVIRONMENT_HOME}/metadata
-|Unit test base path|The folder where this environment's unit tests will be stored|Yes|Yes|${ENVIRONMENT_HOME}
-|Data Sets CSV Folder|The folder where this environment's data files will be stored|Yes|Yes|${ENVIRONMENT_HOME}/datasets
+|Metadata base folder|The folder where this environment's metadata will be stored|Yes|Yes|{openvar}ENVIRONMENT_HOME{closevar}/metadata
+|Unit test base path|The folder where this environment's unit tests will be stored|Yes|Yes|{openvar}ENVIRONMENT_HOME{closevar}
+|Data Sets CSV Folder|The folder where this environment's data files will be stored|Yes|Yes|{openvar}ENVIRONMENT_HOME{closevar}/datasets
|Enforce execution in environment home|Give an error when trying to execute a pipeline or workflow which is not located in the environment home directory or in a sub-directory|Yes|Yes|checked
|Project variables to set|A list of variable names, values and variable descriptions to use with this project|No|Yes|
|===
diff --git a/hop-user-manual/modules/ROOT/pages/variables.adoc b/hop-user-manual/modules/ROOT/pages/variables.adoc
index bf21e8c..42c001e 100644
--- a/hop-user-manual/modules/ROOT/pages/variables.adoc
+++ b/hop-user-manual/modules/ROOT/pages/variables.adoc
@@ -1,5 +1,8 @@
[[Variables]]
:imagesdir: ../assets/images
+:openvar: ${
+:closevar: }
+
= Variables
== What is a Hop variable?
diff --git a/hop-user-manual/modules/ROOT/pages/workflow/run-debug-workflow.adoc b/hop-user-manual/modules/ROOT/pages/workflow/run-debug-workflow.adoc
index c705ca7..d07ec11 100644
--- a/hop-user-manual/modules/ROOT/pages/workflow/run-debug-workflow.adoc
+++ b/hop-user-manual/modules/ROOT/pages/workflow/run-debug-workflow.adoc
@@ -3,7 +3,7 @@
= Run and Debug a Workflow
-=== Run your first Workflow
+== Run your first Workflow
As with designing workflows, the steps to run a workflow are very similar to running a pipeline.
diff --git a/hop-user-manual/modules/ROOT/pages/workflow/workflow-run-configurations/workflow-run-configurations.adoc b/hop-user-manual/modules/ROOT/pages/workflow/workflow-run-configurations/workflow-run-configurations.adoc
index d6d82a3..aea4222 100644
--- a/hop-user-manual/modules/ROOT/pages/workflow/workflow-run-configurations/workflow-run-configurations.adoc
+++ b/hop-user-manual/modules/ROOT/pages/workflow/workflow-run-configurations/workflow-run-configurations.adoc
@@ -30,4 +30,5 @@
|Engine type a|
The available engine types are:
*Local workflwo engine*: this configuration runs pipelines on your machine
-*Remote workflow engine*: this configuration runs workflows on a Hop Server using a defined Run Configuration.
\ No newline at end of file
+*Remote workflow engine*: this configuration runs workflows on a Hop Server using a defined Run Configuration.
+|===
\ No newline at end of file
