From 64ee1f0dbb2eabd9162a816271fc2952296c519b Mon Sep 17 00:00:00 2001 From: nex3 Date: Tue, 19 Dec 2006 02:56:49 +0000 Subject: [PATCH] Moving Haml reference stuff to the Haml module and out of README. git-svn-id: svn://hamptoncatlin.com/haml/trunk@233 7063305b-7217-0410-af8c-cdc13e5119b9 --- README | 725 ++++++---------------------------------------------- Rakefile | 2 +- lib/haml.rb | 623 ++++++++++++++++++++++++++++++++++++++++++++ lib/sass.rb | 3 + 4 files changed, 706 insertions(+), 647 deletions(-) diff --git a/README b/README index 7c81a4b3..2206574f 100644 --- a/README +++ b/README @@ -1,662 +1,95 @@ -= Haml (XHTML Abstraction Markup Language) += Haml and Sass -Haml is a markup language -that's used to cleanly and simply describe the XHTML of any web document, -without the use of inline code. -Haml functions as a replacement -for inline page templating systems such as PHP, RHTML, and ASP. -However, Haml avoids the need for explicitly coding XHTML into the template, -because it is actually an abstract description of the XHTML, -with some code to generate dynamic content. +Haml and Sass are templating engines +for the two most common types of documents on the web: +HTML and CSS, respectively. +They are designed to make it both easier and more pleasant +to cose HTML and CSS documents, +by eliminating redundancy, +reflecting the underlying structure that the document represents, +and providing elegant, easily understandable, and powerful syntax. -== Features +== Formatting -* Whitespace active -* Well-formatted markup -* DRY -* Follows CSS conventions -* Interpolates Ruby code -* Implements Rails templates with the .haml extension +=== Haml + +The most basic element of Haml +is a shorthand for creating HTML tags: + + %tagname{ :attr1 => 'value1', :attr2 => 'value2' } Contents + +No end-tag is needed; Haml handles that automatically. +Adding class and id attributes is even easier. +Haml uses the same syntax as the CSS that styles the document: + + %tagname#id.class + +In fact, when you're using the
tag, +it becomes even easier. +Because
is such a common element, +a tag without a name defaults to a div. So + + #foo Hello! + +becomes + +
Hello! + +Haml uses indentation +to bring the individual elements to represent the HTML structure. +A tag's children are indented two spaces more than the parent tag. +Again, a closing tag is automatically added. +For example: + + %ul + %li Salt + %li Pepper + +becomes: + +
    +
  • Salt
    • +
  • Pepper
    • +
+ +You can also put plain text as a child of an element: + + %p + Hello, + World! + +It's even possible to embed Ruby code into Haml documents. +An equals sign, =, will output the result of the code. +A hyphen, -, will run the code but not output the result. +You can even use control statements +like if and while: + + %p + Date/Time: + - now = DateTime.now + %strong= now + - if now > DateTime.parse("December 31, 2006") + = "Happy new " + "year!" + +Haml provides far more tools than those presented here. +Check out the reference documentation in the Haml module. + +=== Sass + +*add docs* == Authors -Haml was originally created by Hampton Catlin (hcatlin). +Haml and Sass are designed by Hampton Catlin (hcatlin). Help with the Ruby On Rails implementation and much of the documentation by Jeff Hardy (packagethief). -Nathan Weizenbaum (Nex3) contributed the buffered-engine code, +Nathan Weizenbaum (Nex3) contributed the buffered-engine code to Haml, along with many other enhancements (including the silent-line syntax: "-"). +He continues to actively work on both Haml and Sass. If you use this software, you must pay Hampton a compliment. Say something nice about it. Beyond that, the implementation is licensed under the MIT License. Ok, fine, I guess that means compliments aren't *required*. - -== Formatting - -Haml is sensitive to spacing and indentation; -it uses nesting to convey structure. -When you want an element to have children, -indent the lines below it using two spaces. -Remember, spaces are not the same as tabs. -For example: - - #contact - %h1 Eugene Mumbai - %ul.info - %li.login eugene - %li.email eugene@example.com - -is compiled to: - -
-

Eugene Mumbai

-
    - - -
