From 5f2a5e0bf03030369d75750214ae7e3817f61700 Mon Sep 17 00:00:00 2001
From: Winston
Date: Fri, 1 Jul 2011 17:52:17 +0800
Subject: [PATCH] Last pass at updating of all docs! Woo!
---
README.rdoc | 18 ++++++++++-----
app/controllers/docs_controller.rb | 4 ++--
app/views/application/index.html.erb | 22 ++++++++++++++++---
app/views/docs/_constructor.html.erb | 2 +-
app/views/docs/_methods.html.erb | 6 ++---
app/views/docs/formatters.html.erb | 2 +-
app/views/examples/image/spark_line.html.erb | 2 +-
.../examples/interactive/geo_chart.html.erb | 4 ++--
.../interactive/intensity_map.html.erb | 2 +-
.../examples/interactive/line_chart.html.erb | 2 +-
.../interactive/motion_chart.html.erb | 2 +-
.../examples/interactive/org_chart.html.erb | 2 +-
.../examples/interactive/pie_chart.html.erb | 2 +-
.../interactive/scatter_chart.html.erb | 2 +-
14 files changed, 47 insertions(+), 25 deletions(-)
diff --git a/README.rdoc b/README.rdoc
index b0c520f..3897724 100644
--- a/README.rdoc
+++ b/README.rdoc
@@ -1,21 +1,27 @@
= Overview
-This is the GoogleVisualr reference site, written in Rails.
+This is the GoogleVisualr API Reference site, written in Rails 3.
To view this site:
* Visit {http://googlevisualr.heroku.com}[http://googlevisualr.heroku.com]
-* Clone this repository, and run this site locally with script/server
+* Clone this repository, and run this site locally with rails s
= Resources
-* {Google Visualization API}[http://code.google.com/apis/visualization/documentation/]
-* {GoogleVisualr Source}[http://github.com/winston/google_visualr]
+* {Google Chart Tools}[http://code.google.com/apis/chart/index.html]
+* {GoogleVisualr Source}[https://github.com/winston/google_visualr]
+
+= Contributing
+
+Do you think you can write better documentation? Then help me improve this GoogleVisualr API Reference site!
+
+I welcome all pull requests for new or improved examples, or language fixes. Thanks in advance!
= Author
-GoogleVisualr is maintained by {Winston Teo}[mailto:winstonyw+googlevisualr@gmail.com], and his Ninja Penguin.
+GoogleVisualr is maintained by {Winston Teo}[mailto:winstonyw+googlevisualr@gmail.com].
-Who is Winston Teo? Find out more on {WinstonYW}[http://www.winstonyw.com], {LinkedIn}[http://sg.linkedin.com/in/winstonyw], or {follow Winston on Twitter}[http://www.twitter.com/winstonyw].
+Who is Winston Teo? {You should follow Winston on Twitter}[http://www.twitter.com/winstonyw] or find out more on {WinstonYW}[http://www.winstonyw.com] and {LinkedIn}[http://sg.linkedin.com/in/winstonyw].
= License
diff --git a/app/controllers/docs_controller.rb b/app/controllers/docs_controller.rb
index c930dbb..7e67822 100644
--- a/app/controllers/docs_controller.rb
+++ b/app/controllers/docs_controller.rb
@@ -2,7 +2,7 @@ class DocsController < ApplicationController
layout "default"
- # http://code.google.com/apis/visualization/documentation/reference.html
+ # http://code.google.com/apis/chart/interactive/docs/reference.html
def index
##############################
@@ -23,7 +23,7 @@ def index
end
- # http://code.google.com/apis/visualization/documentation/reference.html#formatters
+ # http://code.google.com/apis/chart/interactive/docs/reference.html#formatters
def formatters
##############################
diff --git a/app/views/application/index.html.erb b/app/views/application/index.html.erb
index eac6e50..3a20754 100644
--- a/app/views/application/index.html.erb
+++ b/app/views/application/index.html.erb
@@ -121,16 +121,32 @@
Contribution and Support
- The source of GoogleVisualr is available on <%= link_to "GitHub", "http://github.com/winston/google_visualr/" %>. Please feel free to clone/fork the project, and improve it further!
+ The source of GoogleVisualr is available on <%= link_to "GitHub", "https://github.com/winston/google_visualr/" %>. Please feel free to fork the project, make improvements or bug fixes and submit pull requests.
+ Ideally, all pull requests should also come with tests!
- Please submit all feedback, bugs and feature-requests to <%= link_to "GitHub Issues Tracker", "http://github.com/winston/google_visualr/issues" %>.
+ Please submit all feedback, bugs and feature-requests to <%= link_to "GitHub Issues Tracker", "https://github.com/winston/google_visualr/issues" %>.
+
+
+
+
+
+
+
Sidenote
+
+ This GoogleVisualr API Reference site is also available on <%= link_to "GitHub", "https://github.com/winston/google_visualr_app" %>.
+ Do you think you can write better documentation? Then help me improve this site!
+
+
+ I welcome all pull requests for new or improved examples, and even language fixes. Thanks in advance!
diff --git a/app/views/docs/_constructor.html.erb b/app/views/docs/_constructor.html.erb
index ffa9530..1f23f35 100644
--- a/app/views/docs/_constructor.html.erb
+++ b/app/views/docs/_constructor.html.erb
@@ -57,7 +57,7 @@
- label [Optional] A string value that some visualizations display for this column. Example: label:'Height'
+ label [Optional] A string value that some charts display for this column. Example: label:'Height'
id [Optional] A unique (basic alphanumeric) string ID of the column. Be careful not to choose a JavaScript keyword. Example: id:'col_1'
diff --git a/app/views/docs/_methods.html.erb b/app/views/docs/_methods.html.erb
index 6f67fda..6219a9f 100644
--- a/app/views/docs/_methods.html.erb
+++ b/app/views/docs/_methods.html.erb
@@ -178,7 +178,7 @@
format(formatter [, formatter]*)
- Applies one or more formatters to the visualization to format the columns as specified by the formatter/s.
+ Applies one or more formatters to the data_table to format the columns as specified by the formatter/s.
Parameters
@@ -221,12 +221,12 @@
to_js(div_id)
- Generates JavaScript and renders the visualization in the final HTML output.
+ Generates JavaScript and renders the Google chart in the final HTML output.
Parameters
-
- div_id [Required] The ID of the DIV element that the visualization should be rendered in.
+ div_id [Required] The ID of the DIV element that the Google chart should be rendered in.
diff --git a/app/views/docs/formatters.html.erb b/app/views/docs/formatters.html.erb
index c52cbff..03052b0 100644
--- a/app/views/docs/formatters.html.erb
+++ b/app/views/docs/formatters.html.erb
@@ -25,7 +25,7 @@
- # Initialize and Set Width
+ # Initialize with Width Option
formatter = GoogleVisualr::BarFormat.new( { :width => 150 } )
diff --git a/app/views/examples/image/spark_line.html.erb b/app/views/examples/image/spark_line.html.erb
index d5c344d..6428f91 100644
--- a/app/views/examples/image/spark_line.html.erb
+++ b/app/views/examples/image/spark_line.html.erb
@@ -26,7 +26,7 @@
- In your view, use the to_js method to generate <%= link_to "JavaScript", "http://code.google.com/apis/chart/interactive/docs/gallery/image_spark_line.html#Example" %>, during rendering of the view.
+ In your view, use the to_js method to generate <%= link_to "JavaScript", "http://code.google.com/apis/chart/interactive/docs/gallery/imagesparkline.html#Example" %>, during rendering of the view.
diff --git a/app/views/examples/interactive/geo_chart.html.erb b/app/views/examples/interactive/geo_chart.html.erb
index de74ff6..2d9b8ba 100644
--- a/app/views/examples/interactive/geo_chart.html.erb
+++ b/app/views/examples/interactive/geo_chart.html.erb
@@ -9,7 +9,7 @@
Values are displayed as a color scale, and you can specify optional hover text for regions.
- Please refer to <%= link_to "Google's documentation", "http://code.google.com/apis/chart/interactive/docs/gallery/geo_chart.html" %> for details on Data Format and Configuration Options. However, Methods and Events are not implemented.
+ Please refer to <%= link_to "Google's documentation", "http://code.google.com/apis/chart/interactive/docs/gallery/geochart.html" %> for details on Data Format and Configuration Options. However, Methods and Events are not implemented.
@@ -29,7 +29,7 @@
- In your view, use the to_js method to generate <%= link_to "JavaScript", "http://code.google.com/apis/chart/interactive/docs/gallery/gauge.html#Example" %>, during rendering of the view.
+ In your view, use the to_js method to generate <%= link_to "JavaScript", "http://code.google.com/apis/chart/interactive/docs/gallery/geochart.html#Example" %>, during rendering of the view.
diff --git a/app/views/examples/interactive/intensity_map.html.erb b/app/views/examples/interactive/intensity_map.html.erb
index f48bfaa..54b4ecc 100644
--- a/app/views/examples/interactive/intensity_map.html.erb
+++ b/app/views/examples/interactive/intensity_map.html.erb
@@ -26,7 +26,7 @@
- In your view, use the to_js method to generate <%= link_to "JavaScript", "http://code.google.com/apis/chart/interactive/docs/gallery/intensity_map.html#Example" %>, during rendering of the view.
+ In your view, use the to_js method to generate <%= link_to "JavaScript", "http://code.google.com/apis/chart/interactive/docs/gallery/intensitymap.html#Example" %>, during rendering of the view.
diff --git a/app/views/examples/interactive/line_chart.html.erb b/app/views/examples/interactive/line_chart.html.erb
index caa20d4..c778c81 100644
--- a/app/views/examples/interactive/line_chart.html.erb
+++ b/app/views/examples/interactive/line_chart.html.erb
@@ -26,7 +26,7 @@
- In your view, use the to_js method to generate <%= link_to "JavaScript", "http://code.google.com/apis/chart/interactive/docs/gallery/line_chart.html#Example" %>, during rendering of the view.
+ In your view, use the to_js method to generate <%= link_to "JavaScript", "http://code.google.com/apis/chart/interactive/docs/gallery/linechart.html#Example" %>, during rendering of the view.
diff --git a/app/views/examples/interactive/motion_chart.html.erb b/app/views/examples/interactive/motion_chart.html.erb
index 5c41d98..5b60614 100644
--- a/app/views/examples/interactive/motion_chart.html.erb
+++ b/app/views/examples/interactive/motion_chart.html.erb
@@ -26,7 +26,7 @@
- In your view, use the to_js method to generate <%= link_to "JavaScript", "http://code.google.com/apis/chart/interactive/docs/gallery/motion_chart.html#Example" %>, during rendering of the view.
+ In your view, use the to_js method to generate <%= link_to "JavaScript", "http://code.google.com/apis/chart/interactive/docs/gallery/motionchart.html#Example" %>, during rendering of the view.
diff --git a/app/views/examples/interactive/org_chart.html.erb b/app/views/examples/interactive/org_chart.html.erb
index 7b3eefd..6f1712e 100644
--- a/app/views/examples/interactive/org_chart.html.erb
+++ b/app/views/examples/interactive/org_chart.html.erb
@@ -26,7 +26,7 @@
- In your view, use the to_js method to generate <%= link_to "JavaScript", "http://code.google.com/apis/chart/interactive/docs/gallery/org_chart.html#Example" %>, during rendering of the view.
+ In your view, use the to_js method to generate <%= link_to "JavaScript", "http://code.google.com/apis/chart/interactive/docs/gallery/orgchart.html#Example" %>, during rendering of the view.
diff --git a/app/views/examples/interactive/pie_chart.html.erb b/app/views/examples/interactive/pie_chart.html.erb
index e2c9192..aa7443f 100644
--- a/app/views/examples/interactive/pie_chart.html.erb
+++ b/app/views/examples/interactive/pie_chart.html.erb
@@ -26,7 +26,7 @@
- In your view, use the to_js method to generate <%= link_to "JavaScript", "http://code.google.com/apis/chart/interactive/docs/gallery/pie_chart.html#Example" %>, during rendering of the view.
+ In your view, use the to_js method to generate <%= link_to "JavaScript", "http://code.google.com/apis/chart/interactive/docs/gallery/piechart.html#Example" %>, during rendering of the view.
diff --git a/app/views/examples/interactive/scatter_chart.html.erb b/app/views/examples/interactive/scatter_chart.html.erb
index f6d81df..91097bd 100644
--- a/app/views/examples/interactive/scatter_chart.html.erb
+++ b/app/views/examples/interactive/scatter_chart.html.erb
@@ -26,7 +26,7 @@
- In your view, use the to_js method to generate <%= link_to "JavaScript", "http://code.google.com/apis/chart/interactive/docs/gallery/scatter_chart.html#Example" %>, during rendering of the view.
+ In your view, use the to_js method to generate <%= link_to "JavaScript", "http://code.google.com/apis/chart/interactive/docs/gallery/scatterchart.html#Example" %>, during rendering of the view.