Html snippets shared across pages
Ruby HTML JavaScript Gherkin CSS
Pull request Compare This branch is 82 commits ahead of keram:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
config
db
features
lib
spec
.gitignore
readme.md
refinerycms-snippets.gemspec

readme.md

Snippets engine for Refinery CMS.

About

Snippets allows you to relate one or more html blocks or erb templates to any page in Refinery. These are attached to the page parts, before or after the its html body.

Requirements

  • RefineryCMS with 'Pages' engine (refinerycms-pages = 2.1.0.dev)

TODO

  • improve UI
  • Documentation
  • Tests

Install

Add this line to your applications Gemfile

gem 'refinerycms-sl-snippets', '~> 1.1.0', :require => 'refinerycms-snippets'

Next run

bundle install
rails g refinerycms:snippets
rake db:migrate

Usage

  • Create Snippet on /refinery/snippets
  • Now you can attach snippet to page when you click Edit this page on /refinery/pages. In the Snippets tab you can select the part to which you want to attach the block and add it after and/or before the html body of the part.
  • Next you can initialize a PagePartSectionPresenter with the page part that you would like to render and access its html output:
    • presenter = Refinery::Pages::PagePartSectionPresenter.new(page_part)
    • presenter.wrapped_html
  • You have some other interesting methods to work with snippets:
    • content_or_render_of(snippet): will return the content body (or erb template) of the snippet.
    • page.snippets: returns all the snippets attached to all the parts of page.
    • snippet.pages: returns all pages to whose parts is snippet attached.
    • snippet.before?(part): returns true if snippet is attached before part body.
    • snippet.after?(part): return true if snippet is attached after part body.

ERB templates usage

Snippets search for templates in RAILS_VIEWS_PATH/shared/snippets. The snippet searches for a file with its same name but with all non A-Za-z0-9 characters changed to underscores. If this file exists, snippet html body is ignored and the template is rendered in its place. Methods rendering the template, if exists, in place of the body are content_of(@page, :part) and content_or_render_of(snippet).

For example, a template with title "VIP clients: photos" would search in "app/views/shared/snippets" for a file named "vip_clients_photos.html.erb"; "Country & region banners: España" for "country_region_banners_espa_na" and so on.

Templates are normal erb files. If you want to add complex logic to them I suggest the use of Cells.

Thanks

This is build upon the original refinerycms-snippets from keram: https://github.com/keram/refinerycms-snippets