doc/Directory-structure.html

   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   <style type="text/css">
  10 div.sourceCode { overflow-x: auto; }
  11 table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
  12   margin: 0; padding: 0; vertical-align: baseline; border: none; }
  13 table.sourceCode { width: 100%; line-height: 100%; }
  14 td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
  15 td.sourceCode { padding-left: 5px; }
  16 code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
  17 code > span.dt { color: #902000; } /* DataType */
  18 code > span.dv { color: #40a070; } /* DecVal */
  19 code > span.bn { color: #40a070; } /* BaseN */
  20 code > span.fl { color: #40a070; } /* Float */
  21 code > span.ch { color: #4070a0; } /* Char */
  22 code > span.st { color: #4070a0; } /* String */
  23 code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
  24 code > span.ot { color: #007020; } /* Other */
  25 code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
  26 code > span.fu { color: #06287e; } /* Function */
  27 code > span.er { color: #ff0000; font-weight: bold; } /* Error */
  28 code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
  29 code > span.cn { color: #880000; } /* Constant */
  30 code > span.sc { color: #4070a0; } /* SpecialChar */
  31 code > span.vs { color: #4070a0; } /* VerbatimString */
  32 code > span.ss { color: #bb6688; } /* SpecialString */
  33 code > span.im { } /* Import */
  34 code > span.va { color: #19177c; } /* Variable */
  35 code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
  36 code > span.op { color: #666666; } /* Operator */
  37 code > span.bu { } /* BuiltIn */
  38 code > span.ex { } /* Extension */
  39 code > span.pp { color: #bc7a00; } /* Preprocessor */
  40 code > span.at { color: #7d9029; } /* Attribute */
  41 code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
  42 code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
  43 code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
  44 code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
  45   </style>
  46   <link rel="stylesheet" href="github-markdown.css">
  47   <!--[if lt IE 9]>
  48     <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
  49   <![endif]-->
  50 </head>
  51 <body>
  52 <div id="local-sidebar">
  53 <ul>
  54 <li><a href="Home.html">Home</a></li>
  55 <li>Installation
  56 <ul>
  57 <li><a href="Download.html">Download</a></li>
  58 <li><a href="Server-requirements.html">Server requirements</a></li>
  59 <li><a href="Server-configuration.html">Server configuration</a></li>
  60 <li><a href="Server-security.html">Server security</a></li>
  61 <li><a href="Shaarli-installation.html">Shaarli installation</a></li>
  62 <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
  63 <li><a href="Plugins.html">Plugins</a></li>
  64 </ul></li>
  65 <li><a href="Docker.html">Docker</a></li>
  66 <li><a href="Usage.html">Usage</a>
  67 <ul>
  68 <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</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>
  71 <li><a href="RSS-feeds.html">RSS feeds</a></li>
  72 </ul></li>
  73 <li>How To
  74 <ul>
  75 <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
  76 <li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
  77 <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>
  78 <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
  79 <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
  80 <li><a href="Datastore-hacks.html">Datastore hacks</a></li>
  81 </ul></li>
  82 <li><a href="Troubleshooting.html">Troubleshooting</a></li>
  83 <li><a href="Development.html">Development</a>
  84 <ul>
  85 <li><a href="GnuPG-signature.html">GnuPG signature</a></li>
  86 <li><a href="Coding-guidelines.html">Coding guidelines</a></li>
  87 <li><a href="Directory-structure.html">Directory structure</a></li>
  88 <li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
  89 <li><a href="Plugin-System.html">Plugin System</a></li>
  90 <li><a href="Release-Shaarli.html">Release Shaarli</a></li>
  91 <li><a href="Security.html">Security</a></li>
  92 <li><a href="Static-analysis.html">Static analysis</a></li>
  93 <li><a href="Theming.html">Theming</a></li>
  94 <li><a href="Unit-tests.html">Unit tests</a></li>
  95 </ul></li>
  96 <li>About
  97 <ul>
  98 <li><a href="FAQ.html">FAQ</a></li>
  99 <li><a href="Community-&amp;-Related-software.html">Community &amp; Related software</a></li>
 100 <li><a href="TODO.html">TODO</a></li>
 101 </ul></li>
 102 </ul>
 103 </div>
 104 <h1 id="directory-structure">Directory structure</h1>
 105 <p>Here is the directory structure of Shaarli and the purpose of the different files:</p>
 106 <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">    <span class="kw">index.php</span>        <span class="co"># Main program</span>
 107     <span class="kw">application/</span>     <span class="co"># Shaarli classes</span>
 108         ├── <span class="kw">LinkDB.php</span>
 109         └── <span class="kw">Utils.php</span>
 110     <span class="kw">tests/</span>       <span class="co"># Shaarli unitary &amp; functional tests</span>
 111         ├── <span class="kw">LinkDBTest.php</span>
 112         ├── <span class="kw">utils</span>  <span class="co"># utilities to ease testing</span>
 113         │   └── <span class="kw">ReferenceLinkDB.php</span>
 114         └── <span class="kw">UtilsTest.php</span>
 115     <span class="kw">COPYING</span>          <span class="co"># Shaarli license</span>
 116     <span class="kw">inc/</span>             <span class="co"># static assets and 3rd party libraries</span>
 117         ├── <span class="kw">awesomplete.*</span>          <span class="co"># tags autocompletion library</span>
 118         ├── <span class="kw">blazy.*</span>                <span class="co"># picture wall lazy image loading library</span>
 119         ├── <span class="kw">shaarli.css</span>, reset.css <span class="co"># Shaarli stylesheet.</span>
 120         ├── <span class="kw">qr.*</span>                   <span class="co"># qr code generation library</span>
 121         └──<span class="kw">rain.tpl.class.php</span>      <span class="co"># RainTPL templating library</span>
 122     <span class="kw">tpl/</span>             <span class="co"># RainTPL templates for Shaarli. They are used to build the pages.</span>
 123     <span class="kw">images/</span>          <span class="co"># Images and icons used in Shaarli</span>
 124     <span class="kw">data/</span>            <span class="co"># data storage: bookmark database, configuration, logs, banlist…</span>
 125         ├── <span class="kw">config.php</span>             <span class="co"># Shaarli configuration (login, password, timezone, title…)</span>
 126         ├── <span class="kw">datastore.php</span>          <span class="co"># Your link database (compressed).</span>
 127         ├── <span class="kw">ipban.php</span>              <span class="co"># IP address ban system data</span>
 128         ├── <span class="kw">lastupdatecheck.txt</span>    <span class="co"># Update check timestamp file</span>
 129         └──<span class="kw">log.txt</span>                 <span class="co"># login/IPban log.</span>
 130     <span class="kw">cache/</span>           <span class="co"># thumbnails cache</span>
 131                      <span class="co"># This directory is automatically created. You can erase it anytime you want.</span>
 132     <span class="kw">tmp/</span>             <span class="co"># Temporary directory for compiled RainTPL templates.</span>
 133                      <span class="co"># This directory is automatically created. You can erase it anytime you want.</span></code></pre></div>
 134 </body>
 135 </html>