diff options
Diffstat (limited to 'doc/html/Directory-structure')
-rw-r--r-- | doc/html/Directory-structure/index.html | 359 |
1 files changed, 359 insertions, 0 deletions
diff --git a/doc/html/Directory-structure/index.html b/doc/html/Directory-structure/index.html new file mode 100644 index 00000000..49f26ddb --- /dev/null +++ b/doc/html/Directory-structure/index.html | |||
@@ -0,0 +1,359 @@ | |||
1 | <!DOCTYPE html> | ||
2 | <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> | ||
3 | <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> | ||
4 | <head> | ||
5 | <meta charset="utf-8"> | ||
6 | <meta http-equiv="X-UA-Compatible" content="IE=edge"> | ||
7 | <meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
8 | |||
9 | |||
10 | <link rel="shortcut icon" href="../img/favicon.ico"> | ||
11 | <title>Directory structure - Shaarli Documentation</title> | ||
12 | <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'> | ||
13 | |||
14 | <link rel="stylesheet" href="../css/theme.css" type="text/css" /> | ||
15 | <link rel="stylesheet" href="../css/theme_extra.css" type="text/css" /> | ||
16 | <link rel="stylesheet" href="../css/highlight.css"> | ||
17 | <link href="../github-markdown.css" rel="stylesheet"> | ||
18 | |||
19 | <script> | ||
20 | // Current page data | ||
21 | var mkdocs_page_name = "Directory structure"; | ||
22 | var mkdocs_page_input_path = "Directory-structure.md"; | ||
23 | var mkdocs_page_url = "/Directory-structure/"; | ||
24 | </script> | ||
25 | |||
26 | <script src="../js/jquery-2.1.1.min.js"></script> | ||
27 | <script src="../js/modernizr-2.8.3.min.js"></script> | ||
28 | <script type="text/javascript" src="../js/highlight.pack.js"></script> | ||
29 | |||
30 | </head> | ||
31 | |||
32 | <body class="wy-body-for-nav" role="document"> | ||
33 | |||
34 | <div class="wy-grid-for-nav"> | ||
35 | |||
36 | |||
37 | <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> | ||
38 | <div class="wy-side-nav-search"> | ||
39 | <a href=".." class="icon icon-home"> Shaarli Documentation</a> | ||
40 | <div role="search"> | ||
41 | <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get"> | ||
42 | <input type="text" name="q" placeholder="Search docs" /> | ||
43 | </form> | ||
44 | </div> | ||
45 | </div> | ||
46 | |||
47 | <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> | ||
48 | <ul class="current"> | ||
49 | |||
50 | |||
51 | <li class="toctree-l1"> | ||
52 | |||
53 | <a class="" href="..">Home</a> | ||
54 | </li> | ||
55 | |||
56 | <li class="toctree-l1"> | ||
57 | |||
58 | <span class="caption-text">Setup</span> | ||
59 | <ul class="subnav"> | ||
60 | <li class=""> | ||
61 | |||
62 | <a class="" href="../Download-and-Installation/">Download and Installation</a> | ||
63 | </li> | ||
64 | <li class=""> | ||
65 | |||
66 | <a class="" href="../Upgrade-and-migration/">Upgrade and migration</a> | ||
67 | </li> | ||
68 | <li class=""> | ||
69 | |||
70 | <a class="" href="../Server-requirements/">Server requirements</a> | ||
71 | </li> | ||
72 | <li class=""> | ||
73 | |||
74 | <a class="" href="../Server-configuration/">Server configuration</a> | ||
75 | </li> | ||
76 | <li class=""> | ||
77 | |||
78 | <a class="" href="../Server-security/">Server security</a> | ||
79 | </li> | ||
80 | <li class=""> | ||
81 | |||
82 | <a class="" href="../Shaarli-configuration/">Shaarli configuration</a> | ||
83 | </li> | ||
84 | <li class=""> | ||
85 | |||
86 | <a class="" href="../Plugins/">Plugins</a> | ||
87 | </li> | ||
88 | </ul> | ||
89 | </li> | ||
90 | |||
91 | <li class="toctree-l1"> | ||
92 | |||
93 | <span class="caption-text">Docker</span> | ||
94 | <ul class="subnav"> | ||
95 | <li class=""> | ||
96 | |||
97 | <a class="" href="../docker/docker-101/">Docker 101</a> | ||
98 | </li> | ||
99 | <li class=""> | ||
100 | |||
101 | <a class="" href="../docker/shaarli-images/">Shaarli images</a> | ||
102 | </li> | ||
103 | <li class=""> | ||
104 | |||
105 | <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a> | ||
106 | </li> | ||
107 | <li class=""> | ||
108 | |||
109 | <a class="" href="../docker/resources/">Docker resources</a> | ||
110 | </li> | ||
111 | </ul> | ||
112 | </li> | ||
113 | |||
114 | <li class="toctree-l1"> | ||
115 | |||
116 | <span class="caption-text">Usage</span> | ||
117 | <ul class="subnav"> | ||
118 | <li class=""> | ||
119 | |||
120 | <a class="" href="../Features/">Features</a> | ||
121 | </li> | ||
122 | <li class=""> | ||
123 | |||
124 | <a class="" href="../Bookmarklet/">Bookmarklet</a> | ||
125 | </li> | ||
126 | <li class=""> | ||
127 | |||
128 | <a class="" href="../Browsing-and-searching/">Browsing and searching</a> | ||
129 | </li> | ||
130 | <li class=""> | ||
131 | |||
132 | <a class="" href="../Firefox-share/">Firefox share</a> | ||
133 | </li> | ||
134 | <li class=""> | ||
135 | |||
136 | <a class="" href="../RSS-feeds/">RSS feeds</a> | ||
137 | </li> | ||
138 | <li class=""> | ||
139 | |||
140 | <a class="" href="../REST-API/">REST API</a> | ||
141 | </li> | ||
142 | </ul> | ||
143 | </li> | ||
144 | |||
145 | <li class="toctree-l1"> | ||
146 | |||
147 | <span class="caption-text">How To</span> | ||
148 | <ul class="subnav"> | ||
149 | <li class=""> | ||
150 | |||
151 | <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a> | ||
152 | </li> | ||
153 | <li class=""> | ||
154 | |||
155 | <a class="" href="../Various-hacks/">Various hacks</a> | ||
156 | </li> | ||
157 | </ul> | ||
158 | </li> | ||
159 | |||
160 | <li class="toctree-l1"> | ||
161 | |||
162 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
163 | </li> | ||
164 | |||
165 | <li class="toctree-l1"> | ||
166 | |||
167 | <span class="caption-text">Development</span> | ||
168 | <ul class="subnav"> | ||
169 | <li class=""> | ||
170 | |||
171 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
172 | </li> | ||
173 | <li class=""> | ||
174 | |||
175 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
176 | </li> | ||
177 | <li class=""> | ||
178 | |||
179 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
180 | </li> | ||
181 | <li class=""> | ||
182 | |||
183 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
184 | </li> | ||
185 | <li class=" current"> | ||
186 | |||
187 | <a class="current" href="./">Directory structure</a> | ||
188 | <ul class="subnav"> | ||
189 | |||
190 | </ul> | ||
191 | </li> | ||
192 | <li class=""> | ||
193 | |||
194 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
195 | </li> | ||
196 | <li class=""> | ||
197 | |||
198 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
199 | </li> | ||
200 | <li class=""> | ||
201 | |||
202 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
203 | </li> | ||
204 | <li class=""> | ||
205 | |||
206 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
207 | </li> | ||
208 | <li class=""> | ||
209 | |||
210 | <a class="" href="../Security/">Security</a> | ||
211 | </li> | ||
212 | <li class=""> | ||
213 | |||
214 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
215 | </li> | ||
216 | <li class=""> | ||
217 | |||
218 | <a class="" href="../Theming/">Theming</a> | ||
219 | </li> | ||
220 | <li class=""> | ||
221 | |||
222 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
223 | </li> | ||
224 | </ul> | ||
225 | </li> | ||
226 | |||
227 | <li class="toctree-l1"> | ||
228 | |||
229 | <span class="caption-text">About</span> | ||
230 | <ul class="subnav"> | ||
231 | <li class=""> | ||
232 | |||
233 | <a class="" href="../FAQ/">FAQ</a> | ||
234 | </li> | ||
235 | <li class=""> | ||
236 | |||
237 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
238 | </li> | ||
239 | </ul> | ||
240 | </li> | ||
241 | |||
242 | </ul> | ||
243 | </div> | ||
244 | | ||
245 | </nav> | ||
246 | |||
247 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
248 | |||
249 | |||
250 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
251 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
252 | <a href="..">Shaarli Documentation</a> | ||
253 | </nav> | ||
254 | |||
255 | |||
256 | <div class="wy-nav-content"> | ||
257 | <div class="rst-content"> | ||
258 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
259 | <ul class="wy-breadcrumbs"> | ||
260 | <li><a href="..">Docs</a> »</li> | ||
261 | |||
262 | |||
263 | |||
264 | <li>Development »</li> | ||
265 | |||
266 | |||
267 | |||
268 | <li>Directory structure</li> | ||
269 | <li class="wy-breadcrumbs-aside"> | ||
270 | |||
271 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Directory-structure.md" | ||
272 | class="icon icon-github"> Edit on GitHub</a> | ||
273 | |||
274 | </li> | ||
275 | </ul> | ||
276 | <hr/> | ||
277 | </div> | ||
278 | <div role="main"> | ||
279 | <div class="section"> | ||
280 | |||
281 | <p>Here is the directory structure of Shaarli and the purpose of the different files:</p> | ||
282 | <pre><code class="bash"> index.php # Main program | ||
283 | application/ # Shaarli classes | ||
284 | ├── LinkDB.php | ||
285 | └── Utils.php | ||
286 | tests/ # Shaarli unitary & functional tests | ||
287 | ├── LinkDBTest.php | ||
288 | ├── utils # utilities to ease testing | ||
289 | │ └── ReferenceLinkDB.php | ||
290 | └── UtilsTest.php | ||
291 | COPYING # Shaarli license | ||
292 | inc/ # static assets and 3rd party libraries | ||
293 | ├── awesomplete.* # tags autocompletion library | ||
294 | ├── blazy.* # picture wall lazy image loading library | ||
295 | ├── shaarli.css, reset.css # Shaarli stylesheet. | ||
296 | ├── qr.* # qr code generation library | ||
297 | └──rain.tpl.class.php # RainTPL templating library | ||
298 | tpl/ # RainTPL templates for Shaarli. They are used to build the pages. | ||
299 | images/ # Images and icons used in Shaarli | ||
300 | data/ # data storage: bookmark database, configuration, logs, banlist… | ||
301 | ├── config.php # Shaarli configuration (login, password, timezone, title…) | ||
302 | ├── datastore.php # Your link database (compressed). | ||
303 | ├── ipban.php # IP address ban system data | ||
304 | ├── lastupdatecheck.txt # Update check timestamp file | ||
305 | └──log.txt # login/IPban log. | ||
306 | cache/ # thumbnails cache | ||
307 | # This directory is automatically created. You can erase it anytime you want. | ||
308 | tmp/ # Temporary directory for compiled RainTPL templates. | ||
309 | # This directory is automatically created. You can erase it anytime you want. | ||
310 | </code></pre> | ||
311 | |||
312 | </div> | ||
313 | </div> | ||
314 | <footer> | ||
315 | |||
316 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
317 | |||
318 | <a href="../3rd-party-libraries/" class="btn btn-neutral float-right" title="3rd party libraries">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
319 | |||
320 | |||
321 | <a href="../Coding-guidelines/" class="btn btn-neutral" title="Coding guidelines"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
322 | |||
323 | </div> | ||
324 | |||
325 | |||
326 | <hr/> | ||
327 | |||
328 | <div role="contentinfo"> | ||
329 | <!-- Copyright etc --> | ||
330 | |||
331 | </div> | ||
332 | |||
333 | Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. | ||
334 | </footer> | ||
335 | |||
336 | </div> | ||
337 | </div> | ||
338 | |||
339 | </section> | ||
340 | |||
341 | </div> | ||
342 | |||
343 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
344 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
345 | |||
346 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
347 | |||
348 | |||
349 | <span><a href="../Coding-guidelines/" style="color: #fcfcfc;">« Previous</a></span> | ||
350 | |||
351 | |||
352 | <span style="margin-left: 15px"><a href="../3rd-party-libraries/" style="color: #fcfcfc">Next »</a></span> | ||
353 | |||
354 | </span> | ||
355 | </div> | ||
356 | <script src="../js/theme.js"></script> | ||
357 | |||
358 | </body> | ||
359 | </html> | ||