Permalink
Browse files

wip

  • Loading branch information...
groue committed Feb 2, 2012
1 parent fcd0d2f commit c0e699e743a633cf568416355126765189480320
View
@@ -56,13 +56,7 @@ GRMustache supports two Mustache flavors : the genuine Mustache, and a bit a [Ha
The main difference lies in the syntax of key paths: genuine Mustache reads `{{foo.bar.baz}}`, while Handlebars reads `{{foo/bar/baz}}` and even `{{../foo/bar/baz}}`.
-GRMustache default flavor is Handlebars.
-
-**TL;DR**: Your application should globally follow the genuine Mustache way. Run prior to any GRMustache rendering the following statement:
-
- [GRMustache setDefaultTemplateOptions:GRMustacheTemplateOptionMustacheSpecCompatibility];
-
-Longer version: in [guides/flavors.md](blob/master/guides/flavors.md), you'll read the exact extent of both specification coverage, and how to implement applications mixing templates of differents flavors.
+If your templates use such compound key paths, you should read [guides/flavors.md](blob/master/guides/flavors.md).
Features worth noting
@@ -80,6 +74,11 @@ GRMustache ships with a few helper classes. One allows you to format all numbers
They are covered by [guides/number_formatting.md](blob/master/guides/number_formatting.md) and [guides/date_formatting.md](blob/master/guides/date_formatting.md)
+Forking
+-------
+
+Please fork. You'll learn useful information in [guides/forking.md](blob/master/guides/forking.md).
+
License
-------
@@ -1,4 +1,4 @@
-[up](../README.md), [next]()
+[up](../README.md), [next](flavors.md)
Date formatting with GRMustacheDateFormatterHelper
==================================================
@@ -11,4 +11,4 @@ It does not belong the the core GRMustache code, and as such must be imported se
Read [guides/number_formatting.md](number_formatting.md) documentation, because the principles are the same. You'll just provide a `NSDateFormatter` instead of a `NSNumberFormatter`.
-[up](../README.md), [next]()
+[up](../README.md), [next](flavors.md)
View
@@ -1,4 +1,4 @@
-[up](../README.md), [next]()
+[up](../README.md), [next](templates.md)
Embedding GRMustache in your XCode project
==========================================
@@ -38,4 +38,4 @@ However, you will have to explicitely import:
when you want to use these helpers in order to format your numbers and dates. See [guides/number_formatting.md](number_formatting.md) and [guides/date_formatting.md](date_formatting.md)
-[up](../README.md), [next]()
+[up](../README.md), [next](templates.md)
View
@@ -1,4 +1,4 @@
-[up](../README.md), [next]()
+[up](../README.md), [next](forking.md)
Mustache flavors
================
@@ -90,4 +90,4 @@ That is to say, each character of your templates will be rendered as is, whitesp
Actually, GRMustache implements a single one: the syntax for key paths `{{foo/bar/baz}}` and `{{../foo/bar/baz}}`.
-[up](../README.md), [next]()
+[up](../README.md), [next](forking.md)
View
@@ -1,4 +1,4 @@
-[up](../README.md), [next]()
+[up](../README.md)
# Note on forking
@@ -74,4 +74,4 @@ The XCode GUI can not build them. Instead, you'll issue the following command in
$ make clean && make
-[up](../README.md), [next]()
+[up](../README.md)
View
No changes.
@@ -55,4 +55,3 @@ The first will look for `bar` anywhere in the context stack, starting with the `
The latter ensures the `bar` key comes from the `foo` object.
[up](../runtime.md), [next](loops.md)
-
@@ -1,4 +1,4 @@
-[up](../runtime.md), [next](../forking.md)
+[up](../runtime.md), [next](../number_formatting.md)
Helpers
=======
@@ -170,4 +170,4 @@ You may implement debugging sections:
return nil; // don't render anything
});
-[up](../runtime.md), [next](../forking.md)
+[up](../runtime.md), [next](../number_formatting.md)
@@ -0,0 +1,4 @@
+Template loaders
+================
+
+TODO
View
@@ -1,8 +1,12 @@
+[up](../README.md), [next](runtime.md)
+
Templates
=========
You'll learn here how to load, and render templates. [guides/runtime.md](runtime.md) will talk about about what happens *during* the rendering itself.
+---
+
**TL;DR** Let XCode autocompletion magic find the correct method for you: just type "`[GRMustacheTemplate render`" or "`[GRMustacheTemplate parse`".
The `render...` family parses and renders templates on-the-fly, from strings, bundle resources, or files. The `parse...` family parses only. You'll then have to invoke `renderObject:` on the generated GRMustacheTemplate instances:
@@ -102,7 +106,7 @@ Those methods return GRMustacheTemplate instances, which render objects with the
- (NSString *)renderObject:(id)object;
- (NSString *)renderObjects:(id)object, ...; // nil-terminated list
-The latter method, which takes several arguments, is helpful when several objects should feed the template.
+The latter method, which takes several arguments, is helpful when several objects should feed the template. It actually initializes the rendering [context stack](runtime/context_stack.md) with those objects.
Partials
--------
@@ -133,3 +137,5 @@ More loading options
--------------------
All methods above load UTF8-encoded templates and partials from disk. If this does not fulfill your needs, check [guides/template_loaders.md](template_loaders.md)
+
+[up](../README.md), [next](runtime.md)

0 comments on commit c0e699e

Please sign in to comment.