Table of Contents - RDoc Documentation
Pages
-
Changelog
- FriendlyId Changelog
- 2.3.4 (2010-03-22)
- 2.3.3 (2010-03-10)
- 2.3.2 (2010-02-14)
- 2.3.1 (2010-02-09)
- 2.3.0 (2010-02-04)
- 2.2.7 (2009-12-16)
- 2.2.6 (2009-12-10)
- 2.2.5 (2009-11-30)
- 2.2.4 (2009-11-12)
- 2.2.3 (2009-11-12)
- 2.2.2 (2009-10-26)
- 2.2.1 (2009-10-23)
- 2.2.0 (2009-10-19)
- 2.1.4 (2009-09-01)
- 2.1.3 (2009-06-03)
- 2.1.2 (2009-05-21)
- 2.1.1 (2009-03-25)
- 2.1.0 (2009-03-25)
- 2.0.4 (2009-02-12)
- 2.0.3 (2009-02-11)
- 2.0.2 (2009-02-09)
- 2.0.1 (2009-01-19)
- 2.0.0 (2009-01-03)
- 1.0 (2008-12-11)
- 2008-10-31
- 2008-10-22
- 2008-10-09
- 0.5 (2008-08-25)
- 2008-07-14
- 2008-06-23
- 2008-06-10
- 2008-05-15
- 2008-05-12
- 2008-04-18
- 2008-03-13
- 2008-02-07
- Contributors
- Gemfile
-
Guide
- FriendlyId Guide
- Overview
- Simple Models
- Slugged Models
- Installation
- As a Gem
- Rails 2.2.x - 2.3.x
- As a Plugin
- Setup
- Configuration
- Features
- FriendlyId Strings
- Replacing Accented Characters
- German Approximations
- Spanish Approximations
- Approximations for Other Languages
- Unicode Slugs
- ASCII Slugs
- Using a Custom Method to Generate the Slug Text
- Using a Custom Method to Process the Slug Text
- Converting non-Western characters to ASCII with Stringex
- Redirecting to the Current Friendly URL
- Non-unique Slugs
- Reserved Words
- Caching the FriendlyId Slug for Better Performance
- Automatic setup
- Using a custom column name
- Scoped Slugs
- Updating a Relation's Scoped Slugs
- Routes for Scoped Models
- FriendlyId Rake Tasks
- Generating New Slugs For the First Time
- Regenerating Slugs
- Deleting Old Slugs
- Hacking FriendlyId
- Some Benchmarks
- LICENSE
- README
- Rakefile
- README
- friendly_id.gemspec
- friendly_id.rake
Classes and Modules
- Array
- Author
- Block
- Book
- City
- Country
- CreateSlugs
- CreateSupportModels
- District
- Event
- FriendlyId
- FriendlyId::ActiveRecord2
- FriendlyId::ActiveRecord2::Configuration
- FriendlyId::ActiveRecord2::DeprecatedSlugMethods
- FriendlyId::ActiveRecord2::Finders
- FriendlyId::ActiveRecord2::Finders::FinderProxy
- FriendlyId::ActiveRecord2::Finders::Multiple
- FriendlyId::ActiveRecord2::SimpleModel
- FriendlyId::ActiveRecord2::SimpleModel::DeprecatedMethods
- FriendlyId::ActiveRecord2::SimpleModel::FinderMethods
- FriendlyId::ActiveRecord2::SimpleModel::MultipleFinder
- FriendlyId::ActiveRecord2::SimpleModel::SimpleFinder
- FriendlyId::ActiveRecord2::SimpleModel::SingleFinder
- FriendlyId::ActiveRecord2::SluggedModel
- FriendlyId::ActiveRecord2::SluggedModel::CachedMultipleFinder
- FriendlyId::ActiveRecord2::SluggedModel::CachedSingleFinder
- FriendlyId::ActiveRecord2::SluggedModel::DeprecatedMethods
- FriendlyId::ActiveRecord2::SluggedModel::FinderMethods
- FriendlyId::ActiveRecord2::SluggedModel::MultipleFinder
- FriendlyId::ActiveRecord2::SluggedModel::SingleFinder
- FriendlyId::ActiveRecord2::SluggedModel::SluggedFinder
- FriendlyId::Base
- FriendlyId::BlankError
- FriendlyId::Configuration
- FriendlyId::Finders
- FriendlyId::Finders::Base
- FriendlyId::Finders::Single
- FriendlyId::ReservedError
- FriendlyId::SlugGenerationError
- FriendlyId::SlugString
- FriendlyId::Slugged
- FriendlyId::Slugged::Model
- FriendlyId::Slugged::Status
- FriendlyId::Status
- FriendlyId::TaskRunner
- FriendlyId::Test
- FriendlyId::Test::ActiveRecord2
- FriendlyId::Test::ActiveRecord2::BasicSluggedModelTest
- FriendlyId::Test::ActiveRecord2::CachedSlugTest
- FriendlyId::Test::ActiveRecord2::Core
- FriendlyId::Test::ActiveRecord2::CustomNormalizerTest
- FriendlyId::Test::ActiveRecord2::CustomTableNameTest
- FriendlyId::Test::ActiveRecord2::DeprecatedTest
- FriendlyId::Test::ActiveRecord2::Simple
- FriendlyId::Test::ActiveRecord2::Simple::BasicTest
- FriendlyId::Test::ActiveRecord2::Simple::SimpleTest
- FriendlyId::Test::ActiveRecord2::Simple::StatusTest
- FriendlyId::Test::ActiveRecord2::Slugged
- FriendlyId::Test::ActiveRecord2::StatusTest
- FriendlyId::Test::ActiveRecord2::StiTest
- FriendlyId::Test::CustomNormalizer
- FriendlyId::Test::FriendlyIdTest
- FriendlyId::Test::Generic
- FriendlyId::Test::ScopedModelTest
- FriendlyId::Test::SlugStringTest
- FriendlyId::Test::SlugTest
- FriendlyId::Test::Slugged
- FriendlyId::Test::SluggedStatus
- FriendlyId::Test::Status
- FriendlyId::Version
- FriendlyIdGenerator
- House
- Novel
- Object
- Person
- Place
- Post
- Question
- Resident
- Slug
- String
- TasksTest
- User
Methods
- ::down — CreateSlugs
- ::down — CreateSupportModels
- ::dump_approximations — FriendlyId::SlugString
- ::friendly? — FriendlyId::Finders::Base
- ::included — FriendlyId::ActiveRecord2::SimpleModel
- ::included — FriendlyId::ActiveRecord2::SluggedModel
- ::new — FriendlyId::Status
- ::new — FriendlyId::Configuration
- ::new — FriendlyId::ActiveRecord2::Finders::Multiple
- ::new — FriendlyId::ActiveRecord2::Finders::FinderProxy
- ::new — FriendlyId::Finders::Base
- ::new — FriendlyId::SlugString
- ::new — FriendlyId::TaskRunner
- ::unfriendly? — FriendlyId::Finders::Base
- ::up — CreateSupportModels
- ::up — CreateSlugs
- #add_options! — FriendlyIdGenerator
- #approximate_ascii! — FriendlyId::SlugString
- #best? — FriendlyId::Status
- #best? — FriendlyId::Slugged::Status
- #best_id — FriendlyId::ActiveRecord2::SimpleModel
- #best_id — FriendlyId::ActiveRecord2::SluggedModel::DeprecatedMethods
- #cache_column — FriendlyId::Test::ActiveRecord2::CachedSlugTest
- #cache_column= — FriendlyId::ActiveRecord2::Configuration
- #cache_column? — FriendlyId::ActiveRecord2::Configuration
- #cache_finders? — FriendlyId::ActiveRecord2::Configuration
- #cached_slug — FriendlyId::Test::ActiveRecord2::CachedSlugTest
- #clean! — FriendlyId::SlugString
- #column — FriendlyId::ActiveRecord2::SluggedModel::CachedMultipleFinder
- #column — FriendlyId::ActiveRecord2::SimpleModel::SimpleFinder
- #column — FriendlyId::ActiveRecord2::SluggedModel::CachedSingleFinder
- #create_method — FriendlyId::Test::Generic
- #create_method — FriendlyId::Test::ActiveRecord2::Core
- #current? — FriendlyId::Slugged::Status
- #current? — Slug
- #custom_cache_column? — FriendlyId::ActiveRecord2::Configuration
- #days= — FriendlyId::TaskRunner
- #delete_all_method — FriendlyId::Test::ActiveRecord2::Core
- #delete_old_slugs — FriendlyId::TaskRunner
- #delete_slugs — FriendlyId::TaskRunner
- #downcase! — FriendlyId::SlugString
- #find — FriendlyId::Finders::Base
- #find — FriendlyId::ActiveRecord2::SimpleModel::SingleFinder
- #find — FriendlyId::ActiveRecord2::SimpleModel::MultipleFinder
- #find — FriendlyId::ActiveRecord2::SluggedModel::SingleFinder
- #find — FriendlyId::ActiveRecord2::SluggedModel::CachedSingleFinder
- #find — FriendlyId::ActiveRecord2::SluggedModel::MultipleFinder
- #find_method — FriendlyId::Test::Generic
- #find_method — FriendlyId::Test::ActiveRecord2::Core
- #find_one — FriendlyId::ActiveRecord2::SluggedModel::FinderMethods
- #find_one — FriendlyId::ActiveRecord2::SimpleModel::FinderMethods
- #find_slug — FriendlyId::ActiveRecord2::SluggedModel
- #find_slug — FriendlyId::Slugged::Model
- #find_some — FriendlyId::ActiveRecord2::SluggedModel::FinderMethods
- #find_some — FriendlyId::ActiveRecord2::SimpleModel::FinderMethods
- #finder_slug — FriendlyId::ActiveRecord2::SluggedModel::DeprecatedMethods
- #found_using_friendly_id? — FriendlyId::ActiveRecord2::SluggedModel::DeprecatedMethods
- #found_using_friendly_id? — FriendlyId::ActiveRecord2::SimpleModel::DeprecatedMethods
- #found_using_numeric_id? — FriendlyId::ActiveRecord2::SluggedModel::DeprecatedMethods
- #found_using_numeric_id? — FriendlyId::ActiveRecord2::SimpleModel::DeprecatedMethods
- #found_using_outdated_friendly_id? — FriendlyId::ActiveRecord2::SluggedModel::DeprecatedMethods
- #friendly? — FriendlyId::Finders::Single
- #friendly? — FriendlyId::Slugged::Status
- #friendly? — FriendlyId::Status
- #friendly_id — FriendlyId::ActiveRecord2::SimpleModel
- #friendly_id — FriendlyId::Slugged::Model
- #friendly_id= — FriendlyId::Slugged::Status
- #friendly_id_config — FriendlyId::Slugged::Model
- #friendly_id_status — FriendlyId::ActiveRecord2::SimpleModel
- #friendly_id_status — FriendlyId::Slugged::Model
- #get_id — Object
- #handle_friendly_result — FriendlyId::ActiveRecord2::SluggedModel::SluggedFinder
- #has_a_slug? — FriendlyId::ActiveRecord2::SluggedModel::DeprecatedMethods
- #has_better_id? — FriendlyId::ActiveRecord2::SimpleModel::DeprecatedMethods
- #has_better_id? — FriendlyId::ActiveRecord2::SluggedModel::DeprecatedMethods
- #has_friendly_id — FriendlyId::Base
- #has_friendly_id — FriendlyId::ActiveRecord2
- #instance — FriendlyId::Test::ActiveRecord2::StatusTest
- #instance — FriendlyId::Test::ActiveRecord2::Slugged
- #instance — FriendlyId::Test::SluggedStatus
- #instance — FriendlyId::Test::ActiveRecord2::Simple::SimpleTest
- #instance — FriendlyId::Test::Generic
- #is_most_recent? — Slug
- #klass — FriendlyId::Test::Generic
- #klass — FriendlyId::Test::SluggedStatus
- #klass — FriendlyId::Test::ActiveRecord2::Simple::SimpleTest
- #klass — FriendlyId::Test::ActiveRecord2::Slugged
- #klass — FriendlyId::Test::ActiveRecord2::DeprecatedTest
- #klass — FriendlyId::Test::ActiveRecord2::CustomTableNameTest
- #klass — FriendlyId::Test::ActiveRecord2::CustomNormalizerTest
- #klass — FriendlyId::Test::ActiveRecord2::StiTest
- #klass — FriendlyId::Test::ActiveRecord2::CachedSlugTest
- #klass — FriendlyId::Test::ActiveRecord2::StatusTest
- #klass= — FriendlyId::TaskRunner
- #make_slugs — FriendlyId::TaskRunner
- #manifest — FriendlyIdGenerator
- #method_missing — FriendlyId::Finders::Base
- #method_missing — FriendlyId::TaskRunner
- #method_missing — FriendlyId::ActiveRecord2::Finders::FinderProxy
- #normalize — FriendlyId::ActiveRecord2::DeprecatedSlugMethods
- #normalize! — FriendlyId::SlugString
- #normalize_for! — FriendlyId::SlugString
- #normalize_friendly_id — Person
- #normalize_friendly_id — FriendlyId::Slugged::Model
- #normalizer= — FriendlyId::Configuration
- #numeric? — FriendlyId::Status
- #other_class — FriendlyId::Test::ActiveRecord2::Slugged
- #other_class — FriendlyId::Test::Generic
- #other_class — FriendlyId::Test::ActiveRecord2::Simple::SimpleTest
- #other_class — FriendlyId::Test::ActiveRecord2::CachedSlugTest
- #outdated? — Slug
- #outdated? — FriendlyId::Slugged::Status
- #parse — FriendlyId::ActiveRecord2::DeprecatedSlugMethods
- #parse_friendly_id — String
- #primary_key — FriendlyId::ActiveRecord2::SimpleModel::SimpleFinder
- #rand — Array
- #reserved= — FriendlyId::Configuration
- #reserved? — FriendlyId::Configuration
- #reserved_error_message — FriendlyId::Configuration
- #reserved_words= — FriendlyId::Configuration
- #save_method — FriendlyId::Test::ActiveRecord2::Core
- #scope_for — FriendlyId::ActiveRecord2::Configuration
- #scopes_over? — FriendlyId::ActiveRecord2::Configuration
- #setup — FriendlyId::Test::Generic
- #setup — FriendlyId::Test::ScopedModelTest
- #should — Object
- #slug — FriendlyId::ActiveRecord2::SluggedModel
- #slug= — FriendlyId::ActiveRecord2::SluggedModel
- #slug? — FriendlyId::Slugged::Model
- #slugs_included? — FriendlyId::ActiveRecord2::SluggedModel::SluggedFinder
- #status — FriendlyId::Test::SluggedStatus
- #status — FriendlyId::Test::ActiveRecord2::Simple::StatusTest
- #strip_diacritics — FriendlyId::ActiveRecord2::DeprecatedSlugMethods
- #strip_diacritics= — FriendlyId::Configuration
- #strip_non_ascii — FriendlyId::ActiveRecord2::DeprecatedSlugMethods
- #teardown — FriendlyId::Test::SlugTest
- #teardown — FriendlyId::Test::ScopedModelTest
- #teardown — TasksTest
- #teardown — FriendlyId::Test::Generic
- #teardown — FriendlyId::Test::ActiveRecord2::Core
- #test — Object
- #to_ascii! — FriendlyId::SlugString
- #to_friendly_id — Slug
- #to_param — FriendlyId::ActiveRecord2::SimpleModel
- #to_param — FriendlyId::ActiveRecord2::SluggedModel
- #truncate! — FriendlyId::SlugString
- #unfriendly? — FriendlyId::Finders::Single
- #upcase! — FriendlyId::SlugString
- #uses_friendly_id? — FriendlyId::Base
- #validate_find_options — FriendlyId::ActiveRecord2::SluggedModel::FinderMethods
- #validate_for! — FriendlyId::SlugString
- #validate_name — Slug
- #validate_uses_slugs — FriendlyId::TaskRunner
- #validation_exceptions — FriendlyId::Test::ActiveRecord2::Core
- #validation_exceptions — FriendlyId::Test::Generic
- #with_dashes! — FriendlyId::SlugString
- #word_chars! — FriendlyId::SlugString