-
Notifications
You must be signed in to change notification settings - Fork 293
/
Copy pathmustache.5.html
709 lines (523 loc) · 18.6 KB
/
mustache.5.html
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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
<!DOCTYPE html>
<!--
Hello contributor! This page is automatically generated from the Mustache
man pages. Rather than sending a pull request to change this file, you
should update the source:
https://github.com/mustache/mustache/blob/master/man/mustache.5.ron
-->
<html>
<head>
<meta http-equiv='content-type' content='text/html;charset=utf8'>
<meta name='generator' content='Ronn-NG/v0.9.1 (http://github.com/apjanke/ronn-ng/tree/0.9.1)'>
<title>mustache(5) - Logic-less templates.</title>
<style type='text/css' media='all'>
/* style: man */
body#manpage {margin:0}
.mp {max-width:100ex;padding:0 9ex 1ex 4ex}
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
.mp h2 {margin:10px 0 0 0}
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
.mp h3 {margin:0 0 0 4ex}
.mp dt {margin:0;clear:left}
.mp dt.flush {float:left;width:8ex}
.mp dd {margin:0 0 0 9ex}
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
.mp pre {margin-bottom:20px}
.mp pre+h2,.mp pre+h3 {margin-top:22px}
.mp h2+pre,.mp h3+pre {margin-top:5px}
.mp img {display:block;margin:auto}
.mp h1.man-title {display:none}
.mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
.mp h2 {font-size:16px;line-height:1.25}
.mp h1 {font-size:20px;line-height:2}
.mp {text-align:justify;background:#fff}
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
.mp u {text-decoration:underline}
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
.mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
.mp b.man-ref {font-weight:normal;color:#434241}
.mp pre {padding:0 4ex}
.mp pre code {font-weight:normal;color:#434241}
.mp h2+pre,h3+pre {padding-left:0}
ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
ol.man-decor {width:100%}
ol.man-decor li.tl {text-align:left}
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
ol.man-decor li.tr {text-align:right;float:right}
</style>
</head>
<!--
The following styles are deprecated and will be removed at some point:
div#man, div#man ol.man, div#man ol.head, div#man ol.man.
The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
.man-navigation should be used instead.
-->
<body id='manpage'>
<div class='mp' id='man'>
<div class='man-navigation' style='display:none'>
<a href="#NAME">NAME</a>
<a href="#SYNOPSIS">SYNOPSIS</a>
<a href="#DESCRIPTION">DESCRIPTION</a>
<a href="#TAG-TYPES">TAG TYPES</a>
<a href="#COPYRIGHT">COPYRIGHT</a>
<a href="#SEE-ALSO">SEE ALSO</a>
</div>
<ol class='man-decor man-head man head'>
<li class='tl'>mustache(5)</li>
<li class='tc'>Mustache Manual</li>
<li class='tr'>mustache(5)</li>
</ol>
<h2 id="NAME">NAME</h2>
<p class="man-name">
<code>mustache</code> - <span class="man-whatis">Logic-less templates.</span>
</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
<p>A typical Mustache template:</p>
<pre><code>Hello {{name}}
You have just won {{value}} dollars!
{{#in_ca}}
Well, {{taxed_value}} dollars, after taxes.
{{/in_ca}}
</code></pre>
<p>Given the following hash:</p>
<pre><code>{
"name": "Chris",
"value": 10000,
"taxed_value": 10000 - (10000 * 0.4),
"in_ca": true
}
</code></pre>
<p>Will produce the following:</p>
<pre><code>Hello Chris
You have just won 10000 dollars!
Well, 6000.0 dollars, after taxes.
</code></pre>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
<p>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>
<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.</p>
<p>The Mustache language has a <a href="https://github.com/mustache/spec">formal specification</a>. The current
manpage reflects version 1.3.0 of the specification, including the
official-but-optional extensions for lambdas and inheritance.</p>
<h2 id="TAG-TYPES">TAG TYPES</h2>
<p>Tags are indicated by the double mustaches. <code>{{person}}</code> is a tag, as
is <code>{{#person}}</code>. In both examples, we'd refer to <code>person</code> as the key
or tag key. Let's talk about the different types of tags.</p>
<h3 id="Variables">Variables</h3>
<p>The most basic tag type is the variable. A <code>{{name}}</code> tag in a basic
template will try to find the <code>name</code> key in the current context. If
there is no <code>name</code> key, the parent contexts will be checked recursively.
If the top context is reached and the <code>name</code> key is still not found,
nothing will be rendered.</p>
<p>All variables are HTML escaped by default. If you want to return raw contents
without escaping, use the triple mustache: <code>{{{name}}}</code>.</p>
<p>You can also use <code>&</code> to return its raw contents: <code>{{& name}}</code>. This may be
useful when changing delimiters (see "Set Delimiter" below).</p>
<p>By default a variable "miss" returns an empty string. This can usually
be configured in your Mustache library. The Ruby version of Mustache
supports raising an exception in this situation, for instance.</p>
<p>Template:</p>
<pre><code>* {{name}}
* {{age}}
* {{company}}
* {{{company}}}
</code></pre>
<p>Hash:</p>
<pre><code>{
"name": "Chris",
"company": "<b>GitHub</b>"
}
</code></pre>
<p>Output:</p>
<pre><code>* Chris
*
* &lt;b&gt;GitHub&lt;/b&gt;
* <b>GitHub</b>
</code></pre>
<p><strong>Dotted Names</strong></p>
<p>If the <code>name</code> contains dots, it is split on the dots to obtain multiple
keys. The first key is looked up in the context as described above. If it
is found, the next key is looked up within the previous result. This is
repeated until a key is not found or until the last key is found. The
final result is interpolated as above.</p>
<p>Template:</p>
<pre><code>* {{client.name}}
* {{age}}
* {{client.company.name}}
* {{{company.name}}}
</code></pre>
<p>Hash:</p>
<pre><code>{
"client": {
"name": "Chris & Friends",
"age": 50
},
"company": {
"name": "<b>GitHub</b>"
}
}
</code></pre>
<p>Output:</p>
<pre><code>* Chris &amp; Friends
*
*
* <b>GitHub</b>
</code></pre>
<p><strong>Implicit Iterator</strong></p>
<p>As a special case, if the <code>name</code> consists of only a dot and nothing else,
the value that is the current context is interpolated as a whole. This
is especially useful if the parent context is a list; see <strong>Sections</strong>
below.</p>
<p>Template:</p>
<pre><code>* {{.}}
</code></pre>
<p>Current context:</p>
<pre><code>"Hello!"
</code></pre>
<p>Output:</p>
<pre><code>* Hello!
</code></pre>
<p><strong>Lambdas</strong></p>
<p>If any value found during the lookup is a callable object, such as a
function or lambda, this object will be invoked with zero arguments. The
value that is returned is then used instead of the callable object itself.</p>
<p>An <strong>optional</strong> part of the specification states that if the final key in
the <code>name</code> is a lambda that returns a string, then that string should be
rendered as a Mustache template before interpolation. It will be rendered
using the default delimiters (see <strong>Set Delimiter</strong> below) against the
current context.</p>
<p>Template:</p>
<pre><code>* {{time.hour}}
* {{today}}
</code></pre>
<p>Hash:</p>
<pre><code>{
"year": 1970,
"month": 1,
"day": 1,
"time": function() {
return {
"hour": 0,
"minute": 0,
"second": 0
}
},
"today": function() {
return "{{year}}-{{month}}-{{day}}"
}
}
</code></pre>
<p>Output:</p>
<pre><code>* 0
* 1970-1-1
</code></pre>
<h3 id="Sections">Sections</h3>
<p>Sections render blocks of text zero or more times, depending on the
value of the key in the current context.</p>
<p>Lookup of dotted names works in the same way as with variables, except for
slightly different treatment of lambdas. More on this below.</p>
<p>A section begins with a pound and ends with a slash. That is,
<code>{{#person}}</code> begins a "person" section while <code>{{/person}}</code> ends it.</p>
<p>The behavior of the section is determined by the final value of the key
lookup.</p>
<p><strong>False Values or Empty Lists</strong></p>
<p>If the <code>person</code> key exists and has a value of false or an empty
list, the HTML between the pound and slash will not be displayed.</p>
<p>Template:</p>
<pre><code>Shown.
{{#person}}
Never shown!
{{/person}}
</code></pre>
<p>Hash:</p>
<pre><code>{
"person": false
}
</code></pre>
<p>Output:</p>
<pre><code>Shown.
</code></pre>
<p><strong>Non-Empty Lists</strong></p>
<p>If the <code>person</code> key exists and has a non-false value, the HTML between
the pound and slash will be rendered and displayed one or more times.</p>
<p>When the value is a non-empty list, the text in the block will be
displayed once for each item in the list. The context of the block
will be set to the current item for each iteration. In this way we can
loop over collections.</p>
<p>Template:</p>
<pre><code>{{#repo}}
<b>{{name}}</b>
{{/repo}}
</code></pre>
<p>Hash:</p>
<pre><code>{
"repo": [
{ "name": "resque" },
{ "name": "hub" },
{ "name": "rip" }
]
}
</code></pre>
<p>Output:</p>
<pre><code> <b>resque</b>
<b>hub</b>
<b>rip</b>
</code></pre>
<p>The same effect as above can be obtained without nested objects, by using
the implicit iterator (see <strong>Variables</strong> above).</p>
<p>Template:</p>
<pre><code>{{#repo}}
<b>{{.}}</b>
{{/repo}}
</code></pre>
<p>Hash:</p>
<pre><code>{
"repo": ["resque", "hub", "rip"]
}
</code></pre>
<p>Output:</p>
<pre><code> <b>resque</b>
<b>hub</b>
<b>rip</b>
</code></pre>
<p><strong>Lambdas</strong></p>
<p>When any value found during the lookup is a callable object, such as a
function or lambda, the object will be invoked and passed the block of
text. The text passed is the literal block, unrendered. <code>{{tags}}</code> will
not have been expanded.</p>
<p>An <strong>optional</strong> part of the specification states that if the final key in
the <code>name</code> is a lambda that returns a string, then that string replaces
the content of the section. It will be rendered using the same delimiters
(see <strong>Set Delimiter</strong> below) as the original section content. In this way
you can implement filters or caching.</p>
<p>Template:</p>
<pre><code>{{#wrapped}}{{name}} is awesome.{{/wrapped}}
</code></pre>
<p>Hash:</p>
<pre><code>{
"name": "Willy",
"wrapped": function(text) {
return "<b>" + text + "</b>"
}
}
</code></pre>
<p>Output:</p>
<pre><code><b>Willy is awesome.</b>
</code></pre>
<p><strong>Non-False Values</strong></p>
<p>When the value is non-false but not a list, it will be used as the
context for a single rendering of the block.</p>
<p>Template:</p>
<pre><code>{{#person?}}
Hi {{name}}!
{{/person?}}
</code></pre>
<p>Hash:</p>
<pre><code>{
"person?": { "name": "Jon" }
}
</code></pre>
<p>Output:</p>
<pre><code> Hi Jon!
</code></pre>
<h3 id="Inverted-Sections">Inverted Sections</h3>
<p>An inverted section begins with a caret (hat) and ends with a
slash. That is <code>{{^person}}</code> begins a "person" inverted section while
<code>{{/person}}</code> ends it.</p>
<p>While sections can be used to render text zero or more times based on the
value of the key, inverted sections may render text once based
on the inverse value of the key. That is, they will be rendered
if the key doesn't exist, is false, or is an empty list.</p>
<p>Template:</p>
<pre><code>{{#repo}}
<b>{{name}}</b>
{{/repo}}
{{^repo}}
No repos :(
{{/repo}}
</code></pre>
<p>Hash:</p>
<pre><code>{
"repo": []
}
</code></pre>
<p>Output:</p>
<pre><code> No repos :(
</code></pre>
<h3 id="Comments">Comments</h3>
<p>Comments begin with a bang and are ignored. The following template:</p>
<pre><code><h1>Today{{! ignore me }}.</h1>
</code></pre>
<p>Will render as follows:</p>
<pre><code><h1>Today.</h1>
</code></pre>
<p>Comments may contain newlines.</p>
<h3 id="Partials">Partials</h3>
<p>Partials begin with a greater than sign, like <code>{{> box}}</code>.</p>
<p>Partials are rendered at runtime (as opposed to compile time), so
recursive partials are possible. Just avoid infinite loops.</p>
<p>They also inherit the calling context. Whereas in ERB you may have
this:</p>
<pre><code><%= partial :next_more, :start => start, :size => size %>
</code></pre>
<p>Mustache requires only this:</p>
<pre><code>{{> next_more}}
</code></pre>
<p>Why? Because the <code>next_more.mustache</code> file will inherit the <code>size</code> and
<code>start</code> methods from the calling context.</p>
<p>In this way you may want to think of partials as includes, or template
expansion, even though it's not literally true.</p>
<p>For example, this template and partial:</p>
<pre><code>base.mustache:
<h2>Names</h2>
{{#names}}
{{> user}}
{{/names}}
user.mustache:
<strong>{{name}}</strong>
</code></pre>
<p>Can be thought of as a single, expanded template:</p>
<pre><code><h2>Names</h2>
{{#names}}
<strong>{{name}}</strong>
{{/names}}
</code></pre>
<p><strong>Dynamic Names</strong></p>
<p>Partials can be loaded dynamically at runtime using Dynamic Names; an
<strong>optional</strong> part of the Mustache specification which allows to dynamically
determine a tag's content at runtime.</p>
<p>Dynamic Names consists of an asterisk, followed by a dotted name which follows
the same notation and the same resolution as in an variable tag. That is
<code>{{>*dynamic}}</code>. It can be thought as the following <strong>hypothetical</strong> tag
(which is <strong>not allowed</strong>!): <code>{{>{{dynamic}}}}</code>.</p>
<p>Templates:</p>
<pre><code>main.mustache:
Hello {{>*dynamic}}
world.template:
everyone!
</code></pre>
<p>Hash:</p>
<pre><code>{
"dynamic": "world"
}
</code></pre>
<p>Output:</p>
<pre><code>Hello everyone!
</code></pre>
<h3 id="Blocks">Blocks</h3>
<p>A block begins with a dollar and ends with a slash. That is, <code>{{$title}}</code>
begins a "title" block and <code>{{/title}}</code> ends it.</p>
<p>Blocks mark parts of the template that may be overridden. This can be done
with a block of the same name within a parent section in the calling
template (see <strong>Parents</strong> below). If not overridden, the contents of a
block render just as if the <code>{{$title}}</code> and <code>{{/title}}</code> tags weren't
there.</p>
<p>Blocks could be thought of as template parameters or as inline partials
that may be passed to another template. They are part of the optional
inheritance extension.</p>
<p>Template <code>article.mustache</code>:</p>
<pre><code><h1>{{$title}}The News of Today{{/title}}</h1>
{{$body}}
<p>Nothing special happened.</p>
{{/body}}
</code></pre>
<p>Output:</p>
<pre><code><h1>The News of Today</h1>
<p>Nothing special happened.</p>
</code></pre>
<h3 id="Parents">Parents</h3>
<p>A parent begins with a less than sign and ends with a slash. That is,
<code>{{<article}}</code> begins an "article" parent and <code>{{/article}}</code> ends it.</p>
<p>Like an <code>{{>article}}</code> partial, a parent lets you expand another template
inside the current one. Unlike a partial, a parent also lets you override
blocks of the other template.</p>
<p>Blocks within a parent can again be overridden by another including
template. Other content within a parent is ignored, like comments.</p>
<p>Template:</p>
<pre><code>{{<article}}
Never shown
{{$body}}
{{#headlines}}
<p>{{.}}</p>
{{/headlines}}
{{/body}}
{{/article}}
{{<article}}
{{$title}}Yesterday{{/title}}
{{/article}}
</code></pre>
<p>Hash:</p>
<pre><code>{
"headlines": [
"A pug's handler grew mustaches.",
"What an exciting day!"
]
}
</code></pre>
<p>Output, assuming the <code>article.mustache</code> from before:</p>
<pre><code><h1>The News of Today</h1>
<p>A pug's handler grew mustaches.</p>
<p>What an exciting day!</p>
<h1>Yesterday</h1>
<p>Nothing special happened.</p>
</code></pre>
<p><strong>Dynamic Names</strong></p>
<p>Some mustache implementations may allow the use of Dynamic Names in
parent tags, similar to dynamic names in partials. Here's an example of
how Dynamic Names in parent tags work.</p>
<p>Templates:</p>
<pre><code>{{!normal.mustache}}
{{$text}}Here goes nothing.{{/text}}
{{!bold.mustache}}
<b>{{$text}}Here also goes nothing but it's bold.{{/text}}</b>
{{!dynamic.mustache}}
{{<*dynamic}}
{{$text}}Hello World!{{/text}}
{{/*dynamic}}
</code></pre>
<p>Hash:</p>
<pre><code>{
"dynamic": "bold"
}
</code></pre>
<p>Output:</p>
<pre><code><b>Hello World!</b>
</code></pre>
<h3 id="Set-Delimiter">Set Delimiter</h3>
<p>Set Delimiter tags start with an equal sign and change the tag
delimiters from <code>{{</code> and <code>}}</code> to custom strings.</p>
<p>Consider the following contrived example:</p>
<pre><code>* {{default_tags}}
{{=<% %>=}}
* <% erb_style_tags %>
<%={{ }}=%>
* {{ default_tags_again }}
</code></pre>
<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>
<p>According to <a href="http://goog-ctemplate.sourceforge.net/doc/howto.html">ctemplates</a>, this "is useful for languages like TeX, where
double-braces may occur in the text and are awkward to use for
markup."</p>
<p>Custom delimiters may not contain whitespace or the equals sign.</p>
<h2 id="COPYRIGHT">COPYRIGHT</h2>
<p>Mustache is Copyright (C) 2009 Chris Wanstrath</p>
<p>Original CTemplate by Google</p>
<h2 id="SEE-ALSO">SEE ALSO</h2>
<p><a class="man-ref" href="mustache.1.ron.html">mustache<span class="s">(1)</span></a>,
<a href="http://mustache.github.io/" data-bare-link="true">http://mustache.github.io/</a></p>
<ol class='man-decor man-foot man foot'>
<li class='tl'>DEFUNKT</li>
<li class='tc'>September 2022</li>
<li class='tr'>mustache(5)</li>
</ol>
</div>
</body>
</html>