-
- -== 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. - -==== % - - -This element 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 of . -For example: - - %one - %two - %three Hey there - -is compiled to: - - - - Hey there - - - -Any string is a valid element name; -Haml will automatically generate opening and closing tags for any element. - -==== {} - -Brackets represent a Ruby hash -that is used for specifying the attributes of an element. -It is literally evaluated as a Ruby hash, -so logic will work in it and local variables may be used. -Quote characters within the attribute -will be replaced by appropriate escape sequences. -The hash is placed after the tag is defined. -For example: - - %head{ :name => "doc_head" } - %script{ 'type' => "text/" + "javascript", - :src => "javascripts/script_#{2 + 7}" } - -is compiled to: - - - - - -==== [] - -Square brackets follow a tag definition and contain a Ruby object -that is used to set the class and id of that tag. -The class is set to the object's class -(transformed to use underlines rather than camel case) -and the id is set to the object's class, followed by its id. -Because the id of an object is normally an obscure implementation detail, -this is most useful for elements that represent instances of Models. -For example: - - # file: app/controllers/users_controller.rb - - def show - @user = CrazyUser.find(15) - end - - # file: app/views/users/show.haml - - %div[@user] - %bar[290]/ - Hello! - -is compiled to: - -
- - Hello! -
- -This is based off of DHH's SimplyHelpful syntax, -as presented at RailsConf Europe 2006. - -==== / - -The forward slash character, when placed at the end of a tag definition, -causes the tag to be self-closed. -For example: - - %br/ - %meta{:http-equiv => 'Content-Type', :content => 'text/html'}/ - -is compiled to: - -
- - -==== . and # - -The period and pound sign are borrowed from CSS. -They are used as shortcuts to specify the class -and id attributes of an element, respectively. -Multiple class names can be specified in a similar way to CSS, -by chaining the class names together with periods. -They are placed immediately after the tag and before an attributes hash. -For example: - - div#things - %span#rice Chicken Fried - %p.beans{ :food => 'true' } The magical fruit - %h1.class.otherclass#id La La La - -is compiled to: - -
- Chicken Fried -

The magical fruit

-

La La La

-
- -And, - - #content - .articles - .article.title - Doogie Howser Comes Out - .article.date - 2006-11-05 - .article.entry - Neil Patrick Harris would like to dispel any rumors that he is straight - -is compiled to: - -
-
-
Doogie Howser Comes Out
-
2006-11-05
-
- Neil Patrick Harris would like to dispel any rumors that he is straight -
-
-
- -==== Implicit Div Elements - -Because the div element is used so often, it is the default element. -If you only define a class and/or id using the . or # syntax, -a div element is automatically used. -For example: - - #collection - .item - .description What a cool item! - -is the same as: - - %div{:id => collection} - %div{:class => 'item'} - %div{:class => 'description'} What a cool item! - -and is compiled to: - -
-
Broken record album
-
What a cool item!
-
- -==== = and ~ - -= and ~ are placed at the end of a tag definition, -after class, id, and attribute declarations. -They're just shortcuts for inserting Ruby code into an element. -They work the same as = and ~ without a tag; -see below for documentation of those. -However, if the result is short enough, -it is displayed entirely on one line. -For example: - - %p= "hello" - %h1~ 1 + 2 - -is not quite the same as: - - %p - = "hello" - %h1 - ~ 1 + 2 - -It's compiled to: - -

hello

-

3

- -=== 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: - - - - Wow this is cool! - - - -==== !!! - -When describing XHTML documents with Haml, -you can have a document type or XML prolog generated automatically -by including the characters !!!. -For example: - - !!! XML - !!! - %html - %head - %title Myspace - %body - %h1 I am the international space station - %p Sign my guestbook - -is compiled to: - - - - - - Myspace - - -

I am the international space station

