haml 1.0.5 → 1.5.0

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of haml might be problematic. Click here for more details.

Files changed (92) hide show
  1. data/README +229 -0
  2. data/Rakefile +56 -60
  3. data/VERSION +1 -1
  4. data/bin/haml +4 -14
  5. data/bin/html2haml +89 -0
  6. data/bin/sass +8 -0
  7. data/init.rb +5 -1
  8. data/lib/haml.rb +643 -0
  9. data/lib/haml/buffer.rb +33 -30
  10. data/lib/haml/engine.rb +258 -75
  11. data/lib/haml/error.rb +43 -0
  12. data/lib/haml/exec.rb +181 -0
  13. data/lib/haml/filters.rb +89 -0
  14. data/lib/haml/helpers.rb +19 -5
  15. data/lib/haml/helpers/action_view_mods.rb +28 -4
  16. data/lib/haml/template.rb +13 -27
  17. data/lib/sass.rb +418 -0
  18. data/lib/sass/constant.rb +190 -0
  19. data/lib/sass/constant/color.rb +77 -0
  20. data/lib/sass/constant/literal.rb +51 -0
  21. data/lib/sass/constant/number.rb +87 -0
  22. data/lib/sass/constant/operation.rb +30 -0
  23. data/lib/sass/constant/string.rb +18 -0
  24. data/lib/sass/engine.rb +179 -0
  25. data/lib/sass/error.rb +35 -0
  26. data/lib/sass/plugin.rb +119 -0
  27. data/lib/sass/tree/attr_node.rb +44 -0
  28. data/lib/sass/tree/node.rb +29 -0
  29. data/lib/sass/tree/rule_node.rb +47 -0
  30. data/lib/sass/tree/value_node.rb +12 -0
  31. data/test/benchmark.rb +16 -19
  32. data/test/haml/engine_test.rb +220 -0
  33. data/test/{helper_test.rb → haml/helper_test.rb} +9 -8
  34. data/test/{mocks → haml/mocks}/article.rb +0 -0
  35. data/test/{results → haml/results}/content_for_layout.xhtml +0 -0
  36. data/test/{results → haml/results}/eval_suppressed.xhtml +0 -0
  37. data/test/haml/results/filters.xhtml +57 -0
  38. data/test/{results → haml/results}/helpers.xhtml +10 -0
  39. data/test/haml/results/helpful.xhtml +8 -0
  40. data/test/{results → haml/results}/just_stuff.xhtml +5 -0
  41. data/test/{results → haml/results}/list.xhtml +0 -0
  42. data/test/{results → haml/results}/original_engine.xhtml +1 -1
  43. data/test/{results → haml/results}/partials.xhtml +0 -0
  44. data/test/{results → haml/results}/silent_script.xhtml +0 -0
  45. data/test/{results → haml/results}/standard.xhtml +2 -1
  46. data/test/{results → haml/results}/tag_parsing.xhtml +0 -0
  47. data/test/{results → haml/results}/very_basic.xhtml +0 -0
  48. data/test/haml/results/whitespace_handling.xhtml +104 -0
  49. data/test/{rhtml → haml/rhtml}/standard.rhtml +4 -1
  50. data/test/{runner.rb → haml/runner.rb} +1 -1
  51. data/test/{template_test.rb → haml/template_test.rb} +28 -23
  52. data/test/{templates → haml/templates}/_partial.haml +0 -0
  53. data/test/{templates → haml/templates}/_text_area.haml +0 -0
  54. data/test/haml/templates/breakage.haml +8 -0
  55. data/test/{templates → haml/templates}/content_for_layout.haml +0 -0
  56. data/test/{templates → haml/templates}/eval_suppressed.haml +0 -0
  57. data/test/haml/templates/filters.haml +53 -0
  58. data/test/{templates → haml/templates}/helpers.haml +10 -1
  59. data/test/{templates → haml/templates}/helpful.haml +3 -0
  60. data/test/{templates → haml/templates}/just_stuff.haml +7 -0
  61. data/test/{templates → haml/templates}/list.haml +0 -0
  62. data/test/haml/templates/original_engine.haml +17 -0
  63. data/test/{templates → haml/templates}/partialize.haml +0 -0
  64. data/test/{templates → haml/templates}/partials.haml +0 -0
  65. data/test/{templates → haml/templates}/silent_script.haml +0 -0
  66. data/test/{templates → haml/templates}/standard.haml +3 -1
  67. data/test/{templates → haml/templates}/tag_parsing.haml +0 -0
  68. data/test/{templates → haml/templates}/very_basic.haml +0 -0
  69. data/test/haml/templates/whitespace_handling.haml +137 -0
  70. data/test/profile.rb +36 -18
  71. data/test/sass/engine_test.rb +87 -0
  72. data/test/sass/plugin_test.rb +103 -0
  73. data/test/sass/results/basic.css +9 -0
  74. data/test/sass/results/compact.css +5 -0
  75. data/test/sass/results/complex.css +86 -0
  76. data/test/sass/results/constants.css +12 -0
  77. data/test/sass/results/expanded.css +18 -0
  78. data/test/sass/results/nested.css +14 -0
  79. data/test/sass/templates/basic.sass +23 -0
  80. data/test/sass/templates/bork.sass +2 -0
  81. data/test/sass/templates/compact.sass +15 -0
  82. data/test/sass/templates/complex.sass +291 -0
  83. data/test/sass/templates/constants.sass +80 -0
  84. data/test/sass/templates/expanded.sass +15 -0
  85. data/test/sass/templates/nested.sass +15 -0
  86. metadata +98 -48
  87. data/REFERENCE +0 -662
  88. data/test/engine_test.rb +0 -93
  89. data/test/results/helpful.xhtml +0 -5
  90. data/test/results/whitespace_handling.xhtml +0 -51
  91. data/test/templates/original_engine.haml +0 -17
  92. data/test/templates/whitespace_handling.haml +0 -66
