-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathglossary.html
311 lines (194 loc) · 13.1 KB
/
glossary.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
<!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>15. Glossary — 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="16. Frequently Asked Questions (FAQ)" href="faq.html" />
<link rel="prev" title="14. Contribute" href="contribute.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"><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 current"><a class="current reference internal" href="#">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">15. </span>Glossary</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="glossary">
<h1><span class="section-number">15. </span>Glossary<a class="headerlink" href="#glossary" title="Permalink to this headline">¶</a></h1>
<dl class="glossary">
<dt id="term-Catalog">Catalog</dt><dd><p>The Catalog is the name of the internal database of Keypirinha where all
the <a class="reference internal" href="#term-Items"><span class="xref std std-term">items</span></a> are indexed to allow a quick search.</p>
</dd>
<dt id="term-CatalogItem">CatalogItem</dt><dd><p>The class name of an <a class="reference internal" href="#term-Item"><span class="xref std std-term">item</span></a> (API).</p>
</dd>
<dt id="term-Console">Console</dt><dd><p>The <em>Console</em> window gives access to the output of application’s log. It
should be your first destination in case of error or unexpected
behavior in order to check if a plugin emitted some warning or error
message.</p>
<p>It also gives you an interactive access to the embedded Python
interpreter and Keypirinha’s API.</p>
<p>The <em>Console</em> can be opened:</p>
<ul class="simple">
<li><p>by pressing <kbd class="kbd docutils literal notranslate">F2</kbd> from the <a class="reference internal" href="#term-LaunchBox"><span class="xref std std-term">LaunchBox</span></a></p></li>
<li><p>by executing the <code class="docutils literal notranslate"><span class="pre">Keypirinha:</span> <span class="pre">Console</span></code> item (the <code class="docutils literal notranslate"><span class="pre">Internal</span></code>
package must be enabled)</p></li>
<li><p>via Keypirinha’s main menu</p></li>
</ul>
<img alt="|project|'s Console" class="align-center" src="_images/console.png" />
</dd>
<dt id="term-Diagnostic-Window">Diagnostic Window</dt><dd><p>The <em>Diagnostic Window</em> is useful in case you want to report an issue.
See <a class="reference internal" href="contribute.html#contribute-issue"><span class="std std-ref">How to Report an Issue</span></a>.</p>
<p>The <em>Diagnostic Window</em> can be opened:</p>
<ul class="simple">
<li><p>by pressing <kbd class="kbd docutils literal notranslate">F3</kbd> from the <a class="reference internal" href="#term-LaunchBox"><span class="xref std std-term">LaunchBox</span></a></p></li>
<li><p>by executing the <code class="docutils literal notranslate"><span class="pre">Keypirinha:</span> <span class="pre">Diagnostic</span> <span class="pre">Window</span></code> item (the
<code class="docutils literal notranslate"><span class="pre">Internal</span></code> package must be enabled)</p></li>
<li><p>via Keypirinha’s main menu</p></li>
</ul>
</dd>
<dt id="term-InstanceID">InstanceID</dt><dd><p>Keypirinha allows the code source of its packages to be modified at
runtime by automatically reloading them every time a modification is
done.</p>
<p>The InstanceID number is an unsigned integer internally managed by the
application and assigned at runtime to each <a class="reference internal" href="#term-Package"><span class="xref std std-term">package</span></a>, each time
they are (re)loaded.</p>
<p>It is also used to ensure only the latest instance of a given package
has write access to its section of the <a class="reference internal" href="#term-Catalog"><span class="xref std std-term">Catalog</span></a>.</p>
<p>Read <a class="reference internal" href="api/overview.html"><span class="doc">Overview</span></a> for more information.</p>
</dd>
<dt id="term-Item">Item</dt><dt id="term-Items">Items</dt><dd><p>An item is the data unit of the <a class="reference internal" href="#term-Catalog"><span class="xref std std-term">Catalog</span></a> (Keypirinha’s internal
database). It is a simple data structure, created by the
<a class="reference internal" href="#term-Plugins"><span class="xref std std-term">plugins</span></a>, that has some properties like a display name (label),
a category (File, URL, Command Line, …), a reference to the parent
<a class="reference internal" href="#term-Plugin"><span class="xref std std-term">plugin</span></a>, etc…</p>
</dd>
<dt id="term-LaunchBox">LaunchBox</dt><dd><p>The L(a)unchBox is the main window of Keypirinha, from which you can make
a search and launch the selected <a class="reference internal" href="#term-Item"><span class="xref std std-term">item</span></a>. It can be opened by
pressing the <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> combination (default).</p>
<p>More info in the <a class="reference internal" href="first.html"><span class="doc">First steps</span></a> chapter.</p>
<img alt="|project|'s LaunchBox" class="align-center" src="_images/wndrun.png" />
</dd>
<dt id="term-Package">Package</dt><dt id="term-Packages">Packages</dt><dd><p>A Package is a container of one or several <a class="reference internal" href="#term-Plugins"><span class="xref std std-term">plugins</span></a> that
represent a single feature, or a set of related features.</p>
<p>It contains the source code of its plugins, their dependencies, a
default configuration file, if any, and optionally some documentation.</p>
<p>It can come in the form of a directory with loose files, or it can be
packed in an archive to ease its redistribution (i.e. a
<code class="file docutils literal notranslate"><span class="pre">*.keypirinha-package</span></code> file, which is a regular zip archive).</p>
<p>Read <a class="reference internal" href="packages.html"><span class="doc">Packages Structure</span></a> for more information.</p>
</dd>
<dt id="term-Plugin">Plugin</dt><dt id="term-Plugins">Plugins</dt><dd><p>In the context of Keypirinha, a Plugin is a software component written in
<a class="reference external" href="https://python.org">Python3</a> that extends the base features of the application. <strong>It is
always encapsulated in a</strong> <a class="reference internal" href="#term-Package"><span class="xref std std-term">package</span></a>.</p>
</dd>
<dt id="term-Repository">Repository</dt><dt id="term-Repositories">Repositories</dt><dd><p>A Repository is a directory dedicated to the storage of
<a class="reference internal" href="#term-Packages"><span class="xref std std-term">packages</span></a>. It also defines the way Packages are stored (i.e.:
loose files or packed in a single archive).</p>
</dd>
</dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="faq.html" class="btn btn-neutral float-right" title="16. Frequently Asked Questions (FAQ)" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="contribute.html" class="btn btn-neutral float-left" title="14. Contribute" 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>