/
readme.html
376 lines (324 loc) · 13 KB
/
readme.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
<html>
<head>
<title>Erector - README</title>
<style>body, td, a, p {
font-family: Lucida Grande, Lucida Sans, arial, sans-serif;
font-size: 11pt; }
body {
margin: 0;
padding: 0; }
img {
border: none; }
.clear {
clear: both; }
ul {
list-style-position: inside; }
li {
margin-left: 1.5em;
padding-bottom: .5em; }
li > p {
-webkit-margin-before: 0;
-webkit-margin-after: 0; }
h1 {
/* font-variant: small-caps;*/
border-bottom: 1px solid gray;
/* background: #EEE; */
padding: .25em;
padding-left: 0px;
margin-left: 0px;
text-shadow: #999999 1px 1px 1px; }
h2 {
margin-top: 2em;
background: #FEFEEB;
padding: .25em;
border: 1px solid #cccccc;
text-shadow: #999999 1px 1px 1px; }
pre {
background-color: #f4f4FF;
border: 1px solid gray;
padding: 0.5em 1em;
overflow: auto;
font-family: Inconsolata, Consolas, "Andale Mono", "Lucida Console", "Lucida Sans Typewriter", "DejaVu Sans Mono", "Bitstream Vera Sans Mono", "Liberation Mono", "Nimbus Mono L", Monaco, "Courier New", Courier, monospace; }
pre.sh_html {
background-color: #FFFADE; }
code {
background-color: #F4F4FF;
font-size: 12pt; }
/* cheatsheet */
table.cheatsheet {
border-style: outset;
border-collapse: collapse;
font-size: 10pt; }
table.cheatsheet code {
background-color: #EEEEFF; }
table.cheatsheet i {
font-size: 11pt; }
table.cheatsheet th {
background-color: #EDEDED; }
table.cheatsheet td, table.cheatsheet th {
border-width: 1px;
border-style: solid;
border-color: lightgray;
padding: .5em;
font-size: 10pt; }
table.cheatsheet td {
vertical-align: top; }
.separator {
margin-right: 10px;
font-size: 36pt; }
/* top */
div.top {
background-color: #FEFDCD;
/* background-color: #FDF909;
*/
text-align: bottom;
margin: 0;
padding: 8px 8px 4px; }
div.top .logo {
margin: 2px auto; }
div.top .logo img {
opacity: 0.6; }
/* navbar */
div.navbar {
width: 100%;
margin: 0 0 2px;
padding: 8px 0px 11px;
/* no idea why, but this centers the buttons*/
overflow-vertical: auto;
text-align: left;
background-color: #A3D3D1;
border-top: 1px solid #6881ba;
border-bottom: 1px solid #6881ba; }
div.navbar h3 {
margin-bottom: .25em; }
div.navbar ul {
list-style-type: none;
display: inline;
margin: -1px 0px 0px;
padding: 8px 0px;
list-style-type: none; }
div.navbar li.clickable {
display: inline;
color: #ccdcea;
background-color: #3470a2;
list-style-type: none;
margin: 8px;
padding: 4px 6px;
/* font-variant: small-caps;*/
border: 2px solid #6881ba; }
div.navbar li.clickable a, div.navbar li.clickable a:visited {
text-decoration: none;
/*font-weight: bold;*/
color: white;
margin: 0;
font-size: 10pt; }
div.navbar li.clickable:hover {
background-color: blue;
cursor: pointer;
cursor: hand; }
div.navbar li.clickable.current {
font-weight: bold;
border: 2px solid black;
background-color: #3875D7; }
div.navbar li.clickable.current a {
color: white; }
/* main */
.main {
margin: 0 auto; }
.footer {
font-size: 10pt;
border-top: 1px solid black;
padding: 1em; }
.body {
max-width: 60em;
margin-left: 100px;
margin-right: 100px; }
.body a {
color: #6881BA;
text-decoration: none;
border-bottom: 1px dotted; }
.main h1.title {
margin: 0 200px;
text-align: center; }
/* article */
div.toc {
margin: 1em 0.25em;
display: inline-block;
border: 1px solid black; }
div.toc h2 {
margin: 0; }
div.toc ul, div.toc ol {
padding: 0.25em 1em; }
.promo_wrapper {
float: right; }
div.promo_wrapper {
text-align: center;
margin: 4px;
padding: 4px; }
div.promo {
display: inline-block;
border: 2px solid #6881ba;
text-align: center;
background: white; }
div.promo img {
border: 2px solid black;
margin: 2px; }
div.promo p {
padding: 0.25em 0.5em; }
/* example */
div.example {
position: relative;
border: 2px solid darkblue;
margin: 1em;
padding: .5em; }
div.example .before, div.example .after {
margin: 1em;
text-align: top;
vertical-align: top; }
div.example .before pre, div.example .after pre {
margin: 0;
width: 100%; }
</style>
<script src="js/sh_main.min.js"></script>
<script src="js/sh_lang/sh_ruby.min.js"></script>
<script src="js/sh_lang/sh_html.min.js"></script>
<script src="js/sh_lang/sh_sh.min.js"></script>
<link href="css/sh_style.css" rel="stylesheet" type="text/css" />
</head>
<body onload="sh_highlightDocument();"> <a href="http://github.com/erector/erector"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://a248.e.akamai.net/assets.github.com/img/30f550e0d38ceb6ef5b81500c64d970b7fb0f028/687474703a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f6f72616e67655f6666373630302e706e67" alt="Fork me on GitHub"></a>
<div class="top"> <div class="logo"><a href="index.html"><img src="erector-logo.png" /></a></div>
</div>
<div class="navbar"> <ul class="clickable">
<li class="clickable" onclick="document.location='index.html'"><a href="index.html">Home</a></li>
<li class="clickable" onclick="document.location='userguide.html'"><a href="userguide.html">User Guide</a></li>
<li class="clickable" onclick="document.location='rails.html'"><a href="rails.html">Erector On Rails</a></li>
<li class="clickable" onclick="document.location='faq.html'"><a href="faq.html">FAQ</a></li>
<li class="clickable" onclick="document.location='cheatsheet.html'"><a href="cheatsheet.html">Cheatsheet</a></li>
<li class="clickable" onclick="document.location='rdoc'"><a href="rdoc">RDoc API</a></li>
<li class="clickable" onclick="document.location='developers.html'"><a href="developers.html">For Developers</a></li>
<li class="clickable" onclick="document.location='release_notes.html'"><a href="release_notes.html">Release Notes</a></li>
<li class="clickable" onclick="document.location='community.html'"><a href="community.html">Community</a></li>
</ul>
</div>
<div class="promo_wrapper"> <div class="promo"><img src="images/erector-the-worlds-greatest-toy.jpg" /></div>
</div>
<div class="main"> <div class="body"><ul><li>
<p><a href="http://erector.rubyforge.org">erector.rubyforge.org</a></p>
</li><li>
<p><a href="mailto:erector@googlegroups.com">erector@googlegroups.com</a></p>
</li><li>
<p><a href="http://github.com/erector/erector">github.com/erector/erector</a></p>
</li><li>
<p><a
href="http://www.pivotaltracker.com/projects/482">www.pivotaltracker.com/projects/482</a></p>
</li></ul>
<h2 id="label-DESCRIPTION">DESCRIPTION</h2>
<p>Erector is a Builder-like view framework, inspired by Markaby but
overcoming some of its flaws. In Erector all views are objects, not
template files, which allows the full power of object-oriented programming
(inheritance, modular decomposition, encapsulation) in views. See the rdoc
for the <a href="rdoc/classes/Erector/Widget.html">Erector::Widget</a> class to learn how to make your own widgets, and
visit the project site at <a
href="http://erector.rubyforge.org">erector.rubyforge.org</a> for more
documentation.</p>
<p>No, seriously, we’ve got hella docs at <a
href="http://erector.rubyforge.org">erector.rubyforge.org</a> – go check it
out.</p>
<h2 id="label-SYNOPSIS">SYNOPSIS</h2>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'erector'</span>
<span class="ruby-keyword">class</span> <span class="ruby-constant">Hello</span> <span class="ruby-operator"><</span> <span class="ruby-constant">Erector</span><span class="ruby-operator">::</span><span class="ruby-constant">Widget</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">content</span>
<span class="ruby-identifier">html</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">head</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">title</span> <span class="ruby-string">"Hello"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">body</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">text</span> <span class="ruby-string">"Hello, "</span>
<span class="ruby-identifier">b</span> <span class="ruby-ivar">@target</span>, :<span class="ruby-keyword">class</span> =<span class="ruby-operator">></span> <span class="ruby-string">'big'</span>
<span class="ruby-identifier">text</span> <span class="ruby-string">"!"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-constant">Hello</span>.<span class="ruby-identifier">new</span>(:<span class="ruby-identifier">target</span> =<span class="ruby-operator">></span> <span class="ruby-string">'world'</span>).<span class="ruby-identifier">to_html</span>
=<span class="ruby-operator">></span> <span class="ruby-string">"<html><head><title>Hello</title></head><body>Hello, <b class=\"big\">world</b>!</body></html>"</span>
<span class="ruby-identifier">include</span> <span class="ruby-constant">Erector</span><span class="ruby-operator">::</span><span class="ruby-constant">Mixin</span>
<span class="ruby-identifier">erector</span> { <span class="ruby-identifier">div</span> <span class="ruby-string">"love"</span>, :<span class="ruby-keyword">class</span> =<span class="ruby-operator">></span> <span class="ruby-string">"big"</span> }
=<span class="ruby-operator">></span> <span class="ruby-string">"<div class=\"big\">love</div>"</span>
</pre>
<h2 id="label-REQUIREMENTS">REQUIREMENTS</h2>
<p>The gem depends on rake and treetop, although this is just for using the
command-line tool, so deployed applications won’t need these. The
Rails-dependent code is now separated so you can use Erector cleanly in a
non-Rails app.</p>
<h2 id="label-INSTALL">INSTALL</h2>
<p>To install as a gem:</p>
<ul><li>
<p>sudo gem install erector</p>
</li></ul>
<p>Then add “require ‘erector’” to any files which need erector.</p>
<p>To install as a Rails plugin:</p>
<ul><li>
<p>Copy the erector source to vendor/plugins/erector in your Rails directory.</p>
</li></ul>
<p>When installing this way, erector is automatically available to your Rails
code (no require directive is needed).</p>
<h2 id="label-TESTS">TESTS</h2>
<p>Three spec rake tasks are provided: spec:core (core functionality),
spec:erect (the erector command line tool), and spec:rails (rails
integration).</p>
<p>‘rake spec’ will run the complete set of specs.</p>
<h2 id="label-CREDITS%3A">CREDITS:</h2>
<p>Core Team:</p>
<ul><li>
<p>Alex Chaffee</p>
</li><li>
<p>Brian Takita</p>
</li></ul>
<p>Special Thanks To:</p>
<ul><li>
<p>Abby (Chaffee’s muse & Best friend)</p>
</li><li>
<p>Jim Kingdon</p>
</li><li>
<p>Jeff Dean</p>
</li><li>
<p>John Firebaugh</p>
</li><li>
<p>Nathan Sobo</p>
</li><li>
<p>Nick Kallen</p>
</li><li>
<p>Alon Salant</p>
</li><li>
<p>Andy Peterson</p>
</li></ul>
<h2 id="label-LICENSE%3A">LICENSE:</h2>
<p>(The MIT License)</p>
<p>Copyright © 2007-2010 Pivotal Labs and the Erector Project</p>
<p>Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the “Software”),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:</p>
<p>The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.</p>
<p>THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.</p>
<hr />
<p>Don't forget to read the <a href="userguide.html">User Guide</a> and <a href="faq.html">FAQ</a> and <a href="rdoc">API</a></p>
</div>
<div class="footer"><a href="http://www.pivotallabs.com"><img alt="Pivotal Labs" height="57" src="pivotal.gif" style="float:right; padding: 8px;" width="158" /></a>
<center>Erector is an open source project released under the MIT license.<br />
Its initial development was sponsored by <a href="http://pivotallabs.com">Pivotal Labs</a>.<br />
Not affiliated with or sponsored by the makers of Erector or Meccano toys.</center>
</div>
</div>
</body>
</html>