Welcome to the TrackRecord API documentation

This file is part of a set of automatically built documentation in HTML format. If you are reading it in a text editor, you should instead look at ‘doc/app/index.html’ in your preferred web browser.

If you want to learn more about the TrackRecord internal structure, consider getting an idea of the methods defined in the Application Controller and Application Helper components first. I recommend then looking at the models, so you become familiar with the application’s underlying data structures.

Regenerating the documentation

Run “rake doc:reapp” to regenerate all files. See also the main application README file at the top level.

Charts controller

A Gruff-based charts controller is included to make pie charts (or if extended, other charts) which you might like. It isn’t used “in anger” at present since the charts aren’t really very useful in practice. See partial “shared/_hours” for an example of how to introduce chart images into your views if you want them.

You will need to uncomment the ‘gruff’ and ‘rmagic’ gems in “Gemfile” then run “bundle install” to make any charts. There may be other dependencies too, the most obvious being ImageMagick. Font “PetitaBold.ttf” is kept in the root of the application for graph text; change this by editing the value of “GRAPH_FONT” in file “config/initializers/general_config.rb”.

To fetch an example stand-alone image as a test, visit your site with the following path:

/charts/0?committed=128&duration=168&not_committed=4&width=128