Repository navigation
Expand file tree
/
Copy pathmustache.5
More file actions
364 lines (347 loc) · 5.26 KB
/
Copy pathmustache.5
File metadata and controls
364 lines (347 loc) · 5.26 KB
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
.\" generated with Ron/v0.3
.\" http://github.com/rtomayko/ron/
.
.TH "MUSTACHE" "5" "March 2010" "DEFUNKT" "Mustache Manual"
.
.SH "NAME"
\fBmustache\fR \-\- Logic\-less templates.
.
.SH "SYNOPSIS"
A typical Mustache template:
.
.IP "" 4
.
.nf
\fBHello {{name}}
You have just won ${{value}}!
{{#in_ca}}
Well, ${{taxed_value}}, after taxes.
{{/in_ca}} \fR
.
.fi
.
.IP "" 0
.
.P
Given the following hash:
.
.IP "" 4
.
.nf
\fB{
"name": "Chris",
"value": 10000,
"taxed_value": 10000 - (10000 * 0.4),
"in_ca": true
} \fR
.
.fi
.
.IP "" 0
.
.P
Will produce the following:
.
.IP "" 4
.
.nf
\fBHello Chris
You have just won $10000!
Well, $6000.0, after taxes. \fR
.
.fi
.
.IP "" 0
.
.SH "DESCRIPTION"
Mustache can be used for HTML, config files, source code \-
anything. It works by expanding tags in a template using values
provided in a hash or object.
.
.P
We call it "logic\-less" because there are no if statements, else
clauses, or for loops. Instead there are only tags. Some tags are
replaced with a value, some nothing, and others a series of
values. This document explains the different types of Mustache tags.
.
.SH "TAG TYPES"
Tags are indicated by the double mustaches. \fB{{name}}\fR is a tag. Let's
talk about the different types of tags.
.
.SS "Variables"
The most basic tag is the variable. A \fB{{name}}\fR tag in a basic
template will try to call the \fBname\fR method on your view. If there is
no \fBname\fR method, an exception will be raised.
.
.P
All variables are HTML escaped by default. If you want to return
unescaped HTML, use the triple mustache: \fB{{{name}}}\fR.
.
.P
By default a variable "miss" returns an empty string. This can usually
be configured in your Mustache library.
.
.P
Template:
.
.IP "" 4
.
.nf
\fB* {{name}}
* {{age}}
* {{company}}
* {{{company}}} \fR
.
.fi
.
.IP "" 0
.
.P
Hash:
.
.IP "" 4
.
.nf
\fB{
"name": "Chris",
"company": "<b>GitHub</b>"
} \fR
.
.fi
.
.IP "" 0
.
.P
Output:
.
.IP "" 4
.
.nf
\fB* Chris
*
* <b>GitHub</b>
* <b>GitHub</b> \fR
.
.fi
.
.IP "" 0
.
.SS "Boolean Sections"
A section begins with a pound and ends with a slash. That is,\fB{{#person}}\fR begins a "person" section while \fB{{/person}}\fR ends it.
.
.P
If the \fBperson\fR key exists and calling it returns false, the HTML
between the pound and slash will not be displayed.
.
.P
If the \fBperson\fR method exists and calling it returns true, the HTML
between the pound and slash will be rendered and displayed.
.
.P
Template:
.
.IP "" 4
.
.nf
\fB{{#person}}
Shown!
{{/person}}
{{#anything_else}}
Never shown!
{{/anything_else}} \fR
.
.fi
.
.IP "" 0
.
.P
Hash:
.
.IP "" 4
.
.nf
\fB{
"person": true
} \fR
.
.fi
.
.IP "" 0
.
.P
Output:
.
.IP "" 4
.
.nf
\fBShown! \fR
.
.fi
.
.IP "" 0
.
.SS "Enumerable Sections"
Enumerable sections are syntactically identical to boolean sections in
that they begin with a pound and end with a slash. The difference,
however, is in the view: if the method called returns an enumerable,
the section is repeated as the enumerable is iterated over.
.
.P
Each item in the enumerable is expected to be a hash which will then
become the context of the corresponding iteration. In this way we can
construct loops.
.
.P
Template:
.
.IP "" 4
.
.nf
\fB{{#repo}}
<b>{{name}}</b>
{{/repo}} \fR
.
.fi
.
.IP "" 0
.
.P
Hash:
.
.IP "" 4
.
.nf
\fB{
"repo": [
{ "name": "resque" },
{ "name": "hub" },
{ "name": "rip" },
]
} \fR
.
.fi
.
.IP "" 0
.
.P
Output:
.
.IP "" 4
.
.nf
\fB<b>resque</b>
<b>hub</b>
<b>rip</b> \fR
.
.fi
.
.IP "" 0
.
.SS "Comments"
Comments begin with a bang and are ignored. The following template:
.
.IP "" 4
.
.nf
\fB<h1>Today{{! ignore me }}.</h1> \fR
.
.fi
.
.IP "" 0
.
.P
Will render as follows:
.
.IP "" 4
.
.nf
\fB<h1>Today.</h1> \fR
.
.fi
.
.IP "" 0
.
.SS "Partials"
Partials begin with a greater than sign, like \fB{{> box}}\fR.
.
.P
It is useful to think of partials as a "template expansion" \- that is,
the actual partial tag will be replaced with the content of the
partial. Therefor partials share the current context.
.
.P
For example, this template and partial:
.
.IP "" 4
.
.nf
\fBbase.mustache:
<h2>Names</h2>
{{# names }}
{{> user }}
{{/ names }}
user.mustache:
<strong>{{ name }}</strong>
\fR
.
.fi
.
.IP "" 0
.
.P
Can be thought of as a single, expanded template:
.
.IP "" 4
.
.nf
\fB<h2>Names</h2>
{{# names }}
<strong>{{ name }}</strong>
{{/ names }} \fR
.
.fi
.
.IP "" 0
.
.SS "Set Delimiter"
Set Delimiter tags start with an equal sign and change the tag
delimiters from {{ and }} to custom strings.
.
.P
Consider the following contrived example:
.
.IP "" 4
.
.nf
\fB* {{ default_tags }}
{{=<% %>=}}
* <% erb_style_tags %>
<%={{ }}=%>
* {{ default_tags_again }} \fR
.
.fi
.
.IP "" 0
.
.P
Here we have a list with three items. The first item uses the default
tag style, the second uses erb style as defined by the Set Delimiter
tag, and the third returns to the default style after yet another Set
Delimiter declaration.
.
.P
According to \fIctemplates\fR, this "is useful for languages like TeX, where
double\-braces may occur in the text and are awkward to use for
markup."
.
.P
Custom delimiters may not contain whitespace or the equals sign.
.
.SH "COPYRIGHT"
Mustache is Copyright (C) 2009 Chris Wanstrath
.
.P
Original CTemplate by Google
.
.SH "SEE ALSO"
mustache(1), mustache(7), gem(1),\fIhttp://defunkt.github.com/mustache/\fR