mustache/man/mustache.5 at master · nahiluhmot/mustache

Repository navigation

History

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

.\" generated with Ronn/v0.7.3

.\" http://github.com/rtomayko/ronn/tree/0.7.3

.TH "MUSTACHE" "5" "February 2015" "DEFUNKT" "Mustache Manual"

.SH "NAME"

\fBmustache\fR \- Logic\-less templates\.

.SH "SYNOPSIS"

A typical Mustache template:

.IP "" 4

.nf

Hello {{name}}

You have just won {{value}} dollars!

Well, {{taxed_value}} dollars, after taxes\.

.fi

.IP "" 0

Given the following hash:

.IP "" 4

.nf

{

"name": "Chris",

"value": 10000,

"taxed_value": 10000 \- (10000 * 0\.4),

"in_ca": true

}

.fi

.IP "" 0

Will produce the following:

.IP "" 4

.nf

Hello Chris

You have just won 10000 dollars!

Well, 6000\.0 dollars, after taxes\.

.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\.

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{{person}}\fR is a tag, as is \fB{{#person}}\fR\. In both examples, we\'d refer to \fBperson\fR as the key or tag key\. Let\'s talk about the different types of tags\.

.SS "Variables"

The most basic tag type is the variable\. A \fB{{name}}\fR tag in a basic template will try to find the \fBname\fR key in the current context\. If there is no \fBname\fR key, the parent contexts will be checked recursively\. If the top context is reached and the \fBname\fR key is still not found, nothing will be rendered\.

All variables are HTML escaped by default\. If you want to return raw contents without escaping, use the triple mustache: \fB{{{name}}}\fR\.

You can also use \fB&\fR to return its raw contents: \fB{{& name}}\fR\. This may be useful when changing delimiters (see "Set Delimiter" below)\.

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\.

Template:

.IP "" 4

.nf

* {{name}}

* {{age}}

* {{company}}

* {{{company}}}

.fi

.IP "" 0

Hash:

.IP "" 4

.nf

{

"name": "Chris",

"company": "<b>GitHub</b>"

}

.fi

.IP "" 0

Output:

.IP "" 4

.nf

* Chris

* <b>GitHub</b>

.fi

.IP "" 0

.SS "Sections"

Sections render blocks of text zero or more times, depending on the value of the key in the current context\.

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\.

The behavior of the section is determined by the value of the key\.

\fBFalse Values or Empty Lists\fR

If the \fBperson\fR key exists and has a value of false or an empty list, the HTML between the pound and slash will not be displayed\.

Template:

.IP "" 4

.nf

Shown\.

Never shown!

.fi

.IP "" 0

Hash:

.IP "" 4

.nf

{

"person": false

}

.fi

.IP "" 0

Output:

.IP "" 4

.nf

Shown\.

.fi

.IP "" 0

\fBNon\-Empty Lists\fR

If the \fBperson\fR key exists and has a non\-false value, the HTML between the pound and slash will be rendered and displayed one or more times\.

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\.

Template:

.IP "" 4

.nf

.fi

.IP "" 0

Hash:

.IP "" 4

.nf

{

"repo": [

{ "name": "resque" },

{ "name": "hub" },

{ "name": "rip" }

]

}

.fi

.IP "" 0

Output:

.IP "" 4

.nf

<b>resque</b>

.fi

.IP "" 0

\fBLambdas\fR

When the value 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\. \fB{{tags}}\fR will not have been expanded \- the lambda should do that on its own\. In this way you can implement filters or caching\.

Template:

.IP "" 4

.nf

{{name}} is awesome\.

.fi

.IP "" 0

Hash:

.IP "" 4

.nf

{

"name": "Willy",

"wrapped": function() {

return function(text, render) {

return "<b>" + render(text) + "</b>"

}

.fi

.IP "" 0

Output:

.IP "" 4

.nf

<b>Willy is awesome\.</b>

.fi

.IP "" 0

\fBNon\-False Values\fR

When the value is non\-false but not a list, it will be used as the context for a single rendering of the block\.

Template:

.IP "" 4

.nf

Hi {{name}}!

.fi

.IP "" 0

Hash:

.IP "" 4

.nf

{

"person?": { "name": "Jon" }

}

.fi

.IP "" 0

Output:

.IP "" 4

.nf

Hi Jon!

.fi

.IP "" 0

.SS "Inverted Sections"

An inverted section begins with a caret (hat) and ends with a slash\. That is \fB{{^person}}\fR begins a "person" inverted section while \fB{{/person}}\fR ends it\.

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\.

Template:

.IP "" 4

.nf

No repos :(

.fi

.IP "" 0

Hash:

.IP "" 4

.nf

{

"repo": []

}

.fi

.IP "" 0

Output:

.IP "" 4

.nf

No repos :(

.fi

.IP "" 0

.SS "Comments"

Comments begin with a bang and are ignored\. The following template:

.IP "" 4

.nf

<h1>Today{{! ignore me }}\.</h1>

.fi

.IP "" 0

Will render as follows:

.IP "" 4

.nf

<h1>Today\.</h1>

.fi

.IP "" 0

Comments may contain newlines\.

.SS "Partials"

Partials begin with a greater than sign, like \fB{{> box}}\fR\.

Partials are rendered at runtime (as opposed to compile time), so recursive partials are possible\. Just avoid infinite loops\.

They also inherit the calling context\. Whereas in ERB you may have this:

.IP "" 4

.nf

<%= partial :next_more, :start => start, :size => size %>

.fi

.IP "" 0

Mustache requires only this:

.IP "" 4

.nf

.fi

.IP "" 0

Why? Because the \fBnext_more\.mustache\fR file will inherit the \fBsize\fR and \fBstart\fR methods from the calling context\.

In this way you may want to think of partials as includes, or template expansion, even though it\'s not literally true\.

For example, this template and partial:

.IP "" 4

.nf

base\.mustache:

<h2>Names</h2>

user\.mustache:

.fi

.IP "" 0

Can be thought of as a single, expanded template:

.IP "" 4

.nf

<h2>Names</h2>

.fi

.IP "" 0

.SS "Set Delimiter"

Set Delimiter tags start with an equal sign and change the tag delimiters from \fB{{\fR and \fB}}\fR to custom strings\.

Consider the following contrived example:

.IP "" 4

.nf

* {{default_tags}}

* <% erb_style_tags %>

<%={{ }}=%>

* {{ default_tags_again }}

.fi

.IP "" 0

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\.

According to ctemplates \fIhttp://google\-ctemplate\.googlecode\.com/svn/trunk/doc/howto\.html\fR, this "is useful for languages like TeX, where double\-braces may occur in the text and are awkward to use for markup\."

Custom delimiters may not contain whitespace or the equals sign\.

.SH "COPYRIGHT"

Original CTemplate by Google

.SH "SEE ALSO"

mustache(1), \fIhttp://mustache\.github\.io/\fR

FilesExpand file tree

mustache.5

Latest commit

History

mustache.5

File metadata and controls