Skip to content

Commit

Permalink
Last pass at updating of all docs! Woo!
Browse files Browse the repository at this point in the history
  • Loading branch information
winston committed Jul 1, 2011
1 parent 2262e9d commit 5f2a5e0
Show file tree
Hide file tree
Showing 14 changed files with 47 additions and 25 deletions.
18 changes: 12 additions & 6 deletions 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 <em>script/server</em>
* Clone this repository, and run this site locally with <em>rails s</em>

= 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

Expand Down
4 changes: 2 additions & 2 deletions app/controllers/docs_controller.rb
Expand Up @@ -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

##############################
Expand All @@ -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

##############################
Expand Down
22 changes: 19 additions & 3 deletions app/views/application/index.html.erb
Expand Up @@ -121,16 +121,32 @@
</div>

<!--
Support
Contribution and Support
-->
<div id='support' class='append-bottom'>
<hr/>
<h2>Contribution and Support</h2>
<p>
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!
</p>
<p>
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" %>.
</p>
</div>

<!--
Sidenote
-->
<div id='sidenote' class='append-bottom'>
<hr/>
<h2>Sidenote</h2>
<p>
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!
</p>
<p>
I welcome all pull requests for new or improved examples, and even language fixes. Thanks in advance!
</p>
</div>

Expand Down
2 changes: 1 addition & 1 deletion app/views/docs/_constructor.html.erb
Expand Up @@ -57,7 +57,7 @@
</ul>
</li>
<li>
<span class='cem'>label</span> [Optional] A string value that some visualizations display for this column. Example: label:'Height'
<span class='cem'>label</span> [Optional] A string value that some charts display for this column. Example: label:'Height'
</li>
<li>
<span class='cem'>id</span> [Optional] A unique (basic alphanumeric) string ID of the column. Be careful not to choose a JavaScript keyword. Example: id:'col_1'
Expand Down
6 changes: 3 additions & 3 deletions app/views/docs/_methods.html.erb
Expand Up @@ -178,7 +178,7 @@
<hr/>
<h5><span class='cem'>format(formatter [, formatter]*)</span></h5>
<p>
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.
</p>
<h6>Parameters</h6>
<ul>
Expand Down Expand Up @@ -221,12 +221,12 @@
<div class='append-bottom'>
<h5><span class='cem'>to_js(div_id)</span></h5>
<p>
Generates JavaScript and renders the visualization in the final HTML output.
Generates JavaScript and renders the Google chart in the final HTML output.
</p>
<h6>Parameters</h6>
<ul>
<li>
<span class='cem'>div_id</span> [Required] The ID of the DIV element that the visualization should be rendered in.
<span class='cem'>div_id</span> [Required] The ID of the DIV element that the Google chart should be rendered in.
</li>
</ul>
<p>
Expand Down
2 changes: 1 addition & 1 deletion app/views/docs/formatters.html.erb
Expand Up @@ -25,7 +25,7 @@
</p>
<p>
<code>
# Initialize and Set Width
# Initialize with Width Option
<br/>
formatter = GoogleVisualr::BarFormat.new( { :width => 150 } )
</code>
Expand Down
2 changes: 1 addition & 1 deletion app/views/examples/image/spark_line.html.erb
Expand Up @@ -26,7 +26,7 @@
</div>
<div>
<p>
In your view, use the <em>to_js</em> 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 <em>to_js</em> method to generate <%= link_to "JavaScript", "http://code.google.com/apis/chart/interactive/docs/gallery/imagesparkline.html#Example" %>, during rendering of the view.
</p>
<script src="https://gist.github.com/1057941.js?file=view.html.erb"></script>
</div>
Expand Down
4 changes: 2 additions & 2 deletions app/views/examples/interactive/geo_chart.html.erb
Expand Up @@ -9,7 +9,7 @@
Values are displayed as a color scale, and you can specify optional hover text for regions.
</p>
<p>
Please refer to <%= link_to "Google's documentation", "http://code.google.com/apis/chart/interactive/docs/gallery/geo_chart.html" %> for details on <em>Data Format</em> and <em>Configuration Options</em>. However, <em>Methods</em> and <em>Events</em> 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 <em>Data Format</em> and <em>Configuration Options</em>. However, <em>Methods</em> and <em>Events</em> are not implemented.
</p>
</div>
<div class='append-bottom'>
Expand All @@ -29,7 +29,7 @@
</div>
<div>
<p>
In your view, use the <em>to_js</em> 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 <em>to_js</em> method to generate <%= link_to "JavaScript", "http://code.google.com/apis/chart/interactive/docs/gallery/geochart.html#Example" %>, during rendering of the view.
</p>
<script src="https://gist.github.com/1057951.js?file=view.html.erb"></script>
</div>
Expand Down
2 changes: 1 addition & 1 deletion app/views/examples/interactive/intensity_map.html.erb
Expand Up @@ -26,7 +26,7 @@
</div>
<div>
<p>
In your view, use the <em>to_js</em> 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 <em>to_js</em> method to generate <%= link_to "JavaScript", "http://code.google.com/apis/chart/interactive/docs/gallery/intensitymap.html#Example" %>, during rendering of the view.
</p>
<script src="https://gist.github.com/1057954.js?file=view.html.erb"></script>
</div>
Expand Down
2 changes: 1 addition & 1 deletion app/views/examples/interactive/line_chart.html.erb
Expand Up @@ -26,7 +26,7 @@
</div>
<div>
<p>
In your view, use the <em>to_js</em> 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 <em>to_js</em> method to generate <%= link_to "JavaScript", "http://code.google.com/apis/chart/interactive/docs/gallery/linechart.html#Example" %>, during rendering of the view.
</p>
<script src="https://gist.github.com/1057956.js?file=view.html.erb"></script>
</div>
Expand Down
2 changes: 1 addition & 1 deletion app/views/examples/interactive/motion_chart.html.erb
Expand Up @@ -26,7 +26,7 @@
</div>
<div>
<p>
In your view, use the <em>to_js</em> 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 <em>to_js</em> method to generate <%= link_to "JavaScript", "http://code.google.com/apis/chart/interactive/docs/gallery/motionchart.html#Example" %>, during rendering of the view.
</p>
<script src="https://gist.github.com/1057962.js?file=view.html.erb"></script>
</div>
Expand Down
2 changes: 1 addition & 1 deletion app/views/examples/interactive/org_chart.html.erb
Expand Up @@ -26,7 +26,7 @@
</div>
<div>
<p>
In your view, use the <em>to_js</em> 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 <em>to_js</em> method to generate <%= link_to "JavaScript", "http://code.google.com/apis/chart/interactive/docs/gallery/orgchart.html#Example" %>, during rendering of the view.
</p>
<script src="https://gist.github.com/1057966.js?file=view.html.erb"></script>
</div>
Expand Down
2 changes: 1 addition & 1 deletion app/views/examples/interactive/pie_chart.html.erb
Expand Up @@ -26,7 +26,7 @@
</div>
<div>
<p>
In your view, use the <em>to_js</em> 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 <em>to_js</em> method to generate <%= link_to "JavaScript", "http://code.google.com/apis/chart/interactive/docs/gallery/piechart.html#Example" %>, during rendering of the view.
</p>
<script src="https://gist.github.com/1057968.js?file=view.html.erb"></script>
</div>
Expand Down
2 changes: 1 addition & 1 deletion app/views/examples/interactive/scatter_chart.html.erb
Expand Up @@ -26,7 +26,7 @@
</div>
<div>
<p>
In your view, use the <em>to_js</em> 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 <em>to_js</em> method to generate <%= link_to "JavaScript", "http://code.google.com/apis/chart/interactive/docs/gallery/scatterchart.html#Example" %>, during rendering of the view.
</p>
<script src="https://gist.github.com/1057970.js?file=view.html.erb"></script>
</div>
Expand Down

0 comments on commit 5f2a5e0

Please sign in to comment.