Merge pull request #72 from toeb/becker

Templating

Author: toeb

README.md

@@ -17,9 +17,7 @@ Look through the files in the package.  Most functions will be commented and the
 # Feature Overview
 
 `cmakepp` has a lot of different functions. I tried to subdivide them into some meaningful sections. 
-C:/Users/Tobi/Documents/projects/cmakepp
-cmake
-cmake
+
 
 * [Collections](cmake/collections/README.md)
 * [Date/Time](cmake/datetime/README.md)
@@ -38,7 +36,7 @@ cmake
 * [Parsing and handling semantic versions](cmake/semver/README.md)
 * [String Functions](cmake/string/README.md)
 * [Targets](cmake/targets/README.md)
-* [Templating ](cmake/template/README.md)
+* [Templating ](cmake/templating/README.md)
 * [Uniform Resource Identifiers (URIs)](cmake/uri/README.md)
 * [HTTP Client](cmake/web/README.md)
 
@@ -67,9 +65,9 @@ I have developed some samples to show off `cmakepp`'s capabilities. Here you can
 
 
 
-# Installation 
+# Getting `cmakepp` 
 
-You have multiple options to install `cmakepp` the only prerequisite for all options is that cmake is installed with version `>=2.8.7` - I recommend `>=2.8.23`. You will be notified if a function only works with a more current version of cmake. 
+You have multiple options to install `cmakepp` the only prerequisite for all options is that [`CMake`](http://www.cmake.org) is installed with a version `>=2.8.12`.  `cmakepp` will also work with version less than `2.8.12` however some functions might fail.
 
 
 * [Install by Console](#install_console) - Recommended

README.md.in

@@ -13,14 +13,14 @@
 Look through the files in the package.  Most functions will be commented and the other's usage can be inferred.  All functions are avaiable as soon as you include the `cmakepp.cmake` file.  To find functionality browse the `README.md` files throughout this project.
 
 
-<%=template_run("cmake/README.md.in")%>
+<%=template_run_file("cmake/README.md.in")%>
 
 
-<%=template_run("samples/README.md.in")%>
+<%=template_run_file("samples/README.md.in")%>
 
-# Installation 
+# Getting `cmakepp` 
 
-You have multiple options to install `cmakepp` the only prerequisite for all options is that cmake is installed with version `>=2.8.7` - I recommend `>=2.8.23`. You will be notified if a function only works with a more current version of cmake. 
+You have multiple options to install `cmakepp` the only prerequisite for all options is that [`CMake`](http://www.cmake.org) is installed with a version `>=2.8.12`.  `cmakepp` will also work with version less than `2.8.12` however some functions might fail.
 
 
 * [Install by Console](#install_console) - Recommended
@@ -136,8 +136,8 @@ I am a bit a hypocrit. I am trying to adhere to these rules though:
 To describe cmake functions I use formalisms which I found most useful they should be intuitively understandable but here I want to describe them in detail.
 
 
-* `@` denotes character data
-* `<string> ::= "\""@"\""` denotes a string literal
+* `@@` denotes character data
+* `<string> ::= "\""@@"\""` denotes a string literal
 * `<regex> ::= /<string>/` denotes a regular expression (as cmake defines it)
 * `<identifier> ::= /[a-zA-Z0-9_-]+/` denotes a identifier which can be used for definitions
 * `<datatype> ::= "<" "any"|"bool"|"number"|""|"void"|""|<structured data> <?"...">">"` denotes a datatype the elipses denotes that multiple values in array form are described else the datatype can be `any`, `bool`, `number`, `<structured data>` etc.. 
@@ -153,7 +153,7 @@ To describe cmake functions I use formalisms which I found most useful they shou
 * `<named function parameter>`
 * `<function parameter> ::= <definition>|<named function parameter>`
 * `<function definition> `
-* ... @todo
+* ... @@todo
 
 
 ## <a name="return"></a>Returning values
@@ -214,8 +214,8 @@ This is possible by overwriting CMakes default return() function with a macro. I
 <%=cmakepp_cli(http_get http://httpbin.org/get?key=value --silent --json --json)%>
 
 ## parse an uri using the cmakepp alias
-> cmakepp uri http+https://toeb:[email protected]/path/to/file.ext?key=value&key2.subkey=value2 --select "scheme: @scheme key2.subkey: @params.key2.subkey"
-<%=cmakepp_cli(uri http+https://toeb:[email protected]/path/to/file.ext?key=value&key2.subkey=value2 --silent --select "scheme: @scheme key2.subkey: @params.key2.subkey")%>
+> cmakepp uri http+https://toeb:pass@@www.example.com/path/to/file.ext?key=value&key2.subkey=value2 --select "scheme: @@scheme key2.subkey: @@params.key2.subkey"
+<%=cmakepp_cli(uri http+https://toeb:pass@@www.example.com/path/to/file.ext?key=value&key2.subkey=value2 --silent --select "scheme: @@scheme key2.subkey: @@params.key2.subkey")%>
 ```
 
 ## <a name="icmake"></a>Interactive CMake Shell
@@ -232,12 +232,12 @@ icmake> cd /usr/tobi
 "/usr/tobi"
 icmake> pwd
 "/usr/tobi"
-icmake> @echo off
+icmake> @@echo off
 echo is now off
 icmake> pwd
 icmake> message("${ANS}")
 /usr/tobi
-icmake> @echo on
+icmake> @@echo on
 echo is now on
 icmake> function(myfunc name)\  # <-- backslash allows multiline input
           message("hello ${name}") \

cmake/README.md

@@ -2,9 +2,7 @@
 # Feature Overview
 
 `cmakepp` has a lot of different functions. I tried to subdivide them into some meaningful sections. 
-C:/Users/Tobi/Documents/projects/cmakepp/cmake
-C:/Users/Tobi/Documents/projects/cmakepp/cmake
-C:/Users/Tobi/Documents/projects/cmakepp/cmake
+
 
 * [Collections](collections/README.md)
 * [Date/Time](datetime/README.md)
@@ -23,7 +21,7 @@ C:/Users/Tobi/Documents/projects/cmakepp/cmake
 * [Parsing and handling semantic versions](semver/README.md)
 * [String Functions](string/README.md)
 * [Targets](targets/README.md)
-* [Templating ](template/README.md)
+* [Templating ](templating/README.md)
 * [Uniform Resource Identifiers (URIs)](uri/README.md)
 * [HTTP Client](web/README.md)
 

cmake/cmakepp/cmakepp_compile_docs.cmake

@@ -9,7 +9,7 @@ function(cmakepp_compile_docs)
       get_filename_component(template_dir "${template_path}" PATH)
       set(output_file "${template_dir}/README.md")
       message("generating ${output_file}")
-      template_run("${template_path}")
+      template_run_file("${template_path}")
       ans(generated_content)
       fwrite("${output_file}" "${generated_content}")
   endforeach()

cmake/log/log.cmake

@@ -27,7 +27,7 @@
 ## ```
 ## log("this is a simple error" --error) => <% 
 ##   log("this is a simple error" --error) 
-##   template_write_data("${__ans}")
+##   template_out_json("${__ans}")
 ## %>
 ## ```
 function(log)

cmake/object/README.md

@@ -30,16 +30,13 @@ As is possible in JavaScript an Python I let you override default object operati
   * `__get_keys__ : (<this>):<member ...>` override the operation which returns the list of available keys.  It is expected that all keys returned will are valid properties (they exist).
   * `__has__ : (<this> <member>):<bool>` overrides the has operation. MUST return true iff the object has a property called `<member>`
   * `__member_call__ : (<this> <member> <args:<any...>>):<return value:<any>>` this operation is invoked when `obj_member_call(...)` is called (and thus also when `call, rcall, etc` is called) overriding this function allows you to dispatch a call operation to the object member identified by `<member>` with the specified `args` it should return the result of the specified operation. The `this` variable is always set to the object instance current instance.
-  * `__cast__` @todo
-* helper functions
+  * `__cast__`  helper functions
   * `obj_declare_getter()`
   * `obj_declare_setter()`
   * `obj_declare_call()`
   * `obj_declare_member_call()`  
   * `obj_declare_get_keys()`
-  * `obj_declare_has_key()` @todo
-  * `obj_declare_cast()` @todo
-  
+  * `obj_declare_has_key()`   * `obj_declare_cast()`   
 
 ```
 new([Constructor]) returns a ref to a object

cmake/package/README.md

@@ -233,7 +233,7 @@ A package source which uses the bitbucket api to parse remote source packages.
 
 Uses the source code management sytem `git` to access a package.  A git repository is interpreted as a package with refs (tags/branches/hashes) being interpreted as different version.
 
-* `query uri format` - takes any uri which git can use (`https`, `ssh`, `git`, `user@host:repo.git`) internally `git ls-remote` is used to check if the uri points to a valid repository. You can specify a ref, branch or tag by appending a query to the uri e.g. `?tag=v0.0.1`
+* `query uri format` - takes any uri which git can use (`https`, `ssh`, `git`, `user internally `git ls-remote` is used to check if the uri points to a valid repository. You can specify a ref, branch or tag by appending a query to the uri e.g. `?tag=v0.0.1`
 * `package uri format` - same as `query uri format` but with the additional scheme `gitscm` added
 * Functions
   - `git_package_source()`

cmake/string/README.md

@@ -244,7 +244,7 @@ So I have created somewhat alot of functions which does things that you might ne
 
  evaluates the string <str> in the current scope
  this is done by macro variable expansion
- evaluates both ${} and @@ style variables
+ evaluates both ${} and @ style variables