PageRenderTime 40ms CodeModel.GetById 12ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/gem.haml-3.1.4/classes/Haml.html

https://github.com/toy/rb
HTML | 278 lines | 185 code | 93 blank | 0 comment | 0 complexity | da29e3057943345662970d50d3b44d09 MD5 | raw file
    

  1. <?xml version="1.0" encoding="utf-8"?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    3. 

  3.     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    4. 

  4. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    5. 

  5. <head>
    6. 

  6.     <title>Haml</title>
    7. 

  7.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    8. 

  8.     <link rel="stylesheet" href="../css/reset.css" type="text/css" media="screen" />
    9. 

  9.     <link rel="stylesheet" href="../css/main.css" type="text/css" media="screen" />
    10. 

  10.     <script src="../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
    11. 

  11.     <script src="../js/jquery-effect.js" type="text/javascript" charset="utf-8"></script>
    12. 

  12.     <script src="../js/main.js" type="text/javascript" charset="utf-8"></script>
    13. 

  13. </head>
    14. 

  14. 

  15. <body>     
    16. 

  16.     <div class="banner">
    17. 

  17.         <h1>
    18. 

  18.             <span class="type">Module</span> 
    19. 

  19.             Haml 
    20. 

  20.             
    21. 

  21.         </h1>
    22. 

  22.         <ul class="files">
    23. 

  23.             
    24. 

  24.             <li><a href="../files/lib/haml/buffer_rb.html">lib/haml/buffer.rb</a></li>
    25. 

  25.             
    26. 

  26.             <li><a href="../files/lib/haml/compiler_rb.html">lib/haml/compiler.rb</a></li>
    27. 

  27.             
    28. 

  28.             <li><a href="../files/lib/haml/engine_rb.html">lib/haml/engine.rb</a></li>
    29. 

  29.             
    30. 

  30.             <li><a href="../files/lib/haml/error_rb.html">lib/haml/error.rb</a></li>
    31. 

  31.             
    32. 

  32.             <li><a href="../files/lib/haml/exec_rb.html">lib/haml/exec.rb</a></li>
    33. 

  33.             
    34. 

  34.             <li><a href="../files/lib/haml/filters_rb.html">lib/haml/filters.rb</a></li>
    35. 

  35.             
    36. 

  36.             <li><a href="../files/lib/haml/helpers/action_view_extensions_rb.html">lib/haml/helpers/action_view_extensions.rb</a></li>
    37. 

  37.             
    38. 

  38.             <li><a href="../files/lib/haml/helpers/xss_mods_rb.html">lib/haml/helpers/xss_mods.rb</a></li>
    39. 

  39.             
    40. 

  40.             <li><a href="../files/lib/haml/helpers_rb.html">lib/haml/helpers.rb</a></li>
    41. 

  41.             
    42. 

  42.             <li><a href="../files/lib/haml/html/erb_rb.html">lib/haml/html/erb.rb</a></li>
    43. 

  43.             
    44. 

  44.             <li><a href="../files/lib/haml/html_rb.html">lib/haml/html.rb</a></li>
    45. 

  45.             
    46. 

  46.             <li><a href="../files/lib/haml/parser_rb.html">lib/haml/parser.rb</a></li>
    47. 

  47.             
    48. 

  48.             <li><a href="../files/lib/haml/root_rb.html">lib/haml/root.rb</a></li>
    49. 

  49.             
    50. 

  50.             <li><a href="../files/lib/haml/shared_rb.html">lib/haml/shared.rb</a></li>
    51. 

  51.             
    52. 

  52.             <li><a href="../files/lib/haml/template/options_rb.html">lib/haml/template/options.rb</a></li>
    53. 

  53.             
    54. 

  54.             <li><a href="../files/lib/haml/template/plugin_rb.html">lib/haml/template/plugin.rb</a></li>
    55. 

  55.             
    56. 

  56.             <li><a href="../files/lib/haml/template_rb.html">lib/haml/template.rb</a></li>
    57. 

  57.             
    58. 

  58.             <li><a href="../files/lib/haml/version_rb.html">lib/haml/version.rb</a></li>
    59. 

  59.             
    60. 

  60.             <li><a href="../files/lib/haml/util_rb.html">lib/haml/util.rb</a></li>
    61. 

  61.             
    62. 

  62.             <li><a href="../files/lib/haml_rb.html">lib/haml.rb</a></li>
    63. 

  63.             
    64. 

  64.         </ul>
    65. 

  65.     </div>
    66. 

  66.     <div id="bodyContent">
    67. 

  67.         <div id="content">
    68. 

  68.     
    69. 

  69.     <div class="description">
    70. 

  70.         <p>
    71. 

  71. We keep options in its own self-contained file so that we can load it
    72. 

  72. independently in Rails 3, where the full template stuff is lazy-loaded.
    73. 

  73. </p>
    74. 

  74. <hr size="1"></hr><p>
    75. 

  75. This file makes <a href="Haml.html">Haml</a> work with Rails using the >
    76. 

  76. 2.0.1 template handler API.
    77. 

  77. </p>
    78. 

  78. <hr size="1"></hr><p>
    79. 

  79. The module that contains everything Haml-related:
    80. 

  80. </p>
    81. 

  81. <ul>
    82. 

  82. <li>{Haml::Engine} is the class used to render <a href="Haml.html">Haml</a>
    83. 

  83. within Ruby code.
    84. 

  84. 

  85. </li>
    86. 

  86. <li>{Haml::Helpers} contains Ruby helpers available within <a
    87. 

  87. href="Haml.html">Haml</a> templates.
    88. 

  88. 

  89. </li>
    90. 

  90. <li>{Haml::Template} interfaces with web frameworks (Rails in particular).
    91. 

  91. 

  92. </li>
    93. 

  93. <li>{Haml::Error} is raised when <a href="Haml.html">Haml</a> encounters an
    94. 

  94. error.
    95. 

  95. 

  96. </li>
    97. 

  97. <li>{Haml::HTML} handles conversion of <a href="Haml/HTML.html">HTML</a> to <a
    98. 

  98. href="Haml.html">Haml</a>.
    99. 

  99. 

  100. </li>
    101. 

  101. </ul>
    102. 

  102. <p>
    103. 

  103. Also see the {file:HAML_REFERENCE.md full <a href="Haml.html">Haml</a>
    104. 

  104. reference}.
    105. 

  105. </p>
    106. 

  106. 

  107.     </div>
    108. 

  108.     
    109. 

  109. 

  110.     
    111. 

  111. 

  112.     
    113. 

  113.     
    114. 

  114. 

  115.     
    116. 

  116.     
    117. 

  117.     <div class="sectiontitle">Methods</div>
    118. 

  118.     <dl class="methods">
    119. 

  119.     
    120. 

  120.         <dt>I</dt>
    121. 

  121.         <dd>
    122. 

  122.             <ul>
    123. 

  123.                 
    124. 

  124.                 <li><a href="#M000311">init_rails</a></li>
    125. 

  125.                 
    126. 

  126.             </ul>
    127. 

  127.         </dd>
    128. 

  128.     
    129. 

  129.     </dl>
    130. 

  130.     
    131. 

  131. 

  132.     
    133. 

  133. 

  134.     
    135. 

  135. 

  136.     
    137. 

  137.     <div class="sectiontitle">Classes and Modules</div>
    138. 

  138.     <ul>
    139. 

  139.         
    140. 

  140.         <li><span class="type">MODULE</span> <a href="Haml/Compiler.html">Haml::Compiler</a></li>
    141. 

  141.         
    142. 

  142.         <li><span class="type">MODULE</span> <a href="Haml/Exec.html">Haml::Exec</a></li>
    143. 

  143.         
    144. 

  144.         <li><span class="type">MODULE</span> <a href="Haml/Filters.html">Haml::Filters</a></li>
    145. 

  145.         
    146. 

  146.         <li><span class="type">MODULE</span> <a href="Haml/Helpers.html">Haml::Helpers</a></li>
    147. 

  147.         
    148. 

  148.         <li><span class="type">MODULE</span> <a href="Haml/Parser.html">Haml::Parser</a></li>
    149. 

  149.         
    150. 

  150.         <li><span class="type">MODULE</span> <a href="Haml/Shared.html">Haml::Shared</a></li>
    151. 

  151.         
    152. 

  152.         <li><span class="type">MODULE</span> <a href="Haml/Template.html">Haml::Template</a></li>
    153. 

  153.         
    154. 

  154.         <li><span class="type">MODULE</span> <a href="Haml/Util.html">Haml::Util</a></li>
    155. 

  155.         
    156. 

  156.         <li><span class="type">MODULE</span> <a href="Haml/Version.html">Haml::Version</a></li>
    157. 

  157.         
    158. 

  158.         <li><span class="type">CLASS</span> <a href="Haml/Buffer.html">Haml::Buffer</a></li>
    159. 

  159.         
    160. 

  160.         <li><span class="type">CLASS</span> <a href="Haml/Engine.html">Haml::Engine</a></li>
    161. 

  161.         
    162. 

  162.         <li><span class="type">CLASS</span> <a href="Haml/Error.html">Haml::Error</a></li>
    163. 

  163.         
    164. 

  164.         <li><span class="type">CLASS</span> <a href="Haml/HTML.html">Haml::HTML</a></li>
    165. 

  165.         
    166. 

  166.         <li><span class="type">CLASS</span> <a href="Haml/Plugin.html">Haml::Plugin</a></li>
    167. 

  167.         
    168. 

  168.         <li><span class="type">CLASS</span> <a href="Haml/SyntaxError.html">Haml::SyntaxError</a></li>
    169. 

  169.         
    170. 

  170.     </ul>
    171. 

  171.     
    172. 

  172. 

  173.     
    174. 

  174.     <div class="sectiontitle">Constants</div>
    175. 

  175.     <table border='0' cellpadding='5'>
    176. 

  176.         
    177. 

  177.         <tr valign='top'>
    178. 

  178.             <td class="attr-name">ROOT_DIR</td>
    179. 

  179.             <td>=</td>
    180. 

  180.             <td class="attr-value">File.expand_path(File.join(__FILE__, &quot;../../..&quot;))</td>
    181. 

  181.         </tr>
    182. 

  182.         
    183. 

  183.         <tr valign='top'>
    184. 

  184.             <td>&nbsp;</td>
    185. 

  185.             <td colspan="2" class="attr-desc"><p>
    186. 

  186. The root directory of the <a href="Haml.html">Haml</a> source tree. This
    187. 

  187. may be overridden by the package manager if the lib directory is separated
    188. 

  188. from the main source tree. @api public
    189. 

  189. </p>
    190. 

  190. </td>
    191. 

  191.         </tr>
    192. 

  192.         
    193. 

  193.         
    194. 

  194.         <tr valign='top'>
    195. 

  195.             <td class="attr-name">VERSION</td>
    196. 

  196.             <td>=</td>
    197. 

  197.             <td class="attr-value">version[:string] unless defined?(Haml::VERSION)</td>
    198. 

  198.         </tr>
    199. 

  199.         
    200. 

  200.         <tr valign='top'>
    201. 

  201.             <td>&nbsp;</td>
    202. 

  202.             <td colspan="2" class="attr-desc"><p>
    203. 

  203. A string representing the version of <a href="Haml.html">Haml</a>. A more
    204. 

  204. fine-grained representation is available from Haml.version. @api public
    205. 

  205. </p>
    206. 

  206. </td>
    207. 

  207.         </tr>
    208. 

  208.         
    209. 

  209.         
    210. 

  210.     </table>
    211. 

  211.     
    212. 

  212. 

  213.     
    214. 

  214. 

  215.     
    216. 

  216.             <div class="sectiontitle">Class Public methods</div>
    217. 

  217.             
    218. 

  218.             <div class="method">
    219. 

  219.                 <div class="title" id="M000311">
    220. 

  220.                     
    221. 

  221.                     <a name="M000311"></a><b>init_rails</b>(binding)
    222. 

  222.                     
    223. 

  223.                 </div>
    224. 

  224.                 
    225. 

  225.                 <div class="description">
    226. 

  226.                   <p>
    227. 

  227. Initializes <a href="Haml.html">Haml</a> for Rails.
    228. 

  228. </p>
    229. 

  229. <p>
    230. 

  230. This method is called by `init.rb`, which is run by Rails on startup. We
    231. 

  231. use it rather than putting stuff straight into `init.rb` so we can change
    232. 

  232. the initialization behavior without modifying the file itself.
    233. 

  233. </p>
    234. 

  234. <p>
    235. 

  235. @param binding [Binding] The context of the `init.rb` file.
    236. 

  236. </p>
    237. 

  237. <pre>
    238. 

  238.   This isn't actually used;
    239. 

  239.   it's just passed in in case it needs to be used in the future
    240. 

  240. </pre>
    241. 

  241. 

  242.                 </div>
    243. 

  243.                 
    244. 

  244.                 
    245. 

  245.                 
    246. 

  246.                 
    247. 

  247.                 <div class="sourcecode">
    248. 

  248.                     <p class="source-link">
    249. 

  249.                         Source: <a href="javascript:toggleSource('M000311_source')" id="l_M000311_source">show</a>
    250. 

  250.                         
    251. 

  251.                     </p>
    252. 

  252.                     <div id="M000311_source" class="dyn-source">
    253. 

  253.                         <pre>    <span class="ruby-comment cmt"># File lib/haml.rb, line 27</span>
    254. 

  254. 27:   <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">init_rails</span>(<span class="ruby-identifier">binding</span>)
    255. 

  255. 28:     <span class="ruby-comment cmt"># 2.2 &lt;= Rails &lt; 3</span>
    256. 

  256. 29:     <span class="ruby-keyword kw">if</span> <span class="ruby-keyword kw">defined?</span>(<span class="ruby-constant">Rails</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-constant">Rails</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">:configuration</span>) <span class="ruby-operator">&amp;&amp;</span>
    257. 

  257. 30:         <span class="ruby-constant">Rails</span>.<span class="ruby-identifier">configuration</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">:after_initialize</span>) <span class="ruby-operator">&amp;&amp;</span>
    258. 

  258. 31:         <span class="ruby-operator">!</span><span class="ruby-constant">Haml</span><span class="ruby-operator">::</span><span class="ruby-constant">Util</span>.<span class="ruby-identifier">ap_geq_3?</span>
    259. 

  259. 32:       <span class="ruby-constant">Rails</span>.<span class="ruby-identifier">configuration</span>.<span class="ruby-identifier">after_initialize</span> <span class="ruby-keyword kw">do</span>
    260. 

  260. 33:         <span class="ruby-keyword kw">next</span> <span class="ruby-keyword kw">if</span> <span class="ruby-keyword kw">defined?</span>(<span class="ruby-constant">Sass</span>)
    261. 

  261. 34:         <span class="ruby-identifier">autoload</span>(<span class="ruby-identifier">:Sass</span>, <span class="ruby-value str">'sass/rails2_shim'</span>)
    262. 

  262. 35:         <span class="ruby-comment cmt"># resolve autoload if it looks like they're using Sass without options</span>
    263. 

  263. 36:         <span class="ruby-constant">Sass</span> <span class="ruby-keyword kw">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">RAILS_ROOT</span>, <span class="ruby-value str">'public/stylesheets/sass'</span>))
    264. 

  264. 37:       <span class="ruby-keyword kw">end</span>
    265. 

  265. 38:     <span class="ruby-keyword kw">end</span>
    266. 

  266. 39: 
    267. 

  267. 40:     <span class="ruby-comment cmt"># No &amp;method here for Rails 2.1 compatibility</span>
    268. 

  268. 41:     <span class="ruby-node">%w[haml/template]</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">require</span> <span class="ruby-identifier">f</span>}
    269. 

  269. 42:   <span class="ruby-keyword kw">end</span></pre>
    270. 

  270.                     </div>
    271. 

  271.                 </div>
    272. 

  272.                 
    273. 

  273.             </div>
    274. 

  274.             
    275. 

  275. </div>
    276. 

  276.     </div>
    277. 

  277.   </body>
    278. 

  278. </html>    
    279.