1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
ns: tmpl
title: template functions
preamble: |
Functions for defining or executing templates.
funcs:
- name: tmpl.Exec
description: |
Execute (render) the named template. This is equivalent to using the [`template`](https://golang.org/pkg/text/template/#hdr-Actions) action, except the result is returned as a string.
This allows for post-processing of templates.
pipeline: true
arguments:
- name: name
required: true
description: The template's name.
- name: context
required: false
description: The context to use.
examples:
- |
$ gomplate -i '{{define "T1"}}hello, world!{{end}}{{ tmpl.Exec "T1" | strings.ToUpper }}'
HELLO, WORLD!
- |
$ gomplate -i '{{define "T1"}}hello, {{.}}{{end}}{{ tmpl.Exec "T1" "world!" | strings.Title }}'
Hello, World!
- name: tmpl.Inline
alias: tpl
description: |
Render the given string as a template, just like a nested template.
If the template is given a name (see `name` argument below), it can be re-used later with the `template` keyword.
A context can be provided, otherwise the default gomplate context will be used.
pipeline: false
arguments:
- name: name
required: false
description: The template's name.
- name: in
required: true
description: The template to render, as a string
- name: context
required: false
description: The context to use when rendering - this becomes `.` inside the template.
examples:
- |
$ gomplate -i '{{ tmpl.Inline "{{print `hello world`}}" }}'
hello world
- |
$ gomplate -i '
{{ $tstring := "{{ print .value ` world` }}" }}
{{ $context := dict "value" "hello" }}
{{ tpl "T1" $tstring $context }}
{{ template "T1" (dict "value" "goodbye") }}
'
hello world
goodbye world
- name: tmpl.Path
description: |
Output the path of the current template, if it came from a file. For
inline templates, this will be an empty string.
Note that if this function is called from a nested template, the path
of the main template will be returned instead.
pipeline: false
rawExamples:
- |
_`subdir/input.tpl`:_
```
this template is in {{ tmpl.Path }}
```
```console
$ gomplate -f subdir/input.tpl
this template is in subdir/input.tpl
```
```
- name: tmpl.PathDir
description: |
Output the current template's directory. For inline templates, this will
be an empty string.
Note that if this function is called from a nested template, the path
of the main template will be used instead.
pipeline: false
rawExamples:
- |
_`subdir/input.tpl`:_
```
this template is in {{ tmpl.Dir }}
```
```console
$ gomplate -f subdir/input.tpl
this template is in subdir
```
|