@@ -0,0 +1,80 @@
1
+ !width = 10em + 20
2
+ !color = #00ff98
3
+ !main_text = #ffa
4
+ !num = 10
5
+ !dec = 10.2
6
+ !dec_0 = 99.0
7
+ !neg = -10
8
+ !esc= 10\+12
9
+ !str= "Hello!"
10
+ !qstr= "Quo\"ted\"!"
11
+ !hstr= "Hyph-en!"
12
+ !concat = (5 + 4) hi there
13
+
14
+ #main
15
+ :content = !str
16
+ :qstr = !qstr
17
+ :hstr = !hstr
18
+ :width = !width
19
+ :background-color #000
20
+ :color= !main_text
21
+ :con= foo bar (!concat boom)
22
+ :con2= noquo "quo"
23
+ #sidebar
24
+ :background-color= !color
25
+ :num
26
+ :normal= !num
27
+ :dec= !dec
28
+ :dec0= !dec_0
29
+ :neg= !neg
30
+ :esc= !esc
31
+ :many= 1 + 2 + 3
32
+ :order= 1 + 2 * 3
33
+ :complex= ((1 + 2) + 15)+#3a8b9f + (hi+(1 +1+ 2)* 4)
34
+
35
+ #plus
36
+ :num
37
+ :num= 5+2
38
+ :num-un= 10em + 15em
39
+ :num-un2= 10 + 13em
40
+ :num-neg= 10 + -.13
41
+ :str= 100 + px
42
+ :col= 13 + #aaa
43
+ :str
44
+ :str= hi + \ there
45
+ :str2= hi + " there"
46
+ :col= "14em solid " + #123
47
+ :num= times:\ + 13
48
+ :col
49
+ :num= #f02 + 123.5
50
+ :col= #12A + #405162
51
+
52
+ #minus
53
+ :num
54
+ :num= 912 - 12
55
+ :col
56
+ :num= #fffffa - 5.2
57
+ :col= #abcdef - #fedcba
58
+
59
+ #times
60
+ :num
61
+ :num= 2 * 3.5
62
+ :col= 2 * #3a4b5c
63
+ :col
64
+ :num= #12468a * 0.5
65
+ :col= #121212 * #020304
66
+
67
+ #div
68
+ :num
69
+ :num= 10 / 3.0
70
+ :num2= 10 / 3
71
+ :col
72
+ :num= #12468a / 2
73
+ :col= #abcdef / #0f0f0f
74
+
75
+ #mod
76
+ :num
77
+ :num= 17 % 3
78
+ :col
79
+ :col= #5f6e7d % #10200a
80
+ :num= #aaabac % 3
@@ -0,0 +1,15 @@
1
+ #main
2
+ :width 15em
3
+ :color #0000ff
4
+ p
5
+ :border
6
+ :style dotted
7
+ :width 2px
8
+ .cool
9
+ :width 100px
10
+
11
+ #left
12
+ :font
13
+ :size 2em
14
+ :weight bold
15
+ :float left
@@ -0,0 +1,15 @@
1
+ #main
2
+ :width 15em
3
+ :color #0000ff
4
+ p
5
+ :border
6
+ :style dotted
7
+ :width 2px
8
+ .cool
9
+ :width 100px
10
+
11
+ #left
12
+ :font
13
+ :size 2em
14
+ :weight bold
15
+ :float left
metadata CHANGED
@@ -3,9 +3,9 @@ rubygems_version: 0.9.0
3
3
  specification_version: 1
