-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy patharchitecture.html
More file actions
279 lines (162 loc) · 10.7 KB
/
Copy patharchitecture.html
File metadata and controls
279 lines (162 loc) · 10.7 KB
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
<!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>11. Architecture — 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="12. Packages Structure" href="packages.html" />
<link rel="prev" title="10. Customize your Catalog" href="custom-catalog.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 current"><a class="current reference internal" href="#">11. Architecture</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#overview">11.1. Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="#packages-and-plugins">11.2. Packages and Plugins</a></li>
<li class="toctree-l2"><a class="reference internal" href="#configuration">11.3. Configuration</a></li>
</ul>
</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">11. </span>Architecture</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="architecture">
<h1><span class="section-number">11. </span>Architecture<a class="headerlink" href="#architecture" title="Permalink to this headline">¶</a></h1>
<p>This section provides some insights about Keypirinha’s design and philosophy.</p>
<div class="section" id="overview">
<span id="architecture-overview"></span><h2><span class="section-number">11.1. </span>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>
<p>Keypirinha by itself is just a database (the <a class="reference internal" href="glossary.html#term-Catalog"><span class="xref std std-term">Catalog</span></a>) sweetened with a
small adaptive search engine and a straightforward graphical interface. Thus,
<strong>the task of feeding the Catalog is entirely left to its</strong> <a class="reference internal" href="glossary.html#term-Plugins"><span class="xref std std-term">Plugins</span></a>.</p>
<p>From that point of view, we can say that the whole architecture of Keypirinha
depends on its <a class="reference internal" href="glossary.html#term-Plugins"><span class="xref std std-term">plugins</span></a>. They are responsible of finding <a class="reference internal" href="glossary.html#term-Items"><span class="xref std std-term">items</span></a> on
your computer, like applications, documents and bookmarks for example, as well
as offering to evaluate mathematical expressions, monetary conversions and so
on…</p>
<p>These <a class="reference internal" href="glossary.html#term-Items"><span class="xref std std-term">items</span></a> are created by the <em>plugins</em> and are then sorted and stored
in an internal database called the <a class="reference internal" href="glossary.html#term-Catalog"><span class="xref std std-term">Catalog</span></a>, to make making them quickly
searchable and easily executable.</p>
</div>
<div class="section" id="packages-and-plugins">
<h2><span class="section-number">11.2. </span>Packages and Plugins<a class="headerlink" href="#packages-and-plugins" title="Permalink to this headline">¶</a></h2>
<p>To make <a class="reference internal" href="glossary.html#term-Plugins"><span class="xref std std-term">Plugins</span></a> easier to distribute, Keypirinha has been introduced the
concept of <a class="reference internal" href="glossary.html#term-Packages"><span class="xref std std-term">Packages</span></a>.</p>
<p>In Keypirinha, a package is a container that groups one or several plugins
designed to work together, as well as optional configuration files and
dependencies.</p>
<p>A package can take the form of a directory containing loose files, or a Zip
archive with the <code class="file docutils literal notranslate"><span class="pre">.keypirinha-package</span></code> extension (for redistribution).</p>
<p>Read more about <a class="reference internal" href="packages.html"><span class="doc">Packages Structure</span></a>.</p>
</div>
<div class="section" id="configuration">
<h2><span class="section-number">11.3. </span>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
<p>By design, to configure Keypirinha and its packages requires to edit
configuration files manually. There is no graphical interface to do that.
Keypirinha uses the <code class="docutils literal notranslate"><span class="pre">ini</span></code> file format to read, and it <strong>only reads</strong> its
configuration.</p>
<p>Read more about <a class="reference internal" href="configuration.html"><span class="doc">Configuration</span></a>.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="packages.html" class="btn btn-neutral float-right" title="12. Packages Structure" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="custom-catalog.html" class="btn btn-neutral float-left" title="10. Customize your Catalog" 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>