diff options
Diffstat (limited to 'doc/Directory-structure.html')
| -rw-r--r-- | doc/Directory-structure.html | 42 |
1 files changed, 22 insertions, 20 deletions
diff --git a/doc/Directory-structure.html b/doc/Directory-structure.html index 404ff7c8..3f75db8e 100644 --- a/doc/Directory-structure.html +++ b/doc/Directory-structure.html | |||
| @@ -69,6 +69,7 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf | |||
| 69 | <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li> | 69 | <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li> |
| 70 | <li><a href="Firefox-share.html">Firefox share</a></li> | 70 | <li><a href="Firefox-share.html">Firefox share</a></li> |
| 71 | <li><a href="RSS-feeds.html">RSS feeds</a></li> | 71 | <li><a href="RSS-feeds.html">RSS feeds</a></li> |
| 72 | <li><a href="REST-API.html">REST API</a></li> | ||
| 72 | </ul></li> | 73 | </ul></li> |
| 73 | <li>How To | 74 | <li>How To |
| 74 | <ul> | 75 | <ul> |
| @@ -87,6 +88,7 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf | |||
| 87 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> | 88 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> |
| 88 | <li><a href="Plugin-System.html">Plugin System</a></li> | 89 | <li><a href="Plugin-System.html">Plugin System</a></li> |
| 89 | <li><a href="Release-Shaarli.html">Release Shaarli</a></li> | 90 | <li><a href="Release-Shaarli.html">Release Shaarli</a></li> |
| 91 | <li><a href="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 90 | <li><a href="Security.html">Security</a></li> | 92 | <li><a href="Security.html">Security</a></li> |
| 91 | <li><a href="Static-analysis.html">Static analysis</a></li> | 93 | <li><a href="Static-analysis.html">Static analysis</a></li> |
| 92 | <li><a href="Theming.html">Theming</a></li> | 94 | <li><a href="Theming.html">Theming</a></li> |
| @@ -101,33 +103,33 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf | |||
| 101 | </div> | 103 | </div> |
| 102 | <h1 id="directory-structure">Directory structure</h1> | 104 | <h1 id="directory-structure">Directory structure</h1> |
| 103 | <p>Here is the directory structure of Shaarli and the purpose of the different files:</p> | 105 | <p>Here is the directory structure of Shaarli and the purpose of the different files:</p> |
| 104 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"> <span class="ex">index.php</span> <span class="co"># Main program</span> | 106 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"> <span class="ex">index.php</span> # Main program |
| 105 | <span class="ex">application/</span> <span class="co"># Shaarli classes</span> | 107 | <span class="ex">application/</span> # Shaarli classes |
| 106 | ├── <span class="ex">LinkDB.php</span> | 108 | ├── <span class="ex">LinkDB.php</span> |
| 107 | └── <span class="ex">Utils.php</span> | 109 | └── <span class="ex">Utils.php</span> |
| 108 | <span class="ex">tests/</span> <span class="co"># Shaarli unitary & functional tests</span> | 110 | <span class="ex">tests/</span> # Shaarli unitary <span class="kw">&</span> <span class="ex">functional</span> tests |
| 109 | ├── <span class="ex">LinkDBTest.php</span> | 111 | ├── <span class="ex">LinkDBTest.php</span> |
| 110 | ├── <span class="ex">utils</span> <span class="co"># utilities to ease testing</span> | 112 | ├── <span class="ex">utils</span> # utilities to ease testing |
| 111 | │ └── <span class="ex">ReferenceLinkDB.php</span> | 113 | │ └── <span class="ex">ReferenceLinkDB.php</span> |
| 112 | └── <span class="ex">UtilsTest.php</span> | 114 | └── <span class="ex">UtilsTest.php</span> |
| 113 | <span class="ex">COPYING</span> <span class="co"># Shaarli license</span> | 115 | <span class="ex">COPYING</span> # Shaarli license |
| 114 | <span class="ex">inc/</span> <span class="co"># static assets and 3rd party libraries</span> | 116 | <span class="ex">inc/</span> # static assets and 3rd party libraries |
| 115 | ├── <span class="ex">awesomplete.*</span> <span class="co"># tags autocompletion library</span> | 117 | ├── <span class="ex">awesomplete.*</span> # tags autocompletion library |
| 116 | ├── <span class="ex">blazy.*</span> <span class="co"># picture wall lazy image loading library</span> | 118 | ├── <span class="ex">blazy.*</span> # picture wall lazy image loading library |
| 117 | ├── <span class="ex">shaarli.css</span>, reset.css <span class="co"># Shaarli stylesheet.</span> | 119 | ├── <span class="ex">shaarli.css</span>, reset.css <span class="co"># Shaarli stylesheet.</span> |
| 118 | ├── <span class="ex">qr.*</span> <span class="co"># qr code generation library</span> | 120 | ├── <span class="ex">qr.*</span> # qr code generation library |
| 119 | └──<span class="ex">rain.tpl.class.php</span> <span class="co"># RainTPL templating library</span> | 121 | └──<span class="ex">rain.tpl.class.php</span> # RainTPL templating library |
| 120 | <span class="ex">tpl/</span> <span class="co"># RainTPL templates for Shaarli. They are used to build the pages.</span> | 122 | <span class="ex">tpl/</span> # RainTPL templates for Shaarli. They are used to build the pages. |
| 121 | <span class="ex">images/</span> <span class="co"># Images and icons used in Shaarli</span> | 123 | <span class="ex">images/</span> # Images and icons used in Shaarli |
| 122 | <span class="ex">data/</span> <span class="co"># data storage: bookmark database, configuration, logs, banlist…</span> | 124 | <span class="ex">data/</span> # data storage: bookmark database, configuration, logs, banlist… |
| 123 | ├── <span class="ex">config.php</span> <span class="co"># Shaarli configuration (login, password, timezone, title…)</span> | 125 | ├── <span class="ex">config.php</span> # Shaarli configuration (login, password, timezone, title…) |
| 124 | ├── <span class="ex">datastore.php</span> <span class="co"># Your link database (compressed).</span> | 126 | ├── <span class="ex">datastore.php</span> # Your link database (compressed)<span class="ex">.</span> |
| 125 | ├── <span class="ex">ipban.php</span> <span class="co"># IP address ban system data</span> | 127 | ├── <span class="ex">ipban.php</span> # IP address ban system data |
| 126 | ├── <span class="ex">lastupdatecheck.txt</span> <span class="co"># Update check timestamp file</span> | 128 | ├── <span class="ex">lastupdatecheck.txt</span> # Update check timestamp file |
| 127 | └──<span class="ex">log.txt</span> <span class="co"># login/IPban log.</span> | 129 | └──<span class="ex">log.txt</span> # login/IPban log. |
| 128 | <span class="ex">cache/</span> <span class="co"># thumbnails cache</span> | 130 | <span class="ex">cache/</span> # thumbnails cache |
| 129 | <span class="co"># This directory is automatically created. You can erase it anytime you want.</span> | 131 | <span class="co"># This directory is automatically created. You can erase it anytime you want.</span> |
| 130 | <span class="ex">tmp/</span> <span class="co"># Temporary directory for compiled RainTPL templates.</span> | 132 | <span class="ex">tmp/</span> # Temporary directory for compiled RainTPL templates. |
| 131 | <span class="co"># This directory is automatically created. You can erase it anytime you want.</span></code></pre></div> | 133 | <span class="co"># This directory is automatically created. You can erase it anytime you want.</span></code></pre></div> |
| 132 | </body> | 134 | </body> |
| 133 | </html> | 135 | </html> |