diff options
Diffstat (limited to 'doc/Zero/Renderer.html')
| -rw-r--r-- | doc/Zero/Renderer.html | 654 |
1 files changed, 0 insertions, 654 deletions
diff --git a/doc/Zero/Renderer.html b/doc/Zero/Renderer.html deleted file mode 100644 index 4ce1cee..0000000 --- a/doc/Zero/Renderer.html +++ /dev/null @@ -1,654 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<title> - Class: Zero::Renderer - - — Documentation by YARD 0.8.3 - -</title> - - <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" /> - - <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" /> - -<script type="text/javascript" charset="utf-8"> - hasFrames = window.top.frames.main ? true : false; - relpath = '../'; - framesUrl = "../frames.html#!" + escape(window.location.href); -</script> - - - <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> - - <script type="text/javascript" charset="utf-8" src="../js/app.js"></script> - - - </head> - <body> - <div id="header"> - <div id="menu"> - - <a href="../_index.html">Index (R)</a> » - <span class='title'><span class='object_link'><a href="../Zero.html" title="Zero (module)">Zero</a></span></span> - » - <span class="title">Renderer</span> - - - <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div> -</div> - - <div id="search"> - - <a class="full_list_link" id="class_list_link" - href="../class_list.html"> - Class List - </a> - - <a class="full_list_link" id="method_list_link" - href="../method_list.html"> - Method List - </a> - - <a class="full_list_link" id="file_list_link" - href="../file_list.html"> - File List - </a> - -</div> - <div class="clear"></div> - </div> - - <iframe id="search_frame"></iframe> - - <div id="content"><h1>Class: Zero::Renderer - - - -</h1> - -<dl class="box"> - - <dt class="r1">Inherits:</dt> - <dd class="r1"> - <span class="inheritName">Object</span> - - <ul class="fullTree"> - <li>Object</li> - - <li class="next">Zero::Renderer</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/zero/renderer.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>This class helps with rendering of content.</p> - -<p>The purpose of this class is to render templates. All variables pushed into -the renderer should be already processed, so that the raw data can be used.</p> - -<p>The workflow of this class is like the following.</p> -<ul><li> -<p>setup the type mapping</p> -</li><li> -<p>create a new instance of the class to prepare rendering</p> -</li><li> -<p>call #render to process the template</p> -</li></ul> - -<p>The call to #render will return the String representation of the template -with all data given.</p> - - - </div> -</div> -<div class="tags"> - - -</div> - - - - - - - - <h2> - Class Method Summary - <small>(<a href="#" class="summary_toggle">collapse</a>)</small> - </h2> - - <ul class="summary"> - - <li class="public "> - <span class="summary_signature"> - - <a href="#template_path%3D-class_method" title="template_path= (class method)">+ (Object) <strong>template_path=</strong>(path) </a> - - - - </span> - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>set a base path for template search.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#type_map-class_method" title="type_map (class method)">+ (Hash) <strong>type_map</strong> </a> - - - - </span> - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>returns the type map.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#type_map%3D-class_method" title="type_map= (class method)">+ (Object) <strong>type_map=</strong>(map) </a> - - - - </span> - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>save a mapping hash for the type.</p> -</div></span> - -</li> - - - </ul> - - <h2> - Instance Method Summary - <small>(<a href="#" class="summary_toggle">collapse</a>)</small> - </h2> - - <ul class="summary"> - - <li class="public "> - <span class="summary_signature"> - - <a href="#initialize-instance_method" title="#initialize (instance method)">- (Renderer) <strong>initialize</strong>(path, context, accept_types) </a> - - - - </span> - - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>take the path and render the template within the context.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#render-instance_method" title="#render (instance method)">- (String) <strong>render</strong> </a> - - - - </span> - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>render the template within the context.</p> -</div></span> - -</li> - - - </ul> - - -<div id="constructor_details" class="method_details_list"> - <h2>Constructor Details</h2> - - <div class="method_details first"> - <h3 class="signature first" id="initialize-instance_method"> - - - (<tt><span class='object_link'><a href="" title="Zero::Renderer (class)">Renderer</a></span></tt>) <strong>initialize</strong>(path, context, accept_types) - - - - - -</h3><div class="docstring"> - <div class="discussion"> - -<p>take the path and render the template within the context</p> - - - </div> -</div> -<div class="tags"> - <p class="tag_title">Parameters:</p> -<ul class="param"> - - <li> - - <span class='name'>path</span> - - - <span class='type'>(<tt>String</tt>)</span> - - - - — - <div class='inline'> -<p>the relative path to the template</p> -</div> - - </li> - - <li> - - <span class='name'>context</span> - - - <span class='type'>(<tt>Object</tt>)</span> - - - - — - <div class='inline'> -<p>the object to process on</p> -</div> - - </li> - - <li> - - <span class='name'>accept_types</span> - - - <span class='type'></span> - - - - </li> - -</ul> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -49 -50 -51 -52 -53</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/zero/renderer.rb', line 49</span> - -<span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_context identifier id'>context</span><span class='comma token'>,</span> <span class='rubyid_accept_types identifier id'>accept_types</span><span class='rparen token'>)</span> - <span class='rubyid_accept_types identifier id'>accept_types</span> <span class='opasgn op'>||=</span> <span class='rubyid_Request constant id'>Request</span><span class='colon2 op'>::</span><span class='rubyid_Accept constant id'>Accept</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='string val'>'text/html'</span><span class='rparen token'>)</span> - <span class='rubyid_@path ivar id'>@path</span> <span class='assign token'>=</span> <span class='rubyid_find_template identifier id'>find_template</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_accept_types identifier id'>accept_types</span><span class='rparen token'>)</span> - <span class='rubyid_@context ivar id'>@context</span> <span class='assign token'>=</span> <span class='rubyid_context identifier id'>context</span> -<span class='rubyid_end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - -</div> - - - <div id="class_method_details" class="method_details_list"> - <h2>Class Method Details</h2> - - - <div class="method_details first"> - <h3 class="signature first" id="template_path=-class_method"> - - + (<tt>Object</tt>) <strong>template_path=</strong>(path) - - - - - -</h3><div class="docstring"> - <div class="discussion"> - -<p>set a base path for template search</p> - - - </div> -</div> -<div class="tags"> - <p class="tag_title">Parameters:</p> -<ul class="param"> - - <li> - - <span class='name'>path</span> - - - <span class='type'>(<tt>String</tt>)</span> - - - - — - <div class='inline'> -<p>the path to the template base dir</p> -</div> - - </li> - -</ul> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -20 -21 -22</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/zero/renderer.rb', line 20</span> - -<span class='rubyid_def def kw'>def</span> <span class='rubyid_template_path= identifier id'>template_path=</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='rparen token'>)</span> - <span class='rubyid_@@path ivar id'>@@path</span> <span class='assign token'>=</span> <span class='rubyid_path identifier id'>path</span> <span class='plus op'>+</span> <span class='string val'>'/'</span> -<span class='rubyid_end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <h3 class="signature " id="type_map-class_method"> - - + (<tt>Hash</tt>) <strong>type_map</strong> - - - - - -</h3><div class="docstring"> - <div class="discussion"> - -<p>returns the type map</p> - - - </div> -</div> -<div class="tags"> - -<p class="tag_title">Returns:</p> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Hash</tt>)</span> - - - - — - <div class='inline'> -<p>the mapping for types</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -40 -41 -42</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/zero/renderer.rb', line 40</span> - -<span class='rubyid_def def kw'>def</span> <span class='rubyid_type_map identifier id'>type_map</span> - <span class='rubyid_@@map ivar id'>@@map</span> <span class='opasgn op'>||=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span> -<span class='rubyid_end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <h3 class="signature " id="type_map=-class_method"> - - + (<tt>Object</tt>) <strong>type_map=</strong>(map) - - - - - -</h3><div class="docstring"> - <div class="discussion"> - -<p>save a mapping hash for the type</p> - -<p>With that it is possible to map long and complex contant types to simpler -representations. These get then used in the finding process for the best -fitting template.</p> - - - </div> -</div> -<div class="tags"> - - <div class="examples"> - <p class="tag_title">Examples:</p> - - - <pre class="example code"><span class='rubyid_Zero constant id'>Zero</span><span class='colon2 op'>::</span><span class='rubyid_Renderer constant id'>Renderer</span><span class='dot token'>.</span><span class='rubyid_map identifier id'>map</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='string val'>'text/html'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>'html'</span><span class='rbrace token'>}</span> -</pre> - - </div> -<p class="tag_title">Parameters:</p> -<ul class="param"> - - <li> - - <span class='name'>map</span> - - - <span class='type'>(<tt>Hash</tt>)</span> - - - - — - <div class='inline'> -<p>maps the content type to a simple representation</p> -</div> - - </li> - -</ul> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -34 -35 -36</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/zero/renderer.rb', line 34</span> - -<span class='rubyid_def def kw'>def</span> <span class='rubyid_type_map= identifier id'>type_map=</span><span class='lparen token'>(</span><span class='rubyid_map identifier id'>map</span><span class='rparen token'>)</span> - <span class='rubyid_@@map ivar id'>@@map</span> <span class='assign token'>=</span> <span class='rubyid_map identifier id'>map</span> -<span class='rubyid_end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - </div> - - <div id="instance_method_details" class="method_details_list"> - <h2>Instance Method Details</h2> - - - <div class="method_details first"> - <h3 class="signature first" id="render-instance_method"> - - - (<tt>String</tt>) <strong>render</strong> - - - - - -</h3><div class="docstring"> - <div class="discussion"> - -<p>render the template within the context</p> - - - </div> -</div> -<div class="tags"> - -<p class="tag_title">Returns:</p> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>String</tt>)</span> - - - - — - <div class='inline'> -<p>the rendered template</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -57 -58 -59</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/zero/renderer.rb', line 57</span> - -<span class='rubyid_def def kw'>def</span> <span class='rubyid_render identifier id'>render</span> - <span class='rubyid_Tilt constant id'>Tilt</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_@path ivar id'>@path</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_render identifier id'>render</span><span class='lparen token'>(</span><span class='rubyid_@context ivar id'>@context</span><span class='rparen token'>)</span> -<span class='rubyid_end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - </div> - -</div> - - <div id="footer"> - Generated on Mon Nov 26 21:40:01 2012 by - <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.8.3 (ruby-1.9.3). -</div> - - </body> -</html>
\ No newline at end of file |