readme.md in refinerycms-page-images-2.1.1 vs readme.md in refinerycms-page-images-3.0.0
- old
+ new
@@ -1,27 +1,31 @@
# Page Images Engine for Refinery CMS
+[](https://travis-ci.org/refinery/refinerycms-page-images)
+
## About
Page Images allows you to relate one or more images to any page in Refinery which makes it really easy for you to create simple image galleries with lightbox style popups on the front end page views.
## Requirements
-* refinerycms >= 2.0.0
+* refinerycms >= 3.0.0
## Features
-* Ability to select one or more images from the image picker and relate them to a page
+* Ability to select one or more images from the image picker and assign them to a page
+* An image can be assigned to more than one page
* Reordering support, simply drag into order
-* Optionally include captions with each image.
+* An image assigned to a page can have a caption.
+* An image's caption can be different for different pages
## Install
-Add this line to your applications `Gemfile`
+Add this line to your application's `Gemfile`
```ruby
-gem 'refinerycms-page-images', '~> 2.0.0'
+gem 'refinerycms-page-images', '~> 3.0.0', github: "refinery/refinerycms-page-images", branch: "master"
```
Next run
```bash
@@ -32,12 +36,14 @@
Now when you start up your Refinery application, edit a page and there should be a new "Images" tab.
# Deploying to Heroku
-In order to properly precompile assets on Heroku, config vars be present in the environment during slug compilation.
+Note: the following information about assets on Heroku might be out of date.
+In order to properly precompile assets on Heroku, config vars must be present in the environment during slug compilation.
+
```bash
heroku labs:enable user-env-compile -a myapp
```
otherwise you may experience the following error:
@@ -46,42 +52,56 @@
Is the server running on host "127.0.0.1" and accepting
TCP/IP connections on port 5432?
```
-["More Details"](https://devcenter.heroku.com/articles/labs-user-env-compile)
+[More Details](https://devcenter.heroku.com/articles/labs-user-env-compile)
## Enable Captions
You can enable captions using an initializer containing the following configuration:
```ruby
+# app/config/initializers/refinery/page-images.rb
Refinery::PageImages.captions = true
```
-By default, captions are WYM editors. Prefer `textarea`s ? Gotcha :
+By default, captions are WYM editors. Prefer `textarea`s? Gotcha :
```ruby
Refinery::PageImages.wysiwyg = false
```
+Note that WYMeditor support requires that you have the extension in your Gemfile:
+
+```ruby
+gem 'refinerycms-wymeditor', '~> 1.0.0'
+```
+
## Usage
`app/views/refinery/pages/show.html.erb`
If you don't have this file then Refinery will be using its default. You can override this with
```bash
rake refinery:override view=refinery/pages/show
```
+If images have been assigned to a page several objects are available for showing on the page. They are
+
+* `@page.images`: A collection of images assigned to the page.
+* `@page.caption_for_image_index(i)` will return the caption (if any) for the i<sup>th</sup> image in @page.images
+* `@page.images_with_captions`: A collection of image_with_caption objects with the attributes image: and caption:
+
```erb
<% content_for :body_content_right do %>
<ul id='gallery'>
<% @page.images.each do |image| %>
<li>
- <%= link_to image_tag(image.thumbnail("200x200#c").url), image.thumbnail("900x600").url %>
+ <%= link_to image_tag(image.thumbnail(geometry: "200x200#c").url),
+ image.thumbnail(geometry: "900x600").url %>
</li>
<% end %>
</ul>
<% end %>
<%= render :partial => "/refinery/content_page" %>
@@ -89,20 +109,58 @@
If you have enabled captions, you can show them like this
```erb
<% content_for :body_content_right do %>
- <ul id='gallery'>
+ <section id='gallery'>
<% @page.images.each_with_index do |image, index| %>
+ <figure>
+ <%= link_to image_tag(image.thumbnail(geometry: "200x200#c").url),
+ image.thumbnail(geometry: "900x600").url %>
+ <figcaption><%=raw @page.caption_for_image_index(index) %></figcaption>
+ </figure>
+ <% end %>
+ </section>
+<% end %>
+<%= render :partial => "/refinery/content_page" %>
+```
+or like this
+```erb
+<% content_for :body_content_right do %>
+ <section id='gallery'>
+ <% @page.images_with_captions.each do |iwc| %>
+ <figure>
+ <%= link_to image_tag(iwc.image.thumbnail(geometry: "200x200#c").url),
+ iwc.image.thumbnail(geometry: "900x600").url %>
+ <figcaption><%=raw iwc.caption %></figcaption>
+ </figure>
+ <% end %>
+ </section>
+<% end %>
+<%= render :partial => "/refinery/content_page" %>
+```
+## Refinerycms-blog support
+
+Contrary to its name, `refinerycms-page-images` also works with `refinerycms-blog` and adds the functionality to link images to blog posts.
+
+If `refinerycms-blog` is installed on your rails app, `refinerycms-page-images` will automatically detect it and perform the adequate initialization. PageImages are assigned to a polymorph "page" object, wich can be a `Refinery::Page` or a `Blog::Post`.
+
+Thus, once installed, you can simply call a blog post's images the same way you'd call them for a page, like this
+
+```erb
+<% @blog_posts.each do |blog_post| %>
+ <ul id='gallery'>
+ <% blog_post.images.each do |image| %>
<li>
- <%= link_to image_tag(image.thumbnail("200x200#c").url), image.thumbnail("900x600").url %>
- <span class='caption'><%=raw @page.caption_for_image_index(index) %></span>
+ <%= link_to image_tag(image.thumbnail(geometry: "200x200#c").url),
+ image.thumbnail(geometry: "900x600").url %>
</li>
<% end %>
</ul>
<% end %>
<%= render :partial => "/refinery/content_page" %>
```
+
## Screenshot
