Skip to content

Commit

Permalink
When you cannot do it the right way after a fair amount of time - hack?
Browse files Browse the repository at this point in the history
  • Loading branch information
chalkers committed Feb 26, 2009
1 parent d517fe4 commit 6f39176
Show file tree
Hide file tree
Showing 143 changed files with 12,178 additions and 8 deletions.
3 changes: 0 additions & 3 deletions Rakefile

This file was deleted.

1 change: 0 additions & 1 deletion lib/haml
Submodule haml deleted from fb2943
1 change: 1 addition & 0 deletions lib/haml
138 changes: 138 additions & 0 deletions lib/haml-2.0.7/FAQ
@@ -0,0 +1,138 @@
= Frequently Asked Questions

== Haml

=== How do I put a punctuation mark after an element, like "<tt>I like <strong>cake</strong>!</tt>"?

Expressing the structure of a document
and expressing inline formatting are two very different problems.
Haml is mostly designed for structure,
so the best way to deal with formatting is to leave it to other languages
that are designed for it.
You could use Textile:

%p
:textile
I like *cake*!

or Markdown:

%p
:markdown
I like **cake**!

or plain old XHTML:

%p I like <strong>cake</strong>!

If you're inserting something that's generated by a helper, like a link,
then it's even easier:

%p== I like #{link_to 'chocolate', 'http://franschocolates.com'}!

=== How do I stop Haml from indenting the contents of my +pre+ and +textarea+ tags?

Because Haml automatically indents the HTML source code,
the contents of whitespace-sensitive tags like +pre+ and +textarea+
can get screwed up.
The solution is to replace the newlines inside these tags
with HTML newline entities (<tt>&#x000A;</tt>),
which Haml does using the Haml::Helpers#preserve and Haml::Helpers#find_and_preserve helpers.

Normally, Haml will do this for you automatically
when you're using a tag that needs it
(this can be customized using the <tt>:preserve</tt> option;
see the Options section of the {Haml reference}(../classes/Haml.html)).
For example,

%p
%textarea= "Foo\nBar"

will be compiled to

<p>
<textarea>Foo&#x000A;Bar</textarea>
</p>

However, if a helper is generating the tag,
Haml can't detect that and so you'll have to call +find_and_preserve+ yourself.
You can also use <tt>~</tt>, which is the same as <tt>=</tt>
except that it automatically runs +find_and_preserve+ on its input.
For example:

%p= find_and_preserve "<textarea>Foo\nBar</textarea>"

is the same as

%p~ "<textarea>Foo\nBar</textarea>"

and renders

<p><textarea>Foo&#x000A;Bar</textarea></p>

=== How do I make my long lines of Ruby code look nicer in my Haml document?

Put them in a helper or your model.

Haml purposefully makes it annoying to put lots of Ruby code into your templates,
because lots of code doesn't belong in the view.
If you take that huge +link_to_remote+ call
and move it to a +update_sidebar_link+ helper,
it'll make your view both easier to read and more semantic.

If you absolutely must put lots of code in your template,
Haml offers a somewhat awkward multiline-continuation tool.
Put a <tt>|</tt> (pipe character) at the end of each line you want to be merged into one
(including the last line!).
For example:

%p= @this.is(way.too.much). |
code("and I should"). |
really_move.it.into( |
:a => @helper) |

=== I have Haml installed. Why is Rails (only looking for <tt>.html.erb</tt> files | rendering Haml files as plain text | rendering Haml files as blank pages)?

There are several reasons these things might be happening.
First of all, make sure vendor/plugins/haml really exists
and has an init.rb file in there.
Then try restarting Mongrel or WEBrick or whatever you might be using.

Finally, if none of these work,
chances are you've got some localization plugin like Globalize installed.
Such plugins often don't play nicely with Haml.
Luckily, there's usually an easy fix.
For Globalize, just edit globalize/lib/globalize/rails/action_view.rb
and change

@@re_extension = /\.(rjs|rhtml|rxml)$/

to

@@re_extension = /\.(rjs|rhtml|rxml|erb|builder|haml)$/

For other plugins, a little searching will probably turn up a way to fix them as well.

== Sass

=== Can I use a variable from my controller in my Sass file?

No. Sass files aren't views.
They're compiled once into static CSS files,
then left along until they're changed and need to be compiled again.
Not only don't you want to be running a full request cycle
every time someone requests a stylesheet,
but it's not a great idea to put much logic in there anyway
due to how browsers handle them.

If you really need some sort of dynamic CSS,
the best thing to do is put only the snippet you need to dynamically set
in the +head+ of your HTML document.

== You still haven't answered my question!

Sorry! Try looking at the Haml or Sass references,
in the doucmentation for the haml and Sass modules, respectively.
If you can't find an answer there,
feel free to ask in #haml on irc.freenode.net
or send an email to the {mailing list}[http://groups.google.com/group/haml?hl=en].
20 changes: 20 additions & 0 deletions lib/haml-2.0.7/MIT-LICENSE
@@ -0,0 +1,20 @@
Copyright (c) 2006-2008 Hampton Catlin

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:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

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.

0 comments on commit 6f39176

Please sign in to comment.