-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathfirst.html
461 lines (344 loc) · 26.5 KB
/
first.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>4. First steps — Keypirinha</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="shortcut icon" href="_static/favicon.ico"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="5. Shipped Packages" href="shipped-packages.html" />
<link rel="prev" title="3. Update Procedure" href="update.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home" alt="Documentation Home"> Keypirinha
<img src="_static/app-128.png" class="logo" alt="Logo"/>
</a>
<div class="version">
2.26
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="download.html">1. Download</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">2. Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="update.html">3. Update Procedure</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">4. First steps</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#start-project">4.1. Start Keypirinha</a></li>
<li class="toctree-l2"><a class="reference internal" href="#open-the-launchbox">4.2. Open the LaunchBox</a></li>
<li class="toctree-l2"><a class="reference internal" href="#first-search">4.3. First Search</a></li>
<li class="toctree-l2"><a class="reference internal" href="#second-search">4.4. Second Search</a></li>
<li class="toctree-l2"><a class="reference internal" href="#associate-a-keyword-to-an-item">4.5. Associate a Keyword to an Item</a></li>
<li class="toctree-l2"><a class="reference internal" href="#specify-arguments">4.6. Specify arguments</a></li>
<li class="toctree-l2"><a class="reference internal" href="#actions">4.7. Actions</a></li>
<li class="toctree-l2"><a class="reference internal" href="#maximize-the-launchbox">4.8. Maximize the LaunchBox</a></li>
<li class="toctree-l2"><a class="reference internal" href="#leave-a-search">4.9. Leave a Search</a></li>
<li class="toctree-l2"><a class="reference internal" href="#drag-and-drop">4.10. Drag and Drop</a></li>
<li class="toctree-l2"><a class="reference internal" href="#clear-the-history">4.11. Clear the history</a></li>
<li class="toctree-l2"><a class="reference internal" href="#configuration">4.12. Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="#gui-theming">4.13. GUI Theming</a></li>
<li class="toctree-l2"><a class="reference internal" href="#plugins">4.14. Plugins</a></li>
<li class="toctree-l2"><a class="reference internal" href="#customize-your-catalog">4.15. Customize your Catalog</a></li>
<li class="toctree-l2"><a class="reference internal" href="#extending-project">4.16. Extending Keypirinha</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="shipped-packages.html">5. Shipped Packages</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributions.html">6. Third-Party Packages</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">7. Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="theming.html">8. Theming</a></li>
<li class="toctree-l1"><a class="reference internal" href="keyboard.html">9. Keyboard Shortcuts</a></li>
<li class="toctree-l1"><a class="reference internal" href="custom-catalog.html">10. Customize your Catalog</a></li>
<li class="toctree-l1"><a class="reference internal" href="architecture.html">11. Architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="packages.html">12. Packages Structure</a></li>
<li class="toctree-l1"><a class="reference internal" href="api.html">13. Extending Keypirinha (API)</a></li>
<li class="toctree-l1"><a class="reference internal" href="contribute.html">14. Contribute</a></li>
<li class="toctree-l1"><a class="reference internal" href="glossary.html">15. Glossary</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">16. Frequently Asked Questions (FAQ)</a></li>
<li class="toctree-l1"><a class="reference internal" href="credits.html">17. Credits</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Change Log</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Keypirinha</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> »</li>
<li><span class="section-number">4. </span>First steps</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="first-steps">
<h1><span class="section-number">4. </span>First steps<a class="headerlink" href="#first-steps" title="Permalink to this headline">¶</a></h1>
<p>The first thing to know about Keypirinha is that you can use almost all of its
features by using your keyboard only. Keep that in mind!</p>
<div class="section" id="start-project">
<h2><span class="section-number">4.1. </span>Start Keypirinha<a class="headerlink" href="#start-project" title="Permalink to this headline">¶</a></h2>
<p>Keypirinha is a <em>resident</em> application, it directly goes to background when it is
started.</p>
<p>You can check application is running by looking for its icon in the system
tray’s notification area. It is located next to the system clock on your
desktop, usually in the lower-right corner of your main monitor.</p>
<img alt="|project|'s icon in the system's tray" class="align-center" src="_images/systray.png" />
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>This <code class="docutils literal notranslate"><span class="pre">k</span></code> icon also indicates any activity from the plugins (e.g.
cataloging, suggesting, executing, …) by <strong>turning green</strong>. Color is
restored to normal as soon as plugins have finished their jobs.</p>
</div>
</div>
<div class="section" id="open-the-launchbox">
<h2><span class="section-number">4.2. </span>Open the LaunchBox<a class="headerlink" href="#open-the-launchbox" title="Permalink to this headline">¶</a></h2>
<p>Once Keypirinha is running, press <kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Ctrl</kbd>+<kbd class="kbd docutils literal notranslate">Win</kbd>+<kbd class="kbd docutils literal notranslate">K</kbd></kbd> (by default) to show the
<a class="reference internal" href="glossary.html#term-LaunchBox"><span class="xref std std-term">LaunchBox</span></a>…</p>
<img alt="|project|'s main dialog" class="align-center" src="_images/wndrun.png" />
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>Many former <em>Launchy</em> users change the default hotkey to <kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Alt</kbd>+<kbd class="kbd docutils literal notranslate">Space</kbd></kbd></p>
</div>
</div>
<div class="section" id="first-search">
<h2><span class="section-number">4.3. </span>First Search<a class="headerlink" href="#first-search" title="Permalink to this headline">¶</a></h2>
<p>You can now search for the task you wish to execute.</p>
<p>Say you want to launch the <em>Firefox</em> web browser for example. Start typing its
name and it will soon show up in the results list as long as <em>Firefox</em> is
installed on your machine.</p>
<p>To select the desired item if not done already, you can use the <kbd class="kbd docutils literal notranslate">Down</kbd>,
<kbd class="kbd docutils literal notranslate">Up</kbd>, <kbd class="kbd docutils literal notranslate">PgDown</kbd> and <kbd class="kbd docutils literal notranslate">PgUp</kbd> keys.</p>
<img alt="First search" class="align-center" src="_images/wndrun-search1.png" />
<p>Once the item is selected, press <kbd class="kbd docutils literal notranslate">Enter</kbd> to launch it.</p>
<p>Keypirinha will then automatically go back to background…</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Search is case-insensitive in Keypirinha, the search term <code class="docutils literal notranslate"><span class="pre">FFOX</span></code> is
equivalent to <code class="docutils literal notranslate"><span class="pre">ffox</span></code> or <code class="docutils literal notranslate"><span class="pre">FfoX</span></code></p>
</div>
</div>
<div class="section" id="second-search">
<h2><span class="section-number">4.4. </span>Second Search<a class="headerlink" href="#second-search" title="Permalink to this headline">¶</a></h2>
<p>Keypirinha remembers the tasks you execute, so if you want to launch a task you
already executed, chances are high that you will only need to type the very
first couple of letters of its name to get the task at the top of the results
list.</p>
<p>To keep going with our example, we will <strong>just</strong> type the <code class="docutils literal notranslate"><span class="pre">F</span></code> letter since it
is the one that naturally comes to our mind when thinking about the name
<code class="docutils literal notranslate"><span class="pre">Firefox</span></code>.</p>
<p>Execute this item <strong>again</strong>. You will see why in the next section below.</p>
<img alt="Second search for an already executed item" class="align-center" src="_images/wndrun-search2.png" />
</div>
<div class="section" id="associate-a-keyword-to-an-item">
<span id="first-associate-keyword"></span><h2><span class="section-number">4.5. </span>Associate a Keyword to an Item<a class="headerlink" href="#associate-a-keyword-to-an-item" title="Permalink to this headline">¶</a></h2>
<p>This is one of the coolest search feature of Keypirinha.</p>
<p>Still with our example, if you happen to launch your <em>Firefox</em> browser a lot,
you probably want to keep the number of keystrokes that are required to search
and launch it to a minimum.</p>
<p>Keypirinha <strong>implicitly associates a keyword with a particular item once this
item is executed using any of the provided action</strong> .</p>
<p>In the last section, we typed the search term <code class="docutils literal notranslate"><span class="pre">F</span></code> (or <code class="docutils literal notranslate"><span class="pre">f</span></code>, search is case-
insensitive), before <strong>executing</strong> <em>Firefox</em>. Keypirinha recorded that
information so every time your search term will be <code class="docutils literal notranslate"><span class="pre">f</span></code>, the <em>Firefox</em> item
will be pushed up to the top of the results list.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>Association is done at execution time, that is, when you actually launch the
item.</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>You may want to <em>associate</em> <code class="docutils literal notranslate"><span class="pre">f</span></code> with an other item later. In that case,
just type <code class="docutils literal notranslate"><span class="pre">f</span></code> and select this other item before <strong>executing</strong> it.
Keypirinha will change the association implicitly.</p>
</div>
</div>
<div class="section" id="specify-arguments">
<h2><span class="section-number">4.6. </span>Specify arguments<a class="headerlink" href="#specify-arguments" title="Permalink to this headline">¶</a></h2>
<p>In Keypirinha, some items accept or require arguments.</p>
<p>Once you typed your search term and <strong>selected</strong> the desired item, hit the
<kbd class="kbd docutils literal notranslate">Tab</kbd> key (see also the <code class="docutils literal notranslate"><span class="pre">space_as_tab</span></code> setting).</p>
<p>Back to our example, <em>Firefox</em> currently accepts the <code class="docutils literal notranslate"><span class="pre">-preferences</span></code> command
line option so let’s try typing this one and execute our item.</p>
<img alt="_images/wndrun-args.png" class="align-center" src="_images/wndrun-args.png" />
</div>
<div class="section" id="actions">
<h2><span class="section-number">4.7. </span>Actions<a class="headerlink" href="#actions" title="Permalink to this headline">¶</a></h2>
<p>Items may have several associated actions.</p>
<p>Search and select the <em>Firefox</em> item again.</p>
<img alt="_images/wndrun-search2.png" class="align-center" src="_images/wndrun-search2.png" />
<p>By default, the number of actions available for the selected item are displayed
at the right side: here <code class="docutils literal notranslate"><span class="pre">8</span> <span class="pre">actions</span></code>. Hit the <kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Ctrl</kbd>+<kbd class="kbd docutils literal notranslate">Enter</kbd></kbd> to visualize
these actions (or the <kbd class="kbd docutils literal notranslate">Tab</kbd> key until you reach the actions list).</p>
<p>Because this particular <em>Firefox</em> item is a file, a <code class="file docutils literal notranslate"><span class="pre">*.lnk</span></code> file in this
example, the following actions are made available:</p>
<img alt="_images/wndrun-actions.png" class="align-center" src="_images/wndrun-actions.png" />
<p>Select the one you want and press <kbd class="kbd docutils literal notranslate">Enter</kbd> to execute.</p>
</div>
<div class="section" id="maximize-the-launchbox">
<span id="first-maximize"></span><h2><span class="section-number">4.8. </span>Maximize the LaunchBox<a class="headerlink" href="#maximize-the-launchbox" title="Permalink to this headline">¶</a></h2>
<p><kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Alt</kbd>+<kbd class="kbd docutils literal notranslate">X</kbd></kbd> (or <kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Win</kbd>+<kbd class="kbd docutils literal notranslate">Up</kbd></kbd>) <strong>toggles</strong> between <em>normal</em> and <em>maximized</em>
state.</p>
<p>You may need to <strong>temporarily extend the size</strong> of the LaunchBox sometimes in
order to see the full content of some items in the results list. You can do that
by either pressing <kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Alt</kbd>+<kbd class="kbd docutils literal notranslate">X</kbd></kbd> or <kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Win</kbd>+<kbd class="kbd docutils literal notranslate">Up</kbd></kbd> (toggle).</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This feature does not impact the geometry you manually setup in case your
<code class="docutils literal notranslate"><span class="pre">geometry</span></code> setting is <code class="docutils literal notranslate"><span class="pre">persistent</span></code>. Hit <kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Alt</kbd>+<kbd class="kbd docutils literal notranslate">X</kbd></kbd> again and your
previous position and size will be restored. <strong>CAUTION:</strong> If you are in
<code class="docutils literal notranslate"><span class="pre">persistent</span></code> geometry, do not reposition/resize the window <strong>while being
in maximized mode</strong> or you will loose your previous geometry.</p>
</div>
</div>
<div class="section" id="leave-a-search">
<h2><span class="section-number">4.9. </span>Leave a Search<a class="headerlink" href="#leave-a-search" title="Permalink to this headline">¶</a></h2>
<p>May you wish to abort what you were doing on the <a class="reference internal" href="glossary.html#term-LaunchBox"><span class="xref std std-term">LaunchBox</span></a>, press the
<kbd class="kbd docutils literal notranslate">Esc</kbd> key. Press it <strong>once</strong>, to clear your search, <strong>twice</strong> to close the
dialog. Note that one time is enough if you didn’t type anything.</p>
<p>If you wish to close the window directly, press <kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Shift</kbd>+<kbd class="kbd docutils literal notranslate">Esc</kbd></kbd> or
<kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Alt</kbd>+<kbd class="kbd docutils literal notranslate">F4</kbd></kbd>.</p>
</div>
<div class="section" id="drag-and-drop">
<span id="first-drag"></span><h2><span class="section-number">4.10. </span>Drag and Drop<a class="headerlink" href="#drag-and-drop" title="Permalink to this headline">¶</a></h2>
<p>The LaunchBox allows drag-and-drop operations.</p>
<p>For example, a file from Windows Explorer can be dropped to the search box to
insert its full path.</p>
<p>Also, items in the results list can be dragged out. The effect of the resulting
drop depends on the type of item and the destination application:</p>
<ul class="simple">
<li><p>The actual file pointed at by a <code class="docutils literal notranslate"><span class="pre">FILE</span></code> item will be copied to the drop
destination.</p></li>
<li><p>The text content of the <code class="docutils literal notranslate"><span class="pre">URL</span></code>, <code class="docutils literal notranslate"><span class="pre">CMDLINE</span></code>, <code class="docutils literal notranslate"><span class="pre">EXPRESSION</span></code> and <code class="docutils literal notranslate"><span class="pre">ERROR</span></code>
items will be copied to the drop destination. For example:</p>
<ul>
<li><p>a <code class="docutils literal notranslate"><span class="pre">URL</span></code> item dropped to your web browser’s window will usually open this
<code class="docutils literal notranslate"><span class="pre">URL</span></code></p></li>
<li><p>a <code class="docutils literal notranslate"><span class="pre">CMDLINE</span></code> item dropped to a text editor will insert the <code class="docutils literal notranslate"><span class="pre">CMDLINE</span></code>
itself</p></li>
</ul>
</li>
</ul>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>Like in Windows Explorer, you can drag out <code class="docutils literal notranslate"><span class="pre">FILE</span></code> items using either the
left mouse button to have a regular behavior, or the right mouse button to
invoke a contextual menu at drop destination that allows you to choose the
desired drop effect.</p>
</div>
</div>
<div class="section" id="clear-the-history">
<h2><span class="section-number">4.11. </span>Clear the history<a class="headerlink" href="#clear-the-history" title="Permalink to this headline">¶</a></h2>
<p>It is possible to clear the history of every executed items by executing the
<code class="docutils literal notranslate"><span class="pre">Clear</span> <span class="pre">History</span></code> item that can always be found in the Catalog. It can be done
from application’s main contextual menu as well (right click on the LaunchBox).</p>
<p>If you just want to erase a <strong>single</strong> item from the history, just search for
it, select it and press <kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Ctrl</kbd>+<kbd class="kbd docutils literal notranslate">Del</kbd></kbd>. A message dialog will ask you to
confirm the operation.</p>
<p>It is also possible to delete every reference to a specific package from the
history by selecting a result item from this package, then clicking the
<code class="docutils literal notranslate"><span class="pre">Remove</span> <span class="pre">parent</span> <span class="pre">package</span> <span class="pre">from</span> <span class="pre">History</span></code> action from its contextual menu. <br />
Note that no keyboard shortcut is provided here as it is assumed to be rarely
used and to avoid any mistake.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>By clearing the full history, the score subsystem is also reset and you will
also loose the internal dictionary of the keywords you associated with
items, that is described in the <a class="reference internal" href="#first-associate-keyword"><span class="std std-ref">Associate a Keyword to an Item</span></a> section.</p>
</div>
</div>
<div class="section" id="configuration">
<h2><span class="section-number">4.12. </span>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
<p>See the <a class="reference internal" href="configuration.html"><span class="doc">Configuration</span></a> section for more info.</p>
</div>
<div class="section" id="gui-theming">
<h2><span class="section-number">4.13. </span>GUI Theming<a class="headerlink" href="#gui-theming" title="Permalink to this headline">¶</a></h2>
<p>It is possibe to tweak Keypirinha’s GUI, see <a class="reference internal" href="theming.html"><span class="doc">Theming</span></a> for more info.</p>
</div>
<div class="section" id="plugins">
<h2><span class="section-number">4.14. </span>Plugins<a class="headerlink" href="#plugins" title="Permalink to this headline">¶</a></h2>
<p>Some plugins, called <a class="reference internal" href="glossary.html#term-Packages"><span class="xref std std-term">packages</span></a> in Keypirinha, are shipped with Keypirinha
and are available out of the box. See <a class="reference internal" href="shipped-packages.html"><span class="doc">Shipped Packages</span></a>.</p>
<p>Also, some Keypirinha users kindly shared the packages they developed to the
community. You may find them useful. See <a class="reference internal" href="contributions.html"><span class="doc">Third-Party Packages</span></a>.</p>
</div>
<div class="section" id="customize-your-catalog">
<h2><span class="section-number">4.15. </span>Customize your Catalog<a class="headerlink" href="#customize-your-catalog" title="Permalink to this headline">¶</a></h2>
<p>Read the <a class="reference internal" href="custom-catalog.html"><span class="doc">Customize your Catalog</span></a> chapter to discover how you can gain full control
over what will be referenced in Keypirinha’s database and consequently, in search
results.</p>
</div>
<div class="section" id="extending-project">
<h2><span class="section-number">4.16. </span>Extending Keypirinha<a class="headerlink" href="#extending-project" title="Permalink to this headline">¶</a></h2>
<p>Despite its apparent simplicity, Keypirinha is a generic tool that is able to
welcome a very wide range of features not offered yet by the official bundled
plugins. An API allows to extend Keypirinha’s features to make them fit your
needs.</p>
<p>See the <a class="reference internal" href="api.html"><span class="doc">Extending Keypirinha (API)</span></a> section for more info.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="shipped-packages.html" class="btn btn-neutral float-right" title="5. Shipped Packages" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="update.html" class="btn btn-neutral float-left" title="3. Update Procedure" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2013-2018, Jean-Charles Lefebvre
</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-74522446-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>