From 91ea5ff009672adbad8587a1a4437d0b02519b0e Mon Sep 17 00:00:00 2001
From: Randy Morgan <randym@reallyenglish.com>
Date: Wed, 25 Apr 2012 20:57:49 +0900
Subject: [PATCH] documentation updates and example dir restructuring.

---
 README.md                                                   | 6 +++---
 .../example_conditional_formatting.rb                       | 0
 examples/{ => conditional_formatting}/getting_barred.rb     | 0
 .../{ => conditional_formatting}/hitting_the_high_notes.rb  | 0
 examples/{ => conditional_formatting}/scaled_colors.rb      | 0
 examples/{ => conditional_formatting}/stop_and_go.rb        | 0
 examples/{ => skydrive}/real_example.rb                     | 0
 lib/axlsx/workbook/worksheet/conditional_formatting_rule.rb | 2 ++
 lib/axlsx/workbook/worksheet/data_bar.rb                    | 2 ++
 lib/axlsx/workbook/worksheet/icon_set.rb                    | 2 ++
 10 files changed, 9 insertions(+), 3 deletions(-)
 rename examples/{ => conditional_formatting}/example_conditional_formatting.rb (100%)
 rename examples/{ => conditional_formatting}/getting_barred.rb (100%)
 rename examples/{ => conditional_formatting}/hitting_the_high_notes.rb (100%)
 rename examples/{ => conditional_formatting}/scaled_colors.rb (100%)
 rename examples/{ => conditional_formatting}/stop_and_go.rb (100%)
 rename examples/{ => skydrive}/real_example.rb (100%)

diff --git a/README.md b/README.md
index 1591d13f..bc2b0454 100644
--- a/README.md
+++ b/README.md
@@ -24,7 +24,7 @@ Axlsx: Office Open XML Spreadsheet Generation
 
 **Rubinius Version**: rubinius 2.0.0dev * lower versions may run, this gem always tests against head.
 
-**Release Date**: April 18th 2012
+**Release Date**: April 25th 2012
 
 Synopsis
 --------
@@ -478,7 +478,7 @@ This gem has 100% test coverage using test/unit. To execute tests for this gem,
    - Conditional Formatting completely implemented.
    - refactoring / documentation for Style#add_style
    - added in label rotation for chart axis labels
-   - bugfix to porperly assign style and type info to cells when only partial information is provided in the types/style option
+   - bugfix to properly assign style and type info to cells when only partial information is provided in the types/style option
 
 - ** April.18.12**: 1.1.1 release
    - bugfix for autowidth calculations across multiple rows
@@ -530,4 +530,4 @@ Please see the {file:CHANGELOG.md} document for past release information.
 ----------
 
 Axlsx &copy; 2011-2012 by [Randy Morgan](mailto:digial.ipseity@gmail.com). Axlsx is
-licensed under the MIT license. Please see the {file:LICENSE} document for more information.
+licensed under the MIT license. Please see the LICENSE document for more information.
diff --git a/examples/example_conditional_formatting.rb b/examples/conditional_formatting/example_conditional_formatting.rb
similarity index 100%
rename from examples/example_conditional_formatting.rb
rename to examples/conditional_formatting/example_conditional_formatting.rb
diff --git a/examples/getting_barred.rb b/examples/conditional_formatting/getting_barred.rb
similarity index 100%
rename from examples/getting_barred.rb
rename to examples/conditional_formatting/getting_barred.rb
diff --git a/examples/hitting_the_high_notes.rb b/examples/conditional_formatting/hitting_the_high_notes.rb
similarity index 100%
rename from examples/hitting_the_high_notes.rb
rename to examples/conditional_formatting/hitting_the_high_notes.rb
diff --git a/examples/scaled_colors.rb b/examples/conditional_formatting/scaled_colors.rb
similarity index 100%
rename from examples/scaled_colors.rb
rename to examples/conditional_formatting/scaled_colors.rb
diff --git a/examples/stop_and_go.rb b/examples/conditional_formatting/stop_and_go.rb
similarity index 100%
rename from examples/stop_and_go.rb
rename to examples/conditional_formatting/stop_and_go.rb
diff --git a/examples/real_example.rb b/examples/skydrive/real_example.rb
similarity index 100%
rename from examples/real_example.rb
rename to examples/skydrive/real_example.rb
diff --git a/lib/axlsx/workbook/worksheet/conditional_formatting_rule.rb b/lib/axlsx/workbook/worksheet/conditional_formatting_rule.rb
index 3e6192e0..3e8c3e1b 100644
--- a/lib/axlsx/workbook/worksheet/conditional_formatting_rule.rb
+++ b/lib/axlsx/workbook/worksheet/conditional_formatting_rule.rb
@@ -7,6 +7,8 @@ module Axlsx
   # @see Worksheet#add_conditional_formatting
   # @see ConditionalFormattingRule#initialize
   class ConditionalFormattingRule
+
+    # instance values that must be serialized as their own elements - e.g. not attributes.
     CHILD_ELEMENTS = [:formula, :color_scale, :data_bar, :icon_set]
 
     # Formula
diff --git a/lib/axlsx/workbook/worksheet/data_bar.rb b/lib/axlsx/workbook/worksheet/data_bar.rb
index 701fba84..c5054876 100644
--- a/lib/axlsx/workbook/worksheet/data_bar.rb
+++ b/lib/axlsx/workbook/worksheet/data_bar.rb
@@ -6,6 +6,8 @@ module Axlsx
   # @see Worksheet#add_conditional_formatting
   # @see ConditionalFormattingRule#initialize
   class DataBar
+
+    # instance values that must be serialized as their own elements - e.g. not attributes.
     CHILD_ELEMENTS = [:value_objects, :color]
 
     # minLength attribute
diff --git a/lib/axlsx/workbook/worksheet/icon_set.rb b/lib/axlsx/workbook/worksheet/icon_set.rb
index 68f217da..534c33c1 100644
--- a/lib/axlsx/workbook/worksheet/icon_set.rb
+++ b/lib/axlsx/workbook/worksheet/icon_set.rb
@@ -6,6 +6,8 @@ module Axlsx
   # @see Worksheet#add_conditional_formatting
   # @see ConditionalFormattingRule#initialize
   class IconSet
+
+    # instance values that must be serialized as their own elements - e.g. not attributes.
     CHILD_ELEMENTS = [:value_objects]
 
     # The icon set to display.