projects / github / shaarli / Shaarli.git / blame
| Commit | Line | Data |
|---|---|---|
| 992af0b9 V |
1 | <!DOCTYPE html> |
| 2 | <html> | |
| 3 | <head> | |
| 4 | <meta charset="utf-8"> | |
| 5 | <meta name="generator" content="pandoc"> | |
| 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> | |
| 7 | <title>Shaarli - Directory structure</title> | |
| 8 | <style type="text/css">code{white-space: pre;}</style> | |
| 9 | <!--[if lt IE 9]> | |
| 10 | <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> | |
| 11 | <![endif]--> | |
| 12 | <style type="text/css"> | |
| 13 | table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode { | |
| 14 | margin: 0; padding: 0; vertical-align: baseline; border: none; } | |
| 15 | table.sourceCode { width: 100%; line-height: 100%; } | |
| 16 | td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; } | |
| 17 | td.sourceCode { padding-left: 5px; } | |
| 18 | code > span.kw { color: #007020; font-weight: bold; } | |
| 19 | code > span.dt { color: #902000; } | |
| 20 | code > span.dv { color: #40a070; } | |
| 21 | code > span.bn { color: #40a070; } | |
| 22 | code > span.fl { color: #40a070; } | |
| 23 | code > span.ch { color: #4070a0; } | |
| 24 | code > span.st { color: #4070a0; } | |
| 25 | code > span.co { color: #60a0b0; font-style: italic; } | |
| 26 | code > span.ot { color: #007020; } | |
| 27 | code > span.al { color: #ff0000; font-weight: bold; } | |
| 28 | code > span.fu { color: #06287e; } | |
| 29 | code > span.er { color: #ff0000; font-weight: bold; } | |
| 30 | </style> | |
| 31 | <link rel="stylesheet" href="github-markdown.css"> | |
| 32 | </head> | |
| 33 | <body> | |
| 34 | <div id="local-sidebar"> | |
| 35 | <ul> | |
| 36 | <li><a href="Home.html">Home</a></li> | |
| 37 | <li>Installation | |
| 38 | <ul> | |
| 39 | <li><a href="Server-requirements.html">Server requirements</a></li> | |
| 40 | <li><a href="Server-configuration.html">Server configuration</a></li> | |
| 41 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> | |
| 42 | </ul></li> | |
| 43 | <li><a href="Usage.html">Usage</a> | |
| 44 | <ul> | |
| 45 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> | |
| 46 | <li><a href="Firefox-share.html">Firefox share</a></li> | |
| 47 | <li><a href="RSS-feeds.html">RSS feeds</a></li> | |
| 48 | </ul></li> | |
| 49 | <li>How To | |
| 50 | <ul> | |
| 51 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | |
| 52 | <li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> | |
| 53 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> | |
| 54 | </ul></li> | |
| 55 | <li><a href="Troubleshooting.html">Troubleshooting</a></li> | |
| 56 | <li><a href="Development.html">Development</a> | |
| 57 | <ul> | |
| 58 | <li><a href="GnuPG-signature.html">GnuPG signature</a></li> | |
| 59 | <li><a href="Coding-guidelines.html">Coding guidelines</a></li> | |
| 60 | <li><a href="Directory-structure.html">Directory structure</a></li> | |
| 61 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> | |
| 62 | <li><a href="Plugin-System.html">Plugin System</a></li> | |
| 63 | <li><a href="Security.html">Security</a></li> | |
| 64 | <li><a href="Static-analysis.html">Static analysis</a></li> | |
| 65 | <li><a href="Theming.html">Theming</a></li> | |
| 66 | <li><a href="Unit-tests.html">Unit tests</a></li> | |
| 67 | </ul></li> | |
| 68 | <li>About | |
| 69 | <ul> | |
| 70 | <li><a href="FAQ.html">FAQ</a></li> | |
| 71 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | |
| 72 | <li><a href="TODO.html">TODO</a></li> | |
| 73 | </ul></li> | |
| 74 | </ul> | |
| 75 | </div> | |
| 76 | <h1 id="directory-structure">Directory structure</h1> | |
| 77 | <p>Here is the directory structure of Shaarli and the purpose of the different files:</p> | |
| 78 | <pre class="sourceCode bash"><code class="sourceCode bash"> <span class="kw">index.php</span> <span class="co"># Main program</span> | |
| 79 | <span class="kw">application/</span> <span class="co"># Shaarli classes</span> | |
| 80 | ├── <span class="kw">LinkDB.php</span> | |
| 81 | └── <span class="kw">Utils.php</span> | |
| 82 | <span class="kw">tests/</span> <span class="co"># Shaarli unitary & functional tests</span> | |
| 83 | ├── <span class="kw">LinkDBTest.php</span> | |
| 84 | ├── <span class="kw">utils</span> <span class="co"># utilities to ease testing</span> | |
| 85 | │ └── <span class="kw">ReferenceLinkDB.php</span> | |
| 86 | └── <span class="kw">UtilsTest.php</span> | |
| 87 | <span class="kw">COPYING</span> <span class="co"># Shaarli license</span> | |
| 88 | <span class="kw">inc/</span> <span class="co"># static assets and 3rd party libraries</span> | |
| 89 | ├── <span class="kw">awesomplete.*</span> <span class="co"># tags autocompletion library</span> | |
| 90 | ├── <span class="kw">blazy.*</span> <span class="co"># picture wall lazy image loading library</span> | |
| 91 | ├── <span class="kw">shaarli.css</span>, reset.css <span class="co"># Shaarli stylesheet.</span> | |
| 92 | ├── <span class="kw">qr.*</span> <span class="co"># qr code generation library</span> | |
| 93 | └──<span class="kw">rain.tpl.class.php</span> <span class="co"># RainTPL templating library</span> | |
| 94 | <span class="kw">tpl/</span> <span class="co"># RainTPL templates for Shaarli. They are used to build the pages.</span> | |
| 95 | <span class="kw">images/</span> <span class="co"># Images and icons used in Shaarli</span> | |
| 96 | <span class="kw">data/</span> <span class="co"># data storage: bookmark database, configuration, logs, banlist…</span> | |
| 97 | ├── <span class="kw">config.php</span> <span class="co"># Shaarli configuration (login, password, timezone, title…)</span> | |
| 98 | ├── <span class="kw">datastore.php</span> <span class="co"># Your link database (compressed).</span> | |
| 99 | ├── <span class="kw">ipban.php</span> <span class="co"># IP address ban system data</span> | |
| 100 | ├── <span class="kw">lastupdatecheck.txt</span> <span class="co"># Update check timestamp file</span> | |
| 101 | └──<span class="kw">log.txt</span> <span class="co"># login/IPban log.</span> | |
| 102 | <span class="kw">cache/</span> <span class="co"># thumbnails cache</span> | |
| 103 | <span class="co"># This directory is automatically created. You can erase it anytime you want.</span> | |
| 104 | <span class="kw">tmp/</span> <span class="co"># Temporary directory for compiled RainTPL templates.</span> | |
| 105 | <span class="co"># This directory is automatically created. You can erase it anytime you want.</span></code></pre> | |
| 106 | </body> | |
| 107 | </html> |