= Infopark Rails Connector
Infopark Rails Connector allows you to integrate a number of ready-to-run features into your Rails application.
== Configuration
Here is how all available addons would be enabled in the rails_connector.rb initializer file of your application:
RailsConnector::Configuration.enable(
:comments,
:google_analytics,
:infopark_tracking,
:omc,
:pdf_generator,
:ratings,
:rss,
:search,
:seo_sitemap,
:time_machine
)
== Layout Helpers
Some of those functions depend on html or javascript code being included in the application layout.
For example, Google Analytics does only track pageviews if their javascript snippet is included
at the bottom of the html body.
Rails Connector provides two helpers which manage that kind of layout code,
switching on or off parts depending on what features are enabled or not:
rails_connector_header_tags
This helper needs to be called inside the html head tag.
rails_connector_after_content_tags
That helper is to be put right before the closing body tag.
== Generators
Infopark Rails Connector comes with three generators to help you get up and running quickly:
rails generate rails_connector:install
Adds Time machine assets, a +rails_connector.rb+ initializer and rake tasks specific to the gem to your application.
rails generate rails_connector:comments
Specific to the +comments+ feature. Adds a comments migration to your application.
rails generate rails_connector:ratings
Specific to the +ratings+ feature. Adds a ratings migration to your application as well as an example stylesheet and background image.
== Infopark Tracking
If you enable the infopark_tracking, please refer to the OMC documentation for further details,
e.g. Apache logging options.
== Seo Sitemap
The default implementation for the seo sitemap will feature all files from your CMS in the generated sitemap.xml. For a large number of files, this can slow down your server. Please refer to RailsConnector::SEO::ClassMethods#find_all_for_sitemap for advise on optimization.