-

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 characterset 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: - - %billabong - / This is the billabong element - I like billabongs! - -is compiled to: - - - - I like billabongs! - - -The forward slash can also wrap indented sections of code. For example: - - / - %p This doesn't render... - %div - %h1 Because it's commented out! - -is compiled to: - - - -You can also use Internet Explorer conditional comments -(about)[http://www.quirksmode.org/css/condcom.html] -by enclosing the condition in square brackets after the /. -For example: - - /[if IE] - %a{ :href => 'http://www.mozilla.com/en-US/firefox/' } - %h1 Get Firefox - -is compiled to: - - - -==== \ - -The backslash character escapes the first character of a line, -allowing use of otherwise interpreted characters as plain text. -For example: - - %title - = @title - \- MySite - -is compiled to: - - - MyPage - - MySite - - -==== | - -The pipe character designates a multiline string. -It's placed at the end of a line -and means that all following lines that end with | -will be evaluated as though they were on the same line. -For example: - - %whoo - %hoo I think this might get | - pretty long so I should | - probably make it | - multiline so it doesn't | - look awful. | - %p This is short. - -is compiled to: - - %hoo I think this might get | - pretty long so I should | - probably make it | - multiline so it doesn't | - look awful. | - -=== 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 -

- -==== ~ - -The tilde character works the same as the equals character, -but the output is modified in such a way -that newlines in whitespace-sensitive elements work properly. -For example: - - %foo - = "Woah 
  this is   \n
crazy" - %foo2 - ~ "Woah 
  this is   \n
crazy" - -is compiled to: - - - Woah 
  this is
-
crazy - - - Woah 
  this is
crazy - - -If the ~ character isn't followed by text, -it doesn't evaluate Ruby at all. -Instead, an indented section following it will be rendered -in a whitespace-sensitive manner, -using HTML encodings for newlines. -For example: - -For example: - - .house - %pre - ~ - /^^^\ - |[] []| - |_____| - -is compiled to: - -
- 
-      
 /^^^\
|[] []|
|_____|

-
-
- -==== - - -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? -

- -== Using Haml as a Rails plugin - -Write Rails templates with the .haml extension. -For example: - - # file: app/views/movies/teen_wolf.haml - - %html - %head - %title= "Teen Wolf (1985)" - %body - #contents - %h1 "A highschooler discovers that he is a werewolf" - %ul.cast - %li "Scott Howard" - %li "Rupert 'Stiles' Stilinski" - %li "Lisa 'Boof' Marconi" - %li "Lewis" - -is compiled to: - - - - Teen Wolf (1985) - - -
-

A highschooler discovers that he is a werewolf

-
    -
  • Scott Howard
    • -
  • Rupert 'Stiles' Stilinski
    • -
  • Lisa 'Boof' Marconi
    • -
  • Lewis
    • -
-
- - - -You can access instance variables in Haml templates -the same way you do in ERb templates. -Helper methods are also available in Haml templates. -For example: - - # file: app/controllers/movies_controller.rb - - class MoviesController < ApplicationController - def index - @title = "Teen Wolf" - end - end - - # file: app/views/movies/index.haml - - #content - .title - %h1= @title - = link_to 'Home', home_url - -may be compiled to: - -
-
-

Teen Wolf

- Home -
-
- -=== Setting Options - -Options can be set by setting the hash Haml::Template.options -from environment.rb. -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. - -[:precompiled] A string containing a precompiled Haml template. - If this is passed, template is ignored - and no precompilation is done. - -[: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. - -[:locals] The local variables that will be available within the - template. For instance, if :locals is - { :foo => "bar" }, then within the template, - = foo will produce bar. - ---- -Copyright (c) 2006 Hampton Catlin -Licensed under the MIT License diff --git a/Rakefile b/Rakefile index 76552f4b..2637365c 100644 --- a/Rakefile +++ b/Rakefile @@ -94,7 +94,7 @@ unless ARGV[0] == 'benchmark' require 'rake/rdoctask' rdoc_task = Proc.new do |rdoc| - rdoc.title = 'Haml' + rdoc.title = 'Haml/Sass' rdoc.options << '--line-numbers' << '--inline-source' rdoc.rdoc_files.include('README') rdoc.rdoc_files.include('lib/**/*.rb') diff --git a/lib/haml.rb b/lib/haml.rb index 2c5fcf23..b18573f2 100644 --- a/lib/haml.rb +++ b/lib/haml.rb @@ -1,3 +1,626 @@ dir = File.dirname(__FILE__) $LOAD_PATH << dir unless $LOAD_PATH.include?(dir) + +# = Haml (XHTML Abstraction Markup Language) +# +# Haml is a markup language +# that's used to cleanly and simply describe the XHTML of any web document, +# without the use of inline code. +# Haml functions as a replacement +# for inline page templating systems such as PHP, RHTML, and ASP. +# However, Haml avoids the need for explicitly coding XHTML into the template, +# because it is actually an abstract description of the XHTML, +# with some code to generate dynamic content. +# +# == Features +# +# * Whitespace active +# * Well-formatted markup +# * DRY +# * Follows CSS conventions +# * Interpolates Ruby code +# * Implements Rails templates with the .haml extension +# +# +# == 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. +# +# ==== % +# +# +# This element 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 of . +# For example: +# +# %one +# %two +# %three Hey there +# +# is compiled to: +# +# +# +# Hey there +# +# +# +# Any string is a valid element name; +# Haml will automatically generate opening and closing tags for any element. +# +# ==== {} +# +# Brackets represent a Ruby hash +# that is used for specifying the attributes of an element. +# It is literally evaluated as a Ruby hash, +# so logic will work in it and local variables may be used. +# Quote characters within the attribute +# will be replaced by appropriate escape sequences. +# The hash is placed after the tag is defined. +# For example: +# +# %head{ :name => "doc_head" } +# %script{ 'type' => "text/" + "javascript", +# :src => "javascripts/script_#{2 + 7}" } +# +# is compiled to: +# +# +# +# +# +# ==== [] +# +# Square brackets follow a tag definition and contain a Ruby object +# that is used to set the class and id of that tag. +# The class is set to the object's class +# (transformed to use underlines rather than camel case) +# and the id is set to the object's class, followed by its id. +# Because the id of an object is normally an obscure implementation detail, +# this is most useful for elements that represent instances of Models. +# For example: +# +# # file: app/controllers/users_controller.rb +# +# def show +# @user = CrazyUser.find(15) +# end +# +# # file: app/views/users/show.haml +# +# %div[@user] +# %bar[290]/ +# Hello! +# +# is compiled to: +# +#
+# +# Hello! +#
+# +# This is based off of DHH's SimplyHelpful syntax, +# as presented at RailsConf Europe 2006. +# +# ==== / +# +# The forward slash character, when placed at the end of a tag definition, +# causes the tag to be self-closed. +# For example: +# +# %br/ +# %meta{:http-equiv => 'Content-Type', :content => 'text/html'}/ +# +# is compiled to: +# +#
+# +# +# ==== . and # +# +# The period and pound sign are borrowed from CSS. +# They are used as shortcuts to specify the class +# and id attributes of an element, respectively. +# Multiple class names can be specified in a similar way to CSS, +# by chaining the class names together with periods. +# They are placed immediately after the tag and before an attributes hash. +# For example: +# +# div#things +# %span#rice Chicken Fried +# %p.beans{ :food => 'true' } The magical fruit +# %h1.class.otherclass#id La La La +# +# is compiled to: +# +#
+# Chicken Fried +#

The magical fruit

+#

La La La

+#
+# +# And, +# +# #content +# .articles +# .article.title +# Doogie Howser Comes Out +# .article.date +# 2006-11-05 +# .article.entry +# Neil Patrick Harris would like to dispel any rumors that he is straight +# +# is compiled to: +# +#
+#
+#
Doogie Howser Comes Out
+#
2006-11-05
+#
+# Neil Patrick Harris would like to dispel any rumors that he is straight +#
+#
+#
+# +# ==== Implicit Div Elements +# +# Because the div element is used so often, it is the default element. +# If you only define a class and/or id using the . or # syntax, +# a div element is automatically used. +# For example: +# +# #collection +# .item +# .description What a cool item! +# +# is the same as: +# +# %div{:id => collection} +# %div{:class => 'item'} +# %div{:class => 'description'} What a cool item! +# +# and is compiled to: +# +#
+#
Broken record album
+#
What a cool item!
+#
+# +# ==== = and ~ +# +# = and ~ are placed at the end of a tag definition, +# after class, id, and attribute declarations. +# They're just shortcuts for inserting Ruby code into an element. +# They work the same as = and ~ without a tag; +# see below for documentation of those. +# However, if the result is short enough, +# it is displayed entirely on one line. +# For example: +# +# %p= "hello" +# %h1~ 1 + 2 +# +# is not quite the same as: +# +# %p +# = "hello" +# %h1 +# ~ 1 + 2 +# +# It's compiled to: +# +#

hello

+#

3

+# +# === 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: +# +# +# +# Wow this is cool! +# +# +# +# ==== !!! +# +# When describing XHTML documents with Haml, +# you can have a document type or XML prolog generated automatically +# by including the characters !!!. +# For example: +# +# !!! XML +# !!! +# %html +# %head +# %title Myspace +# %body +# %h1 I am the international space station +# %p Sign my guestbook +# +# is compiled to: +# +# +# +# +# +# Myspace +# +# +#

I am the international space station

+#

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 characterset 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: +# +# %billabong +# / This is the billabong element +# I like billabongs! +# +# is compiled to: +# +# +# +# I like billabongs! +# +# +# The forward slash can also wrap indented sections of code. For example: +# +# / +# %p This doesn't render... +# %div +# %h1 Because it's commented out! +# +# is compiled to: +# +# +# +# You can also use Internet Explorer conditional comments +# (about)[http://www.quirksmode.org/css/condcom.html] +# by enclosing the condition in square brackets after the /. +# For example: +# +# /[if IE] +# %a{ :href => 'http://www.mozilla.com/en-US/firefox/' } +# %h1 Get Firefox +# +# is compiled to: +# +# +# +# ==== \ +# +# The backslash character escapes the first character of a line, +# allowing use of otherwise interpreted characters as plain text. +# For example: +# +# %title +# = @title +# \- MySite +# +# is compiled to: +# +# +# MyPage +# - MySite +# +# +# ==== | +# +# The pipe character designates a multiline string. +# It's placed at the end of a line +# and means that all following lines that end with | +# will be evaluated as though they were on the same line. +# For example: +# +# %whoo +# %hoo I think this might get | +# pretty long so I should | +# probably make it | +# multiline so it doesn't | +# look awful. | +# %p This is short. +# +# is compiled to: +# +# %hoo I think this might get | +# pretty long so I should | +# probably make it | +# multiline so it doesn't | +# look awful. | +# +# === 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 +#

+# +# ==== ~ +# +# The tilde character works the same as the equals character, +# but the output is modified in such a way +# that newlines in whitespace-sensitive elements work properly. +# For example: +# +# %foo +# = "Woah 
  this is   \n
crazy" +# %foo2 +# ~ "Woah 
  this is   \n
crazy" +# +# is compiled to: +# +# +# Woah 
  this is
+#
crazy +# +# +# Woah 
  this is
crazy +# +# +# If the ~ character isn't followed by text, +# it doesn't evaluate Ruby at all. +# Instead, an indented section following it will be rendered +# in a whitespace-sensitive manner, +# using HTML encodings for newlines. +# For example: +# +# For example: +# +# .house +# %pre +# ~ +# /^^^\ +# |[] []| +# |_____| +# +# is compiled to: +# +#
+# 
+#       
 /^^^\
|[] []|
|_____|

+#
+#
+# +# ==== - +# +# 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? +#

+# +# == Using Haml as a Rails plugin +# +# Write Rails templates with the .haml extension. +# For example: +# +# # file: app/views/movies/teen_wolf.haml +# +# %html +# %head +# %title= "Teen Wolf (1985)" +# %body +# #contents +# %h1 "A highschooler discovers that he is a werewolf" +# %ul.cast +# %li "Scott Howard" +# %li "Rupert 'Stiles' Stilinski" +# %li "Lisa 'Boof' Marconi" +# %li "Lewis" +# +# is compiled to: +# +# +# +# Teen Wolf (1985) +# +# +#
+#

A highschooler discovers that he is a werewolf

+#
    +#
  • Scott Howard
    • +#
  • Rupert 'Stiles' Stilinski
    • +#
  • Lisa 'Boof' Marconi
    • +#
  • Lewis
    • +#
+#
+# +# +# +# You can access instance variables in Haml templates +# the same way you do in ERb templates. +# Helper methods are also available in Haml templates. +# For example: +# +# # file: app/controllers/movies_controller.rb +# +# class MoviesController < ApplicationController +# def index +# @title = "Teen Wolf" +# end +# end +# +# # file: app/views/movies/index.haml +# +# #content +# .title +# %h1= @title +# = link_to 'Home', home_url +# +# may be compiled to: +# +#
+#
+#

Teen Wolf

+# Home +#
+#
+# +# === Setting Options +# +# Options can be set by setting the hash Haml::Template.options +# from environment.rb. +# 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. +# +# [:precompiled] A string containing a precompiled Haml template. +# If this is passed, template is ignored +# and no precompilation is done. +# +# [: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. +# +# [:locals] The local variables that will be available within the +# template. For instance, if :locals is +# { :foo => "bar" }, then within the template, +# = foo will produce bar. +# +module Haml; end + require 'haml/engine' diff --git a/lib/sass.rb b/lib/sass.rb index f173f4e9..29ca7fe8 100644 --- a/lib/sass.rb +++ b/lib/sass.rb @@ -1,3 +1,6 @@ dir = File.dirname(__FILE__) $LOAD_PATH << dir unless $LOAD_PATH.include?(dir) + +module Sass; end + require 'sass/engine'