This is the one page help document for Picky.
Search for things using your browser (use ⌘F).
Edit typos directly in the github page of a section using the edit button.
It's All Ruby. You'll never feel powerless. Look at your index data anytime.
Creating an example app to get you up and running fast, Servers or Clients.
Generating them:
More infos on the applications:
How to integrate Picky in:
How data is cut into little pieces for the index and when searching.
How the data is stored and what you can do with Indexes.
Configuring an index:
How does data get into an index?
- Indexing
- Data Source Overview
- Source defined explicitly
- Source responding to #each
- When is the data for indexing loaded?
- Source not explicitly defined
- Methods to add data to an index
How is the data categorized?
- Categories
- Option partial
- Option weight
- Option similarity
- Option qualifier / qualifiers (categorizing)
- Option from
- Option key_format
- Option source
- Option tokenize
How is the data prepared?
Getting at the data:
There are four different store types:
Advanced topics:
How to configure a search interface over an index (or multiple).
What options does a user have when searching?
Advanced topics:
- Boosting (boosting a single category)
- Ignoring categories
- Ignoring combinations of categories
- Keeping only specific combinations of categories
- Ignoring query words that are not found
- Maximum allocations (of tokens to categories)
- Stopping a search early
When you need a slice over a category's data.
- Facets
- Index Facets
- Search Facets (Using a query to filter your index facets)
What a picky search returns.
We include a JavaScript library to make writing snazzy interfaces easier – see the options.
A bit of thanks!