Haml code!
\n" -### Options - -Haml understands various configuration options that affect its performance and -output. - -In Rails, options can be set by setting the {Haml::Template#options Haml::Template.options} -hash in an initializer: - -```ruby -# config/initializers/haml.rb -Haml::Template.options[:format] = :html5 - -# Avoid escaping attributes which are already escaped -Haml::Template.options[:escape_attrs] = :once -``` - -Outside Rails, you can set them by configuring them globally in -Haml::Options.defaults: - -```ruby -Haml::Options.defaults[:format] = :html5 -``` - -In sinatra specifically, you can set them in global config with: -```ruby -set :haml, { escape_html: true } -``` - -Finally, you can also set them by passing an options hash to -{Haml::Engine#initialize}. For the complete list of available options, please -see {Haml::Options}. - -### Encodings - -Haml supports the same sorts of -encoding-declaration comments that Ruby does. Although both Ruby and Haml -support several different styles, the easiest it just to add `-# coding: -encoding-name` at the beginning of the Haml template (it must come before all -other lines). This will tell Haml that the template is encoded using the named -encoding. - -By default, the HTML generated by Haml has the same encoding as the Haml -template. However, if `Encoding.default_internal` is set, Haml will attempt to -use that instead. In addition, the {Haml::Options#encoding `:encoding` option} -can be used to specify an output encoding manually. - -Note that, like Ruby, Haml does not support templates encoded in UTF-16 or -UTF-32, since these encodings are not compatible with ASCII. It is possible to -use these as the output encoding, though. - ## Plain Text A substantial portion of any HTML document is its content, which is plain old @@ -325,49 +257,6 @@ Haml also supports Ruby's new hash syntax: %a{title: @title, href: href} Stuff -#### Attribute Methods - -A Ruby method call that returns a hash can be substituted for the hash contents. -For example, {Haml::Helpers} defines the following method: - - def html_attrs(lang = 'en-US') - {:xmlns => "http://www.w3.org/1999/xhtml", 'xml:lang' => lang, :lang => lang} - end - -This can then be used in Haml, like so: - - %html{html_attrs('fr-fr')} - -This is compiled to: - - - - -You can use as many such attribute methods as you want by separating them with -commas, like a Ruby argument list. All the hashes will be merged together, from -left to right. For example, if you defined - - def hash1 - {:bread => 'white', :filling => 'peanut butter and jelly'} - end - - def hash2 - {:bread => 'whole wheat'} - end - -then - - %sandwich{hash1, hash2, :delicious => 'true'}/ - -would compile to: - -Bar\nBaz" @@ -1154,9 +1043,6 @@ is compiled to
I really prefer raspberry jam.
-Note that `#{}` interpolation within filters is HTML-escaped if you specify true to -{Haml::Options#escape_filter_interpolations `:escape_filter_interpolations`} option. - The functionality of some filters such as Markdown can be provided by many different libraries. Usually you don't have to worry about this - you can just load the gem of your choice and Haml will automatically use it. @@ -1273,42 +1159,6 @@ default. This filter is implemented using Tilt. You can also define your own filters. See {Haml::Filters} for details. -## Helper Methods {#helper-methods} - -Sometimes you need to manipulate whitespace in a more precise fashion than what -the whitespace removal methods allow. There are a few helper methods that are -useful when dealing with inline content. All these methods take a Haml block to -modify. - -### surround {#surround} - -Surrounds a Haml block with text. Expects 1 or 2 string arguments used to -surround the Haml block. If a second argument is not provided, the first -argument is used as the second. - - = surround "(", ")" do - = link_to "learn more", "#" - -### precede {#precede} - -Prepends a Haml block with text. Expects 1 argument. - - = precede "*" do - %span Required - -### succeed {#succeed} - -Appends a Haml block with text. Expects 1 argument. - - Begin by - = succeed "," do - = link_to "filling out your profile", "#" - = succeed "," do - = link_to "adding a bio", "#" - and - = succeed "." do - = link_to "inviting friends", "#" - ## Multiline: `|` {#multiline} The pipe character designates a multiline string. @@ -1367,14 +1217,7 @@ Haml won't try to re-format the indentation. Literal `textarea` and `pre` tags automatically preserve content given through `=`. Dynamically-generated `textarea`s and `pre`s can't be preserved automatically, and so should be passed through -{Haml::Helpers#find\_and\_preserve} or the [`~` command](#tilde), which has the +{Haml::Helpers.preserve} or the [`~` command](#tilde), which has the same effect. Blocks of literal text can be preserved using the [`:preserve` filter](#preserve-filter). - -## Helpers - -Haml offers a bunch of helpers that are useful for doing stuff like preserving -whitespace, creating nicely indented output for user-defined helpers, and other -useful things. The helpers are all documented in the {Haml::Helpers} and -{Haml::Helpers::ActionViewExtensions} modules.