diff options
Diffstat (limited to 'doc/Theming.html')
-rw-r--r-- | doc/Theming.html | 73 |
1 files changed, 50 insertions, 23 deletions
diff --git a/doc/Theming.html b/doc/Theming.html index a751eb98..1eda52e4 100644 --- a/doc/Theming.html +++ b/doc/Theming.html | |||
@@ -4,31 +4,49 @@ | |||
4 | <meta charset="utf-8"> | 4 | <meta charset="utf-8"> |
5 | <meta name="generator" content="pandoc"> | 5 | <meta name="generator" content="pandoc"> |
6 | <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> | 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> |
7 | <title>Shaarli - Theming</title> | 7 | <title>Shaarli – Theming</title> |
8 | <style type="text/css">code{white-space: pre;}</style> | 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"> | 9 | <style type="text/css"> |
10 | div.sourceCode { overflow-x: auto; } | ||
13 | table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode { | 11 | table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode { |
14 | margin: 0; padding: 0; vertical-align: baseline; border: none; } | 12 | margin: 0; padding: 0; vertical-align: baseline; border: none; } |
15 | table.sourceCode { width: 100%; line-height: 100%; } | 13 | 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; } | 14 | td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; } |
17 | td.sourceCode { padding-left: 5px; } | 15 | td.sourceCode { padding-left: 5px; } |
18 | code > span.kw { color: #007020; font-weight: bold; } | 16 | code > span.kw { color: #007020; font-weight: bold; } /* Keyword */ |
19 | code > span.dt { color: #902000; } | 17 | code > span.dt { color: #902000; } /* DataType */ |
20 | code > span.dv { color: #40a070; } | 18 | code > span.dv { color: #40a070; } /* DecVal */ |
21 | code > span.bn { color: #40a070; } | 19 | code > span.bn { color: #40a070; } /* BaseN */ |
22 | code > span.fl { color: #40a070; } | 20 | code > span.fl { color: #40a070; } /* Float */ |
23 | code > span.ch { color: #4070a0; } | 21 | code > span.ch { color: #4070a0; } /* Char */ |
24 | code > span.st { color: #4070a0; } | 22 | code > span.st { color: #4070a0; } /* String */ |
25 | code > span.co { color: #60a0b0; font-style: italic; } | 23 | code > span.co { color: #60a0b0; font-style: italic; } /* Comment */ |
26 | code > span.ot { color: #007020; } | 24 | code > span.ot { color: #007020; } /* Other */ |
27 | code > span.al { color: #ff0000; font-weight: bold; } | 25 | code > span.al { color: #ff0000; font-weight: bold; } /* Alert */ |
28 | code > span.fu { color: #06287e; } | 26 | code > span.fu { color: #06287e; } /* Function */ |
29 | code > span.er { color: #ff0000; font-weight: bold; } | 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 */ | ||
30 | </style> | 45 | </style> |
31 | <link rel="stylesheet" href="github-markdown.css"> | 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]--> | ||
32 | </head> | 50 | </head> |
33 | <body> | 51 | <body> |
34 | <div id="local-sidebar"> | 52 | <div id="local-sidebar"> |
@@ -39,18 +57,26 @@ code > span.er { color: #ff0000; font-weight: bold; } | |||
39 | <li><a href="Download.html">Download</a></li> | 57 | <li><a href="Download.html">Download</a></li> |
40 | <li><a href="Server-requirements.html">Server requirements</a></li> | 58 | <li><a href="Server-requirements.html">Server requirements</a></li> |
41 | <li><a href="Server-configuration.html">Server configuration</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> | ||
42 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> | 62 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> |
63 | <li><a href="Plugin-installation-&-configuration.html">Plugin installation & configuration</a></li> | ||
43 | </ul></li> | 64 | </ul></li> |
65 | <li><a href="Docker.html">Docker</a></li> | ||
66 | <li><a href="Plugin-list.html">Plugin list</a></li> | ||
44 | <li><a href="Usage.html">Usage</a> | 67 | <li><a href="Usage.html">Usage</a> |
45 | <ul> | 68 | <ul> |
46 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> | 69 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> |
70 | <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li> | ||
47 | <li><a href="Firefox-share.html">Firefox share</a></li> | 71 | <li><a href="Firefox-share.html">Firefox share</a></li> |
48 | <li><a href="RSS-feeds.html">RSS feeds</a></li> | 72 | <li><a href="RSS-feeds.html">RSS feeds</a></li> |
49 | </ul></li> | 73 | </ul></li> |
50 | <li>How To | 74 | <li>How To |
51 | <ul> | 75 | <ul> |
52 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | 76 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> |
77 | <li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li> | ||
53 | <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="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> |
79 | <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li> | ||
54 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> | 80 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> |
55 | <li><a href="Datastore-hacks.html">Datastore hacks</a></li> | 81 | <li><a href="Datastore-hacks.html">Datastore hacks</a></li> |
56 | </ul></li> | 82 | </ul></li> |
@@ -62,6 +88,7 @@ code > span.er { color: #ff0000; font-weight: bold; } | |||
62 | <li><a href="Directory-structure.html">Directory structure</a></li> | 88 | <li><a href="Directory-structure.html">Directory structure</a></li> |
63 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> | 89 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> |
64 | <li><a href="Plugin-System.html">Plugin System</a></li> | 90 | <li><a href="Plugin-System.html">Plugin System</a></li> |
91 | <li><a href="Release-Shaarli.html">Release Shaarli</a></li> | ||
65 | <li><a href="Security.html">Security</a></li> | 92 | <li><a href="Security.html">Security</a></li> |
66 | <li><a href="Static-analysis.html">Static analysis</a></li> | 93 | <li><a href="Static-analysis.html">Static analysis</a></li> |
67 | <li><a href="Theming.html">Theming</a></li> | 94 | <li><a href="Theming.html">Theming</a></li> |
@@ -89,14 +116,14 @@ code > span.er { color: #ff0000; font-weight: bold; } | |||
89 | <h2 id="raintpl-template">RainTPL template</h2> | 116 | <h2 id="raintpl-template">RainTPL template</h2> |
90 | <p><em>WARNING - This feature is currently being worked on and will be improved in the next releases. Experimental.</em></p> | 117 | <p><em>WARNING - This feature is currently being worked on and will be improved in the next releases. Experimental.</em></p> |
91 | <ul> | 118 | <ul> |
92 | <li>Find the template you'd like to install (see the list of <a href="available-templates|Theming#community-themes--templates.html">available templates|Theming#community-themes--templates</a>)</li> | 119 | <li>Find the template you'd like to install (see the list of <a href="available-templates%7CTheming#community-themes--templates.html">available templates|Theming#community-themes--templates</a>)</li> |
93 | <li>Find it's git clone URL or download the zip archive for the template.</li> | 120 | <li>Find it's git clone URL or download the zip archive for the template.</li> |
94 | <li>In your Shaarli <code>tpl/</code> directory, run <code>git clone https://url/of/my-template/</code> or unpack the zip archive. | 121 | <li>In your Shaarli <code>tpl/</code> directory, run <code>git clone https://url/of/my-template/</code> or unpack the zip archive. |
95 | <ul> | 122 | <ul> |
96 | <li>There should now be a <code>my-template/</code> directory under the <code>tpl/</code> dir, containing directly all the template files.</li> | 123 | <li>There should now be a <code>my-template/</code> directory under the <code>tpl/</code> dir, containing directly all the template files.</li> |
97 | </ul></li> | 124 | </ul></li> |
98 | <li><p>Edit <code>data/config.php</code> to have Shaarli use this template, e.g.</p> | 125 | <li><p>Edit <code>data/config.php</code> to have Shaarli use this template, e.g.</p> |
99 | <pre class="sourceCode php"><code class="sourceCode php"><span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'RAINTPL_TPL'</span><span class="ot">]</span> = <span class="st">'tpl/my-template/'</span><span class="ot">;](</span><span class="st">'RAINTPL_TPL'</span><span class="ot">]</span>-=-<span class="st">'tpl/my-template/'</span><span class="ot">;</span>.html<span class="ot">)</span></code></pre></li> | 126 | <div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php"><span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'RAINTPL_TPL'</span><span class="ot">]</span> = <span class="st">'tpl/my-template/'</span><span class="ot">;](</span><span class="st">'RAINTPL_TPL'</span><span class="ot">]</span>-=-<span class="st">'tpl/my-template/'</span><span class="ot">;</span>.html<span class="ot">)</span></code></pre></div></li> |
100 | </ul> | 127 | </ul> |
101 | <h2 id="community-themes-templates">Community themes & templates</h2> | 128 | <h2 id="community-themes-templates">Community themes & templates</h2> |
102 | <ul> | 129 | <ul> |
@@ -116,7 +143,7 @@ code > span.er { color: #ff0000; font-weight: bold; } | |||
116 | <li>user sites are enabled, e.g. <code>/home/user/public_html/somedir</code> is served as <code>http://localhost/~user/somedir</code></li> | 143 | <li>user sites are enabled, e.g. <code>/home/user/public_html/somedir</code> is served as <code>http://localhost/~user/somedir</code></li> |
117 | <li><code>http</code> is the name of the Apache user</li> | 144 | <li><code>http</code> is the name of the Apache user</li> |
118 | </ul> | 145 | </ul> |
119 | <pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">cd</span> ~/public_html | 146 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">cd</span> ~/public_html |
120 | 147 | ||
121 | <span class="co"># clone repositories</span> | 148 | <span class="co"># clone repositories</span> |
122 | $ <span class="kw">git</span> clone https://github.com/shaarli/Shaarli.git shaarli | 149 | $ <span class="kw">git</span> clone https://github.com/shaarli/Shaarli.git shaarli |
@@ -126,15 +153,15 @@ $ <span class="kw">popd</span> | |||
126 | 153 | ||
127 | <span class="co"># set access rights for Apache</span> | 154 | <span class="co"># set access rights for Apache</span> |
128 | $ <span class="kw">chgrp</span> -R http shaarli | 155 | $ <span class="kw">chgrp</span> -R http shaarli |
129 | $ <span class="kw">chmod</span> g+rwx shaarli shaarli/cache shaarli/data shaarli/pagecache shaarli/tmp</code></pre> | 156 | $ <span class="kw">chmod</span> g+rwx shaarli shaarli/cache shaarli/data shaarli/pagecache shaarli/tmp</code></pre></div> |
130 | <p>Get config written:</p> | 157 | <p>Get config written:</p> |
131 | <ul> | 158 | <ul> |
132 | <li>go to the freshly installed site</li> | 159 | <li>go to the freshly installed site</li> |
133 | <li>fill the install form</li> | 160 | <li>fill the install form</li> |
134 | <li>log in to Shaarli</li> | 161 | <li>log in to Shaarli</li> |
135 | </ul> | 162 | </ul> |
136 | <p>Edit Shaarli's <a href="configuration|Shaarli-configuration.html">configuration|Shaarli configuration</a>:</p> | 163 | <p>Edit Shaarli's <a href="configuration%7CShaarli-configuration.html">configuration|Shaarli configuration</a>:</p> |
137 | <pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># the file should be owned by Apache, thus not writeable => sudo</span> | 164 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># the file should be owned by Apache, thus not writeable => sudo</span> |
138 | $ <span class="kw">sudo</span> sed -i s=tpl=tpl/albinomouse-template=g shaarli/data/config.php</code></pre> | 165 | $ <span class="kw">sudo</span> sed -i s=tpl=tpl/albinomouse-template=g shaarli/data/config.php</code></pre></div> |
139 | </body> | 166 | </body> |
140 | </html> | 167 | </html> |