sigmasternchen/libparcival
1
0
Fork 0
mirror of https://github.com/sigmasternchen/libparcival synced 2025-03-15 11:58:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

updated readme for changed interface

Browse source
This commit is contained in:
overflowerror 2021-05-23 16:04:45 +02:00
parent 9a1bdb9413
commit b7053a6241
1 changed files with 2 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -143,13 +143,11 @@ Include the `templates.h` file into your program.
#include <templates.h>
```
Use the function `findTemplate()` to find the template for a given name. This function will always return a valid `template_t` pointer. In case no template with the given name is found a placeholder template is returned.
The result is a function pointer that takes a `FILE*` argument (the template will be rendered to that stream) followed by the arguments that are specified in the template file (in the same order).
Use the function `renderTemplate()` to render a template with a given namen. The first argument is the name of the template, the second one is the `FILE*` into with the template will be rendered. The following arguments are the parameters of the template itself (in the order that they were declared in the template file).
Following example shows how this could look like (using the previous discussed "Complete Example" withe name specified in "Translating Template").
```
findTemplate("templates/index.html.templ")(stdout, "Page Title", userArray, userArrayLength);
renderTemplate("templates/index.html.templ", qstdout, "Page Title", userArray, userArrayLength);
```
# Demo