-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathcustom-catalog.html
312 lines (195 loc) · 13.6 KB
/
custom-catalog.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
<!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>10. Customize your Catalog — 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="11. Architecture" href="architecture.html" />
<link rel="prev" title="9. Keyboard Shortcuts" href="keyboard.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"><a class="reference internal" href="first.html">4. First steps</a></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 current"><a class="current reference internal" href="#">10. Customize your Catalog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#introduction">10.1. Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="#shrinking-your-catalog">10.2. Shrinking your Catalog</a></li>
<li class="toctree-l2"><a class="reference internal" href="#expanding-your-catalog">10.3. Expanding your Catalog</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tracking-down-unwanted-features">10.4. Tracking down unwanted features</a></li>
</ul>
</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">10. </span>Customize your Catalog</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="customize-your-catalog">
<h1><span class="section-number">10. </span>Customize your Catalog<a class="headerlink" href="#customize-your-catalog" title="Permalink to this headline">¶</a></h1>
<p>By default, almost all Keypirinha’s features are enabled.</p>
<p>While the majority of users will find convenient not to have to configure
Keypirinha straight out of the box, some might prefer to have full control on
what is actually available in the <a class="reference internal" href="glossary.html#term-Catalog"><span class="xref std std-term">Catalog</span></a>.</p>
<p>At the cost of extra time spent on configuring Keypirinha, reducing the number of
items in the <a class="reference internal" href="glossary.html#term-Catalog"><span class="xref std std-term">Catalog</span></a> may have a significant impact on both memory
footprint and search speed.</p>
<p>This small guide shows how to clear the Catalog entirely so you can then
expand it with only the desired features/items.</p>
<div class="section" id="introduction">
<h2><span class="section-number">10.1. </span>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
<p>To understand how to customize your Catalog, you must first understand how it is
built. The tiny <a class="reference internal" href="architecture.html#architecture-overview"><span class="std std-ref">Overview</span></a> section gives you an overview of
the role plugins play in Keypirinha.</p>
<p>Also, this guide assumes you already know how to configure Keypirinha so you
might want to open the <a class="reference internal" href="configuration.html"><span class="doc">Configuration</span></a> chapter aside and have it handy
while reading the following sections.</p>
</div>
<div class="section" id="shrinking-your-catalog">
<h2><span class="section-number">10.2. </span>Shrinking your Catalog<a class="headerlink" href="#shrinking-your-catalog" title="Permalink to this headline">¶</a></h2>
<p>To start with a clean slate, we will disable every shipped <a class="reference internal" href="glossary.html#term-Package"><span class="xref std std-term">package</span></a>
except the <code class="docutils literal notranslate"><span class="pre">Internal</span></code> one.</p>
<p>Open Keypirinha’s configuration file and create/modify the <code class="docutils literal notranslate"><span class="pre">ignored_packages</span></code>
setting as follows:</p>
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[app]</span>
<span class="na">ignored_packages</span> <span class="o">=</span> <span class="s"><All>, -Internal</span>
</pre></div>
</div>
<p>Read the comments related to <code class="docutils literal notranslate"><span class="pre">ignored_packages</span></code> in the default configuration
file for more info on the meaning and the syntax of this value.</p>
<p>Save your configuration file.</p>
<p>From now on, only items from the <code class="docutils literal notranslate"><span class="pre">Internal</span></code> package are available. The
<code class="docutils literal notranslate"><span class="pre">Internal</span></code> package enables access to some core features of Keypirinha and is
very lightweight in terms of number of items. So it is recommended to keep it
enabled but technically-wise, nothing prevents you from disabling it as well
(<code class="docutils literal notranslate"><span class="pre">ignored_packages</span> <span class="pre">=</span> <span class="pre"><All></span></code>).</p>
</div>
<div class="section" id="expanding-your-catalog">
<h2><span class="section-number">10.3. </span>Expanding your Catalog<a class="headerlink" href="#expanding-your-catalog" title="Permalink to this headline">¶</a></h2>
<p>Keypirinha is a generic tool that allows a very wide range of use cases.</p>
<p>For that reason, this section cannot be explicit or exhaustive since it entirely
depends on how you want to use Keypirinha. For example, some users only want to
launch applications while other may want to have full access to every bookmarks
referenced in their favorite web browser…</p>
<p>An thing to keep in mind though is that in Keypirinha, each package roughly
represents a single feature or a set of related features. <br />
For example, the <a class="reference internal" href="packages/calc.html"><span class="doc">Calc Package</span></a> does just what its name implies: it
evaluates the mathematical expression you typed, then shows its result(s).</p>
<p>Check out the list of the available <a class="reference internal" href="shipped-packages.html"><span class="doc">Shipped Packages</span></a> and learn more about
their purpose to see if they suit your needs. You may then want to enable them
one by one using the <code class="docutils literal notranslate"><span class="pre">ignored_packages</span></code> setting.</p>
<p>Also, do not forget that some of them are configurable, which means that you may
be able to have a more fine-grained control on what they insert in the
<em>Catalog</em>. <br />
For example, if you enable the <code class="docutils literal notranslate"><span class="pre">Apps</span></code> package, you might want to have a look
at the <code class="docutils literal notranslate"><span class="pre">scan_start_menu</span></code> and <code class="docutils literal notranslate"><span class="pre">scan_env_path</span></code> settings.</p>
</div>
<div class="section" id="tracking-down-unwanted-features">
<h2><span class="section-number">10.4. </span>Tracking down unwanted features<a class="headerlink" href="#tracking-down-unwanted-features" title="Permalink to this headline">¶</a></h2>
<p>If you happen to notice that some unwanted features are still enabled, it is
worth mentioning that it is possible to know what plugin (and by extension, what
package) created a specific catalog item in the list of results.</p>
<p>To do that, select an item and press <kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Alt</kbd>+<kbd class="kbd docutils literal notranslate">Enter</kbd></kbd>. The <a class="reference internal" href="glossary.html#term-Console"><span class="xref std std-term">Console</span></a>
window will show up and the last log lines list the properties of the selected
item. Among them the name of the parent plugin.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="architecture.html" class="btn btn-neutral float-right" title="11. Architecture" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="keyboard.html" class="btn btn-neutral float-left" title="9. Keyboard Shortcuts" 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>