4
4
  name: haml
5
5
  version: !ruby/object:Gem::Version
6
- version: 1.0.5
7
- date: 2007-01-25 00:00:00 -08:00
8
- summary: An elegant, structured XHTML/XML templating engine.
6
+ version: 1.5.0
7
+ date: 2007-03-06 00:00:00 -08:00
8
+ summary: An elegant, structured XHTML/XML templating engine. Comes with Sass, a similar CSS templating engine.
9
9
  require_paths:
10
10
  - lib
11
11
  email: haml@googlegroups.com
@@ -30,68 +30,116 @@ authors:
30
30
  - Hampton Catlin
31
31
  files:
32
32
  - lib/haml
33
+ - lib/sass
34
+ - lib/haml.rb
35
+ - lib/sass.rb
33
36
  - lib/haml/helpers
34
37
  - lib/haml/helpers.rb
35
38
  - lib/haml/engine.rb
36
39
  - lib/haml/buffer.rb
37
40
  - lib/haml/template.rb
41
+ - lib/haml/filters.rb
42
+ - lib/haml/exec.rb
43
+ - lib/haml/error.rb
38
44
  - lib/haml/helpers/action_view_mods.rb
45
+ - lib/sass/tree
46
+ - lib/sass/constant
47
+ - lib/sass/plugin.rb
48
+ - lib/sass/engine.rb
49
+ - lib/sass/constant.rb
50
+ - lib/sass/error.rb
51
+ - lib/sass/tree/value_node.rb
52
+ - lib/sass/tree/attr_node.rb
53
+ - lib/sass/tree/rule_node.rb
54
+ - lib/sass/tree/node.rb
55
+ - lib/sass/constant/operation.rb
56
+ - lib/sass/constant/color.rb
57
+ - lib/sass/constant/string.rb
58
+ - lib/sass/constant/number.rb
59
+ - lib/sass/constant/literal.rb
39
60
  - bin/haml
40
- - test/results
41
- - test/rhtml
42
- - test/mocks
43
- - test/templates
44
- - test/helper_test.rb
61
+ - bin/sass
62
+ - bin/html2haml
63
+ - test/haml
64
+ - test/sass
45
65
  - test/profile.rb
46
- - test/engine_test.rb
47
- - test/runner.rb
48
66
  - test/benchmark.rb
