Skip to content

Commit

Permalink
more line endings
Browse files Browse the repository at this point in the history
  • Loading branch information
cainlevy committed Jul 28, 2013
1 parent 2734100 commit 7d4efaf
Showing 1 changed file with 71 additions and 71 deletions.
142 changes: 71 additions & 71 deletions README
@@ -1,71 +1,71 @@
= Acts as Sluggable readme
Generates a URL slug based on a specific fields (e.g. title).
A url slug is a string derived from a specific field which can the be used in a URL. For instance, a page with the title <tt>My page</tt> would have a URL slug of <tt>my-page</tt>.
The slug is generated on save and create actions. If the field has an existing URL slug (like when editing an existing record) the URL slug is preserved.
URL slugs are unique within the specified scope (or all records if no scope is defined). If the slug already exists within the scope, <tt>-n</tt> is added (e.g. <tt>my-page-0</tt>, <tt>my-page-1</tt>, etc...
== Installation
Add to your Gemfile:
gem 'acts_as_sluggable', :git => 'git@github.com:cainlevy/acts_as_sluggable.git'
== Usage examples
In your target table, add a column to hold the URL slug.
=== With scope
class Page < ActiveRecord::Base
acts_as_sluggable :source_column => :title, :slug_column => :slug, :scope => :parent
end
=== Without scope
class Post < ActiveRecord::Base
acts_as_sluggable :source_column => :title, :slug_column => :slug
end
=== A sample link
link_to @page.title, :action => 'show', :slug => @page.slug
=== Example usage
# app/models/page.rb
class Page
def to_param
slug
end
end
# config/routes.rb
resources :pages
# app/controllers/pages_controller.rb
def index
@page = Page.create(:name => "my page")
end
# app/views/pages/index.html.erb
<%= url_for @page # generates "/pages/my-page" %>
== Testing
The unit tests for this plugin use an in-memory sqlite3 database (http://www.sqlite.org/).
To execute the unit tests run the default rake task (<tt>rake</tt>). To execute the unit tests but preserve to debug log run <tt>rake test</tt>.
== Credits
Created by Alex Dunae (http://dunae.ca/), 2006-07, though it takes a village to raise a plugin:
Thanks to Andrew White (http://pixeltrix.co.uk/) for fixing a conflict with <tt>acts_as_list</tt>.
Thanks to Philip Hallstrom (http://pjkh.com/) for pointing out some redundant code.
= Acts as Sluggable readme

Generates a URL slug based on a specific fields (e.g. title).

A url slug is a string derived from a specific field which can the be used in a URL. For instance, a page with the title <tt>My page</tt> would have a URL slug of <tt>my-page</tt>.

The slug is generated on save and create actions. If the field has an existing URL slug (like when editing an existing record) the URL slug is preserved.

URL slugs are unique within the specified scope (or all records if no scope is defined). If the slug already exists within the scope, <tt>-n</tt> is added (e.g. <tt>my-page-0</tt>, <tt>my-page-1</tt>, etc...


== Installation

Add to your Gemfile:

gem 'acts_as_sluggable', :git => 'git@github.com:cainlevy/acts_as_sluggable.git'


== Usage examples

In your target table, add a column to hold the URL slug.

=== With scope

class Page < ActiveRecord::Base
acts_as_sluggable :source_column => :title, :slug_column => :slug, :scope => :parent
end

=== Without scope

class Post < ActiveRecord::Base
acts_as_sluggable :source_column => :title, :slug_column => :slug
end

=== A sample link

link_to @page.title, :action => 'show', :slug => @page.slug

=== Example usage

# app/models/page.rb
class Page
def to_param
slug
end
end

# config/routes.rb
resources :pages

# app/controllers/pages_controller.rb
def index
@page = Page.create(:name => "my page")
end

# app/views/pages/index.html.erb
<%= url_for @page # generates "/pages/my-page" %>

== Testing

The unit tests for this plugin use an in-memory sqlite3 database (http://www.sqlite.org/).

To execute the unit tests run the default rake task (<tt>rake</tt>). To execute the unit tests but preserve to debug log run <tt>rake test</tt>.

== Credits

Created by Alex Dunae (http://dunae.ca/), 2006-07, though it takes a village to raise a plugin:

Thanks to Andrew White (http://pixeltrix.co.uk/) for fixing a conflict with <tt>acts_as_list</tt>.

Thanks to Philip Hallstrom (http://pjkh.com/) for pointing out some redundant code.

0 comments on commit 7d4efaf

Please sign in to comment.