#
# Haml code!
\n" # # == Characters with meaning to Haml # # Various characters, when placed at a certain point in a line, # instruct Haml to render different types of things. # # === XHTML Tags # # These characters render XHTML tags. # # ==== % # # # The percent character is placed at the beginning of a line. # It's followed immediately by the name of an element, # then optionally by modifiers (see below), a space, # and text to be rendered inside the element. # It creates an element in the form ofThe magical fruit
#hello
# # === XHTML Helpers # # ==== No Special Character # # If no special character appears at the beginning of a line, # the line is rendered as plain text. # For example: # # %gee # %whiz # Wow this is cool! # # is compiled to: # #Sign my guestbook
# # # # You can also specify the version and type of XHTML after the !!!. # XHTML 1.0 Strict, Transitional, and Frameset and XHTML 1.1 are supported. # The default version is 1.0 and the default type is Transitional. # For example: # # !!! 1.1 # # is compiled to: # # # # and # # !!! Strict # # is compiled to: # # # # If you're not using the UTF-8 character set for your document, # you can specify which encoding should appear # in the XML prolog in a similar way. # For example: # # !!! XML iso-8859-1 # # is compiled to: # # # # ==== / # # The forward slash character, when placed at the beginning of a line, # wraps all text after it in an HTML comment. # For example: # # %peanutbutterjelly # / This is the peanutbutterjelly element # I like sandwiches! # # is compiled to: # ##
Hello, World
# # # Haml has the following filters defined: # # [plain] Does not parse the filtered text. # This is useful for large blocks of text without HTML tags, # when you don't want lines starting with . or - # to be parsed. # # [ruby] Parses the filtered text with the normal Ruby interpreter. # All output sent to $stdout, like with +puts+, # is output into the Haml document. # Not available if the suppress_eval option is set to true. # # [preserve] Inserts the filtered text into the template with whitespace preserved. # preserved blocks of text aren't indented, # and newlines are replaced with the HTML escape code for newlines, # to preserve nice-looking output. # # [erb] Parses the filtered text with ERB, like an RHTML template. # Not available if the suppress_eval option is set to true. # At the moment, this doesn't support access to variables # defined by Ruby on Rails or Haml code. # # [sass] Parses the filtered text with Sass to produce CSS output. # # [redcloth] Parses the filtered text with RedCloth (http://whytheluckystiff.net/ruby/redcloth), # which uses both Textile and Markdown syntax. # Only works if RedCloth is installed. # # [textile] Parses the filtered text with Textile (http://www.textism.com/tools/textile). # Only works if RedCloth is installed. # # [markdown] Parses the filtered text with Markdown (http://daringfireball.net/projects/markdown). # Only works if RedCloth or BlueCloth (http://www.deveiate.org/projects/BlueCloth) # is installed # (BlueCloth takes precedence if both are installed). # # You can also define your own filters (see Setting Options, below). # # === Ruby evaluators # # ==== = # # The equals character is followed by Ruby code, # which is evaluated and the output inserted into the document as plain text. # For example: # # %p # = ['hi', 'there', 'reader!'].join " " # = "yo" # # is compiled to: # ## hi there reader! # yo #
# # You can also use two equal signs, ==, # along with conventional Ruby string-embedding syntax # to easily embed Ruby code in otherwise static text. # For example: # # %p # == 1 + 1 = #{1 + 1} # # is compiled to: # ## 1 + 1 = 2 #
# # ==== - # # The hyphen character makes the text following it into "silent script": # Ruby script that is evaluated, but not output. # # It is not recommended that you use this widely; # almost all processing code and logic should be restricted # to the Controller, the Helper, or partials. # # For example: # # - foo = "hello" # - foo << " there" # - foo << " you!" # %p= foo # # is compiled to: # ## hello there you! #
# # ===== Blocks # # Ruby blocks, like XHTML tags, don't need to be explicitly closed in Haml. # Rather, they're automatically closed, based on indentation. # A block begins whenever the indentation is increased # after a silent script command. # It ends when the indentation decreases # (as long as it's not an +else+ clause or something similar). # For example: # # - (42...47).each do |i| # %p= i # %p See, I can count! # # is compiled to: # ## 42 #
## 43 #
## 44 #
## 45 #
## 46 #
# # Another example: # # %p # - case 2 # - when 1 # = "1!" # - when 2 # = "2?" # - when 3 # = "3." # # is compiled to: # ## 2? #
# # ==== -# # # The hyphen followed immediately by the pound sign # signifies a silent comment. # Any text following this isn't rendered in the resulting document # at all. # # For example: # # %p foo # -# This is a comment # %p bar # # is compiled to: # #foo
#bar
# # You can also nest text beneath a silent comment. # None of this text will be rendered. # For example: # # %p foo # -# # This won't be displayed # Nor will this # %p bar # # is compiled to: # #foo
#bar
# # == Other Useful Things # # === 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. # # === Haml Options # # Options can be set by setting the hash Haml::Template.options # from environment.rb in Rails, # or by passing an options hash to Haml::Engine. # Available options are: # # [:suppress_eval] Whether or not attribute hashes and Ruby scripts # designated by = or ~ should be # evaluated. If this is true, said scripts are # rendered as empty strings. Defaults to false. # # [:attr_wrapper] The character that should wrap element attributes. # This defaults to ' (an apostrophe). Characters # of this type within the attributes will be escaped # (e.g. by replacing them with ') if # the character is an apostrophe or a quotation mark. # # [:filename] The name of the Haml file being parsed. # This is only used as information when exceptions are raised. # This is automatically assigned when working through ActionView, # so it's really only useful for the user to assign # when dealing with Haml programatically. # # [:filters] A hash of filters that can be applied to Haml code. # The keys are the string names of the filters; # the values are references to the classes of the filters. # User-defined filters should always have lowercase keys, # and should have: # * An +initialize+ method that accepts one parameter, # the text to be filtered. # * A +render+ method that returns the result of the filtering. # # [:autoclose] A list of tag names that should be automatically self-closed # if they have no content. # Defaults to ['meta', 'img', 'link', 'br', 'hr', 'input', 'area']. # module Haml # A string representing the version of Haml VERSION = File.read(File.dirname(__FILE__) + '/../VERSION').strip unless defined?(VERSION) # This method is called by init.rb, # which is run by Rails on startup. # We use it rather than putting stuff straight into init.rb # so we can change the initialization behavior # without modifying the file itself. def self.init_rails(binding) %w[haml/template sass sass/plugin].each(&method(:require)) end end require 'haml/engine'