Change HAML_REFERENCE to REFERENCE everywhere and clean up changelog.

CHANGELOG.md

@@ -9,23 +9,30 @@
 
 * Add RedCarpet support to Markdown filter.
 
-* Performance improvements (thanks to [Chris Heald](https://github.com/cheald)).
+* Generate object references based on `#to_key` if it exists in preference to
+  `#id`.
 
-* Generate object references based on `#to_key` if it exists in preference to `#id`.
-* Add an {file:HAML_REFERENCE.md#hyphenate_data_attrs-option `:hyphenate_data_attrs` option}
-  that converts underscores to hyphens in your HTML5 data keys (thanks to [Andrew Smith](https://github.com/fullsailor))
+* Performance improvements.
+  (thanks to [Chris Heald](https://github.com/cheald))
+
+* Add an {file:REFERENCE.md#hyphenate_data_attrs-option `:hyphenate_data_attrs`
+  option} that converts underscores to hyphens in your HTML5 data keys. This is
+  a language change from 3.1 and is enabled by default.
+  (thanks to [Andrew Smith](https://github.com/fullsailor))
 
 * Add SCSS filter.
   (thanks to [Matt Wildig](https://github.com/mattwildig))
 
-* Helper `list_of` takes an extra argument that is rendered into list item attributes
+* Helper `list_of` takes an extra argument that is rendered into list item
+  attributes.
   (thanks  [Iain Barnett](http://iainbarnett.me.uk/))
 
-* Fix parser to allow lines ending with `some_method?` to be a Ruby multinline
+* Fix parser to allow lines ending with `some_method?` to be a Ruby multinline.
   (thanks to [Brad Ediger](https://github.com/bradediger))
 
-* Always use :xhtml format when the mime_type of the rendered template is 'text/xml'.
-  (thanks to [Stephen Bannasch](https://github.com/stepheneb)).
+* Always use :xhtml format when the mime_type of the rendered template is
+  'text/xml'.
+  (thanks to [Stephen Bannasch](https://github.com/stepheneb))
 
 
 ## 3.1.5 (Unreleased)

README.md

@@ -88,7 +88,7 @@ output the result. You can even use control statements like `if` and `while`:
         = "Happy new " + "year!"
 
 Haml provides far more tools than those presented here. Check out the [reference
-documentation](http://beta.haml-lang.com/docs/yardoc/file.HAML_REFERENCE.html)
+documentation](http://beta.haml-lang.com/docs/yardoc/file.REFERENCE.html)
 for full details.
 
 ### Indentation

lib/haml.rb

@@ -11,7 +11,7 @@ require 'haml/version'
 # * {Haml::Error} is raised when Haml encounters an error.
 # * {Haml::HTML} handles conversion of HTML to Haml.
 #
-# Also see the {file:HAML_REFERENCE.md full Haml reference}.
+# Also see the {file:REFERENCE.md full Haml reference}.
 module Haml
   # Initializes Haml for Rails.
   #

lib/haml/engine.rb

@@ -20,7 +20,7 @@ module Haml
     include Compiler
 
     # The options hash.
-    # See {file:HAML_REFERENCE.md#haml_options the Haml options documentation}.
+    # See {file:REFERENCE.md#haml_options the Haml options documentation}.
     #
     # @return [{Symbol => Object}]
     attr_accessor :options
@@ -55,7 +55,7 @@ module Haml
     # The source code that is evaluated to produce the Haml document.
     #
     # In Ruby 1.9, this is automatically converted to the correct encoding
-    # (see {file:HAML_REFERENCE.md#encoding-option the `:encoding` option}).
+    # (see {file:REFERENCE.md#encoding-option the `:encoding` option}).
     #
     # @return [String]
     def precompiled
@@ -69,13 +69,13 @@ module Haml
     #
     # @param template [String] The Haml template
     # @param options [{Symbol => Object}] An options hash;
-    #   see {file:HAML_REFERENCE.md#haml_options the Haml options documentation}
+    #   see {file: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 = {
         :suppress_eval        => false,
         :attr_wrapper         => "'",
-        # Don't forget to update the docs in doc-src/HAML_REFERENCE.md
+        # Don't forget to update the docs in doc-src/REFERENCE.md
         # if you update these
         :autoclose            => %w[meta img link br hr input area param col base],
         :preserve             => %w[textarea pre code],
@@ -288,7 +288,7 @@ module Haml
     # 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 {file:HAML_REFERENCE.md#haml_options the Haml options documentation}.
+    # See {file:REFERENCE.md#haml_options the Haml options documentation}.
     #
     # @return [{Symbol => Object}] The options hash
     def options_for_buffer

lib/haml/filters.rb

@@ -266,7 +266,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 {file:HAML_REFERENCE.md#suppress_eval-option `:suppress_eval`} option is set to true.
+    # Not available if the {file: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
@@ -325,7 +325,7 @@ END
     end
 
     # Parses the filtered text with ERB.
-    # Not available if the {file:HAML_REFERENCE.md#suppress_eval-option `:suppress_eval`} option is set to true.
+    # Not available if the {file: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

lib/haml/template/options.rb

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