49
- - test/template_test.rb
50
- - test/results/eval_suppressed.xhtml
51
- - test/results/silent_script.xhtml
52
- - test/results/whitespace_handling.xhtml
53
- - test/results/very_basic.xhtml
54
- - test/results/original_engine.xhtml
55
- - test/results/list.xhtml
56
- - test/results/just_stuff.xhtml
57
- - test/results/content_for_layout.xhtml
58
- - test/results/tag_parsing.xhtml
59
- - test/results/helpful.xhtml
60
- - test/results/partials.xhtml
61
- - test/results/standard.xhtml
62
- - test/results/helpers.xhtml
63
- - test/rhtml/standard.rhtml
64
- - test/mocks/article.rb
65
- - test/templates/whitespace_handling.haml
66
- - test/templates/eval_suppressed.haml
67
- - test/templates/standard.haml
68
- - test/templates/helpful.haml
69
- - test/templates/helpers.haml
70
- - test/templates/silent_script.haml
71
- - test/templates/partialize.haml
72
- - test/templates/_text_area.haml
73
- - test/templates/list.haml
74
- - test/templates/content_for_layout.haml
75
- - test/templates/partials.haml
76
- - test/templates/very_basic.haml
77
- - test/templates/original_engine.haml
78
- - test/templates/_partial.haml
79
- - test/templates/just_stuff.haml
80
- - test/templates/tag_parsing.haml
67
+ - test/haml/results
68
+ - test/haml/rhtml
69
+ - test/haml/mocks
70
+ - test/haml/templates
71
+ - test/haml/helper_test.rb
72
+ - test/haml/engine_test.rb
73
+ - test/haml/runner.rb
74
+ - test/haml/template_test.rb
75
+ - test/haml/results/whitespace_handling.xhtml
76
+ - test/haml/results/eval_suppressed.xhtml
77
+ - test/haml/results/very_basic.xhtml
78
+ - test/haml/results/original_engine.xhtml
79
+ - test/haml/results/list.xhtml
80
+ - test/haml/results/just_stuff.xhtml
81
+ - test/haml/results/content_for_layout.xhtml
82
+ - test/haml/results/tag_parsing.xhtml
83
+ - test/haml/results/helpful.xhtml
84
+ - test/haml/results/partials.xhtml
85
+ - test/haml/results/standard.xhtml
86
+ - test/haml/results/silent_script.xhtml
87
+ - test/haml/results/helpers.xhtml
88
+ - test/haml/results/filters.xhtml
89
+ - test/haml/rhtml/standard.rhtml
90
+ - test/haml/mocks/article.rb
91
+ - test/haml/templates/standard.haml
92
+ - test/haml/templates/helpful.haml
93
+ - test/haml/templates/whitespace_handling.haml
94
+ - test/haml/templates/helpers.haml
95
+ - test/haml/templates/partialize.haml
96
+ - test/haml/templates/eval_suppressed.haml
97
+ - test/haml/templates/list.haml
98
+ - test/haml/templates/_text_area.haml
99
+ - test/haml/templates/content_for_layout.haml
100
+ - test/haml/templates/partials.haml
101
+ - test/haml/templates/silent_script.haml
102
+ - test/haml/templates/very_basic.haml
103
+ - test/haml/templates/original_engine.haml
104
+ - test/haml/templates/_partial.haml
105
+ - test/haml/templates/just_stuff.haml
106
+ - test/haml/templates/tag_parsing.haml
107
+ - test/haml/templates/filters.haml
108
+ - test/haml/templates/breakage.haml
109
+ - test/sass/tmp
110
+ - test/sass/results
111
+ - test/sass/templates
112
+ - test/sass/plugin_test.rb
113
+ - test/sass/engine_test.rb
114
+ - test/sass/results/constants.css
115
+ - test/sass/results/basic.css
116
+ - test/sass/results/complex.css
117
+ - test/sass/results/expanded.css
118
+ - test/sass/results/nested.css
119
+ - test/sass/results/compact.css
120
+ - test/sass/templates/constants.sass
121
+ - test/sass/templates/complex.sass
122
+ - test/sass/templates/expanded.sass
123
+ - test/sass/templates/bork.sass
124
+ - test/sass/templates/basic.sass
125
+ - test/sass/templates/nested.sass
126
+ - test/sass/templates/compact.sass
81
127
  - Rakefile
82
128
  - init.rb
83
129
  - MIT-LICENSE
84
130
  - VERSION
85
- - REFERENCE
131
+ - README
86
132
  test_files:
87
- - test/helper_test.rb
88
- - test/engine_test.rb
89
- - test/template_test.rb
133
+ - test/haml/helper_test.rb
134
+ - test/haml/engine_test.rb
135
+ - test/haml/template_test.rb
136
+ - test/sass/plugin_test.rb
137
+ - test/sass/engine_test.rb
90
138
  rdoc_options:
91
139
  - --title
92
140
  - Haml
93
141
  - --main
94
- - REFERENCE
142
+ - README
95
143
  - --exclude
96
144
  - lib/haml/buffer.rb
97
145
  - --line-numbers
@@ -99,9 +147,11 @@ rdoc_options:
99
147
  extra_rdoc_files:
100
148
  - MIT-LICENSE
101
149
  - VERSION
102
- - REFERENCE
150
+ - README
103
151
  executables:
104
152
  - haml
153
+ - html2haml
154
+ - sass
105
155
  extensions: []
106
156
 
107
157
  requirements: []
