Move the Haml and Sass references into their own files.

This commit is contained in:
Nathan Weizenbaum 2009-06-18 13:40:57 -07:00
parent 691272b60b
commit 73dd210858
13 changed files with 2125 additions and 2110 deletions

View File

@ -43,7 +43,7 @@ which Haml does using the {Haml::Helpers#preserve} and {Haml::Helpers#find_and_p
Normally, Haml will do this for you automatically
when you're using a tag that needs it
(this can be customized using the [`:preserve`](Haml.html#preserve-option) option.
(this can be customized using the {file:HAML_REFERENCE.md#preserve-option `:preserve`} option.
For example,
%p

1032
doc-src/HAML_REFERENCE.md Normal file

File diff suppressed because it is too large Load Diff

1064
doc-src/SASS_REFERENCE.md Normal file

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -18,7 +18,7 @@ module Haml
include Precompiler
# The options hash.
# See [the Haml options documentation](../Haml.html#haml_options).
# See {file:HAML_REFERENCE.md#haml_options the Haml options documentation}.
#
# @return [Hash<Symbol, Object>]
attr_accessor :options
@ -59,7 +59,7 @@ module Haml
#
# @param template [String] The Haml template
# @param options [Hash<Symbol, Object>] An options hash;
# see [the Haml options documentation](../Haml.html#haml_options)
# see {file:HAML_REFERENCE.md#haml_options the Haml options documentation}
# @raise [Haml::Error] if there's a Haml syntax error in the template
def initialize(template, options = {})
@options = {
@ -267,7 +267,7 @@ END
# All of the values here are such that when `#inspect` is called on the hash,
# it can be `Kernel#eval`ed to get the same result back.
#
# See [the Haml options documentation](../Haml.html#haml_options).
# See {file:HAML_REFERENCE.md#haml_options the Haml options documentation}.
#
# @return [Hash<Symbol, Object>] The options hash
def options_for_buffer

View File

@ -224,7 +224,7 @@ END
# Parses the filtered text with the normal Ruby interpreter.
# All output sent to `$stdout`, such as with `puts`,
# is output into the Haml document.
# Not available if the [`:suppress_eval`](../Haml.html#suppress-eval-option) option is set to true.
# Not available if the {file:HAML_REFERENCE.md#suppress_eval-option `:suppress_eval`} option is set to true.
# The Ruby code is evaluated in the same context as the Haml template.
module Ruby
include Base
@ -272,7 +272,7 @@ END
end
# Parses the filtered text with ERB, like an RHTML template.
# Not available if the [`:suppress_eval`](../Haml.html#suppress-eval-option) option is set to true.
# Not available if the {file:HAML_REFERENCE.md#suppress_eval-option `:suppress_eval`} option is set to true.
# Embedded Ruby code is evaluated in the same context as the Haml template.
module ERB
include Base

View File

@ -7,7 +7,7 @@ module Haml
@options = {}
# The options hash for Haml when used within Rails.
# See [the Haml options documentation](../Haml.html#haml_options).
# See {file:HAML_REFERENCE.md#haml_options the Haml options documentation}.
#
# @return [Hash<Symbol, Object>]
attr_accessor :options

File diff suppressed because it is too large Load Diff

View File

@ -127,7 +127,7 @@ module Sass
# @param template [String] The Sass template.
# @param options [Hash<Symbol, Object>] An options hash;
# see [the Sass options documentation](../Sass.html#sass_options)
# see {file:SASS_REFERENCE.md#sass_options the Sass options documentation}
def initialize(template, options={})
@options = DEFAULT_OPTIONS.merge(options)
@template = template

View File

@ -28,7 +28,7 @@ module Sass
end
# The options hash.
# See [the Sass options documentation](../Sass.html#sass_options).
# See {file:SASS_REFERENCE.md#sass_options the Sass options documentation}.
#
# @return [Hash<Symbol, Object>]
def options

View File

@ -12,7 +12,7 @@ module Sass
#
# @param filename [String] The path to the Sass file
# @param options [Hash<Symbol, Object>] The options hash.
# Only the [`:cache_location`](../Sass.html#cache-option) option is used
# Only the {file:SASS_REFERENCE.md#cache-option `:cache_location`} option is used
# @raise [Sass::SyntaxError] if there's an error in the document
def tree_for(filename, options)
options = Sass::Engine::DEFAULT_OPTIONS.merge(options)

View File

@ -26,13 +26,13 @@ module Sass
attr_reader :checked_for_updates
# An options hash.
# See [the Sass options documentation](../Sass.html#sass_options).
# See {file:SASS_REFERENCE.md#sass_options the Sass options documentation}.
#
# @return [Hash<Symbol, Object>]
attr_reader :options
# Sets the options hash.
# See [the Sass options documentation](../Sass.html#sass_options).
# See {file:SASS_REFERENCE.md#sass_options the Sass options documentation}.
#
# @param value [Hash<Symbol, Object>] The options hash
def options=(value)
@ -51,9 +51,9 @@ module Sass
# Updates out-of-date stylesheets.
#
# Checks each Sass file in [`:template_location`](../Sass.html#template_location-option)
# Checks each Sass file in {file:SASS_REFERENCE.md#template_location-option `:template_location`}
# to see if it's been modified more recently than the corresponding CSS file
# in [`:css_location`](../Sass.html#css_location-option).
# in {file:SASS_REFERENCE.md#css_location-option} `:css_location`}.
# If it has, it updates the CSS file.
def update_stylesheets
return if options[:never_update]

View File

@ -34,7 +34,7 @@ module Sass
attr_writer :filename
# The options hash for the node.
# See [the Sass options documentation](../../Sass.html#sass_options).
# See {file:SASS_REFERENCE.md#sass_options the Sass options documentation}.
#
# @return [Hash<Symbol, Object>]
attr_reader :options
@ -155,7 +155,7 @@ module Sass
rescue Sass::SyntaxError => e; e.add_metadata(filename, line)
end
# The output style. See [the Sass options documentation](../../Sass.html#output_style).
# The output style. See {file:SASS_REFERENCE.md#sass_options the Sass options documentation}.
#
# @return [Symbol]
def style