Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 133 lines (86 sloc) 4.159 kb
c763882 Florian R. Hanke + moved the docs into the Picky main repo
authored
1 ## Single Page Help Index
2
5e55377 Florian R. Hanke + links on website
authored
3 This is the one page help document for Picky.
4
02f3dd3 Florian R. Hanke + documentation
authored
5 Search for things using your browser (use ⌘F).
c763882 Florian R. Hanke + moved the docs into the Picky main repo
authored
6
e31a3c0 Florian R. Hanke + new style documentation
authored
7 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.
c763882 Florian R. Hanke + moved the docs into the Picky main repo
authored
8
02f3dd3 Florian R. Hanke + documentation
authored
9 ### Getting started{#index-getting-started}
c763882 Florian R. Hanke + moved the docs into the Picky main repo
authored
10
e31a3c0 Florian R. Hanke + new style documentation
authored
11 It's [All Ruby](#all_ruby). You'll never feel powerless. [Look at your index data](#transparency) anytime.
c763882 Florian R. Hanke + moved the docs into the Picky main repo
authored
12
02f3dd3 Florian R. Hanke + documentation
authored
13 #### Generating an app{#index-generating}
c763882 Florian R. Hanke + moved the docs into the Picky main repo
authored
14
e31a3c0 Florian R. Hanke + new style documentation
authored
15 Creating an [example app](#generators) to get you up and running fast, [Servers](#generators-servers) or [Clients](#generators-clients).
5e55377 Florian R. Hanke + links on website
authored
16
e31a3c0 Florian R. Hanke + new style documentation
authored
17 Generating them:
c763882 Florian R. Hanke + moved the docs into the Picky main repo
authored
18
e31a3c0 Florian R. Hanke + new style documentation
authored
19 * [Sinatra Server](#generators-servers-sinatra) and [Client](#generators-clients-sinatra)
20 * [Sinatra Server+Client in one](#generators-servers-allinone)
02f3dd3 Florian R. Hanke + documentation
authored
21
e31a3c0 Florian R. Hanke + new style documentation
authored
22 More infos on the [applications](#servers):
02f3dd3 Florian R. Hanke + documentation
authored
23
e31a3c0 Florian R. Hanke + new style documentation
authored
24 * [Sinatra](#servers-sinatra)([Routing](#servers-sinatra-routing), [Logging](#servers-sinatra-logging))
25 * [All In One (Client/Server)](#servers-allinone)
02f3dd3 Florian R. Hanke + documentation
authored
26
27 #### Integration in Rails/Sinatra etc.{#index-integration}
c763882 Florian R. Hanke + moved the docs into the Picky main repo
authored
28
e31a3c0 Florian R. Hanke + new style documentation
authored
29 How to [integrate](#integration) Picky in:
5e55377 Florian R. Hanke + links on website
authored
30
02f3dd3 Florian R. Hanke + documentation
authored
31 * [Rails](#rails)
32 * [Sinatra](#sinatra)
33 * [DRb](#drb)
e31a3c0 Florian R. Hanke + new style documentation
authored
34 * [Ruby Script](#ruby_script)
c763882 Florian R. Hanke + moved the docs into the Picky main repo
authored
35
5e55377 Florian R. Hanke + links on website
authored
36 ### Tokenizing{#index-tokenizing}
37
38 How data is cut into little pieces for the index and when searching.
c763882 Florian R. Hanke + moved the docs into the Picky main repo
authored
39
02f3dd3 Florian R. Hanke + documentation
authored
40 * [What is tokenizing?](#tokenizing)
41 * [Options](#tokenizing-options)
42 * [Using a custom tokenizer](#tokenizing-tokenizer)
43 * [Examples](#tokenizing-examples)
44 * [Advanced tokenizing](#tokenizing-notes)
45
46 ### Indexes{#index-indexes}
47
48 How the data is stored and what you can do with [Indexes](#indexes).
49
50 Configuring an index:
51
52 * [Configuration](#indexes-configuration)
53
54 How does data get in there?
55
56 * [Indexing](#indexes-indexing)
57 * [Data Source Overview](#indexes-sources)
58 * [Source responding to #each](#indexes-sources-each)
e31a3c0 Florian R. Hanke + new style documentation
authored
59 * [_Classic Picky sources_](#indexes-sources-classic) _(deprecated from 5.0)_
02f3dd3 Florian R. Hanke + documentation
authored
60 * [When is the data for indexing loaded?](#indexes-sources-delayed)
61
62 How is the data categorized?
63
64 * [Categories](#indexes-categories)
65 * [Option partial](#indexes-categories-partial)
66 * [Option weights](#indexes-categories-weights)
67 * [Option similarity](#indexes-categories-similarity)
68 * [Option qualifier / qualifiers (categorizing)](#indexes-categories-qualifiers)
69 * [Option from](#indexes-categories-from)
70 * [Option key_format](#indexes-categories-keyformat)
71 * [Option source](#indexes-categories-source)
72
73 How is the data prepared?
74
75 * [Indexing / Tokenizing](#indexes-indexing)
76
77 Getting at the data:
78
79 * [Accessing indexes and categories](#indexes-acessing)
80
81 There are four different [store types](#indexes-types):
82
83 * [Memory](#indexes-types-memory)
84 * [Redis](#indexes-types-redis)
85 * [SQLite](#indexes-types-sqlite)
86 * [File](#indexes-types-file)
87
88 Advanced topics:
89
90 * [Format of the indexed ids](#indexes-keyformat)
91 * [Reloading](#indexes-reloading)
92 * [Reindexing](#indexes-reindexing)
93 * [Using signals](#indexes-reloading-signals)
94 * [Which index did a result come from?](#indexes-results)
95
96 ### Searching{#index-searching}
97
98 How to configure a search interface over an index (or multiple).
99
100 * [Search Interface Overview](#search)
101 * [Search Options](#search-options)
102 * [Searching / Tokenizing](#search-options-searching)
103
104 What [options](#indexes-categories-searching) does a user have when searching?
105
106 Advanced topics:
107
108 * [Boosting](#search-options-boost) ([boosting a single category](#indexes-categories-weights))
109 * [Ignoring a category](#search-options-ignore)
110 * [Ignoring query words that are not found](#search-options-unassigned)
111 * [Maximum Allocations](#search-options-maxallocations)
112 * [Stopping a search early](#search-options-terminateearly)
113
114 #### Facets{#facets-index}
115
116 When you need a slice over a category's data.
117
118 * [Facets](#facets)
119 * [Index Facets](#index_facets)
120 * [Search Facets](#search_facets) (Using a query to filter your index facets)
121
122 #### Results{#index-results}
5e55377 Florian R. Hanke + links on website
authored
123
124 What a picky search returns.
c763882 Florian R. Hanke + moved the docs into the Picky main repo
authored
125
02f3dd3 Florian R. Hanke + documentation
authored
126 * [Results Overview](#results)
127 * [Logging](#results-logging)
128 * [Sorting](#results-sorting)
129 * [Identification](#indexes-results)
130
131 ### Thanks{#index-thanks}
132
133 A bit of [thanks](#thanks)!
Something went wrong with that request. Please try again.