Skip to content
This repository
Newer
Older
100644 147 lines (96 sloc) 4.802 kb
c763882d »
2012-10-28 + moved the docs into the Picky main repo
1 ## Single Page Help Index
2
d242249e »
2012-11-01 + edit links for all the doc sections
3 {.edit}
4 [edit](http://github.com/floere/picky/blob/master/web/source/documentation/_index.html.md)
5
5e553778 »
2012-10-28 + links on website
6 This is the one page help document for Picky.
7
02f3dd30 »
2012-10-29 + documentation
8 Search for things using your browser (use ⌘F).
c763882d »
2012-10-28 + moved the docs into the Picky main repo
9
e31a3c0d »
2012-10-29 + new style documentation
10 Edit typos directly in the [github page](http://github.com/floere/picky/tree/master/web/source/documentation) of a section using the [edit](http://github.com/floere/picky/blob/master/web/source/documentation/_index.html.md) button.
c763882d »
2012-10-28 + moved the docs into the Picky main repo
11
02f3dd30 »
2012-10-29 + documentation
12 ### Getting started{#index-getting-started}
c763882d »
2012-10-28 + moved the docs into the Picky main repo
13
e31a3c0d »
2012-10-29 + new style documentation
14 It's [All Ruby](#all_ruby). You'll never feel powerless. [Look at your index data](#transparency) anytime.
c763882d »
2012-10-28 + moved the docs into the Picky main repo
15
02f3dd30 »
2012-10-29 + documentation
16 #### Generating an app{#index-generating}
c763882d »
2012-10-28 + moved the docs into the Picky main repo
17
e31a3c0d »
2012-10-29 + new style documentation
18 Creating an [example app](#generators) to get you up and running fast, [Servers](#generators-servers) or [Clients](#generators-clients).
5e553778 »
2012-10-28 + links on website
19
e31a3c0d »
2012-10-29 + new style documentation
20 Generating them:
c763882d »
2012-10-28 + moved the docs into the Picky main repo
21
e31a3c0d »
2012-10-29 + new style documentation
22 * [Sinatra Server](#generators-servers-sinatra) and [Client](#generators-clients-sinatra)
23 * [Sinatra Server+Client in one](#generators-servers-allinone)
02f3dd30 »
2012-10-29 + documentation
24
e31a3c0d »
2012-10-29 + new style documentation
25 More infos on the [applications](#servers):
02f3dd30 »
2012-10-29 + documentation
26
e31a3c0d »
2012-10-29 + new style documentation
27 * [Sinatra](#servers-sinatra)([Routing](#servers-sinatra-routing), [Logging](#servers-sinatra-logging))
28 * [All In One (Client/Server)](#servers-allinone)
02f3dd30 »
2012-10-29 + documentation
29
30 #### Integration in Rails/Sinatra etc.{#index-integration}
c763882d »
2012-10-28 + moved the docs into the Picky main repo
31
e31a3c0d »
2012-10-29 + new style documentation
32 How to [integrate](#integration) Picky in:
5e553778 »
2012-10-28 + links on website
33
02f3dd30 »
2012-10-29 + documentation
34 * [Rails](#rails)
35 * [Sinatra](#sinatra)
36 * [DRb](#drb)
e31a3c0d »
2012-10-29 + new style documentation
37 * [Ruby Script](#ruby_script)
c763882d »
2012-10-28 + moved the docs into the Picky main repo
38
5e553778 »
2012-10-28 + links on website
39 ### Tokenizing{#index-tokenizing}
40
41 How data is cut into little pieces for the index and when searching.
c763882d »
2012-10-28 + moved the docs into the Picky main repo
42
02f3dd30 »
2012-10-29 + documentation
43 * [What is tokenizing?](#tokenizing)
44 * [Options](#tokenizing-options)
45 * [Using a custom tokenizer](#tokenizing-tokenizer)
46 * [Examples](#tokenizing-examples)
47 * [Advanced tokenizing](#tokenizing-notes)
48
49 ### Indexes{#index-indexes}
50
51 How the data is stored and what you can do with [Indexes](#indexes).
52
53 Configuring an index:
54
55 * [Configuration](#indexes-configuration)
56
ecf9ea7c »
2014-04-15 . some preliminary corrections to the documentation
57 How does data get into an index?
02f3dd30 »
2012-10-29 + documentation
58
59 * [Indexing](#indexes-indexing)
60 * [Data Source Overview](#indexes-sources)
80faa66f »
2013-07-14 + Implicit and explicit data sources
61 * [Source defined explicitly](#indexes-sources-explicit)
02f3dd30 »
2012-10-29 + documentation
62 * [Source responding to #each](#indexes-sources-each)
63 * [When is the data for indexing loaded?](#indexes-sources-delayed)
80faa66f »
2013-07-14 + Implicit and explicit data sources
64 * [Source not explicitly defined](#indexes-sources-implicit)
65 * [Methods to add data to an index](#indexes-sources-implicit-methods)
02f3dd30 »
2012-10-29 + documentation
66
67 How is the data categorized?
68
69 * [Categories](#indexes-categories)
70 * [Option partial](#indexes-categories-partial)
88cbaa23 »
2013-02-18 ! weights -> weight
71 * [Option weight](#indexes-categories-weight)
02f3dd30 »
2012-10-29 + documentation
72 * [Option similarity](#indexes-categories-similarity)
73 * [Option qualifier / qualifiers (categorizing)](#indexes-categories-qualifiers)
74 * [Option from](#indexes-categories-from)
75 * [Option key_format](#indexes-categories-keyformat)
76 * [Option source](#indexes-categories-source)
4d803697 »
2013-03-03 + New option tokenize
77 * [Option tokenize](#indexes-categories-tokenize)
02f3dd30 »
2012-10-29 + documentation
78
79 How is the data prepared?
80
81 * [Indexing / Tokenizing](#indexes-indexing)
82
83 Getting at the data:
84
85 * [Accessing indexes and categories](#indexes-acessing)
86
87 There are four different [store types](#indexes-types):
88
89 * [Memory](#indexes-types-memory)
90 * [Redis](#indexes-types-redis)
91 * [SQLite](#indexes-types-sqlite)
92 * [File](#indexes-types-file)
93
94 Advanced topics:
95
96 * [Format of the indexed ids](#indexes-keyformat)
97 * [Reloading](#indexes-reloading)
98 * [Reindexing](#indexes-reindexing)
99 * [Using signals](#indexes-reloading-signals)
100 * [Which index did a result come from?](#indexes-results)
101
102 ### Searching{#index-searching}
103
104 How to configure a search interface over an index (or multiple).
105
106 * [Search Interface Overview](#search)
107 * [Search Options](#search-options)
108 * [Searching / Tokenizing](#search-options-searching)
109
51841dab »
2012-11-28 + Range queries to range options
110 What options does a user have when searching?
111
112 * [User Search Options](#indexes-categories-searching)
02f3dd30 »
2012-10-29 + documentation
113
114 Advanced topics:
115
88cbaa23 »
2013-02-18 ! weights -> weight
116 * [Boosting](#search-options-boost) ([boosting a single category](#indexes-categories-weight))
d46b6dcd »
2013-03-03 + New features (only, ignore)
117 * [Ignoring categories](#search-options-ignore)
118 * [Ignoring combinations of categories](#search-options-ignore-combination)
119 * [Keeping only specific combinations of categories](#search-options-only-combination)
02f3dd30 »
2012-10-29 + documentation
120 * [Ignoring query words that are not found](#search-options-unassigned)
d46b6dcd »
2013-03-03 + New features (only, ignore)
121 * [Maximum allocations (of tokens to categories)](#search-options-maxallocations)
02f3dd30 »
2012-10-29 + documentation
122 * [Stopping a search early](#search-options-terminateearly)
123
124 #### Facets{#facets-index}
125
126 When you need a slice over a category's data.
127
128 * [Facets](#facets)
129 * [Index Facets](#index_facets)
130 * [Search Facets](#search_facets) (Using a query to filter your index facets)
131
132 #### Results{#index-results}
5e553778 »
2012-10-28 + links on website
133
134 What a picky search returns.
c763882d »
2012-10-28 + moved the docs into the Picky main repo
135
02f3dd30 »
2012-10-29 + documentation
136 * [Results Overview](#results)
137 * [Logging](#results-logging)
138 * [Sorting](#results-sorting)
139 * [Identification](#indexes-results)
140
794c0c09 »
2012-12-10 + javascript section
141 ### JavaScript{#index-javascript}
142
b9974335 »
2012-12-10 + documentation of JS options
143 We include a [JavaScript library](#javascript) to make writing snazzy interfaces easier – see the [options](#javascript_options).
794c0c09 »
2012-12-10 + javascript section
144
02f3dd30 »
2012-10-29 + documentation
145 ### Thanks{#index-thanks}
146
147 A bit of [thanks](#thanks)!
Something went wrong with that request. Please try again.