mustache 0.5.1 → 0.6.0

data/man/mustache.5

@@ -0,0 +1,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
+*
+* &lt;b&gt;GitHub&lt;/b&gt;
+* <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

data/man/mustache.5.html

@@ -0,0 +1,300 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ron/v0.3'>
+  <title>mustache(5) -- Logic-less templates.</title>
+  <style type='text/css'>
+    body {margin:0}
+    #man, #man code, #man pre, #man tt, #man kbd, #man samp {
+      font-family:consolas,monospace;
+      font-size:16px;
+      line-height:1.3;
+      color:#343331;
+      background:#fff; }
+    #man { max-width:89ex; text-align:justify; margin:0 25px 25px 25px }
+    #man h1, #man h2, #man h3 { color:#232221;clear:left }
+    #man h1 { font-size:28px; margin:15px 0 30px 0; text-align:center }
+    #man h2 { font-size:18px; margin-bottom:0; margin-top:10px; line-height:1.3; }
+    #man h3 { font-size:16px; margin:0 0 0 4ex; }
+    #man p, #man ul, #man ol, #man dl, #man pre { margin:0 0 18px 0; }
+    #man pre {
+      color:#333231;
+      background:#edeceb;
+      padding:5px 7px;
+      margin:0px 0 20px 0;
+      border-left:2ex solid #ddd}
+    #man pre + h2, #man pre + h3 {
+      margin-top:22px;
+    }
+    #man h2 + pre, #man h3 + pre {
+      margin-top:5px;
+    }
+    #man > p, #man > ul, #man > ol, #man > dl, #man > pre { margin-left:8ex; }
+    #man dt { margin:0; clear:left }
+    #man dt.flush { float:left; width:8ex }
+    #man dd { margin:0 0 0 9ex }
+    #man code, #man strong, #man b { font-weight:bold; color:#131211; }
+    #man pre code { font-weight:normal; color:#232221; background:inherit }
+    #man em, var, u {
+      font-style:normal; color:#333231; border-bottom:1px solid #999; }
+    #man h1.man-title { display:none; }
+    #man ol.man, #man ol.man li { margin:2px 0 10px 0; padding:0;
+      float:left; width:33%; list-style-type:none;
+      text-transform:uppercase; font-size:18px; color:#999;
+      letter-spacing:1px;}
+    #man ol.man { width:100%; }
+    #man ol.man li.tl { text-align:left }
+    #man ol.man li.tc { text-align:center;letter-spacing:4px }
+    #man ol.man li.tr { text-align:right }
+    #man ol.man a { color:#999 }
+    #man ol.man a:hover { color:#333231 }
+  </style>
+</head>
+<body>
+<div id='man'>
+
+<h1 class='man-title'>mustache(5)</h1>
+
+<ol class='head man'>
+  <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><code>mustache</code> -- Logic-less templates.</p>
+<h2>SYNOPSIS</h2>
+
+<p>A typical Mustache template:</p>
+
+<pre><code>Hello {{name}}
+You have just won ${{value}}!
+{{#in_ca}}
+Well, ${{taxed_value}}, 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!
+Well, $6000.0, after taxes.
+</code></pre>
+
+<h2>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>
+
+<h2>TAG TYPES</h2>
+
+<p>Tags are indicated by the double mustaches. <code>{{name}}</code> is a tag. Let's
+talk about the different types of tags.</p>
+
+<h3>Variables</h3>
+
+<p>The most basic tag is the variable. A <code>{{name}}</code> tag in a basic
+template will try to call the <code>name</code> method on your view. If there is
+no <code>name</code> method, an exception will be raised.</p>
+
+<p>All variables are HTML escaped by default. If you want to return
+unescaped HTML, use the triple mustache: <code>{{{name}}}</code>.</p>
+
+<p>By default a variable "miss" returns an empty string. This can usually
+be configured in your Mustache library.</p>
+
+<p>Template:</p>
+
+<pre><code>* {{name}}
+* {{age}}
+* {{company}}
+* {{{company}}}
+</code></pre>
+
+<p>Hash:</p>
+
+<pre><code>{
+  "name": "Chris",
+  "company": "&lt;b&gt;GitHub&lt;/b&gt;"
+}
+</code></pre>
+
+<p>Output:</p>
+
+<pre><code>* Chris
+*
+* &amp;lt;b&amp;gt;GitHub&amp;lt;/b&amp;gt;
+* &lt;b&gt;GitHub&lt;/b&gt;
+</code></pre>
+
+<h3>Boolean Sections</h3>
+
+<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>If the <code>person</code> key exists and calling it returns false, the HTML
+between the pound and slash will not be displayed.</p>
+
+<p>If the <code>person</code> method exists and calling it returns true, the HTML
+between the pound and slash will be rendered and displayed.</p>
+
+<p>Template:</p>
+
+<pre><code>{{#person}}
+  Shown!
+{{/person}}
+{{#anything_else}}
+  Never shown!
+{{/anything_else}}
+</code></pre>
+
+<p>Hash:</p>
+
+<pre><code>{
+  "person": true
+}
+</code></pre>
+
+<p>Output:</p>
+
+<pre><code>Shown!
+</code></pre>
+
+<h3>Enumerable Sections</h3>
+
+<p>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>
+
+<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>
+
+<p>Template:</p>
+
+<pre><code>{{#repo}}
+  &lt;b&gt;{{name}}&lt;/b&gt;
+{{/repo}}
+</code></pre>
+
+<p>Hash:</p>
+
+<pre><code>{
+  "repo": [
+    { "name": "resque" },
+    { "name": "hub" },
+    { "name": "rip" },
+  ]
+}
+</code></pre>
+
+<p>Output:</p>
+
+<pre><code>&lt;b&gt;resque&lt;/b&gt;
+&lt;b&gt;hub&lt;/b&gt;
+&lt;b&gt;rip&lt;/b&gt;
+</code></pre>
+
+<h3>Comments</h3>
+
+<p>Comments begin with a bang and are ignored. The following template:</p>
+
+<pre><code>&lt;h1&gt;Today{{! ignore me }}.&lt;/h1&gt;
+</code></pre>
+
+<p>Will render as follows:</p>
+
+<pre><code>&lt;h1&gt;Today.&lt;/h1&gt;
+</code></pre>
+
+<h3>Partials</h3>
+
+<p>Partials begin with a greater than sign, like <code>{{&gt; box}}</code>.</p>
+
+<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>
+
+<p>For example, this template and partial:</p>
+
+<pre><code>base.mustache:
+&lt;h2&gt;Names&lt;/h2&gt;
+{{# names }}
+  {{&gt; user }}
+{{/ names }}
+
+user.mustache:
+&lt;strong&gt;{{ name }}&lt;/strong&gt;
+</code></pre>
+
+<p>Can be thought of as a single, expanded template:</p>
+
+<pre><code>&lt;h2&gt;Names&lt;/h2&gt;
+{{# names }}
+  &lt;strong&gt;{{ name }}&lt;/strong&gt;
+{{/ names }}
+</code></pre>
+
+<h3>Set Delimiter</h3>
+
+<p>Set Delimiter tags start with an equal sign and change the tag
+delimiters from {{ and }} to custom strings.</p>
+
+<p>Consider the following contrived example:</p>
+
+<pre><code>* {{ default_tags }}
+{{=&lt;% %&gt;=}}
+* &lt;% erb_style_tags %&gt;
+&lt;%={{ }}=%&gt;
+* {{ 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://google-ctemplate.googlecode.com/svn/trunk/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>COPYRIGHT</h2>
+
+<p>Mustache is Copyright (C) 2009 Chris Wanstrath</p>
+
+<p>Original CTemplate by Google</p>
+
+<h2>SEE ALSO</h2>
+
+<p>mustache(1), mustache(7), gem(1),
+<a href="http://defunkt.github.com/mustache/">http://defunkt.github.com/mustache/</a></p>
+
+<ol class='foot man'>
+  <li class='tl'>DEFUNKT</li>
+  <li class='tc'>March 2010</li>
+  <li class='tr'>mustache(5)</li>
+</ol>
+
+</div>
+</body>
+</html>