data/REFERENCE DELETED
@@ -1,662 +0,0 @@
1
- = Haml (XHTML Abstraction Markup Language)
2
-
3
- Haml is a markup language
4
- that's used to cleanly and simply describe the XHTML of any web document,
5
- without the use of inline code.
6
- Haml functions as a replacement
7
- for inline page templating systems such as PHP, RHTML, and ASP.
8
- However, Haml avoids the need for explicitly coding XHTML into the template,
9
- because it is actually an abstract description of the XHTML,
10
- with some code to generate dynamic content.
11
-
12
- == Features
13
-
14
- * Whitespace active
15
- * Well-formatted markup
16
- * DRY
17
- * Follows CSS conventions
18
- * Interpolates Ruby code
19
- * Implements Rails templates with the .haml extension
20
-
21
- == Authors
22
-
23
- Haml was originally created by Hampton Catlin (hcatlin).
24
- Help with the Ruby On Rails implementation and much of the documentation
25
- by Jeff Hardy (packagethief).
26
-
27
- Nathan Weizenbaum (Nex3) contributed the buffered-engine code,
28
- along with many other enhancements
29
- (including the silent-line syntax: "-").
30
-
31
- If you use this software, you must pay Hampton a compliment.
32
- Say something nice about it.
33
- Beyond that, the implementation is licensed under the MIT License.
34
- Ok, fine, I guess that means compliments aren't *required*.
35
-
36
- == Formatting
37
-
38
- Haml is sensitive to spacing and indentation;
39
- it uses nesting to convey structure.
40
- When you want an element to have children,
41
- indent the lines below it using two spaces.
42
- Remember, spaces are not the same as tabs.
43
- For example:
44
-
45
- #contact
46
- %h1 Eugene Mumbai
47
- %ul.info
48
- %li.login eugene
49
- %li.email eugene@example.com
50
-
51
- is compiled to:
52
-
53
- <div id='contact'>
54
- <h1>Eugene Mumbai</h1>
55
- <ul class='info'>
56
- <li class='login'>eugene</li>
57
- <li class='email'>eugene@example.com</li>
58
- </ul>
59
- </div>
60
-
61
- == Characters with meaning to Haml
62
-
63
- Various characters, when placed at a certain point in a line,
64
- instruct Haml to render different types of things.
65
-
66
- === XHTML Tags
67
-
68
- These characters render XHTML tags.
69
-
70
- ==== %
71
-
72
-
73
- This element is placed at the beginning of a line.
74
- It's followed immediately by the name of an element,
75
- then optionally by modifiers (see below), a space,
76
- and text to be rendered inside the element.
77
- It creates an element in the form of <tt><element></element></tt>.
78
- For example:
79
-
80
- %one
81
- %two
82
- %three Hey there
83
-
84
- is compiled to:
85
-
86
- <one>
87
- <two>
88
- <three>Hey there</three>
89
- </two>
90
- </one>
91
-
92
- Any string is a valid element name;
93
- Haml will automatically generate opening and closing tags for any element.
94
-
95
- ==== {}
96
-
97
- Brackets represent a Ruby hash
98
- that is used for specifying the attributes of an element.
99
- It is literally evaluated as a Ruby hash,
100
- so logic will work in it and local variables may be used.
101
- Quote characters within the attribute
102
- will be replaced by appropriate escape sequences.
103
- The hash is placed after the tag is defined.
104
- For example:
105
-
106
- %head{ :name => "doc_head" }
107
- %script{ 'type' => "text/" + "javascript",
108
- :src => "javascripts/script_#{2 + 7}" }
109
-
110
- is compiled to:
111
-
112
- <head name="doc_head">
113
- <script src='javascripts/script_9' type='text/javascript'>
114
- </script>
115
- </head>
116
-
117
- ==== []
118
-
119
- Square brackets follow a tag definition and contain a Ruby object
120
- that is used to set the class and id of that tag.
121
- The class is set to the object's class
122
- (transformed to use underlines rather than camel case)
123
- and the id is set to the object's class, followed by its id.
124
- Because the id of an object is normally an obscure implementation detail,
125
- this is most useful for elements that represent instances of Models.
126
- For example:
127
-
128
- # file: app/controllers/users_controller.rb
129
-
130
- def show
131
- @user = CrazyUser.find(15)
132
- end
133
-
134
- # file: app/views/users/show.haml
135
-
136
- %div[@user]
137
- %bar[290]/
138
- Hello!
139
-
140
- is compiled to:
141
-
142
- <div class="crazy_user" id="crazy_user_15">
143
- <bar class="fixnum" id="fixnum_581" />
144
- Hello!
145
- </div>
146
-
147
- This is based off of DHH's SimplyHelpful syntax,
148
- as presented at RailsConf Europe 2006.
149
-
150
- ==== /
151
-
152
- The forward slash character, when placed at the end of a tag definition,
153
- causes the tag to be self-closed.
154
- For example:
155
-
156
- %br/
157
- %meta{'http-equiv' => 'Content-Type', :content => 'text/html'}/
158
-
159
- is compiled to:
160
-
161
- <br />
162
- <meta http-equiv='Content-Type' content='text/html' />
163
-
164
- ==== . and #
165
-
166
- The period and pound sign are borrowed from CSS.
167
- They are used as shortcuts to specify the <tt>class</tt>
168
- and <tt>id</tt> attributes of an element, respectively.
169
- Multiple class names can be specified in a similar way to CSS,
170
- by chaining the class names together with periods.
171
- They are placed immediately after the tag and before an attributes hash.
172
- For example:
173
-
174
- %div#things
175
- %span#rice Chicken Fried
176
- %p.beans{ :food => 'true' } The magical fruit
177
- %h1.class.otherclass#id La La La
178
-
179
- is compiled to:
180
-
181
- <div id='things'>
182
- <span id='rice'>Chicken Fried</span>
183
- <p class='beans' food='true'>The magical fruit</p>
184
- <h1 class='class otherclass' id='id'>La La La</h1>
185
- </div>
186
-
187
- And,
188
-
189
- #content
190
- .articles
191
- .article.title
192
- Doogie Howser Comes Out
193
- .article.date
194
- 2006-11-05
195
- .article.entry
196
- Neil Patrick Harris would like to dispel any rumors that he is straight
197
-
198
- is compiled to:
199
-
200
- <div id="content">
201
- <div class="articles">
202
- <div class="article title">Doogie Howser Comes Out</div>
203
- <div class="article date">2006-11-05</div>
204
- <div class="article entry">
205
- Neil Patrick Harris would like to dispel any rumors that he is straight
206
- </div>
207
- </div>
208
- </div>
209
-
210
- ==== Implicit Div Elements
211
-
212
- Because the div element is used so often, it is the default element.
213
- If you only define a class and/or id using the <tt>.</tt> or <tt>#</tt> syntax,
214
- a div element is automatically used.
215
- For example:
216
-
217
- #collection
218
- .item
219
- .description What a cool item!
220
-
221
- is the same as:
222
-
223
- %div{:id => collection}
224
- %div{:class => 'item'}
225
- %div{:class => 'description'} What a cool item!
226
-
227
- and is compiled to:
228
-
229
- <div id='collection'>
230
- <div class='item'>Broken record album</div>
231
- <div class='description'>What a cool item!</div>
232
- </div>
233
-
234
- ==== = and ~
235
-
236
- <tt>=</tt> and <tt>~</tt> are placed at the end of a tag definition,
237
- after class, id, and attribute declarations.
238
- They're just shortcuts for inserting Ruby code into an element.
239
- They work the same as <tt>=</tt> and <tt>~</tt> without a tag;
240
- see below for documentation of those.
241
- However, if the result is short enough,
242
- it is displayed entirely on one line.
243
- For example:
244
-
245
- %p= "hello"
246
- %h1~ 1 + 2
247
-
248
- is not quite the same as:
249
-
250
- %p
251
- = "hello"
252
- %h1
253
- ~ 1 + 2
254
-
255
- It's compiled to:
256
-
257
- <p>hello</p>
258
- <h1>3</h1>
259
-
260
- === XHTML Helpers
261
-
262
- ==== No Special Character
263
-
264
- If no special character appears at the beginning of a line,
265
- the line is rendered as plain text.
266
- For example:
267
-
268
- %gee
269
- %whiz
270
- Wow this is cool!
271
-
272
- is compiled to:
273
-
274
- <gee>
275
- <whiz>
276
- Wow this is cool!
277
- </whiz>
278
- </gee>
279
-
280
- ==== !!!
281
-
282
- When describing XHTML documents with Haml,
283
- you can have a document type or XML prolog generated automatically
284
- by including the characters <tt>!!!</tt>.
285
- For example:
286
-
287
- !!! XML
288
- !!!
289
- %html
290
- %head
291
- %title Myspace
292
- %body
293
- %h1 I am the international space station
294
- %p Sign my guestbook
295
-
296
- is compiled to:
297
-
298
- <?xml version="1.0" encoding="utf-8" ?>
299
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
300
- <html>
301
- <head>
302
- <title>Myspace</title>
303
- </head>
304
- <body>
305
- <h1>I am the international space station</h1>
306
- <p>Sign my guestbook</p>
307
- </body>
308
- </html>
309
-
310
- You can also specify the version and type of XHTML after the <tt>!!!</tt>.
311
- XHTML 1.0 Strict, Transitional, and Frameset and XHTML 1.1 are supported.
312
- The default version is 1.0 and the default type is Transitional.
313
- For example:
314
-
315
- !!! 1.1
316
-
317
- is compiled to:
318
-
319
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
320
-
321
- and
322
-
323
- !!! Strict
324
-
325
- is compiled to:
326
-
327
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
328
-
329
- If you're not using the UTF-8 characterset for your document,
330
- you can specify which encoding should appear
331
- in the XML prolog in a similar way.
332
- For example:
333
-
334
- !!! XML iso-8859-1
335
-
336
- is compiled to:
337
-
338
- <?xml version="1.0" encoding="iso-8859-1" ?>
339
-
340
- ==== /
341
-
342
- The forward slash character, when placed at the beginning of a line,
343
- wraps all text after it in an HTML comment.
344
- For example:
345
-
346
- %billabong
347
- / This is the billabong element
348
- I like billabongs!
349
-
350
- is compiled to:
351
-
352
- <billabong>
353
- <!-- This is the billabong element -->
354
- I like billabongs!
355
- </billabong>
356
-
357
- The forward slash can also wrap indented sections of code. For example:
358
-
359
- /
360
- %p This doesn't render...
361
- %div
362
- %h1 Because it's commented out!
363
-
364
- is compiled to:
365
-
366
- <!--
367
- <p>This doesn't render...</p>
368
- <div>
369
- <h1>Because it's commented out!</h1>
370
- </div>
371
- -->
372
-
373
- You can also use Internet Explorer conditional comments
374
- (about)[http://www.quirksmode.org/css/condcom.html]
375
- by enclosing the condition in square brackets after the <tt>/</tt>.
376
- For example:
377
-
378
- /[if IE]
379
- %a{ :href => 'http://www.mozilla.com/en-US/firefox/' }
380
- %h1 Get Firefox
381
-
382
- is compiled to:
383
-
384
- <!--[if IE]>
385
- <a href='http://www.mozilla.com/en-US/firefox/'>
386
- <h1>Get Firefox</h1>
387
- </a>
388
- <![endif]-->
389
-
390
- ==== \
391
-
392
- The backslash character escapes the first character of a line,
393
- allowing use of otherwise interpreted characters as plain text.
394
- For example:
395
-
396
- %title
397
- = @title
398
- \- MySite
399
-
400
- is compiled to:
401
-
402
- <title>
403
- MyPage
404
- - MySite
405
- </title>
406
-
407
- ==== |
408
-
409
- The pipe character designates a multiline string.
410
- It's placed at the end of a line
411
- and means that all following lines that end with <tt>|</tt>
412
- will be evaluated as though they were on the same line.
413
- For example:
414
-
415
- %whoo
416
- %hoo I think this might get |
417
- pretty long so I should |
418
- probably make it |
419
- multiline so it doesn't |
420
- look awful. |
421
- %p This is short.
422
-
423
- is compiled to:
424
-
425
- %hoo I think this might get |
426
- pretty long so I should |
427
- probably make it |
428
- multiline so it doesn't |
429
- look awful. |
430
-
431
- === Ruby evaluators
432
-
433
- ==== =
434
-
435
- The equals character is followed by Ruby code,
436
- which is evaluated and the output inserted into the document as plain text.
437
- For example:
438
-
439
- %p
440
- = ['hi', 'there', 'reader!'].join " "
441
- = "yo"
442
-
443
- is compiled to:
444
-
445
- <p>
446
- hi there reader!
447
- yo
448
- </p>
449
-
450
- ==== ~
451
-
452
- The tilde character works the same as the equals character,
453
- but the output is modified in such a way
454
- that newlines in whitespace-sensitive elements work properly.
455
- For example:
456
-
457
- %foo
458
- = "Woah <pre> this is \n</pre> crazy"
459
- %foo2
460
- ~ "Woah <pre> this is \n</pre> crazy"
461
-
462
- is compiled to:
463
-
464
- <foo>
465
- Woah <pre> this is
466
- </pre> crazy
467
- </foo>
468
- <foo2>
469
- Woah <pre> this is &#x000A;</pre> crazy
470
- </foo2>
471
-
472
- If the ~ character isn't followed by text,
473
- it doesn't evaluate Ruby at all.
474
- Instead, an indented section following it will be rendered
475
- in a whitespace-sensitive manner,
476
- using HTML encodings for newlines.
477
- For example:
478
-
479
- For example:
480
-
481
- .house
482
- %pre
483
- ~
484
- /^^^\
485
- |[] []|
486
- |_____|
487
-
488
- is compiled to:
489
-
490
- <div class="house">
491
- <pre>
492
- &#x000A; /^^^\&#x000A;|[] []|&#x000A;|_____|&#x000A;
493
- </pre>
494
- </div>
495
-
496
- ==== -
497
-
498
- The hyphen character makes the text following it into "silent script":
499
- Ruby script that is evaluated, but not output.
500
-
501
- <b>It is not recommended that you use this widely;
502
- almost all processing code and logic should be restricted
503
- to the Controller, the Helper, or partials.</b>
504
-
505
- For example:
506
-
507
- - foo = "hello"
508
- - foo << " there"
509
- - foo << " you!"
510
- %p= foo
511
-
512
- is compiled to:
513
-
514
- <p>
515
- hello there you!
516
- </p>
517
-
518
- ===== Blocks
519
-
520
- Ruby blocks, like XHTML tags, don't need to be explicitly closed in Haml.
521
- Rather, they're automatically closed, based on indentation.
522
- A block begins whenever the indentation is increased
523
- after a silent script command.
524
- It ends when the indentation decreases
525
- (as long as it's not an +else+ clause or something similar).
526
- For example:
527
-
528
- - (42...47).each do |i|
529
- %p= i
530
- %p See, I can count!
531
-
532
- is compiled to:
533
-
534
- <p>
535
- 42
536
- </p>
537
- <p>
538
- 43
539
- </p>
540
- <p>
541
- 44
542
- </p>
543
- <p>
544
- 45
545
- </p>
546
- <p>
547
- 46
548
- </p>
549
-
550
- Another example:
551
-
552
- %p
553
- - case 2
554
- - when 1
555
- = "1!"
556
- - when 2
557
- = "2?"
558
- - when 3
559
- = "3."
560
-
561
- is compiled to:
562
-
563
- <p>
564
- 2?
565
- </p>
566
-
567
- == Using Haml as a Rails plugin
568
-
569
- Write Rails templates with the .haml extension.
570
- For example:
571
-
572
- # file: app/views/movies/teen_wolf.haml
573
-
574
- %html
575
- %head
576
- %title= "Teen Wolf (1985)"
577
- %body
578
- #contents
579
- %h1 "A highschooler discovers that he is a werewolf"
580
- %ul.cast
581
- %li "Scott Howard"
582
- %li "Rupert 'Stiles' Stilinski"
583
- %li "Lisa 'Boof' Marconi"
584
- %li "Lewis"
585
-
586
- is compiled to:
587
-
588
- <html>
589
- <head>
590
- <title>Teen Wolf (1985)</title>
591
- </head>
592
- <body>
593
- <div id='contents'>
594
- <h1>A highschooler discovers that he is a werewolf</h1>
595
- <ul class='cast'>
596
- <li>Scott Howard</li>
597
- <li>Rupert 'Stiles' Stilinski</li>
598
- <li>Lisa 'Boof' Marconi</li>
599
- <li>Lewis</li>
600
- </ul>
601
- </div>
602
- </body>
603
- </html>
604
-
605
- You can access instance variables in Haml templates
606
- the same way you do in ERb templates.
607
- Helper methods are also available in Haml templates.
608
- For example:
609
-
610
- # file: app/controllers/movies_controller.rb
611
-
612
- class MoviesController < ApplicationController
613
- def index
614
- @title = "Teen Wolf"
615
- end
616
- end
617
-
618
- # file: app/views/movies/index.haml
619
-
620
- #content
621
- .title
622
- %h1= @title
623
- = link_to 'Home', home_url
624
-
625
- may be compiled to:
626
-
627
- <div id='content'>
628
- <div class='title'>
629
- <h1>Teen Wolf</h1>
630
- <a href='/'>Home</a>
631
- </div>
632
- </div>
633
-
634
- === Setting Options
635
-
636
- Options can be set by setting the hash <tt>Haml::Template.options</tt>
637
- from <tt>environment.rb</tt>.
638
- Available options are:
639
-
640
- [<tt>:suppress_eval</tt>] Whether or not attribute hashes and Ruby scripts
641
- designated by <tt>=</tt> or <tt>~</tt> should be
642
- evaluated. If this is true, said scripts are
643
- rendered as empty strings. Defaults to false.
644
-
645
- [<tt>:precompiled</tt>] A string containing a precompiled Haml template.
646
- If this is passed, <tt>template</tt> is ignored
647
- and no precompilation is done.
648
-
649
- [<tt>:attr_wrapper</tt>] The character that should wrap element attributes.
650
- This defaults to <tt>'</tt> (an apostrophe). Characters
651
- of this type within the attributes will be escaped
652
- (e.g. by replacing them with <tt>&apos;</tt>) if
653
- the character is an apostrophe or a quotation mark.
654
-
655
- [<tt>:locals</tt>] The local variables that will be available within the
656
- template. For instance, if <tt>:locals</tt> is
657
- <tt>{ :foo => "bar" }</tt>, then within the template,
658
- <tt>= foo</tt> will produce <tt>bar</tt>.
659
-
660
- ---
661
- Copyright (c) 2006 Hampton Catlin
662
- Licensed under the MIT License