diff options
| author | Matthias Andreas Benkard <code@mail.matthias.benkard.de> | 2011-06-25 23:51:40 +0200 |
|---|---|---|
| committer | Matthias Andreas Benkard <code@mail.matthias.benkard.de> | 2011-06-25 23:51:40 +0200 |
| commit | 431d0cf525f96f00a35a700a5cd5d91990a172e6 (patch) | |
| tree | e6b9132a330bc77c6d764ee1a8ecfc35d417bd1f /manual.scrbl | |
| parent | 976d5cdd3d728d9fa1e2f177f7fa400492a5bf97 (diff) | |
| parent | 636bca26b171649af1e48f74e725b7a2157f5d49 (diff) | |
Merge Typed Racket branch.
Diffstat (limited to 'manual.scrbl')
| -rw-r--r-- | manual.scrbl | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/manual.scrbl b/manual.scrbl new file mode 100644 index 0000000..9f8b6b5 --- /dev/null +++ b/manual.scrbl @@ -0,0 +1,88 @@ +#lang scribble/manual
+@;@(require planet/scribble)
+@(require scribble/eval)
+@(require racket/sandbox)
+@(require (for-label racket))
+@(require (for-label "json-template.rkt"))
+@;@(require (for-label (this-package-in json-template)))
+
+@(define r6rs-evaluator
+ (call-with-trusted-sandbox-configuration
+ (lambda ()
+ (parameterize ([sandbox-output 'string]
+ [sandbox-error-output 'string])
+ (make-evaluator
+ 'r6rs
+ '(import (rnrs) (json-template)))))))
+@(define racket-evaluator
+ (call-with-trusted-sandbox-configuration
+ (lambda ()
+ (parameterize ([sandbox-output 'string]
+ [sandbox-error-output 'string])
+ (make-evaluator
+ 'racket/base
+ #:requires (list "json-template.rkt"))))))
+@(define typed-racket-evaluator
+ (call-with-trusted-sandbox-configuration
+ (lambda ()
+ (parameterize ([sandbox-output 'string]
+ [sandbox-error-output 'string])
+ (make-evaluator
+ 'typed/racket/base
+ #:requires (list "json-template.rkt"))))))
+
+
+@title{JSON Template for Racket (and Typed Racket)}
+@author{Matthias A. Benkard}
+
+
+@section{Installation}
+
+JSON Template for Racket is published as a PLaneT module. Simply @racket[(require (planet mbenkard/json-template))] to get started.
+
+
+@section{Usage}
+
+@subsection{API}
+
+@defproc[(make-template [template-data string?]) procedure?]{
+ Create a template from @scheme[template-data], which must be in JSON Template syntax.
+
+ The returned procedure expects a single argument, the @italic{subtitution context}, and returns the expanded template as a string. Three types of contexts are supported:
+
+ @itemlist[
+ @item{@bold{Primitive contexts.} These may be of any form whatever (valid primitive contexts are lists, numbers, symbols, strings, etc.) and are not treated specially. Their only purpose is being printed into the template expansion as plain text. Note that a primitive context does not make a whole lot of sense when used as an argument to @scheme{make-template} (although it can be used as such and referenced as @scheme["@"]); it is much more commonly encountered as a nested context in a map.}
+ @item{@bold{Sequences.} At present, these may only be lists. They can be iterated over by the use of repeated sections.}
+ @item{@bold{Maps.} These may be any kinds of <dict?> objects; in particular, association lists and hash tables are fine choices. They can be indexed into by substitutions.}
+ ]
+
+ @scheme[make-template]'s behavior can be customized by the parameters @scheme[formatters], @scheme[meta-left], @scheme[meta-right], @scheme[default-formatter], and @scheme[format-char].
+
+ For general information about JSON Template, see @url{http://json-template.googlecode.com/svn/trunk/doc/Introducing-JSON-Template.html} and @url{http://code.google.com/p/json-template/wiki/Reference}.
+}
+
+
+@subsection{Examples}
+
+@interaction[#:eval racket-evaluator
+(define template (make-template "
+<h1>{title|html}</h1>
+{.section people}
+<ul>
+{.repeated section @}
+ <li>{name} ({age} years)</li>
+{.end}
+</ul>
+{.or}
+<p>No one's registered.</p>
+{.end}
+"))
+(template '((title . "<Registered People>")
+ (people .
+ (((name . "Nathalie") (age . 24))
+ ((name . "Heinrich") (age . 28))
+ ((name . "Hans") (age . 25))))))
+(template '((title . "<Registered People>")
+ (people)))
+(template '((title . "<Registered People>")))
+]
|