Crow/docs/guides/templating.md

Templating is when you return an html page with custom data. You can probably tell why that's useful.<br><br>

Crow supports [mustache](http://mustache.github.io) for templates through its own implementation `crow::mustache`.<br><br>

##Components of mustache

There are 2 components of a mustache template implementation:

- Page
- Context

###Page
The HTML page (including the mustache tags). It is usually loaded into `crow::mustache::template_t`. It needs to be placed in `templates` directory (relative to where the crow executable is).<br><br>

For more information on how to formulate a template, see [this mustache manual](http://mustache.github.io/mustache.5.html).

###Context
A JSON object containing the tags as keys and their values. `crow::mustache::context` is actually a [crow::json::wvalue](../json#wvalue).

##Returning a template
To return a mustache template, you need to load a page using `#!cpp auto page = crow::mustache::load("path/to/template.html");`, keep in mind that the path is relative to the templates directory.<br>
You also need to set up the context by using `#!cpp crow::mustache::context ctx;`. Then you need to assign the keys and values, this can be done the same way you assign values to a json write value (`ctx["key"] = value;`).<br>
With your context and page ready, just `#!cpp return page.render(ctx);`. This will use the context data to return a filled template.<br>
Alternatively you could just render the page without a context using `#!cpp return page.render();`.
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme. 2020-11-28 14:28:47 +00:00			`Templating is when you return an html page with custom data. You can probably tell why that's useful.<br><br>`

			Crow supports [mustache](http://mustache.github.io) for templates through its own implementation `crow::mustache`.<br><br>

			`##Components of mustache`

fixed typos and added missing parts 2020-11-28 19:48:09 +00:00			`There are 2 components of a mustache template implementation:`
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme. 2020-11-28 14:28:47 +00:00
			`- Page`
			`- Context`

			`###Page`
fixed typos and added missing parts 2020-11-28 19:48:09 +00:00			The HTML page (including the mustache tags). It is usually loaded into `crow::mustache::template_t`. It needs to be placed in `templates` directory (relative to where the crow executable is).<br><br>
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme. 2020-11-28 14:28:47 +00:00
fixed typos and added missing parts 2020-11-28 19:48:09 +00:00			`For more information on how to formulate a template, see [this mustache manual](http://mustache.github.io/mustache.5.html).`
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme. 2020-11-28 14:28:47 +00:00
			`###Context`
Updated all URLs for migration and to fix mkdocs 2020-11-30 20:05:55 +00:00			A JSON object containing the tags as keys and their values. `crow::mustache::context` is actually a [crow::json::wvalue](../json#wvalue).
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme. 2020-11-28 14:28:47 +00:00
			`##Returning a template`
			To return a mustache template, you need to load a page using `#!cpp auto page = crow::mustache::load("path/to/template.html");`, keep in mind that the path is relative to the templates directory.<br>
fixed typos and added missing parts 2020-11-28 19:48:09 +00:00			You also need to set up the context by using `#!cpp crow::mustache::context ctx;`. Then you need to assign the keys and values, this can be done the same way you assign values to a json write value (`ctx["key"] = value;`).<br>
			With your context and page ready, just `#!cpp return page.render(ctx);`. This will use the context data to return a filled template.<br>
			Alternatively you could just render the page without a context using `#!cpp return page.render();`.