diff options
| author | nodiscc <nodiscc@gmail.com> | 2017-01-26 18:52:54 +0100 |
|---|---|---|
| committer | nodiscc <nodiscc@gmail.com> | 2017-06-18 00:19:49 +0200 |
| commit | 53ed6d7d1e678d7486337ce67a2f17b30bac21ac (patch) | |
| tree | f8bef0164a70bd03d2b9781951c01bdd018f1842 | |
| parent | d5d22a6d07917865c44148ad76f43c65a929a890 (diff) | |
| download | Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.gz Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.zst Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.zip | |
Generate HTML documentation using MkDocs (WIP)
MkDocs is a static site generator geared towards building project documentation.
Documentation source files are written in Markdown, and configured with a single YAML file.
* http://www.mkdocs.org/
* http://www.mkdocs.org/user-guide/configuration/
Ref. #312
* remove pandoc-generated HTML documentation
* move markdown doc to doc/md/,
* mkdocs.yml:
* generate HTML doc in doc/html
* add pages TOC/ordering
* use index.md as index page
* Makefile: remove execute permissions from generated files
* Makefile: rewrite htmlpages GFM to markdown conversion using sed:
awk expression aslo matched '][' which causes invalid output on complex links with images or code blocks
* Add mkdocs.yml to .gitattributes, exclude this file from release archives
* Makefile: rename: htmldoc -> doc_html target
* run make doc: pull latest markdown documentation from wiki
* run make htmlpages: update html documentation
162 files changed, 22127 insertions, 7136 deletions
diff --git a/.gitattributes b/.gitattributes index 82f37602..dd0e573c 100644 --- a/.gitattributes +++ b/.gitattributes | |||
| @@ -33,5 +33,6 @@ doc/**/*.md export-ignore | |||
| 33 | docker/ export-ignore | 33 | docker/ export-ignore |
| 34 | Doxyfile export-ignore | 34 | Doxyfile export-ignore |
| 35 | Makefile export-ignore | 35 | Makefile export-ignore |
| 36 | mkdocs.yml export-ignore | ||
| 36 | phpunit.xml export-ignore | 37 | phpunit.xml export-ignore |
| 37 | tests/ export-ignore | 38 | tests/ export-ignore |
| @@ -194,42 +194,28 @@ doxygen: clean | |||
| 194 | 194 | ||
| 195 | ### update the local copy of the documentation | 195 | ### update the local copy of the documentation |
| 196 | doc: clean | 196 | doc: clean |
| 197 | @rm -rf doc | 197 | @rm -rf doc/md/ |
| 198 | @git clone https://github.com/shaarli/Shaarli.wiki.git doc | 198 | @git clone https://github.com/shaarli/Shaarli.wiki.git doc/md |
| 199 | @rm -rf doc/.git | 199 | mv doc/md/Home.md doc/md/index.md |
| 200 | 200 | @rm -rf doc/md/.git | |
| 201 | ### Generate a custom sidebar | ||
| 202 | # | ||
| 203 | # Sidebar content: | ||
| 204 | # - convert GitHub-flavoured relative links to standard Markdown | ||
| 205 | # - trim HTML, only keep the list (<ul>[...]</ul>) part | ||
| 206 | htmlsidebar: | ||
| 207 | @echo '<div id="local-sidebar">' > doc/sidebar.html | ||
| 208 | @awk 'BEGIN { FS = "[\\[\\]]{2}" }'\ | ||
| 209 | 'm = /\[/ { t=$$2; gsub(/ /, "-", $$2); print $$1"["t"]("$$2".html)"$$3 }'\ | ||
| 210 | '!m { print $$0 }' doc/_Sidebar.md > doc/tmp.md | ||
| 211 | @pandoc -f markdown -t html5 -s doc/tmp.md | awk '/(ul>|li>)/' >> doc/sidebar.html | ||
| 212 | @echo '</div>' >> doc/sidebar.html | ||
| 213 | @rm doc/tmp.md | ||
| 214 | 201 | ||
| 215 | ### Convert local markdown documentation to HTML | 202 | ### Convert local markdown documentation to HTML |
| 216 | # | 203 | # |
| 217 | # For all pages: | 204 | # For all pages: |
| 218 | # - infer title from the file name | ||
| 219 | # - convert GitHub-flavoured relative links to standard Markdown | 205 | # - convert GitHub-flavoured relative links to standard Markdown |
| 220 | # - insert the sidebar menu | 206 | # - generate html documentation with mkdocs |
| 221 | htmlpages: | 207 | htmlpages: |
| 222 | @for file in `find doc/ -maxdepth 1 -name "*.md"`; do \ | 208 | # Rename local [[links]] to regular links. |
| 223 | base=`basename $$file .md`; \ | 209 | @for file in `find doc/md/ -maxdepth 1 -name "*.md"`; do \ |
| 224 | sed -i "1i #$${base//-/ }" $$file; \ | 210 | sed -e "s/\[\[\(.*\)\]\]/[\1](\1)/g" "$$file" > doc/md/tmp.md; \ |
| 225 | awk 'BEGIN { FS = "[\\[\\]]{2}" }'\ | 211 | mv doc/md/tmp.md $$file; \ |
| 226 | 'm = /\[/ { t=$$2; gsub(/ /, "-", $$2); print $$1"["t"]("$$2".html)"$$3 }'\ | 212 | done |
| 227 | '!m { print $$0 }' $$file > doc/tmp.md; \ | 213 | |
| 228 | mv doc/tmp.md $$file; \ | 214 | python3 -m venv venv/ |
| 229 | pandoc -f markdown_github -t html5 -s \ | 215 | bash -c 'source venv/bin/activate; \ |
| 230 | -c "github-markdown.css" \ | 216 | pip install mkdocs; \ |
| 231 | -T Shaarli -M pagetitle:"$${base//-/ }" -B doc/sidebar.html \ | 217 | mkdocs build' |
| 232 | -o doc/$$base.html $$file; \ | 218 | find doc/html/ -type f -exec chmod a-x '{}' \; |
| 233 | done; | 219 | rm -r venv |
| 234 | 220 | ||
| 235 | htmldoc: authors doc htmlsidebar htmlpages | 221 | doc_html: authors doc htmlpages |
diff --git a/doc/3rd-party-libraries.html b/doc/3rd-party-libraries.html deleted file mode 100644 index 50aba6c0..00000000 --- a/doc/3rd-party-libraries.html +++ /dev/null | |||
| @@ -1,88 +0,0 @@ | |||
| 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 – 3rd party libraries</title> | ||
| 8 | <style type="text/css">code{white-space: pre;}</style> | ||
| 9 | <link rel="stylesheet" href="github-markdown.css"> | ||
| 10 | <!--[if lt IE 9]> | ||
| 11 | <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script> | ||
| 12 | <![endif]--> | ||
| 13 | </head> | ||
| 14 | <body> | ||
| 15 | <div id="local-sidebar"> | ||
| 16 | <ul> | ||
| 17 | <li><a href="Home.html">Home</a></li> | ||
| 18 | <li>Setup | ||
| 19 | <ul> | ||
| 20 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 21 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 22 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 23 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 24 | <li><a href="Server-security.html">Server security</a></li> | ||
| 25 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> | ||
| 26 | <li><a href="Plugins.html">Plugins</a></li> | ||
| 27 | </ul></li> | ||
| 28 | <li><a href="Docker.html">Docker</a></li> | ||
| 29 | <li><a href="Usage.html">Usage</a> | ||
| 30 | <ul> | ||
| 31 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> | ||
| 32 | <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li> | ||
| 33 | <li><a href="Firefox-share.html">Firefox share</a></li> | ||
| 34 | <li><a href="RSS-feeds.html">RSS feeds</a></li> | ||
| 35 | <li><a href="REST-API.html">REST API</a></li> | ||
| 36 | </ul></li> | ||
| 37 | <li>How To | ||
| 38 | <ul> | ||
| 39 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | ||
| 40 | <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> | ||
| 41 | <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li> | ||
| 42 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> | ||
| 43 | <li><a href="Datastore-hacks.html">Datastore hacks</a></li> | ||
| 44 | </ul></li> | ||
| 45 | <li><a href="Troubleshooting.html">Troubleshooting</a></li> | ||
| 46 | <li><a href="Development.html">Development</a> | ||
| 47 | <ul> | ||
| 48 | <li><a href="GnuPG-signature.html">GnuPG signature</a></li> | ||
| 49 | <li><a href="Coding-guidelines.html">Coding guidelines</a></li> | ||
| 50 | <li><a href="Directory-structure.html">Directory structure</a></li> | ||
| 51 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> | ||
| 52 | <li><a href="Plugin-System.html">Plugin System</a></li> | ||
| 53 | <li><a href="Release-Shaarli.html">Release Shaarli</a></li> | ||
| 54 | <li><a href="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 55 | <li><a href="Security.html">Security</a></li> | ||
| 56 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 57 | <li><a href="Theming.html">Theming</a></li> | ||
| 58 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 59 | </ul></li> | ||
| 60 | <li>About | ||
| 61 | <ul> | ||
| 62 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 63 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 64 | </ul></li> | ||
| 65 | </ul> | ||
| 66 | </div> | ||
| 67 | <h1 id="rd-party-libraries">3rd party libraries</h1> | ||
| 68 | <h2 id="css">CSS</h2> | ||
| 69 | <ul> | ||
| 70 | <li>Yahoo UI <a href="http://yuilibrary.com/yui/docs/cssreset/">CSS Reset</a><a href=".html"></a> | ||
| 71 | <ul> | ||
| 72 | <li>resets default CSS properties for all HTML elements (overriding browsers' default values)</li> | ||
| 73 | <li>ensures custom CSS stylessheets will provide the same results on all browsers</li> | ||
| 74 | </ul></li> | ||
| 75 | </ul> | ||
| 76 | <h2 id="javascript">Javascript</h2> | ||
| 77 | <ul> | ||
| 78 | <li><a href="https://leaverou.github.io/awesomplete/">Awesomeplete</a> (<a href="https://github.com/LeaVerou/awesomplete">GitHub</a>) - autocompletion in input forms<a href=".html"></a></li> | ||
| 79 | <li><a href="http://dinbror.dk/blazy/">bLazy</a> (<a href="https://github.com/dinbror/blazy">GitHub</a>) - lazy loading for thumbnails<a href=".html"></a></li> | ||
| 80 | <li><a href="http://neocotic.com/qr.js/">qr.js</a> (<a href="https://github.com/neocotic/qr.js">GitHub</a>) - QR code generation<a href=".html"></a></li> | ||
| 81 | </ul> | ||
| 82 | <h2 id="php">PHP</h2> | ||
| 83 | <ul> | ||
| 84 | <li><a href="https://github.com/shaarli/netscape-bookmark-parser">shaarli/netscape-bookmark-parser</a> - Netscape bookmark parser<a href=".html"></a></li> | ||
| 85 | <li><a href="https://github.com/rainphp/raintpl">RainTPL</a> - HTML templating for PHP<a href=".html"></a></li> | ||
| 86 | </ul> | ||
| 87 | </body> | ||
| 88 | </html> | ||
diff --git a/doc/Backup,-restore,-import-and-export.html b/doc/Backup,-restore,-import-and-export.html deleted file mode 100644 index 3c168824..00000000 --- a/doc/Backup,-restore,-import-and-export.html +++ /dev/null | |||
| @@ -1,152 +0,0 @@ | |||
| 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 – Backup, restore, import and export</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>Setup | ||
| 56 | <ul> | ||
| 57 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 58 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 59 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 60 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 61 | <li><a href="Server-security.html">Server security</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 | <li><a href="REST-API.html">REST API</a></li> | ||
| 73 | </ul></li> | ||
| 74 | <li>How To | ||
| 75 | <ul> | ||
| 76 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</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="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 92 | <li><a href="Security.html">Security</a></li> | ||
| 93 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 94 | <li><a href="Theming.html">Theming</a></li> | ||
| 95 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 96 | </ul></li> | ||
| 97 | <li>About | ||
| 98 | <ul> | ||
| 99 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 100 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 101 | </ul></li> | ||
| 102 | </ul> | ||
| 103 | </div> | ||
| 104 | <h1 id="backup-restore-import-and-export">Backup, restore, import and export</h1> | ||
| 105 | <ul> | ||
| 106 | <li><a href="#backup-and-restore-the-datastore-file">Backup and restore the datastore file</a><a href=".html"></a></li> | ||
| 107 | <li><a href="#export-links-as">Export links as...</a><a href=".html"></a></li> | ||
| 108 | <li><a href="#import-links-from">Import links from...</a><a href=".html"></a></li> | ||
| 109 | <li><a href="#import-shaarli-links-to-firefox">Import Shaarli links to Firefox</a><a href=".html"></a></li> | ||
| 110 | </ul> | ||
| 111 | <hr /> | ||
| 112 | <h2 id="backup-and-restore-the-datastore-file">Backup and restore the datastore file</h2> | ||
| 113 | <p>Backup the file <code>data/datastore.php</code> (by FTP or SSH). Restore by putting the file back in place.</p> | ||
| 114 | <p>Example command:</p> | ||
| 115 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="fu">rsync</span> -avzP my.server.com:/var/www/shaarli/data/datastore.php datastore-<span class="va">$(</span><span class="fu">date</span> +%Y-%m-%d_%H%M<span class="va">)</span>.php</code></pre></div> | ||
| 116 | <h2 id="export-links-as...">Export links as...</h2> | ||
| 117 | <p>To export links as an HTML file, under <em>Tools > Export</em>, choose:</p> | ||
| 118 | <ul> | ||
| 119 | <li><em>Export all</em> to export both public and private links</li> | ||
| 120 | <li><em>Export public</em> to export public links only</li> | ||
| 121 | <li><em>Export private</em> to export private links only</li> | ||
| 122 | </ul> | ||
| 123 | <p>Restore by using the <code>Import</code> feature.</p> | ||
| 124 | <ul> | ||
| 125 | <li>This can be done using the <a href="https://github.com/nodiscc/shaarchiver">shaarchiver</a> tool.<a href=".html"></a></li> | ||
| 126 | </ul> | ||
| 127 | <p>Example command:</p> | ||
| 128 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="ex">./export-bookmarks.py</span> --url=https://my.server.com/shaarli --username=myusername --password=mysupersecretpassword --download-dir=./ --type=all</code></pre></div> | ||
| 129 | <h2 id="import-links-from...">Import links from...</h2> | ||
| 130 | <h3 id="diigo">Diigo</h3> | ||
| 131 | <p>If you export your bookmark from Diigo, make sure you use the Delicious export, not the Netscape export. (Their Netscape export is broken, and they don't seem to be interested in fixing it.)</p> | ||
| 132 | <h3 id="mister-wong">Mister Wong</h3> | ||
| 133 | <p>See <a href="https://github.com/sebsauvage/Shaarli/issues/146">this issue</a> for import tweaks.<a href=".html"></a></p> | ||
| 134 | <h3 id="semanticscuttle">SemanticScuttle</h3> | ||
| 135 | <p>To correctly import the tags from a <a href="http://semanticscuttle.sourceforge.net/">SemanticScuttle</a> HTML export, edit the HTML file before importing and replace all occurences of <code>tags=</code> (lowercase) to <code>TAGS=</code> (uppercase).<a href=".html"></a></p> | ||
| 136 | <h3 id="scuttle">Scuttle</h3> | ||
| 137 | <p>Shaarli cannot import data directly from <a href="https://github.com/scronide/scuttle">Scuttle</a>. However, you can use this third party tool: <a href="https://github.com/q2apro/scuttle-to-shaarli" class="uri">https://github.com/q2apro/scuttle-to-shaarli</a> to export the Scuttle database to the Netscape HTML format compatible with the Shaarli importer.<a href=".html"></a></p> | ||
| 138 | <h2 id="import-shaarli-links-to-firefox">Import Shaarli links to Firefox</h2> | ||
| 139 | <ul> | ||
| 140 | <li>Export your Shaarli links as described above.</li> | ||
| 141 | <li>For compatibility reasons, check <code>Prepend note permalinks with this Shaarli instance's URL (useful to import bookmarks in a web browser)</code></li> | ||
| 142 | <li>In Firefox, open the bookmark manager (not the sidebar! <code>Bookmarks menu > Show all bookmarks</code> or <code>Ctrl+Shift+B</code>)</li> | ||
| 143 | <li>Select <code>Import and Backup > Import bookmarks in HTML format</code></li> | ||
| 144 | </ul> | ||
| 145 | <p>Your bookmarks will be imported in Firefox, ready to use, with tags and descriptions retained. "Self" (notes) shaares will still point to the Shaarli instance you exported them from, but the note text can be viewed directly in the bookmark properties inside your browser. Depending on the number of bookmarks, the import can take some time.</p> | ||
| 146 | <p>You may be interested in these Firefox addons to manage links imported from Shaarli</p> | ||
| 147 | <ul> | ||
| 148 | <li><a href="https://addons.mozilla.org/en-US/firefox/addon/bookmark-deduplicator/">Bookmark Deduplicator</a> - provides an easy way to deduplicate your bookmarks<a href=".html"></a></li> | ||
| 149 | <li><a href="https://addons.mozilla.org/en-US/firefox/addon/tagsieve/">TagSieve</a> - browse your bookmarks by their tags<a href=".html"></a></li> | ||
| 150 | </ul> | ||
| 151 | </body> | ||
| 152 | </html> | ||
diff --git a/doc/Browsing-and-searching.html b/doc/Browsing-and-searching.html deleted file mode 100644 index ef5b5245..00000000 --- a/doc/Browsing-and-searching.html +++ /dev/null | |||
| @@ -1,83 +0,0 @@ | |||
| 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 – Browsing and searching</title> | ||
| 8 | <style type="text/css">code{white-space: pre;}</style> | ||
| 9 | <link rel="stylesheet" href="github-markdown.css"> | ||
| 10 | <!--[if lt IE 9]> | ||
| 11 | <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script> | ||
| 12 | <![endif]--> | ||
| 13 | </head> | ||
| 14 | <body> | ||
| 15 | <div id="local-sidebar"> | ||
| 16 | <ul> | ||
| 17 | <li><a href="Home.html">Home</a></li> | ||
| 18 | <li>Setup | ||
| 19 | <ul> | ||
| 20 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 21 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 22 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 23 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 24 | <li><a href="Server-security.html">Server security</a></li> | ||
| 25 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> | ||
| 26 | <li><a href="Plugins.html">Plugins</a></li> | ||
| 27 | </ul></li> | ||
| 28 | <li><a href="Docker.html">Docker</a></li> | ||
| 29 | <li><a href="Usage.html">Usage</a> | ||
| 30 | <ul> | ||
| 31 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> | ||
| 32 | <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li> | ||
| 33 | <li><a href="Firefox-share.html">Firefox share</a></li> | ||
| 34 | <li><a href="RSS-feeds.html">RSS feeds</a></li> | ||
| 35 | <li><a href="REST-API.html">REST API</a></li> | ||
| 36 | </ul></li> | ||
| 37 | <li>How To | ||
| 38 | <ul> | ||
| 39 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | ||
| 40 | <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> | ||
| 41 | <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li> | ||
| 42 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> | ||
| 43 | <li><a href="Datastore-hacks.html">Datastore hacks</a></li> | ||
| 44 | </ul></li> | ||
| 45 | <li><a href="Troubleshooting.html">Troubleshooting</a></li> | ||
| 46 | <li><a href="Development.html">Development</a> | ||
| 47 | <ul> | ||
| 48 | <li><a href="GnuPG-signature.html">GnuPG signature</a></li> | ||
| 49 | <li><a href="Coding-guidelines.html">Coding guidelines</a></li> | ||
| 50 | <li><a href="Directory-structure.html">Directory structure</a></li> | ||
| 51 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> | ||
| 52 | <li><a href="Plugin-System.html">Plugin System</a></li> | ||
| 53 | <li><a href="Release-Shaarli.html">Release Shaarli</a></li> | ||
| 54 | <li><a href="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 55 | <li><a href="Security.html">Security</a></li> | ||
| 56 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 57 | <li><a href="Theming.html">Theming</a></li> | ||
| 58 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 59 | </ul></li> | ||
| 60 | <li>About | ||
| 61 | <ul> | ||
| 62 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 63 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 64 | </ul></li> | ||
| 65 | </ul> | ||
| 66 | </div> | ||
| 67 | <h1 id="browsing-and-searching">Browsing and searching</h1> | ||
| 68 | <h1 id="browsing-and-searching-1">Browsing and Searching</h1> | ||
| 69 | <p><embed src="(http://pix.toile-libre.org/upload/original/1455571378.png).html" /></p> | ||
| 70 | <h2 id="plain-text-search">Plain text search</h2> | ||
| 71 | <p>Use the <code>Search text</code> field to search in <em>any</em> of the fields of all links (Title, URL, Description...)</p> | ||
| 72 | <p><strong>Exclude text/tags:</strong> Use the <code>-</code> operator before a word or tag (example <code>-uninteresting</code>) to prevent entries containing (or tagged) <code>uninteresting</code> from showing up in the search results.</p> | ||
| 73 | <p><strong>Exact text search:</strong> Use double-quotes (example <code>"exact search"</code>) to search for the exact expression.</p> | ||
| 74 | <p>Both exclude patterns and exact searches can be combined with normal searches (example <code>"exact search" term otherterm -notthis "very exact" stuff -notagain</code>)</p> | ||
| 75 | <h2 id="tags-search">Tags search</h2> | ||
| 76 | <p>Use the <code>Filter by tags</code> field to restrict displayed links to entries tagged with one or multiple tags (use space to separate tags).</p> | ||
| 77 | <p><strong>Hidden tags:</strong> Tags starting with a dot <code>.</code> (example <code>.secret</code>) are private. They can only be seen and searched when logged in.</p> | ||
| 78 | <p>Alternatively you can use the <code>Tag cloud</code> to discover all tags and click on any of them to display related links.</p> | ||
| 79 | <p>To search for links that are not tagged, enter <code>""</code> in the tag search field.</p> | ||
| 80 | <h2 id="filtering-rss-feedspicture-wall">Filtering RSS feeds/Picture wall</h2> | ||
| 81 | <p>RSS feeds can also be restricted to only return items matching a text/tag search: see <a href="RSS-feeds.html">RSS feeds</a>.</p> | ||
| 82 | </body> | ||
| 83 | </html> | ||
diff --git a/doc/Coding-guidelines.html b/doc/Coding-guidelines.html deleted file mode 100644 index 8df12182..00000000 --- a/doc/Coding-guidelines.html +++ /dev/null | |||
| @@ -1,75 +0,0 @@ | |||
| 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 – Coding guidelines</title> | ||
| 8 | <style type="text/css">code{white-space: pre;}</style> | ||
| 9 | <link rel="stylesheet" href="github-markdown.css"> | ||
| 10 | <!--[if lt IE 9]> | ||
| 11 | <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script> | ||
| 12 | <![endif]--> | ||
| 13 | </head> | ||
| 14 | <body> | ||
| 15 | <div id="local-sidebar"> | ||
| 16 | <ul> | ||
| 17 | <li><a href="Home.html">Home</a></li> | ||
| 18 | <li>Setup | ||
| 19 | <ul> | ||
| 20 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 21 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 22 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 23 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 24 | <li><a href="Server-security.html">Server security</a></li> | ||
| 25 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> | ||
| 26 | <li><a href="Plugins.html">Plugins</a></li> | ||
| 27 | </ul></li> | ||
| 28 | <li><a href="Docker.html">Docker</a></li> | ||
| 29 | <li><a href="Usage.html">Usage</a> | ||
| 30 | <ul> | ||
| 31 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> | ||
| 32 | <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li> | ||
| 33 | <li><a href="Firefox-share.html">Firefox share</a></li> | ||
| 34 | <li><a href="RSS-feeds.html">RSS feeds</a></li> | ||
| 35 | <li><a href="REST-API.html">REST API</a></li> | ||
| 36 | </ul></li> | ||
| 37 | <li>How To | ||
| 38 | <ul> | ||
| 39 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | ||
| 40 | <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> | ||
| 41 | <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li> | ||
| 42 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> | ||
| 43 | <li><a href="Datastore-hacks.html">Datastore hacks</a></li> | ||
| 44 | </ul></li> | ||
| 45 | <li><a href="Troubleshooting.html">Troubleshooting</a></li> | ||
| 46 | <li><a href="Development.html">Development</a> | ||
| 47 | <ul> | ||
| 48 | <li><a href="GnuPG-signature.html">GnuPG signature</a></li> | ||
| 49 | <li><a href="Coding-guidelines.html">Coding guidelines</a></li> | ||
| 50 | <li><a href="Directory-structure.html">Directory structure</a></li> | ||
| 51 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> | ||
| 52 | <li><a href="Plugin-System.html">Plugin System</a></li> | ||
| 53 | <li><a href="Release-Shaarli.html">Release Shaarli</a></li> | ||
| 54 | <li><a href="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 55 | <li><a href="Security.html">Security</a></li> | ||
| 56 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 57 | <li><a href="Theming.html">Theming</a></li> | ||
| 58 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 59 | </ul></li> | ||
| 60 | <li>About | ||
| 61 | <ul> | ||
| 62 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 63 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 64 | </ul></li> | ||
| 65 | </ul> | ||
| 66 | </div> | ||
| 67 | <h1 id="coding-guidelines">Coding guidelines</h1> | ||
| 68 | <h2 id="wip">WIP</h2> | ||
| 69 | <p>This topic is currently being discussed here:</p> | ||
| 70 | <ul> | ||
| 71 | <li><a href="https://github.com/shaarli/Shaarli/issues/95">Fix coding style (static analysis)</a> (#95)<a href=".html"></a></li> | ||
| 72 | <li><a href="https://github.com/shaarli/Shaarli/issues/130">Continuous Integration tools & features</a> (#130)<a href=".html"></a></li> | ||
| 73 | </ul> | ||
| 74 | </body> | ||
| 75 | </html> | ||
diff --git a/doc/Community-&-Related-software.html b/doc/Community-&-Related-software.html deleted file mode 100644 index 28b96185..00000000 --- a/doc/Community-&-Related-software.html +++ /dev/null | |||
| @@ -1,131 +0,0 @@ | |||
| 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 – Community & Related software</title> | ||
| 8 | <style type="text/css">code{white-space: pre;}</style> | ||
| 9 | <link rel="stylesheet" href="github-markdown.css"> | ||
| 10 | <!--[if lt IE 9]> | ||
| 11 | <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script> | ||
| 12 | <![endif]--> | ||
| 13 | </head> | ||
| 14 | <body> | ||
| 15 | <div id="local-sidebar"> | ||
| 16 | <ul> | ||
| 17 | <li><a href="Home.html">Home</a></li> | ||
| 18 | <li>Setup | ||
| 19 | <ul> | ||
| 20 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 21 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 22 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 23 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 24 | <li><a href="Server-security.html">Server security</a></li> | ||
| 25 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> | ||
| 26 | <li><a href="Plugins.html">Plugins</a></li> | ||
| 27 | </ul></li> | ||
| 28 | <li><a href="Docker.html">Docker</a></li> | ||
| 29 | <li><a href="Usage.html">Usage</a> | ||
| 30 | <ul> | ||
| 31 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> | ||
| 32 | <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li> | ||
| 33 | <li><a href="Firefox-share.html">Firefox share</a></li> | ||
| 34 | <li><a href="RSS-feeds.html">RSS feeds</a></li> | ||
| 35 | <li><a href="REST-API.html">REST API</a></li> | ||
| 36 | </ul></li> | ||
| 37 | <li>How To | ||
| 38 | <ul> | ||
| 39 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | ||
| 40 | <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> | ||
| 41 | <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li> | ||
| 42 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> | ||
| 43 | <li><a href="Datastore-hacks.html">Datastore hacks</a></li> | ||
| 44 | </ul></li> | ||
| 45 | <li><a href="Troubleshooting.html">Troubleshooting</a></li> | ||
| 46 | <li><a href="Development.html">Development</a> | ||
| 47 | <ul> | ||
| 48 | <li><a href="GnuPG-signature.html">GnuPG signature</a></li> | ||
| 49 | <li><a href="Coding-guidelines.html">Coding guidelines</a></li> | ||
| 50 | <li><a href="Directory-structure.html">Directory structure</a></li> | ||
| 51 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> | ||
| 52 | <li><a href="Plugin-System.html">Plugin System</a></li> | ||
| 53 | <li><a href="Release-Shaarli.html">Release Shaarli</a></li> | ||
| 54 | <li><a href="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 55 | <li><a href="Security.html">Security</a></li> | ||
| 56 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 57 | <li><a href="Theming.html">Theming</a></li> | ||
| 58 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 59 | </ul></li> | ||
| 60 | <li>About | ||
| 61 | <ul> | ||
| 62 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 63 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 64 | </ul></li> | ||
| 65 | </ul> | ||
| 66 | </div> | ||
| 67 | <h1 id="community-related-software">Community & Related software</h1> | ||
| 68 | <p><em>Unofficial but related work on Shaarli. If you maintain one of these, please get in touch with us to help us find a way to adapt your work to our fork.</em></p> | ||
| 69 | <p><em>TODO: contact repos owners to see if they'd like to standardize their work with the community fork.</em></p> | ||
| 70 | <h2 id="community">Community</h2> | ||
| 71 | <ul> | ||
| 72 | <li><a href="http://sebsauvage.net/links/">Liens en vrac de sebsauvage</a> - the original Shaarli<a href=".html"></a></li> | ||
| 73 | <li><a href="http://porneia.free.fr/pub/links/ou-est-shaarli.html">A large list of Shaarlis</a><a href=".html"></a></li> | ||
| 74 | <li><a href="https://raw.githubusercontent.com/Oros42/find_shaarlis/master/annuaires.json">A list of working Shaarli aggregators</a><a href=".html"></a></li> | ||
| 75 | <li><a href="https://github.com/Oros42/shaarlis_list">A list of some known Shaarlis</a><a href=".html"></a></li> | ||
| 76 | <li><a href="http://sebsauvage.net/rhaa/index.php?2011/09/16/09/29/58-adieu-delicious-diigo-et-stumbleupon-salut-shaarli-">Adieu Delicious, Diigo et StumbleUpon. Salut Shaarli ! - sebsauvage.net</a> (fr) <em>16/09/2011 - the original post about Shaarli</em><a href=".html"></a></li> | ||
| 77 | <li><a href="http://sebsauvage.net/wiki/doku.php?id=php:shaarli:ideas">Original ideas/fixme/TODO page</a><a href=".html"></a></li> | ||
| 78 | <li><a href="http://sebsauvage.net/wiki/doku.php?id=php:shaarli:discussion">Original discussion page</a> (fr)<a href=".html"></a></li> | ||
| 79 | <li><a href="http://sebsauvage.net/wiki/doku.php?id=php:shaarli:history">Original revisions history</a><a href=".html"></a></li> | ||
| 80 | <li><a href="https://www.shaarli.fr/my.php">Shaarli.fr/my</a> - Unofficial, unsupported (old fork) hosted Shaarlis provider, courtesy of <a href="https://github.com/DMeloni">DMeloni</a><a href=".html"></a></li> | ||
| 81 | </ul> | ||
| 82 | <h3 id="articles-and-social-media-discussions">Articles and social media discussions</h3> | ||
| 83 | <ul> | ||
| 84 | <li>2016-09-22 - Hacker News - <a href="https://news.ycombinator.com/item?id=12552176" class="uri">https://news.ycombinator.com/item?id=12552176</a></li> | ||
| 85 | <li>2015-08-15 - Reddit - <a href="https://www.reddit.com/r/selfhosted/comments/3h3zwh/question_about_migrating_from_wordpress_to_shaarli/">Question about migrating from WordPress to Shaarli.</a><a href=".html"></a></li> | ||
| 86 | <li>2015-06-22 - Hacker News - <a href="https://news.ycombinator.com/item?id=9755366" class="uri">https://news.ycombinator.com/item?id=9755366</a></li> | ||
| 87 | <li>2015-05-12 - Reddit - <a href="https://www.reddit.com/r/selfhosted/comments/35pkkc/shaarli_self_hosted_bookmarking_delicious_php/">shaarli - Self hosted Bookmarking / Delicious (PHP, MySQL)</a><a href=".html"></a></li> | ||
| 88 | </ul> | ||
| 89 | <h3 id="third-party-plugins">Third party plugins</h3> | ||
| 90 | <ul> | ||
| 91 | <li><a href="https://github.com/kalvn/shaarli-plugin-autosave">autosave</a> by <a href="https://github.com/kalvn">@kalvn</a>: Automatically saves data when editing a link to avoid any loss in case of crash or unexpected shutdown.<a href=".html"></a></li> | ||
| 92 | <li><a href="https://github.com/ArthurHoaro/code-coloration">Code Coloration</a> by <a href="https://github.com/ArthurHoaro">@ArthurHoaro</a>: client side code syntax highlighter.<a href=".html"></a></li> | ||
| 93 | <li><a href="https://github.com/kalvn/shaarli-plugin-disqus">Disqus</a> by <a href="https://github.com/kalvn">@kalvn</a>: Adds Disqus comment system to your Shaarli.<a href=".html"></a></li> | ||
| 94 | <li><a href="https://github.com/NerosTie/emojione">emojione</a> by <a href="https://github.com/NerosTie">@NerosTie</a>: Add colorful emojis to your Shaarli.<a href=".html"></a></li> | ||
| 95 | <li><a href="https://github.com/ericjuden/Shaarli-Google-Analytics-Plugin">google analytics</a> by <a href="http://github.com/ericjuden">@ericjuden</a>: Adds Google Analytics tracking support<a href=".html"></a></li> | ||
| 96 | <li><a href="https://github.com/ArthurHoaro/launch-plugin">launch</a> - Launch Plugin is a plugin designed to enhance and customize Launch Theme for Shaarli.<a href=".html"></a></li> | ||
| 97 | <li><a href="https://github.com/alexisju/social">social</a> by <a href="https://github.com/alexisju">@alexisju</a>: share links to social networks.<a href=".html"></a></li> | ||
| 98 | <li><a href="https://github.com/ArthurHoaro/shaarli2twitter">shaarli2twitter</a> by <a href="https://github.com/ArthurHoaro">@ArthurHoaro</a> - Automatically tweet your shared links from Shaarli<a href=".html"></a></li> | ||
| 99 | </ul> | ||
| 100 | <h3 id="themes">Themes</h3> | ||
| 101 | <p>See <a href="Theming.html">Theming</a> for the list of community-contributed themes, and an installation guide.</p> | ||
| 102 | <h3 id="server-apps">Server apps</h3> | ||
| 103 | <ul> | ||
| 104 | <li><a href="https://github.com/nodiscc/shaarchiver">shaarchiver</a> - Archive your Shaarli bookmarks and their content<a href=".html"></a></li> | ||
| 105 | <li><a href="https://github.com/mknexen/shaarli-river">shaarli-river</a> - An aggregator for shaarlis with many features <a href=".html"></a></li> | ||
| 106 | <li><a href="https://github.com/DMeloni/shaarlo">Shaarlo</a> - An aggregator for shaarlis with many features (a very popular running instance among french shaarliers: <a href="http://shaarli.fr/">shaarli.fr</a>)<a href=".html"></a></li> | ||
| 107 | <li><a href="https://github.com/BoboTiG/shaarlimages">Shaarlimages</a> - An image-oriented aggregator for Shaarlis<a href=".html"></a></li> | ||
| 108 | <li><a href="https://github.com/mknexen/shaarli-api">mknexen/shaarli-api</a> - A REST API for Shaarli<a href=".html"></a></li> | ||
| 109 | <li><a href="https://github.com/qwertygc/shaarli-dev-code/blob/master/self-dead-link.php">Self dead link</a> - Detect dead links on shaarli. This version use the database of shaarli. <a href="https://github.com/qwertygc/shaarli-dev-code/blob/master/dead-link.php">Another version</a>, can be used for other shaarli instances (but is more resource consuming).<a href=".html"></a></li> | ||
| 110 | </ul> | ||
| 111 | <h3 id="mobile-apps">Mobile Apps</h3> | ||
| 112 | <ul> | ||
| 113 | <li><a href="http://app.mro.name/Shaarli💫">Shaarli💫</a> iOS share extension - see <a href="https://github.com/shaarli/Shaarli/issues/308#issuecomment-184592070">#308</a> for some promo codes,<a href=".html"></a></li> | ||
| 114 | <li><a href="http://sebsauvage.net/links/?ZAyDzg">Shaarli for Android</a> - Android application that adds Shaarli as a sharing provider<a href=".html"></a></li> | ||
| 115 | <li><a href="https://github.com/dimtion/Shaarlier">Shaarlier for Android</a> - Android application to simply add links directly into your Shaarli<a href=".html"></a></li> | ||
| 116 | </ul> | ||
| 117 | <h2 id="integration-with-other-platforms">Integration with other platforms</h2> | ||
| 118 | <ul> | ||
| 119 | <li><a href="https://github.com/jcsaaddupuy/tt-rss-shaarli">tt-rss-shaarli</a> - <a href="http://tt-rss.org/">TinyTiny RSS</a> plugin that adds support for sharing articles with Shaarli<a href=".html"></a></li> | ||
| 120 | <li><a href="https://github.com/ahmet2mir/octopress-shaarli">octopress-shaarli</a> - Octopress plugin to retrieve Shaarli links on the sidebar<a href=".html"></a></li> | ||
| 121 | <li><a href="https://github.com/q2apro/scuttle-to-shaarli">Scuttle to Shaarli</a> - Import bookmarks from Scuttle<a href=".html"></a></li> | ||
| 122 | </ul> | ||
| 123 | <h2 id="alternatives-to-shaarli">Alternatives to Shaarli</h2> | ||
| 124 | <ul> | ||
| 125 | <li><a href="http://alternativeto.net/software/shaarli/">Shaarli alternatives</a> (alternativeto.net)<a href=".html"></a></li> | ||
| 126 | <li><a href="https://github.com/bookieio/bookie">Bookie</a> - Another self-hostable, free bookmark sharing software, written in Python<a href=".html"></a></li> | ||
| 127 | <li><a href="https://github.com/plainmade/unmark">Unmark</a> - An open source todo app for bookmarks (<a href="https://unmark.it/">Homepage</a>)<a href=".html"></a></li> | ||
| 128 | <li><a href="https://wordpress.org/plugins/wp-bookmarks/">Wordpress bookmarks</a><a href=".html"></a></li> | ||
| 129 | </ul> | ||
| 130 | </body> | ||
| 131 | </html> | ||
diff --git a/doc/Copy-an-existing-installation-over-SSH-and-serve-it-locally.html b/doc/Copy-an-existing-installation-over-SSH-and-serve-it-locally.html deleted file mode 100644 index d6b76add..00000000 --- a/doc/Copy-an-existing-installation-over-SSH-and-serve-it-locally.html +++ /dev/null | |||
| @@ -1,165 +0,0 @@ | |||
| 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 – Copy an existing installation over SSH and serve it locally</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>Setup | ||
| 56 | <ul> | ||
| 57 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 58 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 59 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 60 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 61 | <li><a href="Server-security.html">Server security</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 | <li><a href="REST-API.html">REST API</a></li> | ||
| 73 | </ul></li> | ||
| 74 | <li>How To | ||
| 75 | <ul> | ||
| 76 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</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="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 92 | <li><a href="Security.html">Security</a></li> | ||
| 93 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 94 | <li><a href="Theming.html">Theming</a></li> | ||
| 95 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 96 | </ul></li> | ||
| 97 | <li>About | ||
| 98 | <ul> | ||
| 99 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 100 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 101 | </ul></li> | ||
| 102 | </ul> | ||
| 103 | </div> | ||
| 104 | <h1 id="copy-an-existing-installation-over-ssh-and-serve-it-locally">Copy an existing installation over SSH and serve it locally</h1> | ||
| 105 | <p>Example bash script:</p> | ||
| 106 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="co">#!/bin/bash</span> | ||
| 107 | <span class="co">#Description: Copy a Shaarli installation over SSH/SCP, serve it locally with php-cli</span> | ||
| 108 | <span class="co">#Will create a local-shaarli/ directory when you run it, backup your Shaarli there, and serve it locally.</span> | ||
| 109 | <span class="co">#Will NOT download linked pages. It's just a directly usable backup/copy/mirror of your Shaarli</span> | ||
| 110 | <span class="co">#Requires: ssh, scp and a working SSH access to the server where your Shaarli is installed</span> | ||
| 111 | <span class="co">#Usage: ./local-shaarli.sh</span> | ||
| 112 | <span class="co">#Author: nodiscc (nodiscc@gmail.com)</span> | ||
| 113 | <span class="co">#License: MIT (http://opensource.org/licenses/MIT)</span> | ||
| 114 | <span class="kw">set</span> <span class="ex">-o</span> errexit | ||
| 115 | <span class="kw">set</span> <span class="ex">-o</span> nounset | ||
| 116 | |||
| 117 | <span class="co">##### CONFIG #################</span> | ||
| 118 | <span class="co">#The port used by php's local server</span> | ||
| 119 | <span class="va">php_local_port=</span>7431 | ||
| 120 | |||
| 121 | <span class="co">#Name of the SSH server and path where Shaarli is installed</span> | ||
| 122 | <span class="co">#TODO: pass these as command-line arguments</span> | ||
| 123 | <span class="va">remotehost=</span><span class="st">"my.ssh.server"</span> | ||
| 124 | <span class="va">remote_shaarli_dir=</span><span class="st">"/var/www/shaarli"</span> | ||
| 125 | |||
| 126 | |||
| 127 | <span class="co">###### FUNCTIONS #############</span> | ||
| 128 | <span class="fu">_main()</span> <span class="kw">{</span> | ||
| 129 | <span class="ex">_CBSyncShaarli</span> | ||
| 130 | <span class="ex">_CBServeShaarli</span> | ||
| 131 | <span class="kw">}</span> | ||
| 132 | |||
| 133 | <span class="fu">_CBSyncShaarli()</span> <span class="kw">{</span> | ||
| 134 | <span class="va">remote_temp_dir=$(</span><span class="fu">ssh</span> <span class="va">$remotehost</span> mktemp -d<span class="va">)</span> | ||
| 135 | <span class="va">remote_ssh_user=$(</span><span class="fu">ssh</span> <span class="va">$remotehost</span> whoami<span class="va">)</span> | ||
| 136 | <span class="fu">ssh</span> -t <span class="st">"</span><span class="va">$remotehost</span><span class="st">"</span> sudo cp -r <span class="st">"</span><span class="va">$remote_shaarli_dir</span><span class="st">"</span> <span class="st">"</span><span class="va">$remote_temp_dir</span><span class="st">"</span> | ||
| 137 | <span class="fu">ssh</span> -t <span class="st">"</span><span class="va">$remotehost</span><span class="st">"</span> sudo chown -R <span class="st">"</span><span class="va">$remote_ssh_user</span><span class="st">"</span>:<span class="st">"</span><span class="va">$remote_ssh_user</span><span class="st">"</span> <span class="st">"</span><span class="va">$remote_temp_dir</span><span class="st">"</span> | ||
| 138 | <span class="fu">scp</span> -rq <span class="st">"</span><span class="va">$remotehost</span><span class="st">"</span>:<span class="st">"</span><span class="va">$remote_temp_dir</span><span class="st">"</span> local-shaarli | ||
| 139 | <span class="fu">ssh</span> <span class="st">"</span><span class="va">$remotehost</span><span class="st">"</span> rm -r <span class="st">"</span><span class="va">$remote_temp_dir</span><span class="st">"</span> | ||
| 140 | <span class="kw">}</span> | ||
| 141 | |||
| 142 | <span class="fu">_CBServeShaarli()</span> <span class="kw">{</span> | ||
| 143 | <span class="co">#TODO: allow serving a previously downloaded Shaarli</span> | ||
| 144 | <span class="co">#TODO: ask before overwriting local copy, if it exists</span> | ||
| 145 | <span class="bu">cd</span> local-shaarli/ | ||
| 146 | <span class="ex">php</span> -S localhost:<span class="va">${php_local_port}</span> | ||
| 147 | <span class="bu">echo</span> <span class="st">"Please go to http://localhost:</span><span class="va">${php_local_port}</span><span class="st">"</span> | ||
| 148 | <span class="kw">}</span> | ||
| 149 | |||
| 150 | |||
| 151 | <span class="co">##### MAIN #################</span> | ||
| 152 | |||
| 153 | <span class="ex">_main</span></code></pre></div> | ||
| 154 | <p>This outputs:</p> | ||
| 155 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="ex">./local-shaarli.sh</span> | ||
| 156 | <span class="ex">PHP</span> 5.6.0RC4 Development Server started at Mon Sep 1 21:56:19 2014 | ||
| 157 | <span class="ex">Listening</span> on http://localhost:7431 | ||
| 158 | <span class="ex">Document</span> root is /home/user/local-shaarli/shaarli | ||
| 159 | <span class="ex">Press</span> Ctrl-C to quit. | ||
| 160 | |||
| 161 | [<span class="ex">Mon</span> Sep 1 21:56:27 2014] ::1:57868 [200]: /[](.html) | ||
| 162 | [<span class="ex">Mon</span> Sep 1 21:56:27 2014] ::1:57869 [200]: /index.html[](.html) | ||
| 163 | [<span class="ex">Mon</span> Sep 1 21:56:37 2014] ::1:57881 [200]: /...[](.html)</code></pre></div> | ||
| 164 | </body> | ||
| 165 | </html> | ||
diff --git a/doc/Create-and-serve-multiple-Shaarlis-(farm).html b/doc/Create-and-serve-multiple-Shaarlis-(farm).html deleted file mode 100644 index 0be81d56..00000000 --- a/doc/Create-and-serve-multiple-Shaarlis-(farm).html +++ /dev/null | |||
| @@ -1,159 +0,0 @@ | |||
| 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 – Create and serve multiple Shaarlis (farm)</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>Setup | ||
| 56 | <ul> | ||
| 57 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 58 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 59 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 60 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 61 | <li><a href="Server-security.html">Server security</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 | <li><a href="REST-API.html">REST API</a></li> | ||
| 73 | </ul></li> | ||
| 74 | <li>How To | ||
| 75 | <ul> | ||
| 76 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</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="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 92 | <li><a href="Security.html">Security</a></li> | ||
| 93 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 94 | <li><a href="Theming.html">Theming</a></li> | ||
| 95 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 96 | </ul></li> | ||
| 97 | <li>About | ||
| 98 | <ul> | ||
| 99 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 100 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 101 | </ul></li> | ||
| 102 | </ul> | ||
| 103 | </div> | ||
| 104 | <h1 id="create-and-serve-multiple-shaarlis-farm">Create and serve multiple Shaarlis (farm)</h1> | ||
| 105 | <p>Example bash script (creates multiple shaarli instances and generates an HTML index of them)</p> | ||
| 106 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="co">#!/bin/bash</span> | ||
| 107 | <span class="kw">set</span> <span class="ex">-o</span> errexit | ||
| 108 | <span class="kw">set</span> <span class="ex">-o</span> nounset | ||
| 109 | |||
| 110 | <span class="co">#config</span> | ||
| 111 | <span class="va">shaarli_base_dir=</span><span class="st">'/var/www/shaarli'</span> | ||
| 112 | <span class="va">accounts=</span><span class="st">'bob john whatever username'</span> | ||
| 113 | <span class="va">shaarli_repo_url=</span><span class="st">'https://github.com/shaarli/Shaarli'</span> | ||
| 114 | <span class="va">ref=</span><span class="st">"master"</span> | ||
| 115 | |||
| 116 | <span class="co">#clone multiple shaarli instances</span> | ||
| 117 | <span class="kw">if</span><span class="bu"> [</span> <span class="ot">!</span> <span class="ot">-d</span> <span class="st">"</span><span class="va">$shaarli_base_dir</span><span class="st">"</span><span class="bu"> ]</span>; <span class="kw">then</span> <span class="fu">mkdir</span> <span class="st">"</span><span class="va">$shaarli_base_dir</span><span class="st">"</span><span class="kw">;</span> <span class="kw">fi</span>[]<span class="kw">(</span><span class="ex">.html</span><span class="kw">)</span> | ||
| 118 | |||
| 119 | <span class="kw">for</span> <span class="ex">account</span> in <span class="va">$accounts</span><span class="kw">;</span> <span class="kw">do</span> | ||
| 120 | <span class="kw">if</span><span class="bu"> [</span> <span class="ot">-d</span> <span class="st">"</span><span class="va">$shaarli_base_dir</span><span class="st">/</span><span class="va">$account</span><span class="st">"</span><span class="bu"> ]</span>;[]<span class="kw">(</span><span class="ex">.html</span><span class="kw">)</span> | ||
| 121 | <span class="kw">then</span> <span class="bu">echo</span> <span class="st">"[info] account </span><span class="va">$account</span><span class="st"> already exists, skipping"</span><span class="kw">;</span>[]<span class="kw">(</span><span class="ex">.html</span><span class="kw">)</span> | ||
| 122 | <span class="kw">else</span> <span class="bu">echo</span> <span class="st">"[info] creating new account </span><span class="va">$account</span><span class="st"> ..."</span><span class="kw">;</span> <span class="fu">git</span> clone --quiet <span class="st">"</span><span class="va">$shaarli_repo_url</span><span class="st">"</span> -b <span class="st">"</span><span class="va">$ref</span><span class="st">"</span> <span class="st">"</span><span class="va">$shaarli_base_dir</span><span class="st">/</span><span class="va">$account</span><span class="st">"</span><span class="kw">;</span> <span class="kw">fi</span>[]<span class="kw">(</span><span class="ex">.html</span><span class="kw">)</span> | ||
| 123 | <span class="kw">done</span> | ||
| 124 | |||
| 125 | <span class="co">#generate html index of shaarlis</span> | ||
| 126 | <span class="va">htmlhead=</span><span class="st">'<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"></span> | ||
| 127 | <span class="st"><!-- Minimal html template thanks to http://www.sitepoint.com/a-minimal-html-document/ --></span> | ||
| 128 | <span class="st"><html lang="en"></span> | ||
| 129 | <span class="st"> <head></span> | ||
| 130 | <span class="st"> <meta http-equiv="content-type" content="text/html; charset=utf-8"></span> | ||
| 131 | <span class="st"> <title>My Shaarli farm</title></span> | ||
| 132 | <span class="st"> <style>body {font-family: "Open Sans"}</style></span> | ||
| 133 | <span class="st"> </head></span> | ||
| 134 | <span class="st"> <body></span> | ||
| 135 | <span class="st"> <div></span> | ||
| 136 | <span class="st"> <h1>My Shaarli farm</h1></span> | ||
| 137 | <span class="st"> <ul style="list-style-type: none;">'</span> | ||
| 138 | |||
| 139 | <span class="va">accountlinks=</span><span class="st">''</span> | ||
| 140 | |||
| 141 | <span class="va">htmlfooter=</span><span class="st">'</span> | ||
| 142 | <span class="st"> </ul></span> | ||
| 143 | <span class="st"> </div></span> | ||
| 144 | <span class="st"> </body></span> | ||
| 145 | <span class="st"></html>'</span> | ||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | <span class="kw">for</span> <span class="ex">account</span> in <span class="va">$accounts</span><span class="kw">;</span> <span class="kw">do</span> <span class="va">accountlinks=</span><span class="st">"</span><span class="va">$accountlinks</span><span class="st">\n<li><a href=</span><span class="dt">\"</span><span class="va">$account</span><span class="dt">\"</span><span class="st">></span><span class="va">$account</span><span class="st"></a></li>"</span>; <span class="kw">done</span> | ||
| 150 | <span class="kw">if</span><span class="bu"> [</span> <span class="ot">-d</span> <span class="st">"</span><span class="va">$shaarli_base_dir</span><span class="st">/index.html"</span><span class="bu"> ]</span>; <span class="kw">then</span> <span class="bu">echo</span> <span class="st">"[removing old index.html]"</span><span class="kw">;</span> <span class="fu">rm</span> <span class="st">"</span><span class="va">$shaarli_base_dir</span><span class="st">/index.html"</span> ]<span class="kw">;</span> <span class="kw">fi</span>[]<span class="kw">(</span><span class="ex">.html</span><span class="kw">)</span> | ||
| 151 | <span class="bu">echo</span> <span class="st">"[info] generating new index of shaarlis"</span>[](.html) | ||
| 152 | <span class="bu">echo</span> -e <span class="st">"</span><span class="va">$htmlhead</span><span class="st"> </span><span class="va">$accountlinks</span><span class="st"> </span><span class="va">$htmlfooter</span><span class="st">"</span> <span class="op">></span> <span class="st">"</span><span class="va">$shaarli_base_dir</span><span class="st">/index.html"</span> | ||
| 153 | <span class="bu">echo</span> <span class="st">'[info] done.'</span>[](.html) | ||
| 154 | <span class="bu">echo</span> <span class="st">"[info] list of accounts: </span><span class="va">$accounts</span><span class="st">"</span>[](.html) | ||
| 155 | <span class="bu">echo</span> <span class="st">"[info] contents of </span><span class="va">$shaarli_base_dir</span><span class="st">:"</span>[](.html) | ||
| 156 | <span class="ex">tree</span> -a -L 1 <span class="st">"</span><span class="va">$shaarli_base_dir</span><span class="st">"</span></code></pre></div> | ||
| 157 | <p>This script just serves as an example. More precise or complex (applying custom configuration, etc) automation is possible using configuration management software like <a href="https://www.ansible.com/">Ansible</a><a href=".html"></a></p> | ||
| 158 | </body> | ||
| 159 | </html> | ||
diff --git a/doc/Datastore-hacks.html b/doc/Datastore-hacks.html deleted file mode 100644 index ef3e17bb..00000000 --- a/doc/Datastore-hacks.html +++ /dev/null | |||
| @@ -1,124 +0,0 @@ | |||
| 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 – Datastore hacks</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>Setup | ||
| 56 | <ul> | ||
| 57 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 58 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 59 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 60 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 61 | <li><a href="Server-security.html">Server security</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 | <li><a href="REST-API.html">REST API</a></li> | ||
| 73 | </ul></li> | ||
| 74 | <li>How To | ||
| 75 | <ul> | ||
| 76 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</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="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 92 | <li><a href="Security.html">Security</a></li> | ||
| 93 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 94 | <li><a href="Theming.html">Theming</a></li> | ||
| 95 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 96 | </ul></li> | ||
| 97 | <li>About | ||
| 98 | <ul> | ||
| 99 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 100 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 101 | </ul></li> | ||
| 102 | </ul> | ||
| 103 | </div> | ||
| 104 | <h1 id="datastore-hacks">Datastore hacks</h1> | ||
| 105 | <h3 id="decode-datastore-content">Decode datastore content</h3> | ||
| 106 | <p>To display the array representing the data saved in <code>data/datastore.php</code>, use the following snippet:</p> | ||
| 107 | <div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php"><span class="kw">$data</span> = <span class="st">"tZNdb9MwFIb... <Commented content inside datastore.php>"</span><span class="ot">;</span> | ||
| 108 | <span class="kw">$out</span> = <span class="fu">unserialize</span><span class="ot">(</span><span class="fu">gzinflate</span><span class="ot">(</span><span class="fu">base64_decode</span><span class="ot">(</span><span class="kw">$data</span><span class="ot">)));</span> | ||
| 109 | <span class="fu">echo</span> <span class="st">"<pre>"</span><span class="ot">;</span> <span class="co">// Pretty printing is love, pretty printing is life</span> | ||
| 110 | <span class="fu">print_r</span><span class="ot">(</span><span class="kw">$out</span><span class="ot">);</span> | ||
| 111 | <span class="fu">echo</span> <span class="st">"</pre>"</span><span class="ot">;</span> | ||
| 112 | <span class="fu">exit</span><span class="ot">;</span></code></pre></div> | ||
| 113 | <p>This will output the internal representation of the datastore, "unobfuscated" (if this can really be considered obfuscation).</p> | ||
| 114 | <p>Alternatively, you can transform to JSON format (and pretty-print if you have <code>jq</code> installed):</p> | ||
| 115 | <pre><code>php -r 'print(json_encode(unserialize(gzinflate(base64_decode(preg_replace("!.*/\* (.+) \*/.*!", "$1", file_get_contents("data/datastore.php")))))));' | jq .</code></pre> | ||
| 116 | <h3 id="changing-the-timestamp-for-a-link">Changing the timestamp for a link</h3> | ||
| 117 | <ul> | ||
| 118 | <li>Look for <code><input type="hidden" name="lf_linkdate" value="{$link.linkdate}"></code> in <code>tpl/editlink.tpl</code> (line 14)</li> | ||
| 119 | <li>Replace <code>type="hidden"</code> with <code>type="text"</code> from this line</li> | ||
| 120 | <li>A new date/time field becomes available in the edit/new link dialog.</li> | ||
| 121 | <li>You can set the timestamp manually by entering it in the format <code>YYYMMDD_HHMMS</code>.</li> | ||
| 122 | </ul> | ||
| 123 | </body> | ||
| 124 | </html> | ||
diff --git a/doc/Development.html b/doc/Development.html deleted file mode 100644 index 8a2be413..00000000 --- a/doc/Development.html +++ /dev/null | |||
| @@ -1,112 +0,0 @@ | |||
| 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 – Development</title> | ||
| 8 | <style type="text/css">code{white-space: pre;}</style> | ||
| 9 | <link rel="stylesheet" href="github-markdown.css"> | ||
| 10 | <!--[if lt IE 9]> | ||
| 11 | <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script> | ||
| 12 | <![endif]--> | ||
| 13 | </head> | ||
| 14 | <body> | ||
| 15 | <div id="local-sidebar"> | ||
| 16 | <ul> | ||
| 17 | <li><a href="Home.html">Home</a></li> | ||
| 18 | <li>Setup | ||
| 19 | <ul> | ||
| 20 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 21 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 22 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 23 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 24 | <li><a href="Server-security.html">Server security</a></li> | ||
| 25 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> | ||
| 26 | <li><a href="Plugins.html">Plugins</a></li> | ||
| 27 | </ul></li> | ||
| 28 | <li><a href="Docker.html">Docker</a></li> | ||
| 29 | <li><a href="Usage.html">Usage</a> | ||
| 30 | <ul> | ||
| 31 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> | ||
| 32 | <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li> | ||
| 33 | <li><a href="Firefox-share.html">Firefox share</a></li> | ||
| 34 | <li><a href="RSS-feeds.html">RSS feeds</a></li> | ||
| 35 | <li><a href="REST-API.html">REST API</a></li> | ||
| 36 | </ul></li> | ||
| 37 | <li>How To | ||
| 38 | <ul> | ||
| 39 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | ||
| 40 | <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> | ||
| 41 | <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li> | ||
| 42 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> | ||
| 43 | <li><a href="Datastore-hacks.html">Datastore hacks</a></li> | ||
| 44 | </ul></li> | ||
| 45 | <li><a href="Troubleshooting.html">Troubleshooting</a></li> | ||
| 46 | <li><a href="Development.html">Development</a> | ||
| 47 | <ul> | ||
| 48 | <li><a href="GnuPG-signature.html">GnuPG signature</a></li> | ||
| 49 | <li><a href="Coding-guidelines.html">Coding guidelines</a></li> | ||
| 50 | <li><a href="Directory-structure.html">Directory structure</a></li> | ||
| 51 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> | ||
| 52 | <li><a href="Plugin-System.html">Plugin System</a></li> | ||
| 53 | <li><a href="Release-Shaarli.html">Release Shaarli</a></li> | ||
| 54 | <li><a href="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 55 | <li><a href="Security.html">Security</a></li> | ||
| 56 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 57 | <li><a href="Theming.html">Theming</a></li> | ||
| 58 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 59 | </ul></li> | ||
| 60 | <li>About | ||
| 61 | <ul> | ||
| 62 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 63 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 64 | </ul></li> | ||
| 65 | </ul> | ||
| 66 | </div> | ||
| 67 | <h1 id="development">Development</h1> | ||
| 68 | <h2 id="guidelines">Guidelines</h2> | ||
| 69 | <p>Please have a look at the following pages:</p> | ||
| 70 | <ul> | ||
| 71 | <li><a href="https://github.com/shaarli/Shaarli/tree/master/CONTRIBUTING.md">Contributing to Shaarli</a><a href=".html"></a></li> | ||
| 72 | <li><a href="Static-analysis.html">Static analysis</a> - patches should try to stick to the <a href="http://www.php-fig.org/psr/">PHP Standard Recommendations</a> (PSR), especially: | ||
| 73 | <ul> | ||
| 74 | <li><a href="http://www.php-fig.org/psr/psr-1/">PSR-1</a> - Basic Coding Standard<a href=".html"></a></li> | ||
| 75 | <li><a href="http://www.php-fig.org/psr/psr-2/">PSR-2</a> - Coding Style Guide<a href=".html"></a></li> | ||
| 76 | </ul></li> | ||
| 77 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 78 | <li><a href="GnuPG-signature.html">GnuPG signature</a> for tags/releases</li> | ||
| 79 | </ul> | ||
| 80 | <h2 id="continuous-integration-tools">Continuous integration tools</h2> | ||
| 81 | <h3 id="local-development">Local development</h3> | ||
| 82 | <p>A <a href="https://github.com/shaarli/Shaarli/blob/master/Makefile"><code>Makefile</code></a> is available to perform project-related operations:<a href=".html"></a></p> | ||
| 83 | <ul> | ||
| 84 | <li>Documentation - generate a local HTML copy of the GitHub wiki</li> | ||
| 85 | <li><a href="Static-analysis.html">Static analysis</a> - check that the code is compliant to PHP conventions</li> | ||
| 86 | <li><a href="Unit-tests.html">Unit tests</a> - ensure there are no regressions introduced by new commits</li> | ||
| 87 | </ul> | ||
| 88 | <h3 id="automatic-builds">Automatic builds</h3> | ||
| 89 | <p><a href="http://docs.travis-ci.com/">Travis CI</a> is a Continuous Integration build server, that runs a build:<a href=".html"></a></p> | ||
| 90 | <ul> | ||
| 91 | <li>each time a commit is merged to the mainline (<code>master</code> branch)</li> | ||
| 92 | <li>each time a Pull Request is submitted or updated</li> | ||
| 93 | </ul> | ||
| 94 | <p>A build is composed of several jobs: one for each supported PHP version (see <a href="Server-requirements.html">Server requirements</a>).</p> | ||
| 95 | <p>Each build job:</p> | ||
| 96 | <ul> | ||
| 97 | <li>updates Composer</li> | ||
| 98 | <li>installs 3rd-party test dependencies with Composer</li> | ||
| 99 | <li>runs <a href="Unit-tests.html">Unit tests</a></li> | ||
| 100 | </ul> | ||
| 101 | <p>After all jobs have finished, Travis returns the results to GitHub:</p> | ||
| 102 | <ul> | ||
| 103 | <li>a status icon represents the result for the <code>master</code> branch: <a href="(https://api.travis-ci.org/shaarli/Shaarli.svg)%5D(https://travis-ci.org/shaarli/Shaarli).html"><img src="https://travis-ci.org/shaarli/Shaarli" alt="(https://api.travis-ci.org/shaarli/Shaarli.svg)" /></a></li> | ||
| 104 | <li>Pull Requests are updated with the Travis result | ||
| 105 | <ul> | ||
| 106 | <li>Green: all tests have passed</li> | ||
| 107 | <li>Red: some tests failed</li> | ||
| 108 | <li>Orange: tests are pending</li> | ||
| 109 | </ul></li> | ||
| 110 | </ul> | ||
| 111 | </body> | ||
| 112 | </html> | ||
diff --git a/doc/Development.md b/doc/Development.md deleted file mode 100644 index 6cfcb683..00000000 --- a/doc/Development.md +++ /dev/null | |||
| @@ -1,35 +0,0 @@ | |||
| 1 | #Development | ||
| 2 | ## Guidelines | ||
| 3 | Please have a look at the following pages: | ||
| 4 | - [Contributing to Shaarli](https://github.com/shaarli/Shaarli/tree/master/CONTRIBUTING.md)[](.html) | ||
| 5 | - [Static analysis](Static-analysis.html) - patches should try to stick to the [PHP Standard Recommendations](http://www.php-fig.org/psr/) (PSR), especially: | ||
| 6 | - [PSR-1](http://www.php-fig.org/psr/psr-1/) - Basic Coding Standard[](.html) | ||
| 7 | - [PSR-2](http://www.php-fig.org/psr/psr-2/) - Coding Style Guide[](.html) | ||
| 8 | - [Unit tests](Unit-tests.html) | ||
| 9 | - [GnuPG signature](GnuPG-signature.html) for tags/releases | ||
| 10 | |||
| 11 | ## Continuous integration tools | ||
| 12 | ### Local development | ||
| 13 | A [`Makefile`](https://github.com/shaarli/Shaarli/blob/master/Makefile) is available to perform project-related operations:[](.html) | ||
| 14 | - Documentation - generate a local HTML copy of the GitHub wiki | ||
| 15 | - [Static analysis](Static-analysis.html) - check that the code is compliant to PHP conventions | ||
| 16 | - [Unit tests](Unit-tests.html) - ensure there are no regressions introduced by new commits | ||
| 17 | |||
| 18 | ### Automatic builds | ||
| 19 | [Travis CI](http://docs.travis-ci.com/) is a Continuous Integration build server, that runs a build:[](.html) | ||
| 20 | - each time a commit is merged to the mainline (`master` branch) | ||
| 21 | - each time a Pull Request is submitted or updated | ||
| 22 | |||
| 23 | A build is composed of several jobs: one for each supported PHP version (see [Server requirements](Server-requirements.html)). | ||
| 24 | |||
| 25 | Each build job: | ||
| 26 | - updates Composer | ||
| 27 | - installs 3rd-party test dependencies with Composer | ||
| 28 | - runs [Unit tests](Unit-tests.html) | ||
| 29 | |||
| 30 | After all jobs have finished, Travis returns the results to GitHub: | ||
| 31 | - a status icon represents the result for the `master` branch: []((https://api.travis-ci.org/shaarli/Shaarli.svg)](https://travis-ci.org/shaarli/Shaarli).html) | ||
| 32 | - Pull Requests are updated with the Travis result | ||
| 33 | - Green: all tests have passed | ||
| 34 | - Red: some tests failed | ||
| 35 | - Orange: tests are pending | ||
diff --git a/doc/Directory-structure.html b/doc/Directory-structure.html deleted file mode 100644 index 3f75db8e..00000000 --- a/doc/Directory-structure.html +++ /dev/null | |||
| @@ -1,135 +0,0 @@ | |||
| 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>Setup | ||
| 56 | <ul> | ||
| 57 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 58 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 59 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 60 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 61 | <li><a href="Server-security.html">Server security</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 | <li><a href="REST-API.html">REST API</a></li> | ||
| 73 | </ul></li> | ||
| 74 | <li>How To | ||
| 75 | <ul> | ||
| 76 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</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="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 92 | <li><a href="Security.html">Security</a></li> | ||
| 93 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 94 | <li><a href="Theming.html">Theming</a></li> | ||
| 95 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 96 | </ul></li> | ||
| 97 | <li>About | ||
| 98 | <ul> | ||
| 99 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 100 | <li><a href="Community-&-Related-software.html">Community & Related software</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="ex">index.php</span> # Main program | ||
| 107 | <span class="ex">application/</span> # Shaarli classes | ||
| 108 | ├── <span class="ex">LinkDB.php</span> | ||
| 109 | └── <span class="ex">Utils.php</span> | ||
| 110 | <span class="ex">tests/</span> # Shaarli unitary <span class="kw">&</span> <span class="ex">functional</span> tests | ||
| 111 | ├── <span class="ex">LinkDBTest.php</span> | ||
| 112 | ├── <span class="ex">utils</span> # utilities to ease testing | ||
| 113 | │ └── <span class="ex">ReferenceLinkDB.php</span> | ||
| 114 | └── <span class="ex">UtilsTest.php</span> | ||
| 115 | <span class="ex">COPYING</span> # Shaarli license | ||
| 116 | <span class="ex">inc/</span> # static assets and 3rd party libraries | ||
| 117 | ├── <span class="ex">awesomplete.*</span> # tags autocompletion library | ||
| 118 | ├── <span class="ex">blazy.*</span> # picture wall lazy image loading library | ||
| 119 | ├── <span class="ex">shaarli.css</span>, reset.css <span class="co"># Shaarli stylesheet.</span> | ||
| 120 | ├── <span class="ex">qr.*</span> # qr code generation library | ||
| 121 | └──<span class="ex">rain.tpl.class.php</span> # RainTPL templating library | ||
| 122 | <span class="ex">tpl/</span> # RainTPL templates for Shaarli. They are used to build the pages. | ||
| 123 | <span class="ex">images/</span> # Images and icons used in Shaarli | ||
| 124 | <span class="ex">data/</span> # data storage: bookmark database, configuration, logs, banlist… | ||
| 125 | ├── <span class="ex">config.php</span> # Shaarli configuration (login, password, timezone, title…) | ||
| 126 | ├── <span class="ex">datastore.php</span> # Your link database (compressed)<span class="ex">.</span> | ||
| 127 | ├── <span class="ex">ipban.php</span> # IP address ban system data | ||
| 128 | ├── <span class="ex">lastupdatecheck.txt</span> # Update check timestamp file | ||
| 129 | └──<span class="ex">log.txt</span> # login/IPban log. | ||
| 130 | <span class="ex">cache/</span> # thumbnails cache | ||
| 131 | <span class="co"># This directory is automatically created. You can erase it anytime you want.</span> | ||
| 132 | <span class="ex">tmp/</span> # Temporary directory for compiled RainTPL templates. | ||
| 133 | <span class="co"># This directory is automatically created. You can erase it anytime you want.</span></code></pre></div> | ||
| 134 | </body> | ||
| 135 | </html> | ||
diff --git a/doc/Docker.html b/doc/Docker.html deleted file mode 100644 index fd0dec4b..00000000 --- a/doc/Docker.html +++ /dev/null | |||
| @@ -1,245 +0,0 @@ | |||
| 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 – Docker</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>Setup | ||
| 56 | <ul> | ||
| 57 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 58 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 59 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 60 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 61 | <li><a href="Server-security.html">Server security</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 | <li><a href="REST-API.html">REST API</a></li> | ||
| 73 | </ul></li> | ||
| 74 | <li>How To | ||
| 75 | <ul> | ||
| 76 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</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="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 92 | <li><a href="Security.html">Security</a></li> | ||
| 93 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 94 | <li><a href="Theming.html">Theming</a></li> | ||
| 95 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 96 | </ul></li> | ||
| 97 | <li>About | ||
| 98 | <ul> | ||
| 99 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 100 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 101 | </ul></li> | ||
| 102 | </ul> | ||
| 103 | </div> | ||
| 104 | <h1 id="docker">Docker</h1> | ||
| 105 | <ul> | ||
| 106 | <li><a href="#docker-usage">Docker usage</a><a href=".html"></a></li> | ||
| 107 | <li><a href="#get-and-run-a-shaarli-image">Get and run a Shaarli image</a><a href=".html"></a></li> | ||
| 108 | <li><a href="#resources">Resources</a><a href=".html"></a></li> | ||
| 109 | </ul> | ||
| 110 | <h2 id="docker-usage">Docker usage</h2> | ||
| 111 | <h3 id="basics">Basics</h3> | ||
| 112 | <p>Install <a href="https://www.docker.com/">Docker</a>, by following the instructions relevant<a href=".html"></a><br /> | ||
| 113 | to your OS / distribution, and start the service.</p> | ||
| 114 | <h4 id="search-an-image-on-dockerhub">Search an image on <a href="https://hub.docker.com/">DockerHub</a><a href=".html"></a></h4> | ||
| 115 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="ex">docker</span> search debian | ||
| 116 | |||
| 117 | <span class="ex">NAME</span> DESCRIPTION STARS OFFICIAL AUTOMATED | ||
| 118 | <span class="ex">ubuntu</span> Ubuntu is a Debian-based Linux operating s... 2065 [OK][](.html) | ||
| 119 | <span class="ex">debian</span> Debian is a Linux distribution that<span class="st">'s comp... 603 [OK][](.html)</span> | ||
| 120 | <span class="st">google/debian 47 [OK][](.html)</span></code></pre></div> | ||
| 121 | <h4 id="show-available-tags-for-a-repository">Show available tags for a repository</h4> | ||
| 122 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="ex">curl</span> https://index.docker.io/v1/repositories/debian/tags <span class="kw">|</span> <span class="ex">python</span> -m json.tool | ||
| 123 | |||
| 124 | <span class="ex">%</span> Total % Received % Xferd Average Speed Time Time Time Current | ||
| 125 | <span class="ex">Dload</span> Upload Total Spent Left Speed | ||
| 126 | <span class="ex">100</span> 1283 0 1283 0 0 433 0 --:--:-- 0:00:02 --:--:-- 433</code></pre></div> | ||
| 127 | <p>Sample output:</p> | ||
| 128 | <div class="sourceCode"><pre class="sourceCode json"><code class="sourceCode json"><span class="ot">[[]</span><span class="er">(.html)</span> | ||
| 129 | <span class="fu">{</span> | ||
| 130 | <span class="dt">"layer"</span><span class="fu">:</span> <span class="st">"85a02782"</span><span class="fu">,</span> | ||
| 131 | <span class="dt">"name"</span><span class="fu">:</span> <span class="st">"stretch"</span> | ||
| 132 | <span class="fu">}</span><span class="ot">,</span> | ||
| 133 | <span class="fu">{</span> | ||
| 134 | <span class="dt">"layer"</span><span class="fu">:</span> <span class="st">"59abecbc"</span><span class="fu">,</span> | ||
| 135 | <span class="dt">"name"</span><span class="fu">:</span> <span class="st">"testing"</span> | ||
| 136 | <span class="fu">}</span><span class="ot">,</span> | ||
| 137 | <span class="fu">{</span> | ||
| 138 | <span class="dt">"layer"</span><span class="fu">:</span> <span class="st">"bf0fd686"</span><span class="fu">,</span> | ||
| 139 | <span class="dt">"name"</span><span class="fu">:</span> <span class="st">"unstable"</span> | ||
| 140 | <span class="fu">}</span><span class="ot">,</span> | ||
| 141 | <span class="fu">{</span> | ||
| 142 | <span class="dt">"layer"</span><span class="fu">:</span> <span class="st">"60c52dbe"</span><span class="fu">,</span> | ||
| 143 | <span class="dt">"name"</span><span class="fu">:</span> <span class="st">"wheezy"</span> | ||
| 144 | <span class="fu">}</span><span class="ot">,</span> | ||
| 145 | <span class="fu">{</span> | ||
| 146 | <span class="dt">"layer"</span><span class="fu">:</span> <span class="st">"c5b806fe"</span><span class="fu">,</span> | ||
| 147 | <span class="dt">"name"</span><span class="fu">:</span> <span class="st">"wheezy-backports"</span> | ||
| 148 | <span class="fu">}</span> | ||
| 149 | <span class="ot">]</span></code></pre></div> | ||
| 150 | <h4 id="pull-an-image-from-dockerhub">Pull an image from DockerHub</h4> | ||
| 151 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="ex">docker</span> pull repository[:tag][](.html) | ||
| 152 | |||
| 153 | $ <span class="ex">docker</span> pull debian:wheezy | ||
| 154 | <span class="ex">wheezy</span>: Pulling from debian | ||
| 155 | <span class="ex">4c8cbfd2973e</span>: Pull complete | ||
| 156 | <span class="ex">60c52dbe9d91</span>: Pull complete | ||
| 157 | <span class="ex">Digest</span>: sha256:c584131da2ac1948aa3e66468a4424b6aea2f33acba7cec0b631bdb56254c4fe | ||
| 158 | <span class="ex">Status</span>: Downloaded newer image for debian:wheezy</code></pre></div> | ||
| 159 | <h2 id="get-and-run-a-shaarli-image">Get and run a Shaarli image</h2> | ||
| 160 | <h3 id="dockerhub-repository">DockerHub repository</h3> | ||
| 161 | <p>The images can be found in the <a href="https://hub.docker.com/r/shaarli/shaarli/"><code>shaarli/shaarli</code></a><a href=".html"></a><br /> | ||
| 162 | repository.</p> | ||
| 163 | <h3 id="available-image-tags">Available image tags</h3> | ||
| 164 | <ul> | ||
| 165 | <li><code>latest</code>: master branch (tarball release)</li> | ||
| 166 | <li><code>stable</code>: stable branch (tarball release)</li> | ||
| 167 | <li><code>dev</code>: master branch (Git clone)</li> | ||
| 168 | </ul> | ||
| 169 | <p>All images rely on:</p> | ||
| 170 | <ul> | ||
| 171 | <li><a href="https://hub.docker.com/_/debian/">Debian 8 Jessie</a><a href=".html"></a></li> | ||
| 172 | <li><a href="http://php-fpm.org/">PHP5-FPM</a><a href=".html"></a></li> | ||
| 173 | <li><a href="http://nginx.org/">Nginx</a><a href=".html"></a></li> | ||
| 174 | </ul> | ||
| 175 | <h3 id="download-from-dockerhub">Download from DockerHub</h3> | ||
| 176 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="ex">docker</span> pull shaarli/shaarli | ||
| 177 | <span class="ex">latest</span>: Pulling from shaarli/shaarli | ||
| 178 | <span class="ex">32716d9fcddb</span>: Pull complete | ||
| 179 | <span class="ex">84899d045435</span>: Pull complete | ||
| 180 | <span class="ex">4b6ad7444763</span>: Pull complete | ||
| 181 | <span class="ex">e0345ef7a3e0</span>: Pull complete | ||
| 182 | <span class="ex">5c1dd344094f</span>: Pull complete | ||
| 183 | <span class="ex">6422305a200b</span>: Pull complete | ||
| 184 | <span class="ex">7d63f861dbef</span>: Pull complete | ||
| 185 | <span class="ex">3eb97210645c</span>: Pull complete | ||
| 186 | <span class="ex">869319d746ff</span>: Already exists | ||
| 187 | <span class="ex">869319d746ff</span>: Pulling fs layer | ||
| 188 | <span class="ex">902b87aaaec9</span>: Already exists | ||
| 189 | <span class="ex">Digest</span>: sha256:f836b4627b958b3f83f59c332f22f02fcd495ace3056f2be2c4912bd8704cc98 | ||
| 190 | <span class="ex">Status</span>: Downloaded newer image for shaarli/shaarli:latest</code></pre></div> | ||
| 191 | <h3 id="create-and-start-a-new-container-from-the-image">Create and start a new container from the image</h3> | ||
| 192 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># map the host's :8000 port to the container's :80 port</span> | ||
| 193 | $ <span class="ex">docker</span> create -p 8000:80 shaarli/shaarli | ||
| 194 | <span class="ex">d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101</span> | ||
| 195 | |||
| 196 | <span class="co"># launch the container in the background</span> | ||
| 197 | $ <span class="ex">docker</span> start d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101 | ||
| 198 | <span class="ex">d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101</span> | ||
| 199 | |||
| 200 | <span class="co"># list active containers</span> | ||
| 201 | $ <span class="ex">docker</span> ps | ||
| 202 | <span class="ex">CONTAINER</span> ID IMAGE COMMAND CREATED STATUS PORTS NAMES | ||
| 203 | <span class="ex">d40b7af693d6</span> shaarli/shaarli /usr/bin/supervisor 15 seconds ago Up 4 seconds 0.0.0.0:8000-<span class="op">></span>80/tcp backstabbing_galileo</code></pre></div> | ||
| 204 | <h3 id="stop-and-destroy-a-container">Stop and destroy a container</h3> | ||
| 205 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="ex">docker</span> stop backstabbing_galileo # those docker guys are really rude to physicists! | ||
| 206 | <span class="ex">backstabbing_galileo</span> | ||
| 207 | |||
| 208 | <span class="co"># check the container is stopped</span> | ||
| 209 | $ <span class="ex">docker</span> ps | ||
| 210 | <span class="ex">CONTAINER</span> ID IMAGE COMMAND CREATED STATUS PORTS NAMES | ||
| 211 | |||
| 212 | <span class="co"># list ALL containers</span> | ||
| 213 | $ <span class="ex">docker</span> ps -a | ||
| 214 | <span class="ex">CONTAINER</span> ID IMAGE COMMAND CREATED STATUS PORTS NAMES | ||
| 215 | <span class="ex">d40b7af693d6</span> shaarli/shaarli /usr/bin/supervisor 5 minutes ago Exited (0) <span class="ex">48</span> seconds ago backstabbing_galileo | ||
| 216 | |||
| 217 | <span class="co"># destroy the container</span> | ||
| 218 | $ <span class="ex">docker</span> rm backstabbing_galileo # let<span class="st">'s put an end to these barbarian practices</span> | ||
| 219 | <span class="st">backstabbing_galileo</span> | ||
| 220 | |||
| 221 | <span class="st">$ docker ps -a</span> | ||
| 222 | <span class="st">CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES</span></code></pre></div> | ||
| 223 | <h2 id="resources">Resources</h2> | ||
| 224 | <h3 id="docker-1">Docker</h3> | ||
| 225 | <ul> | ||
| 226 | <li><a href="https://www.katacoda.com/courses/docker/">Interactive Docker training portal</a> on <a href="https://www.katacoda.com/">Katakoda</a><a href=".html"></a></li> | ||
| 227 | <li><a href="http://blog.thoward37.me/articles/where-are-docker-images-stored/">Where are Docker images stored?</a><a href=".html"></a></li> | ||
| 228 | <li><a href="https://docs.docker.com/reference/builder/">Dockerfile reference</a><a href=".html"></a></li> | ||
| 229 | <li><a href="https://docs.docker.com/articles/dockerfile_best-practices/">Dockerfile best practices</a><a href=".html"></a></li> | ||
| 230 | <li><a href="https://docs.docker.com/userguide/dockervolumes/">Volumes</a><a href=".html"></a></li> | ||
| 231 | </ul> | ||
| 232 | <h3 id="dockerhub">DockerHub</h3> | ||
| 233 | <ul> | ||
| 234 | <li><a href="https://docs.docker.com/userguide/dockerrepos/">Repositories</a><a href=".html"></a></li> | ||
| 235 | <li><a href="https://docs.docker.com/docker-hub/orgs/">Teams and organizations</a><a href=".html"></a></li> | ||
| 236 | <li><a href="https://docs.docker.com/docker-hub/github/">GitHub automated build</a><a href=".html"></a></li> | ||
| 237 | </ul> | ||
| 238 | <h3 id="service-management">Service management</h3> | ||
| 239 | <ul> | ||
| 240 | <li><a href="https://docs.docker.com/articles/using_supervisord/">Using supervisord</a><a href=".html"></a></li> | ||
| 241 | <li><a href="http://nginx.org/en/docs/ngx_core_module.html#daemon">Nginx in the foreground</a><a href=".html"></a></li> | ||
| 242 | <li><a href="http://supervisord.org/">supervisord</a><a href=".html"></a></li> | ||
| 243 | </ul> | ||
| 244 | </body> | ||
| 245 | </html> | ||
diff --git a/doc/Download-CSS-styles-from-an-OPML-list.html b/doc/Download-CSS-styles-from-an-OPML-list.html deleted file mode 100644 index 18cc5d9a..00000000 --- a/doc/Download-CSS-styles-from-an-OPML-list.html +++ /dev/null | |||
| @@ -1,257 +0,0 @@ | |||
| 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 – Download CSS styles from an OPML list</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>Setup | ||
| 56 | <ul> | ||
| 57 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 58 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 59 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 60 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 61 | <li><a href="Server-security.html">Server security</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 | <li><a href="REST-API.html">REST API</a></li> | ||
| 73 | </ul></li> | ||
| 74 | <li>How To | ||
| 75 | <ul> | ||
| 76 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</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="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 92 | <li><a href="Security.html">Security</a></li> | ||
| 93 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 94 | <li><a href="Theming.html">Theming</a></li> | ||
| 95 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 96 | </ul></li> | ||
| 97 | <li>About | ||
| 98 | <ul> | ||
| 99 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 100 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 101 | </ul></li> | ||
| 102 | </ul> | ||
| 103 | </div> | ||
| 104 | <h1 id="download-css-styles-from-an-opml-list">Download CSS styles from an OPML list</h1> | ||
| 105 | <h3 id="download-css-styles-for-shaarlis-listed-in-an-opml-file">Download CSS styles for shaarlis listed in an opml file</h3> | ||
| 106 | <p>Example php script:</p> | ||
| 107 | <div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php"><!---- <span class="ot">?</span>php --> | ||
| 108 | <!---- Copyright <span class="ot">(</span>c<span class="ot">)</span> <span class="dv">2014</span> Nicolas Delsaux <span class="ot">(</span>https<span class="ot">:</span><span class="co">//github.com/Riduidel) --></span> | ||
| 109 | <!---- License: zlib <span class="ot">(</span>http:<span class="co">//www.gzip.org/zlib/zlib_license.html) --></span> | ||
| 110 | |||
| 111 | <span class="co">/**</span> | ||
| 112 | <span class="co"> * Source: https://github.com/Riduidel</span> | ||
| 113 | <span class="co"> * Download css styles for shaarlis listed in an opml file</span> | ||
| 114 | <span class="co"> */</span> | ||
| 115 | <span class="fu">define</span><span class="ot">(</span><span class="st">"SHAARLI_RSS_OPML"</span><span class="ot">,</span> <span class="st">"https://www.ecirtam.net/shaarlirss/custom/people.opml"</span><span class="ot">);</span> | ||
| 116 | |||
| 117 | <span class="fu">define</span><span class="ot">(</span><span class="st">"THEMES_TEMP_FOLDER"</span><span class="ot">,</span> <span class="st">"new_themes"</span><span class="ot">);</span> | ||
| 118 | |||
| 119 | <span class="kw">if</span><span class="ot">(</span>!<span class="fu">file_exists</span><span class="ot">(</span><span class="kw">THEMES_TEMP_FOLDER</span><span class="ot">))</span> { | ||
| 120 | <span class="fu">mkdir</span><span class="ot">(</span><span class="kw">THEMES_TEMP_FOLDER</span><span class="ot">);</span> | ||
| 121 | } | ||
| 122 | |||
| 123 | <span class="kw">function</span> siteUrl<span class="ot">(</span><span class="kw">$pathInSite</span><span class="ot">)</span> { | ||
| 124 | <span class="kw">$indexPos</span> = <span class="fu">strpos</span><span class="ot">(</span><span class="kw">$pathInSite</span><span class="ot">,</span> <span class="st">"index.php"</span><span class="ot">);</span> | ||
| 125 | <span class="kw">if</span><span class="ot">(</span>!<span class="kw">$indexPos</span><span class="ot">)</span> { | ||
| 126 | <span class="kw">return</span> <span class="kw">$pathInSite</span><span class="ot">;</span> | ||
| 127 | } <span class="kw">else</span> { | ||
| 128 | <span class="kw">return</span> <span class="fu">substr</span><span class="ot">(</span><span class="kw">$pathInSite</span><span class="ot">,</span> <span class="dv">0</span><span class="ot">,</span> <span class="kw">$indexPos</span><span class="ot">);</span> | ||
| 129 | } | ||
| 130 | } | ||
| 131 | |||
| 132 | <span class="kw">function</span> createShaarliHashFromOPMLL<span class="ot">(</span><span class="kw">$opmlFile</span><span class="ot">)</span> { | ||
| 133 | <span class="kw">$result</span> = <span class="fu">array</span><span class="ot">();</span> | ||
| 134 | <span class="kw">$opml</span> = <span class="fu">file_get_contents</span><span class="ot">(</span><span class="kw">$opmlFile</span><span class="ot">);</span> | ||
| 135 | <span class="kw">$opmlXml</span> = <span class="fu">simplexml_load_string</span><span class="ot">(</span><span class="kw">$opml</span><span class="ot">);</span> | ||
| 136 | <span class="kw">$outlineElements</span> = <span class="kw">$opmlXml</span>->xpath<span class="ot">(</span><span class="st">"body/outline"</span><span class="ot">);</span> | ||
| 137 | <span class="kw">foreach</span><span class="ot">(</span><span class="kw">$outlineElements</span> <span class="kw">as</span> <span class="kw">$site</span><span class="ot">)</span> { | ||
| 138 | <span class="kw">$siteUrl</span> = siteUrl<span class="ot">(</span><span class="dt">(string)</span> <span class="kw">$site</span><span class="ot">[</span><span class="st">'htmlUrl'</span><span class="ot">]);[](</span>.html<span class="ot">)</span> | ||
| 139 | <span class="kw">$result</span><span class="ot">[</span><span class="kw">$siteUrl</span><span class="ot">]</span>=<span class="ot">(</span><span class="dt">(string)</span> <span class="kw">$site</span><span class="ot">[</span><span class="st">'text'</span><span class="ot">]);[](</span>.html<span class="ot">)</span> | ||
| 140 | } | ||
| 141 | <span class="kw">return</span> <span class="kw">$result</span><span class="ot">;</span> | ||
| 142 | } | ||
| 143 | |||
| 144 | <span class="kw">function</span> getSiteFolder<span class="ot">(</span><span class="kw">$url</span><span class="ot">)</span> { | ||
| 145 | <span class="kw">$domain</span> = <span class="fu">parse_url</span><span class="ot">(</span><span class="kw">$url</span><span class="ot">,</span> <span class="kw">PHP_URL_HOST</span><span class="ot">);</span> | ||
| 146 | <span class="kw">return</span> <span class="kw">THEMES_TEMP_FOLDER</span>.<span class="st">"/"</span>.<span class="fu">str_replace</span><span class="ot">(</span><span class="st">"."</span><span class="ot">,</span> <span class="st">"_"</span><span class="ot">,</span> <span class="kw">$domain</span><span class="ot">);</span> | ||
| 147 | } | ||
| 148 | |||
| 149 | <span class="kw">function</span> get_http_response_code<span class="ot">(</span><span class="kw">$theURL</span><span class="ot">)</span> { | ||
| 150 | <span class="kw">$headers</span> = <span class="fu">get_headers</span><span class="ot">(</span><span class="kw">$theURL</span><span class="ot">);</span> | ||
| 151 | <span class="kw">return</span> <span class="fu">substr</span><span class="ot">(</span><span class="kw">$headers</span><span class="ot">[</span><span class="dv">0</span><span class="ot">],</span> <span class="dv">9</span><span class="ot">,</span> <span class="dv">3</span><span class="ot">);[](</span>.html<span class="ot">)</span> | ||
| 152 | } | ||
| 153 | |||
| 154 | <span class="co">/**</span> | ||
| 155 | <span class="co"> * This makes the code PHP-5 only (particularly the call to "get_headers")</span> | ||
| 156 | <span class="co"> */</span> | ||
| 157 | <span class="kw">function</span> copyUserStyleFrom<span class="ot">(</span><span class="kw">$url</span><span class="ot">,</span> <span class="kw">$name</span><span class="ot">,</span> <span class="kw">$knownStyles</span><span class="ot">)</span> { | ||
| 158 | <span class="kw">$userStyle</span> = <span class="kw">$url</span>.<span class="st">"inc/user.css"</span><span class="ot">;</span> | ||
| 159 | <span class="kw">if</span><span class="ot">(</span><span class="fu">in_array</span><span class="ot">(</span><span class="kw">$url</span><span class="ot">,</span> <span class="kw">$knownStyles</span><span class="ot">))</span> { | ||
| 160 | <span class="co">// </span><span class="al">TODO</span><span class="co"> add log message</span> | ||
| 161 | } <span class="kw">else</span> { | ||
| 162 | <span class="kw">$statusCode</span> = get_http_response_code<span class="ot">(</span><span class="kw">$userStyle</span><span class="ot">);</span> | ||
| 163 | <span class="kw">if</span><span class="ot">(</span><span class="fu">intval</span><span class="ot">(</span><span class="kw">$statusCode</span><span class="ot">)</span><<span class="dv">300</span><span class="ot">)</span> { | ||
| 164 | <span class="kw">$styleSheet</span> = <span class="fu">file_get_contents</span><span class="ot">(</span><span class="kw">$userStyle</span><span class="ot">);</span> | ||
| 165 | <span class="kw">$siteFolder</span> = getSiteFolder<span class="ot">(</span><span class="kw">$url</span><span class="ot">);</span> | ||
| 166 | <span class="kw">if</span><span class="ot">(</span>!<span class="fu">file_exists</span><span class="ot">(</span><span class="kw">$siteFolder</span><span class="ot">))</span> { | ||
| 167 | <span class="fu">mkdir</span><span class="ot">(</span><span class="kw">$siteFolder</span><span class="ot">);</span> | ||
| 168 | } | ||
| 169 | <span class="kw">if</span><span class="ot">(</span>!<span class="fu">file_exists</span><span class="ot">(</span><span class="kw">$siteFolder</span>.<span class="st">'/user.css'</span><span class="ot">))</span> { | ||
| 170 | <span class="co">// Copy stylesheet</span> | ||
| 171 | <span class="fu">file_put_contents</span><span class="ot">(</span><span class="kw">$siteFolder</span>.<span class="st">'/user.css'</span><span class="ot">,</span> <span class="kw">$styleSheet</span><span class="ot">);</span> | ||
| 172 | } | ||
| 173 | <span class="kw">if</span><span class="ot">(</span>!<span class="fu">file_exists</span><span class="ot">(</span><span class="kw">$siteFolder</span>.<span class="st">'/README.md'</span><span class="ot">))</span> { | ||
| 174 | <span class="co">// Then write a readme.md file</span> | ||
| 175 | <span class="fu">file_put_contents</span><span class="ot">(</span><span class="kw">$siteFolder</span>.<span class="st">'/README.md'</span><span class="ot">,</span> | ||
| 176 | <span class="st">"User style from "</span>.<span class="kw">$name</span>.<span class="st">"</span><span class="kw">\n</span><span class="st">"</span> | ||
| 177 | .<span class="st">"============================="</span> | ||
| 178 | .<span class="st">"</span><span class="kw">\n\n</span><span class="st">"</span> | ||
| 179 | .<span class="st">"This stylesheet was downloaded from "</span>.<span class="kw">$userStyle</span>.<span class="st">" on "</span>.<span class="fu">date</span><span class="ot">(</span><span class="kw">DATE_RFC822</span><span class="ot">)</span> | ||
| 180 | <span class="ot">);</span> | ||
| 181 | } | ||
| 182 | <span class="kw">if</span><span class="ot">(</span>!<span class="fu">file_exists</span><span class="ot">(</span><span class="kw">$siteFolder</span>.<span class="st">'/config.ini'</span><span class="ot">))</span> { | ||
| 183 | <span class="co">// Write a config file containing useful informations</span> | ||
| 184 | <span class="fu">file_put_contents</span><span class="ot">(</span><span class="kw">$siteFolder</span>.<span class="st">'/config.ini'</span><span class="ot">,</span> | ||
| 185 | <span class="st">"site_url="</span>.<span class="kw">$url</span>.<span class="st">"</span><span class="kw">\n</span><span class="st">"</span> | ||
| 186 | .<span class="st">"site_name="</span>.<span class="kw">$name</span>.<span class="st">"</span><span class="kw">\n</span><span class="st">"</span> | ||
| 187 | <span class="ot">);</span> | ||
| 188 | } | ||
| 189 | <span class="kw">if</span><span class="ot">(</span>!<span class="fu">file_exists</span><span class="ot">(</span><span class="kw">$siteFolder</span>.<span class="st">'/home.png'</span><span class="ot">))</span> { | ||
| 190 | <span class="co">// And finally copy generated thumbnail</span> | ||
| 191 | <span class="kw">$homeThumb</span> = <span class="kw">$siteFolder</span>.<span class="st">'/home.png'</span><span class="ot">;</span> | ||
| 192 | <span class="fu">file_put_contents</span><span class="ot">(</span><span class="kw">$siteFolder</span>.<span class="st">'/home.png'</span><span class="ot">,</span> <span class="fu">file_get_contents</span><span class="ot">(</span>getThumbnailUrl<span class="ot">(</span><span class="kw">$url</span><span class="ot">)));</span> | ||
| 193 | } | ||
| 194 | <span class="fu">echo</span> <span class="st">'Theme have been downloaded from <a href="'</span>.<span class="kw">$url</span>.<span class="st">'">'</span>.<span class="kw">$url</span>.<span class="st">'</a> into '</span>.<span class="kw">$siteFolder</span> | ||
| 195 | .<span class="st">'. It looks like <img src="'</span>.<span class="kw">$homeThumb</span>.<span class="st">'"><br/>'</span><span class="ot">;</span> | ||
| 196 | } | ||
| 197 | } | ||
| 198 | } | ||
| 199 | |||
| 200 | <span class="kw">function</span> getThumbnailUrl<span class="ot">(</span><span class="kw">$url</span><span class="ot">)</span> { | ||
| 201 | <span class="kw">return</span> <span class="st">'http://api.webthumbnail.org/?url='</span>.<span class="kw">$url</span><span class="ot">;</span> | ||
| 202 | } | ||
| 203 | |||
| 204 | <span class="kw">function</span> copyUserStylesFrom<span class="ot">(</span><span class="kw">$urlToNames</span><span class="ot">,</span> <span class="kw">$knownStyles</span><span class="ot">)</span> { | ||
| 205 | <span class="kw">foreach</span><span class="ot">(</span><span class="kw">$urlToNames</span> <span class="kw">as</span> <span class="kw">$url</span> => <span class="kw">$name</span><span class="ot">)</span> { | ||
| 206 | copyUserStyleFrom<span class="ot">(</span><span class="kw">$url</span><span class="ot">,</span> <span class="kw">$name</span><span class="ot">,</span> <span class="kw">$knownStyles</span><span class="ot">);</span> | ||
| 207 | } | ||
| 208 | } | ||
| 209 | |||
| 210 | <span class="co">/**</span> | ||
| 211 | <span class="co"> * Reading directory list, courtesy of http://www.laughing-buddha.net/php/dirlist/</span> | ||
| 212 | <span class="co"> * </span><span class="an">@param</span><span class="co"> </span><span class="cv">directory</span><span class="co"> the directory we want to list files of</span> | ||
| 213 | <span class="co"> * </span><span class="an">@return</span><span class="co"> a simple array containing the list of absolute file paths. Notice that current file (".") and parent one("..")</span> | ||
| 214 | <span class="co"> * are not listed here</span> | ||
| 215 | <span class="co"> */</span> | ||
| 216 | <span class="kw">function</span> getDirectoryList <span class="ot">(</span><span class="kw">$directory</span><span class="ot">)</span> { | ||
| 217 | <span class="kw">$realPath</span> = <span class="fu">realpath</span><span class="ot">(</span><span class="kw">$directory</span><span class="ot">);</span> | ||
| 218 | <span class="co">// create an array to hold directory list</span> | ||
| 219 | <span class="kw">$results</span> = <span class="fu">array</span><span class="ot">();</span> | ||
| 220 | <span class="co">// create a handler for the directory</span> | ||
| 221 | <span class="kw">$handler</span> = <span class="fu">opendir</span><span class="ot">(</span><span class="kw">$directory</span><span class="ot">);</span> | ||
| 222 | <span class="co">// open directory and walk through the filenames</span> | ||
| 223 | <span class="kw">while</span> <span class="ot">(</span><span class="kw">$file</span> = <span class="fu">readdir</span><span class="ot">(</span><span class="kw">$handler</span><span class="ot">))</span> { | ||
| 224 | <span class="co">// if file isn't this directory or its parent, add it to the results</span> | ||
| 225 | <span class="kw">if</span> <span class="ot">(</span><span class="kw">$file</span> != <span class="st">"."</span> && <span class="kw">$file</span> != <span class="st">".."</span><span class="ot">)</span> { | ||
| 226 | <span class="kw">$results</span><span class="ot">[</span> = <span class="fu">realpath</span><span class="ot">(</span><span class="kw">$realPath</span> . <span class="st">"/"</span> . <span class="kw">$file</span><span class="ot">);](</span>-=-<span class="fu">realpath</span><span class="ot">(</span><span class="kw">$realPath</span>-.-<span class="st">"/"</span>-.-<span class="kw">$file</span><span class="ot">);</span>.html<span class="ot">)</span> | ||
| 227 | } | ||
| 228 | } | ||
| 229 | <span class="co">// tidy up: close the handler</span> | ||
| 230 | <span class="fu">closedir</span><span class="ot">(</span><span class="kw">$handler</span><span class="ot">);</span> | ||
| 231 | <span class="co">// done!</span> | ||
| 232 | <span class="kw">return</span> <span class="kw">$results</span><span class="ot">;</span> | ||
| 233 | } | ||
| 234 | |||
| 235 | <span class="co">/**</span> | ||
| 236 | <span class="co"> * Start in themes folder and look in all subfolders for config.ini files. </span> | ||
| 237 | <span class="co"> * These config.ini files allow us not to download styles again and again</span> | ||
| 238 | <span class="co"> */</span> | ||
| 239 | <span class="kw">function</span> findKnownStyles<span class="ot">()</span> { | ||
| 240 | <span class="kw">$result</span> = <span class="fu">array</span><span class="ot">();</span> | ||
| 241 | <span class="kw">$subFolders</span> = getDirectoryList<span class="ot">(</span><span class="st">"themes"</span><span class="ot">);</span> | ||
| 242 | <span class="kw">foreach</span><span class="ot">(</span><span class="kw">$subFolders</span> <span class="kw">as</span> <span class="kw">$folder</span><span class="ot">)</span> { | ||
| 243 | <span class="kw">$configFile</span> = <span class="kw">$folder</span>.<span class="st">"/config.ini"</span><span class="ot">;</span> | ||
| 244 | <span class="kw">if</span><span class="ot">(</span><span class="fu">file_exists</span><span class="ot">(</span><span class="kw">$configFile</span><span class="ot">))</span> { | ||
| 245 | <span class="kw">$iniParameters</span> = <span class="fu">parse_ini_file</span><span class="ot">(</span><span class="kw">$configFile</span><span class="ot">);</span> | ||
| 246 | <span class="fu">array_push</span><span class="ot">(</span><span class="kw">$result</span><span class="ot">,</span> <span class="kw">$iniParameters</span><span class="ot">[</span><span class="st">'site_url'</span><span class="ot">]);[](</span>.html<span class="ot">)</span> | ||
| 247 | } | ||
| 248 | } | ||
| 249 | <span class="kw">return</span> <span class="kw">$result</span><span class="ot">;</span> | ||
| 250 | } | ||
| 251 | |||
| 252 | <span class="kw">$knownStyles</span> = findKnownStyles<span class="ot">();</span> | ||
| 253 | copyUserStylesFrom<span class="ot">(</span>createShaarliHashFromOPMLL<span class="ot">(</span><span class="kw">SHAARLI_RSS_OPML</span><span class="ot">),</span> <span class="kw">$knownStyles</span><span class="ot">);</span> | ||
| 254 | |||
| 255 | <!--- <span class="ot">?</span> ----></code></pre></div> | ||
| 256 | </body> | ||
| 257 | </html> | ||
diff --git a/doc/Download-and-Installation.html b/doc/Download-and-Installation.html deleted file mode 100644 index 2c5b3be2..00000000 --- a/doc/Download-and-Installation.html +++ /dev/null | |||
| @@ -1,172 +0,0 @@ | |||
| 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 – Download and Installation</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>Setup | ||
| 56 | <ul> | ||
| 57 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 58 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 59 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 60 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 61 | <li><a href="Server-security.html">Server security</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 | <li><a href="REST-API.html">REST API</a></li> | ||
| 73 | </ul></li> | ||
| 74 | <li>How To | ||
| 75 | <ul> | ||
| 76 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</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="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 92 | <li><a href="Security.html">Security</a></li> | ||
| 93 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 94 | <li><a href="Theming.html">Theming</a></li> | ||
| 95 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 96 | </ul></li> | ||
| 97 | <li>About | ||
| 98 | <ul> | ||
| 99 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 100 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 101 | </ul></li> | ||
| 102 | </ul> | ||
| 103 | </div> | ||
| 104 | <h1 id="download-and-installation">Download and Installation</h1> | ||
| 105 | <h1 id="get-shaarli">Get Shaarli!</h1> | ||
| 106 | <p>To install Shaarli, simply place the files in a directory under your webserver's Document Root (or directly at the document root). Make sure your <a href="Server-requirements">server</a> is properly <a href="Server-configuration">configured</a>.<a href=".html"></a></p> | ||
| 107 | <p>Several releases are available:</p> | ||
| 108 | <hr /> | ||
| 109 | <h2 id="latest-release-recommended">Latest release (recommended)</h2> | ||
| 110 | <h3 id="download-as-an-archive">Download as an archive</h3> | ||
| 111 | <p>Get the latest released version from the <a href="https://github.com/shaarli/Shaarli/releases">releases</a> page.<a href=".html"></a></p> | ||
| 112 | <p><strong>Download our <em>shaarli-full</em> archive</strong> to include dependencies.</p> | ||
| 113 | <p>The current latest released version is <code>v0.8.4</code></p> | ||
| 114 | <p>Or in command lines:</p> | ||
| 115 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="fu">wget</span> https://github.com/shaarli/Shaarli/releases/download/v0.8.4/shaarli-v0.8.4-full.zip | ||
| 116 | $ <span class="fu">unzip</span> shaarli-v0.8.4-full.zip | ||
| 117 | $ <span class="fu">mv</span> Shaarli /path/to/shaarli/</code></pre></div> | ||
| 118 | <table style="width:46%;"> | ||
| 119 | <colgroup> | ||
| 120 | <col style="width: 8%" /> | ||
| 121 | <col style="width: 37%" /> | ||
| 122 | </colgroup> | ||
| 123 | <thead> | ||
| 124 | <tr class="header"> | ||
| 125 | <th>!</th> | ||
| 126 | <th>In most cases, download Shaarli from the <a href="https://github.com/shaarli/Shaarli/releases">releases</a> page. Cloning using <code>git</code> or downloading Github branches as zip files requires additional steps (see below).</th> | ||
| 127 | </tr> | ||
| 128 | </thead> | ||
| 129 | <tbody> | ||
| 130 | </tbody> | ||
| 131 | </table> | ||
| 132 | <h3 id="using-git">Using git</h3> | ||
| 133 | <pre><code>mkdir -p /path/to/shaarli && cd /path/to/shaarli/ | ||
| 134 | git clone -b v0.8 https://github.com/shaarli/Shaarli.git . | ||
| 135 | composer install --no-dev</code></pre> | ||
| 136 | <hr /> | ||
| 137 | <h2 id="stable-version">Stable version</h2> | ||
| 138 | <p>The stable version has been experienced by Shaarli users, and will receive security updates.</p> | ||
| 139 | <h3 id="download-as-an-archive-1">Download as an archive</h3> | ||
| 140 | <p>As a .zip archive:</p> | ||
| 141 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="fu">wget</span> https://github.com/shaarli/Shaarli/archive/stable.zip | ||
| 142 | $ <span class="fu">unzip</span> stable.zip | ||
| 143 | $ <span class="fu">mv</span> Shaarli-stable /path/to/shaarli/</code></pre></div> | ||
| 144 | <p>As a .tar.gz archive :</p> | ||
| 145 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="fu">wget</span> https://github.com/shaarli/Shaarli/archive/stable.tar.gz | ||
| 146 | $ <span class="fu">tar</span> xvf stable.tar.gz | ||
| 147 | $ <span class="fu">mv</span> Shaarli-stable /path/to/shaarli/</code></pre></div> | ||
| 148 | <h3 id="clone-with-git">Clone with Git</h3> | ||
| 149 | <p><a href="https://getcomposer.org/">Composer</a> is required to build a functional Shaarli installation when pulling from git.<a href=".html"></a></p> | ||
| 150 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="fu">git</span> clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/ | ||
| 151 | <span class="co"># install/update third-party dependencies</span> | ||
| 152 | $ <span class="bu">cd</span> /path/to/shaarli/ | ||
| 153 | $ <span class="ex">composer</span> install --no-dev</code></pre></div> | ||
| 154 | <hr /> | ||
| 155 | <h2 id="development-version-mainline">Development version (mainline)</h2> | ||
| 156 | <p><em>Use at your own risk!</em></p> | ||
| 157 | <p>To get the latest changes from the <code>master</code> branch:</p> | ||
| 158 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># clone the repository </span> | ||
| 159 | $ <span class="fu">git</span> clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/ | ||
| 160 | <span class="co"># install/update third-party dependencies</span> | ||
| 161 | $ <span class="bu">cd</span> /path/to/shaarli | ||
| 162 | $ <span class="ex">composer</span> install --no-dev</code></pre></div> | ||
| 163 | <hr /> | ||
| 164 | <h2 id="finish-installation">Finish Installation</h2> | ||
| 165 | <p>Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser.</p> | ||
| 166 | <p><img src="http://i.imgur.com/wuMpDSN.png" alt="install screenshot" /><a href=".html"></a></p> | ||
| 167 | <p>Setup your Shaarli installation, and it's ready to use!</p> | ||
| 168 | <hr /> | ||
| 169 | <h2 id="updating-shaarli">Updating Shaarli</h2> | ||
| 170 | <p>See <a href="Upgrade-and-migration">Upgrade and Migration</a><a href=".html"></a></p> | ||
| 171 | </body> | ||
| 172 | </html> | ||
diff --git a/doc/Example-patch---add-new-via-field-for-links.html b/doc/Example-patch---add-new-via-field-for-links.html deleted file mode 100644 index 49036a74..00000000 --- a/doc/Example-patch---add-new-via-field-for-links.html +++ /dev/null | |||
| @@ -1,254 +0,0 @@ | |||
| 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 – Example patch add new via field for links</title> | ||
| 8 | <style type="text/css">code{white-space: pre;}</style> | ||
| 9 | <link rel="stylesheet" href="github-markdown.css"> | ||
| 10 | <!--[if lt IE 9]> | ||
| 11 | <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script> | ||
| 12 | <![endif]--> | ||
| 13 | </head> | ||
| 14 | <body> | ||
| 15 | <div id="local-sidebar"> | ||
| 16 | <ul> | ||
| 17 | <li><a href="Home.html">Home</a></li> | ||
| 18 | <li>Setup | ||
| 19 | <ul> | ||
| 20 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 21 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 22 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 23 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 24 | <li><a href="Server-security.html">Server security</a></li> | ||
| 25 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> | ||
| 26 | <li><a href="Plugins.html">Plugins</a></li> | ||
| 27 | </ul></li> | ||
| 28 | <li><a href="Docker.html">Docker</a></li> | ||
| 29 | <li><a href="Usage.html">Usage</a> | ||
| 30 | <ul> | ||
| 31 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> | ||
| 32 | <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li> | ||
| 33 | <li><a href="Firefox-share.html">Firefox share</a></li> | ||
| 34 | <li><a href="RSS-feeds.html">RSS feeds</a></li> | ||
| 35 | <li><a href="REST-API.html">REST API</a></li> | ||
| 36 | </ul></li> | ||
| 37 | <li>How To | ||
| 38 | <ul> | ||
| 39 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | ||
| 40 | <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> | ||
| 41 | <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li> | ||
| 42 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> | ||
| 43 | <li><a href="Datastore-hacks.html">Datastore hacks</a></li> | ||
| 44 | </ul></li> | ||
| 45 | <li><a href="Troubleshooting.html">Troubleshooting</a></li> | ||
| 46 | <li><a href="Development.html">Development</a> | ||
| 47 | <ul> | ||
| 48 | <li><a href="GnuPG-signature.html">GnuPG signature</a></li> | ||
| 49 | <li><a href="Coding-guidelines.html">Coding guidelines</a></li> | ||
| 50 | <li><a href="Directory-structure.html">Directory structure</a></li> | ||
| 51 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> | ||
| 52 | <li><a href="Plugin-System.html">Plugin System</a></li> | ||
| 53 | <li><a href="Release-Shaarli.html">Release Shaarli</a></li> | ||
| 54 | <li><a href="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 55 | <li><a href="Security.html">Security</a></li> | ||
| 56 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 57 | <li><a href="Theming.html">Theming</a></li> | ||
| 58 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 59 | </ul></li> | ||
| 60 | <li>About | ||
| 61 | <ul> | ||
| 62 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 63 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 64 | </ul></li> | ||
| 65 | </ul> | ||
| 66 | </div> | ||
| 67 | <h1 id="example-patch-add-new-via-field-for-links">Example patch add new via field for links</h1> | ||
| 68 | <p>Example patch to add a new field ("via") for links, an input field to set the "via" property from the "edit link" dialog, and display the "via" field in the link list display. <strong>Untested, use at your own risk</strong></p> | ||
| 69 | <p>Thanks to @Knah-Tsaeb in <a href="https://github.com/sebsauvage/Shaarli/pull/158" class="uri">https://github.com/sebsauvage/Shaarli/pull/158</a></p> | ||
| 70 | <pre><code>From e0f363c18e8fe67990ed2bb1a08652e24e70bbcb Mon Sep 17 00:00:00 2001 | ||
| 71 | From: Knah Tsaeb <knah-tsaeb@knah-tsaeb.org> | ||
| 72 | Date: Fri, 11 Oct 2013 15:18:37 +0200 | ||
| 73 | Subject: [PATCH] Add a "via"/origin property for links, add new input in "edit link" dialog[](.html) | ||
| 74 | Thanks to: | ||
| 75 | * https://github.com/Knah-Tsaeb/Shaarli/commit/040eb18ec8cdabd5ea855e108f81f97fbf0478c4 | ||
| 76 | * https://github.com/Knah-Tsaeb/Shaarli/commit/4123658eae44d7564d1128ce52ddd5689efee813 | ||
| 77 | * https://github.com/Knah-Tsaeb/Shaarli/commit/f1a8ca9cc8fe49b119d51b2d8382cc1a34542f96 | ||
| 78 | |||
| 79 | --- | ||
| 80 | index.php | 43 ++++++++++++++++++++++++++++++++----------- | ||
| 81 | tpl/editlink.html | 1 + | ||
| 82 | tpl/linklist.html | 1 + | ||
| 83 | 3 files changed, 34 insertions(+), 11 deletions(-) | ||
| 84 | |||
| 85 | diff --git a/index.php b/index.php | ||
| 86 | index 6fae2f8..53f798e 100644 | ||
| 87 | --- a/index.php | ||
| 88 | +++ b/index.php | ||
| 89 | @@ -436,6 +436,12 @@ if (isset($_POST['login']))[](.html) | ||
| 90 | // ------------------------------------------------------------------------------------------ | ||
| 91 | // Misc utility functions: | ||
| 92 | |||
| 93 | +// Try to get just domain for @via | ||
| 94 | +function getJustDomain($url){ | ||
| 95 | + $parts = parse_url($url); | ||
| 96 | + return trim($parts['host']);[](.html) | ||
| 97 | + } | ||
| 98 | + | ||
| 99 | // Returns the server URL (including port and http/https), without path. | ||
| 100 | // e.g. "http://myserver.com:8080" | ||
| 101 | // You can append $_SERVER['SCRIPT_NAME'] to get the current script URL.[](.html) | ||
| 102 | @@ -799,7 +805,8 @@ class linkdb implements Iterator, Countable, ArrayAccess | ||
| 103 | $found= (strpos(strtolower($l['title']),$s)!==false)[](.html) | ||
| 104 | || (strpos(strtolower($l['description']),$s)!==false)[](.html) | ||
| 105 | || (strpos(strtolower($l['url']),$s)!==false)[](.html) | ||
| 106 | - || (strpos(strtolower($l['tags']),$s)!==false);[](.html) | ||
| 107 | + || (strpos(strtolower($l['tags']),$s)!==false)[](.html) | ||
| 108 | + || (!empty($l['via']) && (strpos(strtolower($l['via']),$s)!==false));[](.html) | ||
| 109 | if ($found) $filtered[$l['linkdate'[ = $l;](-=-$l;.html) | ||
| 110 | } | ||
| 111 | krsort($filtered); | ||
| 112 | @@ -814,7 +821,7 @@ class linkdb implements Iterator, Countable, ArrayAccess | ||
| 113 | $t = str_replace(',',' ',($casesensitive?$tags:strtolower($tags))); | ||
| 114 | $searchtags=explode(' ',$t); | ||
| 115 | $filtered=array(); | ||
| 116 | - foreach($this->links as $l) | ||
| 117 | + foreach($this-> links as $l) | ||
| 118 | { | ||
| 119 | $linktags = explode(' ',($casesensitive?$l['tags']:strtolower($l['tags'])));[](.html) | ||
| 120 | if (count(array_intersect($linktags,$searchtags)) == count($searchtags)) | ||
| 121 | @@ -905,7 +912,7 @@ function showRSS() | ||
| 122 | else $linksToDisplay = $LINKSDB; | ||
| 123 | $nblinksToDisplay = 50; // Number of links to display. | ||
| 124 | if (!empty($_GET['nb'])) // In URL, you can specificy the number of links. Example: nb=200 or nb=all for all links.[](.html) | ||
| 125 | - { | ||
| 126 | + { | ||
| 127 | $nblinksToDisplay = $_GET['nb']=='all' ? count($linksToDisplay) : max($_GET['nb']+0,1) ;[](.html) | ||
| 128 | } | ||
| 129 | |||
| 130 | @@ -944,7 +951,12 @@ function showRSS() | ||
| 131 | // If user wants permalinks first, put the final link in description | ||
| 132 | if ($usepermalinks===true) $descriptionlink = '(<a href="'.$absurl.'">Link</a>)'; | ||
| 133 | if (strlen($link['description'])>0) $descriptionlink = '<br>'.$descriptionlink;[](.html) | ||
| 134 | - echo '<description><![CDATA['.nl2br(keepMultipleSpaces(text2clickable(htmlspecialchars($link['description'])))).$descriptionlink.'[></description>'."\n</item>\n";](></description>'."\n</item>\n";.html) | ||
| 135 | + if(!empty($link['via'])){[](.html) | ||
| 136 | + $via = '<br>Origine => <a href="'.htmlspecialchars($link['via']).'">'.htmlspecialchars(getJustDomain($link['via'])).'</a>';[](.html) | ||
| 137 | + } else { | ||
| 138 | + $via = ''; | ||
| 139 | + } | ||
| 140 | + echo '<description><![CDATA['.nl2br(keepMultipleSpaces(text2clickable(htmlspecialchars($link['description'])))).$via.$descriptionlink.'[></description>'."\n</item>\n";](></description>'."\n</item>\n";.html) | ||
| 141 | $i++; | ||
| 142 | } | ||
| 143 | echo '</channel></rss><!-- Cached version of '.htmlspecialchars(pageUrl()).' -->'; | ||
| 144 | @@ -980,7 +992,7 @@ function showATOM() | ||
| 145 | else $linksToDisplay = $LINKSDB; | ||
| 146 | $nblinksToDisplay = 50; // Number of links to display. | ||
| 147 | if (!empty($_GET['nb'])) // In URL, you can specificy the number of links. Example: nb=200 or nb=all for all links.[](.html) | ||
| 148 | - { | ||
| 149 | + { | ||
| 150 | $nblinksToDisplay = $_GET['nb']=='all' ? count($linksToDisplay) : max($_GET['nb']+0,1) ;[](.html) | ||
| 151 | } | ||
| 152 | |||
| 153 | @@ -1006,11 +1018,16 @@ function showATOM() | ||
| 154 | |||
| 155 | // Add permalink in description | ||
| 156 | $descriptionlink = htmlspecialchars('(<a href="'.$guid.'">Permalink</a>)'); | ||
| 157 | + if(isset($link['via']) && !empty($link['via'])){[](.html) | ||
| 158 | + $via = htmlspecialchars('</br> Origine => <a href="'.$link['via'].'">'.getJustDomain($link['via']).'</a>');[](.html) | ||
| 159 | + } else { | ||
| 160 | + $via = ''; | ||
| 161 | + } | ||
| 162 | // If user wants permalinks first, put the final link in description | ||
| 163 | if ($usepermalinks===true) $descriptionlink = htmlspecialchars('(<a href="'.$absurl.'">Link</a>)'); | ||
| 164 | if (strlen($link['description'])>0) $descriptionlink = '&lt;br&gt;'.$descriptionlink;[](.html) | ||
| 165 | |||
| 166 | - $entries.='<content type="html">'.htmlspecialchars(nl2br(keepMultipleSpaces(text2clickable(htmlspecialchars($link['description']))))).$descriptionlink."</content>\n";[](.html) | ||
| 167 | + $entries.='<content type="html">'.htmlspecialchars(nl2br(keepMultipleSpaces(text2clickable(htmlspecialchars($link['description']))))).$descriptionlink.$via."</content>\n";[](.html) | ||
| 168 | if ($link['tags']!='') // Adding tags to each ATOM entry (as mentioned in ATOM specification)[](.html) | ||
| 169 | { | ||
| 170 | foreach(explode(' ',$link['tags']) as $tag)[](.html) | ||
| 171 | @@ -1478,7 +1495,7 @@ function renderPage() | ||
| 172 | if (!startsWith($url,'http:') && !startsWith($url,'https:') && !startsWith($url,'ftp:') && !startsWith($url,'magnet:') && !startsWith($url,'?')) | ||
| 173 | $url = 'http://'.$url; | ||
| 174 | $link = array('title'=>trim($_POST['lf_title']),'url'=>$url,'description'=>trim($_POST['lf_description']),'private'=>(isset($_POST['lf_private']) ? 1 : 0),[](.html) | ||
| 175 | - 'linkdate'=>$linkdate,'tags'=>str_replace(',',' ',$tags)); | ||
| 176 | + 'linkdate'=>$linkdate,'tags'=>str_replace(',',' ',$tags), 'via'=>trim($_POST['lf_via']));[](.html) | ||
| 177 | if ($link['title']=='') $link['title']=$link['url']; // If title is empty, use the URL as title.[](.html) | ||
| 178 | $LINKSDB[$linkdate] = $link;[](.html) | ||
| 179 | $LINKSDB->savedb(); // Save to disk. | ||
| 180 | @@ -1556,7 +1573,8 @@ function renderPage() | ||
| 181 | $title = (empty($_GET['title']) ? '' : $_GET['title'] ); // Get title if it was provided in URL (by the bookmarklet).[](.html) | ||
| 182 | $description = (empty($_GET['description']) ? '' : $_GET['description']); // Get description if it was provided in URL (by the bookmarklet). [Bronco added that][](.html) | ||
| 183 | $tags = (empty($_GET['tags']) ? '' : $_GET['tags'] ); // Get tags if it was provided in URL[](.html) | ||
| 184 | - $private = (!empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0); // Get private if it was provided in URL [](.html) | ||
| 185 | + $via = (empty($_GET['via']) ? '' : $_GET['via'] );[](.html) | ||
| 186 | + $private = (!empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0); // Get private if it was provided in URL[](.html) | ||
| 187 | if (($url!='') && parse_url($url,PHP_URL_SCHEME)=='') $url = 'http://'.$url; | ||
| 188 | // If this is an HTTP link, we try go get the page to extract the title (otherwise we will to straight to the edit form.) | ||
| 189 | if (empty($title) && parse_url($url,PHP_URL_SCHEME)=='http') | ||
| 190 | @@ -1567,7 +1585,7 @@ function renderPage() | ||
| 191 | { | ||
| 192 | // Look for charset in html header. | ||
| 193 | preg_match('#<meta .*charset=.*>#Usi', $data, $meta); | ||
| 194 | - | ||
| 195 | + | ||
| 196 | // If found, extract encoding. | ||
| 197 | if (!empty($meta[0]))[](.html) | ||
| 198 | { | ||
| 199 | @@ -1577,7 +1595,7 @@ function renderPage() | ||
| 200 | $html_charset = (!empty($enc[1])) ? strtolower($enc[1]) : 'utf-8';[](.html) | ||
| 201 | } | ||
| 202 | else { $html_charset = 'utf-8'; } | ||
| 203 | - | ||
| 204 | + | ||
| 205 | // Extract title | ||
| 206 | $title = html_extract_title($data); | ||
| 207 | if (!empty($title)) | ||
| 208 | @@ -1592,7 +1610,7 @@ function renderPage() | ||
| 209 | $url='?'.smallHash($linkdate); | ||
| 210 | $title='Note: '; | ||
| 211 | } | ||
| 212 | - $link = array('linkdate'=>$linkdate,'title'=>$title,'url'=>$url,'description'=>$description,'tags'=>$tags,'private'=>$private); | ||
| 213 | + $link = array('linkdate'=>$linkdate,'title'=>$title,'url'=>$url,'description'=>$description,'tags'=>$tags,'via' => $via,'private'=>$private); | ||
| 214 | } | ||
| 215 | |||
| 216 | $PAGE = new pageBuilder; | ||
| 217 | @@ -1842,6 +1860,9 @@ function buildLinkList($PAGE,$LINKSDB) | ||
| 218 | $taglist = explode(' ',$link['tags']);[](.html) | ||
| 219 | uasort($taglist, 'strcasecmp'); | ||
| 220 | $link['taglist']=$taglist;[](.html) | ||
| 221 | + if(!empty($link['via'])){[](.html) | ||
| 222 | + $link['via']=htmlspecialchars($link['via']);[](.html) | ||
| 223 | + } | ||
| 224 | $linkDisp[$keys[$i[ = $link;](-=-$link;.html) | ||
| 225 | $i++; | ||
| 226 | } | ||
| 227 | diff --git a/tpl/editlink.html b/tpl/editlink.html | ||
| 228 | index 4a2c30c..14d4f9c 100644 | ||
| 229 | --- a/tpl/editlink.html | ||
| 230 | +++ b/tpl/editlink.html | ||
| 231 | @@ -16,6 +16,7 @@ | ||
| 232 | <i>Title</i><br><input type="text" name="lf_title" value="{$link.title|htmlspecialchars}" style="width:100%"><br> | ||
| 233 | <i>Description</i><br><textarea name="lf_description" rows="4" cols="25" style="width:100%">{$link.description|htmlspecialchars}</textarea><br> | ||
| 234 | <i>Tags</i><br><input type="text" id="lf_tags" name="lf_tags" value="{$link.tags|htmlspecialchars}" style="width:100%"><br> | ||
| 235 | + <i>Origine</i><br><input type="text" name="lf_via" value="{$link.via|htmlspecialchars}" style="width:100%"><br> | ||
| 236 | {if condition="($link_is_new && $GLOBALS['privateLinkByDefault']==true) || $link.private == true"}[](.html) | ||
| 237 | <input type="checkbox" checked="checked" name="lf_private" id="lf_private"> | ||
| 238 | &nbsp;<label for="lf_private"><i>Private</i></label><br> | ||
| 239 | diff --git a/tpl/linklist.html b/tpl/linklist.html | ||
| 240 | index ddc38cb..0a8475f 100644 | ||
| 241 | --- a/tpl/linklist.html | ||
| 242 | +++ b/tpl/linklist.html | ||
| 243 | @@ -43,6 +43,7 @@ | ||
| 244 | <span class="linktitle"><a href="{$redirector}{$value.url|htmlspecialchars}">{$value.title|htmlspecialchars}</a></span> | ||
| 245 | <br> | ||
| 246 | {if="$value.description"}<div class="linkdescription"{if condition="$search_type=='permalink'"} style="max-height:none !important;"{/if}>{$value.description}</div>{/if} | ||
| 247 | + {if condition="isset($value.via) && !empty($value.via)"}<div><a href="{$value.via}">Origine => {$value.via|getJustDomain}</a></div>{/if} | ||
| 248 | {if="!$GLOBALS['config'['HIDE_TIMESTAMPS'] || isLoggedIn()"}]('HIDE_TIMESTAMPS']-||-isLoggedIn()"}.html) | ||
| 249 | <span class="linkdate" title="Permalink"><a href="?{$value.linkdate|smallHash}">{$value.localdate|htmlspecialchars} - permalink</a> - </span> | ||
| 250 | {else} | ||
| 251 | -- | ||
| 252 | 2.1.1</code></pre> | ||
| 253 | </body> | ||
| 254 | </html> | ||
diff --git a/doc/FAQ.html b/doc/FAQ.html deleted file mode 100644 index 25584f22..00000000 --- a/doc/FAQ.html +++ /dev/null | |||
| @@ -1,107 +0,0 @@ | |||
| 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 – FAQ</title> | ||
| 8 | <style type="text/css">code{white-space: pre;}</style> | ||
| 9 | <link rel="stylesheet" href="github-markdown.css"> | ||
| 10 | <!--[if lt IE 9]> | ||
| 11 | <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script> | ||
| 12 | <![endif]--> | ||
| 13 | </head> | ||
| 14 | <body> | ||
| 15 | <div id="local-sidebar"> | ||
| 16 | <ul> | ||
| 17 | <li><a href="Home.html">Home</a></li> | ||
| 18 | <li>Setup | ||
| 19 | <ul> | ||
| 20 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 21 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 22 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 23 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 24 | <li><a href="Server-security.html">Server security</a></li> | ||
| 25 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> | ||
| 26 | <li><a href="Plugins.html">Plugins</a></li> | ||
| 27 | </ul></li> | ||
| 28 | <li><a href="Docker.html">Docker</a></li> | ||
| 29 | <li><a href="Usage.html">Usage</a> | ||
| 30 | <ul> | ||
| 31 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> | ||
| 32 | <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li> | ||
| 33 | <li><a href="Firefox-share.html">Firefox share</a></li> | ||
| 34 | <li><a href="RSS-feeds.html">RSS feeds</a></li> | ||
| 35 | <li><a href="REST-API.html">REST API</a></li> | ||
| 36 | </ul></li> | ||
| 37 | <li>How To | ||
| 38 | <ul> | ||
| 39 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | ||
| 40 | <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> | ||
| 41 | <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li> | ||
| 42 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> | ||
| 43 | <li><a href="Datastore-hacks.html">Datastore hacks</a></li> | ||
| 44 | </ul></li> | ||
| 45 | <li><a href="Troubleshooting.html">Troubleshooting</a></li> | ||
| 46 | <li><a href="Development.html">Development</a> | ||
| 47 | <ul> | ||
| 48 | <li><a href="GnuPG-signature.html">GnuPG signature</a></li> | ||
| 49 | <li><a href="Coding-guidelines.html">Coding guidelines</a></li> | ||
| 50 | <li><a href="Directory-structure.html">Directory structure</a></li> | ||
| 51 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> | ||
| 52 | <li><a href="Plugin-System.html">Plugin System</a></li> | ||
| 53 | <li><a href="Release-Shaarli.html">Release Shaarli</a></li> | ||
| 54 | <li><a href="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 55 | <li><a href="Security.html">Security</a></li> | ||
| 56 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 57 | <li><a href="Theming.html">Theming</a></li> | ||
| 58 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 59 | </ul></li> | ||
| 60 | <li>About | ||
| 61 | <ul> | ||
| 62 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 63 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 64 | </ul></li> | ||
| 65 | </ul> | ||
| 66 | </div> | ||
| 67 | <h1 id="faq">FAQ</h1> | ||
| 68 | <h3 id="why-did-you-create-shaarli">Why did you create Shaarli ?</h3> | ||
| 69 | <p>I was a StumbleUpon user. Then I got fed up with they big toolbar. I switched to delicious, which was lighter, faster and more beautiful. Until Yahoo bought it. Then the export API broke all the time, delicious became slow and was ditched by Yahoo. I switched to Diigo, which is not bad, but does too much. And Diigo is sslllooooowww and their Firefox extension a bit buggy. And… oh… <strong>their Firefox addon sends to Diigo every single URL you visit</strong> (Don't believe me ? Use <a href="https://addons.mozilla.org/en-US/firefox/addon/tamper-data/">Tamper Data</a> and open any page).<a href=".html"></a></p> | ||
| 70 | <p>Enough is enough. Saving simple links should not be a complicated heavy thing. I ditched them all and wrote my own: Shaarli. It's simple, but it does the job and does it well. And my data is not hosted on a foreign server, but on my server.</p> | ||
| 71 | <h3 id="why-use-shaarli-and-not-deliciousdiigo">Why use Shaarli and not Delicious/Diigo ?</h3> | ||
| 72 | <p>With Shaarli:</p> | ||
| 73 | <ul> | ||
| 74 | <li>The data is yours: It's hosted on your server.</li> | ||
| 75 | <li>Never fear of having your data locked-in.</li> | ||
| 76 | <li>Never fear to have your data sold to third party.</li> | ||
| 77 | <li>Your private links are not hosted on a third party server.</li> | ||
| 78 | <li>You are not tracked by browser addons (like Diigo does)</li> | ||
| 79 | <li>You can change the look and feel of the pages if you want.</li> | ||
| 80 | <li>You can change the behaviour of the program.</li> | ||
| 81 | <li>It's magnitude faster than most bookmarking services.</li> | ||
| 82 | </ul> | ||
| 83 | <h3 id="what-does-shaarli-mean">What does Shaarli mean?</h3> | ||
| 84 | <p>Shaarli is for shaaring your links.</p> | ||
| 85 | <h3 id="my-shaarli-is-broken">My Shaarli is broken!</h3> | ||
| 86 | <p>First of all, ensure that both the <a href="Server-configuration">web server</a> and <a href="Shaarli-configuration">Shaarli</a> are correctly configured, and that your installation is <a href="Server-requirements">supported</a>.<a href=".html"></a></p> | ||
| 87 | <p>If everything looks right but the issue(s) remain(s), please:</p> | ||
| 88 | <ul> | ||
| 89 | <li>take a look at the <a href="Troubleshooting">troubleshooting</a> section<a href=".html"></a></li> | ||
| 90 | <li>come <a href="https://gitter.im/shaarli/Shaarli">chat with us</a> on Gitter, we'll be happy to help ;-)<a href=".html"></a></li> | ||
| 91 | <li>browse active <a href="https://github.com/shaarli/Shaarli/issues">issues</a> and <a href="https://github.com/shaarli/Shaarli/pulls">Pull Requests</a><a href=".html"></a> | ||
| 92 | <ul> | ||
| 93 | <li>if you find one that is related to the issue, feel free to comment and provide additional details (host/Shaarli setup)</li> | ||
| 94 | <li>else, <a href="https://github.com/shaarli/Shaarli/issues/new">open a new issue</a>, and provide information about the problem:<a href=".html"></a> | ||
| 95 | <ul> | ||
| 96 | <li><em>what happens?</em> - display glitches, invalid data, security flaws...</li> | ||
| 97 | <li><em>what is your configuration?</em> - OS, server version, activated extensions, web browser...</li> | ||
| 98 | <li><em>is it reproducible?</em></li> | ||
| 99 | </ul></li> | ||
| 100 | </ul></li> | ||
| 101 | </ul> | ||
| 102 | <h3 id="why-not-use-a-real-database-files-are-slow">Why not use a real database? Files are slow!</h3> | ||
| 103 | <p>Does browsing <a href="http://sebsauvage.net/links/">this page</a> feel slow? Try browsing older pages, too.<a href=".html"></a></p> | ||
| 104 | <p>It's not slow at all, is it? And don't forget the database contains more than 16000 links, and it's on a shared host, with 32000 visitors/day for my website alone. And it's still damn fast. Why?</p> | ||
| 105 | <p>The data file is only 3.7 Mb. It's read 99% of the time, and is probably already in the operation system disk cache. So generating a page involves no I/O at all most of the time.</p> | ||
| 106 | </body> | ||
| 107 | </html> | ||
diff --git a/doc/Firefox-share.html b/doc/Firefox-share.html deleted file mode 100644 index 707119a6..00000000 --- a/doc/Firefox-share.html +++ /dev/null | |||
| @@ -1,95 +0,0 @@ | |||
| 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 – Firefox share</title> | ||
| 8 | <style type="text/css">code{white-space: pre;}</style> | ||
| 9 | <link rel="stylesheet" href="github-markdown.css"> | ||
| 10 | <!--[if lt IE 9]> | ||
| 11 | <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script> | ||
| 12 | <![endif]--> | ||
| 13 | </head> | ||
| 14 | <body> | ||
| 15 | <div id="local-sidebar"> | ||
| 16 | <ul> | ||
| 17 | <li><a href="Home.html">Home</a></li> | ||
| 18 | <li>Setup | ||
| 19 | <ul> | ||
| 20 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 21 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 22 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 23 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 24 | <li><a href="Server-security.html">Server security</a></li> | ||
| 25 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> | ||
| 26 | <li><a href="Plugins.html">Plugins</a></li> | ||
| 27 | </ul></li> | ||
| 28 | <li><a href="Docker.html">Docker</a></li> | ||
| 29 | <li><a href="Usage.html">Usage</a> | ||
| 30 | <ul> | ||
| 31 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> | ||
| 32 | <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li> | ||
| 33 | <li><a href="Firefox-share.html">Firefox share</a></li> | ||
| 34 | <li><a href="RSS-feeds.html">RSS feeds</a></li> | ||
| 35 | <li><a href="REST-API.html">REST API</a></li> | ||
| 36 | </ul></li> | ||
| 37 | <li>How To | ||
| 38 | <ul> | ||
| 39 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | ||
| 40 | <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> | ||
| 41 | <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li> | ||
| 42 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> | ||
| 43 | <li><a href="Datastore-hacks.html">Datastore hacks</a></li> | ||
| 44 | </ul></li> | ||
| 45 | <li><a href="Troubleshooting.html">Troubleshooting</a></li> | ||
| 46 | <li><a href="Development.html">Development</a> | ||
| 47 | <ul> | ||
| 48 | <li><a href="GnuPG-signature.html">GnuPG signature</a></li> | ||
| 49 | <li><a href="Coding-guidelines.html">Coding guidelines</a></li> | ||
| 50 | <li><a href="Directory-structure.html">Directory structure</a></li> | ||
| 51 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> | ||
| 52 | <li><a href="Plugin-System.html">Plugin System</a></li> | ||
| 53 | <li><a href="Release-Shaarli.html">Release Shaarli</a></li> | ||
| 54 | <li><a href="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 55 | <li><a href="Security.html">Security</a></li> | ||
| 56 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 57 | <li><a href="Theming.html">Theming</a></li> | ||
| 58 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 59 | </ul></li> | ||
| 60 | <li>About | ||
| 61 | <ul> | ||
| 62 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 63 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 64 | </ul></li> | ||
| 65 | </ul> | ||
| 66 | </div> | ||
| 67 | <h1 id="firefox-share">Firefox share</h1> | ||
| 68 | <h3 id="add-shaarli-as-a-sharing-service-to-firefox">Add Shaarli as a sharing service to Firefox</h3> | ||
| 69 | <ul> | ||
| 70 | <li>Open your Shaarli and <code>Login</code></li> | ||
| 71 | <li>Click the <code>Tools</code> button in the top bar</li> | ||
| 72 | <li>Click the <code>✚Add to Firefox social</code> button and accept the activation.</li> | ||
| 73 | </ul> | ||
| 74 | <h3 id="sharing-links-using-firefox-share">Sharing links using Firefox share</h3> | ||
| 75 | <ul> | ||
| 76 | <li>Add the sharing service as described above</li> | ||
| 77 | <li>When you are visiting a webpage you would like to share with Shaarli, click the Firefox <em>Share</em> button <a href="images/firefoxshare.png.html">images/firefoxshare.png</a></li> | ||
| 78 | <li>You can edit your link before and after saving, just like the bookmarklet above.</li> | ||
| 79 | </ul> | ||
| 80 | <table style="width:100%;"> | ||
| 81 | <colgroup> | ||
| 82 | <col style="width: 8%" /> | ||
| 83 | <col style="width: 91%" /> | ||
| 84 | </colgroup> | ||
| 85 | <thead> | ||
| 86 | <tr class="header"> | ||
| 87 | <th></th> | ||
| 88 | <th>Your Shaarli instance must be hosted on an HTTPS (SSL/TLS secure connection) enabled server for Firefox Share to work. Firefox Share will not work over plain HTTP connections.</th> | ||
| 89 | </tr> | ||
| 90 | </thead> | ||
| 91 | <tbody> | ||
| 92 | </tbody> | ||
| 93 | </table> | ||
| 94 | </body> | ||
| 95 | </html> | ||
diff --git a/doc/GnuPG-signature.html b/doc/GnuPG-signature.html deleted file mode 100644 index 182a71d4..00000000 --- a/doc/GnuPG-signature.html +++ /dev/null | |||
| @@ -1,175 +0,0 @@ | |||
| 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 – GnuPG signature</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>Setup | ||
| 56 | <ul> | ||
| 57 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 58 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 59 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 60 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 61 | <li><a href="Server-security.html">Server security</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 | <li><a href="REST-API.html">REST API</a></li> | ||
| 73 | </ul></li> | ||
| 74 | <li>How To | ||
| 75 | <ul> | ||
| 76 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</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="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 92 | <li><a href="Security.html">Security</a></li> | ||
| 93 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 94 | <li><a href="Theming.html">Theming</a></li> | ||
| 95 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 96 | </ul></li> | ||
| 97 | <li>About | ||
| 98 | <ul> | ||
| 99 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 100 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 101 | </ul></li> | ||
| 102 | </ul> | ||
| 103 | </div> | ||
| 104 | <h1 id="gnupg-signature">GnuPG signature</h1> | ||
| 105 | <h2 id="introduction">Introduction</h2> | ||
| 106 | <h3 id="pgp-and-gpg">PGP and GPG</h3> | ||
| 107 | <p><a href="https://gnupg.org/">Gnu Privacy Guard</a> (GnuPG) is an Open Source implementation of the <a href="https://en.wikipedia.org/wiki/Pretty_Good_Privacy#OpenPGP">Pretty Good [](.html)<br /> | ||
| 108 | Privacy</a> (OpenPGP) specification. Its main purposes are digital authentication,<br /> | ||
| 109 | signature and encryption.</p> | ||
| 110 | <p>It is often used by the <a href="https://en.wikipedia.org/wiki/Free_and_open-source_software">FLOSS</a> community to verify:<a href=".html"></a></p> | ||
| 111 | <ul> | ||
| 112 | <li>Linux package signatures: Debian <a href="https://wiki.debian.org/SecureApt">SecureApt</a>, ArchLinux <a href="https://www.archlinux.org/master-keys/">Master [](.html)<br /> | ||
| 113 | Keys</a></li> | ||
| 114 | <li><a href="https://en.wikipedia.org/wiki/Revision_control">SCM</a> releases & maintainer identity<a href=".html"></a></li> | ||
| 115 | </ul> | ||
| 116 | <h3 id="trust">Trust</h3> | ||
| 117 | <p>To quote Phil Pennock (the author of the <a href="https://bitbucket.org/skskeyserver/sks-keyserver/wiki/Home">SKS</a> key server - <a href="http://sks.spodhuis.org/" class="uri">http://sks.spodhuis.org/</a>):<a href=".html"></a></p> | ||
| 118 | <blockquote> | ||
| 119 | <p>You MUST understand that presence of data in the keyserver (pools) in no way connotes trust. Anyone can generate a key, with any name or email address, and upload it. All security and trust comes from evaluating security at the “object level”, via PGP Web-Of-Trust signatures. This keyserver makes it possible to retrieve keys, looking them up via various indices, but the collection of keys in this public pool is KNOWN to contain malicious and fraudulent keys. It is the common expectation of server operators that users understand this and use software which, like all known common OpenPGP implementations, evaluates trust accordingly. This expectation is so common that it is not normally explicitly stated.</p> | ||
| 120 | </blockquote> | ||
| 121 | <p>Trust can be gained by having your key signed by other people (and signing their key back, too :) ), for instance during <a href="https://en.wikipedia.org/wiki/Key_signing_party">key signing parties</a>, see:<a href=".html"></a></p> | ||
| 122 | <ul> | ||
| 123 | <li><a href="http://www.cryptnet.net/fdp/crypto/keysigning_party/en/keysigning_party.html">The Keysigning party HOWTO</a><a href=".html"></a></li> | ||
| 124 | <li><a href="https://en.wikipedia.org/wiki/Web_of_trust">Web of trust</a><a href=".html"></a></li> | ||
| 125 | </ul> | ||
| 126 | <h2 id="generate-a-gpg-key">Generate a GPG key</h2> | ||
| 127 | <ul> | ||
| 128 | <li><a href="http://stackoverflow.com/a/16725717">Generating a GPG key for Git tagging</a> (StackOverflow)<a href=".html"></a></li> | ||
| 129 | <li><a href="https://help.github.com/articles/generating-a-gpg-key/">Generating a GPG key</a> (GitHub)<a href=".html"></a></li> | ||
| 130 | </ul> | ||
| 131 | <h3 id="gpg---provide-identity-information">gpg - provide identity information</h3> | ||
| 132 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="ex">gpg</span> --gen-key | ||
| 133 | |||
| 134 | <span class="ex">gpg</span> (GnuPG) <span class="ex">2.1.6</span><span class="kw">;</span> <span class="ex">Copyright</span> (C) <span class="ex">2015</span> Free Software Foundation, Inc. | ||
| 135 | <span class="ex">This</span> is free software: you are free to change and redistribute it. | ||
| 136 | <span class="ex">There</span> is NO WARRANTY, to the extent permitted by law. | ||
| 137 | |||
| 138 | <span class="ex">Note</span>: Use <span class="st">"gpg2 --full-gen-key"</span> for a full featured key generation dialog. | ||
| 139 | |||
| 140 | <span class="ex">GnuPG</span> needs to construct a user ID to identify your key. | ||
| 141 | |||
| 142 | <span class="ex">Real</span> name: Marvin the Paranoid Android | ||
| 143 | <span class="ex">Email</span> address: marvin@h2g2.net | ||
| 144 | <span class="ex">You</span> selected this USER-ID: | ||
| 145 | <span class="st">"Marvin the Paranoid Android <marvin@h2g2.net>"</span> | ||
| 146 | |||
| 147 | <span class="ex">Change</span> (N)<span class="ex">ame</span>, (E)<span class="ex">mail</span>, or (O)<span class="ex">kay</span>/<span class="kw">(</span><span class="ex">Q</span><span class="kw">)</span><span class="ex">uit?</span> o | ||
| 148 | <span class="ex">We</span> need to generate a lot of random bytes. It is a good idea to perform | ||
| 149 | <span class="ex">some</span> other action (type on the keyboard, move the mouse, utilize the | ||
| 150 | <span class="ex">disks</span>) <span class="ex">during</span> the prime generation<span class="kw">;</span> <span class="ex">this</span> gives the random number | ||
| 151 | <span class="ex">generator</span> a better chance to gain enough entropy.</code></pre></div> | ||
| 152 | <h3 id="gpg---entropy-interlude">gpg - entropy interlude</h3> | ||
| 153 | <p>At this point, you will:</p> | ||
| 154 | <ul> | ||
| 155 | <li>be prompted for a secure password to protect your key (the input method will depend on your Desktop Environment and configuration)</li> | ||
| 156 | <li>be asked to use your machine's input devices (mouse, keyboard, etc.) to generate random entropy; this step <em>may take some time</em></li> | ||
| 157 | </ul> | ||
| 158 | <h3 id="gpg---key-creation-confirmation">gpg - key creation confirmation</h3> | ||
| 159 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="ex">gpg</span>: key A9D53A3E marked as ultimately trusted | ||
| 160 | <span class="ex">public</span> and secret key created and signed. | ||
| 161 | |||
| 162 | <span class="ex">gpg</span>: checking the trustdb | ||
| 163 | <span class="ex">gpg</span>: 3 marginal(s) <span class="ex">needed</span>, 1 complete(s) <span class="ex">needed</span>, PGP trust model | ||
| 164 | <span class="ex">gpg</span>: depth: 0 valid: 2 signed: 0 trust: 0-, 0q, 0n, 0m, 0f, 2u | ||
| 165 | <span class="ex">pub</span> rsa2048/A9D53A3E 2015-07-31 | ||
| 166 | <span class="ex">Key</span> fingerprint = AF2A 5381 E54B 2FD2 14C4 A9A3 0E35 ACA4 A9D5 3A3E | ||
| 167 | <span class="ex">uid</span> [ultimate] Marvin the Paranoid Android <span class="op"><</span>marvin@h2g2.net<span class="op">></span>[](.html) | ||
| 168 | <span class="ex">sub</span> rsa2048/8C0EACF1 2015-07-31</code></pre></div> | ||
| 169 | <h3 id="gpg---submit-your-public-key-to-a-pgp-server-optional">gpg - submit your public key to a PGP server (Optional)</h3> | ||
| 170 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="ex">gpg</span> --keyserver pgp.mit.edu --send-keys A9D53A3E | ||
| 171 | <span class="ex">gpg</span>: sending key A9D53A3E to hkp server pgp.mit.edu</code></pre></div> | ||
| 172 | <h2 id="create-and-push-a-gpg-signed-tag">Create and push a GPG-signed tag</h2> | ||
| 173 | <p>See <a href="Release-Shaarli.html">Release Shaarli</a>.</p> | ||
| 174 | </body> | ||
| 175 | </html> | ||
diff --git a/doc/Home.html b/doc/Home.html deleted file mode 100644 index 7f51b93b..00000000 --- a/doc/Home.html +++ /dev/null | |||
| @@ -1,76 +0,0 @@ | |||
| 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 – Home</title> | ||
| 8 | <style type="text/css">code{white-space: pre;}</style> | ||
| 9 | <link rel="stylesheet" href="github-markdown.css"> | ||
| 10 | <!--[if lt IE 9]> | ||
| 11 | <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script> | ||
| 12 | <![endif]--> | ||
| 13 | </head> | ||
| 14 | <body> | ||
| 15 | <div id="local-sidebar"> | ||
| 16 | <ul> | ||
| 17 | <li><a href="Home.html">Home</a></li> | ||
| 18 | <li>Setup | ||
| 19 | <ul> | ||
| 20 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 21 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 22 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 23 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 24 | <li><a href="Server-security.html">Server security</a></li> | ||
| 25 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> | ||
| 26 | <li><a href="Plugins.html">Plugins</a></li> | ||
| 27 | </ul></li> | ||
| 28 | <li><a href="Docker.html">Docker</a></li> | ||
| 29 | <li><a href="Usage.html">Usage</a> | ||
| 30 | <ul> | ||
| 31 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> | ||
| 32 | <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li> | ||
| 33 | <li><a href="Firefox-share.html">Firefox share</a></li> | ||
| 34 | <li><a href="RSS-feeds.html">RSS feeds</a></li> | ||
| 35 | <li><a href="REST-API.html">REST API</a></li> | ||
| 36 | </ul></li> | ||
| 37 | <li>How To | ||
| 38 | <ul> | ||
| 39 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | ||
| 40 | <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> | ||
| 41 | <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li> | ||
| 42 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> | ||
| 43 | <li><a href="Datastore-hacks.html">Datastore hacks</a></li> | ||
| 44 | </ul></li> | ||
| 45 | <li><a href="Troubleshooting.html">Troubleshooting</a></li> | ||
| 46 | <li><a href="Development.html">Development</a> | ||
| 47 | <ul> | ||
| 48 | <li><a href="GnuPG-signature.html">GnuPG signature</a></li> | ||
| 49 | <li><a href="Coding-guidelines.html">Coding guidelines</a></li> | ||
| 50 | <li><a href="Directory-structure.html">Directory structure</a></li> | ||
| 51 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> | ||
| 52 | <li><a href="Plugin-System.html">Plugin System</a></li> | ||
| 53 | <li><a href="Release-Shaarli.html">Release Shaarli</a></li> | ||
| 54 | <li><a href="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 55 | <li><a href="Security.html">Security</a></li> | ||
| 56 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 57 | <li><a href="Theming.html">Theming</a></li> | ||
| 58 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 59 | </ul></li> | ||
| 60 | <li>About | ||
| 61 | <ul> | ||
| 62 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 63 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 64 | </ul></li> | ||
| 65 | </ul> | ||
| 66 | </div> | ||
| 67 | <h1 id="home">Home</h1> | ||
| 68 | <h1 id="shaarli-wiki">Shaarli wiki</h1> | ||
| 69 | <p>Welcome to the <a href="https://github.com/shaarli/Shaarli/">Shaarli</a> wiki<embed src=".html" /></p> | ||
| 70 | <p>Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli.</p> | ||
| 71 | <p>For general info, read the <a href="https://github.com/shaarli/Shaarli/blob/master/README.md">README</a>.<a href=".html"></a></p> | ||
| 72 | <p>If you have any questions or ideas, please join the <a href="https://gitter.im/shaarli/Shaarli">chat</a> (also reachable via <a href="https://irc.gitter.im/">IRC</a>), post them in our <a href="https://github.com/shaarli/Shaarli/issues/308">general discussion</a> (<a href="https://github.com/shaarli/Shaarli/issues/44">archive</a>) or read the current <a href="https://github.com/shaarli/Shaarli/issues">issues</a>. If you've found a bug, please create a <a href="https://github.com/shaarli/Shaarli/issues/new">new issue</a>.<a href=".html"></a></p> | ||
| 73 | <p>If you would like a feature added to Shaarli, check the issues labeled <a href="https://github.com/shaarli/Shaarli/labels/feature"><code>feature</code></a>, <a href="https://github.com/shaarli/Shaarli/labels/enhancement"><code>enhancement</code></a>, and <a href="https://github.com/shaarli/Shaarli/labels/plugin"><code>plugin</code></a>.<a href=".html"></a></p> | ||
| 74 | <p><em>Note: This documentation is available online at <a href="https://github.com/shaarli/Shaarli/wiki" class="uri">https://github.com/shaarli/Shaarli/wiki</a>, and locally in the <code>doc/</code> directory of your Shaarli installation.</em></p> | ||
| 75 | </body> | ||
| 76 | </html> | ||
diff --git a/doc/Plugin-System.html b/doc/Plugin-System.html deleted file mode 100644 index 123bf106..00000000 --- a/doc/Plugin-System.html +++ /dev/null | |||
| @@ -1,634 +0,0 @@ | |||
| 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 – Plugin System</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>Setup | ||
| 56 | <ul> | ||
| 57 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 58 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 59 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 60 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 61 | <li><a href="Server-security.html">Server security</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 | <li><a href="REST-API.html">REST API</a></li> | ||
| 73 | </ul></li> | ||
| 74 | <li>How To | ||
| 75 | <ul> | ||
| 76 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</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="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 92 | <li><a href="Security.html">Security</a></li> | ||
| 93 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 94 | <li><a href="Theming.html">Theming</a></li> | ||
| 95 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 96 | </ul></li> | ||
| 97 | <li>About | ||
| 98 | <ul> | ||
| 99 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 100 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 101 | </ul></li> | ||
| 102 | </ul> | ||
| 103 | </div> | ||
| 104 | <h1 id="plugin-system">Plugin System</h1> | ||
| 105 | <p><a href="#developer-api"><strong>I am a developer.</strong> Developer API.</a><a href=".html"></a></p> | ||
| 106 | <p><a href="#guide-for-template-designer"><strong>I am a template designer.</strong> Guide for template designer.</a><a href=".html"></a></p> | ||
| 107 | <h2 id="developer-api">Developer API</h2> | ||
| 108 | <h3 id="what-can-i-do-with-plugins">What can I do with plugins?</h3> | ||
| 109 | <p>The plugin system let you:</p> | ||
| 110 | <ul> | ||
| 111 | <li>insert content into specific places across templates.</li> | ||
| 112 | <li>alter data before templates rendering.</li> | ||
| 113 | <li>alter data before saving new links.</li> | ||
| 114 | </ul> | ||
| 115 | <h3 id="how-can-i-create-a-plugin-for-shaarli">How can I create a plugin for Shaarli?</h3> | ||
| 116 | <p>First, chose a plugin name, such as <code>demo_plugin</code>.</p> | ||
| 117 | <p>Under <code>plugin</code> folder, create a folder named with your plugin name. Then create a <plugin_name>.php file in that folder.</p> | ||
| 118 | <p>You should have the following tree view:</p> | ||
| 119 | <pre><code>| index.php | ||
| 120 | | plugins/ | ||
| 121 | |---| demo_plugin/ | ||
| 122 | | |---| demo_plugin.php</code></pre> | ||
| 123 | <h3 id="plugin-initialization">Plugin initialization</h3> | ||
| 124 | <p>At the beginning of Shaarli execution, all enabled plugins are loaded. At this point, the plugin system looks for an <code>init()</code> function to execute and run it if it exists. This function must be named this way, and takes the <code>ConfigManager</code> as parameter.</p> | ||
| 125 | <pre><code><plugin_name>_init($conf)</code></pre> | ||
| 126 | <p>This function can be used to create initial data, load default settings, etc. But also to set <em>plugin errors</em>. If the initialization function returns an array of strings, they will be understand as errors, and displayed in the header to logged in users.</p> | ||
| 127 | <h3 id="understanding-hooks">Understanding hooks</h3> | ||
| 128 | <p>A plugin is a set of functions. Each function will be triggered by the plugin system at certain point in Shaarli execution.</p> | ||
| 129 | <p>These functions need to be named with this pattern:</p> | ||
| 130 | <pre><code>hook_<plugin_name>_<hook_name>($data, $conf)</code></pre> | ||
| 131 | <p>Parameters:</p> | ||
| 132 | <ul> | ||
| 133 | <li>data: see <a href="https://github.com/shaarli/Shaarli/wiki/Plugin-System#plugins-data">$data section</a><a href=".html"></a></li> | ||
| 134 | <li>conf: the <code>ConfigManager</code> instance.</li> | ||
| 135 | </ul> | ||
| 136 | <p>For exemple, if my plugin want to add data to the header, this function is needed:</p> | ||
| 137 | <pre><code>hook_demo_plugin_render_header</code></pre> | ||
| 138 | <p>If this function is declared, and the plugin enabled, it will be called every time Shaarli is rendering the header.</p> | ||
| 139 | <h3 id="plugins-data">Plugin's data</h3> | ||
| 140 | <h4 id="parameters">Parameters</h4> | ||
| 141 | <p>Every hook function has a <code>$data</code> parameter. Its content differs for each hooks.</p> | ||
| 142 | <p><strong>This parameter needs to be returned every time</strong>, otherwise data is lost.</p> | ||
| 143 | <pre><code>return $data;</code></pre> | ||
| 144 | <h4 id="filling-templates-placeholder">Filling templates placeholder</h4> | ||
| 145 | <p>Template placeholders are displayed in template in specific places.</p> | ||
| 146 | <p>RainTPL displays every element contained in the placeholder's array. These element can be added by plugins.</p> | ||
| 147 | <p>For example, let's add a value in the placeholder <code>top_placeholder</code> which is displayed at the top of my page:</p> | ||
| 148 | <div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php"><span class="kw">$data</span><span class="ot">[</span><span class="st">'top_placeholder'</span><span class="ot">[]</span> = <span class="st">'My content'</span><span class="ot">;](]</span>-=-<span class="st">'My-content'</span><span class="ot">;</span>.html<span class="ot">)</span> | ||
| 149 | <span class="co"># OR</span> | ||
| 150 | <span class="fu">array_push</span><span class="ot">(</span><span class="kw">$data</span><span class="ot">[</span><span class="st">'top_placeholder'</span><span class="ot">],</span> <span class="st">'My'</span><span class="ot">,</span> <span class="st">'content'</span><span class="ot">);[](</span>.html<span class="ot">)</span> | ||
| 151 | |||
| 152 | <span class="kw">return</span> <span class="kw">$data</span><span class="ot">;</span></code></pre></div> | ||
| 153 | <h4 id="data-manipulation">Data manipulation</h4> | ||
| 154 | <p>When a page is displayed, every variable send to the template engine is passed to plugins before that in <code>$data</code>.</p> | ||
| 155 | <p>The data contained by this array can be altered before template rendering.</p> | ||
| 156 | <p>For exemple, in linklist, it is possible to alter every title:</p> | ||
| 157 | <div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php"><span class="co">// mind the reference if you want $data to be altered</span> | ||
| 158 | <span class="kw">foreach</span> <span class="ot">(</span><span class="kw">$data</span><span class="ot">[</span><span class="st">'links'</span><span class="ot">]</span> <span class="kw">as</span> &<span class="kw">$value</span><span class="ot">)</span> {<span class="ot">[](</span>.html<span class="ot">)</span> | ||
| 159 | <span class="co">// String reverse every title.</span> | ||
| 160 | <span class="kw">$value</span><span class="ot">[</span><span class="st">'title'</span><span class="ot">]</span> = <span class="fu">strrev</span><span class="ot">(</span><span class="kw">$value</span><span class="ot">[</span><span class="st">'title'</span><span class="ot">]);[](</span>.html<span class="ot">)</span> | ||
| 161 | } | ||
| 162 | |||
| 163 | <span class="kw">return</span> <span class="kw">$data</span><span class="ot">;</span></code></pre></div> | ||
| 164 | <h3 id="metadata">Metadata</h3> | ||
| 165 | <p>Every plugin needs a <code><plugin_name>.meta</code> file, which is in fact an <code>.ini</code> file (<code>KEY="VALUE"</code>), to be listed in plugin administration.</p> | ||
| 166 | <p>Each file contain two keys:</p> | ||
| 167 | <ul> | ||
| 168 | <li><code>description</code>: plugin description</li> | ||
| 169 | <li><code>parameters</code>: user parameter names, separated by a <code>;</code>.</li> | ||
| 170 | <li><code>parameter.<PARAMETER_NAME></code>: add a text description the specified parameter.</li> | ||
| 171 | </ul> | ||
| 172 | <blockquote> | ||
| 173 | <p>Note: In PHP, <code>parse_ini_file()</code> seems to want strings to be between by quotes <code>"</code> in the ini file.</p> | ||
| 174 | </blockquote> | ||
| 175 | <h3 id="its-not-working">It's not working!</h3> | ||
| 176 | <p>Use <code>demo_plugin</code> as a functional example. It covers most of the plugin system features.</p> | ||
| 177 | <p>If it's still not working, please <a href="https://github.com/shaarli/Shaarli/issues/new">open an issue</a>.<a href=".html"></a></p> | ||
| 178 | <h3 id="hooks">Hooks</h3> | ||
| 179 | <table style="width:42%;"> | ||
| 180 | <colgroup> | ||
| 181 | <col style="width: 19%" /> | ||
| 182 | <col style="width: 22%" /> | ||
| 183 | </colgroup> | ||
| 184 | <thead> | ||
| 185 | <tr class="header"> | ||
| 186 | <th>Hooks</th> | ||
| 187 | <th style="text-align: center;">Description</th> | ||
| 188 | </tr> | ||
| 189 | </thead> | ||
| 190 | <tbody> | ||
| 191 | <tr class="odd"> | ||
| 192 | <td><a href="#render_header">render_header</a></td> | ||
| 193 | <td style="text-align: center;">Allow plugin to add content in page headers.</td> | ||
| 194 | </tr> | ||
| 195 | <tr class="even"> | ||
| 196 | <td><a href="#render_includes">render_includes</a></td> | ||
| 197 | <td style="text-align: center;">Allow plugin to include their own CSS files.</td> | ||
| 198 | </tr> | ||
| 199 | <tr class="odd"> | ||
| 200 | <td><a href="#render_footer">render_footer</a></td> | ||
| 201 | <td style="text-align: center;">Allow plugin to add content in page footer and include their own JS files.</td> | ||
| 202 | </tr> | ||
| 203 | <tr class="even"> | ||
| 204 | <td><a href="#render_linklist">render_linklist</a></td> | ||
| 205 | <td style="text-align: center;">It allows to add content at the begining and end of the page, after every link displayed and to alter link data.</td> | ||
| 206 | </tr> | ||
| 207 | <tr class="odd"> | ||
| 208 | <td><a href="#render_editlink">render_editlink</a></td> | ||
| 209 | <td style="text-align: center;">Allow to add fields in the form, or display elements.</td> | ||
| 210 | </tr> | ||
| 211 | <tr class="even"> | ||
| 212 | <td><a href="#render_tools">render_tools</a></td> | ||
| 213 | <td style="text-align: center;">Allow to add content at the end of the page.</td> | ||
| 214 | </tr> | ||
| 215 | <tr class="odd"> | ||
| 216 | <td><a href="#render_picwall">render_picwall</a></td> | ||
| 217 | <td style="text-align: center;">Allow to add content at the top and bottom of the page.</td> | ||
| 218 | </tr> | ||
| 219 | <tr class="even"> | ||
| 220 | <td><a href="#render_tagcloud">render_tagcloud</a></td> | ||
| 221 | <td style="text-align: center;">Allow to add content at the top and bottom of the page, and after all tags.</td> | ||
| 222 | </tr> | ||
| 223 | <tr class="odd"> | ||
| 224 | <td><a href="#render_taglist">render_taglist</a></td> | ||
| 225 | <td style="text-align: center;">Allow to add content at the top and bottom of the page, and after all tags.</td> | ||
| 226 | </tr> | ||
| 227 | <tr class="even"> | ||
| 228 | <td><a href="#render_daily">render_daily</a></td> | ||
| 229 | <td style="text-align: center;">Allow to add content at the top and bottom of the page, the bottom of each link and to alter data.</td> | ||
| 230 | </tr> | ||
| 231 | <tr class="odd"> | ||
| 232 | <td><a href="#render_feed">render_feed</a></td> | ||
| 233 | <td style="text-align: center;">Allow to do add tags in RSS and ATOM feeds.</td> | ||
| 234 | </tr> | ||
| 235 | <tr class="even"> | ||
| 236 | <td><a href="#save_link">save_link</a></td> | ||
| 237 | <td style="text-align: center;">Allow to alter the link being saved in the datastore.</td> | ||
| 238 | </tr> | ||
| 239 | <tr class="odd"> | ||
| 240 | <td><a href="#delete_link">delete_link</a></td> | ||
| 241 | <td style="text-align: center;">Allow to do an action before a link is deleted from the datastore.</td> | ||
| 242 | </tr> | ||
| 243 | </tbody> | ||
| 244 | </table> | ||
| 245 | <h4 id="render_header">render_header</h4> | ||
| 246 | <p>Triggered on every page.</p> | ||
| 247 | <p>Allow plugin to add content in page headers.</p> | ||
| 248 | <h5 id="data">Data</h5> | ||
| 249 | <p><code>$data</code> is an array containing:</p> | ||
| 250 | <ul> | ||
| 251 | <li><code>_PAGE_</code>: current target page (eg: <code>linklist</code>, <code>picwall</code>, etc.).</li> | ||
| 252 | <li><code>_LOGGEDIN_</code>: true if user is logged in, false otherwise.</li> | ||
| 253 | </ul> | ||
| 254 | <h5 id="template-placeholders">Template placeholders</h5> | ||
| 255 | <p>Items can be displayed in templates by adding an entry in <code>$data['<placeholder>']</code> array.<a href=".html"></a></p> | ||
| 256 | <p>List of placeholders:</p> | ||
| 257 | <ul> | ||
| 258 | <li><code>buttons_toolbar</code>: after the list of buttons in the header.</li> | ||
| 259 | </ul> | ||
| 260 | <p><img src="http://i.imgur.com/ssJUOrt.png" alt="buttons_toolbar_example" /><a href=".html"></a></p> | ||
| 261 | <ul> | ||
| 262 | <li><code>fields_toolbar</code>: after search fields in the header.</li> | ||
| 263 | </ul> | ||
| 264 | <blockquote> | ||
| 265 | <p>Note: This will only be called in linklist.</p> | ||
| 266 | </blockquote> | ||
| 267 | <p><img src="http://i.imgur.com/3GMifI2.png" alt="fields_toolbar_example" /><a href=".html"></a></p> | ||
| 268 | <h4 id="render_includes">render_includes</h4> | ||
| 269 | <p>Triggered on every page.</p> | ||
| 270 | <p>Allow plugin to include their own CSS files.</p> | ||
| 271 | <h5 id="data-1">Data</h5> | ||
| 272 | <p><code>$data</code> is an array containing:</p> | ||
| 273 | <ul> | ||
| 274 | <li><code>_PAGE_</code>: current target page (eg: <code>linklist</code>, <code>picwall</code>, etc.).</li> | ||
| 275 | <li><code>_LOGGEDIN_</code>: true if user is logged in, false otherwise.</li> | ||
| 276 | </ul> | ||
| 277 | <h5 id="template-placeholders-1">Template placeholders</h5> | ||
| 278 | <p>Items can be displayed in templates by adding an entry in <code>$data['<placeholder>']</code> array.<a href=".html"></a></p> | ||
| 279 | <p>List of placeholders:</p> | ||
| 280 | <ul> | ||
| 281 | <li><code>css_files</code>: called after loading default CSS.</li> | ||
| 282 | </ul> | ||
| 283 | <blockquote> | ||
| 284 | <p>Note: only add the path of the CSS file. E.g: <code>plugins/demo_plugin/custom_demo.css</code>.</p> | ||
| 285 | </blockquote> | ||
| 286 | <h4 id="render_footer">render_footer</h4> | ||
| 287 | <p>Triggered on every page.</p> | ||
| 288 | <p>Allow plugin to add content in page footer and include their own JS files.</p> | ||
| 289 | <h5 id="data-2">Data</h5> | ||
| 290 | <p><code>$data</code> is an array containing:</p> | ||
| 291 | <ul> | ||
| 292 | <li><code>_PAGE_</code>: current target page (eg: <code>linklist</code>, <code>picwall</code>, etc.).</li> | ||
| 293 | <li><code>_LOGGEDIN_</code>: true if user is logged in, false otherwise.</li> | ||
| 294 | </ul> | ||
| 295 | <h5 id="template-placeholders-2">Template placeholders</h5> | ||
| 296 | <p>Items can be displayed in templates by adding an entry in <code>$data['<placeholder>']</code> array.<a href=".html"></a></p> | ||
| 297 | <p>List of placeholders:</p> | ||
| 298 | <ul> | ||
| 299 | <li><code>text</code>: called after the end of the footer text.</li> | ||
| 300 | <li><code>endofpage</code>: called at the end of the page.</li> | ||
| 301 | </ul> | ||
| 302 | <p><img src="http://i.imgur.com/L5S2YEH.png" alt="text_example" /><a href=".html"></a></p> | ||
| 303 | <ul> | ||
| 304 | <li><code>js_files</code>: called at the end of the page, to include custom JS scripts.</li> | ||
| 305 | </ul> | ||
| 306 | <blockquote> | ||
| 307 | <p>Note: only add the path of the JS file. E.g: <code>plugins/demo_plugin/custom_demo.js</code>.</p> | ||
| 308 | </blockquote> | ||
| 309 | <h4 id="render_linklist">render_linklist</h4> | ||
| 310 | <p>Triggered when <code>linklist</code> is displayed (list of links, permalink, search, tag filtered, etc.).</p> | ||
| 311 | <p>It allows to add content at the begining and end of the page, after every link displayed and to alter link data.</p> | ||
| 312 | <h5 id="data-3">Data</h5> | ||
| 313 | <p><code>$data</code> is an array containing:</p> | ||
| 314 | <ul> | ||
| 315 | <li><code>_LOGGEDIN_</code>: true if user is logged in, false otherwise.</li> | ||
| 316 | <li>All templates data, including links.</li> | ||
| 317 | </ul> | ||
| 318 | <h5 id="template-placeholders-3">Template placeholders</h5> | ||
| 319 | <p>Items can be displayed in templates by adding an entry in <code>$data['<placeholder>']</code> array.<a href=".html"></a></p> | ||
| 320 | <p>List of placeholders:</p> | ||
| 321 | <ul> | ||
| 322 | <li><code>action_plugin</code>: next to the button "private only" at the top and bottom of the page.</li> | ||
| 323 | </ul> | ||
| 324 | <p><img src="http://i.imgur.com/Q12PWg0.png" alt="action_plugin_example" /><a href=".html"></a></p> | ||
| 325 | <ul> | ||
| 326 | <li><code>link_plugin</code>: for every link, between permalink and link URL.</li> | ||
| 327 | </ul> | ||
| 328 | <p><img src="http://i.imgur.com/3oDPhWx.png" alt="link_plugin_example" /><a href=".html"></a></p> | ||
| 329 | <ul> | ||
| 330 | <li><code>plugin_start_zone</code>: before displaying the template content.</li> | ||
| 331 | </ul> | ||
| 332 | <p><img src="http://i.imgur.com/OVBkGy3.png" alt="plugin_start_zone_example" /><a href=".html"></a></p> | ||
| 333 | <ul> | ||
| 334 | <li><code>plugin_end_zone</code>: after displaying the template content.</li> | ||
| 335 | </ul> | ||
| 336 | <p><img src="http://i.imgur.com/6IoRuop.png" alt="plugin_end_zone_example" /><a href=".html"></a></p> | ||
| 337 | <h4 id="render_editlink">render_editlink</h4> | ||
| 338 | <p>Triggered when the link edition form is displayed.</p> | ||
| 339 | <p>Allow to add fields in the form, or display elements.</p> | ||
| 340 | <h5 id="data-4">Data</h5> | ||
| 341 | <p><code>$data</code> is an array containing:</p> | ||
| 342 | <ul> | ||
| 343 | <li>All templates data.</li> | ||
| 344 | </ul> | ||
| 345 | <h5 id="template-placeholders-4">Template placeholders</h5> | ||
| 346 | <p>Items can be displayed in templates by adding an entry in <code>$data['<placeholder>']</code> array.<a href=".html"></a></p> | ||
| 347 | <p>List of placeholders:</p> | ||
| 348 | <ul> | ||
| 349 | <li><code>edit_link_plugin</code>: after tags field.</li> | ||
| 350 | </ul> | ||
| 351 | <p><img src="http://i.imgur.com/5u17Ens.png" alt="edit_link_plugin_example" /><a href=".html"></a></p> | ||
| 352 | <h4 id="render_tools">render_tools</h4> | ||
| 353 | <p>Triggered when the "tools" page is displayed.</p> | ||
| 354 | <p>Allow to add content at the end of the page.</p> | ||
| 355 | <h5 id="data-5">Data</h5> | ||
| 356 | <p><code>$data</code> is an array containing:</p> | ||
| 357 | <ul> | ||
| 358 | <li>All templates data.</li> | ||
| 359 | </ul> | ||
| 360 | <h5 id="template-placeholders-5">Template placeholders</h5> | ||
| 361 | <p>Items can be displayed in templates by adding an entry in <code>$data['<placeholder>']</code> array.<a href=".html"></a></p> | ||
| 362 | <p>List of placeholders:</p> | ||
| 363 | <ul> | ||
| 364 | <li><code>tools_plugin</code>: at the end of the page.</li> | ||
| 365 | </ul> | ||
| 366 | <p><img src="http://i.imgur.com/Bqhu9oQ.png" alt="tools_plugin_example" /><a href=".html"></a></p> | ||
| 367 | <h4 id="render_picwall">render_picwall</h4> | ||
| 368 | <p>Triggered when picwall is displayed.</p> | ||
| 369 | <p>Allow to add content at the top and bottom of the page.</p> | ||
| 370 | <h5 id="data-6">Data</h5> | ||
| 371 | <p><code>$data</code> is an array containing:</p> | ||
| 372 | <ul> | ||
| 373 | <li><code>_LOGGEDIN_</code>: true if user is logged in, false otherwise.</li> | ||
| 374 | <li>All templates data.</li> | ||
| 375 | </ul> | ||
| 376 | <h5 id="template-placeholders-6">Template placeholders</h5> | ||
| 377 | <p>Items can be displayed in templates by adding an entry in <code>$data['<placeholder>']</code> array.<a href=".html"></a></p> | ||
| 378 | <p>List of placeholders:</p> | ||
| 379 | <ul> | ||
| 380 | <li><p><code>plugin_start_zone</code>: before displaying the template content.</p></li> | ||
| 381 | <li><p><code>plugin_end_zone</code>: after displaying the template content.</p></li> | ||
| 382 | </ul> | ||
| 383 | <p><img src="http://i.imgur.com/tVTQFER.png" alt="plugin_start_end_zone_example" /><a href=".html"></a></p> | ||
| 384 | <h4 id="render_tagcloud">render_tagcloud</h4> | ||
| 385 | <p>Triggered when tagcloud is displayed.</p> | ||
| 386 | <p>Allow to add content at the top and bottom of the page.</p> | ||
| 387 | <h5 id="data-7">Data</h5> | ||
| 388 | <p><code>$data</code> is an array containing:</p> | ||
| 389 | <ul> | ||
| 390 | <li><code>_LOGGEDIN_</code>: true if user is logged in, false otherwise.</li> | ||
| 391 | <li>All templates data.</li> | ||
| 392 | </ul> | ||
| 393 | <h5 id="template-placeholders-7">Template placeholders</h5> | ||
| 394 | <p>Items can be displayed in templates by adding an entry in <code>$data['<placeholder>']</code> array.<a href=".html"></a></p> | ||
| 395 | <p>List of placeholders:</p> | ||
| 396 | <ul> | ||
| 397 | <li><p><code>plugin_start_zone</code>: before displaying the template content.</p></li> | ||
| 398 | <li><p><code>plugin_end_zone</code>: after displaying the template content.</p></li> | ||
| 399 | </ul> | ||
| 400 | <p>For each tag, the following placeholder can be used:</p> | ||
| 401 | <ul> | ||
| 402 | <li><code>tag_plugin</code>: after each tag</li> | ||
| 403 | </ul> | ||
| 404 | <p><img src="http://i.imgur.com/vHmyT3a.png" alt="plugin_start_end_zone_example" /><a href=".html"></a></p> | ||
| 405 | <h4 id="render_taglist">render_taglist</h4> | ||
| 406 | <p>Triggered when taglist is displayed.</p> | ||
| 407 | <p>Allow to add content at the top and bottom of the page.</p> | ||
| 408 | <h5 id="data-8">Data</h5> | ||
| 409 | <p><code>$data</code> is an array containing:</p> | ||
| 410 | <ul> | ||
| 411 | <li><code>_LOGGEDIN_</code>: true if user is logged in, false otherwise.</li> | ||
| 412 | <li>All templates data.</li> | ||
| 413 | </ul> | ||
| 414 | <h5 id="template-placeholders-8">Template placeholders</h5> | ||
| 415 | <p>Items can be displayed in templates by adding an entry in <code>$data['<placeholder>']</code> array.<a href=".html"></a></p> | ||
| 416 | <p>List of placeholders:</p> | ||
| 417 | <ul> | ||
| 418 | <li><p><code>plugin_start_zone</code>: before displaying the template content.</p></li> | ||
| 419 | <li><p><code>plugin_end_zone</code>: after displaying the template content.</p></li> | ||
| 420 | </ul> | ||
| 421 | <p>For each tag, the following placeholder can be used:</p> | ||
| 422 | <ul> | ||
| 423 | <li><code>tag_plugin</code>: after each tag</li> | ||
| 424 | </ul> | ||
| 425 | <h4 id="render_daily">render_daily</h4> | ||
| 426 | <p>Triggered when tagcloud is displayed.</p> | ||
| 427 | <p>Allow to add content at the top and bottom of the page, the bottom of each link and to alter data.</p> | ||
| 428 | <h5 id="data-9">Data</h5> | ||
| 429 | <p><code>$data</code> is an array containing:</p> | ||
| 430 | <ul> | ||
| 431 | <li><code>_LOGGEDIN_</code>: true if user is logged in, false otherwise.</li> | ||
| 432 | <li>All templates data, including links.</li> | ||
| 433 | </ul> | ||
| 434 | <h5 id="template-placeholders-9">Template placeholders</h5> | ||
| 435 | <p>Items can be displayed in templates by adding an entry in <code>$data['<placeholder>']</code> array.<a href=".html"></a></p> | ||
| 436 | <p>List of placeholders:</p> | ||
| 437 | <ul> | ||
| 438 | <li><code>link_plugin</code>: used at bottom of each link.</li> | ||
| 439 | </ul> | ||
| 440 | <p><img src="http://i.imgur.com/hzhMfSZ.png" alt="link_plugin_example" /><a href=".html"></a></p> | ||
| 441 | <ul> | ||
| 442 | <li><p><code>plugin_start_zone</code>: before displaying the template content.</p></li> | ||
| 443 | <li><p><code>plugin_end_zone</code>: after displaying the template content.</p></li> | ||
| 444 | </ul> | ||
| 445 | <h4 id="render_feed">render_feed</h4> | ||
| 446 | <p>Triggered when the ATOM or RSS feed is displayed.</p> | ||
| 447 | <p>Allow to add tags in the feed, either in the header or for each items. Items (links) can also be altered before being rendered.</p> | ||
| 448 | <h5 id="data-10">Data</h5> | ||
| 449 | <p><code>$data</code> is an array containing:</p> | ||
| 450 | <ul> | ||
| 451 | <li><code>_LOGGEDIN_</code>: true if user is logged in, false otherwise.</li> | ||
| 452 | <li><code>_PAGE_</code>: containing either <code>rss</code> or <code>atom</code>.</li> | ||
| 453 | <li>All templates data, including links.</li> | ||
| 454 | </ul> | ||
| 455 | <h5 id="template-placeholders-10">Template placeholders</h5> | ||
| 456 | <p>Tags can be added in feeds by adding an entry in <code>$data['<placeholder>']</code> array.<a href=".html"></a></p> | ||
| 457 | <p>List of placeholders:</p> | ||
| 458 | <ul> | ||
| 459 | <li><code>feed_plugins_header</code>: used as a header tag in the feed.</li> | ||
| 460 | </ul> | ||
| 461 | <p>For each links:</p> | ||
| 462 | <ul> | ||
| 463 | <li><code>feed_plugins</code>: additional tag for every link entry.</li> | ||
| 464 | </ul> | ||
| 465 | <h4 id="save_link">save_link</h4> | ||
| 466 | <p>Triggered when a link is save (new link or edit).</p> | ||
| 467 | <p>Allow to alter the link being saved in the datastore.</p> | ||
| 468 | <h5 id="data-11">Data</h5> | ||
| 469 | <p><code>$data</code> is an array containing the link being saved:</p> | ||
| 470 | <ul> | ||
| 471 | <li>id</li> | ||
| 472 | <li>title</li> | ||
| 473 | <li>url</li> | ||
| 474 | <li>shorturl</li> | ||
| 475 | <li>description</li> | ||
| 476 | <li>private</li> | ||
| 477 | <li>tags</li> | ||
| 478 | <li>created</li> | ||
| 479 | <li>updated</li> | ||
| 480 | </ul> | ||
| 481 | <h4 id="delete_link">delete_link</h4> | ||
| 482 | <p>Triggered when a link is deleted.</p> | ||
| 483 | <p>Allow to execute any action before the link is actually removed from the datastore</p> | ||
| 484 | <h5 id="data-12">Data</h5> | ||
| 485 | <p><code>$data</code> is an array containing the link being saved:</p> | ||
| 486 | <ul> | ||
| 487 | <li>id</li> | ||
| 488 | <li>title</li> | ||
| 489 | <li>url</li> | ||
| 490 | <li>shorturl</li> | ||
| 491 | <li>description</li> | ||
| 492 | <li>private</li> | ||
| 493 | <li>tags</li> | ||
| 494 | <li>created</li> | ||
| 495 | <li>updated</li> | ||
| 496 | </ul> | ||
| 497 | <h2 id="guide-for-template-designer">Guide for template designer</h2> | ||
| 498 | <h3 id="plugin-administration">Plugin administration</h3> | ||
| 499 | <p>Your theme must include a plugin administration page: <code>pluginsadmin.html</code>.</p> | ||
| 500 | <blockquote> | ||
| 501 | <p>Note: repo's template link needs to be added when the PR is merged.</p> | ||
| 502 | </blockquote> | ||
| 503 | <p>Use the default one as an example.</p> | ||
| 504 | <p>Aside from classic RainTPL loops, plugins order is handle by JavaScript. You can just include <code>plugin_admin.js</code>, only if:</p> | ||
| 505 | <ul> | ||
| 506 | <li>you're using a table.</li> | ||
| 507 | <li>you call orderUp() and orderUp() onclick on arrows.</li> | ||
| 508 | <li>you add data-line and data-order to your rows.</li> | ||
| 509 | </ul> | ||
| 510 | <p>Otherwise, you can use your own JS as long as this field is send by the form:</p> | ||
| 511 | <p><input type="hidden" name="order_{$key}" value="{$counter}"></p> | ||
| 512 | <h3 id="placeholder-system">Placeholder system</h3> | ||
| 513 | <p>In order to make plugins work with every custom themes, you need to add variable placeholder in your templates.</p> | ||
| 514 | <p>It's a RainTPL loop like this:</p> | ||
| 515 | <pre><code>{loop="$plugin_variable"} | ||
| 516 | {$value} | ||
| 517 | {/loop}</code></pre> | ||
| 518 | <p>You should enable <code>demo_plugin</code> for testing purpose, since it uses every placeholder available.</p> | ||
| 519 | <h3 id="list-of-placeholders">List of placeholders</h3> | ||
| 520 | <p><strong>page.header.html</strong></p> | ||
| 521 | <p>At the end of the menu:</p> | ||
| 522 | <pre><code>{loop="$plugins_header.buttons_toolbar"} | ||
| 523 | {$value} | ||
| 524 | {/loop}</code></pre> | ||
| 525 | <p>At the end of file, before clearing floating blocks:</p> | ||
| 526 | <pre><code>{if="!empty($plugin_errors) && isLoggedIn()"} | ||
| 527 | <ul class="errors"> | ||
| 528 | {loop="plugin_errors"} | ||
| 529 | <li>{$value}</li> | ||
| 530 | {/loop} | ||
| 531 | </ul> | ||
| 532 | {/if}</code></pre> | ||
| 533 | <p><strong>includes.html</strong></p> | ||
| 534 | <p>At the end of the file:</p> | ||
| 535 | <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop="$plugins_includes.css_files"} | ||
| 536 | <span class="kw"><link</span><span class="ot"> type=</span><span class="st">"text/css"</span><span class="ot"> rel=</span><span class="st">"stylesheet"</span><span class="ot"> href=</span><span class="st">"{$value}#"</span><span class="kw">/></span> | ||
| 537 | {/loop}</code></pre></div> | ||
| 538 | <p><strong>page.footer.html</strong></p> | ||
| 539 | <p>At the end of your footer notes:</p> | ||
| 540 | <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop="$plugins_footer.text"} | ||
| 541 | {$value} | ||
| 542 | {/loop}</code></pre></div> | ||
| 543 | <p>At the end of file:</p> | ||
| 544 | <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop="$plugins_footer.js_files"} | ||
| 545 | <span class="kw"><script</span><span class="ot"> src=</span><span class="st">"{$value}#"</span><span class="kw">></script></span> | ||
| 546 | {/loop}</code></pre></div> | ||
| 547 | <p><strong>linklist.html</strong></p> | ||
| 548 | <p>After search fields:</p> | ||
| 549 | <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop="$plugins_header.fields_toolbar"} | ||
| 550 | {$value} | ||
| 551 | {/loop}</code></pre></div> | ||
| 552 | <p>Before displaying the link list (after paging):</p> | ||
| 553 | <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop="$plugin_start_zone"} | ||
| 554 | {$value} | ||
| 555 | {/loop}</code></pre></div> | ||
| 556 | <p>For every links (icons):</p> | ||
| 557 | <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop="$value.link_plugin"} | ||
| 558 | <span class="kw"><span></span>{$value}<span class="kw"></span></span> | ||
| 559 | {/loop}</code></pre></div> | ||
| 560 | <p>Before end paging:</p> | ||
| 561 | <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop="$plugin_end_zone"} | ||
| 562 | {$value} | ||
| 563 | {/loop}</code></pre></div> | ||
| 564 | <p><strong>linklist.paging.html</strong></p> | ||
| 565 | <p>After the "private only" icon:</p> | ||
| 566 | <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop="$action_plugin"} | ||
| 567 | {$value} | ||
| 568 | {/loop}</code></pre></div> | ||
| 569 | <p><strong>editlink.html</strong></p> | ||
| 570 | <p>After tags field:</p> | ||
| 571 | <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop="$edit_link_plugin"} | ||
| 572 | {$value} | ||
| 573 | {/loop}</code></pre></div> | ||
| 574 | <p><strong>tools.html</strong></p> | ||
| 575 | <p>After the last tool:</p> | ||
| 576 | <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop="$tools_plugin"} | ||
| 577 | {$value} | ||
| 578 | {/loop}</code></pre></div> | ||
| 579 | <p><strong>picwall.html</strong></p> | ||
| 580 | <p>Top:</p> | ||
| 581 | <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html"><span class="kw"><div</span><span class="ot"> id=</span><span class="st">"plugin_zone_start_picwall"</span><span class="ot"> class=</span><span class="st">"plugin_zone"</span><span class="kw">></span> | ||
| 582 | {loop="$plugin_start_zone"} | ||
| 583 | {$value} | ||
| 584 | {/loop} | ||
| 585 | <span class="kw"></div></span></code></pre></div> | ||
| 586 | <p>Bottom:</p> | ||
| 587 | <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html"><span class="kw"><div</span><span class="ot"> id=</span><span class="st">"plugin_zone_end_picwall"</span><span class="ot"> class=</span><span class="st">"plugin_zone"</span><span class="kw">></span> | ||
| 588 | {loop="$plugin_end_zone"} | ||
| 589 | {$value} | ||
| 590 | {/loop} | ||
| 591 | <span class="kw"></div></span></code></pre></div> | ||
| 592 | <p><strong>tagcloud.html</strong></p> | ||
| 593 | <p>Top:</p> | ||
| 594 | <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html"> <span class="kw"><div</span><span class="ot"> id=</span><span class="st">"plugin_zone_start_tagcloud"</span><span class="ot"> class=</span><span class="st">"plugin_zone"</span><span class="kw">></span> | ||
| 595 | {loop="$plugin_start_zone"} | ||
| 596 | {$value} | ||
| 597 | {/loop} | ||
| 598 | <span class="kw"></div></span></code></pre></div> | ||
| 599 | <p>Bottom:</p> | ||
| 600 | <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html"> <span class="kw"><div</span><span class="ot"> id=</span><span class="st">"plugin_zone_end_tagcloud"</span><span class="ot"> class=</span><span class="st">"plugin_zone"</span><span class="kw">></span> | ||
| 601 | {loop="$plugin_end_zone"} | ||
| 602 | {$value} | ||
| 603 | {/loop} | ||
| 604 | <span class="kw"></div></span></code></pre></div> | ||
| 605 | <p><strong>daily.html</strong></p> | ||
| 606 | <p>Top:</p> | ||
| 607 | <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html"><span class="kw"><div</span><span class="ot"> id=</span><span class="st">"plugin_zone_start_picwall"</span><span class="ot"> class=</span><span class="st">"plugin_zone"</span><span class="kw">></span> | ||
| 608 | {loop="$plugin_start_zone"} | ||
| 609 | {$value} | ||
| 610 | {/loop} | ||
| 611 | <span class="kw"></div></span></code></pre></div> | ||
| 612 | <p>After every link:</p> | ||
| 613 | <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html"><span class="kw"><div</span><span class="ot"> class=</span><span class="st">"dailyEntryFooter"</span><span class="kw">></span> | ||
| 614 | {loop="$link.link_plugin"} | ||
| 615 | {$value} | ||
| 616 | {/loop} | ||
| 617 | <span class="kw"></div></span></code></pre></div> | ||
| 618 | <p>Bottom:</p> | ||
| 619 | <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html"><span class="kw"><div</span><span class="ot"> id=</span><span class="st">"plugin_zone_end_picwall"</span><span class="ot"> class=</span><span class="st">"plugin_zone"</span><span class="kw">></span> | ||
| 620 | {loop="$plugin_end_zone"} | ||
| 621 | {$value} | ||
| 622 | {/loop} | ||
| 623 | <span class="kw"></div></span></code></pre></div> | ||
| 624 | <p><strong>feed.atom.xml</strong> and <strong>feed.rss.xml</strong>:</p> | ||
| 625 | <p>In headers tags section:</p> | ||
| 626 | <div class="sourceCode"><pre class="sourceCode xml"><code class="sourceCode xml">{loop="$feed_plugins_header"} | ||
| 627 | {$value} | ||
| 628 | {/loop}</code></pre></div> | ||
| 629 | <p>After each entry:</p> | ||
| 630 | <div class="sourceCode"><pre class="sourceCode xml"><code class="sourceCode xml">{loop="$value.feed_plugins"} | ||
| 631 | {$value} | ||
| 632 | {/loop}</code></pre></div> | ||
| 633 | </body> | ||
| 634 | </html> | ||
diff --git a/doc/Plugins.html b/doc/Plugins.html deleted file mode 100644 index 08ce8a86..00000000 --- a/doc/Plugins.html +++ /dev/null | |||
| @@ -1,155 +0,0 @@ | |||
| 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 – Plugins</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>Setup | ||
| 56 | <ul> | ||
| 57 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 58 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 59 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 60 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 61 | <li><a href="Server-security.html">Server security</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 | <li><a href="REST-API.html">REST API</a></li> | ||
| 73 | </ul></li> | ||
| 74 | <li>How To | ||
| 75 | <ul> | ||
| 76 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</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="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 92 | <li><a href="Security.html">Security</a></li> | ||
| 93 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 94 | <li><a href="Theming.html">Theming</a></li> | ||
| 95 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 96 | </ul></li> | ||
| 97 | <li>About | ||
| 98 | <ul> | ||
| 99 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 100 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 101 | </ul></li> | ||
| 102 | </ul> | ||
| 103 | </div> | ||
| 104 | <h1 id="plugins">Plugins</h1> | ||
| 105 | <h2 id="plugin-installation">Plugin installation</h2> | ||
| 106 | <p>There is a bunch of plugins shipped with Shaarli, where there is nothing to do to install them.</p> | ||
| 107 | <p>If you want to install a third party plugin:</p> | ||
| 108 | <ul> | ||
| 109 | <li>Download it.</li> | ||
| 110 | <li>Put it in the <code>plugins</code> directory in Shaarli's installation folder.</li> | ||
| 111 | <li>Make sure you put it correctly:</li> | ||
| 112 | </ul> | ||
| 113 | <pre><code>| index.php | ||
| 114 | | plugins/ | ||
| 115 | |---| custom_plugin/ | ||
| 116 | | |---| custom_plugin.php | ||
| 117 | | |---| ... | ||
| 118 | </code></pre> | ||
| 119 | <ul> | ||
| 120 | <li>Make sure your webserver can read and write the files in your plugin folder.</li> | ||
| 121 | </ul> | ||
| 122 | <h2 id="plugin-configuration">Plugin configuration</h2> | ||
| 123 | <p>In Shaarli's administration page (<code>Tools</code> link), go to <code>Plugin administration</code>.</p> | ||
| 124 | <p>Here you can enable and disable all plugins available, and configure them.</p> | ||
| 125 | <p><img src="https://camo.githubusercontent.com/5da68e191969007492ca0fbeb25f3b2357b748cc/687474703a2f2f692e696d6775722e636f6d2f766837544643712e706e67" alt="administration screenshot" /><a href=".html"></a></p> | ||
| 126 | <h2 id="plugin-order">Plugin order</h2> | ||
| 127 | <p>In the plugin administration page, you can move enabled plugins to the top or bottom of the list. The first plugins in the list will be processed first.</p> | ||
| 128 | <p>This is important in case plugins are depending on each other. Read plugins README details for more information.</p> | ||
| 129 | <p><strong>Use case</strong>: The (non existent) plugin <code>shaares_footer</code> adds a footer to every shaare in Markdown syntax. It needs to be processed <em>before</em> (higher in the list) the Markdown plugin. Otherwise its syntax won't be translated in HTML.</p> | ||
| 130 | <h2 id="file-mode">File mode</h2> | ||
| 131 | <p>Enabled plugin are stored in your <code>config.php</code> parameters file, under the <code>array</code>:</p> | ||
| 132 | <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">'ENABLED_PLUGINS'</span><span class="ot">]](</span><span class="st">'ENABLED_PLUGINS'</span><span class="ot">]</span>.html<span class="ot">)</span></code></pre></div> | ||
| 133 | <p>You can edit them manually here.<br /> | ||
| 134 | Example:</p> | ||
| 135 | <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">'ENABLED_PLUGINS'</span><span class="ot">]</span> = <span class="fu">array</span><span class="ot">(](</span><span class="st">'ENABLED_PLUGINS'</span><span class="ot">]</span>-=-<span class="fu">array</span><span class="ot">(</span>.html<span class="ot">)</span> | ||
| 136 | <span class="st">'qrcode'</span><span class="ot">,</span> | ||
| 137 | <span class="st">'archiveorg'</span><span class="ot">,</span> | ||
| 138 | <span class="st">'wallabag'</span><span class="ot">,</span> | ||
| 139 | <span class="st">'markdown'</span><span class="ot">,</span> | ||
| 140 | <span class="ot">);</span></code></pre></div> | ||
| 141 | <h3 id="plugin-usage">Plugin usage</h3> | ||
| 142 | <h4 id="official-plugins">Official plugins</h4> | ||
| 143 | <p>Usage of each plugin is documented in it's README file:</p> | ||
| 144 | <ul> | ||
| 145 | <li><code>addlink-toolbar</code>: Adds the addlink input on the linklist page</li> | ||
| 146 | <li><code>archiveorg</code>: For each link, add an Archive.org icon</li> | ||
| 147 | <li><a href="https://github.com/shaarli/Shaarli/blob/master/plugins/markdown/README.md"><code>markdown</code></a>: Render shaare description with Markdown syntax.<a href=".html"></a></li> | ||
| 148 | <li><a href="https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md"><code>playvideos</code></a>: Add a button in the toolbar allowing to watch all videos.<a href=".html"></a></li> | ||
| 149 | <li><code>qrcode</code>: For each link, add a QRCode icon.</li> | ||
| 150 | <li><a href="https://github.com/shaarli/Shaarli/blob/master/plugins/wallabag/README.md"><code>wallabag</code></a>: For each link, add a Wallabag icon to save it in your instance.<a href=".html"></a></li> | ||
| 151 | </ul> | ||
| 152 | <h4 id="third-party-plugins">Third party plugins</h4> | ||
| 153 | <p>See <a href="https://github.com/shaarli/Shaarli/wiki/Community-%26-Related-software#third-party-plugins">Community & related software</a><a href=".html"></a></p> | ||
| 154 | </body> | ||
| 155 | </html> | ||
diff --git a/doc/REST-API.html b/doc/REST-API.html deleted file mode 100644 index d14c98c9..00000000 --- a/doc/REST-API.html +++ /dev/null | |||
| @@ -1,169 +0,0 @@ | |||
| 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 – REST API</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>Setup | ||
| 56 | <ul> | ||
| 57 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 58 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 59 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 60 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 61 | <li><a href="Server-security.html">Server security</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 | <li><a href="REST-API.html">REST API</a></li> | ||
| 73 | </ul></li> | ||
| 74 | <li>How To | ||
| 75 | <ul> | ||
| 76 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</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="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 92 | <li><a href="Security.html">Security</a></li> | ||
| 93 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 94 | <li><a href="Theming.html">Theming</a></li> | ||
| 95 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 96 | </ul></li> | ||
| 97 | <li>About | ||
| 98 | <ul> | ||
| 99 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 100 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 101 | </ul></li> | ||
| 102 | </ul> | ||
| 103 | </div> | ||
| 104 | <h1 id="rest-api">REST API</h1> | ||
| 105 | <h2 id="usage">Usage</h2> | ||
| 106 | <p>See the <a href="http://shaarli.github.io/api-documentation/">REST API documentation</a>.<a href=".html"></a></p> | ||
| 107 | <h2 id="authentication">Authentication</h2> | ||
| 108 | <p>All requests to Shaarli's API must include a JWT token to verify their authenticity.</p> | ||
| 109 | <p>This token has to be included as an HTTP header called <code>Authentication: Bearer <jwt token></code>.</p> | ||
| 110 | <p>JWT resources :</p> | ||
| 111 | <ul> | ||
| 112 | <li><a href="https://jwt.io">jwt.io</a> (including a list of client per language).<a href=".html"></a></li> | ||
| 113 | <li>RFC : <a href="https://tools.ietf.org/html/rfc7519" class="uri">https://tools.ietf.org/html/rfc7519</a></li> | ||
| 114 | <li><a href="https://float-middle.com/json-web-tokens-jwt-vs-sessions/" class="uri">https://float-middle.com/json-web-tokens-jwt-vs-sessions/</a></li> | ||
| 115 | <li>HackerNews thread: <a href="https://news.ycombinator.com/item?id=11929267" class="uri">https://news.ycombinator.com/item?id=11929267</a></li> | ||
| 116 | </ul> | ||
| 117 | <h3 id="shaarli-jwt-token">Shaarli JWT Token</h3> | ||
| 118 | <p>JWT tokens are composed by three parts, separated by a dot <code>.</code> and encoded in base64:</p> | ||
| 119 | <pre><code>[header].[payload].[signature][](.html)</code></pre> | ||
| 120 | <h4 id="header">Header</h4> | ||
| 121 | <p>Shaarli only allow one hash algorithm, so the header will always be the same:</p> | ||
| 122 | <div class="sourceCode"><pre class="sourceCode json"><code class="sourceCode json"><span class="fu">{</span> | ||
| 123 | <span class="dt">"typ"</span><span class="fu">:</span> <span class="st">"JWT"</span><span class="fu">,</span> | ||
| 124 | <span class="dt">"alg"</span><span class="fu">:</span> <span class="st">"HS512"</span> | ||
| 125 | <span class="fu">}</span></code></pre></div> | ||
| 126 | <p>Encoded in base64, it gives:</p> | ||
| 127 | <pre><code>ewogICAgICAgICJ0eXAiOiAiSldUIiwKICAgICAgICAiYWxnIjogIkhTNTEyIgogICAgfQ==</code></pre> | ||
| 128 | <h4 id="payload">Payload</h4> | ||
| 129 | <p><strong>Validity duration</strong></p> | ||
| 130 | <p>To avoid infinite token validity, JWT tokens must include their creation date in UNIX timestamp format (timezone independant - UTC) under the key <code>iat</code> (issued at). This token will be accepted during 9 minutes.</p> | ||
| 131 | <div class="sourceCode"><pre class="sourceCode json"><code class="sourceCode json"><span class="fu">{</span> | ||
| 132 | <span class="dt">"iat"</span><span class="fu">:</span> <span class="dv">1468663519</span> | ||
| 133 | <span class="fu">}</span></code></pre></div> | ||
| 134 | <p>See <a href="https://tools.ietf.org/html/rfc7519#section-4.1.6">RFC reference</a>.<a href=".html"></a></p> | ||
| 135 | <h4 id="signature">Signature</h4> | ||
| 136 | <p>The signature authenticate the token validity. It contains the base64 of the header and the body, separated by a dot <code>.</code>, hashed in SHA512 with the API secret available in Shaarli administration page.</p> | ||
| 137 | <p>Signature example with PHP:</p> | ||
| 138 | <div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php"><span class="kw">$content</span> = <span class="fu">base64_encode</span><span class="ot">(</span><span class="kw">$header</span><span class="ot">)</span> . <span class="st">'.'</span> . <span class="fu">base64_encode</span><span class="ot">(</span><span class="kw">$payload</span><span class="ot">);</span> | ||
| 139 | <span class="kw">$signature</span> = <span class="fu">hash_hmac</span><span class="ot">(</span><span class="st">'sha512'</span><span class="ot">,</span> <span class="kw">$content</span><span class="ot">,</span> <span class="kw">$secret</span><span class="ot">);</span></code></pre></div> | ||
| 140 | <h3 id="complete-example">Complete example</h3> | ||
| 141 | <h4 id="php">PHP</h4> | ||
| 142 | <div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php"><span class="kw">function</span> generateToken<span class="ot">(</span><span class="kw">$secret</span><span class="ot">)</span> { | ||
| 143 | <span class="kw">$header</span> = <span class="fu">base64_encode</span><span class="ot">(</span><span class="st">'{</span> | ||
| 144 | <span class="st"> "typ": "JWT",</span> | ||
| 145 | <span class="st"> "alg": "HS512"</span> | ||
| 146 | <span class="st"> }'</span><span class="ot">);</span> | ||
| 147 | <span class="kw">$payload</span> = <span class="fu">base64_encode</span><span class="ot">(</span><span class="st">'{</span> | ||
| 148 | <span class="st"> "iat": '</span>. <span class="fu">time</span><span class="ot">()</span> .<span class="st">'</span> | ||
| 149 | <span class="st"> }'</span><span class="ot">);</span> | ||
| 150 | <span class="kw">$signature</span> = <span class="fu">hash_hmac</span><span class="ot">(</span><span class="st">'sha512'</span><span class="ot">,</span> <span class="kw">$header</span> .<span class="st">'.'</span>. <span class="kw">$payload</span> <span class="ot">,</span> <span class="kw">$secret</span><span class="ot">);</span> | ||
| 151 | <span class="kw">return</span> <span class="kw">$header</span> .<span class="st">'.'</span>. <span class="kw">$payload</span> .<span class="st">'.'</span>. <span class="kw">$signature</span><span class="ot">;</span> | ||
| 152 | } | ||
| 153 | |||
| 154 | <span class="kw">$secret</span> = <span class="st">'mysecret'</span><span class="ot">;</span> | ||
| 155 | <span class="kw">$token</span> = generateToken<span class="ot">(</span><span class="kw">$secret</span><span class="ot">);</span> | ||
| 156 | <span class="fu">echo</span> <span class="kw">$token</span><span class="ot">;</span></code></pre></div> | ||
| 157 | <blockquote> | ||
| 158 | <p><code>ewogICAgICAgICJ0eXAiOiAiSldUIiwKICAgICAgICAiYWxnIjogIkhTNTEyIgogICAgfQ==.ewogICAgICAgICJpYXQiOiAxNDY4NjY3MDQ3CiAgICB9.1d2c54fa947daf594fdbf7591796195652c8bc63bffad7f6a6db2a41c313f495a542cbfb595acade79e83f3810d709b4251d7b940bbc10b531a6e6134af63a68</code></p> | ||
| 159 | </blockquote> | ||
| 160 | <div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php"><span class="kw">$options</span> = <span class="ot">[[](</span>.html<span class="ot">)</span> | ||
| 161 | <span class="st">'http'</span> => <span class="ot">[[](</span>.html<span class="ot">)</span> | ||
| 162 | <span class="st">'method'</span> => <span class="st">'GET'</span><span class="ot">,</span> | ||
| 163 | <span class="st">'jwt'</span> => <span class="kw">$token</span><span class="ot">,</span> | ||
| 164 | <span class="ot">],</span> | ||
| 165 | <span class="ot">];</span> | ||
| 166 | <span class="kw">$context</span> = <span class="fu">stream_context_create</span><span class="ot">(</span><span class="kw">$options</span><span class="ot">);</span> | ||
| 167 | <span class="fu">file_get_contents</span><span class="ot">(</span><span class="kw">$apiEndpoint</span><span class="ot">,</span> <span class="kw">false</span><span class="ot">,</span> <span class="kw">$context</span><span class="ot">);</span></code></pre></div> | ||
| 168 | </body> | ||
| 169 | </html> | ||
diff --git a/doc/RSS-feeds.html b/doc/RSS-feeds.html deleted file mode 100644 index 0ebfecc6..00000000 --- a/doc/RSS-feeds.html +++ /dev/null | |||
| @@ -1,99 +0,0 @@ | |||
| 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 – RSS feeds</title> | ||
| 8 | <style type="text/css">code{white-space: pre;}</style> | ||
| 9 | <link rel="stylesheet" href="github-markdown.css"> | ||
| 10 | <!--[if lt IE 9]> | ||
| 11 | <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script> | ||
| 12 | <![endif]--> | ||
| 13 | </head> | ||
| 14 | <body> | ||
| 15 | <div id="local-sidebar"> | ||
| 16 | <ul> | ||
| 17 | <li><a href="Home.html">Home</a></li> | ||
| 18 | <li>Setup | ||
| 19 | <ul> | ||
| 20 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 21 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 22 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 23 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 24 | <li><a href="Server-security.html">Server security</a></li> | ||
| 25 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> | ||
| 26 | <li><a href="Plugins.html">Plugins</a></li> | ||
| 27 | </ul></li> | ||
| 28 | <li><a href="Docker.html">Docker</a></li> | ||
| 29 | <li><a href="Usage.html">Usage</a> | ||
| 30 | <ul> | ||
| 31 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> | ||
| 32 | <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li> | ||
| 33 | <li><a href="Firefox-share.html">Firefox share</a></li> | ||
| 34 | <li><a href="RSS-feeds.html">RSS feeds</a></li> | ||
| 35 | <li><a href="REST-API.html">REST API</a></li> | ||
| 36 | </ul></li> | ||
| 37 | <li>How To | ||
| 38 | <ul> | ||
| 39 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | ||
| 40 | <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> | ||
| 41 | <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li> | ||
| 42 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> | ||
| 43 | <li><a href="Datastore-hacks.html">Datastore hacks</a></li> | ||
| 44 | </ul></li> | ||
| 45 | <li><a href="Troubleshooting.html">Troubleshooting</a></li> | ||
| 46 | <li><a href="Development.html">Development</a> | ||
| 47 | <ul> | ||
| 48 | <li><a href="GnuPG-signature.html">GnuPG signature</a></li> | ||
| 49 | <li><a href="Coding-guidelines.html">Coding guidelines</a></li> | ||
| 50 | <li><a href="Directory-structure.html">Directory structure</a></li> | ||
| 51 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> | ||
| 52 | <li><a href="Plugin-System.html">Plugin System</a></li> | ||
| 53 | <li><a href="Release-Shaarli.html">Release Shaarli</a></li> | ||
| 54 | <li><a href="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 55 | <li><a href="Security.html">Security</a></li> | ||
| 56 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 57 | <li><a href="Theming.html">Theming</a></li> | ||
| 58 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 59 | </ul></li> | ||
| 60 | <li>About | ||
| 61 | <ul> | ||
| 62 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 63 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 64 | </ul></li> | ||
| 65 | </ul> | ||
| 66 | </div> | ||
| 67 | <h1 id="rss-feeds">RSS feeds</h1> | ||
| 68 | <h3 id="feeds-options">Feeds options</h3> | ||
| 69 | <p>Feeds are available in ATOM with <code>?do=atom</code> and RSS with <code>do=RSS</code>.</p> | ||
| 70 | <p>Options:</p> | ||
| 71 | <ul> | ||
| 72 | <li>You can use <code>permalinks</code> in the feed URL to get permalink to Shaares instead of direct link to shaared URL. | ||
| 73 | <ul> | ||
| 74 | <li>E.G. <code>https://my.shaarli.domain/?do=atom&permalinks</code>.</li> | ||
| 75 | </ul></li> | ||
| 76 | <li>You can use <code>nb</code> parameter in the feed URL to specify the number of Shaares you want in a feed (default if not specified: <code>50</code>). The keyword <code>all</code> is available if you want everything. | ||
| 77 | <ul> | ||
| 78 | <li><code>https://my.shaarli.domain/?do=atom&permalinks&nb=42</code></li> | ||
| 79 | <li><code>https://my.shaarli.domain/?do=atom&permalinks&nb=all</code></li> | ||
| 80 | </ul></li> | ||
| 81 | </ul> | ||
| 82 | <h3 id="rss-feeds-or-picture-wall-for-a-specific-searchtag">RSS Feeds or Picture Wall for a specific search/tag</h3> | ||
| 83 | <p>It is possible to filter RSS/ATOM feeds and Picture Wall on a Shaarli to <strong>only display results of a specific search, or for a specific tag</strong>.</p> | ||
| 84 | <p>For example, if you want to subscribe only to links tagged <code>photography</code>:</p> | ||
| 85 | <ul> | ||
| 86 | <li>Go to the desired Shaarli instance.</li> | ||
| 87 | <li>Search for the <code>photography</code> tag in the <em>Filter by tag</em> box. Links tagged <code>photography</code> are displayed.</li> | ||
| 88 | <li>Click on the <code>RSS Feed</code> button.</li> | ||
| 89 | <li>You are presented with an RSS feed showing only these links. Subscribe to it to receive only updates with this tag.</li> | ||
| 90 | <li>The same method <strong>also works for a full-text search</strong> (<em>Search</em> box) <strong>and for the Picture Wall</strong> (want to only see pictures about <code>nature</code>?)</li> | ||
| 91 | <li>You can also build the URLs manually: | ||
| 92 | <ul> | ||
| 93 | <li><code>https://my.shaarli.domain/?do=rss&searchtags=nature</code></li> | ||
| 94 | <li><code>https://my.shaarli.domain/links/?do=picwall&searchterm=poney</code></li> | ||
| 95 | </ul></li> | ||
| 96 | </ul> | ||
| 97 | <p><embed src="(images/rss-filter-1.png)-!.html" />(images/rss-filter-2.png)</p> | ||
| 98 | </body> | ||
| 99 | </html> | ||
diff --git a/doc/Release-Shaarli.html b/doc/Release-Shaarli.html deleted file mode 100644 index fa690c7c..00000000 --- a/doc/Release-Shaarli.html +++ /dev/null | |||
| @@ -1,224 +0,0 @@ | |||
| 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 – Release Shaarli</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>Setup | ||
| 56 | <ul> | ||
| 57 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 58 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 59 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 60 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 61 | <li><a href="Server-security.html">Server security</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 | <li><a href="REST-API.html">REST API</a></li> | ||
| 73 | </ul></li> | ||
| 74 | <li>How To | ||
| 75 | <ul> | ||
| 76 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</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="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 92 | <li><a href="Security.html">Security</a></li> | ||
| 93 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 94 | <li><a href="Theming.html">Theming</a></li> | ||
| 95 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 96 | </ul></li> | ||
| 97 | <li>About | ||
| 98 | <ul> | ||
| 99 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 100 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 101 | </ul></li> | ||
| 102 | </ul> | ||
| 103 | </div> | ||
| 104 | <h1 id="release-shaarli">Release Shaarli</h1> | ||
| 105 | <p>See <a href="http://git-scm.com/book/en/v2/Distributed-Git-Maintaining-a-Project#Tagging-Your-Releases">Git - Maintaining a project - Tagging your [](.html)<br /> | ||
| 106 | releases</a>.</p> | ||
| 107 | <h2 id="prerequisites">Prerequisites</h2> | ||
| 108 | <p>This guide assumes that you have:</p> | ||
| 109 | <ul> | ||
| 110 | <li>a GPG key matching your GitHub authentication credentials | ||
| 111 | <ul> | ||
| 112 | <li>i.e., the email address identified by the GPG key is the same as the one in your <code>~/.gitconfig</code></li> | ||
| 113 | </ul></li> | ||
| 114 | <li>a GitHub fork of Shaarli</li> | ||
| 115 | <li>a local clone of your Shaarli fork, with the following remotes: | ||
| 116 | <ul> | ||
| 117 | <li><code>origin</code> pointing to your GitHub fork</li> | ||
| 118 | <li><code>upstream</code> pointing to the main Shaarli repository</li> | ||
| 119 | </ul></li> | ||
| 120 | <li>maintainer permissions on the main Shaarli repository, to: | ||
| 121 | <ul> | ||
| 122 | <li>push the signed tag</li> | ||
| 123 | <li>create a new release</li> | ||
| 124 | </ul></li> | ||
| 125 | <li><a href="https://getcomposer.org/">Composer</a> and <a href="http://pandoc.org/">Pandoc</a> need to be installed<a href=".html"></a></li> | ||
| 126 | </ul> | ||
| 127 | <h2 id="github-release-draft-and-changelog.md">GitHub release draft and <code>CHANGELOG.md</code></h2> | ||
| 128 | <p>See <a href="http://keepachangelog.com/en/0.3.0/" class="uri">http://keepachangelog.com/en/0.3.0/</a> for changelog formatting.</p> | ||
| 129 | <h3 id="github-release-draft">GitHub release draft</h3> | ||
| 130 | <p>GitHub allows drafting the release note for the upcoming release, from the <a href="https://github.com/shaarli/Shaarli/releases">Releases</a> page. This way, the release note can be drafted while contributions are merged to <code>master</code>.<a href=".html"></a></p> | ||
| 131 | <h3 id="changelog.md"><code>CHANGELOG.md</code></h3> | ||
| 132 | <p>This file should contain the same information as the release note draft for the upcoming version.</p> | ||
| 133 | <p>Update it to:</p> | ||
| 134 | <ul> | ||
| 135 | <li>add new entries (additions, fixes, etc.)</li> | ||
| 136 | <li>mark the current version as released by setting its date and link</li> | ||
| 137 | <li>add a new section for the future unreleased version</li> | ||
| 138 | </ul> | ||
| 139 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="bu">cd</span> /path/to/shaarli | ||
| 140 | |||
| 141 | $ <span class="fu">nano</span> CHANGELOG.md | ||
| 142 | |||
| 143 | [<span class="ex">...</span>][](.html) | ||
| 144 | <span class="co">## vA.B.C - UNRELEASED</span> | ||
| 145 | <span class="ex">TBA</span> | ||
| 146 | |||
| 147 | <span class="co">## [vX.Y.Z](https://github.com/shaarli/Shaarli/releases/tag/vX.Y.Z) - YYYY-MM-DD[](.html)</span> | ||
| 148 | [<span class="ex">...</span>][](.html)</code></pre></div> | ||
| 149 | <h2 id="increment-the-version-code-create-and-push-a-signed-tag">Increment the version code, create and push a signed tag</h2> | ||
| 150 | <h3 id="bump-shaarlis-version">Bump Shaarli's version</h3> | ||
| 151 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="bu">cd</span> /path/to/shaarli | ||
| 152 | |||
| 153 | <span class="co"># create a new branch</span> | ||
| 154 | $ <span class="fu">git</span> fetch upstream | ||
| 155 | $ <span class="fu">git</span> checkout upstream/master -b v0.5.0 | ||
| 156 | |||
| 157 | <span class="co"># bump the version number</span> | ||
| 158 | $ <span class="ex">vim</span> index.php shaarli_version.php | ||
| 159 | |||
| 160 | <span class="co"># rebuild the documentation from the wiki</span> | ||
| 161 | $ <span class="fu">make</span> htmldoc | ||
| 162 | |||
| 163 | <span class="co"># commit the changes</span> | ||
| 164 | $ <span class="fu">git</span> add index.php shaarli_version.php doc | ||
| 165 | $ <span class="fu">git</span> commit -s -m <span class="st">"Bump version to v0.5.0"</span> | ||
| 166 | |||
| 167 | <span class="co"># push the commit on your GitHub fork</span> | ||
| 168 | $ <span class="fu">git</span> push origin v0.5.0</code></pre></div> | ||
| 169 | <h3 id="create-and-merge-a-pull-request">Create and merge a Pull Request</h3> | ||
| 170 | <p>This one is pretty straightforward ;-)</p> | ||
| 171 | <h3 id="create-and-push-a-signed-tag">Create and push a signed tag</h3> | ||
| 172 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># update your local copy</span> | ||
| 173 | $ <span class="fu">git</span> checkout master | ||
| 174 | $ <span class="fu">git</span> fetch upstream | ||
| 175 | $ <span class="fu">git</span> pull upstream master | ||
| 176 | |||
| 177 | <span class="co"># create a signed tag</span> | ||
| 178 | $ <span class="fu">git</span> tag -s -m <span class="st">"Release v0.5.0"</span> v0.5.0 | ||
| 179 | |||
| 180 | <span class="co"># push it to "upstream"</span> | ||
| 181 | $ <span class="fu">git</span> push --tags upstream</code></pre></div> | ||
| 182 | <h3 id="verify-a-signed-tag">Verify a signed tag</h3> | ||
| 183 | <p><a href="https://github.com/shaarli/Shaarli/releases/tag/v0.5.0"><code>v0.5.0</code></a> is the first GPG-signed tag pushed on the Community Shaarli.<a href=".html"></a></p> | ||
| 184 | <p>Let's have a look at its signature!</p> | ||
| 185 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="bu">cd</span> /path/to/shaarli | ||
| 186 | $ <span class="fu">git</span> fetch upstream | ||
| 187 | |||
| 188 | <span class="co"># get the SHA1 reference of the tag</span> | ||
| 189 | $ <span class="fu">git</span> show-ref tags/v0.5.0 | ||
| 190 | <span class="ex">f7762cf803f03f5caf4b8078359a63783d0090c1</span> refs/tags/v0.5.0 | ||
| 191 | |||
| 192 | <span class="co"># verify the tag signature information</span> | ||
| 193 | $ <span class="fu">git</span> verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1 | ||
| 194 | <span class="ex">gpg</span>: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F | ||
| 195 | <span class="ex">gpg</span>: Good signature from <span class="st">"VirtualTam <virtualtam@flibidi.net>"</span> [ultimate][](.html)</code></pre></div> | ||
| 196 | <h2 id="publish-the-github-release">Publish the GitHub release</h2> | ||
| 197 | <h3 id="update-release-badges">Update release badges</h3> | ||
| 198 | <p>Update <code>README.md</code> so version badges display and point to the newly released Shaarli version(s).</p> | ||
| 199 | <h3 id="create-a-github-release-from-a-git-tag">Create a GitHub release from a Git tag</h3> | ||
| 200 | <p>From the previously drafted release:</p> | ||
| 201 | <ul> | ||
| 202 | <li>edit the release notes (if needed)</li> | ||
| 203 | <li>specify the appropriate Git tag</li> | ||
| 204 | <li>publish the release</li> | ||
| 205 | <li>profit!</li> | ||
| 206 | </ul> | ||
| 207 | <h3 id="generate-and-upload-all-in-one-release-archives">Generate and upload all-in-one release archives</h3> | ||
| 208 | <p>Users with a shared hosting may have:</p> | ||
| 209 | <ul> | ||
| 210 | <li>no SSH access</li> | ||
| 211 | <li>no possibility to install PHP packages or server extensions</li> | ||
| 212 | <li>no possibility to run scripts</li> | ||
| 213 | </ul> | ||
| 214 | <p>To ease Shaarli installations, it is possible to generate and upload additional release archives,<br /> | ||
| 215 | that will contain Shaarli code plus all required third-party libraries:</p> | ||
| 216 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="fu">make</span> release_archive</code></pre></div> | ||
| 217 | <p>This will create the following archives:</p> | ||
| 218 | <ul> | ||
| 219 | <li><code>shaarli-vX.Y.Z-full.tar</code></li> | ||
| 220 | <li><code>shaarli-vX.Y.Z-full.zip</code></li> | ||
| 221 | </ul> | ||
| 222 | <p>The archives need to be manually uploaded on the previously created GitHub release.</p> | ||
| 223 | </body> | ||
| 224 | </html> | ||
diff --git a/doc/Security.html b/doc/Security.html deleted file mode 100644 index 12b46fa9..00000000 --- a/doc/Security.html +++ /dev/null | |||
| @@ -1,135 +0,0 @@ | |||
| 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 – Security</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>Setup | ||
| 56 | <ul> | ||
| 57 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 58 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 59 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 60 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 61 | <li><a href="Server-security.html">Server security</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 | <li><a href="REST-API.html">REST API</a></li> | ||
| 73 | </ul></li> | ||
| 74 | <li>How To | ||
| 75 | <ul> | ||
| 76 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</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="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 92 | <li><a href="Security.html">Security</a></li> | ||
| 93 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 94 | <li><a href="Theming.html">Theming</a></li> | ||
| 95 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 96 | </ul></li> | ||
| 97 | <li>About | ||
| 98 | <ul> | ||
| 99 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 100 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 101 | </ul></li> | ||
| 102 | </ul> | ||
| 103 | </div> | ||
| 104 | <h1 id="security">Security</h1> | ||
| 105 | <h2 id="client-browser">Client browser</h2> | ||
| 106 | <ul> | ||
| 107 | <li>Shaarli relies on <code>HTTP_REFERER</code> for some functions (like redirects and clicking on tags). If you have disabled or masqueraded <code>HTTP_REFERER</code> in your browser, some features of Shaarli may not work</li> | ||
| 108 | </ul> | ||
| 109 | <h2 id="php">PHP</h2> | ||
| 110 | <ul> | ||
| 111 | <li><code>magic_quotes</code> is an horrible option of PHP which is often activated on servers. No serious developer should rely on this horror to secure their code against SQL injections. You should disable it (and Shaarli expects this option to be disabled). Nevertheless, I have added code to cope with <code>magic_quotes</code> on, so you should not be bothered even on crappy hosts.</li> | ||
| 112 | </ul> | ||
| 113 | <h2 id="server-and-sessions">Server and sessions</h2> | ||
| 114 | <ul> | ||
| 115 | <li>Directories are protected using <code>.htaccess</code> files</li> | ||
| 116 | <li>Forms are protected against XSRF (Cross-site requests forgery):</li> | ||
| 117 | <li>Forms which act on data (save,delete…) contain a token generated by the server.</li> | ||
| 118 | <li>Any posted form which does not contain a valid token is rejected.</li> | ||
| 119 | <li>Any token can only be used once.</li> | ||
| 120 | <li>Tokens are attached to the session and cannot be reused in another session.</li> | ||
| 121 | <li>Sessions automatically expire after 60 minutes.</li> | ||
| 122 | <li>Sessions are protected against hijacking: the session ID cannot be used from a different IP address.</li> | ||
| 123 | </ul> | ||
| 124 | <h2 id="shaarli-datastore-and-configuration">Shaarli datastore and configuration</h2> | ||
| 125 | <ul> | ||
| 126 | <li>The password is salted, hashed and stored in the data subdirectory, in a PHP file, and protected by htaccess. Even if the webserver does not support htaccess, the hash is not readable by URL. Even if the .php file is stolen, the password cannot deduced from the hash. The salt prevents rainbow-tables attacks.</li> | ||
| 127 | <li>Links are stored as an associative array which is serialized, compressed (with deflate), base64-encoded and saved as a comment in a <code>.php</code> file.</li> | ||
| 128 | <li>Even if the server does not support <code>.htaccess</code> files, the data file will still not be readable by URL.</li> | ||
| 129 | <li><p>The database looks like this:</p> | ||
| 130 | <div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php"><span class="kw"><?php</span> <span class="co">/* zP1ZjxxJtiYIvvevEPJ2lDOaLrZv7o...</span> | ||
| 131 | <span class="co">...ka7gaco/Z+TFXM2i7BlfMf8qxpaSSYfKlvqv/x8= */</span> <span class="kw">?></span></code></pre></div></li> | ||
| 132 | <li><p>Small hashes are used to make a link to an entry in Shaarli. They are unique. In fact, the date of the items (eg. <code>20110923_150523</code>) is hashed with CRC32, then converted to base64 and some characters are replaced. They are always 6 characters longs and use only <code>A-Z a-z 0-9 - _</code> and <code>@</code>.</p></li> | ||
| 133 | </ul> | ||
| 134 | </body> | ||
| 135 | </html> | ||
diff --git a/doc/Server-configuration.html b/doc/Server-configuration.html deleted file mode 100644 index 0e6b220a..00000000 --- a/doc/Server-configuration.html +++ /dev/null | |||
| @@ -1,459 +0,0 @@ | |||
| 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 – Server configuration</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>Setup | ||
| 56 | <ul> | ||
| 57 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 58 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 59 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 60 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 61 | <li><a href="Server-security.html">Server security</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 | <li><a href="REST-API.html">REST API</a></li> | ||
| 73 | </ul></li> | ||
| 74 | <li>How To | ||
| 75 | <ul> | ||
| 76 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</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="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 92 | <li><a href="Security.html">Security</a></li> | ||
| 93 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 94 | <li><a href="Theming.html">Theming</a></li> | ||
| 95 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 96 | </ul></li> | ||
| 97 | <li>About | ||
| 98 | <ul> | ||
| 99 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 100 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 101 | </ul></li> | ||
| 102 | </ul> | ||
| 103 | </div> | ||
| 104 | <h1 id="server-configuration">Server configuration</h1> | ||
| 105 | <p><em>Example virtual host configurations for popular web servers</em></p> | ||
| 106 | <ul> | ||
| 107 | <li><a href="#apache">Apache</a><a href=".html"></a></li> | ||
| 108 | <li><a href="#nginx">Nginx</a><a href=".html"></a></li> | ||
| 109 | </ul> | ||
| 110 | <h2 id="prerequisites">Prerequisites</h2> | ||
| 111 | <h3 id="shaarli">Shaarli</h3> | ||
| 112 | <ul> | ||
| 113 | <li>Shaarli is installed in a directory readable/writeable by the user</li> | ||
| 114 | <li>the correct read/write permissions have been granted to the web server <em>user and/or group</em></li> | ||
| 115 | <li>for HTTPS / SSL:</li> | ||
| 116 | <li>a key pair (public, private) and a certificate have been generated</li> | ||
| 117 | <li>the appropriate server SSL extension is installed and active</li> | ||
| 118 | </ul> | ||
| 119 | <h3 id="https-tls-and-self-signed-certificates">HTTPS, TLS and self-signed certificates</h3> | ||
| 120 | <p>Related guides:</p> | ||
| 121 | <ul> | ||
| 122 | <li><a href="http://www.xenocafe.com/tutorials/linux/centos/openssl/self_signed_certificates/index.php">How to Create Self-Signed SSL Certificates with OpenSSL</a><a href=".html"></a></li> | ||
| 123 | <li><a href="https://workaround.org/certificate-authority">How do I create my own Certificate Authority?</a><a href=".html"></a></li> | ||
| 124 | <li>Generate a self-signed certificate (will trigger browser warnings) with apache2: <code>make-ssl-cert generate-default-snakeoil --force-overwrite</code> will create <code>/etc/ssl/certs/ssl-cert-snakeoil.pem</code> and <code>/etc/ssl/private/ssl-cert-snakeoil.key</code></li> | ||
| 125 | </ul> | ||
| 126 | <h3 id="proxies">Proxies</h3> | ||
| 127 | <p>If Shaarli is served behind a proxy (i.e. there is a proxy server between clients and the web server hosting Shaarli), please refer to the proxy server documentation for proper configuration. In particular, you have to ensure that the following server variables are properly set:</p> | ||
| 128 | <ul> | ||
| 129 | <li><code>X-Forwarded-Proto</code>;</li> | ||
| 130 | <li><code>X-Forwarded-Host</code>;</li> | ||
| 131 | <li><code>X-Forwarded-For</code>.</li> | ||
| 132 | </ul> | ||
| 133 | <p>See also <a href="https://github.com/shaarli/Shaarli/issues?utf8=%E2%9C%93&q=label%3Aproxy+">proxy-related</a> issues.<a href=".html"></a></p> | ||
| 134 | <h2 id="apache">Apache</h2> | ||
| 135 | <h3 id="minimal">Minimal</h3> | ||
| 136 | <div class="sourceCode"><pre class="sourceCode apache"><code class="sourceCode apache"><span class="fu"><VirtualHost</span><span class="at"> *:80</span><span class="fu">></span> | ||
| 137 | ServerName<span class="st"> shaarli.my-domain.org</span> | ||
| 138 | DocumentRoot<span class="st"> /absolute/path/to/shaarli/</span> | ||
| 139 | <span class="fu"></VirtualHost></span></code></pre></div> | ||
| 140 | <h3 id="debug---log-all-the-things">Debug - Log all the things!</h3> | ||
| 141 | <p>This configuration will log both Apache and PHP errors, which may prove useful to identify server configuration errors.</p> | ||
| 142 | <p>See:</p> | ||
| 143 | <ul> | ||
| 144 | <li><a href="http://stackoverflow.com/q/176">Apache/PHP - error log per VirtualHost</a> (StackOverflow)<a href=".html"></a></li> | ||
| 145 | <li><a href="https://ma.ttias.be/php-php_value-vs-php_admin_value-and-the-use-of-php_flag-explained/">PHP: php_value vs php_admin_value and the use of php_flag explained</a><a href=".html"></a></li> | ||
| 146 | </ul> | ||
| 147 | <div class="sourceCode"><pre class="sourceCode apache"><code class="sourceCode apache"><span class="fu"><VirtualHost</span><span class="at"> *:80</span><span class="fu">></span> | ||
| 148 | ServerName<span class="st"> shaarli.my-domain.org</span> | ||
| 149 | DocumentRoot<span class="st"> /absolute/path/to/shaarli/</span> | ||
| 150 | |||
| 151 | <span class="ex">LogLevel</span><span class="ch"> </span><span class="kw">warn</span> | ||
| 152 | ErrorLog<span class="st"> /var/log/apache2/shaarli-error.log</span> | ||
| 153 | CustomLog<span class="st"> /var/log/apache2/shaarli-access.log combined</span> | ||
| 154 | |||
| 155 | php_flag log_errors on | ||
| 156 | php_flag display_errors on | ||
| 157 | php_value error_reporting 2147483647 | ||
| 158 | php_value error_log /var/log/apache2/shaarli-php-error.log | ||
| 159 | <span class="fu"></VirtualHost></span></code></pre></div> | ||
| 160 | <h3 id="standard---keep-access-and-error-logs">Standard - Keep access and error logs</h3> | ||
| 161 | <div class="sourceCode"><pre class="sourceCode apache"><code class="sourceCode apache"><span class="fu"><VirtualHost</span><span class="at"> *:80</span><span class="fu">></span> | ||
| 162 | ServerName<span class="st"> shaarli.my-domain.org</span> | ||
| 163 | DocumentRoot<span class="st"> /absolute/path/to/shaarli/</span> | ||
| 164 | |||
| 165 | <span class="ex">LogLevel</span><span class="ch"> </span><span class="kw">warn</span> | ||
| 166 | ErrorLog<span class="st"> /var/log/apache2/shaarli-error.log</span> | ||
| 167 | CustomLog<span class="st"> /var/log/apache2/shaarli-access.log combined</span> | ||
| 168 | <span class="fu"></VirtualHost></span></code></pre></div> | ||
| 169 | <h3 id="paranoid---redirect-http-80-to-https-443">Paranoid - Redirect HTTP (:80) to HTTPS (:443)</h3> | ||
| 170 | <p>See <a href="https://wiki.mozilla.org/Security/Server_Side_TLS#Apache">Server-side TLS</a> (Mozilla).<a href=".html"></a></p> | ||
| 171 | <div class="sourceCode"><pre class="sourceCode apache"><code class="sourceCode apache"><span class="fu"><VirtualHost</span><span class="at"> *:443</span><span class="fu">></span> | ||
| 172 | ServerName<span class="st"> shaarli.my-domain.org</span> | ||
| 173 | DocumentRoot<span class="st"> /absolute/path/to/shaarli/</span> | ||
| 174 | |||
| 175 | <span class="ex">SSLEngine</span><span class="ch"> </span><span class="kw">on</span> | ||
| 176 | SSLCertificateFile<span class="st"> /absolute/path/to/the/website/certificate.pem</span> | ||
| 177 | SSLCertificateKeyFile<span class="st"> /absolute/path/to/the/website/key.key</span> | ||
| 178 | |||
| 179 | <span class="fu"><Directory</span><span class="at"> /absolute/path/to/shaarli/</span><span class="fu">></span> | ||
| 180 | <span class="ex">AllowOverride</span><span class="ch"> </span><span class="kw">All</span> | ||
| 181 | <span class="ex">Options</span><span class="ch"> </span><span class="kw">Indexes</span><span class="ch"> </span><span class="kw">FollowSymLinks</span><span class="ch"> </span><span class="kw">MultiViews</span> | ||
| 182 | <span class="ex">Order</span><span class="ch"> </span><span class="kw">allow,deny</span> | ||
| 183 | allow<span class="st"> from all</span> | ||
| 184 | <span class="fu"></Directory></span> | ||
| 185 | |||
| 186 | <span class="ex">LogLevel</span><span class="ch"> </span><span class="kw">warn</span> | ||
| 187 | ErrorLog<span class="st"> /var/log/apache2/shaarli-error.log</span> | ||
| 188 | CustomLog<span class="st"> /var/log/apache2/shaarli-access.log combined</span> | ||
| 189 | <span class="fu"></VirtualHost></span> | ||
| 190 | <span class="fu"><VirtualHost</span><span class="at"> *:80</span><span class="fu">></span> | ||
| 191 | ServerName<span class="st"> shaarli.my-domain.org</span> | ||
| 192 | Redirect<span class="st"> 301 / https://shaarli.my-domain.org</span> | ||
| 193 | |||
| 194 | <span class="ex">LogLevel</span><span class="ch"> </span><span class="kw">warn</span> | ||
| 195 | ErrorLog<span class="st"> /var/log/apache2/shaarli-error.log</span> | ||
| 196 | CustomLog<span class="st"> /var/log/apache2/shaarli-access.log combined</span> | ||
| 197 | <span class="fu"></VirtualHost></span></code></pre></div> | ||
| 198 | <h3 id="htaccess">.htaccess</h3> | ||
| 199 | <p>Shaarli use <code>.htaccess</code> Apache files to deny access to files that shouldn't be directly accessed (datastore, config, etc.). You need the directive <code>AllowOverride All</code> in your virtual host configuration for them to work.</p> | ||
| 200 | <p><strong>Warning</strong>: If you use Apache 2.2 or lower, you need <a href="https://httpd.apache.org/docs/current/mod/mod_version.html">mod_version</a> to be installed and enabled.<a href=".html"></a></p> | ||
| 201 | <p>Apache module <code>mod_rewrite</code> <strong>must</strong> be enabled to use the REST API. URL rewriting rules for the Slim microframework are stated in the root <code>.htaccess</code> file.</p> | ||
| 202 | <h2 id="lighthttpd">LightHttpd</h2> | ||
| 203 | <h2 id="nginx">Nginx</h2> | ||
| 204 | <h3 id="foreword">Foreword</h3> | ||
| 205 | <p>Nginx does not natively interpret PHP scripts; to this effect, we will run a <a href="https://en.wikipedia.org/wiki/FastCGI">FastCGI</a> service, to which Nginx's FastCGI module will proxy all requests to PHP resources.<a href=".html"></a></p> | ||
| 206 | <p>Required packages:</p> | ||
| 207 | <ul> | ||
| 208 | <li><a href="http://nginx.org">nginx</a><a href=".html"></a></li> | ||
| 209 | <li><a href="http://php-fpm.org">php-fpm</a> - PHP FastCGI Process Manager<a href=".html"></a></li> | ||
| 210 | </ul> | ||
| 211 | <p>Official documentation:</p> | ||
| 212 | <ul> | ||
| 213 | <li><a href="http://nginx.org/en/docs/beginners_guide.html">Beginner's guide</a><a href=".html"></a></li> | ||
| 214 | <li><a href="http://nginx.org/en/docs/http/ngx_http_fastcgi_module.html">ngx_http_fastcgi_module</a><a href=".html"></a></li> | ||
| 215 | <li><a href="http://wiki.nginx.org/Pitfalls">Pitfalls</a><a href=".html"></a></li> | ||
| 216 | </ul> | ||
| 217 | <p>Community resources:</p> | ||
| 218 | <ul> | ||
| 219 | <li><a href="https://wiki.mozilla.org/Security/Server_Side_TLS#Nginx">Server-side TLS (Nginx)</a> (Mozilla)<a href=".html"></a></li> | ||
| 220 | <li><a href="http://kbeezie.com/nginx-configuration-examples/">PHP configuration examples</a> (Karl Blessing)<a href=".html"></a></li> | ||
| 221 | </ul> | ||
| 222 | <h3 id="common-setup">Common setup</h3> | ||
| 223 | <p>Once Nginx and PHP-FPM are installed, we need to ensure:</p> | ||
| 224 | <ul> | ||
| 225 | <li>Nginx and PHP-FPM are running using the <em>same user and group</em></li> | ||
| 226 | <li>both these user and group have | ||
| 227 | <ul> | ||
| 228 | <li><code>read</code> permissions for Shaarli resources</li> | ||
| 229 | <li><code>execute</code> permissions for Shaarli directories <em>AND</em> their parent directories</li> | ||
| 230 | </ul></li> | ||
| 231 | </ul> | ||
| 232 | <p>On a production server:</p> | ||
| 233 | <ul> | ||
| 234 | <li><code>user:group</code> will likely be <code>http:http</code>, <code>www:www</code> or <code>www-data:www-data</code></li> | ||
| 235 | <li>files will be located under <code>/var/www</code>, <code>/var/http</code> or <code>/usr/share/nginx</code></li> | ||
| 236 | </ul> | ||
| 237 | <p>On a development server:</p> | ||
| 238 | <ul> | ||
| 239 | <li>files may be located in a user's home directory</li> | ||
| 240 | <li>in this case, make sure both Nginx and PHP-FPM are running as the local user/group!</li> | ||
| 241 | </ul> | ||
| 242 | <p>For all following configuration examples, this user/group pair will be used:</p> | ||
| 243 | <ul> | ||
| 244 | <li><code>user:group = john:users</code>,</li> | ||
| 245 | </ul> | ||
| 246 | <p>which corresponds to the following service configuration:</p> | ||
| 247 | <div class="sourceCode"><pre class="sourceCode ini"><code class="sourceCode ini"><span class="co">; /etc/php/php-fpm.conf</span> | ||
| 248 | <span class="dt">user </span><span class="ot">=</span><span class="st"> john</span> | ||
| 249 | <span class="dt">group </span><span class="ot">=</span><span class="st"> users</span> | ||
| 250 | |||
| 251 | <span class="kw">[...][]</span><span class="dt">(.html)</span> | ||
| 252 | <span class="dt">listen.owner </span><span class="ot">=</span><span class="st"> john</span> | ||
| 253 | <span class="dt">listen.group </span><span class="ot">=</span><span class="st"> users</span></code></pre></div> | ||
| 254 | <pre class="nginx"><code># /etc/nginx/nginx.conf | ||
| 255 | user john users; | ||
| 256 | |||
| 257 | http { | ||
| 258 | [...][](.html) | ||
| 259 | }</code></pre> | ||
| 260 | <h3 id="optional-increase-the-maximum-file-upload-size">(Optional) Increase the maximum file upload size</h3> | ||
| 261 | <p>Some bookmark dumps generated by web browsers can be <em>huge</em> due to the presence of Base64-encoded images and favicons, as well as extra verbosity when nesting links in (sub-)folders.</p> | ||
| 262 | <p>To increase upload size, you will need to modify both nginx and PHP configuration:</p> | ||
| 263 | <pre class="nginx"><code># /etc/nginx/nginx.conf | ||
| 264 | |||
| 265 | http { | ||
| 266 | [...][](.html) | ||
| 267 | |||
| 268 | client_max_body_size 10m; | ||
| 269 | |||
| 270 | [...][](.html) | ||
| 271 | }</code></pre> | ||
| 272 | <div class="sourceCode"><pre class="sourceCode ini"><code class="sourceCode ini"><span class="co"># /etc/php5/fpm/php.ini</span> | ||
| 273 | |||
| 274 | <span class="kw">[...][]</span><span class="dt">(.html)</span> | ||
| 275 | <span class="dt">post_max_size </span><span class="ot">=</span><span class="st"> 10M</span> | ||
| 276 | <span class="kw">[...][]</span><span class="dt">(.html)</span> | ||
| 277 | <span class="dt">upload_max_filesize </span><span class="ot">=</span><span class="st"> 10M</span></code></pre></div> | ||
| 278 | <h3 id="minimal-1">Minimal</h3> | ||
| 279 | <p><em>WARNING: Use for development only!</em></p> | ||
| 280 | <pre class="nginx"><code>user john users; | ||
| 281 | worker_processes 1; | ||
| 282 | events { | ||
| 283 | worker_connections 1024; | ||
| 284 | } | ||
| 285 | |||
| 286 | http { | ||
| 287 | include mime.types; | ||
| 288 | default_type application/octet-stream; | ||
| 289 | keepalive_timeout 20; | ||
| 290 | |||
| 291 | index index.html index.php; | ||
| 292 | |||
| 293 | server { | ||
| 294 | listen 80; | ||
| 295 | server_name localhost; | ||
| 296 | root /home/john/web; | ||
| 297 | |||
| 298 | access_log /var/log/nginx/access.log; | ||
| 299 | error_log /var/log/nginx/error.log; | ||
| 300 | |||
| 301 | location /shaarli/ { | ||
| 302 | try_files $uri /shaarli/index.php$is_args$args; | ||
| 303 | access_log /var/log/nginx/shaarli.access.log; | ||
| 304 | error_log /var/log/nginx/shaarli.error.log; | ||
| 305 | } | ||
| 306 | |||
| 307 | location ~ (index)\.php$ { | ||
| 308 | try_files $uri =404; | ||
| 309 | fastcgi_split_path_info ^(.+\.php)(/.+)$; | ||
| 310 | fastcgi_pass unix:/var/run/php-fpm/php-fpm.sock; | ||
| 311 | fastcgi_index index.php; | ||
| 312 | include fastcgi.conf; | ||
| 313 | } | ||
| 314 | } | ||
| 315 | }</code></pre> | ||
| 316 | <h3 id="modular">Modular</h3> | ||
| 317 | <p>The previous setup is sufficient for development purposes, but has several major caveats:</p> | ||
| 318 | <ul> | ||
| 319 | <li>every content that does not match the PHP rule will be sent to client browsers: | ||
| 320 | <ul> | ||
| 321 | <li>dotfiles - in our case, <code>.htaccess</code></li> | ||
| 322 | <li>temporary files, e.g. Vim or Emacs files: <code>index.php~</code></li> | ||
| 323 | </ul></li> | ||
| 324 | <li>asset / static resource caching is not optimized</li> | ||
| 325 | <li>if serving several PHP sites, there will be a lot of duplication: <code>location /shaarli/</code>, <code>location /mysite/</code>, etc.</li> | ||
| 326 | </ul> | ||
| 327 | <p>To solve this, we will split Nginx configuration in several parts, that will be included when needed:</p> | ||
| 328 | <pre class="nginx"><code># /etc/nginx/deny.conf | ||
| 329 | location ~ /\. { | ||
| 330 | # deny access to dotfiles | ||
| 331 | access_log off; | ||
| 332 | log_not_found off; | ||
| 333 | deny all; | ||
| 334 | } | ||
| 335 | |||
| 336 | location ~ ~$ { | ||
| 337 | # deny access to temp editor files, e.g. "script.php~" | ||
| 338 | access_log off; | ||
| 339 | log_not_found off; | ||
| 340 | deny all; | ||
| 341 | }</code></pre> | ||
| 342 | <pre class="nginx"><code># /etc/nginx/php.conf | ||
| 343 | location ~ (index)\.php$ { | ||
| 344 | # Slim - split URL path into (script_filename, path_info) | ||
| 345 | try_files $uri =404; | ||
| 346 | fastcgi_split_path_info ^(.+\.php)(/.+)$; | ||
| 347 | |||
| 348 | # filter and proxy PHP requests to PHP-FPM | ||
| 349 | fastcgi_pass unix:/var/run/php-fpm/php-fpm.sock; | ||
| 350 | fastcgi_index index.php; | ||
| 351 | include fastcgi.conf; | ||
| 352 | } | ||
| 353 | |||
| 354 | location ~ \.php$ { | ||
| 355 | # deny access to all other PHP scripts | ||
| 356 | deny all; | ||
| 357 | }</code></pre> | ||
| 358 | <pre class="nginx"><code># /etc/nginx/static_assets.conf | ||
| 359 | location ~* \.(?:ico|css|js|gif|jpe?g|png)$ { | ||
| 360 | expires max; | ||
| 361 | add_header Pragma public; | ||
| 362 | add_header Cache-Control "public, must-revalidate, proxy-revalidate"; | ||
| 363 | }</code></pre> | ||
| 364 | <pre class="nginx"><code># /etc/nginx/nginx.conf | ||
| 365 | [...][](.html) | ||
| 366 | |||
| 367 | http { | ||
| 368 | [...][](.html) | ||
| 369 | |||
| 370 | root /home/john/web; | ||
| 371 | access_log /var/log/nginx/access.log; | ||
| 372 | error_log /var/log/nginx/error.log; | ||
| 373 | |||
| 374 | server { | ||
| 375 | # virtual host for a first domain | ||
| 376 | listen 80; | ||
| 377 | server_name my.first.domain.org; | ||
| 378 | |||
| 379 | location /shaarli/ { | ||
| 380 | # Slim - rewrite URLs | ||
| 381 | try_files $uri /shaarli/index.php$is_args$args; | ||
| 382 | |||
| 383 | access_log /var/log/nginx/shaarli.access.log; | ||
| 384 | error_log /var/log/nginx/shaarli.error.log; | ||
| 385 | } | ||
| 386 | |||
| 387 | location = /shaarli/favicon.ico { | ||
| 388 | # serve the Shaarli favicon from its custom location | ||
| 389 | alias /var/www/shaarli/images/favicon.ico; | ||
| 390 | } | ||
| 391 | |||
| 392 | include deny.conf; | ||
| 393 | include static_assets.conf; | ||
| 394 | include php.conf; | ||
| 395 | } | ||
| 396 | |||
| 397 | server { | ||
| 398 | # virtual host for a second domain | ||
| 399 | listen 80; | ||
| 400 | server_name second.domain.com; | ||
| 401 | |||
| 402 | location /minigal/ { | ||
| 403 | access_log /var/log/nginx/minigal.access.log; | ||
| 404 | error_log /var/log/nginx/minigal.error.log; | ||
| 405 | } | ||
| 406 | |||
| 407 | include deny.conf; | ||
| 408 | include static_assets.conf; | ||
| 409 | include php.conf; | ||
| 410 | } | ||
| 411 | }</code></pre> | ||
| 412 | <h3 id="redirect-http-to-https">Redirect HTTP to HTTPS</h3> | ||
| 413 | <p>Assuming you have generated a (self-signed) key and certificate, and they are located under <code>/home/john/ssl/localhost.{key,crt}</code>, it is pretty straightforward to set an HTTP (:80) to HTTPS (:443) redirection to force SSL/TLS usage.</p> | ||
| 414 | <pre class="nginx"><code># /etc/nginx/nginx.conf | ||
| 415 | [...][](.html) | ||
| 416 | |||
| 417 | http { | ||
| 418 | [...][](.html) | ||
| 419 | |||
| 420 | index index.html index.php; | ||
| 421 | |||
| 422 | root /home/john/web; | ||
| 423 | access_log /var/log/nginx/access.log; | ||
| 424 | error_log /var/log/nginx/error.log; | ||
| 425 | |||
| 426 | server { | ||
| 427 | listen 80; | ||
| 428 | server_name localhost; | ||
| 429 | |||
| 430 | return 301 https://localhost$request_uri; | ||
| 431 | } | ||
| 432 | |||
| 433 | server { | ||
| 434 | listen 443 ssl; | ||
| 435 | server_name localhost; | ||
| 436 | |||
| 437 | ssl_certificate /home/john/ssl/localhost.crt; | ||
| 438 | ssl_certificate_key /home/john/ssl/localhost.key; | ||
| 439 | |||
| 440 | location /shaarli/ { | ||
| 441 | # Slim - rewrite URLs | ||
| 442 | try_files $uri /index.php$is_args$args; | ||
| 443 | |||
| 444 | access_log /var/log/nginx/shaarli.access.log; | ||
| 445 | error_log /var/log/nginx/shaarli.error.log; | ||
| 446 | } | ||
| 447 | |||
| 448 | location = /shaarli/favicon.ico { | ||
| 449 | # serve the Shaarli favicon from its custom location | ||
| 450 | alias /var/www/shaarli/images/favicon.ico; | ||
| 451 | } | ||
| 452 | |||
| 453 | include deny.conf; | ||
| 454 | include static_assets.conf; | ||
| 455 | include php.conf; | ||
| 456 | } | ||
| 457 | }</code></pre> | ||
| 458 | </body> | ||
| 459 | </html> | ||
diff --git a/doc/Server-requirements.html b/doc/Server-requirements.html deleted file mode 100644 index 79d74118..00000000 --- a/doc/Server-requirements.html +++ /dev/null | |||
| @@ -1,195 +0,0 @@ | |||
| 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 – Server requirements</title> | ||
| 8 | <style type="text/css">code{white-space: pre;}</style> | ||
| 9 | <link rel="stylesheet" href="github-markdown.css"> | ||
| 10 | <!--[if lt IE 9]> | ||
| 11 | <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script> | ||
| 12 | <![endif]--> | ||
| 13 | </head> | ||
| 14 | <body> | ||
| 15 | <div id="local-sidebar"> | ||
| 16 | <ul> | ||
| 17 | <li><a href="Home.html">Home</a></li> | ||
| 18 | <li>Setup | ||
| 19 | <ul> | ||
| 20 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 21 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 22 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 23 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 24 | <li><a href="Server-security.html">Server security</a></li> | ||
| 25 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> | ||
| 26 | <li><a href="Plugins.html">Plugins</a></li> | ||
| 27 | </ul></li> | ||
| 28 | <li><a href="Docker.html">Docker</a></li> | ||
| 29 | <li><a href="Usage.html">Usage</a> | ||
| 30 | <ul> | ||
| 31 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> | ||
| 32 | <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li> | ||
| 33 | <li><a href="Firefox-share.html">Firefox share</a></li> | ||
| 34 | <li><a href="RSS-feeds.html">RSS feeds</a></li> | ||
| 35 | <li><a href="REST-API.html">REST API</a></li> | ||
| 36 | </ul></li> | ||
| 37 | <li>How To | ||
| 38 | <ul> | ||
| 39 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | ||
| 40 | <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> | ||
| 41 | <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li> | ||
| 42 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> | ||
| 43 | <li><a href="Datastore-hacks.html">Datastore hacks</a></li> | ||
| 44 | </ul></li> | ||
| 45 | <li><a href="Troubleshooting.html">Troubleshooting</a></li> | ||
| 46 | <li><a href="Development.html">Development</a> | ||
| 47 | <ul> | ||
| 48 | <li><a href="GnuPG-signature.html">GnuPG signature</a></li> | ||
| 49 | <li><a href="Coding-guidelines.html">Coding guidelines</a></li> | ||
| 50 | <li><a href="Directory-structure.html">Directory structure</a></li> | ||
| 51 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> | ||
| 52 | <li><a href="Plugin-System.html">Plugin System</a></li> | ||
| 53 | <li><a href="Release-Shaarli.html">Release Shaarli</a></li> | ||
| 54 | <li><a href="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 55 | <li><a href="Security.html">Security</a></li> | ||
| 56 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 57 | <li><a href="Theming.html">Theming</a></li> | ||
| 58 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 59 | </ul></li> | ||
| 60 | <li>About | ||
| 61 | <ul> | ||
| 62 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 63 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 64 | </ul></li> | ||
| 65 | </ul> | ||
| 66 | </div> | ||
| 67 | <h1 id="server-requirements">Server requirements</h1> | ||
| 68 | <h2 id="php">PHP</h2> | ||
| 69 | <h3 id="release-information">Release information</h3> | ||
| 70 | <ul> | ||
| 71 | <li><a href="http://php.net/supported-versions.php">PHP: Supported versions</a><a href=".html"></a></li> | ||
| 72 | <li><a href="http://php.net/eol.php">PHP: Unsupported versions</a> <em>(EOL - End Of Life)</em><a href=".html"></a></li> | ||
| 73 | <li><a href="http://php.net/ChangeLog-7.php">PHP 7 Changelog</a><a href=".html"></a></li> | ||
| 74 | <li><a href="http://php.net/ChangeLog-5.php">PHP 5 Changelog</a><a href=".html"></a></li> | ||
| 75 | <li><a href="https://bugs.php.net/">PHP: Bugs</a><a href=".html"></a></li> | ||
| 76 | </ul> | ||
| 77 | <h3 id="supported-versions">Supported versions</h3> | ||
| 78 | <table> | ||
| 79 | <thead> | ||
| 80 | <tr class="header"> | ||
| 81 | <th style="text-align: center;">Version</th> | ||
| 82 | <th style="text-align: center;">Status</th> | ||
| 83 | <th style="text-align: center;">Shaarli compatibility</th> | ||
| 84 | </tr> | ||
| 85 | </thead> | ||
| 86 | <tbody> | ||
| 87 | <tr class="odd"> | ||
| 88 | <td style="text-align: center;">7.1</td> | ||
| 89 | <td style="text-align: center;">Supported (v0.9.x)</td> | ||
| 90 | <td style="text-align: center;">✅</td> | ||
| 91 | </tr> | ||
| 92 | <tr class="even"> | ||
| 93 | <td style="text-align: center;">7.0</td> | ||
| 94 | <td style="text-align: center;">Supported</td> | ||
| 95 | <td style="text-align: center;">✅</td> | ||
| 96 | </tr> | ||
| 97 | <tr class="odd"> | ||
| 98 | <td style="text-align: center;">5.6</td> | ||
| 99 | <td style="text-align: center;">Supported</td> | ||
| 100 | <td style="text-align: center;">✅</td> | ||
| 101 | </tr> | ||
| 102 | <tr class="even"> | ||
| 103 | <td style="text-align: center;">5.5</td> | ||
| 104 | <td style="text-align: center;">EOL: 2016-07-10</td> | ||
| 105 | <td style="text-align: center;">✅</td> | ||
| 106 | </tr> | ||
| 107 | <tr class="odd"> | ||
| 108 | <td style="text-align: center;">5.4</td> | ||
| 109 | <td style="text-align: center;">EOL: 2015-09-14</td> | ||
| 110 | <td style="text-align: center;">✅ (up to Shaarli 0.8.x)</td> | ||
| 111 | </tr> | ||
| 112 | <tr class="even"> | ||
| 113 | <td style="text-align: center;">5.3</td> | ||
| 114 | <td style="text-align: center;">EOL: 2014-08-14</td> | ||
| 115 | <td style="text-align: center;">✅ (up to Shaarli 0.8.x)</td> | ||
| 116 | </tr> | ||
| 117 | </tbody> | ||
| 118 | </table> | ||
| 119 | <p>See also:</p> | ||
| 120 | <ul> | ||
| 121 | <li><a href="https://github.com/shaarli/Shaarli/blob/master/.travis.yml">Travis configuration</a><a href=".html"></a></li> | ||
| 122 | </ul> | ||
| 123 | <h3 id="dependency-management">Dependency management</h3> | ||
| 124 | <p>Starting with Shaarli <code>v0.8.x</code>, <a href="https://getcomposer.org/">Composer</a> is used to resolve,<a href=".html"></a><br /> | ||
| 125 | download and install third-party PHP dependencies.</p> | ||
| 126 | <table> | ||
| 127 | <thead> | ||
| 128 | <tr class="header"> | ||
| 129 | <th>Library</th> | ||
| 130 | <th style="text-align: center;">Required?</th> | ||
| 131 | <th>Usage</th> | ||
| 132 | </tr> | ||
| 133 | </thead> | ||
| 134 | <tbody> | ||
| 135 | <tr class="odd"> | ||
| 136 | <td><a href="https://packagist.org/packages/shaarli/netscape-bookmark-parser"><code>shaarli/netscape-bookmark-parser</code></a></td> | ||
| 137 | <td style="text-align: center;">All</td> | ||
| 138 | <td>Import bookmarks from Netscape files<a href=".html"></a></td> | ||
| 139 | </tr> | ||
| 140 | <tr class="even"> | ||
| 141 | <td><a href="https://packagist.org/packages/erusev/parsedown"><code>erusev/parsedown</code></a></td> | ||
| 142 | <td style="text-align: center;">All</td> | ||
| 143 | <td>Parse MarkDown syntax for the MarkDown plugin<a href=".html"></a></td> | ||
| 144 | </tr> | ||
| 145 | <tr class="odd"> | ||
| 146 | <td><a href="https://packagist.org/packages/slim/slim"><code>slim/slim</code></a></td> | ||
| 147 | <td style="text-align: center;">All</td> | ||
| 148 | <td>Handle routes and middleware for the REST API<a href=".html"></a></td> | ||
| 149 | </tr> | ||
| 150 | </tbody> | ||
| 151 | </table> | ||
| 152 | <h3 id="extensions">Extensions</h3> | ||
| 153 | <table style="width:19%;"> | ||
| 154 | <colgroup> | ||
| 155 | <col style="width: 5%" /> | ||
| 156 | <col style="width: 8%" /> | ||
| 157 | <col style="width: 5%" /> | ||
| 158 | </colgroup> | ||
| 159 | <thead> | ||
| 160 | <tr class="header"> | ||
| 161 | <th>Extension</th> | ||
| 162 | <th style="text-align: center;">Required?</th> | ||
| 163 | <th>Usage</th> | ||
| 164 | </tr> | ||
| 165 | </thead> | ||
| 166 | <tbody> | ||
| 167 | <tr class="odd"> | ||
| 168 | <td><a href="http://php.net/manual/en/book.openssl.php"><code>openssl</code></a></td> | ||
| 169 | <td style="text-align: center;">All</td> | ||
| 170 | <td>OpenSSL, HTTPS<a href=".html"></a></td> | ||
| 171 | </tr> | ||
| 172 | <tr class="even"> | ||
| 173 | <td><a href="http://php.net/manual/en/book.mbstring.php"><code>php-mbstring</code></a></td> | ||
| 174 | <td style="text-align: center;">CentOS, Fedora, RHEL, Windows</td> | ||
| 175 | <td>multibyte (Unicode) string support<a href=".html"></a></td> | ||
| 176 | </tr> | ||
| 177 | <tr class="odd"> | ||
| 178 | <td><a href="http://php.net/manual/en/book.image.php"><code>php-gd</code></a></td> | ||
| 179 | <td style="text-align: center;">optional</td> | ||
| 180 | <td>thumbnail resizing<a href=".html"></a></td> | ||
| 181 | </tr> | ||
| 182 | <tr class="even"> | ||
| 183 | <td><a href="http://php.net/manual/en/book.intl.php"><code>php-intl</code></a></td> | ||
| 184 | <td style="text-align: center;">optional</td> | ||
| 185 | <td>localized text sorting (e.g. <code>e->è->f</code>)<a href=".html"></a></td> | ||
| 186 | </tr> | ||
| 187 | <tr class="odd"> | ||
| 188 | <td><a href="http://php.net/manual/en/book.curl.php"><code>php-curl</code></a></td> | ||
| 189 | <td style="text-align: center;">optional</td> | ||
| 190 | <td>using cURL for fetching webpages and thumbnails in a more robust way<a href=".html"></a></td> | ||
| 191 | </tr> | ||
| 192 | </tbody> | ||
| 193 | </table> | ||
| 194 | </body> | ||
| 195 | </html> | ||
diff --git a/doc/Server-security.html b/doc/Server-security.html deleted file mode 100644 index 4f7ff468..00000000 --- a/doc/Server-security.html +++ /dev/null | |||
| @@ -1,175 +0,0 @@ | |||
| 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 – Server security</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>Setup | ||
| 56 | <ul> | ||
| 57 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 58 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 59 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 60 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 61 | <li><a href="Server-security.html">Server security</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 | <li><a href="REST-API.html">REST API</a></li> | ||
| 73 | </ul></li> | ||
| 74 | <li>How To | ||
| 75 | <ul> | ||
| 76 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</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="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 92 | <li><a href="Security.html">Security</a></li> | ||
| 93 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 94 | <li><a href="Theming.html">Theming</a></li> | ||
| 95 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 96 | </ul></li> | ||
| 97 | <li>About | ||
| 98 | <ul> | ||
| 99 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 100 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 101 | </ul></li> | ||
| 102 | </ul> | ||
| 103 | </div> | ||
| 104 | <h1 id="server-security">Server security</h1> | ||
| 105 | <h2 id="php.ini">php.ini</h2> | ||
| 106 | <p>PHP settings are defined in:</p> | ||
| 107 | <ul> | ||
| 108 | <li>a main configuration file, usually found under <code>/etc/php5/php.ini</code>; some distributions provide different configuration environments, e.g. | ||
| 109 | <ul> | ||
| 110 | <li><code>/etc/php5/php.ini</code> - used when running console scripts</li> | ||
| 111 | <li><code>/etc/php5/apache2/php.ini</code> - used when a client requests PHP resources from Apache</li> | ||
| 112 | <li><code>/etc/php5/php-fpm.conf</code> - used when PHP requests are proxied to PHP-FPM</li> | ||
| 113 | </ul></li> | ||
| 114 | <li>additional configuration files/entries, depending on the installed/enabled extensions: | ||
| 115 | <ul> | ||
| 116 | <li><code>/etc/php/conf.d/xdebug.ini</code></li> | ||
| 117 | </ul></li> | ||
| 118 | </ul> | ||
| 119 | <h3 id="locate-.ini-files">Locate .ini files</h3> | ||
| 120 | <h4 id="console-environment">Console environment</h4> | ||
| 121 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="ex">php</span> --ini | ||
| 122 | <span class="ex">Configuration</span> File (php.ini) <span class="ex">Path</span>: /etc/php | ||
| 123 | <span class="ex">Loaded</span> Configuration File: /etc/php/php.ini | ||
| 124 | <span class="ex">Scan</span> for additional .ini files in: /etc/php/conf.d | ||
| 125 | <span class="ex">Additional</span> .ini files parsed: /etc/php/conf.d/xdebug.ini</code></pre></div> | ||
| 126 | <h4 id="server-environment">Server environment</h4> | ||
| 127 | <ul> | ||
| 128 | <li>create a <code>phpinfo.php</code> script located in a path supported by the web server, e.g. | ||
| 129 | <ul> | ||
| 130 | <li>Apache (with user dirs enabled): <code>/home/myself/public_html/phpinfo.php</code></li> | ||
| 131 | <li><code>/var/www/test/phpinfo.php</code></li> | ||
| 132 | </ul></li> | ||
| 133 | <li>make sure the script is readable by the web server user/group (usually, <code>www</code>, <code>www-data</code> or <code>httpd</code>)</li> | ||
| 134 | <li>access the script from a web browser</li> | ||
| 135 | <li><p>look at the <em>Loaded Configuration File</em> and <em>Scan this dir for additional .ini files</em> entries</p> | ||
| 136 | <div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php"><span class="kw"><?php</span> <span class="fu">phpinfo</span><span class="ot">();</span> <span class="kw">?></span></code></pre></div></li> | ||
| 137 | </ul> | ||
| 138 | <h2 id="fail2ban">fail2ban</h2> | ||
| 139 | <p><code>fail2ban</code> is an intrusion prevention framework that reads server (Apache, SSH, etc.) and uses <code>iptables</code> profiles to block brute-force attempts:</p> | ||
| 140 | <ul> | ||
| 141 | <li><a href="http://www.fail2ban.org/wiki/index.php/Main_Page">Official website</a><a href=".html"></a></li> | ||
| 142 | <li><a href="https://github.com/fail2ban/fail2ban">Source code</a><a href=".html"></a></li> | ||
| 143 | </ul> | ||
| 144 | <h3 id="read-shaarli-logs-to-ban-ips">Read Shaarli logs to ban IPs</h3> | ||
| 145 | <p>Example configuration:</p> | ||
| 146 | <ul> | ||
| 147 | <li>allow 3 login attempts per IP address</li> | ||
| 148 | <li>after 3 failures, permanently ban the corresponding IP adddress</li> | ||
| 149 | </ul> | ||
| 150 | <p><code>/etc/fail2ban/jail.local</code></p> | ||
| 151 | <div class="sourceCode"><pre class="sourceCode ini"><code class="sourceCode ini"><span class="kw">[shaarli-auth][]</span><span class="dt">(.html)</span> | ||
| 152 | <span class="dt">enabled </span><span class="ot">=</span><span class="st"> </span><span class="kw">true</span> | ||
| 153 | <span class="dt">port </span><span class="ot">=</span><span class="st"> https,http</span> | ||
| 154 | <span class="dt">filter </span><span class="ot">=</span><span class="st"> shaarli-auth</span> | ||
| 155 | <span class="dt">logpath </span><span class="ot">=</span><span class="st"> /var/www/path/to/shaarli/data/log.txt</span> | ||
| 156 | <span class="dt">maxretry </span><span class="ot">=</span><span class="st"> </span><span class="dv">3</span> | ||
| 157 | <span class="dt">bantime </span><span class="ot">=</span><span class="st"> -</span><span class="dv">1</span></code></pre></div> | ||
| 158 | <p><code>/etc/fail2ban/filter.d/shaarli-auth.conf</code></p> | ||
| 159 | <div class="sourceCode"><pre class="sourceCode ini"><code class="sourceCode ini"><span class="kw">[INCLUDES][]</span><span class="dt">(.html)</span> | ||
| 160 | <span class="dt">before </span><span class="ot">=</span><span class="st"> common.conf</span> | ||
| 161 | <span class="kw">[Definition][]</span><span class="dt">(.html)</span> | ||
| 162 | <span class="dt">failregex </span><span class="ot">=</span><span class="st"> \s-\s<HOST>\s-\sLogin failed for user.*$</span> | ||
| 163 | <span class="dt">ignoreregex </span><span class="ot">=</span><span class="st"> </span></code></pre></div> | ||
| 164 | <h2 id="robots---restricting-search-engines-and-web-crawler-traffic">Robots - Restricting search engines and web crawler traffic</h2> | ||
| 165 | <p>Creating a <code>robots.txt</code> with the following contents at the root of your Shaarli installation will prevent <em>honest</em> web crawlers from indexing each and every link and Daily page from a Shaarli instance, thus getting rid of a certain amount of unsollicited network traffic.</p> | ||
| 166 | <pre><code>User-agent: * | ||
| 167 | Disallow: /</code></pre> | ||
| 168 | <p>See:</p> | ||
| 169 | <ul> | ||
| 170 | <li><a href="http://www.robotstxt.org/" class="uri">http://www.robotstxt.org/</a></li> | ||
| 171 | <li><a href="http://www.robotstxt.org/robotstxt.html" class="uri">http://www.robotstxt.org/robotstxt.html</a></li> | ||
| 172 | <li><a href="http://www.robotstxt.org/meta.html" class="uri">http://www.robotstxt.org/meta.html</a></li> | ||
| 173 | </ul> | ||
| 174 | </body> | ||
| 175 | </html> | ||
diff --git a/doc/Shaarli-configuration.html b/doc/Shaarli-configuration.html deleted file mode 100644 index c696c97c..00000000 --- a/doc/Shaarli-configuration.html +++ /dev/null | |||
| @@ -1,298 +0,0 @@ | |||
| 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 – Shaarli configuration</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>Setup | ||
| 56 | <ul> | ||
| 57 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 58 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 59 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 60 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 61 | <li><a href="Server-security.html">Server security</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 | <li><a href="REST-API.html">REST API</a></li> | ||
| 73 | </ul></li> | ||
| 74 | <li>How To | ||
| 75 | <ul> | ||
| 76 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</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="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 92 | <li><a href="Security.html">Security</a></li> | ||
| 93 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 94 | <li><a href="Theming.html">Theming</a></li> | ||
| 95 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 96 | </ul></li> | ||
| 97 | <li>About | ||
| 98 | <ul> | ||
| 99 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 100 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 101 | </ul></li> | ||
| 102 | </ul> | ||
| 103 | </div> | ||
| 104 | <h1 id="shaarli-configuration">Shaarli configuration</h1> | ||
| 105 | <h1 id="shaarli-configuration-1">Shaarli configuration</h1> | ||
| 106 | <h2 id="foreword">Foreword</h2> | ||
| 107 | <p><strong>Do not edit configuration options in index.php! Your changes would be lost.</strong></p> | ||
| 108 | <p>Once your Shaarli instance is installed, the file <code>data/config.json.php</code> is generated:</p> | ||
| 109 | <ul> | ||
| 110 | <li>it contains all settings in JSON format, and can be edited to customize values</li> | ||
| 111 | <li>it defines which <a href="Plugin-System">plugins</a> are enabled<a href="(.html).html">(.html)</a></li> | ||
| 112 | <li>its values override those defined in <code>index.php</code></li> | ||
| 113 | <li>it is wrap in a PHP comment to prevent anyone accessing it, regardless of server configuration</li> | ||
| 114 | </ul> | ||
| 115 | <h2 id="file-and-directory-permissions">File and directory permissions</h2> | ||
| 116 | <p>The server process running Shaarli must have:</p> | ||
| 117 | <ul> | ||
| 118 | <li><code>read</code> access to the following resources: | ||
| 119 | <ul> | ||
| 120 | <li>PHP scripts: <code>index.php</code>, <code>application/*.php</code>, <code>plugins/*.php</code></li> | ||
| 121 | <li>3rd party PHP and Javascript libraries: <code>inc/*.php</code>, <code>inc/*.js</code></li> | ||
| 122 | <li>static assets: | ||
| 123 | <ul> | ||
| 124 | <li>CSS stylesheets: <code>inc/*.css</code></li> | ||
| 125 | <li><code>images/*</code></li> | ||
| 126 | </ul></li> | ||
| 127 | <li>RainTPL templates: <code>tpl/*.html</code></li> | ||
| 128 | </ul></li> | ||
| 129 | <li><code>read</code>, <code>write</code> and <code>execution</code> access to the following directories: | ||
| 130 | <ul> | ||
| 131 | <li><code>cache</code> - thumbnail cache</li> | ||
| 132 | <li><code>data</code> - link data store, configuration options</li> | ||
| 133 | <li><code>pagecache</code> - Atom/RSS feed cache</li> | ||
| 134 | <li><code>tmp</code> - RainTPL page cache</li> | ||
| 135 | </ul></li> | ||
| 136 | </ul> | ||
| 137 | <p>On a Linux distribution:</p> | ||
| 138 | <ul> | ||
| 139 | <li>the web server user will likely be <code>www</code> or <code>http</code> (for Apache2)</li> | ||
| 140 | <li>it will be a member of a group of the same name: <code>www:www</code>, <code>http:http</code></li> | ||
| 141 | <li>to give it access to Shaarli, either: | ||
| 142 | <ul> | ||
| 143 | <li>unzip Shaarli in the default web server location (usually <code>/var/www/</code>) and set the web server user as the owner</li> | ||
| 144 | <li>put users in the same group as the web server, and set the appropriate access rights</li> | ||
| 145 | </ul></li> | ||
| 146 | <li>if you have a domain / subdomain to serve Shaarli, <a href="Server-configuration">configure the server</a> accordingly<a href="(.html).html">(.html)</a></li> | ||
| 147 | </ul> | ||
| 148 | <h2 id="configuration">Configuration</h2> | ||
| 149 | <p>In <code>data/config.json.php</code>.</p> | ||
| 150 | <p>See also <a href="Plugin-System.html">Plugin System</a>.<a href=".html"></a></p> | ||
| 151 | <h3 id="credentials">Credentials</h3> | ||
| 152 | <blockquote> | ||
| 153 | <p>You shouldn't edit those.</p> | ||
| 154 | </blockquote> | ||
| 155 | <p><strong>login</strong>: Login username.<br /> | ||
| 156 | <strong>hash</strong>: Generated password hash.<br /> | ||
| 157 | <strong>salt</strong>: Password salt.</p> | ||
| 158 | <h3 id="general">General</h3> | ||
| 159 | <p><strong>title</strong>: Shaarli's instance title.<br /> | ||
| 160 | <strong>header_link</strong>: Link to the homepage.<br /> | ||
| 161 | <strong>links_per_page</strong>: Number of shaares displayed per page.<br /> | ||
| 162 | <strong>timezone</strong>: See <a href="http://php.net/manual/en/timezones.php">the list of supported timezones</a>. <a href=".html"></a><br /> | ||
| 163 | <strong>enabled_plugins</strong>: List of enabled plugins.</p> | ||
| 164 | <h3 id="security">Security</h3> | ||
| 165 | <p><strong>session_protection_disabled</strong>: Disable session cookie hijacking protection (not recommended).<br /> | ||
| 166 | It might be useful if your IP adress often changes.<br /> | ||
| 167 | <strong>ban_after</strong>: Failed login attempts before being IP banned.<br /> | ||
| 168 | <strong>ban_duration</strong>: IP ban duration in seconds.<br /> | ||
| 169 | <strong>open_shaarli</strong>: Anyone can add a new link while logged out if enabled.<br /> | ||
| 170 | <strong>trusted_proxies</strong>: List of trusted IP which won't be banned after failed login attemps. Useful if Shaarli is behind a reverse proxy.</p> | ||
| 171 | <h3 id="resources">Resources</h3> | ||
| 172 | <p><strong>data_dir</strong>: Data directory.<br /> | ||
| 173 | <strong>datastore</strong>: Shaarli's links database file path.<br /> | ||
| 174 | <strong>history</strong>: Shaarli's operation history file path.<br /> | ||
| 175 | <strong>updates</strong>: File path for the ran updates file.<br /> | ||
| 176 | <strong>log</strong>: Log file path.<br /> | ||
| 177 | <strong>update_check</strong>: Last update check file path.<br /> | ||
| 178 | <strong>raintpl_tpl</strong>: Templates directory.<br /> | ||
| 179 | <strong>raintpl_tmp</strong>: Template engine cache directory.<br /> | ||
| 180 | <strong>thumbnails_cache</strong>: Thumbnails cache directory.<br /> | ||
| 181 | <strong>page_cache</strong>: Shaarli's internal cache directory.<br /> | ||
| 182 | <strong>ban_file</strong>: Banned IP file path.</p> | ||
| 183 | <h3 id="updates">Updates</h3> | ||
| 184 | <p><strong>check_updates</strong>: Enable or disable update check to the git repository.<br /> | ||
| 185 | <strong>check_updates_branch</strong>: Git branch used to check updates (e.g. <code>stable</code> or <code>master</code>).<br /> | ||
| 186 | <strong>check_updates_interval</strong>: Look for new version every N seconds (default: every day).</p> | ||
| 187 | <h3 id="privacy">Privacy</h3> | ||
| 188 | <p><strong>default_private_links</strong>: Check the private checkbox by default for every new link.<br /> | ||
| 189 | <strong>hide_public_links</strong>: All links are hidden while logged out.<br /> | ||
| 190 | <strong>hide_timestamps</strong>: Timestamps are hidden.</p> | ||
| 191 | <h3 id="feed">Feed</h3> | ||
| 192 | <p><strong>rss_permalinks</strong>: Enable this to redirect RSS links to Shaarli's permalinks instead of shaared URL.<br /> | ||
| 193 | <strong>show_atom</strong>: Display ATOM feed button.</p> | ||
| 194 | <h3 id="thumbnail">Thumbnail</h3> | ||
| 195 | <p><strong>enable_thumbnails</strong>: Enable or disable thumbnail display.<br /> | ||
| 196 | <strong>enable_localcache</strong>: Enable or disable local cache.</p> | ||
| 197 | <h3 id="redirector">Redirector</h3> | ||
| 198 | <p><strong>url</strong>: Redirector URL, such as <code>anonym.to</code>.<br /> | ||
| 199 | <strong>encode_url</strong>: Enable this if the redirector needs encoded URL to work properly.</p> | ||
| 200 | <h2 id="configuration-file-example">Configuration file example</h2> | ||
| 201 | <div class="sourceCode"><pre class="sourceCode json"><code class="sourceCode json"><span class="er"><?php</span> <span class="er">/*</span> | ||
| 202 | <span class="fu">{</span> | ||
| 203 | <span class="dt">"credentials"</span><span class="fu">:</span> <span class="fu">{</span> | ||
| 204 | <span class="dt">"login"</span><span class="fu">:</span> <span class="st">"<login>"</span><span class="fu">,</span> | ||
| 205 | <span class="dt">"hash"</span><span class="fu">:</span> <span class="st">"<password hash>"</span><span class="fu">,</span> | ||
| 206 | <span class="dt">"salt"</span><span class="fu">:</span> <span class="st">"<password salt>"</span> | ||
| 207 | <span class="fu">},</span> | ||
| 208 | <span class="dt">"security"</span><span class="fu">:</span> <span class="fu">{</span> | ||
| 209 | <span class="dt">"ban_after"</span><span class="fu">:</span> <span class="dv">4</span><span class="fu">,</span> | ||
| 210 | <span class="dt">"session_protection_disabled"</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span> | ||
| 211 | <span class="dt">"ban_duration"</span><span class="fu">:</span> <span class="dv">1800</span><span class="fu">,</span> | ||
| 212 | <span class="dt">"trusted_proxies"</span><span class="fu">:</span> <span class="ot">[[]</span><span class="er">(.html)</span> | ||
| 213 | <span class="st">"1.2.3.4"</span><span class="ot">,</span> | ||
| 214 | <span class="st">"5.6.7.8"</span> | ||
| 215 | <span class="ot">]</span> | ||
| 216 | <span class="fu">},</span> | ||
| 217 | <span class="dt">"resources"</span><span class="fu">:</span> <span class="fu">{</span> | ||
| 218 | <span class="dt">"data_dir"</span><span class="fu">:</span> <span class="st">"data"</span><span class="fu">,</span> | ||
| 219 | <span class="dt">"config"</span><span class="fu">:</span> <span class="st">"data</span><span class="ch">\/</span><span class="st">config.php"</span><span class="fu">,</span> | ||
| 220 | <span class="dt">"datastore"</span><span class="fu">:</span> <span class="st">"data</span><span class="ch">\/</span><span class="st">datastore.php"</span><span class="fu">,</span> | ||
| 221 | <span class="dt">"ban_file"</span><span class="fu">:</span> <span class="st">"data</span><span class="ch">\/</span><span class="st">ipbans.php"</span><span class="fu">,</span> | ||
| 222 | <span class="dt">"updates"</span><span class="fu">:</span> <span class="st">"data</span><span class="ch">\/</span><span class="st">updates.txt"</span><span class="fu">,</span> | ||
| 223 | <span class="dt">"log"</span><span class="fu">:</span> <span class="st">"data</span><span class="ch">\/</span><span class="st">log.txt"</span><span class="fu">,</span> | ||
| 224 | <span class="dt">"update_check"</span><span class="fu">:</span> <span class="st">"data</span><span class="ch">\/</span><span class="st">lastupdatecheck.txt"</span><span class="fu">,</span> | ||
| 225 | <span class="dt">"raintpl_tmp"</span><span class="fu">:</span> <span class="st">"tmp</span><span class="ch">\/</span><span class="st">"</span><span class="fu">,</span> | ||
| 226 | <span class="dt">"raintpl_tpl"</span><span class="fu">:</span> <span class="st">"tpl</span><span class="ch">\/</span><span class="st">"</span><span class="fu">,</span> | ||
| 227 | <span class="dt">"thumbnails_cache"</span><span class="fu">:</span> <span class="st">"cache"</span><span class="fu">,</span> | ||
| 228 | <span class="dt">"page_cache"</span><span class="fu">:</span> <span class="st">"pagecache"</span> | ||
| 229 | <span class="fu">},</span> | ||
| 230 | <span class="dt">"general"</span><span class="fu">:</span> <span class="fu">{</span> | ||
| 231 | <span class="dt">"check_updates"</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span> | ||
| 232 | <span class="dt">"rss_permalinks"</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span> | ||
| 233 | <span class="dt">"links_per_page"</span><span class="fu">:</span> <span class="dv">20</span><span class="fu">,</span> | ||
| 234 | <span class="dt">"default_private_links"</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span> | ||
| 235 | <span class="dt">"enable_thumbnails"</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span> | ||
| 236 | <span class="dt">"enable_localcache"</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span> | ||
| 237 | <span class="dt">"check_updates_branch"</span><span class="fu">:</span> <span class="st">"stable"</span><span class="fu">,</span> | ||
| 238 | <span class="dt">"check_updates_interval"</span><span class="fu">:</span> <span class="dv">86400</span><span class="fu">,</span> | ||
| 239 | <span class="dt">"enabled_plugins"</span><span class="fu">:</span> <span class="ot">[[]</span><span class="er">(.html)</span> | ||
| 240 | <span class="st">"markdown"</span><span class="ot">,</span> | ||
| 241 | <span class="st">"wallabag"</span><span class="ot">,</span> | ||
| 242 | <span class="st">"archiveorg"</span> | ||
| 243 | <span class="ot">]</span><span class="fu">,</span> | ||
| 244 | <span class="dt">"timezone"</span><span class="fu">:</span> <span class="st">"Europe</span><span class="ch">\/</span><span class="st">Paris"</span><span class="fu">,</span> | ||
| 245 | <span class="dt">"title"</span><span class="fu">:</span> <span class="st">"My Shaarli"</span><span class="fu">,</span> | ||
| 246 | <span class="dt">"header_link"</span><span class="fu">:</span> <span class="st">"?"</span> | ||
| 247 | <span class="fu">},</span> | ||
| 248 | <span class="dt">"extras"</span><span class="fu">:</span> <span class="fu">{</span> | ||
| 249 | <span class="dt">"show_atom"</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span> | ||
| 250 | <span class="dt">"hide_public_links"</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span> | ||
| 251 | <span class="dt">"hide_timestamps"</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span> | ||
| 252 | <span class="dt">"open_shaarli"</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span> | ||
| 253 | <span class="dt">"redirector"</span><span class="fu">:</span> <span class="st">"http://anonym.to/?"</span><span class="fu">,</span> | ||
| 254 | <span class="dt">"redirector_encode_url"</span><span class="fu">:</span> <span class="kw">false</span> | ||
| 255 | <span class="fu">},</span> | ||
| 256 | <span class="dt">"general"</span><span class="fu">:</span> <span class="fu">{</span> | ||
| 257 | <span class="dt">"header_link"</span><span class="fu">:</span> <span class="st">"?"</span><span class="fu">,</span> | ||
| 258 | <span class="dt">"links_per_page"</span><span class="fu">:</span> <span class="dv">20</span><span class="fu">,</span> | ||
| 259 | <span class="dt">"enabled_plugins"</span><span class="fu">:</span> <span class="ot">[[]</span><span class="er">(.html)</span> | ||
| 260 | <span class="st">"markdown"</span><span class="ot">,</span> | ||
| 261 | <span class="st">"wallabag"</span> | ||
| 262 | <span class="ot">]</span><span class="fu">,</span> | ||
| 263 | <span class="dt">"timezone"</span><span class="fu">:</span> <span class="st">"Europe</span><span class="ch">\/</span><span class="st">Paris"</span><span class="fu">,</span> | ||
| 264 | <span class="dt">"title"</span><span class="fu">:</span> <span class="st">"My Shaarli"</span> | ||
| 265 | <span class="fu">},</span> | ||
| 266 | <span class="dt">"updates"</span><span class="fu">:</span> <span class="fu">{</span> | ||
| 267 | <span class="dt">"check_updates"</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span> | ||
| 268 | <span class="dt">"check_updates_branch"</span><span class="fu">:</span> <span class="st">"stable"</span><span class="fu">,</span> | ||
| 269 | <span class="dt">"check_updates_interval"</span><span class="fu">:</span> <span class="dv">86400</span> | ||
| 270 | <span class="fu">},</span> | ||
| 271 | <span class="dt">"feed"</span><span class="fu">:</span> <span class="fu">{</span> | ||
| 272 | <span class="dt">"rss_permalinks"</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span> | ||
| 273 | <span class="dt">"show_atom"</span><span class="fu">:</span> <span class="kw">false</span> | ||
| 274 | <span class="fu">},</span> | ||
| 275 | <span class="dt">"privacy"</span><span class="fu">:</span> <span class="fu">{</span> | ||
| 276 | <span class="dt">"default_private_links"</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span> | ||
| 277 | <span class="dt">"hide_public_links"</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span> | ||
| 278 | <span class="dt">"hide_timestamps"</span><span class="fu">:</span> <span class="kw">false</span> | ||
| 279 | <span class="fu">},</span> | ||
| 280 | <span class="dt">"thumbnail"</span><span class="fu">:</span> <span class="fu">{</span> | ||
| 281 | <span class="dt">"enable_thumbnails"</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span> | ||
| 282 | <span class="dt">"enable_localcache"</span><span class="fu">:</span> <span class="kw">true</span> | ||
| 283 | <span class="fu">},</span> | ||
| 284 | <span class="dt">"redirector"</span><span class="fu">:</span> <span class="fu">{</span> | ||
| 285 | <span class="dt">"url"</span><span class="fu">:</span> <span class="st">"http://anonym.to/?"</span><span class="fu">,</span> | ||
| 286 | <span class="dt">"encode_url"</span><span class="fu">:</span> <span class="kw">false</span> | ||
| 287 | <span class="fu">},</span> | ||
| 288 | <span class="dt">"plugins"</span><span class="fu">:</span> <span class="fu">{</span> | ||
| 289 | <span class="dt">"WALLABAG_URL"</span><span class="fu">:</span> <span class="st">"http://demo.wallabag.org"</span><span class="fu">,</span> | ||
| 290 | <span class="dt">"WALLABAG_VERSION"</span><span class="fu">:</span> <span class="st">"1"</span> | ||
| 291 | <span class="fu">}</span> | ||
| 292 | <span class="fu">}</span> <span class="er">?></span></code></pre></div> | ||
| 293 | <h2 id="additional-configuration">Additional configuration</h2> | ||
| 294 | <p>The playvideos plugin may require that you adapt your server's<br /> | ||
| 295 | <a href="https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md#troubleshooting">Content Security Policy</a> <a href=".html"></a><br /> | ||
| 296 | configuration to work properly.<a href="(.html).html">(.html)</a></p> | ||
| 297 | </body> | ||
| 298 | </html> | ||
diff --git a/doc/Sharing-button.html b/doc/Sharing-button.html deleted file mode 100644 index f3682f8c..00000000 --- a/doc/Sharing-button.html +++ /dev/null | |||
| @@ -1,94 +0,0 @@ | |||
| 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 – Sharing button</title> | ||
| 8 | <style type="text/css">code{white-space: pre;}</style> | ||
| 9 | <link rel="stylesheet" href="github-markdown.css"> | ||
| 10 | <!--[if lt IE 9]> | ||
| 11 | <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script> | ||
| 12 | <![endif]--> | ||
| 13 | </head> | ||
| 14 | <body> | ||
| 15 | <div id="local-sidebar"> | ||
| 16 | <ul> | ||
| 17 | <li><a href="Home.html">Home</a></li> | ||
| 18 | <li>Setup | ||
| 19 | <ul> | ||
| 20 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 21 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 22 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 23 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 24 | <li><a href="Server-security.html">Server security</a></li> | ||
| 25 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> | ||
| 26 | <li><a href="Plugins.html">Plugins</a></li> | ||
| 27 | </ul></li> | ||
| 28 | <li><a href="Docker.html">Docker</a></li> | ||
| 29 | <li><a href="Usage.html">Usage</a> | ||
| 30 | <ul> | ||
| 31 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> | ||
| 32 | <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li> | ||
| 33 | <li><a href="Firefox-share.html">Firefox share</a></li> | ||
| 34 | <li><a href="RSS-feeds.html">RSS feeds</a></li> | ||
| 35 | <li><a href="REST-API.html">REST API</a></li> | ||
| 36 | </ul></li> | ||
| 37 | <li>How To | ||
| 38 | <ul> | ||
| 39 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | ||
| 40 | <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> | ||
| 41 | <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li> | ||
| 42 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> | ||
| 43 | <li><a href="Datastore-hacks.html">Datastore hacks</a></li> | ||
| 44 | </ul></li> | ||
| 45 | <li><a href="Troubleshooting.html">Troubleshooting</a></li> | ||
| 46 | <li><a href="Development.html">Development</a> | ||
| 47 | <ul> | ||
| 48 | <li><a href="GnuPG-signature.html">GnuPG signature</a></li> | ||
| 49 | <li><a href="Coding-guidelines.html">Coding guidelines</a></li> | ||
| 50 | <li><a href="Directory-structure.html">Directory structure</a></li> | ||
| 51 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> | ||
| 52 | <li><a href="Plugin-System.html">Plugin System</a></li> | ||
| 53 | <li><a href="Release-Shaarli.html">Release Shaarli</a></li> | ||
| 54 | <li><a href="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 55 | <li><a href="Security.html">Security</a></li> | ||
| 56 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 57 | <li><a href="Theming.html">Theming</a></li> | ||
| 58 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 59 | </ul></li> | ||
| 60 | <li>About | ||
| 61 | <ul> | ||
| 62 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 63 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 64 | </ul></li> | ||
| 65 | </ul> | ||
| 66 | </div> | ||
| 67 | <h1 id="sharing-button">Sharing button</h1> | ||
| 68 | <h3 id="add-the-sharing-button-bookmarklet-to-your-browser">Add the sharing button (<em>bookmarklet</em>) to your browser</h3> | ||
| 69 | <ul> | ||
| 70 | <li>Open your Shaarli and <code>Login</code></li> | ||
| 71 | <li>Click the <code>Tools</code> button in the top bar</li> | ||
| 72 | <li>Drag the <strong><code>✚Shaare link</code> button</strong>, and drop it to your browser's bookmarks bar.</li> | ||
| 73 | </ul> | ||
| 74 | <p><em>This bookmarklet button is compatible with Firefox, Opera, Chrome and Safari. Under Opera, you can't drag'n drop the button: You have to right-click on it and add a bookmark to your personal toolbar.</em></p> | ||
| 75 | <p><embed src="(images/bookmarklet.png).html" /></p> | ||
| 76 | <h3 id="share-links-using-the-bookmarklet">Share links using the <em>bookmarklet</em></h3> | ||
| 77 | <ul> | ||
| 78 | <li>When you are visiting a webpage you would like to share with Shaarli, click the <em>bookmarklet</em> you just added.</li> | ||
| 79 | <li>A window opens.</li> | ||
| 80 | <li>You can freely edit title, description, tags... to find it later using the text search or tag filtering.</li> | ||
| 81 | <li>You will be able to edit this link later using the <embed src="(https://raw.githubusercontent.com/shaarli/Shaarli/master/images/edit_icon.png)-edit-button..html" /></li> | ||
| 82 | <li>You can also check the “Private” box so that the link is saved but only visible to you.</li> | ||
| 83 | <li>Click <code>Save</code>.<strong>Voilà! Your link is now shared.</strong></li> | ||
| 84 | </ul> | ||
| 85 | <h3 id="troubleshooting-the-bookmarklet-doesnt-work-with-a-few-website-e.g.-github.com">Troubleshooting: The bookmarklet doesn't work with a few website (e.g. Github.com)</h3> | ||
| 86 | <p>Websites which enforce Content Security Policy (CSP), such as github.com, disallow usage of bookmarklets. Unfortunatly, there is nothing Shaarli can do about it.</p> | ||
| 87 | <p>See <a href="https://github.com/shaarli/Shaarli#196">#196</a>.<a href=".html"></a></p> | ||
| 88 | <p>There is an open bug for both Firefox and Chromium:</p> | ||
| 89 | <ul> | ||
| 90 | <li><a href="https://bugzilla.mozilla.org/show_bug.cgi?id=866522" class="uri">https://bugzilla.mozilla.org/show_bug.cgi?id=866522</a></li> | ||
| 91 | <li><a href="https://code.google.com/p/chromium/issues/detail?id=233903" class="uri">https://code.google.com/p/chromium/issues/detail?id=233903</a></li> | ||
| 92 | </ul> | ||
| 93 | </body> | ||
| 94 | </html> | ||
diff --git a/doc/Static-analysis.html b/doc/Static-analysis.html deleted file mode 100644 index a95d195e..00000000 --- a/doc/Static-analysis.html +++ /dev/null | |||
| @@ -1,82 +0,0 @@ | |||
| 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 – Static analysis</title> | ||
| 8 | <style type="text/css">code{white-space: pre;}</style> | ||
| 9 | <link rel="stylesheet" href="github-markdown.css"> | ||
| 10 | <!--[if lt IE 9]> | ||
| 11 | <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script> | ||
| 12 | <![endif]--> | ||
| 13 | </head> | ||
| 14 | <body> | ||
| 15 | <div id="local-sidebar"> | ||
| 16 | <ul> | ||
| 17 | <li><a href="Home.html">Home</a></li> | ||
| 18 | <li>Setup | ||
| 19 | <ul> | ||
| 20 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 21 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 22 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 23 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 24 | <li><a href="Server-security.html">Server security</a></li> | ||
| 25 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> | ||
| 26 | <li><a href="Plugins.html">Plugins</a></li> | ||
| 27 | </ul></li> | ||
| 28 | <li><a href="Docker.html">Docker</a></li> | ||
| 29 | <li><a href="Usage.html">Usage</a> | ||
| 30 | <ul> | ||
| 31 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> | ||
| 32 | <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li> | ||
| 33 | <li><a href="Firefox-share.html">Firefox share</a></li> | ||
| 34 | <li><a href="RSS-feeds.html">RSS feeds</a></li> | ||
| 35 | <li><a href="REST-API.html">REST API</a></li> | ||
| 36 | </ul></li> | ||
| 37 | <li>How To | ||
| 38 | <ul> | ||
| 39 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | ||
| 40 | <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> | ||
| 41 | <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li> | ||
| 42 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> | ||
| 43 | <li><a href="Datastore-hacks.html">Datastore hacks</a></li> | ||
| 44 | </ul></li> | ||
| 45 | <li><a href="Troubleshooting.html">Troubleshooting</a></li> | ||
| 46 | <li><a href="Development.html">Development</a> | ||
| 47 | <ul> | ||
| 48 | <li><a href="GnuPG-signature.html">GnuPG signature</a></li> | ||
| 49 | <li><a href="Coding-guidelines.html">Coding guidelines</a></li> | ||
| 50 | <li><a href="Directory-structure.html">Directory structure</a></li> | ||
| 51 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> | ||
| 52 | <li><a href="Plugin-System.html">Plugin System</a></li> | ||
| 53 | <li><a href="Release-Shaarli.html">Release Shaarli</a></li> | ||
| 54 | <li><a href="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 55 | <li><a href="Security.html">Security</a></li> | ||
| 56 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 57 | <li><a href="Theming.html">Theming</a></li> | ||
| 58 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 59 | </ul></li> | ||
| 60 | <li>About | ||
| 61 | <ul> | ||
| 62 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 63 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 64 | </ul></li> | ||
| 65 | </ul> | ||
| 66 | </div> | ||
| 67 | <h1 id="static-analysis">Static analysis</h1> | ||
| 68 | <h2 id="wip">WIP</h2> | ||
| 69 | <p>This topic is currently being discussed here:</p> | ||
| 70 | <ul> | ||
| 71 | <li><a href="https://github.com/shaarli/Shaarli/issues/95">Fix coding style (static analysis)</a> (#95)<a href=".html"></a></li> | ||
| 72 | <li><a href="https://github.com/shaarli/Shaarli/issues/130">Continuous Integration tools & features</a> (#130)<a href=".html"></a></li> | ||
| 73 | </ul> | ||
| 74 | <h3 id="usage">Usage</h3> | ||
| 75 | <p>Static analysis tools can be installed with Composer, and used through Shaarli's <a href="https://github.com/shaarli/Shaarli/blob/master/Makefile">Makefile</a>.<a href=".html"></a></p> | ||
| 76 | <p>For an overview of the available features, see:</p> | ||
| 77 | <ul> | ||
| 78 | <li><a href="https://github.com/shaarli/Shaarli/pull/124">Code quality: Makefile to run static code checkers</a> (#124)<a href=".html"></a></li> | ||
| 79 | <li><a href="https://github.com/shaarli/Shaarli/pull/276">Run PHPCS against different coding standards</a> (#276)<a href=".html"></a></li> | ||
| 80 | </ul> | ||
| 81 | </body> | ||
| 82 | </html> | ||
diff --git a/doc/Theming.html b/doc/Theming.html deleted file mode 100644 index 6b5dac35..00000000 --- a/doc/Theming.html +++ /dev/null | |||
| @@ -1,182 +0,0 @@ | |||
| 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 – Theming</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>Setup | ||
| 56 | <ul> | ||
| 57 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 58 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 59 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 60 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 61 | <li><a href="Server-security.html">Server security</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 | <li><a href="REST-API.html">REST API</a></li> | ||
| 73 | </ul></li> | ||
| 74 | <li>How To | ||
| 75 | <ul> | ||
| 76 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</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="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 92 | <li><a href="Security.html">Security</a></li> | ||
| 93 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 94 | <li><a href="Theming.html">Theming</a></li> | ||
| 95 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 96 | </ul></li> | ||
| 97 | <li>About | ||
| 98 | <ul> | ||
| 99 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 100 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 101 | </ul></li> | ||
| 102 | </ul> | ||
| 103 | </div> | ||
| 104 | <h1 id="theming">Theming</h1> | ||
| 105 | <h2 id="foreword">Foreword</h2> | ||
| 106 | <p>There are two ways of customizing how Shaarli looks:</p> | ||
| 107 | <ol> | ||
| 108 | <li>by using a custom CSS to override Shaarli's CSS</li> | ||
| 109 | <li>by using a full theme that provides its own RainTPL templates, CSS and Javascript resources</li> | ||
| 110 | </ol> | ||
| 111 | <h2 id="custom-css">Custom CSS</h2> | ||
| 112 | <p>Shaarli's appearance can be modified by adding CSS rules to:</p> | ||
| 113 | <ul> | ||
| 114 | <li>Shaarli < <code>v0.9.0</code>: <code>inc/user.css</code></li> | ||
| 115 | <li>Shaarli >= <code>v0.9.0</code>: <code>data/user.css</code></li> | ||
| 116 | </ul> | ||
| 117 | <p>This file allows overriding rules defined in the template CSS files (only add changed rules), or define a whole new theme.</p> | ||
| 118 | <p><strong>Note</strong>: Do not edit <code>tpl/default/css/shaarli.css</code>! Your changes would be overridden when updating Shaarli.</p> | ||
| 119 | <p>See also <a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></p> | ||
| 120 | <h2 id="themes">Themes</h2> | ||
| 121 | <p><em>WARNING - This feature is currently being worked on and will be improved in the next releases. Experimental.</em></p> | ||
| 122 | <p>Installation:</p> | ||
| 123 | <ul> | ||
| 124 | <li>find a theme you'd like to install</li> | ||
| 125 | <li>copy or clone the theme folder under <code>tpl/<a_sweet_theme></code></li> | ||
| 126 | <li>enable the theme: | ||
| 127 | <ul> | ||
| 128 | <li>Shaarli < <code>v0.9.0</code>: edit <code>data/config.json.php</code> and set the value of <code>raintpl_tpl</code> to the new theme name:<br /> | ||
| 129 | <code>"raintpl_tpl": "tpl\/my-template\/"</code></li> | ||
| 130 | <li>Shaarli >= <code>v0.9.0</code>: select the theme through the <em>Tools</em> page</li> | ||
| 131 | </ul></li> | ||
| 132 | </ul> | ||
| 133 | <h2 id="community-css-themes">Community CSS & themes</h2> | ||
| 134 | <h3 id="custom-css-1">Custom CSS</h3> | ||
| 135 | <ul> | ||
| 136 | <li><a href="https://github.com/mrjovanovic/serious-theme-shaarli">mrjovanovic/serious-theme-shaarli</a> - A serious theme for Shaarli<a href=".html"></a></li> | ||
| 137 | <li><a href="https://github.com/shaarli/shaarli-themes">shaarli/shaarli-themes</a><a href=".html"></a></li> | ||
| 138 | </ul> | ||
| 139 | <h3 id="themes-1">Themes</h3> | ||
| 140 | <ul> | ||
| 141 | <li><a href="https://github.com/AkibaTech/Shaarli---SuperHero-Theme">AkibaTech/Shaarli Superhero Theme</a> - A template/theme for Shaarli<a href=".html"></a></li> | ||
| 142 | <li><a href="https://github.com/alexisju/albinomouse-template">alexisju/albinomouse-template</a> - A full template for Shaarli<a href=".html"></a></li> | ||
| 143 | <li><a href="https://github.com/ArthurHoaro/shaarli-launch">ArthurHoaro/shaarli-launch</a> - Customizable Shaarli theme<a href=".html"></a></li> | ||
| 144 | <li><a href="https://github.com/dhoko/ShaarliTemplate">dhoko/ShaarliTemplate</a> - A template/theme for Shaarli<a href=".html"></a></li> | ||
| 145 | <li><a href="https://github.com/kalvn/shaarli-blocks">kalvn/shaarli-blocks</a> - A template/theme for Shaarli<a href=".html"></a></li> | ||
| 146 | <li><a href="https://github.com/kalvn/Shaarli-Material">kalvn/Shaarli-Material</a> - A theme (template) based on Google's Material Design for Shaarli, the superfast delicious clone<a href=".html"></a></li> | ||
| 147 | <li><a href="https://github.com/ManufacturaInd/shaarli-2004licious-theme">ManufacturaInd/shaarli-2004licious-theme</a> - A template/theme as a humble homage to the early looks of the del.icio.us site<a href=".html"></a></li> | ||
| 148 | </ul> | ||
| 149 | <h3 id="shaarli-forks">Shaarli forks</h3> | ||
| 150 | <ul> | ||
| 151 | <li><a href="https://github.com/misterair/limonade">misterair/Limonade</a> - A fork of (legacy) Shaarli with a new template<a href=".html"></a></li> | ||
| 152 | <li><a href="https://github.com/vivienhaese/shaarlitheme">vivienhaese/shaarlitheme</a> - A Shaarli fork meant to be run in an openshift instance<a href=".html"></a></li> | ||
| 153 | </ul> | ||
| 154 | <h2 id="example-installation-albinomouse-theme">Example installation: AlbinoMouse theme</h2> | ||
| 155 | <p>With the following configuration:</p> | ||
| 156 | <ul> | ||
| 157 | <li>Apache 2 / PHP 5.6</li> | ||
| 158 | <li>user sites are enabled, e.g. <code>/home/user/public_html/somedir</code> is served as <code>http://localhost/~user/somedir</code></li> | ||
| 159 | <li><code>http</code> is the name of the Apache user</li> | ||
| 160 | </ul> | ||
| 161 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="bu">cd</span> ~/public_html | ||
| 162 | |||
| 163 | <span class="co"># clone repositories</span> | ||
| 164 | $ <span class="fu">git</span> clone https://github.com/shaarli/Shaarli.git shaarli | ||
| 165 | $ <span class="bu">pushd</span> shaarli/tpl | ||
| 166 | $ <span class="fu">git</span> clone https://github.com/alexisju/albinomouse-template.git | ||
| 167 | $ <span class="bu">popd</span> | ||
| 168 | |||
| 169 | <span class="co"># set access rights for Apache</span> | ||
| 170 | $ <span class="fu">chgrp</span> -R http shaarli | ||
| 171 | $ <span class="fu">chmod</span> g+rwx shaarli shaarli/cache shaarli/data shaarli/pagecache shaarli/tmp</code></pre></div> | ||
| 172 | <p>Get config written:</p> | ||
| 173 | <ul> | ||
| 174 | <li>go to the freshly installed site</li> | ||
| 175 | <li>fill the install form</li> | ||
| 176 | <li>log in to Shaarli</li> | ||
| 177 | </ul> | ||
| 178 | <p>Edit Shaarli's <a href="configuration%7CShaarli-configuration.html">configuration|Shaarli configuration</a>:</p> | ||
| 179 | <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> | ||
| 180 | $ <span class="fu">sudo</span> sed -i s=tpl=tpl/albinomouse-template=g shaarli/data/config.php</code></pre></div> | ||
| 181 | </body> | ||
| 182 | </html> | ||
diff --git a/doc/Troubleshooting.html b/doc/Troubleshooting.html deleted file mode 100644 index f43e6ed3..00000000 --- a/doc/Troubleshooting.html +++ /dev/null | |||
| @@ -1,202 +0,0 @@ | |||
| 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 – Troubleshooting</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>Setup | ||
| 56 | <ul> | ||
| 57 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 58 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 59 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 60 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 61 | <li><a href="Server-security.html">Server security</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 | <li><a href="REST-API.html">REST API</a></li> | ||
| 73 | </ul></li> | ||
| 74 | <li>How To | ||
| 75 | <ul> | ||
| 76 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</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="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 92 | <li><a href="Security.html">Security</a></li> | ||
| 93 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 94 | <li><a href="Theming.html">Theming</a></li> | ||
| 95 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 96 | </ul></li> | ||
| 97 | <li>About | ||
| 98 | <ul> | ||
| 99 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 100 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 101 | </ul></li> | ||
| 102 | </ul> | ||
| 103 | </div> | ||
| 104 | <h1 id="troubleshooting">Troubleshooting</h1> | ||
| 105 | <h2 id="browser">Browser</h2> | ||
| 106 | <h3 id="redirection-issues-http-referer">Redirection issues (HTTP Referer)</h3> | ||
| 107 | <p>Depending on its configuration and installed plugins, the browser may remove or alter (spoof) HTTP referers, thus preventing Shaarli from properly redirecting between pages.</p> | ||
| 108 | <p>See:</p> | ||
| 109 | <ul> | ||
| 110 | <li><a href="https://en.wikipedia.org/wiki/HTTP_referer">HTTP referer</a> (Wikipedia)<a href=".html"></a></li> | ||
| 111 | <li><a href="http://www.ghacks.net/2015/01/22/improve-online-privacy-by-controlling-referrer-information/">Improve online privacy by controlling referrer information</a><a href=".html"></a></li> | ||
| 112 | <li><a href="http://b.agilob.net/better-security-privacy-and-anonymity-in-firefox/">Better security, privacy and anonymity in Firefox</a><a href=".html"></a></li> | ||
| 113 | </ul> | ||
| 114 | <h3 id="firefox-http-referer-options">Firefox HTTP Referer options</h3> | ||
| 115 | <p>HTTP settings are available by browsing <code>about:config</code>, here are the available settings and their values.</p> | ||
| 116 | <p><code>network.http.sendRefererHeader</code> - determines when to send the Referer HTTP header</p> | ||
| 117 | <ul> | ||
| 118 | <li>0: Never send the referring URL | ||
| 119 | <ul> | ||
| 120 | <li>not recommended, may break some sites</li> | ||
| 121 | </ul></li> | ||
| 122 | <li>1: Send only on clicked links</li> | ||
| 123 | <li>2 (default): Send for links and images</li> | ||
| 124 | </ul> | ||
| 125 | <p><code>network.http.referer.XOriginPolicy</code> - Cross-domain origin policy</p> | ||
| 126 | <ul> | ||
| 127 | <li>0 (default): Always send</li> | ||
| 128 | <li>1: Send if base domains match</li> | ||
| 129 | <li>2: Send if hosts match</li> | ||
| 130 | </ul> | ||
| 131 | <p><code>network.http.referer.spoofSource</code> - Referer spoofing (~faking)</p> | ||
| 132 | <ul> | ||
| 133 | <li>false (default): real referer</li> | ||
| 134 | <li>true: spoof referer (use target URI as referer)</li> | ||
| 135 | <li>known to break some functionality in Shaarli</li> | ||
| 136 | </ul> | ||
| 137 | <p><code>network.http.referer.trimmingPolicy</code> - trim the URI not to send a full Referer</p> | ||
| 138 | <ul> | ||
| 139 | <li>0 (default): send full URI</li> | ||
| 140 | <li>1: scheme+host+port+path</li> | ||
| 141 | <li>2: scheme+host+port</li> | ||
| 142 | </ul> | ||
| 143 | <h3 id="firefox-localhost-and-redirections">Firefox, localhost and redirections</h3> | ||
| 144 | <p><code>localhost</code> is not a proper Fully Qualified Domain Name (FQDN); if Firefox has been set up to spoof referers, or only accept requests from the same base domain/host, Shaarli redirections will not work properly.</p> | ||
| 145 | <p>To solve this, assign a local domain to your host, e.g.</p> | ||
| 146 | <pre><code>127.0.0.1 localhost desktop localhost.lan | ||
| 147 | ::1 localhost desktop localhost.lan</code></pre> | ||
| 148 | <p>and browse Shaarli at <a href="http://localhost.lan/" class="uri">http://localhost.lan/</a>.</p> | ||
| 149 | <p>Related threads:</p> | ||
| 150 | <ul> | ||
| 151 | <li><a href="https://bbs.archlinux.org/viewtopic.php?id=156064">What is localhost.localdomain for?</a><a href=".html"></a></li> | ||
| 152 | <li><a href="https://github.com/shaarli/Shaarli/issues/311">Stop returning to the first page after editing a bookmark from another page</a><a href=".html"></a></li> | ||
| 153 | </ul> | ||
| 154 | <h2 id="login">Login</h2> | ||
| 155 | <h3 id="i-forgot-my-password">I forgot my password!</h3> | ||
| 156 | <p>Delete the file <code>data/config.php</code> and display the page again. You will be asked for a new login/password.</p> | ||
| 157 | <h3 id="im-locked-out---login-bruteforce-protection">I'm locked out - Login bruteforce protection</h3> | ||
| 158 | <p>Login form is protected against brute force attacks: 4 failed logins will ban the IP address from login for 30 minutes. Banned IPs can still browse links.</p> | ||
| 159 | <p>To remove the current IP bans, delete the file <code>data/ipbans.php</code></p> | ||
| 160 | <h3 id="list-of-all-login-attempts">List of all login attempts</h3> | ||
| 161 | <p>The file <code>data/log.txt</code> shows all logins (successful or failed) and bans/lifted bans.<br /> | ||
| 162 | Search for <code>failed</code> in this file to look for unauthorized login attempts.</p> | ||
| 163 | <h2 id="hosting-problems">Hosting problems</h2> | ||
| 164 | <h3 id="old-php-versions">Old PHP versions</h3> | ||
| 165 | <ul> | ||
| 166 | <li>On <strong>free.fr</strong> : free.fr now support php 5.6.x(<a href="http://les.pages.perso.chez.free.fr/migrations/php5v6.io">link</a>)and so support now the tag autocompletion but you have to do the following : At the root of your webspace create a <code>sessions</code> directory and a <code>.htaccess</code> file containing:<a href=".html"></a></li> | ||
| 167 | </ul> | ||
| 168 | <div class="sourceCode"><pre class="sourceCode ini"><code class="sourceCode ini"><span class="dt"><IfDefine Free></span> | ||
| 169 | <span class="dt">php56 1</span> | ||
| 170 | <span class="dt"></IfDefine></span></code></pre></div> | ||
| 171 | <ul> | ||
| 172 | <li>If you have an error such as: <code>Parse error: syntax error, unexpected '=', expecting '(' in /links/index.php on line xxx</code>, it means that your host is using php4, not php5. Shaarli requires php 5.1. Try changing the file extension to <code>.php5</code></li> | ||
| 173 | <li>On <strong>1and1</strong> : If you add the link from the page (and not from the bookmarklet), Shaarli will no be able to get the title of the page. You will have to enter it manually. (Because they have disabled the ability to download a file through HTTP).</li> | ||
| 174 | <li>If you have the error <code>Warning: file_get_contents() [function.file-get-contents]: URL file-access is disabled in the server configuration in /…/index.php on line xxx</code>, it means that your host has disabled the ability to fetch a file by HTTP in the php config (Typically in 1and1 hosting). Bad host. Change host. Or comment the following lines:<a href=".html"></a></li> | ||
| 175 | </ul> | ||
| 176 | <div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php"><span class="co">//list($status,$headers,$data) = getHTTP($url,4); // Short timeout to keep the application responsive.</span> | ||
| 177 | <span class="co">// </span><span class="al">FIXME</span><span class="co">: Decode charset according to charset specified in either 1) HTTP response headers or 2) <head> in html </span> | ||
| 178 | <span class="co">//if (strpos($status,'200 OK')) $title=html_extract_title($data);</span></code></pre></div> | ||
| 179 | <ul> | ||
| 180 | <li>On hosts which forbid outgoing HTTP requests (such as free.fr), some thumbnails will not work.</li> | ||
| 181 | <li>On <strong>lost-oasis</strong>, RSS doesn't work correctly, because of this message at the begining of the RSS/ATOM feed : <code><? // tout ce qui est charge ici (generalement des includes et require) est charge en permanence. ?></code>. To fix this, remove this message from <code>php-include/prepend.php</code></li> | ||
| 182 | </ul> | ||
| 183 | <h3 id="dates-are-not-properly-formatted">Dates are not properly formatted</h3> | ||
| 184 | <p>Shaarli tries to sniff the language of the browser (using HTTP_ACCEPT_LANGUAGE headers) and choose a date format accordingly. But Shaarli can only use the date formats (and more generaly speaking, the locales) provided by the webserver. So even if you have a browser in French, you may end up with dates in US format (it's the case on sebsauvage.net :-( )</p> | ||
| 185 | <h3 id="problems-on-centos-servers">Problems on CentOS servers</h3> | ||
| 186 | <p>On <strong>CentOS</strong>/RedHat derivatives, you may need to install the <code>php-mbstring</code> package.</p> | ||
| 187 | <h3 id="my-session-expires-i-cant-stay-logged-in">My session expires! I can't stay logged in</h3> | ||
| 188 | <p>This can be caused by several things:</p> | ||
| 189 | <ul> | ||
| 190 | <li>Your php installation may not have a proper directory setup for session files. (eg. on Free.fr you need to create a <code>session</code> directory on the root of your website.) You may need to create the session directory of set it up.</li> | ||
| 191 | <li>Most hosts regularly clean the temporary and session directories. Your host may be cleaning those directories too aggressively (eg.OVH hosts), forcing an expire of the session. You may want to set the session directory in your web root. (eg. Create the <code>sessions</code> subdirectory and add <code>ini_set('session.save_path', $_SERVER['DOCUMENT_ROOT'].'/../sessions');</code>. Make sure this directory is not browsable !)<a href=".html"></a></li> | ||
| 192 | <li>If your IP address changes during surfing, Shaarli will force expire your session for security reasons (to prevent session cookie hijacking). This can happen when surfing from WiFi or 3G (you may have switched WiFi/3G access point), or in some corporate/university proxies which use load balancing (and may have proxies with several external IP addresses).</li> | ||
| 193 | <li>Some browser addons may interfer with HTTP headers (ipfuck/ipflood/GreaseMonkey…). Try disabling those.</li> | ||
| 194 | <li>You may be using OperaTurbo or OperaMini, which use their own proxies which may change from time to time.</li> | ||
| 195 | <li>If you have another application on the same webserver where Shaarli is installed, these application may forcefully expire php sessions.</li> | ||
| 196 | </ul> | ||
| 197 | <h2 id="sessions-do-not-seem-to-work-correctly-on-your-server">Sessions do not seem to work correctly on your server</h2> | ||
| 198 | <p>Follow the instructions in the error message. Make sure you are accessing shaarli via a direct IP address or a proper hostname. If you have <strong>no dots</strong> in the hostname (e.g. <code>localhost</code> or <code>http://my-webserver/shaarli/</code>), some browsers will not store cookies at all (this respects the <a href="http://curl.haxx.se/rfc/cookie_spec.html">HTTP cookie specification</a>).<a href=".html"></a></p> | ||
| 199 | <h3 id="pubsubhubbub-support">pubsubhubbub support</h3> | ||
| 200 | <p>Download <a href="https://pubsubhubbub.googlecode.com/git/publisher_clients/php/library/publisher.php">publisher.php</a> at the root of your Shaarli installation and set <code>$GLOBALS['config'['PUBSUBHUB_URL']</code> in your <code>config.php</code>]('PUBSUBHUB_URL']<code>-in-your-</code>config.php`.html)</p> | ||
| 201 | </body> | ||
| 202 | </html> | ||
diff --git a/doc/Unit-tests.html b/doc/Unit-tests.html deleted file mode 100644 index 09611463..00000000 --- a/doc/Unit-tests.html +++ /dev/null | |||
| @@ -1,226 +0,0 @@ | |||
| 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 – Unit tests</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>Setup | ||
| 56 | <ul> | ||
| 57 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 58 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 59 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 60 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 61 | <li><a href="Server-security.html">Server security</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 | <li><a href="REST-API.html">REST API</a></li> | ||
| 73 | </ul></li> | ||
| 74 | <li>How To | ||
| 75 | <ul> | ||
| 76 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</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="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 92 | <li><a href="Security.html">Security</a></li> | ||
| 93 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 94 | <li><a href="Theming.html">Theming</a></li> | ||
| 95 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 96 | </ul></li> | ||
| 97 | <li>About | ||
| 98 | <ul> | ||
| 99 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 100 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 101 | </ul></li> | ||
| 102 | </ul> | ||
| 103 | </div> | ||
| 104 | <h1 id="unit-tests">Unit tests</h1> | ||
| 105 | <h3 id="setup-your-environment-for-tests">Setup your environment for tests</h3> | ||
| 106 | <p>The framework used is <a href="https://phpunit.de/">PHPUnit</a>; it can be installed with <a href="https://getcomposer.org/">Composer</a>, which is a dependency management tool.<a href=".html"></a></p> | ||
| 107 | <p>Regarding Composer, you can either use:</p> | ||
| 108 | <ul> | ||
| 109 | <li>a system-wide version, e.g. installed through your distro's package manager</li> | ||
| 110 | <li>a local version, downloadable <a href="https://getcomposer.org/download/">here</a><a href=".html"></a></li> | ||
| 111 | </ul> | ||
| 112 | <h4 id="sample-usage">Sample usage</h4> | ||
| 113 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># system-wide version</span> | ||
| 114 | $ <span class="ex">composer</span> install | ||
| 115 | $ <span class="ex">composer</span> update | ||
| 116 | |||
| 117 | <span class="co"># local version</span> | ||
| 118 | $ <span class="ex">php</span> composer.phar self-update | ||
| 119 | $ <span class="ex">php</span> composer.phar install | ||
| 120 | $ <span class="ex">php</span> composer.phar update</code></pre></div> | ||
| 121 | <h4 id="install-shaarli-dev-dependencies">Install Shaarli dev dependencies</h4> | ||
| 122 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="bu">cd</span> /path/to/shaarli | ||
| 123 | $ <span class="ex">composer</span> update</code></pre></div> | ||
| 124 | <h4 id="install-and-enable-xdebug-to-generate-phpunit-coverage-reports">Install and enable Xdebug to generate PHPUnit coverage reports</h4> | ||
| 125 | <p>For Debian-based distros:</p> | ||
| 126 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="ex">aptitude</span> install php5-xdebug</code></pre></div> | ||
| 127 | <p>For ArchLinux:</p> | ||
| 128 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="ex">pacman</span> -S xdebug</code></pre></div> | ||
| 129 | <p>Then add the following line to <code>/etc/php/php.ini</code>:</p> | ||
| 130 | <div class="sourceCode"><pre class="sourceCode ini"><code class="sourceCode ini"><span class="dt">zend_extension</span><span class="ot">=</span><span class="st">xdebug.so</span></code></pre></div> | ||
| 131 | <h4 id="run-unit-tests">Run unit tests</h4> | ||
| 132 | <p>Successful test suite:</p> | ||
| 133 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="fu">make</span> test | ||
| 134 | |||
| 135 | <span class="ex">-------</span> | ||
| 136 | <span class="ex">PHPUNIT</span> | ||
| 137 | <span class="ex">-------</span> | ||
| 138 | <span class="ex">PHPUnit</span> 4.6.9 by Sebastian Bergmann and contributors. | ||
| 139 | |||
| 140 | <span class="ex">Configuration</span> read from /home/virtualtam/public_html/shaarli/phpunit.xml | ||
| 141 | |||
| 142 | <span class="ex">....................................</span> | ||
| 143 | |||
| 144 | <span class="ex">Time</span>: 759 ms, Memory: 8.25Mb | ||
| 145 | |||
| 146 | <span class="ex">OK</span> (36 tests, 65 assertions)</code></pre></div> | ||
| 147 | <p>Test suite with failures and errors:</p> | ||
| 148 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="fu">make</span> test | ||
| 149 | <span class="ex">-------</span> | ||
| 150 | <span class="ex">PHPUNIT</span> | ||
| 151 | <span class="ex">-------</span> | ||
| 152 | <span class="ex">PHPUnit</span> 4.6.9 by Sebastian Bergmann and contributors. | ||
| 153 | |||
| 154 | <span class="ex">Configuration</span> read from /home/virtualtam/public_html/shaarli/phpunit.xml | ||
| 155 | |||
| 156 | <span class="ex">E..FF...............................</span> | ||
| 157 | |||
| 158 | <span class="ex">Time</span>: 802 ms, Memory: 8.25Mb | ||
| 159 | |||
| 160 | <span class="ex">There</span> was 1 error: | ||
| 161 | |||
| 162 | <span class="ex">1</span>) <span class="ex">LinkDBTest</span>::testConstructLoggedIn | ||
| 163 | <span class="ex">Missing</span> argument 2 for LinkDB::__construct(), <span class="ex">called</span> in /home/virtualtam/public_html/shaarli/tests/Link\ | ||
| 164 | DBTest.php on line 79 and defined | ||
| 165 | |||
| 166 | <span class="ex">/home/virtualtam/public_html/shaarli/application</span>/LinkDB.php:<span class="ex">58</span> | ||
| 167 | <span class="ex">/home/virtualtam/public_html/shaarli/tests</span>/LinkDBTest.php:<span class="ex">79</span> | ||
| 168 | |||
| 169 | <span class="ex">--</span> | ||
| 170 | |||
| 171 | <span class="ex">There</span> were 2 failures: | ||
| 172 | |||
| 173 | <span class="ex">1</span>) <span class="ex">LinkDBTest</span>::testCheckDBNew | ||
| 174 | <span class="ex">Failed</span> asserting that two strings are equal. | ||
| 175 | <span class="ex">---</span> Expected | ||
| 176 | <span class="ex">+++</span> Actual | ||
| 177 | <span class="ex">@@</span> @@ | ||
| 178 | <span class="ex">-</span><span class="st">'e3edea8ea7bb50be4bcb404df53fbb4546a7156e'</span> | ||
| 179 | <span class="ex">+</span><span class="st">'85eab0c610d4f68025f6ed6e6b6b5fabd4b55834'</span> | ||
| 180 | |||
| 181 | <span class="ex">/home/virtualtam/public_html/shaarli/tests</span>/LinkDBTest.php:<span class="ex">121</span> | ||
| 182 | |||
| 183 | <span class="ex">2</span>) <span class="ex">LinkDBTest</span>::testCheckDBLoad | ||
| 184 | <span class="ex">Failed</span> asserting that two strings are equal. | ||
| 185 | <span class="ex">---</span> Expected | ||
| 186 | <span class="ex">+++</span> Actual | ||
| 187 | <span class="ex">@@</span> @@ | ||
| 188 | <span class="ex">-</span><span class="st">'e3edea8ea7bb50be4bcb404df53fbb4546a7156e'</span> | ||
| 189 | <span class="ex">+</span><span class="st">'85eab0c610d4f68025f6ed6e6b6b5fabd4b55834'</span> | ||
| 190 | |||
| 191 | <span class="ex">/home/virtualtam/public_html/shaarli/tests</span>/LinkDBTest.php:<span class="ex">133</span> | ||
| 192 | |||
| 193 | <span class="ex">FAILURES</span>! | ||
| 194 | <span class="ex">Tests</span>: 36, Assertions: 63, Errors: 1, Failures: 2.</code></pre></div> | ||
| 195 | <h4 id="test-results-and-coverage">Test results and coverage</h4> | ||
| 196 | <p>By default, PHPUnit will run all suitable tests found under the <code>tests</code> directory.</p> | ||
| 197 | <p>Each test has 3 possible outcomes:</p> | ||
| 198 | <ul> | ||
| 199 | <li><code>.</code> - success</li> | ||
| 200 | <li><code>F</code> - failure: the test was run but its results are invalid</li> | ||
| 201 | <li>the code does not behave as expected</li> | ||
| 202 | <li>dependencies to external elements: globals, session, cache...</li> | ||
| 203 | <li><code>E</code> - error: something went wrong and the tested code has crashed</li> | ||
| 204 | <li>typos in the code, or in the test code</li> | ||
| 205 | <li>dependencies to missing external elements</li> | ||
| 206 | </ul> | ||
| 207 | <p>If Xdebug has been installed and activated, two coverage reports will be generated:</p> | ||
| 208 | <ul> | ||
| 209 | <li>a summary in the console</li> | ||
| 210 | <li>a detailed HTML report with metrics for tested code</li> | ||
| 211 | <li>to open it in a web browser: <code>firefox coverage/index.html &</code></li> | ||
| 212 | </ul> | ||
| 213 | <h3 id="executing-specific-tests">Executing specific tests</h3> | ||
| 214 | <p>Add a <a href="https://phpunit.de/manual/current/en/appendixes.annotations.html#appendixes.annotations.group"><code>@group</code></a> annotation in a test class or method comment:<a href=".html"></a></p> | ||
| 215 | <div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php"><span class="co">/**</span> | ||
| 216 | <span class="co"> * Netscape bookmark import</span> | ||
| 217 | <span class="co"> * </span><span class="an">@group</span><span class="co"> WIP</span> | ||
| 218 | <span class="co"> */</span> | ||
| 219 | <span class="kw">class</span> BookmarkImportTest <span class="kw">extends</span> PHPUnit_Framework_TestCase | ||
| 220 | { | ||
| 221 | <span class="ot">[</span><span class="st">...</span><span class="ot">][](</span>.html<span class="ot">)</span> | ||
| 222 | }</code></pre></div> | ||
| 223 | <p>To run all tests annotated with <code>@group WIP</code>:</p> | ||
| 224 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="ex">vendor/bin/phpunit</span> --group WIP tests/</code></pre></div> | ||
| 225 | </body> | ||
| 226 | </html> | ||
diff --git a/doc/Upgrade-and-migration.html b/doc/Upgrade-and-migration.html deleted file mode 100644 index 667215ab..00000000 --- a/doc/Upgrade-and-migration.html +++ /dev/null | |||
| @@ -1,259 +0,0 @@ | |||
| 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 – Upgrade and migration</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>Setup | ||
| 56 | <ul> | ||
| 57 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 58 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 59 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 60 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 61 | <li><a href="Server-security.html">Server security</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 | <li><a href="REST-API.html">REST API</a></li> | ||
| 73 | </ul></li> | ||
| 74 | <li>How To | ||
| 75 | <ul> | ||
| 76 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</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="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 92 | <li><a href="Security.html">Security</a></li> | ||
| 93 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 94 | <li><a href="Theming.html">Theming</a></li> | ||
| 95 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 96 | </ul></li> | ||
| 97 | <li>About | ||
| 98 | <ul> | ||
| 99 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 100 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 101 | </ul></li> | ||
| 102 | </ul> | ||
| 103 | </div> | ||
| 104 | <h1 id="upgrade-and-migration">Upgrade and migration</h1> | ||
| 105 | <h2 id="preparation">Preparation</h2> | ||
| 106 | <h3 id="note-your-current-version">Note your current version</h3> | ||
| 107 | <p>If anything goes wrong, it's important for us to know which version you're upgrading from.<br /> | ||
| 108 | The current version is present in the <code>version.php</code> file.</p> | ||
| 109 | <h3 id="backup-your-data">Backup your data</h3> | ||
| 110 | <p>Shaarli stores all user data under the <code>data</code> directory:</p> | ||
| 111 | <ul> | ||
| 112 | <li><code>data/config.php</code> - main configuration file</li> | ||
| 113 | <li><code>data/datastore.php</code> - bookmarked links</li> | ||
| 114 | <li><code>data/ipbans.php</code> - banned IP addresses</li> | ||
| 115 | <li><code>data/updates.txt</code> - contains all automatic update to the configuration and datastore files already run</li> | ||
| 116 | </ul> | ||
| 117 | <p>See <a href="Shaarli-configuration.html">Shaarli configuration</a> for more information about Shaarli resources.</p> | ||
| 118 | <p>It is recommended to backup this repository <em>before</em> starting updating/upgrading Shaarli:</p> | ||
| 119 | <ul> | ||
| 120 | <li>users with SSH access: copy or archive the directory to a temporary location</li> | ||
| 121 | <li>users with FTP access: download a local copy of your Shaarli installation using your favourite client</li> | ||
| 122 | </ul> | ||
| 123 | <h3 id="migrating-data-from-a-previous-installation">Migrating data from a previous installation</h3> | ||
| 124 | <p>As all user data is kept under <code>data</code>, this is the only directory you need to worry about when migrating to a new installation, which corresponds to the following steps:</p> | ||
| 125 | <ul> | ||
| 126 | <li>backup the <code>data</code> directory</li> | ||
| 127 | <li>install or update Shaarli: | ||
| 128 | <ul> | ||
| 129 | <li>fresh installation - see <a href="Download-and-installation.html">Download and installation</a></li> | ||
| 130 | <li>update - see the following sections</li> | ||
| 131 | </ul></li> | ||
| 132 | <li>check or restore the <code>data</code> directory</li> | ||
| 133 | </ul> | ||
| 134 | <h2 id="recommended-upgrading-from-release-archives">Recommended : Upgrading from release archives</h2> | ||
| 135 | <p>All tagged revisions can be downloaded as tarballs or ZIP archives from the <a href="https://github.com/shaarli/Shaarli/releases">releases</a> page.<a href=".html"></a></p> | ||
| 136 | <p>We recommend that you use the latest release tarball with the <code>-full</code> suffix. It contains the dependencies, please read <a href="Download-and-installation.html">Download and installation</a> for <code>git</code> complete instructions.</p> | ||
| 137 | <p>Once downloaded, extract the archive locally and update your remote installation (e.g. via FTP) -be sure you keep the content of the <code>data</code> directory!</p> | ||
| 138 | <p>After upgrading, access your fresh Shaarli installation from a web browser; the configuration and data store will then be automatically updated, and new settings added to <code>data/config.json.php</code> (see <a href="Shaarli-configuration.html">Shaarli configuration</a> for more details).</p> | ||
| 139 | <h2 id="upgrading-with-git">Upgrading with Git</h2> | ||
| 140 | <h3 id="updating-a-community-shaarli">Updating a community Shaarli</h3> | ||
| 141 | <p>If you have installed Shaarli from the <a href="Download#clone-with-git-recommended">community Git repository</a>, simply <a href="https://www.git-scm.com/docs/git-pull">pull new changes</a> from your local clone:<a href=".html"></a></p> | ||
| 142 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="bu">cd</span> /path/to/shaarli | ||
| 143 | $ <span class="fu">git</span> pull | ||
| 144 | |||
| 145 | <span class="ex">From</span> github.com:shaarli/Shaarli | ||
| 146 | <span class="ex">*</span> branch master -<span class="op">></span> FETCH_HEAD | ||
| 147 | <span class="ex">Updating</span> ebd67c6..521f0e6 | ||
| 148 | <span class="ex">Fast-forward</span> | ||
| 149 | <span class="ex">application/Url.php</span> <span class="kw">|</span> <span class="ex">1</span> + | ||
| 150 | <span class="ex">shaarli_version.php</span> <span class="kw">|</span> <span class="ex">2</span> +- | ||
| 151 | <span class="ex">tests/Url/UrlTest.php</span> <span class="kw">|</span> <span class="ex">1</span> + | ||
| 152 | <span class="ex">3</span> files changed, 3 insertions(+), <span class="ex">1</span> deletion(-)</code></pre></div> | ||
| 153 | <p>Shaarli >= <code>v0.8.x</code>: install/update third-party PHP dependencies using <a href="https://getcomposer.org/">Composer</a>:<a href=".html"></a></p> | ||
| 154 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="ex">composer</span> install --no-dev | ||
| 155 | |||
| 156 | <span class="ex">Loading</span> composer repositories with package information | ||
| 157 | <span class="ex">Updating</span> dependencies | ||
| 158 | <span class="ex">-</span> Installing shaarli/netscape-bookmark-parser (v1.0.1) | ||
| 159 | <span class="ex">Downloading</span>: 100%</code></pre></div> | ||
| 160 | <h3 id="migrating-and-upgrading-from-sebsauvages-repository">Migrating and upgrading from Sebsauvage's repository</h3> | ||
| 161 | <p>If you have installed Shaarli from <a href="https://github.com/sebsauvage/Shaarli">Sebsauvage's original Git repository</a>, you can use <a href="https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes">Git remotes</a> to update your working copy.<a href=".html"></a></p> | ||
| 162 | <p>The following guide assumes that:</p> | ||
| 163 | <ul> | ||
| 164 | <li>you have a basic knowledge of Git <a href="https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell">branching</a> and <a href="https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes">remote repositories</a><a href=".html"></a></li> | ||
| 165 | <li>the default remote is named <code>origin</code> and points to Sebsauvage's repository</li> | ||
| 166 | <li>the current branch is <code>master</code> | ||
| 167 | <ul> | ||
| 168 | <li>if you have personal branches containing customizations, you will need to <a href="https://git-scm.com/book/en/v2/Git-Branching-Rebasing">rebase them</a> after the upgrade; beware though, a lot of changes have been made since the community fork has been created, so things are very likely to break<embed src=".html" /></li> | ||
| 169 | </ul></li> | ||
| 170 | <li>the working copy is clean: | ||
| 171 | <ul> | ||
| 172 | <li>no versioned file has been locally modified</li> | ||
| 173 | <li>no untracked files are present</li> | ||
| 174 | </ul></li> | ||
| 175 | </ul> | ||
| 176 | <h4 id="step-0-show-repository-information">Step 0: show repository information</h4> | ||
| 177 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="bu">cd</span> /path/to/shaarli | ||
| 178 | |||
| 179 | $ <span class="fu">git</span> remote -v | ||
| 180 | <span class="ex">origin</span> https://github.com/sebsauvage/Shaarli (fetch) | ||
| 181 | <span class="ex">origin</span> https://github.com/sebsauvage/Shaarli (push) | ||
| 182 | |||
| 183 | $ <span class="fu">git</span> branch -vv | ||
| 184 | <span class="ex">*</span> master 029f75f [origin/master] Update README.md[](.html) | ||
| 185 | |||
| 186 | $ <span class="fu">git</span> status | ||
| 187 | <span class="ex">On</span> branch master | ||
| 188 | <span class="ex">Your</span> branch is up-to-date with <span class="st">'origin/master'</span>. | ||
| 189 | <span class="ex">nothing</span> to commit, working directory clean</code></pre></div> | ||
| 190 | <h4 id="step-1-update-git-remotes">Step 1: update Git remotes</h4> | ||
| 191 | <pre><code>$ git remote rename origin sebsauvage | ||
| 192 | $ git remote -v | ||
| 193 | sebsauvage https://github.com/sebsauvage/Shaarli (fetch) | ||
| 194 | sebsauvage https://github.com/sebsauvage/Shaarli (push) | ||
| 195 | |||
| 196 | $ git remote add origin https://github.com/shaarli/Shaarli | ||
| 197 | $ git fetch origin | ||
| 198 | |||
| 199 | remote: Counting objects: 3015, done. | ||
| 200 | remote: Compressing objects: 100% (19/19), done. | ||
| 201 | remote: Total 3015 (delta 446), reused 457 (delta 446), pack-reused 2550 | ||
| 202 | Receiving objects: 100% (3015/3015), 2.59 MiB | 918.00 KiB/s, done. | ||
| 203 | Resolving deltas: 100% (1899/1899), completed with 48 local objects. | ||
| 204 | From https://github.com/shaarli/Shaarli | ||
| 205 | * [new branch] master -> origin/master[](.html) | ||
| 206 | * [new branch] stable -> origin/stable[](.html) | ||
| 207 | [...][](.html) | ||
| 208 | * [new tag] v0.6.4 -> v0.6.4[](.html) | ||
| 209 | * [new tag] v0.7.0 -> v0.7.0[](.html)</code></pre> | ||
| 210 | <h4 id="step-2-use-the-stable-community-branch">Step 2: use the stable community branch</h4> | ||
| 211 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="fu">git</span> checkout origin/stable -b stable | ||
| 212 | <span class="ex">Branch</span> stable set up to track remote branch stable from origin. | ||
| 213 | <span class="ex">Switched</span> to a new branch <span class="st">'stable'</span> | ||
| 214 | |||
| 215 | $ <span class="fu">git</span> branch -vv | ||
| 216 | <span class="ex">master</span> 029f75f [sebsauvage/master] Update README.md[](.html) | ||
| 217 | <span class="ex">*</span> stable 890afc3 [origin/stable] Merge pull request <span class="co">#509 from ArthurHoaro/v0.6.5[](.html)</span></code></pre></div> | ||
| 218 | <p>Shaarli >= <code>v0.8.x</code>: install/update third-party PHP dependencies using <a href="https://getcomposer.org/">Composer</a>:<a href=".html"></a></p> | ||
| 219 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="ex">composer</span> install --no-dev | ||
| 220 | |||
| 221 | <span class="ex">Loading</span> composer repositories with package information | ||
| 222 | <span class="ex">Updating</span> dependencies | ||
| 223 | <span class="ex">-</span> Installing shaarli/netscape-bookmark-parser (v1.0.1) | ||
| 224 | <span class="ex">Downloading</span>: 100%</code></pre></div> | ||
| 225 | <p>Optionally, you can delete information related to the legacy version:</p> | ||
| 226 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="fu">git</span> branch -D master | ||
| 227 | <span class="ex">Deleted</span> branch master (was 029f75f)<span class="ex">.</span> | ||
| 228 | |||
| 229 | $ <span class="fu">git</span> remote remove sebsauvage | ||
| 230 | |||
| 231 | $ <span class="fu">git</span> remote -v | ||
| 232 | <span class="ex">origin</span> https://github.com/shaarli/Shaarli (fetch) | ||
| 233 | <span class="ex">origin</span> https://github.com/shaarli/Shaarli (push) | ||
| 234 | |||
| 235 | $ <span class="fu">git</span> gc | ||
| 236 | <span class="ex">Counting</span> objects: 3317, done. | ||
| 237 | <span class="ex">Delta</span> compression using up to 8 threads. | ||
| 238 | <span class="ex">Compressing</span> objects: 100% (1237/1237), <span class="kw">done</span><span class="ex">.</span> | ||
| 239 | <span class="ex">Writing</span> objects: 100% (3317/3317), <span class="kw">done</span><span class="ex">.</span> | ||
| 240 | <span class="ex">Total</span> 3317 (delta 2050), <span class="ex">reused</span> 3301 (delta 2034)<span class="ex">to</span></code></pre></div> | ||
| 241 | <h4 id="step-3-configuration">Step 3: configuration</h4> | ||
| 242 | <p>After migrating, access your fresh Shaarli installation from a web browser; the configuration will then be automatically updated, and new settings added to <code>data/config.php</code> (see <a href="Shaarli-configuration.html">Shaarli configuration</a> for more details).</p> | ||
| 243 | <h2 id="troubleshooting">Troubleshooting</h2> | ||
| 244 | <p>If the solutions provided here doesn't work, please open an issue specifying which version you're upgrading from and to.</p> | ||
| 245 | <h3 id="you-must-specify-an-integer-as-a-key">You must specify an integer as a key</h3> | ||
| 246 | <p>In <code>v0.8.1</code> we changed how link keys are handled (from timestamps to incremental integers).<br /> | ||
| 247 | Take a look at <code>data/updates.txt</code> content.</p> | ||
| 248 | <h4 id="updates.txt-contains-updatemethoddatastoreids"><code>updates.txt</code> contains <code>updateMethodDatastoreIds</code></h4> | ||
| 249 | <p>Try to delete it and refresh your page while being logged in.</p> | ||
| 250 | <h4 id="updates.txt-doesnt-exists-or-doesnt-contain-updatemethoddatastoreids"><code>updates.txt</code> doesn't exists or doesn't contain <code>updateMethodDatastoreIds</code></h4> | ||
| 251 | <ol> | ||
| 252 | <li>Create <code>data/updates.txt</code> if it doesn't exist.</li> | ||
| 253 | <li>Paste this string in the update file <code>;updateMethodRenameDashTags;</code></li> | ||
| 254 | <li>Login to Shaarli.</li> | ||
| 255 | <li>Delete the update file.</li> | ||
| 256 | <li>Refresh.</li> | ||
| 257 | </ol> | ||
| 258 | </body> | ||
| 259 | </html> | ||
diff --git a/doc/Usage.html b/doc/Usage.html deleted file mode 100644 index b5855881..00000000 --- a/doc/Usage.html +++ /dev/null | |||
| @@ -1,95 +0,0 @@ | |||
| 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 – Usage</title> | ||
| 8 | <style type="text/css">code{white-space: pre;}</style> | ||
| 9 | <link rel="stylesheet" href="github-markdown.css"> | ||
| 10 | <!--[if lt IE 9]> | ||
| 11 | <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script> | ||
| 12 | <![endif]--> | ||
| 13 | </head> | ||
| 14 | <body> | ||
| 15 | <div id="local-sidebar"> | ||
| 16 | <ul> | ||
| 17 | <li><a href="Home.html">Home</a></li> | ||
| 18 | <li>Setup | ||
| 19 | <ul> | ||
| 20 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 21 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 22 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 23 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 24 | <li><a href="Server-security.html">Server security</a></li> | ||
| 25 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> | ||
| 26 | <li><a href="Plugins.html">Plugins</a></li> | ||
| 27 | </ul></li> | ||
| 28 | <li><a href="Docker.html">Docker</a></li> | ||
| 29 | <li><a href="Usage.html">Usage</a> | ||
| 30 | <ul> | ||
| 31 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> | ||
| 32 | <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li> | ||
| 33 | <li><a href="Firefox-share.html">Firefox share</a></li> | ||
| 34 | <li><a href="RSS-feeds.html">RSS feeds</a></li> | ||
| 35 | <li><a href="REST-API.html">REST API</a></li> | ||
| 36 | </ul></li> | ||
| 37 | <li>How To | ||
| 38 | <ul> | ||
| 39 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | ||
| 40 | <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> | ||
| 41 | <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li> | ||
| 42 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> | ||
| 43 | <li><a href="Datastore-hacks.html">Datastore hacks</a></li> | ||
| 44 | </ul></li> | ||
| 45 | <li><a href="Troubleshooting.html">Troubleshooting</a></li> | ||
| 46 | <li><a href="Development.html">Development</a> | ||
| 47 | <ul> | ||
| 48 | <li><a href="GnuPG-signature.html">GnuPG signature</a></li> | ||
| 49 | <li><a href="Coding-guidelines.html">Coding guidelines</a></li> | ||
| 50 | <li><a href="Directory-structure.html">Directory structure</a></li> | ||
| 51 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> | ||
| 52 | <li><a href="Plugin-System.html">Plugin System</a></li> | ||
| 53 | <li><a href="Release-Shaarli.html">Release Shaarli</a></li> | ||
| 54 | <li><a href="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 55 | <li><a href="Security.html">Security</a></li> | ||
| 56 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 57 | <li><a href="Theming.html">Theming</a></li> | ||
| 58 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 59 | </ul></li> | ||
| 60 | <li>About | ||
| 61 | <ul> | ||
| 62 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 63 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 64 | </ul></li> | ||
| 65 | </ul> | ||
| 66 | </div> | ||
| 67 | <h1 id="usage">Usage</h1> | ||
| 68 | <h3 id="main-features">Main features</h3> | ||
| 69 | <p>Shaarli is intended:</p> | ||
| 70 | <ul> | ||
| 71 | <li>to share, comment and save interesting links and news</li> | ||
| 72 | <li>to bookmark useful/frequent personal links (as private links) and share them between computers</li> | ||
| 73 | <li>as a minimal blog/microblog/writing platform (no character limit)</li> | ||
| 74 | <li>as a read-it-later list (for example items tagged <code>readlater</code>)</li> | ||
| 75 | <li>to draft and save articles/ideas</li> | ||
| 76 | <li>to keep code snippets</li> | ||
| 77 | <li>to keep notes and documentation</li> | ||
| 78 | <li>as a shared clipboard between machines</li> | ||
| 79 | <li>as a todo list</li> | ||
| 80 | <li>to store playlists (e.g. with the <code>music</code> or <code>video</code> tags)</li> | ||
| 81 | <li>to keep extracts/comments from webpages that may disappear</li> | ||
| 82 | <li>to keep track of ongoing discussions (for example items tagged <code>discussion</code>)</li> | ||
| 83 | <li><a href="http://shaarli.chassegnouf.net/?9Efeiw">to feed RSS aggregators</a> (planets) with specific tags<a href=".html"></a></li> | ||
| 84 | <li>to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...)</li> | ||
| 85 | </ul> | ||
| 86 | <h3 id="using-shaarli-as-a-blog-notepad-pastebin...">Using Shaarli as a blog, notepad, pastebin...</h3> | ||
| 87 | <ul> | ||
| 88 | <li>Go to your Shaarli setup and log in</li> | ||
| 89 | <li>Click the <code>Add Link</code> button</li> | ||
| 90 | <li>To share text only, do not enter any URL in the corresponding input field and click <code>Add Link</code></li> | ||
| 91 | <li>Pick a title and enter your article, or note, in the description field; add a few tags; optionally check <code>Private</code> then click <code>Save</code></li> | ||
| 92 | <li>Voilà! Your article is now published (privately if you selected that option) and accessible using its permalink.</li> | ||
| 93 | </ul> | ||
| 94 | </body> | ||
| 95 | </html> | ||
diff --git a/doc/Versioning-and-Branches.html b/doc/Versioning-and-Branches.html deleted file mode 100644 index 4dfe4a91..00000000 --- a/doc/Versioning-and-Branches.html +++ /dev/null | |||
| @@ -1,156 +0,0 @@ | |||
| 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 – Versioning and Branches</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>Setup | ||
| 56 | <ul> | ||
| 57 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 58 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 59 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 60 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 61 | <li><a href="Server-security.html">Server security</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 | <li><a href="REST-API.html">REST API</a></li> | ||
| 73 | </ul></li> | ||
| 74 | <li>How To | ||
| 75 | <ul> | ||
| 76 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</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="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 92 | <li><a href="Security.html">Security</a></li> | ||
| 93 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 94 | <li><a href="Theming.html">Theming</a></li> | ||
| 95 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 96 | </ul></li> | ||
| 97 | <li>About | ||
| 98 | <ul> | ||
| 99 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 100 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 101 | </ul></li> | ||
| 102 | </ul> | ||
| 103 | </div> | ||
| 104 | <h1 id="versioning-and-branches">Versioning and Branches</h1> | ||
| 105 | <p>[<strong>WORK IN PROGRESS</strong>][](.html)</p> | ||
| 106 | <p>It's important to understand how Shaarli branches work, especially if you're maintaining a 3rd party tools for Shaarli (theme, plugin, etc.), to be sure stay compatible.</p> | ||
| 107 | <h2 id="master-branch"><code>master</code> branch</h2> | ||
| 108 | <p>The <code>master</code> branch is the development branch. Any new change MUST go through this branch using Pull Requests.</p> | ||
| 109 | <p>Remarks:</p> | ||
| 110 | <ul> | ||
| 111 | <li>This branch shouldn't be used for production as it isn't necessary stable.</li> | ||
| 112 | <li>3rd party aren't required to be compatible with the latest changes.</li> | ||
| 113 | <li>Official plugins, themes and libraries (contained within Shaarli organization repos) must be compatible with the master branch.</li> | ||
| 114 | <li>The version in this branch is always <code>dev</code>.</li> | ||
| 115 | </ul> | ||
| 116 | <h2 id="v0.x-branch"><code>v0.x</code> branch</h2> | ||
| 117 | <p>This <code>v0.x</code> branch, points to the latest <code>v0.x.y</code> release.</p> | ||
| 118 | <p>Explanation:</p> | ||
| 119 | <p>When a new version is released, it might contains a major bug which isn't detected right away. For example, a new PHP version is released, containing backward compatibility issue which doesn't work with Shaarli.</p> | ||
| 120 | <p>In this case, the issue is fixed in the <code>master</code> branch, and the fix is backported the to the <code>v0.x</code> branch. Then a new release is made from the <code>v0.x</code> branch.</p> | ||
| 121 | <p>This workflow allow us to fix any major bug detected, without having to release bleeding edge feature too soon.</p> | ||
| 122 | <h2 id="latest-branch"><code>latest</code> branch</h2> | ||
| 123 | <p>This branch point the latest release. It recommended to use it to get the latest tested changes.</p> | ||
| 124 | <h2 id="stable-branch"><code>stable</code> branch</h2> | ||
| 125 | <p>The <code>stable</code> branch doesn't contain any major bug, and is one major digit version behind the latest release.</p> | ||
| 126 | <p>For example, the current latest release is <code>v0.8.3</code>, the stable branch is an alias to the latest <code>v0.7.x</code> release. When the <code>v0.9.0</code> version will be released, the stable will move to the latest <code>v0.8.x</code> release.</p> | ||
| 127 | <p>Remarks:</p> | ||
| 128 | <ul> | ||
| 129 | <li>Shaarli release pace isn't fast, and the stable branch might be a few months behind the latest release.</li> | ||
| 130 | </ul> | ||
| 131 | <h2 id="releases">Releases</h2> | ||
| 132 | <p>Releases are always made from the latest <code>v0.x</code> branch.</p> | ||
| 133 | <p>Note that for every release, we manually generate a tarball which contains all Shaarli dependencies, making Shaarli's installation only one step.</p> | ||
| 134 | <h2 id="advices-on-3rd-party-git-repos-workflow">Advices on 3rd party git repos workflow</h2> | ||
| 135 | <h3 id="versioning">Versioning</h3> | ||
| 136 | <p>Any time a new Shaarli release is published, you should publish a new release of your repo if the changes affected you since the latest release (take a look at the <a href="https://github.com/shaarli/Shaarli/releases">changelog</a> (<em>Draft</em> means not released yet) and the commit log (like <a href="https://github.com/shaarli/Shaarli/commits/master/tpl/default"><code>tpl</code> folder</a> for themes)). You can either:<a href=".html"></a></p> | ||
| 137 | <ul> | ||
| 138 | <li>use the Shaarli version number, with your repo version. For example, if Shaarli <code>v0.8.3</code> is released, publish a <code>v0.8.3-1</code> release, where <code>v0.8.3</code> states Shaarli compatibility and <code>-1</code> is your own version digit for the current Shaarli version.</li> | ||
| 139 | <li>use your own versioning scheme, and state Shaarli compatibility in the release description.</li> | ||
| 140 | </ul> | ||
| 141 | <p>Using this, any user will be able to pick the release matching his own Shaarli version.</p> | ||
| 142 | <h3 id="major-bugfix-backport-releases">Major bugfix backport releases</h3> | ||
| 143 | <p>To be able to support backported fixes, it recommended to use our workflow:</p> | ||
| 144 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># In master, fix the major bug</span> | ||
| 145 | <span class="fu">git</span> commit -m <span class="st">"Katastrophe"</span> | ||
| 146 | <span class="fu">git</span> push origin master | ||
| 147 | <span class="co"># Get your commit hash</span> | ||
| 148 | <span class="fu">git</span> log --format=<span class="st">"%H"</span> -n 1 | ||
| 149 | <span class="co"># Create a new branch from your latest release, let's say v0.8.2-1 (the tag name)</span> | ||
| 150 | <span class="fu">git</span> checkout -b katastrophe v0.8.2-1 | ||
| 151 | <span class="co"># Backport the fix commit to your brand new branch</span> | ||
| 152 | <span class="fu">git</span> cherry-pick <span class="op"><</span>fix commit hash<span class="op">></span> | ||
| 153 | <span class="fu">git</span> push origin katastrophe | ||
| 154 | <span class="co"># Then you just have to make a new release from the `katastrophe` branch tagged `v0.8.3-1`</span></code></pre></div> | ||
| 155 | </body> | ||
| 156 | </html> | ||
diff --git a/doc/_Footer.html b/doc/_Footer.html deleted file mode 100644 index 09473a38..00000000 --- a/doc/_Footer.html +++ /dev/null | |||
| @@ -1,70 +0,0 @@ | |||
| 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 – _Footer</title> | ||
| 8 | <style type="text/css">code{white-space: pre;}</style> | ||
| 9 | <link rel="stylesheet" href="github-markdown.css"> | ||
| 10 | <!--[if lt IE 9]> | ||
| 11 | <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script> | ||
| 12 | <![endif]--> | ||
| 13 | </head> | ||
| 14 | <body> | ||
| 15 | <div id="local-sidebar"> | ||
| 16 | <ul> | ||
| 17 | <li><a href="Home.html">Home</a></li> | ||
| 18 | <li>Setup | ||
| 19 | <ul> | ||
| 20 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 21 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 22 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 23 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 24 | <li><a href="Server-security.html">Server security</a></li> | ||
| 25 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> | ||
| 26 | <li><a href="Plugins.html">Plugins</a></li> | ||
| 27 | </ul></li> | ||
| 28 | <li><a href="Docker.html">Docker</a></li> | ||
| 29 | <li><a href="Usage.html">Usage</a> | ||
| 30 | <ul> | ||
| 31 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> | ||
| 32 | <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li> | ||
| 33 | <li><a href="Firefox-share.html">Firefox share</a></li> | ||
| 34 | <li><a href="RSS-feeds.html">RSS feeds</a></li> | ||
| 35 | <li><a href="REST-API.html">REST API</a></li> | ||
| 36 | </ul></li> | ||
| 37 | <li>How To | ||
| 38 | <ul> | ||
| 39 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | ||
| 40 | <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> | ||
| 41 | <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li> | ||
| 42 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> | ||
| 43 | <li><a href="Datastore-hacks.html">Datastore hacks</a></li> | ||
| 44 | </ul></li> | ||
| 45 | <li><a href="Troubleshooting.html">Troubleshooting</a></li> | ||
| 46 | <li><a href="Development.html">Development</a> | ||
| 47 | <ul> | ||
| 48 | <li><a href="GnuPG-signature.html">GnuPG signature</a></li> | ||
| 49 | <li><a href="Coding-guidelines.html">Coding guidelines</a></li> | ||
| 50 | <li><a href="Directory-structure.html">Directory structure</a></li> | ||
| 51 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> | ||
| 52 | <li><a href="Plugin-System.html">Plugin System</a></li> | ||
| 53 | <li><a href="Release-Shaarli.html">Release Shaarli</a></li> | ||
| 54 | <li><a href="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 55 | <li><a href="Security.html">Security</a></li> | ||
| 56 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 57 | <li><a href="Theming.html">Theming</a></li> | ||
| 58 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 59 | </ul></li> | ||
| 60 | <li>About | ||
| 61 | <ul> | ||
| 62 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 63 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 64 | </ul></li> | ||
| 65 | </ul> | ||
| 66 | </div> | ||
| 67 | <h1 id="footer-shaarli-the-personal-minimalist-super-fast-database-free-bookmarking-service">_Footer<br /> | ||
| 68 | <em>Shaarli, the personal, minimalist, super-fast, database-free bookmarking service</em></h1> | ||
| 69 | </body> | ||
| 70 | </html> | ||
diff --git a/doc/_Sidebar.html b/doc/_Sidebar.html deleted file mode 100644 index d3f94560..00000000 --- a/doc/_Sidebar.html +++ /dev/null | |||
| @@ -1,119 +0,0 @@ | |||
| 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 – _Sidebar</title> | ||
| 8 | <style type="text/css">code{white-space: pre;}</style> | ||
| 9 | <link rel="stylesheet" href="github-markdown.css"> | ||
| 10 | <!--[if lt IE 9]> | ||
| 11 | <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script> | ||
| 12 | <![endif]--> | ||
| 13 | </head> | ||
| 14 | <body> | ||
| 15 | <div id="local-sidebar"> | ||
| 16 | <ul> | ||
| 17 | <li><a href="Home.html">Home</a></li> | ||
| 18 | <li>Setup | ||
| 19 | <ul> | ||
| 20 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 21 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 22 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 23 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 24 | <li><a href="Server-security.html">Server security</a></li> | ||
| 25 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> | ||
| 26 | <li><a href="Plugins.html">Plugins</a></li> | ||
| 27 | </ul></li> | ||
| 28 | <li><a href="Docker.html">Docker</a></li> | ||
| 29 | <li><a href="Usage.html">Usage</a> | ||
| 30 | <ul> | ||
| 31 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> | ||
| 32 | <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li> | ||
| 33 | <li><a href="Firefox-share.html">Firefox share</a></li> | ||
| 34 | <li><a href="RSS-feeds.html">RSS feeds</a></li> | ||
| 35 | <li><a href="REST-API.html">REST API</a></li> | ||
| 36 | </ul></li> | ||
| 37 | <li>How To | ||
| 38 | <ul> | ||
| 39 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | ||
| 40 | <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> | ||
| 41 | <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li> | ||
| 42 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> | ||
| 43 | <li><a href="Datastore-hacks.html">Datastore hacks</a></li> | ||
| 44 | </ul></li> | ||
| 45 | <li><a href="Troubleshooting.html">Troubleshooting</a></li> | ||
| 46 | <li><a href="Development.html">Development</a> | ||
| 47 | <ul> | ||
| 48 | <li><a href="GnuPG-signature.html">GnuPG signature</a></li> | ||
| 49 | <li><a href="Coding-guidelines.html">Coding guidelines</a></li> | ||
| 50 | <li><a href="Directory-structure.html">Directory structure</a></li> | ||
| 51 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> | ||
| 52 | <li><a href="Plugin-System.html">Plugin System</a></li> | ||
| 53 | <li><a href="Release-Shaarli.html">Release Shaarli</a></li> | ||
| 54 | <li><a href="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 55 | <li><a href="Security.html">Security</a></li> | ||
| 56 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 57 | <li><a href="Theming.html">Theming</a></li> | ||
| 58 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 59 | </ul></li> | ||
| 60 | <li>About | ||
| 61 | <ul> | ||
| 62 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 63 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 64 | </ul></li> | ||
| 65 | </ul> | ||
| 66 | </div> | ||
| 67 | <h1 id="sidebar">_Sidebar</h1> | ||
| 68 | <ul> | ||
| 69 | <li><a href="Home.html">Home</a></li> | ||
| 70 | <li>Setup | ||
| 71 | <ul> | ||
| 72 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 73 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 74 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 75 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 76 | <li><a href="Server-security.html">Server security</a></li> | ||
| 77 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> | ||
| 78 | <li><a href="Plugins.html">Plugins</a></li> | ||
| 79 | </ul></li> | ||
| 80 | <li><a href="Docker.html">Docker</a></li> | ||
| 81 | <li><a href="Usage.html">Usage</a> | ||
| 82 | <ul> | ||
| 83 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> | ||
| 84 | <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li> | ||
| 85 | <li><a href="Firefox-share.html">Firefox share</a></li> | ||
| 86 | <li><a href="RSS-feeds.html">RSS feeds</a></li> | ||
| 87 | <li><a href="REST-API.html">REST API</a></li> | ||
| 88 | </ul></li> | ||
| 89 | <li>How To | ||
| 90 | <ul> | ||
| 91 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | ||
| 92 | <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> | ||
| 93 | <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li> | ||
| 94 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> | ||
| 95 | <li><a href="Datastore-hacks.html">Datastore hacks</a></li> | ||
| 96 | </ul></li> | ||
| 97 | <li><a href="Troubleshooting.html">Troubleshooting</a></li> | ||
| 98 | <li><a href="Development.html">Development</a> | ||
| 99 | <ul> | ||
| 100 | <li><a href="GnuPG-signature.html">GnuPG signature</a></li> | ||
| 101 | <li><a href="Coding-guidelines.html">Coding guidelines</a></li> | ||
| 102 | <li><a href="Directory-structure.html">Directory structure</a></li> | ||
| 103 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> | ||
| 104 | <li><a href="Plugin-System.html">Plugin System</a></li> | ||
| 105 | <li><a href="Release-Shaarli.html">Release Shaarli</a></li> | ||
| 106 | <li><a href="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 107 | <li><a href="Security.html">Security</a></li> | ||
| 108 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 109 | <li><a href="Theming.html">Theming</a></li> | ||
| 110 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 111 | </ul></li> | ||
| 112 | <li>About | ||
| 113 | <ul> | ||
| 114 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 115 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 116 | </ul></li> | ||
| 117 | </ul> | ||
| 118 | </body> | ||
| 119 | </html> | ||
diff --git a/doc/html/3rd-party-libraries/index.html b/doc/html/3rd-party-libraries/index.html new file mode 100644 index 00000000..c54c45f5 --- /dev/null +++ b/doc/html/3rd-party-libraries/index.html | |||
| @@ -0,0 +1,369 @@ | |||
| 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>3rd party libraries - 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 = "3rd party libraries"; | ||
| 22 | var mkdocs_page_input_path = "3rd-party-libraries.md"; | ||
| 23 | var mkdocs_page_url = "/3rd-party-libraries/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="../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="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 156 | </li> | ||
| 157 | <li class=""> | ||
| 158 | |||
| 159 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 160 | </li> | ||
| 161 | <li class=""> | ||
| 162 | |||
| 163 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 164 | </li> | ||
| 165 | <li class=""> | ||
| 166 | |||
| 167 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 168 | </li> | ||
| 169 | </ul> | ||
| 170 | </li> | ||
| 171 | |||
| 172 | <li class="toctree-l1"> | ||
| 173 | |||
| 174 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 175 | </li> | ||
| 176 | |||
| 177 | <li class="toctree-l1"> | ||
| 178 | |||
| 179 | <span class="caption-text">Development</span> | ||
| 180 | <ul class="subnav"> | ||
| 181 | <li class=""> | ||
| 182 | |||
| 183 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 184 | </li> | ||
| 185 | <li class=""> | ||
| 186 | |||
| 187 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 188 | </li> | ||
| 189 | <li class=""> | ||
| 190 | |||
| 191 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 192 | </li> | ||
| 193 | <li class=""> | ||
| 194 | |||
| 195 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 196 | </li> | ||
| 197 | <li class=""> | ||
| 198 | |||
| 199 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 200 | </li> | ||
| 201 | <li class=" current"> | ||
| 202 | |||
| 203 | <a class="current" href="./">3rd party libraries</a> | ||
| 204 | <ul class="subnav"> | ||
| 205 | |||
| 206 | <li class="toctree-l3"><a href="#css">CSS</a></li> | ||
| 207 | |||
| 208 | |||
| 209 | <li class="toctree-l3"><a href="#javascript">Javascript</a></li> | ||
| 210 | |||
| 211 | |||
| 212 | <li class="toctree-l3"><a href="#php">PHP</a></li> | ||
| 213 | |||
| 214 | |||
| 215 | </ul> | ||
| 216 | </li> | ||
| 217 | <li class=""> | ||
| 218 | |||
| 219 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 220 | </li> | ||
| 221 | <li class=""> | ||
| 222 | |||
| 223 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 224 | </li> | ||
| 225 | <li class=""> | ||
| 226 | |||
| 227 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 228 | </li> | ||
| 229 | <li class=""> | ||
| 230 | |||
| 231 | <a class="" href="../Security/">Security</a> | ||
| 232 | </li> | ||
| 233 | <li class=""> | ||
| 234 | |||
| 235 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 236 | </li> | ||
| 237 | <li class=""> | ||
| 238 | |||
| 239 | <a class="" href="../Theming/">Theming</a> | ||
| 240 | </li> | ||
| 241 | <li class=""> | ||
| 242 | |||
| 243 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 244 | </li> | ||
| 245 | </ul> | ||
| 246 | </li> | ||
| 247 | |||
| 248 | <li class="toctree-l1"> | ||
| 249 | |||
| 250 | <span class="caption-text">About</span> | ||
| 251 | <ul class="subnav"> | ||
| 252 | <li class=""> | ||
| 253 | |||
| 254 | <a class="" href="../FAQ/">FAQ</a> | ||
| 255 | </li> | ||
| 256 | <li class=""> | ||
| 257 | |||
| 258 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 259 | </li> | ||
| 260 | </ul> | ||
| 261 | </li> | ||
| 262 | |||
| 263 | </ul> | ||
| 264 | </div> | ||
| 265 | | ||
| 266 | </nav> | ||
| 267 | |||
| 268 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 269 | |||
| 270 | |||
| 271 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 272 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 273 | <a href="..">Shaarli Documentation</a> | ||
| 274 | </nav> | ||
| 275 | |||
| 276 | |||
| 277 | <div class="wy-nav-content"> | ||
| 278 | <div class="rst-content"> | ||
| 279 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 280 | <ul class="wy-breadcrumbs"> | ||
| 281 | <li><a href="..">Docs</a> »</li> | ||
| 282 | |||
| 283 | |||
| 284 | |||
| 285 | <li>Development »</li> | ||
| 286 | |||
| 287 | |||
| 288 | |||
| 289 | <li>3rd party libraries</li> | ||
| 290 | <li class="wy-breadcrumbs-aside"> | ||
| 291 | |||
| 292 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/3rd-party-libraries.md" | ||
| 293 | class="icon icon-github"> Edit on GitHub</a> | ||
| 294 | |||
| 295 | </li> | ||
| 296 | </ul> | ||
| 297 | <hr/> | ||
| 298 | </div> | ||
| 299 | <div role="main"> | ||
| 300 | <div class="section"> | ||
| 301 | |||
| 302 | <h2 id="css">CSS</h2> | ||
| 303 | <ul> | ||
| 304 | <li>Yahoo UI <a href="http://yuilibrary.com/yui/docs/cssreset/">CSS Reset</a><ul> | ||
| 305 | <li>resets default CSS properties for all HTML elements (overriding browsers' default values)</li> | ||
| 306 | <li>ensures custom CSS stylessheets will provide the same results on all browsers</li> | ||
| 307 | </ul> | ||
| 308 | </li> | ||
| 309 | </ul> | ||
| 310 | <h2 id="javascript">Javascript</h2> | ||
| 311 | <ul> | ||
| 312 | <li><a href="https://leaverou.github.io/awesomplete/">Awesomeplete</a> (<a href="https://github.com/LeaVerou/awesomplete">GitHub</a>) - autocompletion in input forms</li> | ||
| 313 | <li><a href="http://dinbror.dk/blazy/">bLazy</a> (<a href="https://github.com/dinbror/blazy">GitHub</a>) - lazy loading for thumbnails</li> | ||
| 314 | <li><a href="http://neocotic.com/qr.js/">qr.js</a> (<a href="https://github.com/neocotic/qr.js">GitHub</a>) - QR code generation</li> | ||
| 315 | </ul> | ||
| 316 | <h2 id="php">PHP</h2> | ||
| 317 | <ul> | ||
| 318 | <li><a href="https://github.com/shaarli/netscape-bookmark-parser">shaarli/netscape-bookmark-parser</a> - Netscape bookmark parser</li> | ||
| 319 | <li><a href="https://github.com/rainphp/raintpl">RainTPL</a> - HTML templating for PHP</li> | ||
| 320 | </ul> | ||
| 321 | |||
| 322 | </div> | ||
| 323 | </div> | ||
| 324 | <footer> | ||
| 325 | |||
| 326 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 327 | |||
| 328 | <a href="../Plugin-System/" class="btn btn-neutral float-right" title="Plugin System">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 329 | |||
| 330 | |||
| 331 | <a href="../Directory-structure/" class="btn btn-neutral" title="Directory structure"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 332 | |||
| 333 | </div> | ||
| 334 | |||
| 335 | |||
| 336 | <hr/> | ||
| 337 | |||
| 338 | <div role="contentinfo"> | ||
| 339 | <!-- Copyright etc --> | ||
| 340 | |||
| 341 | </div> | ||
| 342 | |||
| 343 | 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>. | ||
| 344 | </footer> | ||
| 345 | |||
| 346 | </div> | ||
| 347 | </div> | ||
| 348 | |||
| 349 | </section> | ||
| 350 | |||
| 351 | </div> | ||
| 352 | |||
| 353 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 354 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 355 | |||
| 356 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 357 | |||
| 358 | |||
| 359 | <span><a href="../Directory-structure/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 360 | |||
| 361 | |||
| 362 | <span style="margin-left: 15px"><a href="../Plugin-System/" style="color: #fcfcfc">Next »</a></span> | ||
| 363 | |||
| 364 | </span> | ||
| 365 | </div> | ||
| 366 | <script src="../js/theme.js"></script> | ||
| 367 | |||
| 368 | </body> | ||
| 369 | </html> | ||
diff --git a/doc/html/Backup,-restore,-import-and-export/index.html b/doc/html/Backup,-restore,-import-and-export/index.html new file mode 100644 index 00000000..ceb80170 --- /dev/null +++ b/doc/html/Backup,-restore,-import-and-export/index.html | |||
| @@ -0,0 +1,411 @@ | |||
| 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>Backup, restore, import and export - 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 = "Backup, restore, import and export"; | ||
| 22 | var mkdocs_page_input_path = "Backup,-restore,-import-and-export.md"; | ||
| 23 | var mkdocs_page_url = "/Backup,-restore,-import-and-export/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="../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=" current"> | ||
| 150 | |||
| 151 | <a class="current" href="./">Backup, restore, import and export</a> | ||
| 152 | <ul class="subnav"> | ||
| 153 | |||
| 154 | <li class="toctree-l3"><a href="#backup-and-restore-the-datastore-file">Backup and restore the datastore file</a></li> | ||
| 155 | |||
| 156 | |||
| 157 | <li class="toctree-l3"><a href="#export-links-as">Export links as...</a></li> | ||
| 158 | |||
| 159 | |||
| 160 | <li class="toctree-l3"><a href="#import-links-from">Import links from...</a></li> | ||
| 161 | |||
| 162 | <ul> | ||
| 163 | |||
| 164 | <li><a class="toctree-l4" href="#diigo">Diigo</a></li> | ||
| 165 | |||
| 166 | <li><a class="toctree-l4" href="#mister-wong">Mister Wong</a></li> | ||
| 167 | |||
| 168 | <li><a class="toctree-l4" href="#semanticscuttle">SemanticScuttle</a></li> | ||
| 169 | |||
| 170 | <li><a class="toctree-l4" href="#scuttle">Scuttle</a></li> | ||
| 171 | |||
| 172 | </ul> | ||
| 173 | |||
| 174 | |||
| 175 | <li class="toctree-l3"><a href="#import-shaarli-links-to-firefox">Import Shaarli links to Firefox</a></li> | ||
| 176 | |||
| 177 | |||
| 178 | </ul> | ||
| 179 | </li> | ||
| 180 | <li class=""> | ||
| 181 | |||
| 182 | <a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 183 | </li> | ||
| 184 | <li class=""> | ||
| 185 | |||
| 186 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 187 | </li> | ||
| 188 | <li class=""> | ||
| 189 | |||
| 190 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 191 | </li> | ||
| 192 | <li class=""> | ||
| 193 | |||
| 194 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 195 | </li> | ||
| 196 | </ul> | ||
| 197 | </li> | ||
| 198 | |||
| 199 | <li class="toctree-l1"> | ||
| 200 | |||
| 201 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 202 | </li> | ||
| 203 | |||
| 204 | <li class="toctree-l1"> | ||
| 205 | |||
| 206 | <span class="caption-text">Development</span> | ||
| 207 | <ul class="subnav"> | ||
| 208 | <li class=""> | ||
| 209 | |||
| 210 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 211 | </li> | ||
| 212 | <li class=""> | ||
| 213 | |||
| 214 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 215 | </li> | ||
| 216 | <li class=""> | ||
| 217 | |||
| 218 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 219 | </li> | ||
| 220 | <li class=""> | ||
| 221 | |||
| 222 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 223 | </li> | ||
| 224 | <li class=""> | ||
| 225 | |||
| 226 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 227 | </li> | ||
| 228 | <li class=""> | ||
| 229 | |||
| 230 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 231 | </li> | ||
| 232 | <li class=""> | ||
| 233 | |||
| 234 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 235 | </li> | ||
| 236 | <li class=""> | ||
| 237 | |||
| 238 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 239 | </li> | ||
| 240 | <li class=""> | ||
| 241 | |||
| 242 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 243 | </li> | ||
| 244 | <li class=""> | ||
| 245 | |||
| 246 | <a class="" href="../Security/">Security</a> | ||
| 247 | </li> | ||
| 248 | <li class=""> | ||
| 249 | |||
| 250 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 251 | </li> | ||
| 252 | <li class=""> | ||
| 253 | |||
| 254 | <a class="" href="../Theming/">Theming</a> | ||
| 255 | </li> | ||
| 256 | <li class=""> | ||
| 257 | |||
| 258 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 259 | </li> | ||
| 260 | </ul> | ||
| 261 | </li> | ||
| 262 | |||
| 263 | <li class="toctree-l1"> | ||
| 264 | |||
| 265 | <span class="caption-text">About</span> | ||
| 266 | <ul class="subnav"> | ||
| 267 | <li class=""> | ||
| 268 | |||
| 269 | <a class="" href="../FAQ/">FAQ</a> | ||
| 270 | </li> | ||
| 271 | <li class=""> | ||
| 272 | |||
| 273 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 274 | </li> | ||
| 275 | </ul> | ||
| 276 | </li> | ||
| 277 | |||
| 278 | </ul> | ||
| 279 | </div> | ||
| 280 | | ||
| 281 | </nav> | ||
| 282 | |||
| 283 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 284 | |||
| 285 | |||
| 286 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 287 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 288 | <a href="..">Shaarli Documentation</a> | ||
| 289 | </nav> | ||
| 290 | |||
| 291 | |||
| 292 | <div class="wy-nav-content"> | ||
| 293 | <div class="rst-content"> | ||
| 294 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 295 | <ul class="wy-breadcrumbs"> | ||
| 296 | <li><a href="..">Docs</a> »</li> | ||
| 297 | |||
| 298 | |||
| 299 | |||
| 300 | <li>How To »</li> | ||
| 301 | |||
| 302 | |||
| 303 | |||
| 304 | <li>Backup, restore, import and export</li> | ||
| 305 | <li class="wy-breadcrumbs-aside"> | ||
| 306 | |||
| 307 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Backup,-restore,-import-and-export.md" | ||
| 308 | class="icon icon-github"> Edit on GitHub</a> | ||
| 309 | |||
| 310 | </li> | ||
| 311 | </ul> | ||
| 312 | <hr/> | ||
| 313 | </div> | ||
| 314 | <div role="main"> | ||
| 315 | <div class="section"> | ||
| 316 | |||
| 317 | <ul> | ||
| 318 | <li><a href="#backup-and-restore-the-datastore-file">Backup and restore the datastore file</a></li> | ||
| 319 | <li><a href="#export-links-as">Export links as...</a></li> | ||
| 320 | <li><a href="#import-links-from">Import links from...</a></li> | ||
| 321 | <li><a href="#import-shaarli-links-to-firefox">Import Shaarli links to Firefox</a></li> | ||
| 322 | </ul> | ||
| 323 | <hr /> | ||
| 324 | <h2 id="backup-and-restore-the-datastore-file">Backup and restore the datastore file</h2> | ||
| 325 | <p>Backup the file <code>data/datastore.php</code> (by FTP or SSH). Restore by putting the file back in place.</p> | ||
| 326 | <p>Example command:</p> | ||
| 327 | <pre><code class="bash">rsync -avzP my.server.com:/var/www/shaarli/data/datastore.php datastore-$(date +%Y-%m-%d_%H%M).php | ||
| 328 | </code></pre> | ||
| 329 | |||
| 330 | <h2 id="export-links-as">Export links as...</h2> | ||
| 331 | <p>To export links as an HTML file, under <em>Tools > Export</em>, choose: | ||
| 332 | - <em>Export all</em> to export both public and private links | ||
| 333 | - <em>Export public</em> to export public links only | ||
| 334 | - <em>Export private</em> to export private links only</p> | ||
| 335 | <p>Restore by using the <code>Import</code> feature. | ||
| 336 | * This can be done using the <a href="https://github.com/nodiscc/shaarchiver">shaarchiver</a> tool.</p> | ||
| 337 | <p>Example command: </p> | ||
| 338 | <pre><code class="bash">./export-bookmarks.py --url=https://my.server.com/shaarli --username=myusername --password=mysupersecretpassword --download-dir=./ --type=all | ||
| 339 | </code></pre> | ||
| 340 | |||
| 341 | <h2 id="import-links-from">Import links from...</h2> | ||
| 342 | <h3 id="diigo">Diigo</h3> | ||
| 343 | <p>If you export your bookmark from Diigo, make sure you use the Delicious export, not the Netscape export. (Their Netscape export is broken, and they don't seem to be interested in fixing it.)</p> | ||
| 344 | <h3 id="mister-wong">Mister Wong</h3> | ||
| 345 | <p>See <a href="https://github.com/sebsauvage/Shaarli/issues/146">this issue</a> for import tweaks.</p> | ||
| 346 | <h3 id="semanticscuttle">SemanticScuttle</h3> | ||
| 347 | <p>To correctly import the tags from a <a href="http://semanticscuttle.sourceforge.net/">SemanticScuttle</a> HTML export, edit the HTML file before importing and replace all occurences of <code>tags=</code> (lowercase) to <code>TAGS=</code> (uppercase).</p> | ||
| 348 | <h3 id="scuttle">Scuttle</h3> | ||
| 349 | <p>Shaarli cannot import data directly from <a href="https://github.com/scronide/scuttle">Scuttle</a>. However, you can use this third party tool: https://github.com/q2apro/scuttle-to-shaarli to export the Scuttle database to the Netscape HTML format compatible with the Shaarli importer.</p> | ||
| 350 | <h2 id="import-shaarli-links-to-firefox">Import Shaarli links to Firefox</h2> | ||
| 351 | <ul> | ||
| 352 | <li>Export your Shaarli links as described above.</li> | ||
| 353 | <li>For compatibility reasons, check <code>Prepend note permalinks with this Shaarli instance's URL (useful to import bookmarks in a web browser)</code></li> | ||
| 354 | <li>In Firefox, open the bookmark manager (not the sidebar! <code>Bookmarks menu > Show all bookmarks</code> or <code>Ctrl+Shift+B</code>)</li> | ||
| 355 | <li>Select <code>Import and Backup > Import bookmarks in HTML format</code></li> | ||
| 356 | </ul> | ||
| 357 | <p>Your bookmarks will be imported in Firefox, ready to use, with tags and descriptions retained. "Self" (notes) shaares will still point to the Shaarli instance you exported them from, but the note text can be viewed directly in the bookmark properties inside your browser. Depending on the number of bookmarks, the import can take some time.</p> | ||
| 358 | <p>You may be interested in these Firefox addons to manage links imported from Shaarli</p> | ||
| 359 | <ul> | ||
| 360 | <li><a href="https://addons.mozilla.org/en-US/firefox/addon/bookmark-deduplicator/">Bookmark Deduplicator</a> - provides an easy way to deduplicate your bookmarks</li> | ||
| 361 | <li><a href="https://addons.mozilla.org/en-US/firefox/addon/tagsieve/">TagSieve</a> - browse your bookmarks by their tags</li> | ||
| 362 | </ul> | ||
| 363 | |||
| 364 | </div> | ||
| 365 | </div> | ||
| 366 | <footer> | ||
| 367 | |||
| 368 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 369 | |||
| 370 | <a href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/" class="btn btn-neutral float-right" title="Copy an existing installation over SSH and serve it locally">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 371 | |||
| 372 | |||
| 373 | <a href="../REST-API/" class="btn btn-neutral" title="REST API"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 374 | |||
| 375 | </div> | ||
| 376 | |||
| 377 | |||
| 378 | <hr/> | ||
| 379 | |||
| 380 | <div role="contentinfo"> | ||
| 381 | <!-- Copyright etc --> | ||
| 382 | |||
| 383 | </div> | ||
| 384 | |||
| 385 | 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>. | ||
| 386 | </footer> | ||
| 387 | |||
| 388 | </div> | ||
| 389 | </div> | ||
| 390 | |||
| 391 | </section> | ||
| 392 | |||
| 393 | </div> | ||
| 394 | |||
| 395 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 396 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 397 | |||
| 398 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 399 | |||
| 400 | |||
| 401 | <span><a href="../REST-API/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 402 | |||
| 403 | |||
| 404 | <span style="margin-left: 15px"><a href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/" style="color: #fcfcfc">Next »</a></span> | ||
| 405 | |||
| 406 | </span> | ||
| 407 | </div> | ||
| 408 | <script src="../js/theme.js"></script> | ||
| 409 | |||
| 410 | </body> | ||
| 411 | </html> | ||
diff --git a/doc/html/Bookmarklet/index.html b/doc/html/Bookmarklet/index.html new file mode 100644 index 00000000..e7a370b6 --- /dev/null +++ b/doc/html/Bookmarklet/index.html | |||
| @@ -0,0 +1,375 @@ | |||
| 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>Bookmarklet - 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 = "Bookmarklet"; | ||
| 22 | var mkdocs_page_input_path = "Bookmarklet.md"; | ||
| 23 | var mkdocs_page_url = "/Bookmarklet/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="../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=" current"> | ||
| 123 | |||
| 124 | <a class="current" href="./">Bookmarklet</a> | ||
| 125 | <ul class="subnav"> | ||
| 126 | |||
| 127 | <li class="toctree-l3"><a href="#add-the-sharing-button-bookmarklet-to-your-browser">Add the sharing button (bookmarklet) to your browser</a></li> | ||
| 128 | |||
| 129 | |||
| 130 | <li class="toctree-l3"><a href="#share-links-using-the-bookmarklet">Share links using the bookmarklet</a></li> | ||
| 131 | |||
| 132 | |||
| 133 | <li class="toctree-l3"><a href="#troubleshooting-the-bookmarklet-doesnt-work-with-a-few-website-eg-githubcom">Troubleshooting: The bookmarklet doesn't work with a few website (e.g. Github.com)</a></li> | ||
| 134 | |||
| 135 | |||
| 136 | </ul> | ||
| 137 | </li> | ||
| 138 | <li class=""> | ||
| 139 | |||
| 140 | <a class="" href="../Browsing-and-searching/">Browsing and searching</a> | ||
| 141 | </li> | ||
| 142 | <li class=""> | ||
| 143 | |||
| 144 | <a class="" href="../Firefox-share/">Firefox share</a> | ||
| 145 | </li> | ||
| 146 | <li class=""> | ||
| 147 | |||
| 148 | <a class="" href="../RSS-feeds/">RSS feeds</a> | ||
| 149 | </li> | ||
| 150 | <li class=""> | ||
| 151 | |||
| 152 | <a class="" href="../REST-API/">REST API</a> | ||
| 153 | </li> | ||
| 154 | </ul> | ||
| 155 | </li> | ||
| 156 | |||
| 157 | <li class="toctree-l1"> | ||
| 158 | |||
| 159 | <span class="caption-text">How To</span> | ||
| 160 | <ul class="subnav"> | ||
| 161 | <li class=""> | ||
| 162 | |||
| 163 | <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a> | ||
| 164 | </li> | ||
| 165 | <li class=""> | ||
| 166 | |||
| 167 | <a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 168 | </li> | ||
| 169 | <li class=""> | ||
| 170 | |||
| 171 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 172 | </li> | ||
| 173 | <li class=""> | ||
| 174 | |||
| 175 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 176 | </li> | ||
| 177 | <li class=""> | ||
| 178 | |||
| 179 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 180 | </li> | ||
| 181 | </ul> | ||
| 182 | </li> | ||
| 183 | |||
| 184 | <li class="toctree-l1"> | ||
| 185 | |||
| 186 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 187 | </li> | ||
| 188 | |||
| 189 | <li class="toctree-l1"> | ||
| 190 | |||
| 191 | <span class="caption-text">Development</span> | ||
| 192 | <ul class="subnav"> | ||
| 193 | <li class=""> | ||
| 194 | |||
| 195 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 196 | </li> | ||
| 197 | <li class=""> | ||
| 198 | |||
| 199 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 200 | </li> | ||
| 201 | <li class=""> | ||
| 202 | |||
| 203 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 204 | </li> | ||
| 205 | <li class=""> | ||
| 206 | |||
| 207 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 208 | </li> | ||
| 209 | <li class=""> | ||
| 210 | |||
| 211 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 212 | </li> | ||
| 213 | <li class=""> | ||
| 214 | |||
| 215 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 216 | </li> | ||
| 217 | <li class=""> | ||
| 218 | |||
| 219 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 220 | </li> | ||
| 221 | <li class=""> | ||
| 222 | |||
| 223 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 224 | </li> | ||
| 225 | <li class=""> | ||
| 226 | |||
| 227 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 228 | </li> | ||
| 229 | <li class=""> | ||
| 230 | |||
| 231 | <a class="" href="../Security/">Security</a> | ||
| 232 | </li> | ||
| 233 | <li class=""> | ||
| 234 | |||
| 235 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 236 | </li> | ||
| 237 | <li class=""> | ||
| 238 | |||
| 239 | <a class="" href="../Theming/">Theming</a> | ||
| 240 | </li> | ||
| 241 | <li class=""> | ||
| 242 | |||
| 243 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 244 | </li> | ||
| 245 | </ul> | ||
| 246 | </li> | ||
| 247 | |||
| 248 | <li class="toctree-l1"> | ||
| 249 | |||
| 250 | <span class="caption-text">About</span> | ||
| 251 | <ul class="subnav"> | ||
| 252 | <li class=""> | ||
| 253 | |||
| 254 | <a class="" href="../FAQ/">FAQ</a> | ||
| 255 | </li> | ||
| 256 | <li class=""> | ||
| 257 | |||
| 258 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 259 | </li> | ||
| 260 | </ul> | ||
| 261 | </li> | ||
| 262 | |||
| 263 | </ul> | ||
| 264 | </div> | ||
| 265 | | ||
| 266 | </nav> | ||
| 267 | |||
| 268 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 269 | |||
| 270 | |||
| 271 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 272 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 273 | <a href="..">Shaarli Documentation</a> | ||
| 274 | </nav> | ||
| 275 | |||
| 276 | |||
| 277 | <div class="wy-nav-content"> | ||
| 278 | <div class="rst-content"> | ||
| 279 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 280 | <ul class="wy-breadcrumbs"> | ||
| 281 | <li><a href="..">Docs</a> »</li> | ||
| 282 | |||
| 283 | |||
| 284 | |||
| 285 | <li>Usage »</li> | ||
| 286 | |||
| 287 | |||
| 288 | |||
| 289 | <li>Bookmarklet</li> | ||
| 290 | <li class="wy-breadcrumbs-aside"> | ||
| 291 | |||
| 292 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Bookmarklet.md" | ||
| 293 | class="icon icon-github"> Edit on GitHub</a> | ||
| 294 | |||
| 295 | </li> | ||
| 296 | </ul> | ||
| 297 | <hr/> | ||
| 298 | </div> | ||
| 299 | <div role="main"> | ||
| 300 | <div class="section"> | ||
| 301 | |||
| 302 | <h3 id="add-the-sharing-button-bookmarklet-to-your-browser">Add the sharing button (<em>bookmarklet</em>) to your browser</h3> | ||
| 303 | <ul> | ||
| 304 | <li>Open your Shaarli and <code>Login</code></li> | ||
| 305 | <li>Click the <code>Tools</code> button in the top bar</li> | ||
| 306 | <li>Drag the <strong><code>✚Shaare link</code> button</strong>, and drop it to your browser's bookmarks bar.</li> | ||
| 307 | </ul> | ||
| 308 | <p><em>This bookmarklet button is compatible with Firefox, Opera, Chrome and Safari. Under Opera, you can't drag'n drop the button: You have to right-click on it and add a bookmark to your personal toolbar.</em></p> | ||
| 309 | <p><img alt="" src="../images/bookmarklet.png" /></p> | ||
| 310 | <h3 id="share-links-using-the-bookmarklet">Share links using the <em>bookmarklet</em></h3> | ||
| 311 | <ul> | ||
| 312 | <li>When you are visiting a webpage you would like to share with Shaarli, click the <em>bookmarklet</em> you just added.</li> | ||
| 313 | <li>A window opens.</li> | ||
| 314 | <li>You can freely edit title, description, tags... to find it later using the text search or tag filtering.</li> | ||
| 315 | <li>You will be able to edit this link later using the <img alt="" src="https://raw.githubusercontent.com/shaarli/Shaarli/master/images/edit_icon.png" /> edit button.</li> | ||
| 316 | <li>You can also check the “Private” box so that the link is saved but only visible to you. </li> | ||
| 317 | <li>Click <code>Save</code>.<strong>Voilà! Your link is now shared.</strong></li> | ||
| 318 | </ul> | ||
| 319 | <h3 id="troubleshooting-the-bookmarklet-doesnt-work-with-a-few-website-eg-githubcom">Troubleshooting: The bookmarklet doesn't work with a few website (e.g. Github.com)</h3> | ||
| 320 | <p>Websites which enforce Content Security Policy (CSP), such as github.com, disallow usage of bookmarklets. Unfortunatly, there is nothing Shaarli can do about it.</p> | ||
| 321 | <p>See <a href="https://github.com/shaarli/Shaarli#196">#196</a>.</p> | ||
| 322 | <p>There is an open bug for both Firefox and Chromium:</p> | ||
| 323 | <ul> | ||
| 324 | <li>https://bugzilla.mozilla.org/show_bug.cgi?id=866522</li> | ||
| 325 | <li>https://code.google.com/p/chromium/issues/detail?id=233903</li> | ||
| 326 | </ul> | ||
| 327 | |||
| 328 | </div> | ||
| 329 | </div> | ||
| 330 | <footer> | ||
| 331 | |||
| 332 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 333 | |||
| 334 | <a href="../Browsing-and-searching/" class="btn btn-neutral float-right" title="Browsing and searching">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 335 | |||
| 336 | |||
| 337 | <a href="../Features/" class="btn btn-neutral" title="Features"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 338 | |||
| 339 | </div> | ||
| 340 | |||
| 341 | |||
| 342 | <hr/> | ||
| 343 | |||
| 344 | <div role="contentinfo"> | ||
| 345 | <!-- Copyright etc --> | ||
| 346 | |||
| 347 | </div> | ||
| 348 | |||
| 349 | 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>. | ||
| 350 | </footer> | ||
| 351 | |||
| 352 | </div> | ||
| 353 | </div> | ||
| 354 | |||
| 355 | </section> | ||
| 356 | |||
| 357 | </div> | ||
| 358 | |||
| 359 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 360 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 361 | |||
| 362 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 363 | |||
| 364 | |||
| 365 | <span><a href="../Features/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 366 | |||
| 367 | |||
| 368 | <span style="margin-left: 15px"><a href="../Browsing-and-searching/" style="color: #fcfcfc">Next »</a></span> | ||
| 369 | |||
| 370 | </span> | ||
| 371 | </div> | ||
| 372 | <script src="../js/theme.js"></script> | ||
| 373 | |||
| 374 | </body> | ||
| 375 | </html> | ||
diff --git a/doc/html/Browsing-and-searching/index.html b/doc/html/Browsing-and-searching/index.html new file mode 100644 index 00000000..459f07c7 --- /dev/null +++ b/doc/html/Browsing-and-searching/index.html | |||
| @@ -0,0 +1,362 @@ | |||
| 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>Browsing and searching - 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 = "Browsing and searching"; | ||
| 22 | var mkdocs_page_input_path = "Browsing-and-searching.md"; | ||
| 23 | var mkdocs_page_url = "/Browsing-and-searching/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="../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=" current"> | ||
| 127 | |||
| 128 | <a class="current" href="./">Browsing and searching</a> | ||
| 129 | <ul class="subnav"> | ||
| 130 | |||
| 131 | <li class="toctree-l3"><a href="#plain-text-search">Plain text search</a></li> | ||
| 132 | |||
| 133 | |||
| 134 | <li class="toctree-l3"><a href="#tags-search">Tags search</a></li> | ||
| 135 | |||
| 136 | |||
| 137 | <li class="toctree-l3"><a href="#filtering-rss-feedspicture-wall">Filtering RSS feeds/Picture wall</a></li> | ||
| 138 | |||
| 139 | |||
| 140 | </ul> | ||
| 141 | </li> | ||
| 142 | <li class=""> | ||
| 143 | |||
| 144 | <a class="" href="../Firefox-share/">Firefox share</a> | ||
| 145 | </li> | ||
| 146 | <li class=""> | ||
| 147 | |||
| 148 | <a class="" href="../RSS-feeds/">RSS feeds</a> | ||
| 149 | </li> | ||
| 150 | <li class=""> | ||
| 151 | |||
| 152 | <a class="" href="../REST-API/">REST API</a> | ||
| 153 | </li> | ||
| 154 | </ul> | ||
| 155 | </li> | ||
| 156 | |||
| 157 | <li class="toctree-l1"> | ||
| 158 | |||
| 159 | <span class="caption-text">How To</span> | ||
| 160 | <ul class="subnav"> | ||
| 161 | <li class=""> | ||
| 162 | |||
| 163 | <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a> | ||
| 164 | </li> | ||
| 165 | <li class=""> | ||
| 166 | |||
| 167 | <a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 168 | </li> | ||
| 169 | <li class=""> | ||
| 170 | |||
| 171 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 172 | </li> | ||
| 173 | <li class=""> | ||
| 174 | |||
| 175 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 176 | </li> | ||
| 177 | <li class=""> | ||
| 178 | |||
| 179 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 180 | </li> | ||
| 181 | </ul> | ||
| 182 | </li> | ||
| 183 | |||
| 184 | <li class="toctree-l1"> | ||
| 185 | |||
| 186 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 187 | </li> | ||
| 188 | |||
| 189 | <li class="toctree-l1"> | ||
| 190 | |||
| 191 | <span class="caption-text">Development</span> | ||
| 192 | <ul class="subnav"> | ||
| 193 | <li class=""> | ||
| 194 | |||
| 195 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 196 | </li> | ||
| 197 | <li class=""> | ||
| 198 | |||
| 199 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 200 | </li> | ||
| 201 | <li class=""> | ||
| 202 | |||
| 203 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 204 | </li> | ||
| 205 | <li class=""> | ||
| 206 | |||
| 207 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 208 | </li> | ||
| 209 | <li class=""> | ||
| 210 | |||
| 211 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 212 | </li> | ||
| 213 | <li class=""> | ||
| 214 | |||
| 215 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 216 | </li> | ||
| 217 | <li class=""> | ||
| 218 | |||
| 219 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 220 | </li> | ||
| 221 | <li class=""> | ||
| 222 | |||
| 223 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 224 | </li> | ||
| 225 | <li class=""> | ||
| 226 | |||
| 227 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 228 | </li> | ||
| 229 | <li class=""> | ||
| 230 | |||
| 231 | <a class="" href="../Security/">Security</a> | ||
| 232 | </li> | ||
| 233 | <li class=""> | ||
| 234 | |||
| 235 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 236 | </li> | ||
| 237 | <li class=""> | ||
| 238 | |||
| 239 | <a class="" href="../Theming/">Theming</a> | ||
| 240 | </li> | ||
| 241 | <li class=""> | ||
| 242 | |||
| 243 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 244 | </li> | ||
| 245 | </ul> | ||
| 246 | </li> | ||
| 247 | |||
| 248 | <li class="toctree-l1"> | ||
| 249 | |||
| 250 | <span class="caption-text">About</span> | ||
| 251 | <ul class="subnav"> | ||
| 252 | <li class=""> | ||
| 253 | |||
| 254 | <a class="" href="../FAQ/">FAQ</a> | ||
| 255 | </li> | ||
| 256 | <li class=""> | ||
| 257 | |||
| 258 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 259 | </li> | ||
| 260 | </ul> | ||
| 261 | </li> | ||
| 262 | |||
| 263 | </ul> | ||
| 264 | </div> | ||
| 265 | | ||
| 266 | </nav> | ||
| 267 | |||
| 268 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 269 | |||
| 270 | |||
| 271 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 272 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 273 | <a href="..">Shaarli Documentation</a> | ||
| 274 | </nav> | ||
| 275 | |||
| 276 | |||
| 277 | <div class="wy-nav-content"> | ||
| 278 | <div class="rst-content"> | ||
| 279 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 280 | <ul class="wy-breadcrumbs"> | ||
| 281 | <li><a href="..">Docs</a> »</li> | ||
| 282 | |||
| 283 | |||
| 284 | |||
| 285 | <li>Usage »</li> | ||
| 286 | |||
| 287 | |||
| 288 | |||
| 289 | <li>Browsing and searching</li> | ||
| 290 | <li class="wy-breadcrumbs-aside"> | ||
| 291 | |||
| 292 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Browsing-and-searching.md" | ||
| 293 | class="icon icon-github"> Edit on GitHub</a> | ||
| 294 | |||
| 295 | </li> | ||
| 296 | </ul> | ||
| 297 | <hr/> | ||
| 298 | </div> | ||
| 299 | <div role="main"> | ||
| 300 | <div class="section"> | ||
| 301 | |||
| 302 | <h2 id="plain-text-search">Plain text search</h2> | ||
| 303 | <p>Use the <code>Search text</code> field to search in <em>any</em> of the fields of all links (Title, URL, Description...)</p> | ||
| 304 | <p><strong>Exclude text/tags:</strong> Use the <code>-</code> operator before a word or tag (example <code>-uninteresting</code>) to prevent entries containing (or tagged) <code>uninteresting</code> from showing up in the search results.</p> | ||
| 305 | <p><strong>Exact text search:</strong> Use double-quotes (example <code>"exact search"</code>) to search for the exact expression.</p> | ||
| 306 | <p>Both exclude patterns and exact searches can be combined with normal searches (example <code>"exact search" term otherterm -notthis "very exact" stuff -notagain</code>)</p> | ||
| 307 | <h2 id="tags-search">Tags search</h2> | ||
| 308 | <p>Use the <code>Filter by tags</code> field to restrict displayed links to entries tagged with one or multiple tags (use space to separate tags). </p> | ||
| 309 | <p><strong>Hidden tags:</strong> Tags starting with a dot <code>.</code> (example <code>.secret</code>) are private. They can only be seen and searched when logged in.</p> | ||
| 310 | <p>Alternatively you can use the <code>Tag cloud</code> to discover all tags and click on any of them to display related links.</p> | ||
| 311 | <p>To search for links that are not tagged, enter <code>""</code> in the tag search field.</p> | ||
| 312 | <h2 id="filtering-rss-feedspicture-wall">Filtering RSS feeds/Picture wall</h2> | ||
| 313 | <p>RSS feeds can also be restricted to only return items matching a text/tag search: see <a href="../RSS feeds">RSS feeds</a>.</p> | ||
| 314 | |||
| 315 | </div> | ||
| 316 | </div> | ||
| 317 | <footer> | ||
| 318 | |||
| 319 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 320 | |||
| 321 | <a href="../Firefox-share/" class="btn btn-neutral float-right" title="Firefox share">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 322 | |||
| 323 | |||
| 324 | <a href="../Bookmarklet/" class="btn btn-neutral" title="Bookmarklet"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 325 | |||
| 326 | </div> | ||
| 327 | |||
| 328 | |||
| 329 | <hr/> | ||
| 330 | |||
| 331 | <div role="contentinfo"> | ||
| 332 | <!-- Copyright etc --> | ||
| 333 | |||
| 334 | </div> | ||
| 335 | |||
| 336 | 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>. | ||
| 337 | </footer> | ||
| 338 | |||
| 339 | </div> | ||
| 340 | </div> | ||
| 341 | |||
| 342 | </section> | ||
| 343 | |||
| 344 | </div> | ||
| 345 | |||
| 346 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 347 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 348 | |||
| 349 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 350 | |||
| 351 | |||
| 352 | <span><a href="../Bookmarklet/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 353 | |||
| 354 | |||
| 355 | <span style="margin-left: 15px"><a href="../Firefox-share/" style="color: #fcfcfc">Next »</a></span> | ||
| 356 | |||
| 357 | </span> | ||
| 358 | </div> | ||
| 359 | <script src="../js/theme.js"></script> | ||
| 360 | |||
| 361 | </body> | ||
| 362 | </html> | ||
diff --git a/doc/html/Coding-guidelines/index.html b/doc/html/Coding-guidelines/index.html new file mode 100644 index 00000000..be2bf7e8 --- /dev/null +++ b/doc/html/Coding-guidelines/index.html | |||
| @@ -0,0 +1,348 @@ | |||
| 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>Coding guidelines - 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 = "Coding guidelines"; | ||
| 22 | var mkdocs_page_input_path = "Coding-guidelines.md"; | ||
| 23 | var mkdocs_page_url = "/Coding-guidelines/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="../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="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 156 | </li> | ||
| 157 | <li class=""> | ||
| 158 | |||
| 159 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 160 | </li> | ||
| 161 | <li class=""> | ||
| 162 | |||
| 163 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 164 | </li> | ||
| 165 | <li class=""> | ||
| 166 | |||
| 167 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 168 | </li> | ||
| 169 | </ul> | ||
| 170 | </li> | ||
| 171 | |||
| 172 | <li class="toctree-l1"> | ||
| 173 | |||
| 174 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 175 | </li> | ||
| 176 | |||
| 177 | <li class="toctree-l1"> | ||
| 178 | |||
| 179 | <span class="caption-text">Development</span> | ||
| 180 | <ul class="subnav"> | ||
| 181 | <li class=""> | ||
| 182 | |||
| 183 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 184 | </li> | ||
| 185 | <li class=""> | ||
| 186 | |||
| 187 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 188 | </li> | ||
| 189 | <li class=""> | ||
| 190 | |||
| 191 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 192 | </li> | ||
| 193 | <li class=" current"> | ||
| 194 | |||
| 195 | <a class="current" href="./">Coding guidelines</a> | ||
| 196 | <ul class="subnav"> | ||
| 197 | |||
| 198 | <li class="toctree-l3"><a href="#wip">WIP</a></li> | ||
| 199 | |||
| 200 | |||
| 201 | </ul> | ||
| 202 | </li> | ||
| 203 | <li class=""> | ||
| 204 | |||
| 205 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 206 | </li> | ||
| 207 | <li class=""> | ||
| 208 | |||
| 209 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 210 | </li> | ||
| 211 | <li class=""> | ||
| 212 | |||
| 213 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 214 | </li> | ||
| 215 | <li class=""> | ||
| 216 | |||
| 217 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 218 | </li> | ||
| 219 | <li class=""> | ||
| 220 | |||
| 221 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 222 | </li> | ||
| 223 | <li class=""> | ||
| 224 | |||
| 225 | <a class="" href="../Security/">Security</a> | ||
| 226 | </li> | ||
| 227 | <li class=""> | ||
| 228 | |||
| 229 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 230 | </li> | ||
| 231 | <li class=""> | ||
| 232 | |||
| 233 | <a class="" href="../Theming/">Theming</a> | ||
| 234 | </li> | ||
| 235 | <li class=""> | ||
| 236 | |||
| 237 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 238 | </li> | ||
| 239 | </ul> | ||
| 240 | </li> | ||
| 241 | |||
| 242 | <li class="toctree-l1"> | ||
| 243 | |||
| 244 | <span class="caption-text">About</span> | ||
| 245 | <ul class="subnav"> | ||
| 246 | <li class=""> | ||
| 247 | |||
| 248 | <a class="" href="../FAQ/">FAQ</a> | ||
| 249 | </li> | ||
| 250 | <li class=""> | ||
| 251 | |||
| 252 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 253 | </li> | ||
| 254 | </ul> | ||
| 255 | </li> | ||
| 256 | |||
| 257 | </ul> | ||
| 258 | </div> | ||
| 259 | | ||
| 260 | </nav> | ||
| 261 | |||
| 262 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 263 | |||
| 264 | |||
| 265 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 266 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 267 | <a href="..">Shaarli Documentation</a> | ||
| 268 | </nav> | ||
| 269 | |||
| 270 | |||
| 271 | <div class="wy-nav-content"> | ||
| 272 | <div class="rst-content"> | ||
| 273 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 274 | <ul class="wy-breadcrumbs"> | ||
| 275 | <li><a href="..">Docs</a> »</li> | ||
| 276 | |||
| 277 | |||
| 278 | |||
| 279 | <li>Development »</li> | ||
| 280 | |||
| 281 | |||
| 282 | |||
| 283 | <li>Coding guidelines</li> | ||
| 284 | <li class="wy-breadcrumbs-aside"> | ||
| 285 | |||
| 286 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Coding-guidelines.md" | ||
| 287 | class="icon icon-github"> Edit on GitHub</a> | ||
| 288 | |||
| 289 | </li> | ||
| 290 | </ul> | ||
| 291 | <hr/> | ||
| 292 | </div> | ||
| 293 | <div role="main"> | ||
| 294 | <div class="section"> | ||
| 295 | |||
| 296 | <h2 id="wip">WIP</h2> | ||
| 297 | <p>This topic is currently being discussed here: | ||
| 298 | - <a href="https://github.com/shaarli/Shaarli/issues/95">Fix coding style (static analysis)</a> (#95) | ||
| 299 | - <a href="https://github.com/shaarli/Shaarli/issues/130">Continuous Integration tools & features</a> (#130)</p> | ||
| 300 | |||
| 301 | </div> | ||
| 302 | </div> | ||
| 303 | <footer> | ||
| 304 | |||
| 305 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 306 | |||
| 307 | <a href="../Directory-structure/" class="btn btn-neutral float-right" title="Directory structure">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 308 | |||
| 309 | |||
| 310 | <a href="../GnuPG-signature/" class="btn btn-neutral" title="GnuPG signature"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 311 | |||
| 312 | </div> | ||
| 313 | |||
| 314 | |||
| 315 | <hr/> | ||
| 316 | |||
| 317 | <div role="contentinfo"> | ||
| 318 | <!-- Copyright etc --> | ||
| 319 | |||
| 320 | </div> | ||
| 321 | |||
| 322 | 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>. | ||
| 323 | </footer> | ||
| 324 | |||
| 325 | </div> | ||
| 326 | </div> | ||
| 327 | |||
| 328 | </section> | ||
| 329 | |||
| 330 | </div> | ||
| 331 | |||
| 332 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 333 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 334 | |||
| 335 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 336 | |||
| 337 | |||
| 338 | <span><a href="../GnuPG-signature/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 339 | |||
| 340 | |||
| 341 | <span style="margin-left: 15px"><a href="../Directory-structure/" style="color: #fcfcfc">Next »</a></span> | ||
| 342 | |||
| 343 | </span> | ||
| 344 | </div> | ||
| 345 | <script src="../js/theme.js"></script> | ||
| 346 | |||
| 347 | </body> | ||
| 348 | </html> | ||
diff --git a/doc/html/Community-&-Related-software/index.html b/doc/html/Community-&-Related-software/index.html new file mode 100644 index 00000000..1de704a3 --- /dev/null +++ b/doc/html/Community-&-Related-software/index.html | |||
| @@ -0,0 +1,419 @@ | |||
| 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>Community & Related software - 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 = "Community & Related software"; | ||
| 22 | var mkdocs_page_input_path = "Community-&-Related-software.md"; | ||
| 23 | var mkdocs_page_url = "/Community-&-Related-software/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="../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="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 156 | </li> | ||
| 157 | <li class=""> | ||
| 158 | |||
| 159 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 160 | </li> | ||
| 161 | <li class=""> | ||
| 162 | |||
| 163 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 164 | </li> | ||
| 165 | <li class=""> | ||
| 166 | |||
| 167 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 168 | </li> | ||
| 169 | </ul> | ||
| 170 | </li> | ||
| 171 | |||
| 172 | <li class="toctree-l1"> | ||
| 173 | |||
| 174 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 175 | </li> | ||
| 176 | |||
| 177 | <li class="toctree-l1"> | ||
| 178 | |||
| 179 | <span class="caption-text">Development</span> | ||
| 180 | <ul class="subnav"> | ||
| 181 | <li class=""> | ||
| 182 | |||
| 183 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 184 | </li> | ||
| 185 | <li class=""> | ||
| 186 | |||
| 187 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 188 | </li> | ||
| 189 | <li class=""> | ||
| 190 | |||
| 191 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 192 | </li> | ||
| 193 | <li class=""> | ||
| 194 | |||
| 195 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 196 | </li> | ||
| 197 | <li class=""> | ||
| 198 | |||
| 199 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 200 | </li> | ||
| 201 | <li class=""> | ||
| 202 | |||
| 203 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 204 | </li> | ||
| 205 | <li class=""> | ||
| 206 | |||
| 207 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 208 | </li> | ||
| 209 | <li class=""> | ||
| 210 | |||
| 211 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 212 | </li> | ||
| 213 | <li class=""> | ||
| 214 | |||
| 215 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 216 | </li> | ||
| 217 | <li class=""> | ||
| 218 | |||
| 219 | <a class="" href="../Security/">Security</a> | ||
| 220 | </li> | ||
| 221 | <li class=""> | ||
| 222 | |||
| 223 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 224 | </li> | ||
| 225 | <li class=""> | ||
| 226 | |||
| 227 | <a class="" href="../Theming/">Theming</a> | ||
| 228 | </li> | ||
| 229 | <li class=""> | ||
| 230 | |||
| 231 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 232 | </li> | ||
| 233 | </ul> | ||
| 234 | </li> | ||
| 235 | |||
| 236 | <li class="toctree-l1"> | ||
| 237 | |||
| 238 | <span class="caption-text">About</span> | ||
| 239 | <ul class="subnav"> | ||
| 240 | <li class=""> | ||
| 241 | |||
| 242 | <a class="" href="../FAQ/">FAQ</a> | ||
| 243 | </li> | ||
| 244 | <li class=" current"> | ||
| 245 | |||
| 246 | <a class="current" href="./">Community & Related software</a> | ||
| 247 | <ul class="subnav"> | ||
| 248 | |||
| 249 | <li class="toctree-l3"><a href="#community">Community</a></li> | ||
| 250 | |||
| 251 | <ul> | ||
| 252 | |||
| 253 | <li><a class="toctree-l4" href="#articles-and-social-media-discussions">Articles and social media discussions</a></li> | ||
| 254 | |||
| 255 | <li><a class="toctree-l4" href="#third-party-plugins">Third party plugins</a></li> | ||
| 256 | |||
| 257 | <li><a class="toctree-l4" href="#themes">Themes</a></li> | ||
| 258 | |||
| 259 | <li><a class="toctree-l4" href="#server-apps">Server apps</a></li> | ||
| 260 | |||
| 261 | <li><a class="toctree-l4" href="#mobile-apps">Mobile Apps</a></li> | ||
| 262 | |||
| 263 | </ul> | ||
| 264 | |||
| 265 | |||
| 266 | <li class="toctree-l3"><a href="#integration-with-other-platforms">Integration with other platforms</a></li> | ||
| 267 | |||
| 268 | |||
| 269 | <li class="toctree-l3"><a href="#alternatives-to-shaarli">Alternatives to Shaarli</a></li> | ||
| 270 | |||
| 271 | |||
| 272 | </ul> | ||
| 273 | </li> | ||
| 274 | </ul> | ||
| 275 | </li> | ||
| 276 | |||
| 277 | </ul> | ||
| 278 | </div> | ||
| 279 | | ||
| 280 | </nav> | ||
| 281 | |||
| 282 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 283 | |||
| 284 | |||
| 285 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 286 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 287 | <a href="..">Shaarli Documentation</a> | ||
| 288 | </nav> | ||
| 289 | |||
| 290 | |||
| 291 | <div class="wy-nav-content"> | ||
| 292 | <div class="rst-content"> | ||
| 293 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 294 | <ul class="wy-breadcrumbs"> | ||
| 295 | <li><a href="..">Docs</a> »</li> | ||
| 296 | |||
| 297 | |||
| 298 | |||
| 299 | <li>About »</li> | ||
| 300 | |||
| 301 | |||
| 302 | |||
| 303 | <li>Community & Related software</li> | ||
| 304 | <li class="wy-breadcrumbs-aside"> | ||
| 305 | |||
| 306 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Community-&-Related-software.md" | ||
| 307 | class="icon icon-github"> Edit on GitHub</a> | ||
| 308 | |||
| 309 | </li> | ||
| 310 | </ul> | ||
| 311 | <hr/> | ||
| 312 | </div> | ||
| 313 | <div role="main"> | ||
| 314 | <div class="section"> | ||
| 315 | |||
| 316 | <p><em>Unofficial but related work on Shaarli. If you maintain one of these, please get in touch with us to help us find a way to adapt your work to our fork.</em></p> | ||
| 317 | <p><em>TODO: contact repos owners to see if they'd like to standardize their work with the community fork.</em></p> | ||
| 318 | <h2 id="community">Community</h2> | ||
| 319 | <ul> | ||
| 320 | <li><a href="http://sebsauvage.net/links/">Liens en vrac de sebsauvage</a> - the original Shaarli</li> | ||
| 321 | <li><a href="http://porneia.free.fr/pub/links/ou-est-shaarli.html">A large list of Shaarlis</a></li> | ||
| 322 | <li><a href="https://raw.githubusercontent.com/Oros42/find_shaarlis/master/annuaires.json">A list of working Shaarli aggregators</a></li> | ||
| 323 | <li><a href="https://github.com/Oros42/shaarlis_list">A list of some known Shaarlis</a></li> | ||
| 324 | <li><a href="http://sebsauvage.net/rhaa/index.php?2011/09/16/09/29/58-adieu-delicious-diigo-et-stumbleupon-salut-shaarli-">Adieu Delicious, Diigo et StumbleUpon. Salut Shaarli ! - sebsauvage.net</a> (fr) <em>16/09/2011 - the original post about Shaarli</em></li> | ||
| 325 | <li><a href="http://sebsauvage.net/wiki/doku.php?id=php:shaarli:ideas">Original ideas/fixme/TODO page</a></li> | ||
| 326 | <li><a href="http://sebsauvage.net/wiki/doku.php?id=php:shaarli:discussion">Original discussion page</a> (fr)</li> | ||
| 327 | <li><a href="http://sebsauvage.net/wiki/doku.php?id=php:shaarli:history">Original revisions history</a></li> | ||
| 328 | <li><a href="https://www.shaarli.fr/my.php">Shaarli.fr/my</a> - Unofficial, unsupported (old fork) hosted Shaarlis provider, courtesy of <a href="https://github.com/DMeloni">DMeloni</a></li> | ||
| 329 | </ul> | ||
| 330 | <h3 id="articles-and-social-media-discussions">Articles and social media discussions</h3> | ||
| 331 | <ul> | ||
| 332 | <li>2016-09-22 - Hacker News - https://news.ycombinator.com/item?id=12552176</li> | ||
| 333 | <li>2015-08-15 - Reddit - <a href="https://www.reddit.com/r/selfhosted/comments/3h3zwh/question_about_migrating_from_wordpress_to_shaarli/">Question about migrating from WordPress to Shaarli.</a></li> | ||
| 334 | <li>2015-06-22 - Hacker News - https://news.ycombinator.com/item?id=9755366</li> | ||
| 335 | <li>2015-05-12 - Reddit - <a href="https://www.reddit.com/r/selfhosted/comments/35pkkc/shaarli_self_hosted_bookmarking_delicious_php/">shaarli - Self hosted Bookmarking / Delicious (PHP, MySQL)</a></li> | ||
| 336 | </ul> | ||
| 337 | <h3 id="third-party-plugins">Third party plugins</h3> | ||
| 338 | <ul> | ||
| 339 | <li><a href="https://github.com/kalvn/shaarli-plugin-autosave">autosave</a> by <a href="https://github.com/kalvn">@kalvn</a>: Automatically saves data when editing a link to avoid any loss in case of crash or unexpected shutdown.</li> | ||
| 340 | <li><a href="https://github.com/ArthurHoaro/code-coloration">Code Coloration</a> by <a href="https://github.com/ArthurHoaro">@ArthurHoaro</a>: client side code syntax highlighter.</li> | ||
| 341 | <li><a href="https://github.com/kalvn/shaarli-plugin-disqus">Disqus</a> by <a href="https://github.com/kalvn">@kalvn</a>: Adds Disqus comment system to your Shaarli.</li> | ||
| 342 | <li><a href="https://github.com/NerosTie/emojione">emojione</a> by <a href="https://github.com/NerosTie">@NerosTie</a>: Add colorful emojis to your Shaarli.</li> | ||
| 343 | <li><a href="https://github.com/ericjuden/Shaarli-Google-Analytics-Plugin">google analytics</a> by <a href="http://github.com/ericjuden">@ericjuden</a>: Adds Google Analytics tracking support</li> | ||
| 344 | <li><a href="https://github.com/ArthurHoaro/launch-plugin">launch</a> - Launch Plugin is a plugin designed to enhance and customize Launch Theme for Shaarli.</li> | ||
| 345 | <li><a href="https://github.com/ilesinge/shaarli-related">related</a> by <a href="https://github.com/ilesinge">@ilesinge</a> - Show related links based on the number of identical tags.</li> | ||
| 346 | <li><a href="https://github.com/alexisju/social">social</a> by <a href="https://github.com/alexisju">@alexisju</a>: share links to social networks.</li> | ||
| 347 | <li><a href="https://github.com/ArthurHoaro/shaarli2twitter">shaarli2twitter</a> by <a href="https://github.com/ArthurHoaro">@ArthurHoaro</a> - Automatically tweet your shared links from Shaarli</li> | ||
| 348 | </ul> | ||
| 349 | <h3 id="themes">Themes</h3> | ||
| 350 | <p>See <a href="../Theming">Theming</a> for the list of community-contributed themes, and an installation guide.</p> | ||
| 351 | <h3 id="server-apps">Server apps</h3> | ||
| 352 | <ul> | ||
| 353 | <li><a href="https://github.com/nodiscc/shaarchiver">shaarchiver</a> - Archive your Shaarli bookmarks and their content</li> | ||
| 354 | <li><a href="https://github.com/mknexen/shaarli-river">shaarli-river</a> - An aggregator for shaarlis with many features </li> | ||
| 355 | <li><a href="https://github.com/DMeloni/shaarlo">Shaarlo</a> - An aggregator for shaarlis with many features (a very popular running instance among french shaarliers: <a href="http://shaarli.fr/">shaarli.fr</a>)</li> | ||
| 356 | <li><a href="https://github.com/BoboTiG/shaarlimages">Shaarlimages</a> - An image-oriented aggregator for Shaarlis</li> | ||
| 357 | <li><a href="https://github.com/mknexen/shaarli-api">mknexen/shaarli-api</a> - A REST API for Shaarli</li> | ||
| 358 | <li><a href="https://github.com/qwertygc/shaarli-dev-code/blob/master/self-dead-link.php">Self dead link</a> - Detect dead links on shaarli. This version use the database of shaarli. <a href="https://github.com/qwertygc/shaarli-dev-code/blob/master/dead-link.php">Another version</a>, can be used for other shaarli instances (but is more resource consuming).</li> | ||
| 359 | <li><a href="https://github.com/pirate/bookmark-archiver">Bookmark Archiver</a> - Save an archived copy of all websites starred using browser bookmarks/Shaarli/Delicious/Instapaper/Unmark.it/Pocket/Pinboard. Outputs browseable html. </li> | ||
| 360 | </ul> | ||
| 361 | <h3 id="mobile-apps">Mobile Apps</h3> | ||
| 362 | <ul> | ||
| 363 | <li><a href="https://github.com/mro/ShaarliOS">ShaarliOS</a> iOS share extension - see <a href="https://github.com/shaarli/Shaarli/issues/308#issuecomment-184592070">#308</a> for some promo codes,</li> | ||
| 364 | <li><a href="http://sebsauvage.net/links/?ZAyDzg">Shaarli for Android</a> - Android application that adds Shaarli as a sharing provider</li> | ||
| 365 | <li><a href="https://github.com/dimtion/Shaarlier">Shaarlier for Android</a> - Android application to simply add links directly into your Shaarli</li> | ||
| 366 | </ul> | ||
| 367 | <h2 id="integration-with-other-platforms">Integration with other platforms</h2> | ||
| 368 | <ul> | ||
| 369 | <li><a href="https://github.com/jcsaaddupuy/tt-rss-shaarli">tt-rss-shaarli</a> - <a href="http://tt-rss.org/">Tiny-Tiny RSS</a> plugin that adds support for sharing articles with Shaarli</li> | ||
| 370 | <li><a href="https://github.com/ahmet2mir/octopress-shaarli">octopress-shaarli</a> - Octopress plugin to retrieve Shaarli links on the sidebar</li> | ||
| 371 | <li><a href="https://github.com/q2apro/scuttle-to-shaarli">Scuttle to Shaarli</a> - Import bookmarks from Scuttle</li> | ||
| 372 | </ul> | ||
| 373 | <h2 id="alternatives-to-shaarli">Alternatives to Shaarli</h2> | ||
| 374 | <p>See the <a href="https://github.com/Kickball/awesome-selfhosted/#bookmarks--link-sharing">bookmarks & link sharing</a> section on <a href="https://github.com/Kickball/awesome-selfhosted/">awesome-selfhosted</a>.</p> | ||
| 375 | |||
| 376 | </div> | ||
| 377 | </div> | ||
| 378 | <footer> | ||
| 379 | |||
| 380 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 381 | |||
| 382 | |||
| 383 | <a href="../FAQ/" class="btn btn-neutral" title="FAQ"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 384 | |||
| 385 | </div> | ||
| 386 | |||
| 387 | |||
| 388 | <hr/> | ||
| 389 | |||
| 390 | <div role="contentinfo"> | ||
| 391 | <!-- Copyright etc --> | ||
| 392 | |||
| 393 | </div> | ||
| 394 | |||
| 395 | 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>. | ||
| 396 | </footer> | ||
| 397 | |||
| 398 | </div> | ||
| 399 | </div> | ||
| 400 | |||
| 401 | </section> | ||
| 402 | |||
| 403 | </div> | ||
| 404 | |||
| 405 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 406 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 407 | |||
| 408 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 409 | |||
| 410 | |||
| 411 | <span><a href="../FAQ/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 412 | |||
| 413 | |||
| 414 | </span> | ||
| 415 | </div> | ||
| 416 | <script src="../js/theme.js"></script> | ||
| 417 | |||
| 418 | </body> | ||
| 419 | </html> | ||
diff --git a/doc/html/Continuous-integration-tools/index.html b/doc/html/Continuous-integration-tools/index.html new file mode 100644 index 00000000..c889a963 --- /dev/null +++ b/doc/html/Continuous-integration-tools/index.html | |||
| @@ -0,0 +1,367 @@ | |||
| 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>Continuous integration tools - 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 = "Continuous integration tools"; | ||
| 22 | var mkdocs_page_input_path = "Continuous-integration-tools.md"; | ||
| 23 | var mkdocs_page_url = "/Continuous-integration-tools/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="../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="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 156 | </li> | ||
| 157 | <li class=""> | ||
| 158 | |||
| 159 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 160 | </li> | ||
| 161 | <li class=""> | ||
| 162 | |||
| 163 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 164 | </li> | ||
| 165 | <li class=""> | ||
| 166 | |||
| 167 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 168 | </li> | ||
| 169 | </ul> | ||
| 170 | </li> | ||
| 171 | |||
| 172 | <li class="toctree-l1"> | ||
| 173 | |||
| 174 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 175 | </li> | ||
| 176 | |||
| 177 | <li class="toctree-l1"> | ||
| 178 | |||
| 179 | <span class="caption-text">Development</span> | ||
| 180 | <ul class="subnav"> | ||
| 181 | <li class=""> | ||
| 182 | |||
| 183 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 184 | </li> | ||
| 185 | <li class=" current"> | ||
| 186 | |||
| 187 | <a class="current" href="./">Continuous integration tools</a> | ||
| 188 | <ul class="subnav"> | ||
| 189 | |||
| 190 | <li class="toctree-l3"><a href="#local-development">Local development</a></li> | ||
| 191 | |||
| 192 | |||
| 193 | <li class="toctree-l3"><a href="#automatic-builds">Automatic builds</a></li> | ||
| 194 | |||
| 195 | |||
| 196 | </ul> | ||
| 197 | </li> | ||
| 198 | <li class=""> | ||
| 199 | |||
| 200 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 201 | </li> | ||
| 202 | <li class=""> | ||
| 203 | |||
| 204 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 205 | </li> | ||
| 206 | <li class=""> | ||
| 207 | |||
| 208 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 209 | </li> | ||
| 210 | <li class=""> | ||
| 211 | |||
| 212 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 213 | </li> | ||
| 214 | <li class=""> | ||
| 215 | |||
| 216 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 217 | </li> | ||
| 218 | <li class=""> | ||
| 219 | |||
| 220 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 221 | </li> | ||
| 222 | <li class=""> | ||
| 223 | |||
| 224 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 225 | </li> | ||
| 226 | <li class=""> | ||
| 227 | |||
| 228 | <a class="" href="../Security/">Security</a> | ||
| 229 | </li> | ||
| 230 | <li class=""> | ||
| 231 | |||
| 232 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 233 | </li> | ||
| 234 | <li class=""> | ||
| 235 | |||
| 236 | <a class="" href="../Theming/">Theming</a> | ||
| 237 | </li> | ||
| 238 | <li class=""> | ||
| 239 | |||
| 240 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 241 | </li> | ||
| 242 | </ul> | ||
| 243 | </li> | ||
| 244 | |||
| 245 | <li class="toctree-l1"> | ||
| 246 | |||
| 247 | <span class="caption-text">About</span> | ||
| 248 | <ul class="subnav"> | ||
| 249 | <li class=""> | ||
| 250 | |||
| 251 | <a class="" href="../FAQ/">FAQ</a> | ||
| 252 | </li> | ||
| 253 | <li class=""> | ||
| 254 | |||
| 255 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 256 | </li> | ||
| 257 | </ul> | ||
| 258 | </li> | ||
| 259 | |||
| 260 | </ul> | ||
| 261 | </div> | ||
| 262 | | ||
| 263 | </nav> | ||
| 264 | |||
| 265 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 266 | |||
| 267 | |||
| 268 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 269 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 270 | <a href="..">Shaarli Documentation</a> | ||
| 271 | </nav> | ||
| 272 | |||
| 273 | |||
| 274 | <div class="wy-nav-content"> | ||
| 275 | <div class="rst-content"> | ||
| 276 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 277 | <ul class="wy-breadcrumbs"> | ||
| 278 | <li><a href="..">Docs</a> »</li> | ||
| 279 | |||
| 280 | |||
| 281 | |||
| 282 | <li>Development »</li> | ||
| 283 | |||
| 284 | |||
| 285 | |||
| 286 | <li>Continuous integration tools</li> | ||
| 287 | <li class="wy-breadcrumbs-aside"> | ||
| 288 | |||
| 289 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Continuous-integration-tools.md" | ||
| 290 | class="icon icon-github"> Edit on GitHub</a> | ||
| 291 | |||
| 292 | </li> | ||
| 293 | </ul> | ||
| 294 | <hr/> | ||
| 295 | </div> | ||
| 296 | <div role="main"> | ||
| 297 | <div class="section"> | ||
| 298 | |||
| 299 | <h2 id="local-development">Local development</h2> | ||
| 300 | <p>A <a href="https://github.com/shaarli/Shaarli/blob/master/Makefile"><code>Makefile</code></a> is available to perform project-related operations: | ||
| 301 | - Documentation - generate a local HTML copy of the GitHub wiki | ||
| 302 | - <a href="../Static analysis">Static analysis</a> - check that the code is compliant to PHP conventions | ||
| 303 | - <a href="../Unit tests">Unit tests</a> - ensure there are no regressions introduced by new commits</p> | ||
| 304 | <h2 id="automatic-builds">Automatic builds</h2> | ||
| 305 | <p><a href="http://docs.travis-ci.com/">Travis CI</a> is a Continuous Integration build server, that runs a build: | ||
| 306 | - each time a commit is merged to the mainline (<code>master</code> branch) | ||
| 307 | - each time a Pull Request is submitted or updated</p> | ||
| 308 | <p>A build is composed of several jobs: one for each supported PHP version (see <a href="../Server requirements">Server requirements</a>).</p> | ||
| 309 | <p>Each build job: | ||
| 310 | - updates Composer | ||
| 311 | - installs 3rd-party test dependencies with Composer | ||
| 312 | - runs <a href="../Unit tests">Unit tests</a></p> | ||
| 313 | <p>After all jobs have finished, Travis returns the results to GitHub: | ||
| 314 | - a status icon represents the result for the <code>master</code> branch: <a href="https://travis-ci.org/shaarli/Shaarli"><img alt="" src="https://api.travis-ci.org/shaarli/Shaarli.svg" /></a> | ||
| 315 | - Pull Requests are updated with the Travis result | ||
| 316 | - Green: all tests have passed | ||
| 317 | - Red: some tests failed | ||
| 318 | - Orange: tests are pending</p> | ||
| 319 | |||
| 320 | </div> | ||
| 321 | </div> | ||
| 322 | <footer> | ||
| 323 | |||
| 324 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 325 | |||
| 326 | <a href="../GnuPG-signature/" class="btn btn-neutral float-right" title="GnuPG signature">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 327 | |||
| 328 | |||
| 329 | <a href="../Development-guidelines/" class="btn btn-neutral" title="Development guidelines"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 330 | |||
| 331 | </div> | ||
| 332 | |||
| 333 | |||
| 334 | <hr/> | ||
| 335 | |||
| 336 | <div role="contentinfo"> | ||
| 337 | <!-- Copyright etc --> | ||
| 338 | |||
| 339 | </div> | ||
| 340 | |||
| 341 | 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>. | ||
| 342 | </footer> | ||
| 343 | |||
| 344 | </div> | ||
| 345 | </div> | ||
| 346 | |||
| 347 | </section> | ||
| 348 | |||
| 349 | </div> | ||
| 350 | |||
| 351 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 352 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 353 | |||
| 354 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 355 | |||
| 356 | |||
| 357 | <span><a href="../Development-guidelines/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 358 | |||
| 359 | |||
| 360 | <span style="margin-left: 15px"><a href="../GnuPG-signature/" style="color: #fcfcfc">Next »</a></span> | ||
| 361 | |||
| 362 | </span> | ||
| 363 | </div> | ||
| 364 | <script src="../js/theme.js"></script> | ||
| 365 | |||
| 366 | </body> | ||
| 367 | </html> | ||
diff --git a/doc/html/Copy-an-existing-installation-over-SSH-and-serve-it-locally/index.html b/doc/html/Copy-an-existing-installation-over-SSH-and-serve-it-locally/index.html new file mode 100644 index 00000000..4aea480d --- /dev/null +++ b/doc/html/Copy-an-existing-installation-over-SSH-and-serve-it-locally/index.html | |||
| @@ -0,0 +1,403 @@ | |||
| 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>Copy an existing installation over SSH and serve it locally - 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 = "Copy an existing installation over SSH and serve it locally"; | ||
| 22 | var mkdocs_page_input_path = "Copy-an-existing-installation-over-SSH-and-serve-it-locally.md"; | ||
| 23 | var mkdocs_page_url = "/Copy-an-existing-installation-over-SSH-and-serve-it-locally/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="../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=" current"> | ||
| 154 | |||
| 155 | <a class="current" href="./">Copy an existing installation over SSH and serve it locally</a> | ||
| 156 | <ul class="subnav"> | ||
| 157 | |||
| 158 | </ul> | ||
| 159 | </li> | ||
| 160 | <li class=""> | ||
| 161 | |||
| 162 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 163 | </li> | ||
| 164 | <li class=""> | ||
| 165 | |||
| 166 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 167 | </li> | ||
| 168 | <li class=""> | ||
| 169 | |||
| 170 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 171 | </li> | ||
| 172 | </ul> | ||
| 173 | </li> | ||
| 174 | |||
| 175 | <li class="toctree-l1"> | ||
| 176 | |||
| 177 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 178 | </li> | ||
| 179 | |||
| 180 | <li class="toctree-l1"> | ||
| 181 | |||
| 182 | <span class="caption-text">Development</span> | ||
| 183 | <ul class="subnav"> | ||
| 184 | <li class=""> | ||
| 185 | |||
| 186 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 187 | </li> | ||
| 188 | <li class=""> | ||
| 189 | |||
| 190 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 191 | </li> | ||
| 192 | <li class=""> | ||
| 193 | |||
| 194 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 195 | </li> | ||
| 196 | <li class=""> | ||
| 197 | |||
| 198 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 199 | </li> | ||
| 200 | <li class=""> | ||
| 201 | |||
| 202 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 203 | </li> | ||
| 204 | <li class=""> | ||
| 205 | |||
| 206 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 207 | </li> | ||
| 208 | <li class=""> | ||
| 209 | |||
| 210 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 211 | </li> | ||
| 212 | <li class=""> | ||
| 213 | |||
| 214 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 215 | </li> | ||
| 216 | <li class=""> | ||
| 217 | |||
| 218 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 219 | </li> | ||
| 220 | <li class=""> | ||
| 221 | |||
| 222 | <a class="" href="../Security/">Security</a> | ||
| 223 | </li> | ||
| 224 | <li class=""> | ||
| 225 | |||
| 226 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 227 | </li> | ||
| 228 | <li class=""> | ||
| 229 | |||
| 230 | <a class="" href="../Theming/">Theming</a> | ||
| 231 | </li> | ||
| 232 | <li class=""> | ||
| 233 | |||
| 234 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 235 | </li> | ||
| 236 | </ul> | ||
| 237 | </li> | ||
| 238 | |||
| 239 | <li class="toctree-l1"> | ||
| 240 | |||
| 241 | <span class="caption-text">About</span> | ||
| 242 | <ul class="subnav"> | ||
| 243 | <li class=""> | ||
| 244 | |||
| 245 | <a class="" href="../FAQ/">FAQ</a> | ||
| 246 | </li> | ||
| 247 | <li class=""> | ||
| 248 | |||
| 249 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 250 | </li> | ||
| 251 | </ul> | ||
| 252 | </li> | ||
| 253 | |||
| 254 | </ul> | ||
| 255 | </div> | ||
| 256 | | ||
| 257 | </nav> | ||
| 258 | |||
| 259 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 260 | |||
| 261 | |||
| 262 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 263 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 264 | <a href="..">Shaarli Documentation</a> | ||
| 265 | </nav> | ||
| 266 | |||
| 267 | |||
| 268 | <div class="wy-nav-content"> | ||
| 269 | <div class="rst-content"> | ||
| 270 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 271 | <ul class="wy-breadcrumbs"> | ||
| 272 | <li><a href="..">Docs</a> »</li> | ||
| 273 | |||
| 274 | |||
| 275 | |||
| 276 | <li>How To »</li> | ||
| 277 | |||
| 278 | |||
| 279 | |||
| 280 | <li>Copy an existing installation over SSH and serve it locally</li> | ||
| 281 | <li class="wy-breadcrumbs-aside"> | ||
| 282 | |||
| 283 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Copy-an-existing-installation-over-SSH-and-serve-it-locally.md" | ||
| 284 | class="icon icon-github"> Edit on GitHub</a> | ||
| 285 | |||
| 286 | </li> | ||
| 287 | </ul> | ||
| 288 | <hr/> | ||
| 289 | </div> | ||
| 290 | <div role="main"> | ||
| 291 | <div class="section"> | ||
| 292 | |||
| 293 | <p>Example bash script:</p> | ||
| 294 | <pre><code class="bash">#!/bin/bash | ||
| 295 | #Description: Copy a Shaarli installation over SSH/SCP, serve it locally with php-cli | ||
| 296 | #Will create a local-shaarli/ directory when you run it, backup your Shaarli there, and serve it locally. | ||
| 297 | #Will NOT download linked pages. It's just a directly usable backup/copy/mirror of your Shaarli | ||
| 298 | #Requires: ssh, scp and a working SSH access to the server where your Shaarli is installed | ||
| 299 | #Usage: ./local-shaarli.sh | ||
| 300 | #Author: nodiscc (nodiscc@gmail.com) | ||
| 301 | #License: MIT (http://opensource.org/licenses/MIT) | ||
| 302 | set -o errexit | ||
| 303 | set -o nounset | ||
| 304 | |||
| 305 | ##### CONFIG ################# | ||
| 306 | #The port used by php's local server | ||
| 307 | php_local_port=7431 | ||
| 308 | |||
| 309 | #Name of the SSH server and path where Shaarli is installed | ||
| 310 | #TODO: pass these as command-line arguments | ||
| 311 | remotehost="my.ssh.server" | ||
| 312 | remote_shaarli_dir="/var/www/shaarli" | ||
| 313 | |||
| 314 | |||
| 315 | ###### FUNCTIONS ############# | ||
| 316 | _main() { | ||
| 317 | _CBSyncShaarli | ||
| 318 | _CBServeShaarli | ||
| 319 | } | ||
| 320 | |||
| 321 | _CBSyncShaarli() { | ||
| 322 | remote_temp_dir=$(ssh $remotehost mktemp -d) | ||
| 323 | remote_ssh_user=$(ssh $remotehost whoami) | ||
| 324 | ssh -t "$remotehost" sudo cp -r "$remote_shaarli_dir" "$remote_temp_dir" | ||
| 325 | ssh -t "$remotehost" sudo chown -R "$remote_ssh_user":"$remote_ssh_user" "$remote_temp_dir" | ||
| 326 | scp -rq "$remotehost":"$remote_temp_dir" local-shaarli | ||
| 327 | ssh "$remotehost" rm -r "$remote_temp_dir" | ||
| 328 | } | ||
| 329 | |||
| 330 | _CBServeShaarli() { | ||
| 331 | #TODO: allow serving a previously downloaded Shaarli | ||
| 332 | #TODO: ask before overwriting local copy, if it exists | ||
| 333 | cd local-shaarli/ | ||
| 334 | php -S localhost:${php_local_port} | ||
| 335 | echo "Please go to http://localhost:${php_local_port}" | ||
| 336 | } | ||
| 337 | |||
| 338 | |||
| 339 | ##### MAIN ################# | ||
| 340 | |||
| 341 | _main | ||
| 342 | </code></pre> | ||
| 343 | |||
| 344 | <p>This outputs:</p> | ||
| 345 | <pre><code class="bash">$ ./local-shaarli.sh | ||
| 346 | PHP 5.6.0RC4 Development Server started at Mon Sep 1 21:56:19 2014 | ||
| 347 | Listening on http://localhost:7431 | ||
| 348 | Document root is /home/user/local-shaarli/shaarli | ||
| 349 | Press Ctrl-C to quit. | ||
| 350 | |||
| 351 | [Mon Sep 1 21:56:27 2014] ::1:57868 [200]: / | ||
| 352 | [Mon Sep 1 21:56:27 2014] ::1:57869 [200]: /index.html | ||
| 353 | [Mon Sep 1 21:56:37 2014] ::1:57881 [200]: /... | ||
| 354 | </code></pre> | ||
| 355 | |||
| 356 | </div> | ||
| 357 | </div> | ||
| 358 | <footer> | ||
| 359 | |||
| 360 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 361 | |||
| 362 | <a href="../Create-and-serve-multiple-Shaarlis-(farm)/" class="btn btn-neutral float-right" title="Create and serve multiple Shaarlis (farm)">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 363 | |||
| 364 | |||
| 365 | <a href="../Backup,-restore,-import-and-export/" class="btn btn-neutral" title="Backup, restore, import and export"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 366 | |||
| 367 | </div> | ||
| 368 | |||
| 369 | |||
| 370 | <hr/> | ||
| 371 | |||
| 372 | <div role="contentinfo"> | ||
| 373 | <!-- Copyright etc --> | ||
| 374 | |||
| 375 | </div> | ||
| 376 | |||
| 377 | 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>. | ||
| 378 | </footer> | ||
| 379 | |||
| 380 | </div> | ||
| 381 | </div> | ||
| 382 | |||
| 383 | </section> | ||
| 384 | |||
| 385 | </div> | ||
| 386 | |||
| 387 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 388 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 389 | |||
| 390 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 391 | |||
| 392 | |||
| 393 | <span><a href="../Backup,-restore,-import-and-export/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 394 | |||
| 395 | |||
| 396 | <span style="margin-left: 15px"><a href="../Create-and-serve-multiple-Shaarlis-(farm)/" style="color: #fcfcfc">Next »</a></span> | ||
| 397 | |||
| 398 | </span> | ||
| 399 | </div> | ||
| 400 | <script src="../js/theme.js"></script> | ||
| 401 | |||
| 402 | </body> | ||
| 403 | </html> | ||
diff --git a/doc/html/Create-and-serve-multiple-Shaarlis-(farm)/index.html b/doc/html/Create-and-serve-multiple-Shaarlis-(farm)/index.html new file mode 100644 index 00000000..98d8992e --- /dev/null +++ b/doc/html/Create-and-serve-multiple-Shaarlis-(farm)/index.html | |||
| @@ -0,0 +1,396 @@ | |||
| 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>Create and serve multiple Shaarlis (farm) - 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 = "Create and serve multiple Shaarlis (farm)"; | ||
| 22 | var mkdocs_page_input_path = "Create-and-serve-multiple-Shaarlis-(farm).md"; | ||
| 23 | var mkdocs_page_url = "/Create-and-serve-multiple-Shaarlis-(farm)/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="../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="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 156 | </li> | ||
| 157 | <li class=" current"> | ||
| 158 | |||
| 159 | <a class="current" href="./">Create and serve multiple Shaarlis (farm)</a> | ||
| 160 | <ul class="subnav"> | ||
| 161 | |||
| 162 | </ul> | ||
| 163 | </li> | ||
| 164 | <li class=""> | ||
| 165 | |||
| 166 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 167 | </li> | ||
| 168 | <li class=""> | ||
| 169 | |||
| 170 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 171 | </li> | ||
| 172 | </ul> | ||
| 173 | </li> | ||
| 174 | |||
| 175 | <li class="toctree-l1"> | ||
| 176 | |||
| 177 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 178 | </li> | ||
| 179 | |||
| 180 | <li class="toctree-l1"> | ||
| 181 | |||
| 182 | <span class="caption-text">Development</span> | ||
| 183 | <ul class="subnav"> | ||
| 184 | <li class=""> | ||
| 185 | |||
| 186 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 187 | </li> | ||
| 188 | <li class=""> | ||
| 189 | |||
| 190 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 191 | </li> | ||
| 192 | <li class=""> | ||
| 193 | |||
| 194 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 195 | </li> | ||
| 196 | <li class=""> | ||
| 197 | |||
| 198 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 199 | </li> | ||
| 200 | <li class=""> | ||
| 201 | |||
| 202 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 203 | </li> | ||
| 204 | <li class=""> | ||
| 205 | |||
| 206 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 207 | </li> | ||
| 208 | <li class=""> | ||
| 209 | |||
| 210 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 211 | </li> | ||
| 212 | <li class=""> | ||
| 213 | |||
| 214 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 215 | </li> | ||
| 216 | <li class=""> | ||
| 217 | |||
| 218 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 219 | </li> | ||
| 220 | <li class=""> | ||
| 221 | |||
| 222 | <a class="" href="../Security/">Security</a> | ||
| 223 | </li> | ||
| 224 | <li class=""> | ||
| 225 | |||
| 226 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 227 | </li> | ||
| 228 | <li class=""> | ||
| 229 | |||
| 230 | <a class="" href="../Theming/">Theming</a> | ||
| 231 | </li> | ||
| 232 | <li class=""> | ||
| 233 | |||
| 234 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 235 | </li> | ||
| 236 | </ul> | ||
| 237 | </li> | ||
| 238 | |||
| 239 | <li class="toctree-l1"> | ||
| 240 | |||
| 241 | <span class="caption-text">About</span> | ||
| 242 | <ul class="subnav"> | ||
| 243 | <li class=""> | ||
| 244 | |||
| 245 | <a class="" href="../FAQ/">FAQ</a> | ||
| 246 | </li> | ||
| 247 | <li class=""> | ||
| 248 | |||
| 249 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 250 | </li> | ||
| 251 | </ul> | ||
| 252 | </li> | ||
| 253 | |||
| 254 | </ul> | ||
| 255 | </div> | ||
| 256 | | ||
| 257 | </nav> | ||
| 258 | |||
| 259 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 260 | |||
| 261 | |||
| 262 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 263 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 264 | <a href="..">Shaarli Documentation</a> | ||
| 265 | </nav> | ||
| 266 | |||
| 267 | |||
| 268 | <div class="wy-nav-content"> | ||
| 269 | <div class="rst-content"> | ||
| 270 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 271 | <ul class="wy-breadcrumbs"> | ||
| 272 | <li><a href="..">Docs</a> »</li> | ||
| 273 | |||
| 274 | |||
| 275 | |||
| 276 | <li>How To »</li> | ||
| 277 | |||
| 278 | |||
| 279 | |||
| 280 | <li>Create and serve multiple Shaarlis (farm)</li> | ||
| 281 | <li class="wy-breadcrumbs-aside"> | ||
| 282 | |||
| 283 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Create-and-serve-multiple-Shaarlis-(farm).md" | ||
| 284 | class="icon icon-github"> Edit on GitHub</a> | ||
| 285 | |||
| 286 | </li> | ||
| 287 | </ul> | ||
| 288 | <hr/> | ||
| 289 | </div> | ||
| 290 | <div role="main"> | ||
| 291 | <div class="section"> | ||
| 292 | |||
| 293 | <p>Example bash script (creates multiple shaarli instances and generates an HTML index of them)</p> | ||
| 294 | <pre><code class="bash">#!/bin/bash | ||
| 295 | set -o errexit | ||
| 296 | set -o nounset | ||
| 297 | |||
| 298 | #config | ||
| 299 | shaarli_base_dir='/var/www/shaarli' | ||
| 300 | accounts='bob john whatever username' | ||
| 301 | shaarli_repo_url='https://github.com/shaarli/Shaarli' | ||
| 302 | ref="master" | ||
| 303 | |||
| 304 | #clone multiple shaarli instances | ||
| 305 | if [ ! -d "$shaarli_base_dir" ]; then mkdir "$shaarli_base_dir"; fi | ||
| 306 | |||
| 307 | for account in $accounts; do | ||
| 308 | if [ -d "$shaarli_base_dir/$account" ]; | ||
| 309 | then echo "[info] account $account already exists, skipping"; | ||
| 310 | else echo "[info] creating new account $account ..."; git clone --quiet "$shaarli_repo_url" -b "$ref" "$shaarli_base_dir/$account"; fi | ||
| 311 | done | ||
| 312 | |||
| 313 | #generate html index of shaarlis | ||
| 314 | htmlhead='<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> | ||
| 315 | <!-- Minimal html template thanks to http://www.sitepoint.com/a-minimal-html-document/ --> | ||
| 316 | <html lang="en"> | ||
| 317 | <head> | ||
| 318 | <meta http-equiv="content-type" content="text/html; charset=utf-8"> | ||
| 319 | <title>My Shaarli farm</title> | ||
| 320 | <style>body {font-family: "Open Sans"}</style> | ||
| 321 | </head> | ||
| 322 | <body> | ||
| 323 | <div> | ||
| 324 | <h1>My Shaarli farm</h1> | ||
| 325 | <ul style="list-style-type: none;">' | ||
| 326 | |||
| 327 | accountlinks='' | ||
| 328 | |||
| 329 | htmlfooter=' | ||
| 330 | </ul> | ||
| 331 | </div> | ||
| 332 | </body> | ||
| 333 | </html>' | ||
| 334 | |||
| 335 | |||
| 336 | |||
| 337 | for account in $accounts; do accountlinks="$accountlinks\n<li><a href=\"$account\">$account</a></li>"; done | ||
| 338 | if [ -d "$shaarli_base_dir/index.html" ]; then echo "[removing old index.html]"; rm "$shaarli_base_dir/index.html" ]; fi | ||
| 339 | echo "[info] generating new index of shaarlis" | ||
| 340 | echo -e "$htmlhead $accountlinks $htmlfooter" > "$shaarli_base_dir/index.html" | ||
| 341 | echo '[info] done.' | ||
| 342 | echo "[info] list of accounts: $accounts" | ||
| 343 | echo "[info] contents of $shaarli_base_dir:" | ||
| 344 | tree -a -L 1 "$shaarli_base_dir" | ||
| 345 | </code></pre> | ||
| 346 | |||
| 347 | <p>This script just serves as an example. More precise or complex (applying custom configuration, etc) automation is possible using configuration management software like <a href="https://www.ansible.com/">Ansible</a></p> | ||
| 348 | |||
| 349 | </div> | ||
| 350 | </div> | ||
| 351 | <footer> | ||
| 352 | |||
| 353 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 354 | |||
| 355 | <a href="../Download-CSS-styles-from-an-OPML-list/" class="btn btn-neutral float-right" title="Download CSS styles from an OPML list">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 356 | |||
| 357 | |||
| 358 | <a href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/" class="btn btn-neutral" title="Copy an existing installation over SSH and serve it locally"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 359 | |||
| 360 | </div> | ||
| 361 | |||
| 362 | |||
| 363 | <hr/> | ||
| 364 | |||
| 365 | <div role="contentinfo"> | ||
| 366 | <!-- Copyright etc --> | ||
| 367 | |||
| 368 | </div> | ||
| 369 | |||
| 370 | 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>. | ||
| 371 | </footer> | ||
| 372 | |||
| 373 | </div> | ||
| 374 | </div> | ||
| 375 | |||
| 376 | </section> | ||
| 377 | |||
| 378 | </div> | ||
| 379 | |||
| 380 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 381 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 382 | |||
| 383 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 384 | |||
| 385 | |||
| 386 | <span><a href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 387 | |||
| 388 | |||
| 389 | <span style="margin-left: 15px"><a href="../Download-CSS-styles-from-an-OPML-list/" style="color: #fcfcfc">Next »</a></span> | ||
| 390 | |||
| 391 | </span> | ||
| 392 | </div> | ||
| 393 | <script src="../js/theme.js"></script> | ||
| 394 | |||
| 395 | </body> | ||
| 396 | </html> | ||
diff --git a/doc/html/Datastore-hacks/index.html b/doc/html/Datastore-hacks/index.html new file mode 100644 index 00000000..b3d8d97e --- /dev/null +++ b/doc/html/Datastore-hacks/index.html | |||
| @@ -0,0 +1,369 @@ | |||
| 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>Datastore hacks - 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 = "Datastore hacks"; | ||
| 22 | var mkdocs_page_input_path = "Datastore-hacks.md"; | ||
| 23 | var mkdocs_page_url = "/Datastore-hacks/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="../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="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 156 | </li> | ||
| 157 | <li class=""> | ||
| 158 | |||
| 159 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 160 | </li> | ||
| 161 | <li class=""> | ||
| 162 | |||
| 163 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 164 | </li> | ||
| 165 | <li class=" current"> | ||
| 166 | |||
| 167 | <a class="current" href="./">Datastore hacks</a> | ||
| 168 | <ul class="subnav"> | ||
| 169 | |||
| 170 | <li class="toctree-l3"><a href="#decode-datastore-content">Decode datastore content</a></li> | ||
| 171 | |||
| 172 | |||
| 173 | <li class="toctree-l3"><a href="#changing-the-timestamp-for-a-link">Changing the timestamp for a link</a></li> | ||
| 174 | |||
| 175 | |||
| 176 | </ul> | ||
| 177 | </li> | ||
| 178 | </ul> | ||
| 179 | </li> | ||
| 180 | |||
| 181 | <li class="toctree-l1"> | ||
| 182 | |||
| 183 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 184 | </li> | ||
| 185 | |||
| 186 | <li class="toctree-l1"> | ||
| 187 | |||
| 188 | <span class="caption-text">Development</span> | ||
| 189 | <ul class="subnav"> | ||
| 190 | <li class=""> | ||
| 191 | |||
| 192 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 193 | </li> | ||
| 194 | <li class=""> | ||
| 195 | |||
| 196 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 197 | </li> | ||
| 198 | <li class=""> | ||
| 199 | |||
| 200 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 201 | </li> | ||
| 202 | <li class=""> | ||
| 203 | |||
| 204 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 205 | </li> | ||
| 206 | <li class=""> | ||
| 207 | |||
| 208 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 209 | </li> | ||
| 210 | <li class=""> | ||
| 211 | |||
| 212 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 213 | </li> | ||
| 214 | <li class=""> | ||
| 215 | |||
| 216 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 217 | </li> | ||
| 218 | <li class=""> | ||
| 219 | |||
| 220 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 221 | </li> | ||
| 222 | <li class=""> | ||
| 223 | |||
| 224 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 225 | </li> | ||
| 226 | <li class=""> | ||
| 227 | |||
| 228 | <a class="" href="../Security/">Security</a> | ||
| 229 | </li> | ||
| 230 | <li class=""> | ||
| 231 | |||
| 232 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 233 | </li> | ||
| 234 | <li class=""> | ||
| 235 | |||
| 236 | <a class="" href="../Theming/">Theming</a> | ||
| 237 | </li> | ||
| 238 | <li class=""> | ||
| 239 | |||
| 240 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 241 | </li> | ||
| 242 | </ul> | ||
| 243 | </li> | ||
| 244 | |||
| 245 | <li class="toctree-l1"> | ||
| 246 | |||
| 247 | <span class="caption-text">About</span> | ||
| 248 | <ul class="subnav"> | ||
| 249 | <li class=""> | ||
| 250 | |||
| 251 | <a class="" href="../FAQ/">FAQ</a> | ||
| 252 | </li> | ||
| 253 | <li class=""> | ||
| 254 | |||
| 255 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 256 | </li> | ||
| 257 | </ul> | ||
| 258 | </li> | ||
| 259 | |||
| 260 | </ul> | ||
| 261 | </div> | ||
| 262 | | ||
| 263 | </nav> | ||
| 264 | |||
| 265 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 266 | |||
| 267 | |||
| 268 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 269 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 270 | <a href="..">Shaarli Documentation</a> | ||
| 271 | </nav> | ||
| 272 | |||
| 273 | |||
| 274 | <div class="wy-nav-content"> | ||
| 275 | <div class="rst-content"> | ||
| 276 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 277 | <ul class="wy-breadcrumbs"> | ||
| 278 | <li><a href="..">Docs</a> »</li> | ||
| 279 | |||
| 280 | |||
| 281 | |||
| 282 | <li>How To »</li> | ||
| 283 | |||
| 284 | |||
| 285 | |||
| 286 | <li>Datastore hacks</li> | ||
| 287 | <li class="wy-breadcrumbs-aside"> | ||
| 288 | |||
| 289 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Datastore-hacks.md" | ||
| 290 | class="icon icon-github"> Edit on GitHub</a> | ||
| 291 | |||
| 292 | </li> | ||
| 293 | </ul> | ||
| 294 | <hr/> | ||
| 295 | </div> | ||
| 296 | <div role="main"> | ||
| 297 | <div class="section"> | ||
| 298 | |||
| 299 | <h3 id="decode-datastore-content">Decode datastore content</h3> | ||
| 300 | <p>To display the array representing the data saved in <code>data/datastore.php</code>, use the following snippet:</p> | ||
| 301 | <pre><code class="php">$data = "tZNdb9MwFIb... <Commented content inside datastore.php>"; | ||
| 302 | $out = unserialize(gzinflate(base64_decode($data))); | ||
| 303 | echo "<pre>"; // Pretty printing is love, pretty printing is life | ||
| 304 | print_r($out); | ||
| 305 | echo "</pre>"; | ||
| 306 | exit; | ||
| 307 | </code></pre> | ||
| 308 | |||
| 309 | <p>This will output the internal representation of the datastore, "unobfuscated" (if this can really be considered obfuscation).</p> | ||
| 310 | <p>Alternatively, you can transform to JSON format (and pretty-print if you have <code>jq</code> installed):</p> | ||
| 311 | <pre><code>php -r 'print(json_encode(unserialize(gzinflate(base64_decode(preg_replace("!.*/\* (.+) \*/.*!", "$1", file_get_contents("data/datastore.php")))))));' | jq . | ||
| 312 | </code></pre> | ||
| 313 | |||
| 314 | <h3 id="changing-the-timestamp-for-a-link">Changing the timestamp for a link</h3> | ||
| 315 | <ul> | ||
| 316 | <li>Look for <code><input type="hidden" name="lf_linkdate" value="{$link.linkdate}"></code> in <code>tpl/editlink.tpl</code> (line 14)</li> | ||
| 317 | <li>Replace <code>type="hidden"</code> with <code>type="text"</code> from this line</li> | ||
| 318 | <li>A new date/time field becomes available in the edit/new link dialog.</li> | ||
| 319 | <li>You can set the timestamp manually by entering it in the format <code>YYYMMDD_HHMMS</code>.</li> | ||
| 320 | </ul> | ||
| 321 | |||
| 322 | </div> | ||
| 323 | </div> | ||
| 324 | <footer> | ||
| 325 | |||
| 326 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 327 | |||
| 328 | <a href="../Troubleshooting/" class="btn btn-neutral float-right" title="Troubleshooting">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 329 | |||
| 330 | |||
| 331 | <a href="../Download-CSS-styles-from-an-OPML-list/" class="btn btn-neutral" title="Download CSS styles from an OPML list"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 332 | |||
| 333 | </div> | ||
| 334 | |||
| 335 | |||
| 336 | <hr/> | ||
| 337 | |||
| 338 | <div role="contentinfo"> | ||
| 339 | <!-- Copyright etc --> | ||
| 340 | |||
| 341 | </div> | ||
| 342 | |||
| 343 | 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>. | ||
| 344 | </footer> | ||
| 345 | |||
| 346 | </div> | ||
| 347 | </div> | ||
| 348 | |||
| 349 | </section> | ||
| 350 | |||
| 351 | </div> | ||
| 352 | |||
| 353 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 354 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 355 | |||
| 356 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 357 | |||
| 358 | |||
| 359 | <span><a href="../Download-CSS-styles-from-an-OPML-list/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 360 | |||
| 361 | |||
| 362 | <span style="margin-left: 15px"><a href="../Troubleshooting/" style="color: #fcfcfc">Next »</a></span> | ||
| 363 | |||
| 364 | </span> | ||
| 365 | </div> | ||
| 366 | <script src="../js/theme.js"></script> | ||
| 367 | |||
| 368 | </body> | ||
| 369 | </html> | ||
diff --git a/doc/html/Development-guidelines/index.html b/doc/html/Development-guidelines/index.html new file mode 100644 index 00000000..747d53a8 --- /dev/null +++ b/doc/html/Development-guidelines/index.html | |||
| @@ -0,0 +1,352 @@ | |||
| 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>Development guidelines - 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 = "Development guidelines"; | ||
| 22 | var mkdocs_page_input_path = "Development-guidelines.md"; | ||
| 23 | var mkdocs_page_url = "/Development-guidelines/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="../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="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 156 | </li> | ||
| 157 | <li class=""> | ||
| 158 | |||
| 159 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 160 | </li> | ||
| 161 | <li class=""> | ||
| 162 | |||
| 163 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 164 | </li> | ||
| 165 | <li class=""> | ||
| 166 | |||
| 167 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 168 | </li> | ||
| 169 | </ul> | ||
| 170 | </li> | ||
| 171 | |||
| 172 | <li class="toctree-l1"> | ||
| 173 | |||
| 174 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 175 | </li> | ||
| 176 | |||
| 177 | <li class="toctree-l1"> | ||
| 178 | |||
| 179 | <span class="caption-text">Development</span> | ||
| 180 | <ul class="subnav"> | ||
| 181 | <li class=" current"> | ||
| 182 | |||
| 183 | <a class="current" href="./">Development guidelines</a> | ||
| 184 | <ul class="subnav"> | ||
| 185 | |||
| 186 | <li class="toctree-l3"><a href="#development-guidelines">Development guidelines</a></li> | ||
| 187 | |||
| 188 | |||
| 189 | </ul> | ||
| 190 | </li> | ||
| 191 | <li class=""> | ||
| 192 | |||
| 193 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 194 | </li> | ||
| 195 | <li class=""> | ||
| 196 | |||
| 197 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 198 | </li> | ||
| 199 | <li class=""> | ||
| 200 | |||
| 201 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 202 | </li> | ||
| 203 | <li class=""> | ||
| 204 | |||
| 205 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 206 | </li> | ||
| 207 | <li class=""> | ||
| 208 | |||
| 209 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 210 | </li> | ||
| 211 | <li class=""> | ||
| 212 | |||
| 213 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 214 | </li> | ||
| 215 | <li class=""> | ||
| 216 | |||
| 217 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 218 | </li> | ||
| 219 | <li class=""> | ||
| 220 | |||
| 221 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 222 | </li> | ||
| 223 | <li class=""> | ||
| 224 | |||
| 225 | <a class="" href="../Security/">Security</a> | ||
| 226 | </li> | ||
| 227 | <li class=""> | ||
| 228 | |||
| 229 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 230 | </li> | ||
| 231 | <li class=""> | ||
| 232 | |||
| 233 | <a class="" href="../Theming/">Theming</a> | ||
| 234 | </li> | ||
| 235 | <li class=""> | ||
| 236 | |||
| 237 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 238 | </li> | ||
| 239 | </ul> | ||
| 240 | </li> | ||
| 241 | |||
| 242 | <li class="toctree-l1"> | ||
| 243 | |||
| 244 | <span class="caption-text">About</span> | ||
| 245 | <ul class="subnav"> | ||
| 246 | <li class=""> | ||
| 247 | |||
| 248 | <a class="" href="../FAQ/">FAQ</a> | ||
| 249 | </li> | ||
| 250 | <li class=""> | ||
| 251 | |||
| 252 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 253 | </li> | ||
| 254 | </ul> | ||
| 255 | </li> | ||
| 256 | |||
| 257 | </ul> | ||
| 258 | </div> | ||
| 259 | | ||
| 260 | </nav> | ||
| 261 | |||
| 262 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 263 | |||
| 264 | |||
| 265 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 266 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 267 | <a href="..">Shaarli Documentation</a> | ||
| 268 | </nav> | ||
| 269 | |||
| 270 | |||
| 271 | <div class="wy-nav-content"> | ||
| 272 | <div class="rst-content"> | ||
| 273 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 274 | <ul class="wy-breadcrumbs"> | ||
| 275 | <li><a href="..">Docs</a> »</li> | ||
| 276 | |||
| 277 | |||
| 278 | |||
| 279 | <li>Development »</li> | ||
| 280 | |||
| 281 | |||
| 282 | |||
| 283 | <li>Development guidelines</li> | ||
| 284 | <li class="wy-breadcrumbs-aside"> | ||
| 285 | |||
| 286 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Development-guidelines.md" | ||
| 287 | class="icon icon-github"> Edit on GitHub</a> | ||
| 288 | |||
| 289 | </li> | ||
| 290 | </ul> | ||
| 291 | <hr/> | ||
| 292 | </div> | ||
| 293 | <div role="main"> | ||
| 294 | <div class="section"> | ||
| 295 | |||
| 296 | <h2 id="development-guidelines">Development guidelines</h2> | ||
| 297 | <p>Please have a look at the following pages: | ||
| 298 | - <a href="https://github.com/shaarli/Shaarli/tree/master/CONTRIBUTING.md">Contributing to Shaarli</a> | ||
| 299 | - <a href="../Static analysis">Static analysis</a> - patches should try to stick to the <a href="http://www.php-fig.org/psr/">PHP Standard Recommendations</a> (PSR), especially: | ||
| 300 | - <a href="http://www.php-fig.org/psr/psr-1/">PSR-1</a> - Basic Coding Standard | ||
| 301 | - <a href="http://www.php-fig.org/psr/psr-2/">PSR-2</a> - Coding Style Guide | ||
| 302 | - <a href="../Unit tests">Unit tests</a> | ||
| 303 | - <a href="../GnuPG signature">GnuPG signature</a> for tags/releases</p> | ||
| 304 | |||
| 305 | </div> | ||
| 306 | </div> | ||
| 307 | <footer> | ||
| 308 | |||
| 309 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 310 | |||
| 311 | <a href="../Continuous-integration-tools/" class="btn btn-neutral float-right" title="Continuous integration tools">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 312 | |||
| 313 | |||
| 314 | <a href="../Troubleshooting/" class="btn btn-neutral" title="Troubleshooting"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 315 | |||
| 316 | </div> | ||
| 317 | |||
| 318 | |||
| 319 | <hr/> | ||
| 320 | |||
| 321 | <div role="contentinfo"> | ||
| 322 | <!-- Copyright etc --> | ||
| 323 | |||
| 324 | </div> | ||
| 325 | |||
| 326 | 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>. | ||
| 327 | </footer> | ||
| 328 | |||
| 329 | </div> | ||
| 330 | </div> | ||
| 331 | |||
| 332 | </section> | ||
| 333 | |||
| 334 | </div> | ||
| 335 | |||
| 336 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 337 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 338 | |||
| 339 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 340 | |||
| 341 | |||
| 342 | <span><a href="../Troubleshooting/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 343 | |||
| 344 | |||
| 345 | <span style="margin-left: 15px"><a href="../Continuous-integration-tools/" style="color: #fcfcfc">Next »</a></span> | ||
| 346 | |||
| 347 | </span> | ||
| 348 | </div> | ||
| 349 | <script src="../js/theme.js"></script> | ||
| 350 | |||
| 351 | </body> | ||
| 352 | </html> | ||
diff --git a/doc/html/Directory-structure/index.html b/doc/html/Directory-structure/index.html new file mode 100644 index 00000000..82979774 --- /dev/null +++ b/doc/html/Directory-structure/index.html | |||
| @@ -0,0 +1,371 @@ | |||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="../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="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 156 | </li> | ||
| 157 | <li class=""> | ||
| 158 | |||
| 159 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 160 | </li> | ||
| 161 | <li class=""> | ||
| 162 | |||
| 163 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 164 | </li> | ||
| 165 | <li class=""> | ||
| 166 | |||
| 167 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 168 | </li> | ||
| 169 | </ul> | ||
| 170 | </li> | ||
| 171 | |||
| 172 | <li class="toctree-l1"> | ||
| 173 | |||
| 174 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 175 | </li> | ||
| 176 | |||
| 177 | <li class="toctree-l1"> | ||
| 178 | |||
| 179 | <span class="caption-text">Development</span> | ||
| 180 | <ul class="subnav"> | ||
| 181 | <li class=""> | ||
| 182 | |||
| 183 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 184 | </li> | ||
| 185 | <li class=""> | ||
| 186 | |||
| 187 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 188 | </li> | ||
| 189 | <li class=""> | ||
| 190 | |||
| 191 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 192 | </li> | ||
| 193 | <li class=""> | ||
| 194 | |||
| 195 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 196 | </li> | ||
| 197 | <li class=" current"> | ||
| 198 | |||
| 199 | <a class="current" href="./">Directory structure</a> | ||
| 200 | <ul class="subnav"> | ||
| 201 | |||
| 202 | </ul> | ||
| 203 | </li> | ||
| 204 | <li class=""> | ||
| 205 | |||
| 206 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 207 | </li> | ||
| 208 | <li class=""> | ||
| 209 | |||
| 210 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 211 | </li> | ||
| 212 | <li class=""> | ||
| 213 | |||
| 214 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 215 | </li> | ||
| 216 | <li class=""> | ||
| 217 | |||
| 218 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 219 | </li> | ||
| 220 | <li class=""> | ||
| 221 | |||
| 222 | <a class="" href="../Security/">Security</a> | ||
| 223 | </li> | ||
| 224 | <li class=""> | ||
| 225 | |||
| 226 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 227 | </li> | ||
| 228 | <li class=""> | ||
| 229 | |||
| 230 | <a class="" href="../Theming/">Theming</a> | ||
| 231 | </li> | ||
| 232 | <li class=""> | ||
| 233 | |||
| 234 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 235 | </li> | ||
| 236 | </ul> | ||
| 237 | </li> | ||
| 238 | |||
| 239 | <li class="toctree-l1"> | ||
| 240 | |||
| 241 | <span class="caption-text">About</span> | ||
| 242 | <ul class="subnav"> | ||
| 243 | <li class=""> | ||
| 244 | |||
| 245 | <a class="" href="../FAQ/">FAQ</a> | ||
| 246 | </li> | ||
| 247 | <li class=""> | ||
| 248 | |||
| 249 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 250 | </li> | ||
| 251 | </ul> | ||
| 252 | </li> | ||
| 253 | |||
| 254 | </ul> | ||
| 255 | </div> | ||
| 256 | | ||
| 257 | </nav> | ||
| 258 | |||
| 259 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 260 | |||
| 261 | |||
| 262 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 263 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 264 | <a href="..">Shaarli Documentation</a> | ||
| 265 | </nav> | ||
| 266 | |||
| 267 | |||
| 268 | <div class="wy-nav-content"> | ||
| 269 | <div class="rst-content"> | ||
| 270 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 271 | <ul class="wy-breadcrumbs"> | ||
| 272 | <li><a href="..">Docs</a> »</li> | ||
| 273 | |||
| 274 | |||
| 275 | |||
| 276 | <li>Development »</li> | ||
| 277 | |||
| 278 | |||
| 279 | |||
| 280 | <li>Directory structure</li> | ||
| 281 | <li class="wy-breadcrumbs-aside"> | ||
| 282 | |||
| 283 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Directory-structure.md" | ||
| 284 | class="icon icon-github"> Edit on GitHub</a> | ||
| 285 | |||
| 286 | </li> | ||
| 287 | </ul> | ||
| 288 | <hr/> | ||
| 289 | </div> | ||
| 290 | <div role="main"> | ||
| 291 | <div class="section"> | ||
| 292 | |||
| 293 | <p>Here is the directory structure of Shaarli and the purpose of the different files:</p> | ||
| 294 | <pre><code class="bash"> index.php # Main program | ||
| 295 | application/ # Shaarli classes | ||
| 296 | ├── LinkDB.php | ||
| 297 | └── Utils.php | ||
| 298 | tests/ # Shaarli unitary & functional tests | ||
| 299 | ├── LinkDBTest.php | ||
| 300 | ├── utils # utilities to ease testing | ||
| 301 | │ └── ReferenceLinkDB.php | ||
| 302 | └── UtilsTest.php | ||
| 303 | COPYING # Shaarli license | ||
| 304 | inc/ # static assets and 3rd party libraries | ||
| 305 | ├── awesomplete.* # tags autocompletion library | ||
| 306 | ├── blazy.* # picture wall lazy image loading library | ||
| 307 | ├── shaarli.css, reset.css # Shaarli stylesheet. | ||
| 308 | ├── qr.* # qr code generation library | ||
| 309 | └──rain.tpl.class.php # RainTPL templating library | ||
| 310 | tpl/ # RainTPL templates for Shaarli. They are used to build the pages. | ||
| 311 | images/ # Images and icons used in Shaarli | ||
| 312 | data/ # data storage: bookmark database, configuration, logs, banlist… | ||
| 313 | ├── config.php # Shaarli configuration (login, password, timezone, title…) | ||
| 314 | ├── datastore.php # Your link database (compressed). | ||
| 315 | ├── ipban.php # IP address ban system data | ||
| 316 | ├── lastupdatecheck.txt # Update check timestamp file | ||
| 317 | └──log.txt # login/IPban log. | ||
| 318 | cache/ # thumbnails cache | ||
| 319 | # This directory is automatically created. You can erase it anytime you want. | ||
| 320 | tmp/ # Temporary directory for compiled RainTPL templates. | ||
| 321 | # This directory is automatically created. You can erase it anytime you want. | ||
| 322 | </code></pre> | ||
| 323 | |||
| 324 | </div> | ||
| 325 | </div> | ||
| 326 | <footer> | ||
| 327 | |||
| 328 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 329 | |||
| 330 | <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> | ||
| 331 | |||
| 332 | |||
| 333 | <a href="../Coding-guidelines/" class="btn btn-neutral" title="Coding guidelines"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 334 | |||
| 335 | </div> | ||
| 336 | |||
| 337 | |||
| 338 | <hr/> | ||
| 339 | |||
| 340 | <div role="contentinfo"> | ||
| 341 | <!-- Copyright etc --> | ||
| 342 | |||
| 343 | </div> | ||
| 344 | |||
| 345 | 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>. | ||
| 346 | </footer> | ||
| 347 | |||
| 348 | </div> | ||
| 349 | </div> | ||
| 350 | |||
| 351 | </section> | ||
| 352 | |||
| 353 | </div> | ||
| 354 | |||
| 355 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 356 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 357 | |||
| 358 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 359 | |||
| 360 | |||
| 361 | <span><a href="../Coding-guidelines/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 362 | |||
| 363 | |||
| 364 | <span style="margin-left: 15px"><a href="../3rd-party-libraries/" style="color: #fcfcfc">Next »</a></span> | ||
| 365 | |||
| 366 | </span> | ||
| 367 | </div> | ||
| 368 | <script src="../js/theme.js"></script> | ||
| 369 | |||
| 370 | </body> | ||
| 371 | </html> | ||
diff --git a/doc/html/Docker-101/index.html b/doc/html/Docker-101/index.html new file mode 100644 index 00000000..5b4f645c --- /dev/null +++ b/doc/html/Docker-101/index.html | |||
| @@ -0,0 +1,410 @@ | |||
| 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>Docker 101 - 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 = "Docker 101"; | ||
| 22 | var mkdocs_page_input_path = "Docker-101.md"; | ||
| 23 | var mkdocs_page_url = "/Docker-101/"; | ||
| 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=" current"> | ||
| 96 | |||
| 97 | <a class="current" href="./">Docker 101</a> | ||
| 98 | <ul class="subnav"> | ||
| 99 | |||
| 100 | <li class="toctree-l3"><a href="#basics">Basics</a></li> | ||
| 101 | |||
| 102 | <ul> | ||
| 103 | |||
| 104 | <li><a class="toctree-l4" href="#search-an-image-on-dockerhub">Search an image on DockerHub</a></li> | ||
| 105 | |||
| 106 | <li><a class="toctree-l4" href="#show-available-tags-for-a-repository">Show available tags for a repository</a></li> | ||
| 107 | |||
| 108 | <li><a class="toctree-l4" href="#pull-an-image-from-dockerhub">Pull an image from DockerHub</a></li> | ||
| 109 | |||
| 110 | </ul> | ||
| 111 | |||
| 112 | |||
| 113 | </ul> | ||
| 114 | </li> | ||
| 115 | <li class=""> | ||
| 116 | |||
| 117 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 118 | </li> | ||
| 119 | <li class=""> | ||
| 120 | |||
| 121 | <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a> | ||
| 122 | </li> | ||
| 123 | <li class=""> | ||
| 124 | |||
| 125 | <a class="" href="../Docker-resources/">Docker resources</a> | ||
| 126 | </li> | ||
| 127 | </ul> | ||
| 128 | </li> | ||
| 129 | |||
| 130 | <li class="toctree-l1"> | ||
| 131 | |||
| 132 | <span class="caption-text">Usage</span> | ||
| 133 | <ul class="subnav"> | ||
| 134 | <li class=""> | ||
| 135 | |||
| 136 | <a class="" href="../Features/">Features</a> | ||
| 137 | </li> | ||
| 138 | <li class=""> | ||
| 139 | |||
| 140 | <a class="" href="../Bookmarklet/">Bookmarklet</a> | ||
| 141 | </li> | ||
| 142 | <li class=""> | ||
| 143 | |||
| 144 | <a class="" href="../Browsing-and-searching/">Browsing and searching</a> | ||
| 145 | </li> | ||
| 146 | <li class=""> | ||
| 147 | |||
| 148 | <a class="" href="../Firefox-share/">Firefox share</a> | ||
| 149 | </li> | ||
| 150 | <li class=""> | ||
| 151 | |||
| 152 | <a class="" href="../RSS-feeds/">RSS feeds</a> | ||
| 153 | </li> | ||
| 154 | <li class=""> | ||
| 155 | |||
| 156 | <a class="" href="../REST-API/">REST API</a> | ||
| 157 | </li> | ||
| 158 | </ul> | ||
| 159 | </li> | ||
| 160 | |||
| 161 | <li class="toctree-l1"> | ||
| 162 | |||
| 163 | <span class="caption-text">How To</span> | ||
| 164 | <ul class="subnav"> | ||
| 165 | <li class=""> | ||
| 166 | |||
| 167 | <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a> | ||
| 168 | </li> | ||
| 169 | <li class=""> | ||
| 170 | |||
| 171 | <a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 172 | </li> | ||
| 173 | <li class=""> | ||
| 174 | |||
| 175 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 176 | </li> | ||
| 177 | <li class=""> | ||
| 178 | |||
| 179 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 180 | </li> | ||
| 181 | <li class=""> | ||
| 182 | |||
| 183 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 184 | </li> | ||
| 185 | </ul> | ||
| 186 | </li> | ||
| 187 | |||
| 188 | <li class="toctree-l1"> | ||
| 189 | |||
| 190 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 191 | </li> | ||
| 192 | |||
| 193 | <li class="toctree-l1"> | ||
| 194 | |||
| 195 | <span class="caption-text">Development</span> | ||
| 196 | <ul class="subnav"> | ||
| 197 | <li class=""> | ||
| 198 | |||
| 199 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 200 | </li> | ||
| 201 | <li class=""> | ||
| 202 | |||
| 203 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 204 | </li> | ||
| 205 | <li class=""> | ||
| 206 | |||
| 207 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 208 | </li> | ||
| 209 | <li class=""> | ||
| 210 | |||
| 211 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 212 | </li> | ||
| 213 | <li class=""> | ||
| 214 | |||
| 215 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 216 | </li> | ||
| 217 | <li class=""> | ||
| 218 | |||
| 219 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 220 | </li> | ||
| 221 | <li class=""> | ||
| 222 | |||
| 223 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 224 | </li> | ||
| 225 | <li class=""> | ||
| 226 | |||
| 227 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 228 | </li> | ||
| 229 | <li class=""> | ||
| 230 | |||
| 231 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 232 | </li> | ||
| 233 | <li class=""> | ||
| 234 | |||
| 235 | <a class="" href="../Security/">Security</a> | ||
| 236 | </li> | ||
| 237 | <li class=""> | ||
| 238 | |||
| 239 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 240 | </li> | ||
| 241 | <li class=""> | ||
| 242 | |||
| 243 | <a class="" href="../Theming/">Theming</a> | ||
| 244 | </li> | ||
| 245 | <li class=""> | ||
| 246 | |||
| 247 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 248 | </li> | ||
| 249 | </ul> | ||
| 250 | </li> | ||
| 251 | |||
| 252 | <li class="toctree-l1"> | ||
| 253 | |||
| 254 | <span class="caption-text">About</span> | ||
| 255 | <ul class="subnav"> | ||
| 256 | <li class=""> | ||
| 257 | |||
| 258 | <a class="" href="../FAQ/">FAQ</a> | ||
| 259 | </li> | ||
| 260 | <li class=""> | ||
| 261 | |||
| 262 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 263 | </li> | ||
| 264 | </ul> | ||
| 265 | </li> | ||
| 266 | |||
| 267 | </ul> | ||
| 268 | </div> | ||
| 269 | | ||
| 270 | </nav> | ||
| 271 | |||
| 272 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 273 | |||
| 274 | |||
| 275 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 276 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 277 | <a href="..">Shaarli Documentation</a> | ||
| 278 | </nav> | ||
| 279 | |||
| 280 | |||
| 281 | <div class="wy-nav-content"> | ||
| 282 | <div class="rst-content"> | ||
| 283 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 284 | <ul class="wy-breadcrumbs"> | ||
| 285 | <li><a href="..">Docs</a> »</li> | ||
| 286 | |||
| 287 | |||
| 288 | |||
| 289 | <li>Docker »</li> | ||
| 290 | |||
| 291 | |||
| 292 | |||
| 293 | <li>Docker 101</li> | ||
| 294 | <li class="wy-breadcrumbs-aside"> | ||
| 295 | |||
| 296 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Docker-101.md" | ||
| 297 | class="icon icon-github"> Edit on GitHub</a> | ||
| 298 | |||
| 299 | </li> | ||
| 300 | </ul> | ||
| 301 | <hr/> | ||
| 302 | </div> | ||
| 303 | <div role="main"> | ||
| 304 | <div class="section"> | ||
| 305 | |||
| 306 | <h2 id="basics">Basics</h2> | ||
| 307 | <p>Install <a href="https://www.docker.com/">Docker</a>, by following the instructions relevant | ||
| 308 | to your OS / distribution, and start the service.</p> | ||
| 309 | <h3 id="search-an-image-on-dockerhub">Search an image on <a href="https://hub.docker.com/">DockerHub</a></h3> | ||
| 310 | <pre><code class="bash">$ docker search debian | ||
| 311 | |||
| 312 | NAME DESCRIPTION STARS OFFICIAL AUTOMATED | ||
| 313 | ubuntu Ubuntu is a Debian-based Linux operating s... 2065 [OK] | ||
| 314 | debian Debian is a Linux distribution that's comp... 603 [OK] | ||
| 315 | google/debian 47 [OK] | ||
| 316 | </code></pre> | ||
| 317 | |||
| 318 | <h3 id="show-available-tags-for-a-repository">Show available tags for a repository</h3> | ||
| 319 | <pre><code class="bash">$ curl https://index.docker.io/v1/repositories/debian/tags | python -m json.tool | ||
| 320 | |||
| 321 | % Total % Received % Xferd Average Speed Time Time Time Current | ||
| 322 | Dload Upload Total Spent Left Speed | ||
| 323 | 100 1283 0 1283 0 0 433 0 --:--:-- 0:00:02 --:--:-- 433 | ||
| 324 | </code></pre> | ||
| 325 | |||
| 326 | <p>Sample output:</p> | ||
| 327 | <pre><code class="json">[ | ||
| 328 | { | ||
| 329 | "layer": "85a02782", | ||
| 330 | "name": "stretch" | ||
| 331 | }, | ||
| 332 | { | ||
| 333 | "layer": "59abecbc", | ||
| 334 | "name": "testing" | ||
| 335 | }, | ||
| 336 | { | ||
| 337 | "layer": "bf0fd686", | ||
| 338 | "name": "unstable" | ||
| 339 | }, | ||
| 340 | { | ||
| 341 | "layer": "60c52dbe", | ||
| 342 | "name": "wheezy" | ||
| 343 | }, | ||
| 344 | { | ||
| 345 | "layer": "c5b806fe", | ||
| 346 | "name": "wheezy-backports" | ||
| 347 | } | ||
| 348 | ] | ||
| 349 | |||
| 350 | </code></pre> | ||
| 351 | |||
| 352 | <h3 id="pull-an-image-from-dockerhub">Pull an image from DockerHub</h3> | ||
| 353 | <pre><code class="bash">$ docker pull repository[:tag] | ||
| 354 | |||
| 355 | $ docker pull debian:wheezy | ||
| 356 | wheezy: Pulling from debian | ||
| 357 | 4c8cbfd2973e: Pull complete | ||
| 358 | 60c52dbe9d91: Pull complete | ||
| 359 | Digest: sha256:c584131da2ac1948aa3e66468a4424b6aea2f33acba7cec0b631bdb56254c4fe | ||
| 360 | Status: Downloaded newer image for debian:wheezy | ||
| 361 | </code></pre> | ||
| 362 | |||
| 363 | </div> | ||
| 364 | </div> | ||
| 365 | <footer> | ||
| 366 | |||
| 367 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 368 | |||
| 369 | <a href="../Shaarli-images/" class="btn btn-neutral float-right" title="Shaarli images">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 370 | |||
| 371 | |||
| 372 | <a href="../Plugins/" class="btn btn-neutral" title="Plugins"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 373 | |||
| 374 | </div> | ||
| 375 | |||
| 376 | |||
| 377 | <hr/> | ||
| 378 | |||
| 379 | <div role="contentinfo"> | ||
| 380 | <!-- Copyright etc --> | ||
| 381 | |||
| 382 | </div> | ||
| 383 | |||
| 384 | 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>. | ||
| 385 | </footer> | ||
| 386 | |||
| 387 | </div> | ||
| 388 | </div> | ||
| 389 | |||
| 390 | </section> | ||
| 391 | |||
| 392 | </div> | ||
| 393 | |||
| 394 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 395 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 396 | |||
| 397 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 398 | |||
| 399 | |||
| 400 | <span><a href="../Plugins/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 401 | |||
| 402 | |||
| 403 | <span style="margin-left: 15px"><a href="../Shaarli-images/" style="color: #fcfcfc">Next »</a></span> | ||
| 404 | |||
| 405 | </span> | ||
| 406 | </div> | ||
| 407 | <script src="../js/theme.js"></script> | ||
| 408 | |||
| 409 | </body> | ||
| 410 | </html> | ||
diff --git a/doc/html/Docker-resources/index.html b/doc/html/Docker-resources/index.html new file mode 100644 index 00000000..7bd7067d --- /dev/null +++ b/doc/html/Docker-resources/index.html | |||
| @@ -0,0 +1,370 @@ | |||
| 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>Docker resources - 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 = "Docker resources"; | ||
| 22 | var mkdocs_page_input_path = "Docker-resources.md"; | ||
| 23 | var mkdocs_page_url = "/Docker-resources/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a> | ||
| 106 | </li> | ||
| 107 | <li class=" current"> | ||
| 108 | |||
| 109 | <a class="current" href="./">Docker resources</a> | ||
| 110 | <ul class="subnav"> | ||
| 111 | |||
| 112 | <li class="toctree-l3"><a href="#docker">Docker</a></li> | ||
| 113 | |||
| 114 | |||
| 115 | <li class="toctree-l3"><a href="#dockerhub">DockerHub</a></li> | ||
| 116 | |||
| 117 | |||
| 118 | <li class="toctree-l3"><a href="#service-management">Service management</a></li> | ||
| 119 | |||
| 120 | |||
| 121 | </ul> | ||
| 122 | </li> | ||
| 123 | </ul> | ||
| 124 | </li> | ||
| 125 | |||
| 126 | <li class="toctree-l1"> | ||
| 127 | |||
| 128 | <span class="caption-text">Usage</span> | ||
| 129 | <ul class="subnav"> | ||
| 130 | <li class=""> | ||
| 131 | |||
| 132 | <a class="" href="../Features/">Features</a> | ||
| 133 | </li> | ||
| 134 | <li class=""> | ||
| 135 | |||
| 136 | <a class="" href="../Bookmarklet/">Bookmarklet</a> | ||
| 137 | </li> | ||
| 138 | <li class=""> | ||
| 139 | |||
| 140 | <a class="" href="../Browsing-and-searching/">Browsing and searching</a> | ||
| 141 | </li> | ||
| 142 | <li class=""> | ||
| 143 | |||
| 144 | <a class="" href="../Firefox-share/">Firefox share</a> | ||
| 145 | </li> | ||
| 146 | <li class=""> | ||
| 147 | |||
| 148 | <a class="" href="../RSS-feeds/">RSS feeds</a> | ||
| 149 | </li> | ||
| 150 | <li class=""> | ||
| 151 | |||
| 152 | <a class="" href="../REST-API/">REST API</a> | ||
| 153 | </li> | ||
| 154 | </ul> | ||
| 155 | </li> | ||
| 156 | |||
| 157 | <li class="toctree-l1"> | ||
| 158 | |||
| 159 | <span class="caption-text">How To</span> | ||
| 160 | <ul class="subnav"> | ||
| 161 | <li class=""> | ||
| 162 | |||
| 163 | <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a> | ||
| 164 | </li> | ||
| 165 | <li class=""> | ||
| 166 | |||
| 167 | <a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 168 | </li> | ||
| 169 | <li class=""> | ||
| 170 | |||
| 171 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 172 | </li> | ||
| 173 | <li class=""> | ||
| 174 | |||
| 175 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 176 | </li> | ||
| 177 | <li class=""> | ||
| 178 | |||
| 179 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 180 | </li> | ||
| 181 | </ul> | ||
| 182 | </li> | ||
| 183 | |||
| 184 | <li class="toctree-l1"> | ||
| 185 | |||
| 186 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 187 | </li> | ||
| 188 | |||
| 189 | <li class="toctree-l1"> | ||
| 190 | |||
| 191 | <span class="caption-text">Development</span> | ||
| 192 | <ul class="subnav"> | ||
| 193 | <li class=""> | ||
| 194 | |||
| 195 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 196 | </li> | ||
| 197 | <li class=""> | ||
| 198 | |||
| 199 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 200 | </li> | ||
| 201 | <li class=""> | ||
| 202 | |||
| 203 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 204 | </li> | ||
| 205 | <li class=""> | ||
| 206 | |||
| 207 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 208 | </li> | ||
| 209 | <li class=""> | ||
| 210 | |||
| 211 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 212 | </li> | ||
| 213 | <li class=""> | ||
| 214 | |||
| 215 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 216 | </li> | ||
| 217 | <li class=""> | ||
| 218 | |||
| 219 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 220 | </li> | ||
| 221 | <li class=""> | ||
| 222 | |||
| 223 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 224 | </li> | ||
| 225 | <li class=""> | ||
| 226 | |||
| 227 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 228 | </li> | ||
| 229 | <li class=""> | ||
| 230 | |||
| 231 | <a class="" href="../Security/">Security</a> | ||
| 232 | </li> | ||
| 233 | <li class=""> | ||
| 234 | |||
| 235 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 236 | </li> | ||
| 237 | <li class=""> | ||
| 238 | |||
| 239 | <a class="" href="../Theming/">Theming</a> | ||
| 240 | </li> | ||
| 241 | <li class=""> | ||
| 242 | |||
| 243 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 244 | </li> | ||
| 245 | </ul> | ||
| 246 | </li> | ||
| 247 | |||
| 248 | <li class="toctree-l1"> | ||
| 249 | |||
| 250 | <span class="caption-text">About</span> | ||
| 251 | <ul class="subnav"> | ||
| 252 | <li class=""> | ||
| 253 | |||
| 254 | <a class="" href="../FAQ/">FAQ</a> | ||
| 255 | </li> | ||
| 256 | <li class=""> | ||
| 257 | |||
| 258 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 259 | </li> | ||
| 260 | </ul> | ||
| 261 | </li> | ||
| 262 | |||
| 263 | </ul> | ||
| 264 | </div> | ||
| 265 | | ||
| 266 | </nav> | ||
| 267 | |||
| 268 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 269 | |||
| 270 | |||
| 271 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 272 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 273 | <a href="..">Shaarli Documentation</a> | ||
| 274 | </nav> | ||
| 275 | |||
| 276 | |||
| 277 | <div class="wy-nav-content"> | ||
| 278 | <div class="rst-content"> | ||
| 279 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 280 | <ul class="wy-breadcrumbs"> | ||
| 281 | <li><a href="..">Docs</a> »</li> | ||
| 282 | |||
| 283 | |||
| 284 | |||
| 285 | <li>Docker »</li> | ||
| 286 | |||
| 287 | |||
| 288 | |||
| 289 | <li>Docker resources</li> | ||
| 290 | <li class="wy-breadcrumbs-aside"> | ||
| 291 | |||
| 292 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Docker-resources.md" | ||
| 293 | class="icon icon-github"> Edit on GitHub</a> | ||
| 294 | |||
| 295 | </li> | ||
| 296 | </ul> | ||
| 297 | <hr/> | ||
| 298 | </div> | ||
| 299 | <div role="main"> | ||
| 300 | <div class="section"> | ||
| 301 | |||
| 302 | <h3 id="docker">Docker</h3> | ||
| 303 | <ul> | ||
| 304 | <li><a href="https://www.katacoda.com/courses/docker/">Interactive Docker training portal</a> on <a href="https://www.katacoda.com/">Katakoda</a></li> | ||
| 305 | <li><a href="http://blog.thoward37.me/articles/where-are-docker-images-stored/">Where are Docker images stored?</a></li> | ||
| 306 | <li><a href="https://docs.docker.com/reference/builder/">Dockerfile reference</a></li> | ||
| 307 | <li><a href="https://docs.docker.com/articles/dockerfile_best-practices/">Dockerfile best practices</a></li> | ||
| 308 | <li><a href="https://docs.docker.com/userguide/dockervolumes/">Volumes</a></li> | ||
| 309 | </ul> | ||
| 310 | <h3 id="dockerhub">DockerHub</h3> | ||
| 311 | <ul> | ||
| 312 | <li><a href="https://docs.docker.com/userguide/dockerrepos/">Repositories</a></li> | ||
| 313 | <li><a href="https://docs.docker.com/docker-hub/orgs/">Teams and organizations</a></li> | ||
| 314 | <li><a href="https://docs.docker.com/docker-hub/github/">GitHub automated build</a></li> | ||
| 315 | </ul> | ||
| 316 | <h3 id="service-management">Service management</h3> | ||
| 317 | <ul> | ||
| 318 | <li><a href="https://docs.docker.com/articles/using_supervisord/">Using supervisord</a></li> | ||
| 319 | <li><a href="http://nginx.org/en/docs/ngx_core_module.html#daemon">Nginx in the foreground</a></li> | ||
| 320 | <li><a href="http://supervisord.org/">supervisord</a></li> | ||
| 321 | </ul> | ||
| 322 | |||
| 323 | </div> | ||
| 324 | </div> | ||
| 325 | <footer> | ||
| 326 | |||
| 327 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 328 | |||
| 329 | <a href="../Features/" class="btn btn-neutral float-right" title="Features">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 330 | |||
| 331 | |||
| 332 | <a href="../Reverse-proxy-configuration/" class="btn btn-neutral" title="Reverse proxy configuration"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 333 | |||
| 334 | </div> | ||
| 335 | |||
| 336 | |||
| 337 | <hr/> | ||
| 338 | |||
| 339 | <div role="contentinfo"> | ||
| 340 | <!-- Copyright etc --> | ||
| 341 | |||
| 342 | </div> | ||
| 343 | |||
| 344 | 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>. | ||
| 345 | </footer> | ||
| 346 | |||
| 347 | </div> | ||
| 348 | </div> | ||
| 349 | |||
| 350 | </section> | ||
| 351 | |||
| 352 | </div> | ||
| 353 | |||
| 354 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 355 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 356 | |||
| 357 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 358 | |||
| 359 | |||
| 360 | <span><a href="../Reverse-proxy-configuration/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 361 | |||
| 362 | |||
| 363 | <span style="margin-left: 15px"><a href="../Features/" style="color: #fcfcfc">Next »</a></span> | ||
| 364 | |||
| 365 | </span> | ||
| 366 | </div> | ||
| 367 | <script src="../js/theme.js"></script> | ||
| 368 | |||
| 369 | </body> | ||
| 370 | </html> | ||
diff --git a/doc/html/Download-CSS-styles-from-an-OPML-list/index.html b/doc/html/Download-CSS-styles-from-an-OPML-list/index.html new file mode 100644 index 00000000..e697b39d --- /dev/null +++ b/doc/html/Download-CSS-styles-from-an-OPML-list/index.html | |||
| @@ -0,0 +1,496 @@ | |||
| 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>Download CSS styles from an OPML list - 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 = "Download CSS styles from an OPML list"; | ||
| 22 | var mkdocs_page_input_path = "Download-CSS-styles-from-an-OPML-list.md"; | ||
| 23 | var mkdocs_page_url = "/Download-CSS-styles-from-an-OPML-list/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="../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="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 156 | </li> | ||
| 157 | <li class=""> | ||
| 158 | |||
| 159 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 160 | </li> | ||
| 161 | <li class=" current"> | ||
| 162 | |||
| 163 | <a class="current" href="./">Download CSS styles from an OPML list</a> | ||
| 164 | <ul class="subnav"> | ||
| 165 | |||
| 166 | <li class="toctree-l3"><a href="#download-css-styles-for-shaarlis-listed-in-an-opml-file">Download CSS styles for shaarlis listed in an opml file</a></li> | ||
| 167 | |||
| 168 | |||
| 169 | </ul> | ||
| 170 | </li> | ||
| 171 | <li class=""> | ||
| 172 | |||
| 173 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 174 | </li> | ||
| 175 | </ul> | ||
| 176 | </li> | ||
| 177 | |||
| 178 | <li class="toctree-l1"> | ||
| 179 | |||
| 180 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 181 | </li> | ||
| 182 | |||
| 183 | <li class="toctree-l1"> | ||
| 184 | |||
| 185 | <span class="caption-text">Development</span> | ||
| 186 | <ul class="subnav"> | ||
| 187 | <li class=""> | ||
| 188 | |||
| 189 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 190 | </li> | ||
| 191 | <li class=""> | ||
| 192 | |||
| 193 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 194 | </li> | ||
| 195 | <li class=""> | ||
| 196 | |||
| 197 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 198 | </li> | ||
| 199 | <li class=""> | ||
| 200 | |||
| 201 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 202 | </li> | ||
| 203 | <li class=""> | ||
| 204 | |||
| 205 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 206 | </li> | ||
| 207 | <li class=""> | ||
| 208 | |||
| 209 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 210 | </li> | ||
| 211 | <li class=""> | ||
| 212 | |||
| 213 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 214 | </li> | ||
| 215 | <li class=""> | ||
| 216 | |||
| 217 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 218 | </li> | ||
| 219 | <li class=""> | ||
| 220 | |||
| 221 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 222 | </li> | ||
| 223 | <li class=""> | ||
| 224 | |||
| 225 | <a class="" href="../Security/">Security</a> | ||
| 226 | </li> | ||
| 227 | <li class=""> | ||
| 228 | |||
| 229 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 230 | </li> | ||
| 231 | <li class=""> | ||
| 232 | |||
| 233 | <a class="" href="../Theming/">Theming</a> | ||
| 234 | </li> | ||
| 235 | <li class=""> | ||
| 236 | |||
| 237 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 238 | </li> | ||
| 239 | </ul> | ||
| 240 | </li> | ||
| 241 | |||
| 242 | <li class="toctree-l1"> | ||
| 243 | |||
| 244 | <span class="caption-text">About</span> | ||
| 245 | <ul class="subnav"> | ||
| 246 | <li class=""> | ||
| 247 | |||
| 248 | <a class="" href="../FAQ/">FAQ</a> | ||
| 249 | </li> | ||
| 250 | <li class=""> | ||
| 251 | |||
| 252 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 253 | </li> | ||
| 254 | </ul> | ||
| 255 | </li> | ||
| 256 | |||
| 257 | </ul> | ||
| 258 | </div> | ||
| 259 | | ||
| 260 | </nav> | ||
| 261 | |||
| 262 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 263 | |||
| 264 | |||
| 265 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 266 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 267 | <a href="..">Shaarli Documentation</a> | ||
| 268 | </nav> | ||
| 269 | |||
| 270 | |||
| 271 | <div class="wy-nav-content"> | ||
| 272 | <div class="rst-content"> | ||
| 273 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 274 | <ul class="wy-breadcrumbs"> | ||
| 275 | <li><a href="..">Docs</a> »</li> | ||
| 276 | |||
| 277 | |||
| 278 | |||
| 279 | <li>How To »</li> | ||
| 280 | |||
| 281 | |||
| 282 | |||
| 283 | <li>Download CSS styles from an OPML list</li> | ||
| 284 | <li class="wy-breadcrumbs-aside"> | ||
| 285 | |||
| 286 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Download-CSS-styles-from-an-OPML-list.md" | ||
| 287 | class="icon icon-github"> Edit on GitHub</a> | ||
| 288 | |||
| 289 | </li> | ||
| 290 | </ul> | ||
| 291 | <hr/> | ||
| 292 | </div> | ||
| 293 | <div role="main"> | ||
| 294 | <div class="section"> | ||
| 295 | |||
| 296 | <h3 id="download-css-styles-for-shaarlis-listed-in-an-opml-file">Download CSS styles for shaarlis listed in an opml file</h3> | ||
| 297 | <p>Example php script:</p> | ||
| 298 | <pre><code class="php"><!---- ?php --> | ||
| 299 | <!---- Copyright (c) 2014 Nicolas Delsaux (https://github.com/Riduidel) --> | ||
| 300 | <!---- License: zlib (http://www.gzip.org/zlib/zlib_license.html) --> | ||
| 301 | |||
| 302 | /** | ||
| 303 | * Source: https://github.com/Riduidel | ||
| 304 | * Download css styles for shaarlis listed in an opml file | ||
| 305 | */ | ||
| 306 | define("SHAARLI_RSS_OPML", "https://www.ecirtam.net/shaarlirss/custom/people.opml"); | ||
| 307 | |||
| 308 | define("THEMES_TEMP_FOLDER", "new_themes"); | ||
| 309 | |||
| 310 | if(!file_exists(THEMES_TEMP_FOLDER)) { | ||
| 311 | mkdir(THEMES_TEMP_FOLDER); | ||
| 312 | } | ||
| 313 | |||
| 314 | function siteUrl($pathInSite) { | ||
| 315 | $indexPos = strpos($pathInSite, "index.php"); | ||
| 316 | if(!$indexPos) { | ||
| 317 | return $pathInSite; | ||
| 318 | } else { | ||
| 319 | return substr($pathInSite, 0, $indexPos); | ||
| 320 | } | ||
| 321 | } | ||
| 322 | |||
| 323 | function createShaarliHashFromOPMLL($opmlFile) { | ||
| 324 | $result = array(); | ||
| 325 | $opml = file_get_contents($opmlFile); | ||
| 326 | $opmlXml = simplexml_load_string($opml); | ||
| 327 | $outlineElements = $opmlXml->xpath("body/outline"); | ||
| 328 | foreach($outlineElements as $site) { | ||
| 329 | $siteUrl = siteUrl((string) $site['htmlUrl']); | ||
| 330 | $result[$siteUrl]=((string) $site['text']); | ||
| 331 | } | ||
| 332 | return $result; | ||
| 333 | } | ||
| 334 | |||
| 335 | function getSiteFolder($url) { | ||
| 336 | $domain = parse_url($url, PHP_URL_HOST); | ||
| 337 | return THEMES_TEMP_FOLDER."/".str_replace(".", "_", $domain); | ||
| 338 | } | ||
| 339 | |||
| 340 | function get_http_response_code($theURL) { | ||
| 341 | $headers = get_headers($theURL); | ||
| 342 | return substr($headers[0], 9, 3); | ||
| 343 | } | ||
| 344 | |||
| 345 | /** | ||
| 346 | * This makes the code PHP-5 only (particularly the call to "get_headers") | ||
| 347 | */ | ||
| 348 | function copyUserStyleFrom($url, $name, $knownStyles) { | ||
| 349 | $userStyle = $url."inc/user.css"; | ||
| 350 | if(in_array($url, $knownStyles)) { | ||
| 351 | // TODO add log message | ||
| 352 | } else { | ||
| 353 | $statusCode = get_http_response_code($userStyle); | ||
| 354 | if(intval($statusCode)<300) { | ||
| 355 | $styleSheet = file_get_contents($userStyle); | ||
| 356 | $siteFolder = getSiteFolder($url); | ||
| 357 | if(!file_exists($siteFolder)) { | ||
| 358 | mkdir($siteFolder); | ||
| 359 | } | ||
| 360 | if(!file_exists($siteFolder.'/user.css')) { | ||
| 361 | // Copy stylesheet | ||
| 362 | file_put_contents($siteFolder.'/user.css', $styleSheet); | ||
| 363 | } | ||
| 364 | if(!file_exists($siteFolder.'/README.md')) { | ||
| 365 | // Then write a readme.md file | ||
| 366 | file_put_contents($siteFolder.'/README.md', | ||
| 367 | "User style from ".$name."\n" | ||
| 368 | ."=============================" | ||
| 369 | ."\n\n" | ||
| 370 | ."This stylesheet was downloaded from ".$userStyle." on ".date(DATE_RFC822) | ||
| 371 | ); | ||
| 372 | } | ||
| 373 | if(!file_exists($siteFolder.'/config.ini')) { | ||
| 374 | // Write a config file containing useful informations | ||
| 375 | file_put_contents($siteFolder.'/config.ini', | ||
| 376 | "site_url=".$url."\n" | ||
| 377 | ."site_name=".$name."\n" | ||
| 378 | ); | ||
| 379 | } | ||
| 380 | if(!file_exists($siteFolder.'/home.png')) { | ||
| 381 | // And finally copy generated thumbnail | ||
| 382 | $homeThumb = $siteFolder.'/home.png'; | ||
| 383 | file_put_contents($siteFolder.'/home.png', file_get_contents(getThumbnailUrl($url))); | ||
| 384 | } | ||
| 385 | echo 'Theme have been downloaded from <a href="'.$url.'">'.$url.'</a> into '.$siteFolder | ||
| 386 | .'. It looks like <img src="'.$homeThumb.'"><br/>'; | ||
| 387 | } | ||
| 388 | } | ||
| 389 | } | ||
| 390 | |||
| 391 | function getThumbnailUrl($url) { | ||
| 392 | return 'http://api.webthumbnail.org/?url='.$url; | ||
| 393 | } | ||
| 394 | |||
| 395 | function copyUserStylesFrom($urlToNames, $knownStyles) { | ||
| 396 | foreach($urlToNames as $url => $name) { | ||
| 397 | copyUserStyleFrom($url, $name, $knownStyles); | ||
| 398 | } | ||
| 399 | } | ||
| 400 | |||
| 401 | /** | ||
| 402 | * Reading directory list, courtesy of http://www.laughing-buddha.net/php/dirlist/ | ||
| 403 | * @param directory the directory we want to list files of | ||
| 404 | * @return a simple array containing the list of absolute file paths. Notice that current file (".") and parent one("..") | ||
| 405 | * are not listed here | ||
| 406 | */ | ||
| 407 | function getDirectoryList ($directory) { | ||
| 408 | $realPath = realpath($directory); | ||
| 409 | // create an array to hold directory list | ||
| 410 | $results = array(); | ||
| 411 | // create a handler for the directory | ||
| 412 | $handler = opendir($directory); | ||
| 413 | // open directory and walk through the filenames | ||
| 414 | while ($file = readdir($handler)) { | ||
| 415 | // if file isn't this directory or its parent, add it to the results | ||
| 416 | if ($file != "." && $file != "..") { | ||
| 417 | $results[] = realpath($realPath . "/" . $file); | ||
| 418 | } | ||
| 419 | } | ||
| 420 | // tidy up: close the handler | ||
| 421 | closedir($handler); | ||
| 422 | // done! | ||
| 423 | return $results; | ||
| 424 | } | ||
| 425 | |||
| 426 | /** | ||
| 427 | * Start in themes folder and look in all subfolders for config.ini files. | ||
| 428 | * These config.ini files allow us not to download styles again and again | ||
| 429 | */ | ||
| 430 | function findKnownStyles() { | ||
| 431 | $result = array(); | ||
| 432 | $subFolders = getDirectoryList("themes"); | ||
| 433 | foreach($subFolders as $folder) { | ||
| 434 | $configFile = $folder."/config.ini"; | ||
| 435 | if(file_exists($configFile)) { | ||
| 436 | $iniParameters = parse_ini_file($configFile); | ||
| 437 | array_push($result, $iniParameters['site_url']); | ||
| 438 | } | ||
| 439 | } | ||
| 440 | return $result; | ||
| 441 | } | ||
| 442 | |||
| 443 | $knownStyles = findKnownStyles(); | ||
| 444 | copyUserStylesFrom(createShaarliHashFromOPMLL(SHAARLI_RSS_OPML), $knownStyles); | ||
| 445 | |||
| 446 | <!--- ? ----> | ||
| 447 | </code></pre> | ||
| 448 | |||
| 449 | </div> | ||
| 450 | </div> | ||
| 451 | <footer> | ||
| 452 | |||
| 453 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 454 | |||
| 455 | <a href="../Datastore-hacks/" class="btn btn-neutral float-right" title="Datastore hacks">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 456 | |||
| 457 | |||
| 458 | <a href="../Create-and-serve-multiple-Shaarlis-(farm)/" class="btn btn-neutral" title="Create and serve multiple Shaarlis (farm)"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 459 | |||
| 460 | </div> | ||
| 461 | |||
| 462 | |||
| 463 | <hr/> | ||
| 464 | |||
| 465 | <div role="contentinfo"> | ||
| 466 | <!-- Copyright etc --> | ||
| 467 | |||
| 468 | </div> | ||
| 469 | |||
| 470 | 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>. | ||
| 471 | </footer> | ||
| 472 | |||
| 473 | </div> | ||
| 474 | </div> | ||
| 475 | |||
| 476 | </section> | ||
| 477 | |||
| 478 | </div> | ||
| 479 | |||
| 480 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 481 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 482 | |||
| 483 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 484 | |||
| 485 | |||
| 486 | <span><a href="../Create-and-serve-multiple-Shaarlis-(farm)/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 487 | |||
| 488 | |||
| 489 | <span style="margin-left: 15px"><a href="../Datastore-hacks/" style="color: #fcfcfc">Next »</a></span> | ||
| 490 | |||
| 491 | </span> | ||
| 492 | </div> | ||
| 493 | <script src="../js/theme.js"></script> | ||
| 494 | |||
| 495 | </body> | ||
| 496 | </html> | ||
diff --git a/doc/html/Download-and-Installation/index.html b/doc/html/Download-and-Installation/index.html new file mode 100644 index 00000000..1ede1d68 --- /dev/null +++ b/doc/html/Download-and-Installation/index.html | |||
| @@ -0,0 +1,444 @@ | |||
| 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>Download and Installation - 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 = "Download and Installation"; | ||
| 22 | var mkdocs_page_input_path = "Download-and-Installation.md"; | ||
| 23 | var mkdocs_page_url = "/Download-and-Installation/"; | ||
| 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=" current"> | ||
| 61 | |||
| 62 | <a class="current" href="./">Download and Installation</a> | ||
| 63 | <ul class="subnav"> | ||
| 64 | |||
| 65 | <li class="toctree-l3"><a href="#latest-release-recommended">Latest release (recommended)</a></li> | ||
| 66 | |||
| 67 | <ul> | ||
| 68 | |||
| 69 | <li><a class="toctree-l4" href="#download-as-an-archive">Download as an archive</a></li> | ||
| 70 | |||
| 71 | <li><a class="toctree-l4" href="#using-git">Using git</a></li> | ||
| 72 | |||
| 73 | </ul> | ||
| 74 | |||
| 75 | |||
| 76 | <li class="toctree-l3"><a href="#stable-version">Stable version</a></li> | ||
| 77 | |||
| 78 | <ul> | ||
| 79 | |||
| 80 | <li><a class="toctree-l4" href="#download-as-an-archive_1">Download as an archive</a></li> | ||
| 81 | |||
| 82 | <li><a class="toctree-l4" href="#clone-with-git">Clone with Git</a></li> | ||
| 83 | |||
| 84 | </ul> | ||
| 85 | |||
| 86 | |||
| 87 | <li class="toctree-l3"><a href="#development-version-mainline">Development version (mainline)</a></li> | ||
| 88 | |||
| 89 | |||
| 90 | <li class="toctree-l3"><a href="#finish-installation">Finish Installation</a></li> | ||
| 91 | |||
| 92 | |||
| 93 | <li class="toctree-l3"><a href="#updating-shaarli">Updating Shaarli</a></li> | ||
| 94 | |||
| 95 | |||
| 96 | </ul> | ||
| 97 | </li> | ||
| 98 | <li class=""> | ||
| 99 | |||
| 100 | <a class="" href="../Upgrade-and-migration/">Upgrade and migration</a> | ||
| 101 | </li> | ||
| 102 | <li class=""> | ||
| 103 | |||
| 104 | <a class="" href="../Server-requirements/">Server requirements</a> | ||
| 105 | </li> | ||
| 106 | <li class=""> | ||
| 107 | |||
| 108 | <a class="" href="../Server-configuration/">Server configuration</a> | ||
| 109 | </li> | ||
| 110 | <li class=""> | ||
| 111 | |||
| 112 | <a class="" href="../Server-security/">Server security</a> | ||
| 113 | </li> | ||
| 114 | <li class=""> | ||
| 115 | |||
| 116 | <a class="" href="../Shaarli-configuration/">Shaarli configuration</a> | ||
| 117 | </li> | ||
| 118 | <li class=""> | ||
| 119 | |||
| 120 | <a class="" href="../Plugins/">Plugins</a> | ||
| 121 | </li> | ||
| 122 | </ul> | ||
| 123 | </li> | ||
| 124 | |||
| 125 | <li class="toctree-l1"> | ||
| 126 | |||
| 127 | <span class="caption-text">Docker</span> | ||
| 128 | <ul class="subnav"> | ||
| 129 | <li class=""> | ||
| 130 | |||
| 131 | <a class="" href="../Docker-101/">Docker 101</a> | ||
| 132 | </li> | ||
| 133 | <li class=""> | ||
| 134 | |||
| 135 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 136 | </li> | ||
| 137 | <li class=""> | ||
| 138 | |||
| 139 | <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a> | ||
| 140 | </li> | ||
| 141 | <li class=""> | ||
| 142 | |||
| 143 | <a class="" href="../Docker-resources/">Docker resources</a> | ||
| 144 | </li> | ||
| 145 | </ul> | ||
| 146 | </li> | ||
| 147 | |||
| 148 | <li class="toctree-l1"> | ||
| 149 | |||
| 150 | <span class="caption-text">Usage</span> | ||
| 151 | <ul class="subnav"> | ||
| 152 | <li class=""> | ||
| 153 | |||
| 154 | <a class="" href="../Features/">Features</a> | ||
| 155 | </li> | ||
| 156 | <li class=""> | ||
| 157 | |||
| 158 | <a class="" href="../Bookmarklet/">Bookmarklet</a> | ||
| 159 | </li> | ||
| 160 | <li class=""> | ||
| 161 | |||
| 162 | <a class="" href="../Browsing-and-searching/">Browsing and searching</a> | ||
| 163 | </li> | ||
| 164 | <li class=""> | ||
| 165 | |||
| 166 | <a class="" href="../Firefox-share/">Firefox share</a> | ||
| 167 | </li> | ||
| 168 | <li class=""> | ||
| 169 | |||
| 170 | <a class="" href="../RSS-feeds/">RSS feeds</a> | ||
| 171 | </li> | ||
| 172 | <li class=""> | ||
| 173 | |||
| 174 | <a class="" href="../REST-API/">REST API</a> | ||
| 175 | </li> | ||
| 176 | </ul> | ||
| 177 | </li> | ||
| 178 | |||
| 179 | <li class="toctree-l1"> | ||
| 180 | |||
| 181 | <span class="caption-text">How To</span> | ||
| 182 | <ul class="subnav"> | ||
| 183 | <li class=""> | ||
| 184 | |||
| 185 | <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a> | ||
| 186 | </li> | ||
| 187 | <li class=""> | ||
| 188 | |||
| 189 | <a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 190 | </li> | ||
| 191 | <li class=""> | ||
| 192 | |||
| 193 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 194 | </li> | ||
| 195 | <li class=""> | ||
| 196 | |||
| 197 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 198 | </li> | ||
| 199 | <li class=""> | ||
| 200 | |||
| 201 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 202 | </li> | ||
| 203 | </ul> | ||
| 204 | </li> | ||
| 205 | |||
| 206 | <li class="toctree-l1"> | ||
| 207 | |||
| 208 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 209 | </li> | ||
| 210 | |||
| 211 | <li class="toctree-l1"> | ||
| 212 | |||
| 213 | <span class="caption-text">Development</span> | ||
| 214 | <ul class="subnav"> | ||
| 215 | <li class=""> | ||
| 216 | |||
| 217 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 218 | </li> | ||
| 219 | <li class=""> | ||
| 220 | |||
| 221 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 222 | </li> | ||
| 223 | <li class=""> | ||
| 224 | |||
| 225 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 226 | </li> | ||
| 227 | <li class=""> | ||
| 228 | |||
| 229 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 230 | </li> | ||
| 231 | <li class=""> | ||
| 232 | |||
| 233 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 234 | </li> | ||
| 235 | <li class=""> | ||
| 236 | |||
| 237 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 238 | </li> | ||
| 239 | <li class=""> | ||
| 240 | |||
| 241 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 242 | </li> | ||
| 243 | <li class=""> | ||
| 244 | |||
| 245 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 246 | </li> | ||
| 247 | <li class=""> | ||
| 248 | |||
| 249 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 250 | </li> | ||
| 251 | <li class=""> | ||
| 252 | |||
| 253 | <a class="" href="../Security/">Security</a> | ||
| 254 | </li> | ||
| 255 | <li class=""> | ||
| 256 | |||
| 257 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 258 | </li> | ||
| 259 | <li class=""> | ||
| 260 | |||
| 261 | <a class="" href="../Theming/">Theming</a> | ||
| 262 | </li> | ||
| 263 | <li class=""> | ||
| 264 | |||
| 265 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 266 | </li> | ||
| 267 | </ul> | ||
| 268 | </li> | ||
| 269 | |||
| 270 | <li class="toctree-l1"> | ||
| 271 | |||
| 272 | <span class="caption-text">About</span> | ||
| 273 | <ul class="subnav"> | ||
| 274 | <li class=""> | ||
| 275 | |||
| 276 | <a class="" href="../FAQ/">FAQ</a> | ||
| 277 | </li> | ||
| 278 | <li class=""> | ||
| 279 | |||
| 280 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 281 | </li> | ||
| 282 | </ul> | ||
| 283 | </li> | ||
| 284 | |||
| 285 | </ul> | ||
| 286 | </div> | ||
| 287 | | ||
| 288 | </nav> | ||
| 289 | |||
| 290 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 291 | |||
| 292 | |||
| 293 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 294 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 295 | <a href="..">Shaarli Documentation</a> | ||
| 296 | </nav> | ||
| 297 | |||
| 298 | |||
| 299 | <div class="wy-nav-content"> | ||
| 300 | <div class="rst-content"> | ||
| 301 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 302 | <ul class="wy-breadcrumbs"> | ||
| 303 | <li><a href="..">Docs</a> »</li> | ||
| 304 | |||
| 305 | |||
| 306 | |||
| 307 | <li>Setup »</li> | ||
| 308 | |||
| 309 | |||
| 310 | |||
| 311 | <li>Download and Installation</li> | ||
| 312 | <li class="wy-breadcrumbs-aside"> | ||
| 313 | |||
| 314 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Download-and-Installation.md" | ||
| 315 | class="icon icon-github"> Edit on GitHub</a> | ||
| 316 | |||
| 317 | </li> | ||
| 318 | </ul> | ||
| 319 | <hr/> | ||
| 320 | </div> | ||
| 321 | <div role="main"> | ||
| 322 | <div class="section"> | ||
| 323 | |||
| 324 | <p>To install Shaarli, simply place the files in a directory under your webserver's Document Root (or directly at the document root). Make sure your <a href="../Server-requirements">server</a> is properly <a href="../Server-configuration">configured</a>.</p> | ||
| 325 | <p>Several releases are available:</p> | ||
| 326 | <hr /> | ||
| 327 | <h2 id="latest-release-recommended">Latest release (recommended)</h2> | ||
| 328 | <h3 id="download-as-an-archive">Download as an archive</h3> | ||
| 329 | <p>Get the latest released version from the <a href="https://github.com/shaarli/Shaarli/releases">releases</a> page.</p> | ||
| 330 | <p><strong>Download our <em>shaarli-full</em> archive</strong> to include dependencies.</p> | ||
| 331 | <p>The current latest released version is <code>v0.8.4</code></p> | ||
| 332 | <p>Or in command lines:</p> | ||
| 333 | <pre><code class="bash">$ wget https://github.com/shaarli/Shaarli/releases/download/v0.8.4/shaarli-v0.8.4-full.zip | ||
| 334 | $ unzip shaarli-v0.8.4-full.zip | ||
| 335 | $ mv Shaarli /path/to/shaarli/ | ||
| 336 | </code></pre> | ||
| 337 | |||
| 338 | <table> | ||
| 339 | <thead> | ||
| 340 | <tr> | ||
| 341 | <th>!</th> | ||
| 342 | <th>In most cases, download Shaarli from the <a href="https://github.com/shaarli/Shaarli/releases">releases</a> page. Cloning using <code>git</code> or downloading Github branches as zip files requires additional steps (see below).</th> | ||
| 343 | </tr> | ||
| 344 | </thead> | ||
| 345 | <tbody></tbody> | ||
| 346 | </table> | ||
| 347 | <h3 id="using-git">Using git</h3> | ||
| 348 | <pre><code>mkdir -p /path/to/shaarli && cd /path/to/shaarli/ | ||
| 349 | git clone -b v0.8 https://github.com/shaarli/Shaarli.git . | ||
| 350 | composer install --no-dev | ||
| 351 | </code></pre> | ||
| 352 | |||
| 353 | <hr /> | ||
| 354 | <h2 id="stable-version">Stable version</h2> | ||
| 355 | <p>The stable version has been experienced by Shaarli users, and will receive security updates.</p> | ||
| 356 | <h3 id="download-as-an-archive_1">Download as an archive</h3> | ||
| 357 | <p>As a .zip archive:</p> | ||
| 358 | <pre><code class="bash">$ wget https://github.com/shaarli/Shaarli/archive/stable.zip | ||
| 359 | $ unzip stable.zip | ||
| 360 | $ mv Shaarli-stable /path/to/shaarli/ | ||
| 361 | </code></pre> | ||
| 362 | |||
| 363 | <p>As a .tar.gz archive :</p> | ||
| 364 | <pre><code class="bash">$ wget https://github.com/shaarli/Shaarli/archive/stable.tar.gz | ||
| 365 | $ tar xvf stable.tar.gz | ||
| 366 | $ mv Shaarli-stable /path/to/shaarli/ | ||
| 367 | </code></pre> | ||
| 368 | |||
| 369 | <h3 id="clone-with-git">Clone with Git</h3> | ||
| 370 | <p><a href="https://getcomposer.org/">Composer</a> is required to build a functional Shaarli installation when pulling from git.</p> | ||
| 371 | <pre><code class="bash">$ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/ | ||
| 372 | # install/update third-party dependencies | ||
| 373 | $ cd /path/to/shaarli/ | ||
| 374 | $ composer install --no-dev | ||
| 375 | </code></pre> | ||
| 376 | |||
| 377 | <hr /> | ||
| 378 | <h2 id="development-version-mainline">Development version (mainline)</h2> | ||
| 379 | <p><em>Use at your own risk!</em></p> | ||
| 380 | <p>To get the latest changes from the <code>master</code> branch:</p> | ||
| 381 | <pre><code class="bash"># clone the repository | ||
| 382 | $ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/ | ||
| 383 | # install/update third-party dependencies | ||
| 384 | $ cd /path/to/shaarli | ||
| 385 | $ composer install --no-dev | ||
| 386 | </code></pre> | ||
| 387 | |||
| 388 | <hr /> | ||
| 389 | <h2 id="finish-installation">Finish Installation</h2> | ||
| 390 | <p>Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser.</p> | ||
| 391 | <p><img alt="install screenshot" src="http://i.imgur.com/wuMpDSN.png" /></p> | ||
| 392 | <p>Setup your Shaarli installation, and it's ready to use!</p> | ||
| 393 | <hr /> | ||
| 394 | <h2 id="updating-shaarli">Updating Shaarli</h2> | ||
| 395 | <p>See <a href="../Upgrade-and-migration">Upgrade and Migration</a></p> | ||
| 396 | |||
| 397 | </div> | ||
| 398 | </div> | ||
| 399 | <footer> | ||
| 400 | |||
| 401 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 402 | |||
| 403 | <a href="../Upgrade-and-migration/" class="btn btn-neutral float-right" title="Upgrade and migration">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 404 | |||
| 405 | |||
| 406 | <a href=".." class="btn btn-neutral" title="Home"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 407 | |||
| 408 | </div> | ||
| 409 | |||
| 410 | |||
| 411 | <hr/> | ||
| 412 | |||
| 413 | <div role="contentinfo"> | ||
| 414 | <!-- Copyright etc --> | ||
| 415 | |||
| 416 | </div> | ||
| 417 | |||
| 418 | 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>. | ||
| 419 | </footer> | ||
| 420 | |||
| 421 | </div> | ||
| 422 | </div> | ||
| 423 | |||
| 424 | </section> | ||
| 425 | |||
| 426 | </div> | ||
| 427 | |||
| 428 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 429 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 430 | |||
| 431 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 432 | |||
| 433 | |||
| 434 | <span><a href=".." style="color: #fcfcfc;">« Previous</a></span> | ||
| 435 | |||
| 436 | |||
| 437 | <span style="margin-left: 15px"><a href="../Upgrade-and-migration/" style="color: #fcfcfc">Next »</a></span> | ||
| 438 | |||
| 439 | </span> | ||
| 440 | </div> | ||
| 441 | <script src="../js/theme.js"></script> | ||
| 442 | |||
| 443 | </body> | ||
| 444 | </html> | ||
diff --git a/doc/html/FAQ/index.html b/doc/html/FAQ/index.html new file mode 100644 index 00000000..c48e11f8 --- /dev/null +++ b/doc/html/FAQ/index.html | |||
| @@ -0,0 +1,388 @@ | |||
| 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>FAQ - 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 = "FAQ"; | ||
| 22 | var mkdocs_page_input_path = "FAQ.md"; | ||
| 23 | var mkdocs_page_url = "/FAQ/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="../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="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 156 | </li> | ||
| 157 | <li class=""> | ||
| 158 | |||
| 159 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 160 | </li> | ||
| 161 | <li class=""> | ||
| 162 | |||
| 163 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 164 | </li> | ||
| 165 | <li class=""> | ||
| 166 | |||
| 167 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 168 | </li> | ||
| 169 | </ul> | ||
| 170 | </li> | ||
| 171 | |||
| 172 | <li class="toctree-l1"> | ||
| 173 | |||
| 174 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 175 | </li> | ||
| 176 | |||
| 177 | <li class="toctree-l1"> | ||
| 178 | |||
| 179 | <span class="caption-text">Development</span> | ||
| 180 | <ul class="subnav"> | ||
| 181 | <li class=""> | ||
| 182 | |||
| 183 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 184 | </li> | ||
| 185 | <li class=""> | ||
| 186 | |||
| 187 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 188 | </li> | ||
| 189 | <li class=""> | ||
| 190 | |||
| 191 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 192 | </li> | ||
| 193 | <li class=""> | ||
| 194 | |||
| 195 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 196 | </li> | ||
| 197 | <li class=""> | ||
| 198 | |||
| 199 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 200 | </li> | ||
| 201 | <li class=""> | ||
| 202 | |||
| 203 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 204 | </li> | ||
| 205 | <li class=""> | ||
| 206 | |||
| 207 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 208 | </li> | ||
| 209 | <li class=""> | ||
| 210 | |||
| 211 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 212 | </li> | ||
| 213 | <li class=""> | ||
| 214 | |||
| 215 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 216 | </li> | ||
| 217 | <li class=""> | ||
| 218 | |||
| 219 | <a class="" href="../Security/">Security</a> | ||
| 220 | </li> | ||
| 221 | <li class=""> | ||
| 222 | |||
| 223 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 224 | </li> | ||
| 225 | <li class=""> | ||
| 226 | |||
| 227 | <a class="" href="../Theming/">Theming</a> | ||
| 228 | </li> | ||
| 229 | <li class=""> | ||
| 230 | |||
| 231 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 232 | </li> | ||
| 233 | </ul> | ||
| 234 | </li> | ||
| 235 | |||
| 236 | <li class="toctree-l1"> | ||
| 237 | |||
| 238 | <span class="caption-text">About</span> | ||
| 239 | <ul class="subnav"> | ||
| 240 | <li class=" current"> | ||
| 241 | |||
| 242 | <a class="current" href="./">FAQ</a> | ||
| 243 | <ul class="subnav"> | ||
| 244 | |||
| 245 | <li class="toctree-l3"><a href="#why-did-you-create-shaarli">Why did you create Shaarli ?</a></li> | ||
| 246 | |||
| 247 | |||
| 248 | <li class="toctree-l3"><a href="#why-use-shaarli-and-not-deliciousdiigo">Why use Shaarli and not Delicious/Diigo ?</a></li> | ||
| 249 | |||
| 250 | |||
| 251 | <li class="toctree-l3"><a href="#what-does-shaarli-mean">What does Shaarli mean?</a></li> | ||
| 252 | |||
| 253 | |||
| 254 | <li class="toctree-l3"><a href="#my-shaarli-is-broken">My Shaarli is broken!</a></li> | ||
| 255 | |||
| 256 | |||
| 257 | <li class="toctree-l3"><a href="#why-not-use-a-real-database-files-are-slow">Why not use a real database? Files are slow!</a></li> | ||
| 258 | |||
| 259 | |||
| 260 | </ul> | ||
| 261 | </li> | ||
| 262 | <li class=""> | ||
| 263 | |||
| 264 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 265 | </li> | ||
| 266 | </ul> | ||
| 267 | </li> | ||
| 268 | |||
| 269 | </ul> | ||
| 270 | </div> | ||
| 271 | | ||
| 272 | </nav> | ||
| 273 | |||
| 274 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 275 | |||
| 276 | |||
| 277 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 278 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 279 | <a href="..">Shaarli Documentation</a> | ||
| 280 | </nav> | ||
| 281 | |||
| 282 | |||
| 283 | <div class="wy-nav-content"> | ||
| 284 | <div class="rst-content"> | ||
| 285 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 286 | <ul class="wy-breadcrumbs"> | ||
| 287 | <li><a href="..">Docs</a> »</li> | ||
| 288 | |||
| 289 | |||
| 290 | |||
| 291 | <li>About »</li> | ||
| 292 | |||
| 293 | |||
| 294 | |||
| 295 | <li>FAQ</li> | ||
| 296 | <li class="wy-breadcrumbs-aside"> | ||
| 297 | |||
| 298 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/FAQ.md" | ||
| 299 | class="icon icon-github"> Edit on GitHub</a> | ||
| 300 | |||
| 301 | </li> | ||
| 302 | </ul> | ||
| 303 | <hr/> | ||
| 304 | </div> | ||
| 305 | <div role="main"> | ||
| 306 | <div class="section"> | ||
| 307 | |||
| 308 | <h3 id="why-did-you-create-shaarli">Why did you create Shaarli ?</h3> | ||
| 309 | <p>I was a StumbleUpon user. Then I got fed up with they big toolbar. I switched to delicious, which was lighter, faster and more beautiful. Until Yahoo bought it. Then the export API broke all the time, delicious became slow and was ditched by Yahoo. I switched to Diigo, which is not bad, but does too much. And Diigo is sslllooooowww and their Firefox extension a bit buggy. And… oh… <strong>their Firefox addon sends to Diigo every single URL you visit</strong> (Don't believe me ? Use <a href="https://addons.mozilla.org/en-US/firefox/addon/tamper-data/">Tamper Data</a> and open any page).</p> | ||
| 310 | <p>Enough is enough. Saving simple links should not be a complicated heavy thing. I ditched them all and wrote my own: Shaarli. It's simple, but it does the job and does it well. And my data is not hosted on a foreign server, but on my server.</p> | ||
| 311 | <h3 id="why-use-shaarli-and-not-deliciousdiigo">Why use Shaarli and not Delicious/Diigo ?</h3> | ||
| 312 | <p>With Shaarli:</p> | ||
| 313 | <ul> | ||
| 314 | <li>The data is yours: It's hosted on your server.</li> | ||
| 315 | <li>Never fear of having your data locked-in.</li> | ||
| 316 | <li>Never fear to have your data sold to third party.</li> | ||
| 317 | <li>Your private links are not hosted on a third party server.</li> | ||
| 318 | <li>You are not tracked by browser addons (like Diigo does)</li> | ||
| 319 | <li>You can change the look and feel of the pages if you want.</li> | ||
| 320 | <li>You can change the behaviour of the program.</li> | ||
| 321 | <li>It's magnitude faster than most bookmarking services.</li> | ||
| 322 | </ul> | ||
| 323 | <h3 id="what-does-shaarli-mean">What does Shaarli mean?</h3> | ||
| 324 | <p>Shaarli is for shaaring your links.</p> | ||
| 325 | <h3 id="my-shaarli-is-broken">My Shaarli is broken!</h3> | ||
| 326 | <p>First of all, ensure that both the <a href="../Server-configuration">web server</a> and <a href="../Shaarli-configuration">Shaarli</a> are correctly configured, and that your installation is <a href="../Server-requirements">supported</a>.</p> | ||
| 327 | <p>If everything looks right but the issue(s) remain(s), please: | ||
| 328 | - take a look at the <a href="../Troubleshooting">troubleshooting</a> section | ||
| 329 | - come <a href="https://gitter.im/shaarli/Shaarli">chat with us</a> on Gitter, we'll be happy to help ;-) | ||
| 330 | - browse active <a href="https://github.com/shaarli/Shaarli/issues">issues</a> and <a href="https://github.com/shaarli/Shaarli/pulls">Pull Requests</a> | ||
| 331 | - if you find one that is related to the issue, feel free to comment and provide additional details (host/Shaarli setup) | ||
| 332 | - else, <a href="https://github.com/shaarli/Shaarli/issues/new">open a new issue</a>, and provide information about the problem: | ||
| 333 | - <em>what happens?</em> - display glitches, invalid data, security flaws... | ||
| 334 | - <em>what is your configuration?</em> - OS, server version, activated extensions, web browser... | ||
| 335 | - <em>is it reproducible?</em></p> | ||
| 336 | <h3 id="why-not-use-a-real-database-files-are-slow">Why not use a real database? Files are slow!</h3> | ||
| 337 | <p>Does browsing <a href="http://sebsauvage.net/links/">this page</a> feel slow? Try browsing older pages, too.</p> | ||
| 338 | <p>It's not slow at all, is it? And don't forget the database contains more than 16000 links, and it's on a shared host, with 32000 visitors/day for my website alone. And it's still damn fast. Why?</p> | ||
| 339 | <p>The data file is only 3.7 Mb. It's read 99% of the time, and is probably already in the operation system disk cache. So generating a page involves no I/O at all most of the time.</p> | ||
| 340 | |||
| 341 | </div> | ||
| 342 | </div> | ||
| 343 | <footer> | ||
| 344 | |||
| 345 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 346 | |||
| 347 | <a href="../Community-&-Related-software/" class="btn btn-neutral float-right" title="Community & Related software">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 348 | |||
| 349 | |||
| 350 | <a href="../Unit-tests/" class="btn btn-neutral" title="Unit tests"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 351 | |||
| 352 | </div> | ||
| 353 | |||
| 354 | |||
| 355 | <hr/> | ||
| 356 | |||
| 357 | <div role="contentinfo"> | ||
| 358 | <!-- Copyright etc --> | ||
| 359 | |||
| 360 | </div> | ||
| 361 | |||
| 362 | 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>. | ||
| 363 | </footer> | ||
| 364 | |||
| 365 | </div> | ||
| 366 | </div> | ||
| 367 | |||
| 368 | </section> | ||
| 369 | |||
| 370 | </div> | ||
| 371 | |||
| 372 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 373 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 374 | |||
| 375 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 376 | |||
| 377 | |||
| 378 | <span><a href="../Unit-tests/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 379 | |||
| 380 | |||
| 381 | <span style="margin-left: 15px"><a href="../Community-&-Related-software/" style="color: #fcfcfc">Next »</a></span> | ||
| 382 | |||
| 383 | </span> | ||
| 384 | </div> | ||
| 385 | <script src="../js/theme.js"></script> | ||
| 386 | |||
| 387 | </body> | ||
| 388 | </html> | ||
diff --git a/doc/html/Features/index.html b/doc/html/Features/index.html new file mode 100644 index 00000000..453f189a --- /dev/null +++ b/doc/html/Features/index.html | |||
| @@ -0,0 +1,371 @@ | |||
| 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>Features - 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 = "Features"; | ||
| 22 | var mkdocs_page_input_path = "Features.md"; | ||
| 23 | var mkdocs_page_url = "/Features/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="../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=" current"> | ||
| 119 | |||
| 120 | <a class="current" href="./">Features</a> | ||
| 121 | <ul class="subnav"> | ||
| 122 | |||
| 123 | <li class="toctree-l3"><a href="#main-features">Main features</a></li> | ||
| 124 | |||
| 125 | |||
| 126 | <li class="toctree-l3"><a href="#using-shaarli-as-a-blog-notepad-pastebin">Using Shaarli as a blog, notepad, pastebin...</a></li> | ||
| 127 | |||
| 128 | |||
| 129 | </ul> | ||
| 130 | </li> | ||
| 131 | <li class=""> | ||
| 132 | |||
| 133 | <a class="" href="../Bookmarklet/">Bookmarklet</a> | ||
| 134 | </li> | ||
| 135 | <li class=""> | ||
| 136 | |||
| 137 | <a class="" href="../Browsing-and-searching/">Browsing and searching</a> | ||
| 138 | </li> | ||
| 139 | <li class=""> | ||
| 140 | |||
| 141 | <a class="" href="../Firefox-share/">Firefox share</a> | ||
| 142 | </li> | ||
| 143 | <li class=""> | ||
| 144 | |||
| 145 | <a class="" href="../RSS-feeds/">RSS feeds</a> | ||
| 146 | </li> | ||
| 147 | <li class=""> | ||
| 148 | |||
| 149 | <a class="" href="../REST-API/">REST API</a> | ||
| 150 | </li> | ||
| 151 | </ul> | ||
| 152 | </li> | ||
| 153 | |||
| 154 | <li class="toctree-l1"> | ||
| 155 | |||
| 156 | <span class="caption-text">How To</span> | ||
| 157 | <ul class="subnav"> | ||
| 158 | <li class=""> | ||
| 159 | |||
| 160 | <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a> | ||
| 161 | </li> | ||
| 162 | <li class=""> | ||
| 163 | |||
| 164 | <a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 165 | </li> | ||
| 166 | <li class=""> | ||
| 167 | |||
| 168 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 169 | </li> | ||
| 170 | <li class=""> | ||
| 171 | |||
| 172 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 173 | </li> | ||
| 174 | <li class=""> | ||
| 175 | |||
| 176 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 177 | </li> | ||
| 178 | </ul> | ||
| 179 | </li> | ||
| 180 | |||
| 181 | <li class="toctree-l1"> | ||
| 182 | |||
| 183 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 184 | </li> | ||
| 185 | |||
| 186 | <li class="toctree-l1"> | ||
| 187 | |||
| 188 | <span class="caption-text">Development</span> | ||
| 189 | <ul class="subnav"> | ||
| 190 | <li class=""> | ||
| 191 | |||
| 192 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 193 | </li> | ||
| 194 | <li class=""> | ||
| 195 | |||
| 196 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 197 | </li> | ||
| 198 | <li class=""> | ||
| 199 | |||
| 200 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 201 | </li> | ||
| 202 | <li class=""> | ||
| 203 | |||
| 204 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 205 | </li> | ||
| 206 | <li class=""> | ||
| 207 | |||
| 208 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 209 | </li> | ||
| 210 | <li class=""> | ||
| 211 | |||
| 212 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 213 | </li> | ||
| 214 | <li class=""> | ||
| 215 | |||
| 216 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 217 | </li> | ||
| 218 | <li class=""> | ||
| 219 | |||
| 220 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 221 | </li> | ||
| 222 | <li class=""> | ||
| 223 | |||
| 224 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 225 | </li> | ||
| 226 | <li class=""> | ||
| 227 | |||
| 228 | <a class="" href="../Security/">Security</a> | ||
| 229 | </li> | ||
| 230 | <li class=""> | ||
| 231 | |||
| 232 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 233 | </li> | ||
| 234 | <li class=""> | ||
| 235 | |||
| 236 | <a class="" href="../Theming/">Theming</a> | ||
| 237 | </li> | ||
| 238 | <li class=""> | ||
| 239 | |||
| 240 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 241 | </li> | ||
| 242 | </ul> | ||
| 243 | </li> | ||
| 244 | |||
| 245 | <li class="toctree-l1"> | ||
| 246 | |||
| 247 | <span class="caption-text">About</span> | ||
| 248 | <ul class="subnav"> | ||
| 249 | <li class=""> | ||
| 250 | |||
| 251 | <a class="" href="../FAQ/">FAQ</a> | ||
| 252 | </li> | ||
| 253 | <li class=""> | ||
| 254 | |||
| 255 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 256 | </li> | ||
| 257 | </ul> | ||
| 258 | </li> | ||
| 259 | |||
| 260 | </ul> | ||
| 261 | </div> | ||
| 262 | | ||
| 263 | </nav> | ||
| 264 | |||
| 265 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 266 | |||
| 267 | |||
| 268 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 269 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 270 | <a href="..">Shaarli Documentation</a> | ||
| 271 | </nav> | ||
| 272 | |||
| 273 | |||
| 274 | <div class="wy-nav-content"> | ||
| 275 | <div class="rst-content"> | ||
| 276 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 277 | <ul class="wy-breadcrumbs"> | ||
| 278 | <li><a href="..">Docs</a> »</li> | ||
| 279 | |||
| 280 | |||
| 281 | |||
| 282 | <li>Usage »</li> | ||
| 283 | |||
| 284 | |||
| 285 | |||
| 286 | <li>Features</li> | ||
| 287 | <li class="wy-breadcrumbs-aside"> | ||
| 288 | |||
| 289 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Features.md" | ||
| 290 | class="icon icon-github"> Edit on GitHub</a> | ||
| 291 | |||
| 292 | </li> | ||
| 293 | </ul> | ||
| 294 | <hr/> | ||
| 295 | </div> | ||
| 296 | <div role="main"> | ||
| 297 | <div class="section"> | ||
| 298 | |||
| 299 | <h3 id="main-features">Main features</h3> | ||
| 300 | <p>Shaarli is intended: | ||
| 301 | * to share, comment and save interesting links and news | ||
| 302 | * to bookmark useful/frequent personal links (as private links) and share them between computers | ||
| 303 | * as a minimal blog/microblog/writing platform (no character limit) | ||
| 304 | * as a read-it-later list (for example items tagged <code>readlater</code>) | ||
| 305 | * to draft and save articles/ideas | ||
| 306 | * to keep code snippets | ||
| 307 | * to keep notes and documentation | ||
| 308 | * as a shared clipboard between machines | ||
| 309 | * as a todo list | ||
| 310 | * to store playlists (e.g. with the <code>music</code> or <code>video</code> tags) | ||
| 311 | * to keep extracts/comments from webpages that may disappear | ||
| 312 | * to keep track of ongoing discussions (for example items tagged <code>discussion</code>) | ||
| 313 | * <a href="http://shaarli.chassegnouf.net/?9Efeiw">to feed RSS aggregators</a> (planets) with specific tags | ||
| 314 | * to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...)</p> | ||
| 315 | <h3 id="using-shaarli-as-a-blog-notepad-pastebin">Using Shaarli as a blog, notepad, pastebin...</h3> | ||
| 316 | <ul> | ||
| 317 | <li>Go to your Shaarli setup and log in</li> | ||
| 318 | <li>Click the <code>Add Link</code> button</li> | ||
| 319 | <li>To share text only, do not enter any URL in the corresponding input field and click <code>Add Link</code></li> | ||
| 320 | <li>Pick a title and enter your article, or note, in the description field; add a few tags; optionally check <code>Private</code> then click <code>Save</code></li> | ||
| 321 | <li>Voilà! Your article is now published (privately if you selected that option) and accessible using its permalink.</li> | ||
| 322 | </ul> | ||
| 323 | |||
| 324 | </div> | ||
| 325 | </div> | ||
| 326 | <footer> | ||
| 327 | |||
| 328 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 329 | |||
| 330 | <a href="../Bookmarklet/" class="btn btn-neutral float-right" title="Bookmarklet">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 331 | |||
| 332 | |||
| 333 | <a href="../Docker-resources/" class="btn btn-neutral" title="Docker resources"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 334 | |||
| 335 | </div> | ||
| 336 | |||
| 337 | |||
| 338 | <hr/> | ||
| 339 | |||
| 340 | <div role="contentinfo"> | ||
| 341 | <!-- Copyright etc --> | ||
| 342 | |||
| 343 | </div> | ||
| 344 | |||
| 345 | 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>. | ||
| 346 | </footer> | ||
| 347 | |||
| 348 | </div> | ||
| 349 | </div> | ||
| 350 | |||
| 351 | </section> | ||
| 352 | |||
| 353 | </div> | ||
| 354 | |||
| 355 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 356 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 357 | |||
| 358 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 359 | |||
| 360 | |||
| 361 | <span><a href="../Docker-resources/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 362 | |||
| 363 | |||
| 364 | <span style="margin-left: 15px"><a href="../Bookmarklet/" style="color: #fcfcfc">Next »</a></span> | ||
| 365 | |||
| 366 | </span> | ||
| 367 | </div> | ||
| 368 | <script src="../js/theme.js"></script> | ||
| 369 | |||
| 370 | </body> | ||
| 371 | </html> | ||
diff --git a/doc/html/Firefox-share/index.html b/doc/html/Firefox-share/index.html new file mode 100644 index 00000000..c0aaf4bd --- /dev/null +++ b/doc/html/Firefox-share/index.html | |||
| @@ -0,0 +1,368 @@ | |||
| 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>Firefox share - 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 = "Firefox share"; | ||
| 22 | var mkdocs_page_input_path = "Firefox-share.md"; | ||
| 23 | var mkdocs_page_url = "/Firefox-share/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="../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=" current"> | ||
| 131 | |||
| 132 | <a class="current" href="./">Firefox share</a> | ||
| 133 | <ul class="subnav"> | ||
| 134 | |||
| 135 | <li class="toctree-l3"><a href="#add-shaarli-as-a-sharing-service-to-firefox">Add Shaarli as a sharing service to Firefox</a></li> | ||
| 136 | |||
| 137 | |||
| 138 | <li class="toctree-l3"><a href="#sharing-links-using-firefox-share">Sharing links using Firefox share</a></li> | ||
| 139 | |||
| 140 | |||
| 141 | </ul> | ||
| 142 | </li> | ||
| 143 | <li class=""> | ||
| 144 | |||
| 145 | <a class="" href="../RSS-feeds/">RSS feeds</a> | ||
| 146 | </li> | ||
| 147 | <li class=""> | ||
| 148 | |||
| 149 | <a class="" href="../REST-API/">REST API</a> | ||
| 150 | </li> | ||
| 151 | </ul> | ||
| 152 | </li> | ||
| 153 | |||
| 154 | <li class="toctree-l1"> | ||
| 155 | |||
| 156 | <span class="caption-text">How To</span> | ||
| 157 | <ul class="subnav"> | ||
| 158 | <li class=""> | ||
| 159 | |||
| 160 | <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a> | ||
| 161 | </li> | ||
| 162 | <li class=""> | ||
| 163 | |||
| 164 | <a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 165 | </li> | ||
| 166 | <li class=""> | ||
| 167 | |||
| 168 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 169 | </li> | ||
| 170 | <li class=""> | ||
| 171 | |||
| 172 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 173 | </li> | ||
| 174 | <li class=""> | ||
| 175 | |||
| 176 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 177 | </li> | ||
| 178 | </ul> | ||
| 179 | </li> | ||
| 180 | |||
| 181 | <li class="toctree-l1"> | ||
| 182 | |||
| 183 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 184 | </li> | ||
| 185 | |||
| 186 | <li class="toctree-l1"> | ||
| 187 | |||
| 188 | <span class="caption-text">Development</span> | ||
| 189 | <ul class="subnav"> | ||
| 190 | <li class=""> | ||
| 191 | |||
| 192 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 193 | </li> | ||
| 194 | <li class=""> | ||
| 195 | |||
| 196 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 197 | </li> | ||
| 198 | <li class=""> | ||
| 199 | |||
| 200 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 201 | </li> | ||
| 202 | <li class=""> | ||
| 203 | |||
| 204 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 205 | </li> | ||
| 206 | <li class=""> | ||
| 207 | |||
| 208 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 209 | </li> | ||
| 210 | <li class=""> | ||
| 211 | |||
| 212 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 213 | </li> | ||
| 214 | <li class=""> | ||
| 215 | |||
| 216 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 217 | </li> | ||
| 218 | <li class=""> | ||
| 219 | |||
| 220 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 221 | </li> | ||
| 222 | <li class=""> | ||
| 223 | |||
| 224 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 225 | </li> | ||
| 226 | <li class=""> | ||
| 227 | |||
| 228 | <a class="" href="../Security/">Security</a> | ||
| 229 | </li> | ||
| 230 | <li class=""> | ||
| 231 | |||
| 232 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 233 | </li> | ||
| 234 | <li class=""> | ||
| 235 | |||
| 236 | <a class="" href="../Theming/">Theming</a> | ||
| 237 | </li> | ||
| 238 | <li class=""> | ||
| 239 | |||
| 240 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 241 | </li> | ||
| 242 | </ul> | ||
| 243 | </li> | ||
| 244 | |||
| 245 | <li class="toctree-l1"> | ||
| 246 | |||
| 247 | <span class="caption-text">About</span> | ||
| 248 | <ul class="subnav"> | ||
| 249 | <li class=""> | ||
| 250 | |||
| 251 | <a class="" href="../FAQ/">FAQ</a> | ||
| 252 | </li> | ||
| 253 | <li class=""> | ||
| 254 | |||
| 255 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 256 | </li> | ||
| 257 | </ul> | ||
| 258 | </li> | ||
| 259 | |||
| 260 | </ul> | ||
| 261 | </div> | ||
| 262 | | ||
| 263 | </nav> | ||
| 264 | |||
| 265 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 266 | |||
| 267 | |||
| 268 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 269 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 270 | <a href="..">Shaarli Documentation</a> | ||
| 271 | </nav> | ||
| 272 | |||
| 273 | |||
| 274 | <div class="wy-nav-content"> | ||
| 275 | <div class="rst-content"> | ||
| 276 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 277 | <ul class="wy-breadcrumbs"> | ||
| 278 | <li><a href="..">Docs</a> »</li> | ||
| 279 | |||
| 280 | |||
| 281 | |||
| 282 | <li>Usage »</li> | ||
| 283 | |||
| 284 | |||
| 285 | |||
| 286 | <li>Firefox share</li> | ||
| 287 | <li class="wy-breadcrumbs-aside"> | ||
| 288 | |||
| 289 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Firefox-share.md" | ||
| 290 | class="icon icon-github"> Edit on GitHub</a> | ||
| 291 | |||
| 292 | </li> | ||
| 293 | </ul> | ||
| 294 | <hr/> | ||
| 295 | </div> | ||
| 296 | <div role="main"> | ||
| 297 | <div class="section"> | ||
| 298 | |||
| 299 | <h3 id="add-shaarli-as-a-sharing-service-to-firefox">Add Shaarli as a sharing service to Firefox</h3> | ||
| 300 | <ul> | ||
| 301 | <li>Open your Shaarli and <code>Login</code></li> | ||
| 302 | <li>Click the <code>Tools</code> button in the top bar</li> | ||
| 303 | <li>Click the <code>✚Add to Firefox social</code> button and accept the activation.</li> | ||
| 304 | </ul> | ||
| 305 | <h3 id="sharing-links-using-firefox-share">Sharing links using Firefox share</h3> | ||
| 306 | <ul> | ||
| 307 | <li>Add the sharing service as described above</li> | ||
| 308 | <li>When you are visiting a webpage you would like to share with Shaarli, click the Firefox <em>Share</em> button <a href="../images/firefoxshare.png">images/firefoxshare.png</a></li> | ||
| 309 | <li>You can edit your link before and after saving, just like the bookmarklet above.</li> | ||
| 310 | </ul> | ||
| 311 | <table> | ||
| 312 | <thead> | ||
| 313 | <tr> | ||
| 314 | <th></th> | ||
| 315 | <th>Your Shaarli instance must be hosted on an HTTPS (SSL/TLS secure connection) enabled server for Firefox Share to work. Firefox Share will not work over plain HTTP connections.</th> | ||
| 316 | </tr> | ||
| 317 | </thead> | ||
| 318 | <tbody></tbody> | ||
| 319 | </table> | ||
| 320 | |||
| 321 | </div> | ||
| 322 | </div> | ||
| 323 | <footer> | ||
| 324 | |||
| 325 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 326 | |||
| 327 | <a href="../RSS-feeds/" class="btn btn-neutral float-right" title="RSS feeds">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 328 | |||
| 329 | |||
| 330 | <a href="../Browsing-and-searching/" class="btn btn-neutral" title="Browsing and searching"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 331 | |||
| 332 | </div> | ||
| 333 | |||
| 334 | |||
| 335 | <hr/> | ||
| 336 | |||
| 337 | <div role="contentinfo"> | ||
| 338 | <!-- Copyright etc --> | ||
| 339 | |||
| 340 | </div> | ||
| 341 | |||
| 342 | 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>. | ||
| 343 | </footer> | ||
| 344 | |||
| 345 | </div> | ||
| 346 | </div> | ||
| 347 | |||
| 348 | </section> | ||
| 349 | |||
| 350 | </div> | ||
| 351 | |||
| 352 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 353 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 354 | |||
| 355 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 356 | |||
| 357 | |||
| 358 | <span><a href="../Browsing-and-searching/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 359 | |||
| 360 | |||
| 361 | <span style="margin-left: 15px"><a href="../RSS-feeds/" style="color: #fcfcfc">Next »</a></span> | ||
| 362 | |||
| 363 | </span> | ||
| 364 | </div> | ||
| 365 | <script src="../js/theme.js"></script> | ||
| 366 | |||
| 367 | </body> | ||
| 368 | </html> | ||
diff --git a/doc/html/GnuPG-signature/index.html b/doc/html/GnuPG-signature/index.html new file mode 100644 index 00000000..781ccd2d --- /dev/null +++ b/doc/html/GnuPG-signature/index.html | |||
| @@ -0,0 +1,439 @@ | |||
| 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>GnuPG signature - 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 = "GnuPG signature"; | ||
| 22 | var mkdocs_page_input_path = "GnuPG-signature.md"; | ||
| 23 | var mkdocs_page_url = "/GnuPG-signature/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="../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="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 156 | </li> | ||
| 157 | <li class=""> | ||
| 158 | |||
| 159 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 160 | </li> | ||
| 161 | <li class=""> | ||
| 162 | |||
| 163 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 164 | </li> | ||
| 165 | <li class=""> | ||
| 166 | |||
| 167 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 168 | </li> | ||
| 169 | </ul> | ||
| 170 | </li> | ||
| 171 | |||
| 172 | <li class="toctree-l1"> | ||
| 173 | |||
| 174 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 175 | </li> | ||
| 176 | |||
| 177 | <li class="toctree-l1"> | ||
| 178 | |||
| 179 | <span class="caption-text">Development</span> | ||
| 180 | <ul class="subnav"> | ||
| 181 | <li class=""> | ||
| 182 | |||
| 183 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 184 | </li> | ||
| 185 | <li class=""> | ||
| 186 | |||
| 187 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 188 | </li> | ||
| 189 | <li class=" current"> | ||
| 190 | |||
| 191 | <a class="current" href="./">GnuPG signature</a> | ||
| 192 | <ul class="subnav"> | ||
| 193 | |||
| 194 | <li class="toctree-l3"><a href="#introduction">Introduction</a></li> | ||
| 195 | |||
| 196 | <ul> | ||
| 197 | |||
| 198 | <li><a class="toctree-l4" href="#pgp-and-gpg">PGP and GPG</a></li> | ||
| 199 | |||
| 200 | <li><a class="toctree-l4" href="#trust">Trust</a></li> | ||
| 201 | |||
| 202 | </ul> | ||
| 203 | |||
| 204 | |||
| 205 | <li class="toctree-l3"><a href="#generate-a-gpg-key">Generate a GPG key</a></li> | ||
| 206 | |||
| 207 | <ul> | ||
| 208 | |||
| 209 | <li><a class="toctree-l4" href="#gpg-provide-identity-information">gpg - provide identity information</a></li> | ||
| 210 | |||
| 211 | <li><a class="toctree-l4" href="#gpg-entropy-interlude">gpg - entropy interlude</a></li> | ||
| 212 | |||
| 213 | <li><a class="toctree-l4" href="#gpg-key-creation-confirmation">gpg - key creation confirmation</a></li> | ||
| 214 | |||
| 215 | <li><a class="toctree-l4" href="#gpg-submit-your-public-key-to-a-pgp-server-optional">gpg - submit your public key to a PGP server (Optional)</a></li> | ||
| 216 | |||
| 217 | </ul> | ||
| 218 | |||
| 219 | |||
| 220 | <li class="toctree-l3"><a href="#create-and-push-a-gpg-signed-tag">Create and push a GPG-signed tag</a></li> | ||
| 221 | |||
| 222 | |||
| 223 | </ul> | ||
| 224 | </li> | ||
| 225 | <li class=""> | ||
| 226 | |||
| 227 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 228 | </li> | ||
| 229 | <li class=""> | ||
| 230 | |||
| 231 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 232 | </li> | ||
| 233 | <li class=""> | ||
| 234 | |||
| 235 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 236 | </li> | ||
| 237 | <li class=""> | ||
| 238 | |||
| 239 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 240 | </li> | ||
| 241 | <li class=""> | ||
| 242 | |||
| 243 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 244 | </li> | ||
| 245 | <li class=""> | ||
| 246 | |||
| 247 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 248 | </li> | ||
| 249 | <li class=""> | ||
| 250 | |||
| 251 | <a class="" href="../Security/">Security</a> | ||
| 252 | </li> | ||
| 253 | <li class=""> | ||
| 254 | |||
| 255 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 256 | </li> | ||
| 257 | <li class=""> | ||
| 258 | |||
| 259 | <a class="" href="../Theming/">Theming</a> | ||
| 260 | </li> | ||
| 261 | <li class=""> | ||
| 262 | |||
| 263 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 264 | </li> | ||
| 265 | </ul> | ||
| 266 | </li> | ||
| 267 | |||
| 268 | <li class="toctree-l1"> | ||
| 269 | |||
| 270 | <span class="caption-text">About</span> | ||
| 271 | <ul class="subnav"> | ||
| 272 | <li class=""> | ||
| 273 | |||
| 274 | <a class="" href="../FAQ/">FAQ</a> | ||
| 275 | </li> | ||
| 276 | <li class=""> | ||
| 277 | |||
| 278 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 279 | </li> | ||
| 280 | </ul> | ||
| 281 | </li> | ||
| 282 | |||
| 283 | </ul> | ||
| 284 | </div> | ||
| 285 | | ||
| 286 | </nav> | ||
| 287 | |||
| 288 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 289 | |||
| 290 | |||
| 291 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 292 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 293 | <a href="..">Shaarli Documentation</a> | ||
| 294 | </nav> | ||
| 295 | |||
| 296 | |||
| 297 | <div class="wy-nav-content"> | ||
| 298 | <div class="rst-content"> | ||
| 299 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 300 | <ul class="wy-breadcrumbs"> | ||
| 301 | <li><a href="..">Docs</a> »</li> | ||
| 302 | |||
| 303 | |||
| 304 | |||
| 305 | <li>Development »</li> | ||
| 306 | |||
| 307 | |||
| 308 | |||
| 309 | <li>GnuPG signature</li> | ||
| 310 | <li class="wy-breadcrumbs-aside"> | ||
| 311 | |||
| 312 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/GnuPG-signature.md" | ||
| 313 | class="icon icon-github"> Edit on GitHub</a> | ||
| 314 | |||
| 315 | </li> | ||
| 316 | </ul> | ||
| 317 | <hr/> | ||
| 318 | </div> | ||
| 319 | <div role="main"> | ||
| 320 | <div class="section"> | ||
| 321 | |||
| 322 | <h2 id="introduction">Introduction</h2> | ||
| 323 | <h3 id="pgp-and-gpg">PGP and GPG</h3> | ||
| 324 | <p><a href="https://gnupg.org/">Gnu Privacy Guard</a> (GnuPG) is an Open Source implementation of the <a href="https://en.wikipedia.org/wiki/Pretty_Good_Privacy#OpenPGP">Pretty Good | ||
| 325 | Privacy</a> (OpenPGP) specification. Its main purposes are digital authentication, | ||
| 326 | signature and encryption.</p> | ||
| 327 | <p>It is often used by the <a href="https://en.wikipedia.org/wiki/Free_and_open-source_software">FLOSS</a> community to verify: | ||
| 328 | - Linux package signatures: Debian <a href="https://wiki.debian.org/SecureApt">SecureApt</a>, ArchLinux <a href="https://www.archlinux.org/master-keys/">Master | ||
| 329 | Keys</a> | ||
| 330 | - <a href="https://en.wikipedia.org/wiki/Revision_control">SCM</a> releases & maintainer identity</p> | ||
| 331 | <h3 id="trust">Trust</h3> | ||
| 332 | <p>To quote Phil Pennock (the author of the <a href="https://bitbucket.org/skskeyserver/sks-keyserver/wiki/Home">SKS</a> key server - http://sks.spodhuis.org/):</p> | ||
| 333 | <blockquote> | ||
| 334 | <p>You MUST understand that presence of data in the keyserver (pools) in no way connotes trust. Anyone can generate a key, with any name or email address, and upload it. All security and trust comes from evaluating security at the “object level”, via PGP Web-Of-Trust signatures. This keyserver makes it possible to retrieve keys, looking them up via various indices, but the collection of keys in this public pool is KNOWN to contain malicious and fraudulent keys. It is the common expectation of server operators that users understand this and use software which, like all known common OpenPGP implementations, evaluates trust accordingly. This expectation is so common that it is not normally explicitly stated.</p> | ||
| 335 | </blockquote> | ||
| 336 | <p>Trust can be gained by having your key signed by other people (and signing their key back, too :) ), for instance during <a href="https://en.wikipedia.org/wiki/Key_signing_party">key signing parties</a>, see: | ||
| 337 | - <a href="http://www.cryptnet.net/fdp/crypto/keysigning_party/en/keysigning_party.html">The Keysigning party HOWTO</a> | ||
| 338 | - <a href="https://en.wikipedia.org/wiki/Web_of_trust">Web of trust</a></p> | ||
| 339 | <h2 id="generate-a-gpg-key">Generate a GPG key</h2> | ||
| 340 | <ul> | ||
| 341 | <li><a href="http://stackoverflow.com/a/16725717">Generating a GPG key for Git tagging</a> (StackOverflow)</li> | ||
| 342 | <li><a href="https://help.github.com/articles/generating-a-gpg-key/">Generating a GPG key</a> (GitHub)</li> | ||
| 343 | </ul> | ||
| 344 | <h3 id="gpg-provide-identity-information">gpg - provide identity information</h3> | ||
| 345 | <pre><code class="bash">$ gpg --gen-key | ||
| 346 | |||
| 347 | gpg (GnuPG) 2.1.6; Copyright (C) 2015 Free Software Foundation, Inc. | ||
| 348 | This is free software: you are free to change and redistribute it. | ||
| 349 | There is NO WARRANTY, to the extent permitted by law. | ||
| 350 | |||
| 351 | Note: Use "gpg2 --full-gen-key" for a full featured key generation dialog. | ||
| 352 | |||
| 353 | GnuPG needs to construct a user ID to identify your key. | ||
| 354 | |||
| 355 | Real name: Marvin the Paranoid Android | ||
| 356 | Email address: marvin@h2g2.net | ||
| 357 | You selected this USER-ID: | ||
| 358 | "Marvin the Paranoid Android <marvin@h2g2.net>" | ||
| 359 | |||
| 360 | Change (N)ame, (E)mail, or (O)kay/(Q)uit? o | ||
| 361 | We need to generate a lot of random bytes. It is a good idea to perform | ||
| 362 | some other action (type on the keyboard, move the mouse, utilize the | ||
| 363 | disks) during the prime generation; this gives the random number | ||
| 364 | generator a better chance to gain enough entropy. | ||
| 365 | </code></pre> | ||
| 366 | |||
| 367 | <h3 id="gpg-entropy-interlude">gpg - entropy interlude</h3> | ||
| 368 | <p>At this point, you will: | ||
| 369 | - be prompted for a secure password to protect your key (the input method will depend on your Desktop Environment and configuration) | ||
| 370 | - be asked to use your machine's input devices (mouse, keyboard, etc.) to generate random entropy; this step <em>may take some time</em> </p> | ||
| 371 | <h3 id="gpg-key-creation-confirmation">gpg - key creation confirmation</h3> | ||
| 372 | <pre><code class="bash">gpg: key A9D53A3E marked as ultimately trusted | ||
| 373 | public and secret key created and signed. | ||
| 374 | |||
| 375 | gpg: checking the trustdb | ||
| 376 | gpg: 3 marginal(s) needed, 1 complete(s) needed, PGP trust model | ||
| 377 | gpg: depth: 0 valid: 2 signed: 0 trust: 0-, 0q, 0n, 0m, 0f, 2u | ||
| 378 | pub rsa2048/A9D53A3E 2015-07-31 | ||
| 379 | Key fingerprint = AF2A 5381 E54B 2FD2 14C4 A9A3 0E35 ACA4 A9D5 3A3E | ||
| 380 | uid [ultimate] Marvin the Paranoid Android <marvin@h2g2.net> | ||
| 381 | sub rsa2048/8C0EACF1 2015-07-31 | ||
| 382 | </code></pre> | ||
| 383 | |||
| 384 | <h3 id="gpg-submit-your-public-key-to-a-pgp-server-optional">gpg - submit your public key to a PGP server (Optional)</h3> | ||
| 385 | <pre><code class="bash">$ gpg --keyserver pgp.mit.edu --send-keys A9D53A3E | ||
| 386 | gpg: sending key A9D53A3E to hkp server pgp.mit.edu | ||
| 387 | </code></pre> | ||
| 388 | |||
| 389 | <h2 id="create-and-push-a-gpg-signed-tag">Create and push a GPG-signed tag</h2> | ||
| 390 | <p>See <a href="../Release Shaarli">Release Shaarli</a>.</p> | ||
| 391 | |||
| 392 | </div> | ||
| 393 | </div> | ||
| 394 | <footer> | ||
| 395 | |||
| 396 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 397 | |||
| 398 | <a href="../Coding-guidelines/" class="btn btn-neutral float-right" title="Coding guidelines">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 399 | |||
| 400 | |||
| 401 | <a href="../Continuous-integration-tools/" class="btn btn-neutral" title="Continuous integration tools"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 402 | |||
| 403 | </div> | ||
| 404 | |||
| 405 | |||
| 406 | <hr/> | ||
| 407 | |||
| 408 | <div role="contentinfo"> | ||
| 409 | <!-- Copyright etc --> | ||
| 410 | |||
| 411 | </div> | ||
| 412 | |||
| 413 | 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>. | ||
| 414 | </footer> | ||
| 415 | |||
| 416 | </div> | ||
| 417 | </div> | ||
| 418 | |||
| 419 | </section> | ||
| 420 | |||
| 421 | </div> | ||
| 422 | |||
| 423 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 424 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 425 | |||
| 426 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 427 | |||
| 428 | |||
| 429 | <span><a href="../Continuous-integration-tools/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 430 | |||
| 431 | |||
| 432 | <span style="margin-left: 15px"><a href="../Coding-guidelines/" style="color: #fcfcfc">Next »</a></span> | ||
| 433 | |||
| 434 | </span> | ||
| 435 | </div> | ||
| 436 | <script src="../js/theme.js"></script> | ||
| 437 | |||
| 438 | </body> | ||
| 439 | </html> | ||
diff --git a/doc/html/Plugin-System/index.html b/doc/html/Plugin-System/index.html new file mode 100644 index 00000000..5ee0f6c1 --- /dev/null +++ b/doc/html/Plugin-System/index.html | |||
| @@ -0,0 +1,968 @@ | |||
| 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>Plugin System - 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 = "Plugin System"; | ||
| 22 | var mkdocs_page_input_path = "Plugin-System.md"; | ||
| 23 | var mkdocs_page_url = "/Plugin-System/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="../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="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 156 | </li> | ||
| 157 | <li class=""> | ||
| 158 | |||
| 159 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 160 | </li> | ||
| 161 | <li class=""> | ||
| 162 | |||
| 163 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 164 | </li> | ||
| 165 | <li class=""> | ||
| 166 | |||
| 167 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 168 | </li> | ||
| 169 | </ul> | ||
| 170 | </li> | ||
| 171 | |||
| 172 | <li class="toctree-l1"> | ||
| 173 | |||
| 174 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 175 | </li> | ||
| 176 | |||
| 177 | <li class="toctree-l1"> | ||
| 178 | |||
| 179 | <span class="caption-text">Development</span> | ||
| 180 | <ul class="subnav"> | ||
| 181 | <li class=""> | ||
| 182 | |||
| 183 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 184 | </li> | ||
| 185 | <li class=""> | ||
| 186 | |||
| 187 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 188 | </li> | ||
| 189 | <li class=""> | ||
| 190 | |||
| 191 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 192 | </li> | ||
| 193 | <li class=""> | ||
| 194 | |||
| 195 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 196 | </li> | ||
| 197 | <li class=""> | ||
| 198 | |||
| 199 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 200 | </li> | ||
| 201 | <li class=""> | ||
| 202 | |||
| 203 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 204 | </li> | ||
| 205 | <li class=" current"> | ||
| 206 | |||
| 207 | <a class="current" href="./">Plugin System</a> | ||
| 208 | <ul class="subnav"> | ||
| 209 | |||
| 210 | <li class="toctree-l3"><a href="#developer-api">Developer API</a></li> | ||
| 211 | |||
| 212 | <ul> | ||
| 213 | |||
| 214 | <li><a class="toctree-l4" href="#what-can-i-do-with-plugins">What can I do with plugins?</a></li> | ||
| 215 | |||
| 216 | <li><a class="toctree-l4" href="#how-can-i-create-a-plugin-for-shaarli">How can I create a plugin for Shaarli?</a></li> | ||
| 217 | |||
| 218 | <li><a class="toctree-l4" href="#plugin-initialization">Plugin initialization</a></li> | ||
| 219 | |||
| 220 | <li><a class="toctree-l4" href="#understanding-hooks">Understanding hooks</a></li> | ||
| 221 | |||
| 222 | <li><a class="toctree-l4" href="#plugins-data">Plugin's data</a></li> | ||
| 223 | |||
| 224 | <li><a class="toctree-l4" href="#metadata">Metadata</a></li> | ||
| 225 | |||
| 226 | <li><a class="toctree-l4" href="#its-not-working">It's not working!</a></li> | ||
| 227 | |||
| 228 | <li><a class="toctree-l4" href="#hooks">Hooks</a></li> | ||
| 229 | |||
| 230 | </ul> | ||
| 231 | |||
| 232 | |||
| 233 | <li class="toctree-l3"><a href="#guide-for-template-designer">Guide for template designer</a></li> | ||
| 234 | |||
| 235 | <ul> | ||
| 236 | |||
| 237 | <li><a class="toctree-l4" href="#plugin-administration">Plugin administration</a></li> | ||
| 238 | |||
| 239 | <li><a class="toctree-l4" href="#placeholder-system">Placeholder system</a></li> | ||
| 240 | |||
| 241 | <li><a class="toctree-l4" href="#list-of-placeholders">List of placeholders</a></li> | ||
| 242 | |||
| 243 | </ul> | ||
| 244 | |||
| 245 | |||
| 246 | </ul> | ||
| 247 | </li> | ||
| 248 | <li class=""> | ||
| 249 | |||
| 250 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 251 | </li> | ||
| 252 | <li class=""> | ||
| 253 | |||
| 254 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 255 | </li> | ||
| 256 | <li class=""> | ||
| 257 | |||
| 258 | <a class="" href="../Security/">Security</a> | ||
| 259 | </li> | ||
| 260 | <li class=""> | ||
| 261 | |||
| 262 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 263 | </li> | ||
| 264 | <li class=""> | ||
| 265 | |||
| 266 | <a class="" href="../Theming/">Theming</a> | ||
| 267 | </li> | ||
| 268 | <li class=""> | ||
| 269 | |||
| 270 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 271 | </li> | ||
| 272 | </ul> | ||
| 273 | </li> | ||
| 274 | |||
| 275 | <li class="toctree-l1"> | ||
| 276 | |||
| 277 | <span class="caption-text">About</span> | ||
| 278 | <ul class="subnav"> | ||
| 279 | <li class=""> | ||
| 280 | |||
| 281 | <a class="" href="../FAQ/">FAQ</a> | ||
| 282 | </li> | ||
| 283 | <li class=""> | ||
| 284 | |||
| 285 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 286 | </li> | ||
| 287 | </ul> | ||
| 288 | </li> | ||
| 289 | |||
| 290 | </ul> | ||
| 291 | </div> | ||
| 292 | | ||
| 293 | </nav> | ||
| 294 | |||
| 295 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 296 | |||
| 297 | |||
| 298 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 299 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 300 | <a href="..">Shaarli Documentation</a> | ||
| 301 | </nav> | ||
| 302 | |||
| 303 | |||
| 304 | <div class="wy-nav-content"> | ||
| 305 | <div class="rst-content"> | ||
| 306 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 307 | <ul class="wy-breadcrumbs"> | ||
| 308 | <li><a href="..">Docs</a> »</li> | ||
| 309 | |||
| 310 | |||
| 311 | |||
| 312 | <li>Development »</li> | ||
| 313 | |||
| 314 | |||
| 315 | |||
| 316 | <li>Plugin System</li> | ||
| 317 | <li class="wy-breadcrumbs-aside"> | ||
| 318 | |||
| 319 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Plugin-System.md" | ||
| 320 | class="icon icon-github"> Edit on GitHub</a> | ||
| 321 | |||
| 322 | </li> | ||
| 323 | </ul> | ||
| 324 | <hr/> | ||
| 325 | </div> | ||
| 326 | <div role="main"> | ||
| 327 | <div class="section"> | ||
| 328 | |||
| 329 | <p><a href="#developer-api"><strong>I am a developer.</strong> Developer API.</a></p> | ||
| 330 | <p><a href="#guide-for-template-designer"><strong>I am a template designer.</strong> Guide for template designer.</a></p> | ||
| 331 | <h2 id="developer-api">Developer API</h2> | ||
| 332 | <h3 id="what-can-i-do-with-plugins">What can I do with plugins?</h3> | ||
| 333 | <p>The plugin system let you:</p> | ||
| 334 | <ul> | ||
| 335 | <li>insert content into specific places across templates.</li> | ||
| 336 | <li>alter data before templates rendering.</li> | ||
| 337 | <li>alter data before saving new links.</li> | ||
| 338 | </ul> | ||
| 339 | <h3 id="how-can-i-create-a-plugin-for-shaarli">How can I create a plugin for Shaarli?</h3> | ||
| 340 | <p>First, chose a plugin name, such as <code>demo_plugin</code>.</p> | ||
| 341 | <p>Under <code>plugin</code> folder, create a folder named with your plugin name. Then create a <plugin_name>.php file in that folder.</p> | ||
| 342 | <p>You should have the following tree view:</p> | ||
| 343 | <pre><code>| index.php | ||
| 344 | | plugins/ | ||
| 345 | |---| demo_plugin/ | ||
| 346 | | |---| demo_plugin.php | ||
| 347 | </code></pre> | ||
| 348 | |||
| 349 | <h3 id="plugin-initialization">Plugin initialization</h3> | ||
| 350 | <p>At the beginning of Shaarli execution, all enabled plugins are loaded. At this point, the plugin system looks for an <code>init()</code> function to execute and run it if it exists. This function must be named this way, and takes the <code>ConfigManager</code> as parameter.</p> | ||
| 351 | <pre><code><plugin_name>_init($conf) | ||
| 352 | </code></pre> | ||
| 353 | <p>This function can be used to create initial data, load default settings, etc. But also to set <em>plugin errors</em>. If the initialization function returns an array of strings, they will be understand as errors, and displayed in the header to logged in users.</p> | ||
| 354 | <h3 id="understanding-hooks">Understanding hooks</h3> | ||
| 355 | <p>A plugin is a set of functions. Each function will be triggered by the plugin system at certain point in Shaarli execution.</p> | ||
| 356 | <p>These functions need to be named with this pattern:</p> | ||
| 357 | <pre><code>hook_<plugin_name>_<hook_name>($data, $conf) | ||
| 358 | </code></pre> | ||
| 359 | |||
| 360 | <p>Parameters:</p> | ||
| 361 | <ul> | ||
| 362 | <li>data: see <a href="https://github.com/shaarli/Shaarli/wiki/Plugin-System#plugins-data">$data section</a></li> | ||
| 363 | <li>conf: the <code>ConfigManager</code> instance.</li> | ||
| 364 | </ul> | ||
| 365 | <p>For exemple, if my plugin want to add data to the header, this function is needed:</p> | ||
| 366 | <pre><code>hook_demo_plugin_render_header | ||
| 367 | </code></pre> | ||
| 368 | <p>If this function is declared, and the plugin enabled, it will be called every time Shaarli is rendering the header.</p> | ||
| 369 | <h3 id="plugins-data">Plugin's data</h3> | ||
| 370 | <h4 id="parameters">Parameters</h4> | ||
| 371 | <p>Every hook function has a <code>$data</code> parameter. Its content differs for each hooks.</p> | ||
| 372 | <p><strong>This parameter needs to be returned every time</strong>, otherwise data is lost.</p> | ||
| 373 | <pre><code>return $data; | ||
| 374 | </code></pre> | ||
| 375 | <h4 id="filling-templates-placeholder">Filling templates placeholder</h4> | ||
| 376 | <p>Template placeholders are displayed in template in specific places.</p> | ||
| 377 | <p>RainTPL displays every element contained in the placeholder's array. These element can be added by plugins.</p> | ||
| 378 | <p>For example, let's add a value in the placeholder <code>top_placeholder</code> which is displayed at the top of my page:</p> | ||
| 379 | <pre><code class="php">$data['top_placeholder'][] = 'My content'; | ||
| 380 | # OR | ||
| 381 | array_push($data['top_placeholder'], 'My', 'content'); | ||
| 382 | |||
| 383 | return $data; | ||
| 384 | </code></pre> | ||
| 385 | |||
| 386 | <h4 id="data-manipulation">Data manipulation</h4> | ||
| 387 | <p>When a page is displayed, every variable send to the template engine is passed to plugins before that in <code>$data</code>.</p> | ||
| 388 | <p>The data contained by this array can be altered before template rendering.</p> | ||
| 389 | <p>For exemple, in linklist, it is possible to alter every title:</p> | ||
| 390 | <pre><code class="php">// mind the reference if you want $data to be altered | ||
| 391 | foreach ($data['links'] as &$value) { | ||
| 392 | // String reverse every title. | ||
| 393 | $value['title'] = strrev($value['title']); | ||
| 394 | } | ||
| 395 | |||
| 396 | return $data; | ||
| 397 | </code></pre> | ||
| 398 | |||
| 399 | <h3 id="metadata">Metadata</h3> | ||
| 400 | <p>Every plugin needs a <code><plugin_name>.meta</code> file, which is in fact an <code>.ini</code> file (<code>KEY="VALUE"</code>), to be listed in plugin administration.</p> | ||
| 401 | <p>Each file contain two keys:</p> | ||
| 402 | <ul> | ||
| 403 | <li><code>description</code>: plugin description</li> | ||
| 404 | <li><code>parameters</code>: user parameter names, separated by a <code>;</code>.</li> | ||
| 405 | <li><code>parameter.<PARAMETER_NAME></code>: add a text description the specified parameter.</li> | ||
| 406 | </ul> | ||
| 407 | <blockquote> | ||
| 408 | <p>Note: In PHP, <code>parse_ini_file()</code> seems to want strings to be between by quotes <code>"</code> in the ini file.</p> | ||
| 409 | </blockquote> | ||
| 410 | <h3 id="its-not-working">It's not working!</h3> | ||
| 411 | <p>Use <code>demo_plugin</code> as a functional example. It covers most of the plugin system features.</p> | ||
| 412 | <p>If it's still not working, please <a href="https://github.com/shaarli/Shaarli/issues/new">open an issue</a>.</p> | ||
| 413 | <h3 id="hooks">Hooks</h3> | ||
| 414 | <table> | ||
| 415 | <thead> | ||
| 416 | <tr> | ||
| 417 | <th>Hooks</th> | ||
| 418 | <th align="center">Description</th> | ||
| 419 | </tr> | ||
| 420 | </thead> | ||
| 421 | <tbody> | ||
| 422 | <tr> | ||
| 423 | <td><a href="#render_header">render_header</a></td> | ||
| 424 | <td align="center">Allow plugin to add content in page headers.</td> | ||
| 425 | </tr> | ||
| 426 | <tr> | ||
| 427 | <td><a href="#render_includes">render_includes</a></td> | ||
| 428 | <td align="center">Allow plugin to include their own CSS files.</td> | ||
| 429 | </tr> | ||
| 430 | <tr> | ||
| 431 | <td><a href="#render_footer">render_footer</a></td> | ||
| 432 | <td align="center">Allow plugin to add content in page footer and include their own JS files.</td> | ||
| 433 | </tr> | ||
| 434 | <tr> | ||
| 435 | <td><a href="#render_linklist">render_linklist</a></td> | ||
| 436 | <td align="center">It allows to add content at the begining and end of the page, after every link displayed and to alter link data.</td> | ||
| 437 | </tr> | ||
| 438 | <tr> | ||
| 439 | <td><a href="#render_editlink">render_editlink</a></td> | ||
| 440 | <td align="center">Allow to add fields in the form, or display elements.</td> | ||
| 441 | </tr> | ||
| 442 | <tr> | ||
| 443 | <td><a href="#render_tools">render_tools</a></td> | ||
| 444 | <td align="center">Allow to add content at the end of the page.</td> | ||
| 445 | </tr> | ||
| 446 | <tr> | ||
| 447 | <td><a href="#render_picwall">render_picwall</a></td> | ||
| 448 | <td align="center">Allow to add content at the top and bottom of the page.</td> | ||
| 449 | </tr> | ||
| 450 | <tr> | ||
| 451 | <td><a href="#render_tagcloud">render_tagcloud</a></td> | ||
| 452 | <td align="center">Allow to add content at the top and bottom of the page, and after all tags.</td> | ||
| 453 | </tr> | ||
| 454 | <tr> | ||
| 455 | <td><a href="#render_taglist">render_taglist</a></td> | ||
| 456 | <td align="center">Allow to add content at the top and bottom of the page, and after all tags.</td> | ||
| 457 | </tr> | ||
| 458 | <tr> | ||
| 459 | <td><a href="#render_daily">render_daily</a></td> | ||
| 460 | <td align="center">Allow to add content at the top and bottom of the page, the bottom of each link and to alter data.</td> | ||
| 461 | </tr> | ||
| 462 | <tr> | ||
| 463 | <td><a href="#render_feed">render_feed</a></td> | ||
| 464 | <td align="center">Allow to do add tags in RSS and ATOM feeds.</td> | ||
| 465 | </tr> | ||
| 466 | <tr> | ||
| 467 | <td><a href="#save_link">save_link</a></td> | ||
| 468 | <td align="center">Allow to alter the link being saved in the datastore.</td> | ||
| 469 | </tr> | ||
| 470 | <tr> | ||
| 471 | <td><a href="#delete_link">delete_link</a></td> | ||
| 472 | <td align="center">Allow to do an action before a link is deleted from the datastore.</td> | ||
| 473 | </tr> | ||
| 474 | </tbody> | ||
| 475 | </table> | ||
| 476 | <h4 id="render_header">render_header</h4> | ||
| 477 | <p>Triggered on every page.</p> | ||
| 478 | <p>Allow plugin to add content in page headers.</p> | ||
| 479 | <h5 id="data">Data</h5> | ||
| 480 | <p><code>$data</code> is an array containing:</p> | ||
| 481 | <ul> | ||
| 482 | <li><code>_PAGE_</code>: current target page (eg: <code>linklist</code>, <code>picwall</code>, etc.).</li> | ||
| 483 | <li><code>_LOGGEDIN_</code>: true if user is logged in, false otherwise.</li> | ||
| 484 | </ul> | ||
| 485 | <h5 id="template-placeholders">Template placeholders</h5> | ||
| 486 | <p>Items can be displayed in templates by adding an entry in <code>$data['<placeholder>']</code> array.</p> | ||
| 487 | <p>List of placeholders:</p> | ||
| 488 | <ul> | ||
| 489 | <li><code>buttons_toolbar</code>: after the list of buttons in the header.</li> | ||
| 490 | </ul> | ||
| 491 | <p><img alt="buttons_toolbar_example" src="http://i.imgur.com/ssJUOrt.png" /></p> | ||
| 492 | <ul> | ||
| 493 | <li><code>fields_toolbar</code>: after search fields in the header.</li> | ||
| 494 | </ul> | ||
| 495 | <blockquote> | ||
| 496 | <p>Note: This will only be called in linklist.</p> | ||
| 497 | </blockquote> | ||
| 498 | <p><img alt="fields_toolbar_example" src="http://i.imgur.com/3GMifI2.png" /></p> | ||
| 499 | <h4 id="render_includes">render_includes</h4> | ||
| 500 | <p>Triggered on every page.</p> | ||
| 501 | <p>Allow plugin to include their own CSS files.</p> | ||
| 502 | <h5 id="data_1">Data</h5> | ||
| 503 | <p><code>$data</code> is an array containing:</p> | ||
| 504 | <ul> | ||
| 505 | <li><code>_PAGE_</code>: current target page (eg: <code>linklist</code>, <code>picwall</code>, etc.).</li> | ||
| 506 | <li><code>_LOGGEDIN_</code>: true if user is logged in, false otherwise.</li> | ||
| 507 | </ul> | ||
| 508 | <h5 id="template-placeholders_1">Template placeholders</h5> | ||
| 509 | <p>Items can be displayed in templates by adding an entry in <code>$data['<placeholder>']</code> array.</p> | ||
| 510 | <p>List of placeholders:</p> | ||
| 511 | <ul> | ||
| 512 | <li><code>css_files</code>: called after loading default CSS.</li> | ||
| 513 | </ul> | ||
| 514 | <blockquote> | ||
| 515 | <p>Note: only add the path of the CSS file. E.g: <code>plugins/demo_plugin/custom_demo.css</code>.</p> | ||
| 516 | </blockquote> | ||
| 517 | <h4 id="render_footer">render_footer</h4> | ||
| 518 | <p>Triggered on every page.</p> | ||
| 519 | <p>Allow plugin to add content in page footer and include their own JS files.</p> | ||
| 520 | <h5 id="data_2">Data</h5> | ||
| 521 | <p><code>$data</code> is an array containing:</p> | ||
| 522 | <ul> | ||
| 523 | <li><code>_PAGE_</code>: current target page (eg: <code>linklist</code>, <code>picwall</code>, etc.).</li> | ||
| 524 | <li><code>_LOGGEDIN_</code>: true if user is logged in, false otherwise.</li> | ||
| 525 | </ul> | ||
| 526 | <h5 id="template-placeholders_2">Template placeholders</h5> | ||
| 527 | <p>Items can be displayed in templates by adding an entry in <code>$data['<placeholder>']</code> array.</p> | ||
| 528 | <p>List of placeholders:</p> | ||
| 529 | <ul> | ||
| 530 | <li><code>text</code>: called after the end of the footer text.</li> | ||
| 531 | <li><code>endofpage</code>: called at the end of the page.</li> | ||
| 532 | </ul> | ||
| 533 | <p><img alt="text_example" src="http://i.imgur.com/L5S2YEH.png" /></p> | ||
| 534 | <ul> | ||
| 535 | <li><code>js_files</code>: called at the end of the page, to include custom JS scripts.</li> | ||
| 536 | </ul> | ||
| 537 | <blockquote> | ||
| 538 | <p>Note: only add the path of the JS file. E.g: <code>plugins/demo_plugin/custom_demo.js</code>.</p> | ||
| 539 | </blockquote> | ||
| 540 | <h4 id="render_linklist">render_linklist</h4> | ||
| 541 | <p>Triggered when <code>linklist</code> is displayed (list of links, permalink, search, tag filtered, etc.).</p> | ||
| 542 | <p>It allows to add content at the begining and end of the page, after every link displayed and to alter link data.</p> | ||
| 543 | <h5 id="data_3">Data</h5> | ||
| 544 | <p><code>$data</code> is an array containing:</p> | ||
| 545 | <ul> | ||
| 546 | <li><code>_LOGGEDIN_</code>: true if user is logged in, false otherwise.</li> | ||
| 547 | <li>All templates data, including links.</li> | ||
| 548 | </ul> | ||
| 549 | <h5 id="template-placeholders_3">Template placeholders</h5> | ||
| 550 | <p>Items can be displayed in templates by adding an entry in <code>$data['<placeholder>']</code> array.</p> | ||
| 551 | <p>List of placeholders:</p> | ||
| 552 | <ul> | ||
| 553 | <li><code>action_plugin</code>: next to the button "private only" at the top and bottom of the page.</li> | ||
| 554 | </ul> | ||
| 555 | <p><img alt="action_plugin_example" src="http://i.imgur.com/Q12PWg0.png" /></p> | ||
| 556 | <ul> | ||
| 557 | <li><code>link_plugin</code>: for every link, between permalink and link URL.</li> | ||
| 558 | </ul> | ||
| 559 | <p><img alt="link_plugin_example" src="http://i.imgur.com/3oDPhWx.png" /></p> | ||
| 560 | <ul> | ||
| 561 | <li><code>plugin_start_zone</code>: before displaying the template content.</li> | ||
| 562 | </ul> | ||
| 563 | <p><img alt="plugin_start_zone_example" src="http://i.imgur.com/OVBkGy3.png" /></p> | ||
| 564 | <ul> | ||
| 565 | <li><code>plugin_end_zone</code>: after displaying the template content.</li> | ||
| 566 | </ul> | ||
| 567 | <p><img alt="plugin_end_zone_example" src="http://i.imgur.com/6IoRuop.png" /></p> | ||
| 568 | <h4 id="render_editlink">render_editlink</h4> | ||
| 569 | <p>Triggered when the link edition form is displayed.</p> | ||
| 570 | <p>Allow to add fields in the form, or display elements.</p> | ||
| 571 | <h5 id="data_4">Data</h5> | ||
| 572 | <p><code>$data</code> is an array containing:</p> | ||
| 573 | <ul> | ||
| 574 | <li>All templates data.</li> | ||
| 575 | </ul> | ||
| 576 | <h5 id="template-placeholders_4">Template placeholders</h5> | ||
| 577 | <p>Items can be displayed in templates by adding an entry in <code>$data['<placeholder>']</code> array.</p> | ||
| 578 | <p>List of placeholders:</p> | ||
| 579 | <ul> | ||
| 580 | <li><code>edit_link_plugin</code>: after tags field.</li> | ||
| 581 | </ul> | ||
| 582 | <p><img alt="edit_link_plugin_example" src="http://i.imgur.com/5u17Ens.png" /></p> | ||
| 583 | <h4 id="render_tools">render_tools</h4> | ||
| 584 | <p>Triggered when the "tools" page is displayed.</p> | ||
| 585 | <p>Allow to add content at the end of the page.</p> | ||
| 586 | <h5 id="data_5">Data</h5> | ||
| 587 | <p><code>$data</code> is an array containing:</p> | ||
| 588 | <ul> | ||
| 589 | <li>All templates data.</li> | ||
| 590 | </ul> | ||
| 591 | <h5 id="template-placeholders_5">Template placeholders</h5> | ||
| 592 | <p>Items can be displayed in templates by adding an entry in <code>$data['<placeholder>']</code> array.</p> | ||
| 593 | <p>List of placeholders:</p> | ||
| 594 | <ul> | ||
| 595 | <li><code>tools_plugin</code>: at the end of the page.</li> | ||
| 596 | </ul> | ||
| 597 | <p><img alt="tools_plugin_example" src="http://i.imgur.com/Bqhu9oQ.png" /></p> | ||
| 598 | <h4 id="render_picwall">render_picwall</h4> | ||
| 599 | <p>Triggered when picwall is displayed.</p> | ||
| 600 | <p>Allow to add content at the top and bottom of the page.</p> | ||
| 601 | <h5 id="data_6">Data</h5> | ||
| 602 | <p><code>$data</code> is an array containing:</p> | ||
| 603 | <ul> | ||
| 604 | <li><code>_LOGGEDIN_</code>: true if user is logged in, false otherwise.</li> | ||
| 605 | <li>All templates data.</li> | ||
| 606 | </ul> | ||
| 607 | <h5 id="template-placeholders_6">Template placeholders</h5> | ||
| 608 | <p>Items can be displayed in templates by adding an entry in <code>$data['<placeholder>']</code> array.</p> | ||
| 609 | <p>List of placeholders:</p> | ||
| 610 | <ul> | ||
| 611 | <li> | ||
| 612 | <p><code>plugin_start_zone</code>: before displaying the template content.</p> | ||
| 613 | </li> | ||
| 614 | <li> | ||
| 615 | <p><code>plugin_end_zone</code>: after displaying the template content.</p> | ||
| 616 | </li> | ||
| 617 | </ul> | ||
| 618 | <p><img alt="plugin_start_end_zone_example" src="http://i.imgur.com/tVTQFER.png" /></p> | ||
| 619 | <h4 id="render_tagcloud">render_tagcloud</h4> | ||
| 620 | <p>Triggered when tagcloud is displayed.</p> | ||
| 621 | <p>Allow to add content at the top and bottom of the page.</p> | ||
| 622 | <h5 id="data_7">Data</h5> | ||
| 623 | <p><code>$data</code> is an array containing:</p> | ||
| 624 | <ul> | ||
| 625 | <li><code>_LOGGEDIN_</code>: true if user is logged in, false otherwise.</li> | ||
| 626 | <li>All templates data.</li> | ||
| 627 | </ul> | ||
| 628 | <h5 id="template-placeholders_7">Template placeholders</h5> | ||
| 629 | <p>Items can be displayed in templates by adding an entry in <code>$data['<placeholder>']</code> array.</p> | ||
| 630 | <p>List of placeholders:</p> | ||
| 631 | <ul> | ||
| 632 | <li> | ||
| 633 | <p><code>plugin_start_zone</code>: before displaying the template content.</p> | ||
| 634 | </li> | ||
| 635 | <li> | ||
| 636 | <p><code>plugin_end_zone</code>: after displaying the template content.</p> | ||
| 637 | </li> | ||
| 638 | </ul> | ||
| 639 | <p>For each tag, the following placeholder can be used:</p> | ||
| 640 | <ul> | ||
| 641 | <li><code>tag_plugin</code>: after each tag</li> | ||
| 642 | </ul> | ||
| 643 | <p><img alt="plugin_start_end_zone_example" src="http://i.imgur.com/vHmyT3a.png" /></p> | ||
| 644 | <h4 id="render_taglist">render_taglist</h4> | ||
| 645 | <p>Triggered when taglist is displayed.</p> | ||
| 646 | <p>Allow to add content at the top and bottom of the page.</p> | ||
| 647 | <h5 id="data_8">Data</h5> | ||
| 648 | <p><code>$data</code> is an array containing:</p> | ||
| 649 | <ul> | ||
| 650 | <li><code>_LOGGEDIN_</code>: true if user is logged in, false otherwise.</li> | ||
| 651 | <li>All templates data.</li> | ||
| 652 | </ul> | ||
| 653 | <h5 id="template-placeholders_8">Template placeholders</h5> | ||
| 654 | <p>Items can be displayed in templates by adding an entry in <code>$data['<placeholder>']</code> array.</p> | ||
| 655 | <p>List of placeholders:</p> | ||
| 656 | <ul> | ||
| 657 | <li> | ||
| 658 | <p><code>plugin_start_zone</code>: before displaying the template content.</p> | ||
| 659 | </li> | ||
| 660 | <li> | ||
| 661 | <p><code>plugin_end_zone</code>: after displaying the template content.</p> | ||
| 662 | </li> | ||
| 663 | </ul> | ||
| 664 | <p>For each tag, the following placeholder can be used:</p> | ||
| 665 | <ul> | ||
| 666 | <li><code>tag_plugin</code>: after each tag</li> | ||
| 667 | </ul> | ||
| 668 | <h4 id="render_daily">render_daily</h4> | ||
| 669 | <p>Triggered when tagcloud is displayed.</p> | ||
| 670 | <p>Allow to add content at the top and bottom of the page, the bottom of each link and to alter data.</p> | ||
| 671 | <h5 id="data_9">Data</h5> | ||
| 672 | <p><code>$data</code> is an array containing:</p> | ||
| 673 | <ul> | ||
| 674 | <li><code>_LOGGEDIN_</code>: true if user is logged in, false otherwise.</li> | ||
| 675 | <li>All templates data, including links.</li> | ||
| 676 | </ul> | ||
| 677 | <h5 id="template-placeholders_9">Template placeholders</h5> | ||
| 678 | <p>Items can be displayed in templates by adding an entry in <code>$data['<placeholder>']</code> array.</p> | ||
| 679 | <p>List of placeholders:</p> | ||
| 680 | <ul> | ||
| 681 | <li><code>link_plugin</code>: used at bottom of each link.</li> | ||
| 682 | </ul> | ||
| 683 | <p><img alt="link_plugin_example" src="http://i.imgur.com/hzhMfSZ.png" /></p> | ||
| 684 | <ul> | ||
| 685 | <li> | ||
| 686 | <p><code>plugin_start_zone</code>: before displaying the template content.</p> | ||
| 687 | </li> | ||
| 688 | <li> | ||
| 689 | <p><code>plugin_end_zone</code>: after displaying the template content.</p> | ||
| 690 | </li> | ||
| 691 | </ul> | ||
| 692 | <h4 id="render_feed">render_feed</h4> | ||
| 693 | <p>Triggered when the ATOM or RSS feed is displayed.</p> | ||
| 694 | <p>Allow to add tags in the feed, either in the header or for each items. Items (links) can also be altered before being rendered.</p> | ||
| 695 | <h5 id="data_10">Data</h5> | ||
| 696 | <p><code>$data</code> is an array containing:</p> | ||
| 697 | <ul> | ||
| 698 | <li><code>_LOGGEDIN_</code>: true if user is logged in, false otherwise.</li> | ||
| 699 | <li><code>_PAGE_</code>: containing either <code>rss</code> or <code>atom</code>.</li> | ||
| 700 | <li>All templates data, including links.</li> | ||
| 701 | </ul> | ||
| 702 | <h5 id="template-placeholders_10">Template placeholders</h5> | ||
| 703 | <p>Tags can be added in feeds by adding an entry in <code>$data['<placeholder>']</code> array.</p> | ||
| 704 | <p>List of placeholders:</p> | ||
| 705 | <ul> | ||
| 706 | <li><code>feed_plugins_header</code>: used as a header tag in the feed.</li> | ||
| 707 | </ul> | ||
| 708 | <p>For each links:</p> | ||
| 709 | <ul> | ||
| 710 | <li><code>feed_plugins</code>: additional tag for every link entry.</li> | ||
| 711 | </ul> | ||
| 712 | <h4 id="save_link">save_link</h4> | ||
| 713 | <p>Triggered when a link is save (new link or edit).</p> | ||
| 714 | <p>Allow to alter the link being saved in the datastore.</p> | ||
| 715 | <h5 id="data_11">Data</h5> | ||
| 716 | <p><code>$data</code> is an array containing the link being saved:</p> | ||
| 717 | <ul> | ||
| 718 | <li>id</li> | ||
| 719 | <li>title</li> | ||
| 720 | <li>url</li> | ||
| 721 | <li>shorturl</li> | ||
| 722 | <li>description</li> | ||
| 723 | <li>private</li> | ||
| 724 | <li>tags</li> | ||
| 725 | <li>created</li> | ||
| 726 | <li>updated</li> | ||
| 727 | </ul> | ||
| 728 | <h4 id="delete_link">delete_link</h4> | ||
| 729 | <p>Triggered when a link is deleted.</p> | ||
| 730 | <p>Allow to execute any action before the link is actually removed from the datastore</p> | ||
| 731 | <h5 id="data_12">Data</h5> | ||
| 732 | <p><code>$data</code> is an array containing the link being saved:</p> | ||
| 733 | <ul> | ||
| 734 | <li>id</li> | ||
| 735 | <li>title</li> | ||
| 736 | <li>url</li> | ||
| 737 | <li>shorturl</li> | ||
| 738 | <li>description</li> | ||
| 739 | <li>private</li> | ||
| 740 | <li>tags</li> | ||
| 741 | <li>created</li> | ||
| 742 | <li>updated</li> | ||
| 743 | </ul> | ||
| 744 | <h2 id="guide-for-template-designer">Guide for template designer</h2> | ||
| 745 | <h3 id="plugin-administration">Plugin administration</h3> | ||
| 746 | <p>Your theme must include a plugin administration page: <code>pluginsadmin.html</code>.</p> | ||
| 747 | <blockquote> | ||
| 748 | <p>Note: repo's template link needs to be added when the PR is merged.</p> | ||
| 749 | </blockquote> | ||
| 750 | <p>Use the default one as an example.</p> | ||
| 751 | <p>Aside from classic RainTPL loops, plugins order is handle by JavaScript. You can just include <code>plugin_admin.js</code>, only if:</p> | ||
| 752 | <ul> | ||
| 753 | <li>you're using a table.</li> | ||
| 754 | <li>you call orderUp() and orderUp() onclick on arrows.</li> | ||
| 755 | <li>you add data-line and data-order to your rows.</li> | ||
| 756 | </ul> | ||
| 757 | <p>Otherwise, you can use your own JS as long as this field is send by the form:</p> | ||
| 758 | <p><input type="hidden" name="order_{$key}" value="{$counter}"></p> | ||
| 759 | <h3 id="placeholder-system">Placeholder system</h3> | ||
| 760 | <p>In order to make plugins work with every custom themes, you need to add variable placeholder in your templates. </p> | ||
| 761 | <p>It's a RainTPL loop like this:</p> | ||
| 762 | <pre><code>{loop="$plugin_variable"} | ||
| 763 | {$value} | ||
| 764 | {/loop} | ||
| 765 | </code></pre> | ||
| 766 | <p>You should enable <code>demo_plugin</code> for testing purpose, since it uses every placeholder available.</p> | ||
| 767 | <h3 id="list-of-placeholders">List of placeholders</h3> | ||
| 768 | <p><strong>page.header.html</strong></p> | ||
| 769 | <p>At the end of the menu:</p> | ||
| 770 | <pre><code>{loop="$plugins_header.buttons_toolbar"} | ||
| 771 | {$value} | ||
| 772 | {/loop} | ||
| 773 | </code></pre> | ||
| 774 | <p>At the end of file, before clearing floating blocks:</p> | ||
| 775 | <pre><code>{if="!empty($plugin_errors) && isLoggedIn()"} | ||
| 776 | <ul class="errors"> | ||
| 777 | {loop="plugin_errors"} | ||
| 778 | <li>{$value}</li> | ||
| 779 | {/loop} | ||
| 780 | </ul> | ||
| 781 | {/if} | ||
| 782 | </code></pre> | ||
| 783 | <p><strong>includes.html</strong></p> | ||
| 784 | <p>At the end of the file:</p> | ||
| 785 | <pre><code class="html">{loop="$plugins_includes.css_files"} | ||
| 786 | <link type="text/css" rel="stylesheet" href="{$value}#"/> | ||
| 787 | {/loop} | ||
| 788 | </code></pre> | ||
| 789 | |||
| 790 | <p><strong>page.footer.html</strong></p> | ||
| 791 | <p>At the end of your footer notes:</p> | ||
| 792 | <pre><code class="html">{loop="$plugins_footer.text"} | ||
| 793 | {$value} | ||
| 794 | {/loop} | ||
| 795 | </code></pre> | ||
| 796 | |||
| 797 | <p>At the end of file:</p> | ||
| 798 | <pre><code class="html">{loop="$plugins_footer.js_files"} | ||
| 799 | <script src="{$value}#"></script> | ||
| 800 | {/loop} | ||
| 801 | </code></pre> | ||
| 802 | |||
| 803 | <p><strong>linklist.html</strong></p> | ||
| 804 | <p>After search fields:</p> | ||
| 805 | <pre><code class="html">{loop="$plugins_header.fields_toolbar"} | ||
| 806 | {$value} | ||
| 807 | {/loop} | ||
| 808 | </code></pre> | ||
| 809 | |||
| 810 | <p>Before displaying the link list (after paging):</p> | ||
| 811 | <pre><code class="html">{loop="$plugin_start_zone"} | ||
| 812 | {$value} | ||
| 813 | {/loop} | ||
| 814 | </code></pre> | ||
| 815 | |||
| 816 | <p>For every links (icons):</p> | ||
| 817 | <pre><code class="html">{loop="$value.link_plugin"} | ||
| 818 | <span>{$value}</span> | ||
| 819 | {/loop} | ||
| 820 | </code></pre> | ||
| 821 | |||
| 822 | <p>Before end paging:</p> | ||
| 823 | <pre><code class="html">{loop="$plugin_end_zone"} | ||
| 824 | {$value} | ||
| 825 | {/loop} | ||
| 826 | </code></pre> | ||
| 827 | |||
| 828 | <p><strong>linklist.paging.html</strong></p> | ||
| 829 | <p>After the "private only" icon:</p> | ||
| 830 | <pre><code class="html">{loop="$action_plugin"} | ||
| 831 | {$value} | ||
| 832 | {/loop} | ||
| 833 | </code></pre> | ||
| 834 | |||
| 835 | <p><strong>editlink.html</strong></p> | ||
| 836 | <p>After tags field:</p> | ||
| 837 | <pre><code class="html">{loop="$edit_link_plugin"} | ||
| 838 | {$value} | ||
| 839 | {/loop} | ||
| 840 | </code></pre> | ||
| 841 | |||
| 842 | <p><strong>tools.html</strong></p> | ||
| 843 | <p>After the last tool:</p> | ||
| 844 | <pre><code class="html">{loop="$tools_plugin"} | ||
| 845 | {$value} | ||
| 846 | {/loop} | ||
| 847 | </code></pre> | ||
| 848 | |||
| 849 | <p><strong>picwall.html</strong></p> | ||
| 850 | <p>Top:</p> | ||
| 851 | <pre><code class="html"><div id="plugin_zone_start_picwall" class="plugin_zone"> | ||
| 852 | {loop="$plugin_start_zone"} | ||
| 853 | {$value} | ||
| 854 | {/loop} | ||
| 855 | </div> | ||
| 856 | </code></pre> | ||
| 857 | |||
| 858 | <p>Bottom:</p> | ||
| 859 | <pre><code class="html"><div id="plugin_zone_end_picwall" class="plugin_zone"> | ||
| 860 | {loop="$plugin_end_zone"} | ||
| 861 | {$value} | ||
| 862 | {/loop} | ||
| 863 | </div> | ||
| 864 | </code></pre> | ||
| 865 | |||
| 866 | <p><strong>tagcloud.html</strong></p> | ||
| 867 | <p>Top:</p> | ||
| 868 | <pre><code class="html"> <div id="plugin_zone_start_tagcloud" class="plugin_zone"> | ||
| 869 | {loop="$plugin_start_zone"} | ||
| 870 | {$value} | ||
| 871 | {/loop} | ||
| 872 | </div> | ||
| 873 | </code></pre> | ||
| 874 | |||
| 875 | <p>Bottom:</p> | ||
| 876 | <pre><code class="html"> <div id="plugin_zone_end_tagcloud" class="plugin_zone"> | ||
| 877 | {loop="$plugin_end_zone"} | ||
| 878 | {$value} | ||
| 879 | {/loop} | ||
| 880 | </div> | ||
| 881 | </code></pre> | ||
| 882 | |||
| 883 | <p><strong>daily.html</strong></p> | ||
| 884 | <p>Top:</p> | ||
| 885 | <pre><code class="html"><div id="plugin_zone_start_picwall" class="plugin_zone"> | ||
| 886 | {loop="$plugin_start_zone"} | ||
| 887 | {$value} | ||
| 888 | {/loop} | ||
| 889 | </div> | ||
| 890 | </code></pre> | ||
| 891 | |||
| 892 | <p>After every link:</p> | ||
| 893 | <pre><code class="html"><div class="dailyEntryFooter"> | ||
| 894 | {loop="$link.link_plugin"} | ||
| 895 | {$value} | ||
| 896 | {/loop} | ||
| 897 | </div> | ||
| 898 | </code></pre> | ||
| 899 | |||
| 900 | <p>Bottom:</p> | ||
| 901 | <pre><code class="html"><div id="plugin_zone_end_picwall" class="plugin_zone"> | ||
| 902 | {loop="$plugin_end_zone"} | ||
| 903 | {$value} | ||
| 904 | {/loop} | ||
| 905 | </div> | ||
| 906 | </code></pre> | ||
| 907 | |||
| 908 | <p><strong>feed.atom.xml</strong> and <strong>feed.rss.xml</strong>:</p> | ||
| 909 | <p>In headers tags section:</p> | ||
| 910 | <pre><code class="xml">{loop="$feed_plugins_header"} | ||
| 911 | {$value} | ||
| 912 | {/loop} | ||
| 913 | </code></pre> | ||
| 914 | |||
| 915 | <p>After each entry:</p> | ||
| 916 | <pre><code class="xml">{loop="$value.feed_plugins"} | ||
| 917 | {$value} | ||
| 918 | {/loop} | ||
| 919 | </code></pre> | ||
| 920 | |||
| 921 | </div> | ||
| 922 | </div> | ||
| 923 | <footer> | ||
| 924 | |||
| 925 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 926 | |||
| 927 | <a href="../Release-Shaarli/" class="btn btn-neutral float-right" title="Release Shaarli">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 928 | |||
| 929 | |||
| 930 | <a href="../3rd-party-libraries/" class="btn btn-neutral" title="3rd party libraries"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 931 | |||
| 932 | </div> | ||
| 933 | |||
| 934 | |||
| 935 | <hr/> | ||
| 936 | |||
| 937 | <div role="contentinfo"> | ||
| 938 | <!-- Copyright etc --> | ||
| 939 | |||
| 940 | </div> | ||
| 941 | |||
| 942 | 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>. | ||
| 943 | </footer> | ||
| 944 | |||
| 945 | </div> | ||
| 946 | </div> | ||
| 947 | |||
| 948 | </section> | ||
| 949 | |||
| 950 | </div> | ||
| 951 | |||
| 952 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 953 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 954 | |||
| 955 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 956 | |||
| 957 | |||
| 958 | <span><a href="../3rd-party-libraries/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 959 | |||
| 960 | |||
| 961 | <span style="margin-left: 15px"><a href="../Release-Shaarli/" style="color: #fcfcfc">Next »</a></span> | ||
| 962 | |||
| 963 | </span> | ||
| 964 | </div> | ||
| 965 | <script src="../js/theme.js"></script> | ||
| 966 | |||
| 967 | </body> | ||
| 968 | </html> | ||
diff --git a/doc/html/Plugins/index.html b/doc/html/Plugins/index.html new file mode 100644 index 00000000..3a30e93c --- /dev/null +++ b/doc/html/Plugins/index.html | |||
| @@ -0,0 +1,414 @@ | |||
| 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>Plugins - 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 = "Plugins"; | ||
| 22 | var mkdocs_page_input_path = "Plugins.md"; | ||
| 23 | var mkdocs_page_url = "/Plugins/"; | ||
| 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=" current"> | ||
| 85 | |||
| 86 | <a class="current" href="./">Plugins</a> | ||
| 87 | <ul class="subnav"> | ||
| 88 | |||
| 89 | <li class="toctree-l3"><a href="#plugin-installation">Plugin installation</a></li> | ||
| 90 | |||
| 91 | |||
| 92 | <li class="toctree-l3"><a href="#plugin-configuration">Plugin configuration</a></li> | ||
| 93 | |||
| 94 | |||
| 95 | <li class="toctree-l3"><a href="#plugin-order">Plugin order</a></li> | ||
| 96 | |||
| 97 | |||
| 98 | <li class="toctree-l3"><a href="#file-mode">File mode</a></li> | ||
| 99 | |||
| 100 | <ul> | ||
| 101 | |||
| 102 | <li><a class="toctree-l4" href="#plugin-usage">Plugin usage</a></li> | ||
| 103 | |||
| 104 | </ul> | ||
| 105 | |||
| 106 | |||
| 107 | </ul> | ||
| 108 | </li> | ||
| 109 | </ul> | ||
| 110 | </li> | ||
| 111 | |||
| 112 | <li class="toctree-l1"> | ||
| 113 | |||
| 114 | <span class="caption-text">Docker</span> | ||
| 115 | <ul class="subnav"> | ||
| 116 | <li class=""> | ||
| 117 | |||
| 118 | <a class="" href="../Docker-101/">Docker 101</a> | ||
| 119 | </li> | ||
| 120 | <li class=""> | ||
| 121 | |||
| 122 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 123 | </li> | ||
| 124 | <li class=""> | ||
| 125 | |||
| 126 | <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a> | ||
| 127 | </li> | ||
| 128 | <li class=""> | ||
| 129 | |||
| 130 | <a class="" href="../Docker-resources/">Docker resources</a> | ||
| 131 | </li> | ||
| 132 | </ul> | ||
| 133 | </li> | ||
| 134 | |||
| 135 | <li class="toctree-l1"> | ||
| 136 | |||
| 137 | <span class="caption-text">Usage</span> | ||
| 138 | <ul class="subnav"> | ||
| 139 | <li class=""> | ||
| 140 | |||
| 141 | <a class="" href="../Features/">Features</a> | ||
| 142 | </li> | ||
| 143 | <li class=""> | ||
| 144 | |||
| 145 | <a class="" href="../Bookmarklet/">Bookmarklet</a> | ||
| 146 | </li> | ||
| 147 | <li class=""> | ||
| 148 | |||
| 149 | <a class="" href="../Browsing-and-searching/">Browsing and searching</a> | ||
| 150 | </li> | ||
| 151 | <li class=""> | ||
| 152 | |||
| 153 | <a class="" href="../Firefox-share/">Firefox share</a> | ||
| 154 | </li> | ||
| 155 | <li class=""> | ||
| 156 | |||
| 157 | <a class="" href="../RSS-feeds/">RSS feeds</a> | ||
| 158 | </li> | ||
| 159 | <li class=""> | ||
| 160 | |||
| 161 | <a class="" href="../REST-API/">REST API</a> | ||
| 162 | </li> | ||
| 163 | </ul> | ||
| 164 | </li> | ||
| 165 | |||
| 166 | <li class="toctree-l1"> | ||
| 167 | |||
| 168 | <span class="caption-text">How To</span> | ||
| 169 | <ul class="subnav"> | ||
| 170 | <li class=""> | ||
| 171 | |||
| 172 | <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a> | ||
| 173 | </li> | ||
| 174 | <li class=""> | ||
| 175 | |||
| 176 | <a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 177 | </li> | ||
| 178 | <li class=""> | ||
| 179 | |||
| 180 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 181 | </li> | ||
| 182 | <li class=""> | ||
| 183 | |||
| 184 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 185 | </li> | ||
| 186 | <li class=""> | ||
| 187 | |||
| 188 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 189 | </li> | ||
| 190 | </ul> | ||
| 191 | </li> | ||
| 192 | |||
| 193 | <li class="toctree-l1"> | ||
| 194 | |||
| 195 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 196 | </li> | ||
| 197 | |||
| 198 | <li class="toctree-l1"> | ||
| 199 | |||
| 200 | <span class="caption-text">Development</span> | ||
| 201 | <ul class="subnav"> | ||
| 202 | <li class=""> | ||
| 203 | |||
| 204 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 205 | </li> | ||
| 206 | <li class=""> | ||
| 207 | |||
| 208 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 209 | </li> | ||
| 210 | <li class=""> | ||
| 211 | |||
| 212 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 213 | </li> | ||
| 214 | <li class=""> | ||
| 215 | |||
| 216 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 217 | </li> | ||
| 218 | <li class=""> | ||
| 219 | |||
| 220 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 221 | </li> | ||
| 222 | <li class=""> | ||
| 223 | |||
| 224 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 225 | </li> | ||
| 226 | <li class=""> | ||
| 227 | |||
| 228 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 229 | </li> | ||
| 230 | <li class=""> | ||
| 231 | |||
| 232 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 233 | </li> | ||
| 234 | <li class=""> | ||
| 235 | |||
| 236 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 237 | </li> | ||
| 238 | <li class=""> | ||
| 239 | |||
| 240 | <a class="" href="../Security/">Security</a> | ||
| 241 | </li> | ||
| 242 | <li class=""> | ||
| 243 | |||
| 244 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 245 | </li> | ||
| 246 | <li class=""> | ||
| 247 | |||
| 248 | <a class="" href="../Theming/">Theming</a> | ||
| 249 | </li> | ||
| 250 | <li class=""> | ||
| 251 | |||
| 252 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 253 | </li> | ||
| 254 | </ul> | ||
| 255 | </li> | ||
| 256 | |||
| 257 | <li class="toctree-l1"> | ||
| 258 | |||
| 259 | <span class="caption-text">About</span> | ||
| 260 | <ul class="subnav"> | ||
| 261 | <li class=""> | ||
| 262 | |||
| 263 | <a class="" href="../FAQ/">FAQ</a> | ||
| 264 | </li> | ||
| 265 | <li class=""> | ||
| 266 | |||
| 267 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 268 | </li> | ||
| 269 | </ul> | ||
| 270 | </li> | ||
| 271 | |||
| 272 | </ul> | ||
| 273 | </div> | ||
| 274 | | ||
| 275 | </nav> | ||
| 276 | |||
| 277 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 278 | |||
| 279 | |||
| 280 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 281 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 282 | <a href="..">Shaarli Documentation</a> | ||
| 283 | </nav> | ||
| 284 | |||
| 285 | |||
| 286 | <div class="wy-nav-content"> | ||
| 287 | <div class="rst-content"> | ||
| 288 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 289 | <ul class="wy-breadcrumbs"> | ||
| 290 | <li><a href="..">Docs</a> »</li> | ||
| 291 | |||
| 292 | |||
| 293 | |||
| 294 | <li>Setup »</li> | ||
| 295 | |||
| 296 | |||
| 297 | |||
| 298 | <li>Plugins</li> | ||
| 299 | <li class="wy-breadcrumbs-aside"> | ||
| 300 | |||
| 301 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Plugins.md" | ||
| 302 | class="icon icon-github"> Edit on GitHub</a> | ||
| 303 | |||
| 304 | </li> | ||
| 305 | </ul> | ||
| 306 | <hr/> | ||
| 307 | </div> | ||
| 308 | <div role="main"> | ||
| 309 | <div class="section"> | ||
| 310 | |||
| 311 | <h2 id="plugin-installation">Plugin installation</h2> | ||
| 312 | <p>There is a bunch of plugins shipped with Shaarli, where there is nothing to do to install them.</p> | ||
| 313 | <p>If you want to install a third party plugin:</p> | ||
| 314 | <ul> | ||
| 315 | <li>Download it.</li> | ||
| 316 | <li>Put it in the <code>plugins</code> directory in Shaarli's installation folder.</li> | ||
| 317 | <li>Make sure you put it correctly:</li> | ||
| 318 | </ul> | ||
| 319 | <pre><code>| index.php | ||
| 320 | | plugins/ | ||
| 321 | |---| custom_plugin/ | ||
| 322 | | |---| custom_plugin.php | ||
| 323 | | |---| ... | ||
| 324 | |||
| 325 | </code></pre> | ||
| 326 | |||
| 327 | <ul> | ||
| 328 | <li>Make sure your webserver can read and write the files in your plugin folder.</li> | ||
| 329 | </ul> | ||
| 330 | <h2 id="plugin-configuration">Plugin configuration</h2> | ||
| 331 | <p>In Shaarli's administration page (<code>Tools</code> link), go to <code>Plugin administration</code>.</p> | ||
| 332 | <p>Here you can enable and disable all plugins available, and configure them.</p> | ||
| 333 | <p><img alt="administration screenshot" src="https://camo.githubusercontent.com/5da68e191969007492ca0fbeb25f3b2357b748cc/687474703a2f2f692e696d6775722e636f6d2f766837544643712e706e67" /></p> | ||
| 334 | <h2 id="plugin-order">Plugin order</h2> | ||
| 335 | <p>In the plugin administration page, you can move enabled plugins to the top or bottom of the list. The first plugins in the list will be processed first.</p> | ||
| 336 | <p>This is important in case plugins are depending on each other. Read plugins README details for more information.</p> | ||
| 337 | <p><strong>Use case</strong>: The (non existent) plugin <code>shaares_footer</code> adds a footer to every shaare in Markdown syntax. It needs to be processed <em>before</em> (higher in the list) the Markdown plugin. Otherwise its syntax won't be translated in HTML.</p> | ||
| 338 | <h2 id="file-mode">File mode</h2> | ||
| 339 | <p>Enabled plugin are stored in your <code>config.php</code> parameters file, under the <code>array</code>:</p> | ||
| 340 | <pre><code class="php">$GLOBALS['config']['ENABLED_PLUGINS'] | ||
| 341 | </code></pre> | ||
| 342 | |||
| 343 | <p>You can edit them manually here. | ||
| 344 | Example:</p> | ||
| 345 | <pre><code class="php">$GLOBALS['config']['ENABLED_PLUGINS'] = array( | ||
| 346 | 'qrcode', | ||
| 347 | 'archiveorg', | ||
| 348 | 'wallabag', | ||
| 349 | 'markdown', | ||
| 350 | ); | ||
| 351 | </code></pre> | ||
| 352 | |||
| 353 | <h3 id="plugin-usage">Plugin usage</h3> | ||
| 354 | <h4 id="official-plugins">Official plugins</h4> | ||
| 355 | <p>Usage of each plugin is documented in it's README file:</p> | ||
| 356 | <ul> | ||
| 357 | <li><code>addlink-toolbar</code>: Adds the addlink input on the linklist page</li> | ||
| 358 | <li><code>archiveorg</code>: For each link, add an Archive.org icon</li> | ||
| 359 | <li><a href="https://github.com/shaarli/Shaarli/blob/master/plugins/markdown/README.md"><code>markdown</code></a>: Render shaare description with Markdown syntax.</li> | ||
| 360 | <li><a href="https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md"><code>playvideos</code></a>: Add a button in the toolbar allowing to watch all videos.</li> | ||
| 361 | <li><code>qrcode</code>: For each link, add a QRCode icon.</li> | ||
| 362 | <li><a href="https://github.com/shaarli/Shaarli/blob/master/plugins/wallabag/README.md"><code>wallabag</code></a>: For each link, add a Wallabag icon to save it in your instance.</li> | ||
| 363 | </ul> | ||
| 364 | <h4 id="third-party-plugins">Third party plugins</h4> | ||
| 365 | <p>See <a href="https://github.com/shaarli/Shaarli/wiki/Community-%26-Related-software#third-party-plugins">Community & related software</a></p> | ||
| 366 | |||
| 367 | </div> | ||
| 368 | </div> | ||
| 369 | <footer> | ||
| 370 | |||
| 371 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 372 | |||
| 373 | <a href="../Docker-101/" class="btn btn-neutral float-right" title="Docker 101">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 374 | |||
| 375 | |||
| 376 | <a href="../Shaarli-configuration/" class="btn btn-neutral" title="Shaarli configuration"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 377 | |||
| 378 | </div> | ||
| 379 | |||
| 380 | |||
| 381 | <hr/> | ||
| 382 | |||
| 383 | <div role="contentinfo"> | ||
| 384 | <!-- Copyright etc --> | ||
| 385 | |||
| 386 | </div> | ||
| 387 | |||
| 388 | 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>. | ||
| 389 | </footer> | ||
| 390 | |||
| 391 | </div> | ||
| 392 | </div> | ||
| 393 | |||
| 394 | </section> | ||
| 395 | |||
| 396 | </div> | ||
| 397 | |||
| 398 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 399 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 400 | |||
| 401 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 402 | |||
| 403 | |||
| 404 | <span><a href="../Shaarli-configuration/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 405 | |||
| 406 | |||
| 407 | <span style="margin-left: 15px"><a href="../Docker-101/" style="color: #fcfcfc">Next »</a></span> | ||
| 408 | |||
| 409 | </span> | ||
| 410 | </div> | ||
| 411 | <script src="../js/theme.js"></script> | ||
| 412 | |||
| 413 | </body> | ||
| 414 | </html> | ||
diff --git a/doc/html/REST-API/index.html b/doc/html/REST-API/index.html new file mode 100644 index 00000000..2c244bca --- /dev/null +++ b/doc/html/REST-API/index.html | |||
| @@ -0,0 +1,431 @@ | |||
| 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>REST API - 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 = "REST API"; | ||
| 22 | var mkdocs_page_input_path = "REST-API.md"; | ||
| 23 | var mkdocs_page_url = "/REST-API/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="../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=" current"> | ||
| 139 | |||
| 140 | <a class="current" href="./">REST API</a> | ||
| 141 | <ul class="subnav"> | ||
| 142 | |||
| 143 | <li class="toctree-l3"><a href="#usage">Usage</a></li> | ||
| 144 | |||
| 145 | |||
| 146 | <li class="toctree-l3"><a href="#authentication">Authentication</a></li> | ||
| 147 | |||
| 148 | <ul> | ||
| 149 | |||
| 150 | <li><a class="toctree-l4" href="#shaarli-jwt-token">Shaarli JWT Token</a></li> | ||
| 151 | |||
| 152 | <li><a class="toctree-l4" href="#complete-example">Complete example</a></li> | ||
| 153 | |||
| 154 | </ul> | ||
| 155 | |||
| 156 | |||
| 157 | </ul> | ||
| 158 | </li> | ||
| 159 | </ul> | ||
| 160 | </li> | ||
| 161 | |||
| 162 | <li class="toctree-l1"> | ||
| 163 | |||
| 164 | <span class="caption-text">How To</span> | ||
| 165 | <ul class="subnav"> | ||
| 166 | <li class=""> | ||
| 167 | |||
| 168 | <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a> | ||
| 169 | </li> | ||
| 170 | <li class=""> | ||
| 171 | |||
| 172 | <a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 173 | </li> | ||
| 174 | <li class=""> | ||
| 175 | |||
| 176 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 177 | </li> | ||
| 178 | <li class=""> | ||
| 179 | |||
| 180 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 181 | </li> | ||
| 182 | <li class=""> | ||
| 183 | |||
| 184 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 185 | </li> | ||
| 186 | </ul> | ||
| 187 | </li> | ||
| 188 | |||
| 189 | <li class="toctree-l1"> | ||
| 190 | |||
| 191 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 192 | </li> | ||
| 193 | |||
| 194 | <li class="toctree-l1"> | ||
| 195 | |||
| 196 | <span class="caption-text">Development</span> | ||
| 197 | <ul class="subnav"> | ||
| 198 | <li class=""> | ||
| 199 | |||
| 200 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 201 | </li> | ||
| 202 | <li class=""> | ||
| 203 | |||
| 204 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 205 | </li> | ||
| 206 | <li class=""> | ||
| 207 | |||
| 208 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 209 | </li> | ||
| 210 | <li class=""> | ||
| 211 | |||
| 212 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 213 | </li> | ||
| 214 | <li class=""> | ||
| 215 | |||
| 216 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 217 | </li> | ||
| 218 | <li class=""> | ||
| 219 | |||
| 220 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 221 | </li> | ||
| 222 | <li class=""> | ||
| 223 | |||
| 224 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 225 | </li> | ||
| 226 | <li class=""> | ||
| 227 | |||
| 228 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 229 | </li> | ||
| 230 | <li class=""> | ||
| 231 | |||
| 232 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 233 | </li> | ||
| 234 | <li class=""> | ||
| 235 | |||
| 236 | <a class="" href="../Security/">Security</a> | ||
| 237 | </li> | ||
| 238 | <li class=""> | ||
| 239 | |||
| 240 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 241 | </li> | ||
| 242 | <li class=""> | ||
| 243 | |||
| 244 | <a class="" href="../Theming/">Theming</a> | ||
| 245 | </li> | ||
| 246 | <li class=""> | ||
| 247 | |||
| 248 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 249 | </li> | ||
| 250 | </ul> | ||
| 251 | </li> | ||
| 252 | |||
| 253 | <li class="toctree-l1"> | ||
| 254 | |||
| 255 | <span class="caption-text">About</span> | ||
| 256 | <ul class="subnav"> | ||
| 257 | <li class=""> | ||
| 258 | |||
| 259 | <a class="" href="../FAQ/">FAQ</a> | ||
| 260 | </li> | ||
| 261 | <li class=""> | ||
| 262 | |||
| 263 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 264 | </li> | ||
| 265 | </ul> | ||
| 266 | </li> | ||
| 267 | |||
| 268 | </ul> | ||
| 269 | </div> | ||
| 270 | | ||
| 271 | </nav> | ||
| 272 | |||
| 273 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 274 | |||
| 275 | |||
| 276 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 277 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 278 | <a href="..">Shaarli Documentation</a> | ||
| 279 | </nav> | ||
| 280 | |||
| 281 | |||
| 282 | <div class="wy-nav-content"> | ||
| 283 | <div class="rst-content"> | ||
| 284 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 285 | <ul class="wy-breadcrumbs"> | ||
| 286 | <li><a href="..">Docs</a> »</li> | ||
| 287 | |||
| 288 | |||
| 289 | |||
| 290 | <li>Usage »</li> | ||
| 291 | |||
| 292 | |||
| 293 | |||
| 294 | <li>REST API</li> | ||
| 295 | <li class="wy-breadcrumbs-aside"> | ||
| 296 | |||
| 297 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/REST-API.md" | ||
| 298 | class="icon icon-github"> Edit on GitHub</a> | ||
| 299 | |||
| 300 | </li> | ||
| 301 | </ul> | ||
| 302 | <hr/> | ||
| 303 | </div> | ||
| 304 | <div role="main"> | ||
| 305 | <div class="section"> | ||
| 306 | |||
| 307 | <h2 id="usage">Usage</h2> | ||
| 308 | <p>See the <a href="http://shaarli.github.io/api-documentation/">REST API documentation</a>.</p> | ||
| 309 | <h2 id="authentication">Authentication</h2> | ||
| 310 | <p>All requests to Shaarli's API must include a JWT token to verify their authenticity.</p> | ||
| 311 | <p>This token has to be included as an HTTP header called <code>Authentication: Bearer <jwt token></code>.</p> | ||
| 312 | <p>JWT resources :</p> | ||
| 313 | <ul> | ||
| 314 | <li><a href="https://jwt.io">jwt.io</a> (including a list of client per language).</li> | ||
| 315 | <li>RFC : https://tools.ietf.org/html/rfc7519</li> | ||
| 316 | <li>https://float-middle.com/json-web-tokens-jwt-vs-sessions/</li> | ||
| 317 | <li>HackerNews thread: https://news.ycombinator.com/item?id=11929267</li> | ||
| 318 | </ul> | ||
| 319 | <h3 id="shaarli-jwt-token">Shaarli JWT Token</h3> | ||
| 320 | <p>JWT tokens are composed by three parts, separated by a dot <code>.</code> and encoded in base64:</p> | ||
| 321 | <pre><code>[header].[payload].[signature] | ||
| 322 | </code></pre> | ||
| 323 | |||
| 324 | <h4 id="header">Header</h4> | ||
| 325 | <p>Shaarli only allow one hash algorithm, so the header will always be the same:</p> | ||
| 326 | <pre><code class="json">{ | ||
| 327 | "typ": "JWT", | ||
| 328 | "alg": "HS512" | ||
| 329 | } | ||
| 330 | </code></pre> | ||
| 331 | |||
| 332 | <p>Encoded in base64, it gives:</p> | ||
| 333 | <pre><code>ewogICAgICAgICJ0eXAiOiAiSldUIiwKICAgICAgICAiYWxnIjogIkhTNTEyIgogICAgfQ== | ||
| 334 | </code></pre> | ||
| 335 | |||
| 336 | <h4 id="payload">Payload</h4> | ||
| 337 | <p><strong>Validity duration</strong></p> | ||
| 338 | <p>To avoid infinite token validity, JWT tokens must include their creation date in UNIX timestamp format (timezone independant - UTC) under the key <code>iat</code> (issued at). This token will be accepted during 9 minutes.</p> | ||
| 339 | <pre><code class="json">{ | ||
| 340 | "iat": 1468663519 | ||
| 341 | } | ||
| 342 | </code></pre> | ||
| 343 | |||
| 344 | <p>See <a href="https://tools.ietf.org/html/rfc7519#section-4.1.6">RFC reference</a>.</p> | ||
| 345 | <h4 id="signature">Signature</h4> | ||
| 346 | <p>The signature authenticate the token validity. It contains the base64 of the header and the body, separated by a dot <code>.</code>, hashed in SHA512 with the API secret available in Shaarli administration page.</p> | ||
| 347 | <p>Signature example with PHP:</p> | ||
| 348 | <pre><code class="php">$content = base64_encode($header) . '.' . base64_encode($payload); | ||
| 349 | $signature = hash_hmac('sha512', $content, $secret); | ||
| 350 | </code></pre> | ||
| 351 | |||
| 352 | <h3 id="complete-example">Complete example</h3> | ||
| 353 | <h4 id="php">PHP</h4> | ||
| 354 | <pre><code class="php">function generateToken($secret) { | ||
| 355 | $header = base64_encode('{ | ||
| 356 | "typ": "JWT", | ||
| 357 | "alg": "HS512" | ||
| 358 | }'); | ||
| 359 | $payload = base64_encode('{ | ||
| 360 | "iat": '. time() .' | ||
| 361 | }'); | ||
| 362 | $signature = hash_hmac('sha512', $header .'.'. $payload , $secret); | ||
| 363 | return $header .'.'. $payload .'.'. $signature; | ||
| 364 | } | ||
| 365 | |||
| 366 | $secret = 'mysecret'; | ||
| 367 | $token = generateToken($secret); | ||
| 368 | echo $token; | ||
| 369 | </code></pre> | ||
| 370 | |||
| 371 | <blockquote> | ||
| 372 | <p><code>ewogICAgICAgICJ0eXAiOiAiSldUIiwKICAgICAgICAiYWxnIjogIkhTNTEyIgogICAgfQ==.ewogICAgICAgICJpYXQiOiAxNDY4NjY3MDQ3CiAgICB9.1d2c54fa947daf594fdbf7591796195652c8bc63bffad7f6a6db2a41c313f495a542cbfb595acade79e83f3810d709b4251d7b940bbc10b531a6e6134af63a68</code></p> | ||
| 373 | </blockquote> | ||
| 374 | <pre><code class="php">$options = [ | ||
| 375 | 'http' => [ | ||
| 376 | 'method' => 'GET', | ||
| 377 | 'jwt' => $token, | ||
| 378 | ], | ||
| 379 | ]; | ||
| 380 | $context = stream_context_create($options); | ||
| 381 | file_get_contents($apiEndpoint, false, $context); | ||
| 382 | </code></pre> | ||
| 383 | |||
| 384 | </div> | ||
| 385 | </div> | ||
| 386 | <footer> | ||
| 387 | |||
| 388 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 389 | |||
| 390 | <a href="../Backup,-restore,-import-and-export/" class="btn btn-neutral float-right" title="Backup, restore, import and export">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 391 | |||
| 392 | |||
| 393 | <a href="../RSS-feeds/" class="btn btn-neutral" title="RSS feeds"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 394 | |||
| 395 | </div> | ||
| 396 | |||
| 397 | |||
| 398 | <hr/> | ||
| 399 | |||
| 400 | <div role="contentinfo"> | ||
| 401 | <!-- Copyright etc --> | ||
| 402 | |||
| 403 | </div> | ||
| 404 | |||
| 405 | 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>. | ||
| 406 | </footer> | ||
| 407 | |||
| 408 | </div> | ||
| 409 | </div> | ||
| 410 | |||
| 411 | </section> | ||
| 412 | |||
| 413 | </div> | ||
| 414 | |||
| 415 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 416 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 417 | |||
| 418 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 419 | |||
| 420 | |||
| 421 | <span><a href="../RSS-feeds/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 422 | |||
| 423 | |||
| 424 | <span style="margin-left: 15px"><a href="../Backup,-restore,-import-and-export/" style="color: #fcfcfc">Next »</a></span> | ||
| 425 | |||
| 426 | </span> | ||
| 427 | </div> | ||
| 428 | <script src="../js/theme.js"></script> | ||
| 429 | |||
| 430 | </body> | ||
| 431 | </html> | ||
diff --git a/doc/html/RSS-feeds/index.html b/doc/html/RSS-feeds/index.html new file mode 100644 index 00000000..bb6e412c --- /dev/null +++ b/doc/html/RSS-feeds/index.html | |||
| @@ -0,0 +1,367 @@ | |||
| 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>RSS feeds - 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 = "RSS feeds"; | ||
| 22 | var mkdocs_page_input_path = "RSS-feeds.md"; | ||
| 23 | var mkdocs_page_url = "/RSS-feeds/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="../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=" current"> | ||
| 135 | |||
| 136 | <a class="current" href="./">RSS feeds</a> | ||
| 137 | <ul class="subnav"> | ||
| 138 | |||
| 139 | <li class="toctree-l3"><a href="#feeds-options">Feeds options</a></li> | ||
| 140 | |||
| 141 | |||
| 142 | <li class="toctree-l3"><a href="#rss-feeds-or-picture-wall-for-a-specific-searchtag">RSS Feeds or Picture Wall for a specific search/tag</a></li> | ||
| 143 | |||
| 144 | |||
| 145 | </ul> | ||
| 146 | </li> | ||
| 147 | <li class=""> | ||
| 148 | |||
| 149 | <a class="" href="../REST-API/">REST API</a> | ||
| 150 | </li> | ||
| 151 | </ul> | ||
| 152 | </li> | ||
| 153 | |||
| 154 | <li class="toctree-l1"> | ||
| 155 | |||
| 156 | <span class="caption-text">How To</span> | ||
| 157 | <ul class="subnav"> | ||
| 158 | <li class=""> | ||
| 159 | |||
| 160 | <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a> | ||
| 161 | </li> | ||
| 162 | <li class=""> | ||
| 163 | |||
| 164 | <a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 165 | </li> | ||
| 166 | <li class=""> | ||
| 167 | |||
| 168 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 169 | </li> | ||
| 170 | <li class=""> | ||
| 171 | |||
| 172 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 173 | </li> | ||
| 174 | <li class=""> | ||
| 175 | |||
| 176 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 177 | </li> | ||
| 178 | </ul> | ||
| 179 | </li> | ||
| 180 | |||
| 181 | <li class="toctree-l1"> | ||
| 182 | |||
| 183 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 184 | </li> | ||
| 185 | |||
| 186 | <li class="toctree-l1"> | ||
| 187 | |||
| 188 | <span class="caption-text">Development</span> | ||
| 189 | <ul class="subnav"> | ||
| 190 | <li class=""> | ||
| 191 | |||
| 192 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 193 | </li> | ||
| 194 | <li class=""> | ||
| 195 | |||
| 196 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 197 | </li> | ||
| 198 | <li class=""> | ||
| 199 | |||
| 200 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 201 | </li> | ||
| 202 | <li class=""> | ||
| 203 | |||
| 204 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 205 | </li> | ||
| 206 | <li class=""> | ||
| 207 | |||
| 208 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 209 | </li> | ||
| 210 | <li class=""> | ||
| 211 | |||
| 212 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 213 | </li> | ||
| 214 | <li class=""> | ||
| 215 | |||
| 216 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 217 | </li> | ||
| 218 | <li class=""> | ||
| 219 | |||
| 220 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 221 | </li> | ||
| 222 | <li class=""> | ||
| 223 | |||
| 224 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 225 | </li> | ||
| 226 | <li class=""> | ||
| 227 | |||
| 228 | <a class="" href="../Security/">Security</a> | ||
| 229 | </li> | ||
| 230 | <li class=""> | ||
| 231 | |||
| 232 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 233 | </li> | ||
| 234 | <li class=""> | ||
| 235 | |||
| 236 | <a class="" href="../Theming/">Theming</a> | ||
| 237 | </li> | ||
| 238 | <li class=""> | ||
| 239 | |||
| 240 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 241 | </li> | ||
| 242 | </ul> | ||
| 243 | </li> | ||
| 244 | |||
| 245 | <li class="toctree-l1"> | ||
| 246 | |||
| 247 | <span class="caption-text">About</span> | ||
| 248 | <ul class="subnav"> | ||
| 249 | <li class=""> | ||
| 250 | |||
| 251 | <a class="" href="../FAQ/">FAQ</a> | ||
| 252 | </li> | ||
| 253 | <li class=""> | ||
| 254 | |||
| 255 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 256 | </li> | ||
| 257 | </ul> | ||
| 258 | </li> | ||
| 259 | |||
| 260 | </ul> | ||
| 261 | </div> | ||
| 262 | | ||
| 263 | </nav> | ||
| 264 | |||
| 265 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 266 | |||
| 267 | |||
| 268 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 269 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 270 | <a href="..">Shaarli Documentation</a> | ||
| 271 | </nav> | ||
| 272 | |||
| 273 | |||
| 274 | <div class="wy-nav-content"> | ||
| 275 | <div class="rst-content"> | ||
| 276 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 277 | <ul class="wy-breadcrumbs"> | ||
| 278 | <li><a href="..">Docs</a> »</li> | ||
| 279 | |||
| 280 | |||
| 281 | |||
| 282 | <li>Usage »</li> | ||
| 283 | |||
| 284 | |||
| 285 | |||
| 286 | <li>RSS feeds</li> | ||
| 287 | <li class="wy-breadcrumbs-aside"> | ||
| 288 | |||
| 289 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/RSS-feeds.md" | ||
| 290 | class="icon icon-github"> Edit on GitHub</a> | ||
| 291 | |||
| 292 | </li> | ||
| 293 | </ul> | ||
| 294 | <hr/> | ||
| 295 | </div> | ||
| 296 | <div role="main"> | ||
| 297 | <div class="section"> | ||
| 298 | |||
| 299 | <h3 id="feeds-options">Feeds options</h3> | ||
| 300 | <p>Feeds are available in ATOM with <code>?do=atom</code> and RSS with <code>do=RSS</code>.</p> | ||
| 301 | <p>Options: | ||
| 302 | - You can use <code>permalinks</code> in the feed URL to get permalink to Shaares instead of direct link to shaared URL. | ||
| 303 | - E.G. <code>https://my.shaarli.domain/?do=atom&permalinks</code>. | ||
| 304 | - You can use <code>nb</code> parameter in the feed URL to specify the number of Shaares you want in a feed (default if not specified: <code>50</code>). The keyword <code>all</code> is available if you want everything. | ||
| 305 | - <code>https://my.shaarli.domain/?do=atom&permalinks&nb=42</code> | ||
| 306 | - <code>https://my.shaarli.domain/?do=atom&permalinks&nb=all</code></p> | ||
| 307 | <h3 id="rss-feeds-or-picture-wall-for-a-specific-searchtag">RSS Feeds or Picture Wall for a specific search/tag</h3> | ||
| 308 | <p>It is possible to filter RSS/ATOM feeds and Picture Wall on a Shaarli to <strong>only display results of a specific search, or for a specific tag</strong>.</p> | ||
| 309 | <p>For example, if you want to subscribe only to links tagged <code>photography</code>: | ||
| 310 | - Go to the desired Shaarli instance. | ||
| 311 | - Search for the <code>photography</code> tag in the <em>Filter by tag</em> box. Links tagged <code>photography</code> are displayed. | ||
| 312 | - Click on the <code>RSS Feed</code> button. | ||
| 313 | - You are presented with an RSS feed showing only these links. Subscribe to it to receive only updates with this tag. | ||
| 314 | - The same method <strong>also works for a full-text search</strong> (<em>Search</em> box) <strong>and for the Picture Wall</strong> (want to only see pictures about <code>nature</code>?) | ||
| 315 | - You can also build the URLs manually: | ||
| 316 | - <code>https://my.shaarli.domain/?do=rss&searchtags=nature</code> | ||
| 317 | - <code>https://my.shaarli.domain/links/?do=picwall&searchterm=poney</code></p> | ||
| 318 | <p><img alt="" src="../images/rss-filter-1.png" /> <img alt="" src="../images/rss-filter-2.png" /></p> | ||
| 319 | |||
| 320 | </div> | ||
| 321 | </div> | ||
| 322 | <footer> | ||
| 323 | |||
| 324 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 325 | |||
| 326 | <a href="../REST-API/" class="btn btn-neutral float-right" title="REST API">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 327 | |||
| 328 | |||
| 329 | <a href="../Firefox-share/" class="btn btn-neutral" title="Firefox share"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 330 | |||
| 331 | </div> | ||
| 332 | |||
| 333 | |||
| 334 | <hr/> | ||
| 335 | |||
| 336 | <div role="contentinfo"> | ||
| 337 | <!-- Copyright etc --> | ||
| 338 | |||
| 339 | </div> | ||
| 340 | |||
| 341 | 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>. | ||
| 342 | </footer> | ||
| 343 | |||
| 344 | </div> | ||
| 345 | </div> | ||
| 346 | |||
| 347 | </section> | ||
| 348 | |||
| 349 | </div> | ||
| 350 | |||
| 351 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 352 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 353 | |||
| 354 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 355 | |||
| 356 | |||
| 357 | <span><a href="../Firefox-share/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 358 | |||
| 359 | |||
| 360 | <span style="margin-left: 15px"><a href="../REST-API/" style="color: #fcfcfc">Next »</a></span> | ||
| 361 | |||
| 362 | </span> | ||
| 363 | </div> | ||
| 364 | <script src="../js/theme.js"></script> | ||
| 365 | |||
| 366 | </body> | ||
| 367 | </html> | ||
diff --git a/doc/html/Release-Shaarli/index.html b/doc/html/Release-Shaarli/index.html new file mode 100644 index 00000000..cf5fcee8 --- /dev/null +++ b/doc/html/Release-Shaarli/index.html | |||
| @@ -0,0 +1,529 @@ | |||
| 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>Release Shaarli - 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 = "Release Shaarli"; | ||
| 22 | var mkdocs_page_input_path = "Release-Shaarli.md"; | ||
| 23 | var mkdocs_page_url = "/Release-Shaarli/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="../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="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 156 | </li> | ||
| 157 | <li class=""> | ||
| 158 | |||
| 159 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 160 | </li> | ||
| 161 | <li class=""> | ||
| 162 | |||
| 163 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 164 | </li> | ||
| 165 | <li class=""> | ||
| 166 | |||
| 167 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 168 | </li> | ||
| 169 | </ul> | ||
| 170 | </li> | ||
| 171 | |||
| 172 | <li class="toctree-l1"> | ||
| 173 | |||
| 174 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 175 | </li> | ||
| 176 | |||
| 177 | <li class="toctree-l1"> | ||
| 178 | |||
| 179 | <span class="caption-text">Development</span> | ||
| 180 | <ul class="subnav"> | ||
| 181 | <li class=""> | ||
| 182 | |||
| 183 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 184 | </li> | ||
| 185 | <li class=""> | ||
| 186 | |||
| 187 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 188 | </li> | ||
| 189 | <li class=""> | ||
| 190 | |||
| 191 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 192 | </li> | ||
| 193 | <li class=""> | ||
| 194 | |||
| 195 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 196 | </li> | ||
| 197 | <li class=""> | ||
| 198 | |||
| 199 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 200 | </li> | ||
| 201 | <li class=""> | ||
| 202 | |||
| 203 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 204 | </li> | ||
| 205 | <li class=""> | ||
| 206 | |||
| 207 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 208 | </li> | ||
| 209 | <li class=" current"> | ||
| 210 | |||
| 211 | <a class="current" href="./">Release Shaarli</a> | ||
| 212 | <ul class="subnav"> | ||
| 213 | |||
| 214 | <li class="toctree-l3"><a href="#prerequisites">Prerequisites</a></li> | ||
| 215 | |||
| 216 | |||
| 217 | <li class="toctree-l3"><a href="#github-release-draft-and-changelogmd">GitHub release draft and CHANGELOG.md</a></li> | ||
| 218 | |||
| 219 | <ul> | ||
| 220 | |||
| 221 | <li><a class="toctree-l4" href="#github-release-draft">GitHub release draft</a></li> | ||
| 222 | |||
| 223 | <li><a class="toctree-l4" href="#changelogmd">CHANGELOG.md</a></li> | ||
| 224 | |||
| 225 | </ul> | ||
| 226 | |||
| 227 | |||
| 228 | <li class="toctree-l3"><a href="#increment-the-version-code-updated-docs-create-and-push-a-signed-tag">Increment the version code, updated docs, create and push a signed tag</a></li> | ||
| 229 | |||
| 230 | <ul> | ||
| 231 | |||
| 232 | <li><a class="toctree-l4" href="#generate-documentation">Generate documentation</a></li> | ||
| 233 | |||
| 234 | <li><a class="toctree-l4" href="#create-and-merge-a-pull-request">Create and merge a Pull Request</a></li> | ||
| 235 | |||
| 236 | <li><a class="toctree-l4" href="#bump-shaarli-version-to-v0x-branch">Bump Shaarli version to v0.x branch</a></li> | ||
| 237 | |||
| 238 | <li><a class="toctree-l4" href="#create-and-push-a-signed-tag">Create and push a signed tag</a></li> | ||
| 239 | |||
| 240 | <li><a class="toctree-l4" href="#verify-a-signed-tag">Verify a signed tag</a></li> | ||
| 241 | |||
| 242 | </ul> | ||
| 243 | |||
| 244 | |||
| 245 | <li class="toctree-l3"><a href="#publish-the-github-release">Publish the GitHub release</a></li> | ||
| 246 | |||
| 247 | <ul> | ||
| 248 | |||
| 249 | <li><a class="toctree-l4" href="#update-release-badges">Update release badges</a></li> | ||
| 250 | |||
| 251 | <li><a class="toctree-l4" href="#create-a-github-release-from-a-git-tag">Create a GitHub release from a Git tag</a></li> | ||
| 252 | |||
| 253 | <li><a class="toctree-l4" href="#generate-and-upload-all-in-one-release-archives">Generate and upload all-in-one release archives</a></li> | ||
| 254 | |||
| 255 | <li><a class="toctree-l4" href="#update-stable-and-latest-branches">Update stable and latest branches</a></li> | ||
| 256 | |||
| 257 | </ul> | ||
| 258 | |||
| 259 | |||
| 260 | </ul> | ||
| 261 | </li> | ||
| 262 | <li class=""> | ||
| 263 | |||
| 264 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 265 | </li> | ||
| 266 | <li class=""> | ||
| 267 | |||
| 268 | <a class="" href="../Security/">Security</a> | ||
| 269 | </li> | ||
| 270 | <li class=""> | ||
| 271 | |||
| 272 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 273 | </li> | ||
| 274 | <li class=""> | ||
| 275 | |||
| 276 | <a class="" href="../Theming/">Theming</a> | ||
| 277 | </li> | ||
| 278 | <li class=""> | ||
| 279 | |||
| 280 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 281 | </li> | ||
| 282 | </ul> | ||
| 283 | </li> | ||
| 284 | |||
| 285 | <li class="toctree-l1"> | ||
| 286 | |||
| 287 | <span class="caption-text">About</span> | ||
| 288 | <ul class="subnav"> | ||
| 289 | <li class=""> | ||
| 290 | |||
| 291 | <a class="" href="../FAQ/">FAQ</a> | ||
| 292 | </li> | ||
| 293 | <li class=""> | ||
| 294 | |||
| 295 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 296 | </li> | ||
| 297 | </ul> | ||
| 298 | </li> | ||
| 299 | |||
| 300 | </ul> | ||
| 301 | </div> | ||
| 302 | | ||
| 303 | </nav> | ||
| 304 | |||
| 305 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 306 | |||
| 307 | |||
| 308 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 309 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 310 | <a href="..">Shaarli Documentation</a> | ||
| 311 | </nav> | ||
| 312 | |||
| 313 | |||
| 314 | <div class="wy-nav-content"> | ||
| 315 | <div class="rst-content"> | ||
| 316 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 317 | <ul class="wy-breadcrumbs"> | ||
| 318 | <li><a href="..">Docs</a> »</li> | ||
| 319 | |||
| 320 | |||
| 321 | |||
| 322 | <li>Development »</li> | ||
| 323 | |||
| 324 | |||
| 325 | |||
| 326 | <li>Release Shaarli</li> | ||
| 327 | <li class="wy-breadcrumbs-aside"> | ||
| 328 | |||
| 329 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Release-Shaarli.md" | ||
| 330 | class="icon icon-github"> Edit on GitHub</a> | ||
| 331 | |||
| 332 | </li> | ||
| 333 | </ul> | ||
| 334 | <hr/> | ||
| 335 | </div> | ||
| 336 | <div role="main"> | ||
| 337 | <div class="section"> | ||
| 338 | |||
| 339 | <p>See <a href="http://git-scm.com/book/en/v2/Distributed-Git-Maintaining-a-Project#Tagging-Your-Releases">Git - Maintaining a project - Tagging your | ||
| 340 | releases</a>.</p> | ||
| 341 | <h2 id="prerequisites">Prerequisites</h2> | ||
| 342 | <p>This guide assumes that you have: | ||
| 343 | - a GPG key matching your GitHub authentication credentials | ||
| 344 | - i.e., the email address identified by the GPG key is the same as the one in your <code>~/.gitconfig</code> | ||
| 345 | - a GitHub fork of Shaarli | ||
| 346 | - a local clone of your Shaarli fork, with the following remotes: | ||
| 347 | - <code>origin</code> pointing to your GitHub fork | ||
| 348 | - <code>upstream</code> pointing to the main Shaarli repository | ||
| 349 | - maintainer permissions on the main Shaarli repository, to: | ||
| 350 | - push the signed tag | ||
| 351 | - create a new release | ||
| 352 | - <a href="https://getcomposer.org/">Composer</a> and <a href="http://pandoc.org/">Pandoc</a> need to be installed</p> | ||
| 353 | <h2 id="github-release-draft-and-changelogmd">GitHub release draft and <code>CHANGELOG.md</code></h2> | ||
| 354 | <p>See http://keepachangelog.com/en/0.3.0/ for changelog formatting.</p> | ||
| 355 | <h3 id="github-release-draft">GitHub release draft</h3> | ||
| 356 | <p>GitHub allows drafting the release note for the upcoming release, from the <a href="https://github.com/shaarli/Shaarli/releases">Releases</a> page. This way, the release note can be drafted while contributions are merged to <code>master</code>.</p> | ||
| 357 | <h3 id="changelogmd"><code>CHANGELOG.md</code></h3> | ||
| 358 | <p>This file should contain the same information as the release note draft for the upcoming version.</p> | ||
| 359 | <p>Update it to: | ||
| 360 | - add new entries (additions, fixes, etc.) | ||
| 361 | - mark the current version as released by setting its date and link | ||
| 362 | - add a new section for the future unreleased version</p> | ||
| 363 | <pre><code class="bash">$ cd /path/to/shaarli | ||
| 364 | |||
| 365 | $ nano CHANGELOG.md | ||
| 366 | |||
| 367 | [...] | ||
| 368 | ## vA.B.C - UNRELEASED | ||
| 369 | TBA | ||
| 370 | |||
| 371 | ## [vX.Y.Z](https://github.com/shaarli/Shaarli/releases/tag/vX.Y.Z) - YYYY-MM-DD | ||
| 372 | [...] | ||
| 373 | </code></pre> | ||
| 374 | |||
| 375 | <h2 id="increment-the-version-code-updated-docs-create-and-push-a-signed-tag">Increment the version code, updated docs, create and push a signed tag</h2> | ||
| 376 | <h3 id="generate-documentation">Generate documentation</h3> | ||
| 377 | <pre><code class="bash">$ cd /path/to/shaarli | ||
| 378 | |||
| 379 | # create a new branch | ||
| 380 | $ git fetch upstream | ||
| 381 | $ git checkout upstream/master -b v0.5.0 | ||
| 382 | |||
| 383 | # rebuild the documentation from the wiki | ||
| 384 | $ make htmldoc | ||
| 385 | |||
| 386 | # commit the changes | ||
| 387 | $ git add doc | ||
| 388 | $ git commit -s -m "Generate documentation for v0.5.0" | ||
| 389 | |||
| 390 | # push the commit on your GitHub fork | ||
| 391 | $ git push origin v0.5.0 | ||
| 392 | </code></pre> | ||
| 393 | |||
| 394 | <h3 id="create-and-merge-a-pull-request">Create and merge a Pull Request</h3> | ||
| 395 | <p>This one is pretty straightforward ;-)</p> | ||
| 396 | <h3 id="bump-shaarli-version-to-v0x-branch">Bump Shaarli version to v0.x branch</h3> | ||
| 397 | <pre><code>$ git checkout master | ||
| 398 | $ git fetch upstream | ||
| 399 | $ git pull upstream master | ||
| 400 | |||
| 401 | # IF the branch doesn't exists | ||
| 402 | $ git checkout -b v0.5 | ||
| 403 | # OR if the branch already exists | ||
| 404 | $ git checkout v0.5 | ||
| 405 | $ git rebase upstream/master | ||
| 406 | |||
| 407 | # Bump shaarli version from dev to 0.5.0, **without the `v`** | ||
| 408 | $ vim shaarli_version.php | ||
| 409 | $ git add shaarli_version | ||
| 410 | $ git commit -s -m "Bump Shaarli version to v0.5.0" | ||
| 411 | $ git push upstream v0.5 | ||
| 412 | </code></pre> | ||
| 413 | |||
| 414 | <h3 id="create-and-push-a-signed-tag">Create and push a signed tag</h3> | ||
| 415 | <pre><code class="bash"># update your local copy | ||
| 416 | $ git checkout v0.5 | ||
| 417 | $ git fetch upstream | ||
| 418 | $ git pull upstream v0.5 | ||
| 419 | |||
| 420 | # create a signed tag | ||
| 421 | $ git tag -s -m "Release v0.5.0" v0.5.0 | ||
| 422 | |||
| 423 | # push it to "upstream" | ||
| 424 | $ git push --tags upstream | ||
| 425 | </code></pre> | ||
| 426 | |||
| 427 | <h3 id="verify-a-signed-tag">Verify a signed tag</h3> | ||
| 428 | <p><a href="https://github.com/shaarli/Shaarli/releases/tag/v0.5.0"><code>v0.5.0</code></a> is the first GPG-signed tag pushed on the Community Shaarli.</p> | ||
| 429 | <p>Let's have a look at its signature!</p> | ||
| 430 | <pre><code class="bash">$ cd /path/to/shaarli | ||
| 431 | $ git fetch upstream | ||
| 432 | |||
| 433 | # get the SHA1 reference of the tag | ||
| 434 | $ git show-ref tags/v0.5.0 | ||
| 435 | f7762cf803f03f5caf4b8078359a63783d0090c1 refs/tags/v0.5.0 | ||
| 436 | |||
| 437 | # verify the tag signature information | ||
| 438 | $ git verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1 | ||
| 439 | gpg: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F | ||
| 440 | gpg: Good signature from "VirtualTam <virtualtam@flibidi.net>" [ultimate] | ||
| 441 | </code></pre> | ||
| 442 | |||
| 443 | <h2 id="publish-the-github-release">Publish the GitHub release</h2> | ||
| 444 | <h3 id="update-release-badges">Update release badges</h3> | ||
| 445 | <p>Update <code>README.md</code> so version badges display and point to the newly released Shaarli version(s), in the <code>master</code> branch.</p> | ||
| 446 | <h3 id="create-a-github-release-from-a-git-tag">Create a GitHub release from a Git tag</h3> | ||
| 447 | <p>From the previously drafted release: | ||
| 448 | - edit the release notes (if needed) | ||
| 449 | - specify the appropriate Git tag | ||
| 450 | - publish the release | ||
| 451 | - profit!</p> | ||
| 452 | <h3 id="generate-and-upload-all-in-one-release-archives">Generate and upload all-in-one release archives</h3> | ||
| 453 | <p>Users with a shared hosting may have: | ||
| 454 | - no SSH access | ||
| 455 | - no possibility to install PHP packages or server extensions | ||
| 456 | - no possibility to run scripts</p> | ||
| 457 | <p>To ease Shaarli installations, it is possible to generate and upload additional release archives, | ||
| 458 | that will contain Shaarli code plus all required third-party libraries.</p> | ||
| 459 | <p><strong>From the <code>v0.5</code> branch:</strong></p> | ||
| 460 | <pre><code class="bash">$ make release_archive | ||
| 461 | </code></pre> | ||
| 462 | |||
| 463 | <p>This will create the following archives: | ||
| 464 | - <code>shaarli-vX.Y.Z-full.tar</code> | ||
| 465 | - <code>shaarli-vX.Y.Z-full.zip</code></p> | ||
| 466 | <p>The archives need to be manually uploaded on the previously created GitHub release.</p> | ||
| 467 | <h3 id="update-stable-and-latest-branches">Update <code>stable</code> and <code>latest</code> branches</h3> | ||
| 468 | <pre><code>$ git checkout latest | ||
| 469 | # latest release | ||
| 470 | $ git merge v0.5.0 | ||
| 471 | # fix eventual conflicts | ||
| 472 | $ make test | ||
| 473 | $ git push upstream latest | ||
| 474 | $ git checkout stable | ||
| 475 | # latest previous major | ||
| 476 | $ git merge v0.4.5 | ||
| 477 | # fix eventual conflicts | ||
| 478 | $ make test | ||
| 479 | $ git push upstream stable | ||
| 480 | </code></pre> | ||
| 481 | |||
| 482 | </div> | ||
| 483 | </div> | ||
| 484 | <footer> | ||
| 485 | |||
| 486 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 487 | |||
| 488 | <a href="../Versioning-and-Branches/" class="btn btn-neutral float-right" title="Versioning and Branches">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 489 | |||
| 490 | |||
| 491 | <a href="../Plugin-System/" class="btn btn-neutral" title="Plugin System"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 492 | |||
| 493 | </div> | ||
| 494 | |||
| 495 | |||
| 496 | <hr/> | ||
| 497 | |||
| 498 | <div role="contentinfo"> | ||
| 499 | <!-- Copyright etc --> | ||
| 500 | |||
| 501 | </div> | ||
| 502 | |||
| 503 | 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>. | ||
| 504 | </footer> | ||
| 505 | |||
| 506 | </div> | ||
| 507 | </div> | ||
| 508 | |||
| 509 | </section> | ||
| 510 | |||
| 511 | </div> | ||
| 512 | |||
| 513 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 514 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 515 | |||
| 516 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 517 | |||
| 518 | |||
| 519 | <span><a href="../Plugin-System/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 520 | |||
| 521 | |||
| 522 | <span style="margin-left: 15px"><a href="../Versioning-and-Branches/" style="color: #fcfcfc">Next »</a></span> | ||
| 523 | |||
| 524 | </span> | ||
| 525 | </div> | ||
| 526 | <script src="../js/theme.js"></script> | ||
| 527 | |||
| 528 | </body> | ||
| 529 | </html> | ||
diff --git a/doc/html/Reverse-proxy-configuration/index.html b/doc/html/Reverse-proxy-configuration/index.html new file mode 100644 index 00000000..bebd663f --- /dev/null +++ b/doc/html/Reverse-proxy-configuration/index.html | |||
| @@ -0,0 +1,350 @@ | |||
| 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>Reverse proxy configuration - 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 = "Reverse proxy configuration"; | ||
| 22 | var mkdocs_page_input_path = "Reverse-proxy-configuration.md"; | ||
| 23 | var mkdocs_page_url = "/Reverse-proxy-configuration/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=" current"> | ||
| 104 | |||
| 105 | <a class="current" href="./">Reverse proxy configuration</a> | ||
| 106 | <ul class="subnav"> | ||
| 107 | |||
| 108 | <li class="toctree-l3"><a href="#haproxy">HAProxy</a></li> | ||
| 109 | |||
| 110 | |||
| 111 | <li class="toctree-l3"><a href="#nginx">Nginx</a></li> | ||
| 112 | |||
| 113 | |||
| 114 | </ul> | ||
| 115 | </li> | ||
| 116 | <li class=""> | ||
| 117 | |||
| 118 | <a class="" href="../Docker-resources/">Docker resources</a> | ||
| 119 | </li> | ||
| 120 | </ul> | ||
| 121 | </li> | ||
| 122 | |||
| 123 | <li class="toctree-l1"> | ||
| 124 | |||
| 125 | <span class="caption-text">Usage</span> | ||
| 126 | <ul class="subnav"> | ||
| 127 | <li class=""> | ||
| 128 | |||
| 129 | <a class="" href="../Features/">Features</a> | ||
| 130 | </li> | ||
| 131 | <li class=""> | ||
| 132 | |||
| 133 | <a class="" href="../Bookmarklet/">Bookmarklet</a> | ||
| 134 | </li> | ||
| 135 | <li class=""> | ||
| 136 | |||
| 137 | <a class="" href="../Browsing-and-searching/">Browsing and searching</a> | ||
| 138 | </li> | ||
| 139 | <li class=""> | ||
| 140 | |||
| 141 | <a class="" href="../Firefox-share/">Firefox share</a> | ||
| 142 | </li> | ||
| 143 | <li class=""> | ||
| 144 | |||
| 145 | <a class="" href="../RSS-feeds/">RSS feeds</a> | ||
| 146 | </li> | ||
| 147 | <li class=""> | ||
| 148 | |||
| 149 | <a class="" href="../REST-API/">REST API</a> | ||
| 150 | </li> | ||
| 151 | </ul> | ||
| 152 | </li> | ||
| 153 | |||
| 154 | <li class="toctree-l1"> | ||
| 155 | |||
| 156 | <span class="caption-text">How To</span> | ||
| 157 | <ul class="subnav"> | ||
| 158 | <li class=""> | ||
| 159 | |||
| 160 | <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a> | ||
| 161 | </li> | ||
| 162 | <li class=""> | ||
| 163 | |||
| 164 | <a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 165 | </li> | ||
| 166 | <li class=""> | ||
| 167 | |||
| 168 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 169 | </li> | ||
| 170 | <li class=""> | ||
| 171 | |||
| 172 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 173 | </li> | ||
| 174 | <li class=""> | ||
| 175 | |||
| 176 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 177 | </li> | ||
| 178 | </ul> | ||
| 179 | </li> | ||
| 180 | |||
| 181 | <li class="toctree-l1"> | ||
| 182 | |||
| 183 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 184 | </li> | ||
| 185 | |||
| 186 | <li class="toctree-l1"> | ||
| 187 | |||
| 188 | <span class="caption-text">Development</span> | ||
| 189 | <ul class="subnav"> | ||
| 190 | <li class=""> | ||
| 191 | |||
| 192 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 193 | </li> | ||
| 194 | <li class=""> | ||
| 195 | |||
| 196 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 197 | </li> | ||
| 198 | <li class=""> | ||
| 199 | |||
| 200 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 201 | </li> | ||
| 202 | <li class=""> | ||
| 203 | |||
| 204 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 205 | </li> | ||
| 206 | <li class=""> | ||
| 207 | |||
| 208 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 209 | </li> | ||
| 210 | <li class=""> | ||
| 211 | |||
| 212 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 213 | </li> | ||
| 214 | <li class=""> | ||
| 215 | |||
| 216 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 217 | </li> | ||
| 218 | <li class=""> | ||
| 219 | |||
| 220 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 221 | </li> | ||
| 222 | <li class=""> | ||
| 223 | |||
| 224 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 225 | </li> | ||
| 226 | <li class=""> | ||
| 227 | |||
| 228 | <a class="" href="../Security/">Security</a> | ||
| 229 | </li> | ||
| 230 | <li class=""> | ||
| 231 | |||
| 232 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 233 | </li> | ||
| 234 | <li class=""> | ||
| 235 | |||
| 236 | <a class="" href="../Theming/">Theming</a> | ||
| 237 | </li> | ||
| 238 | <li class=""> | ||
| 239 | |||
| 240 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 241 | </li> | ||
| 242 | </ul> | ||
| 243 | </li> | ||
| 244 | |||
| 245 | <li class="toctree-l1"> | ||
| 246 | |||
| 247 | <span class="caption-text">About</span> | ||
| 248 | <ul class="subnav"> | ||
| 249 | <li class=""> | ||
| 250 | |||
| 251 | <a class="" href="../FAQ/">FAQ</a> | ||
| 252 | </li> | ||
| 253 | <li class=""> | ||
| 254 | |||
| 255 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 256 | </li> | ||
| 257 | </ul> | ||
| 258 | </li> | ||
| 259 | |||
| 260 | </ul> | ||
| 261 | </div> | ||
| 262 | | ||
| 263 | </nav> | ||
| 264 | |||
| 265 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 266 | |||
| 267 | |||
| 268 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 269 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 270 | <a href="..">Shaarli Documentation</a> | ||
| 271 | </nav> | ||
| 272 | |||
| 273 | |||
| 274 | <div class="wy-nav-content"> | ||
| 275 | <div class="rst-content"> | ||
| 276 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 277 | <ul class="wy-breadcrumbs"> | ||
| 278 | <li><a href="..">Docs</a> »</li> | ||
| 279 | |||
| 280 | |||
| 281 | |||
| 282 | <li>Docker »</li> | ||
| 283 | |||
| 284 | |||
| 285 | |||
| 286 | <li>Reverse proxy configuration</li> | ||
| 287 | <li class="wy-breadcrumbs-aside"> | ||
| 288 | |||
| 289 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Reverse-proxy-configuration.md" | ||
| 290 | class="icon icon-github"> Edit on GitHub</a> | ||
| 291 | |||
| 292 | </li> | ||
| 293 | </ul> | ||
| 294 | <hr/> | ||
| 295 | </div> | ||
| 296 | <div role="main"> | ||
| 297 | <div class="section"> | ||
| 298 | |||
| 299 | <p>TODO, see https://github.com/shaarli/Shaarli/issues/888</p> | ||
| 300 | <h2 id="haproxy">HAProxy</h2> | ||
| 301 | <h2 id="nginx">Nginx</h2> | ||
| 302 | |||
| 303 | </div> | ||
| 304 | </div> | ||
| 305 | <footer> | ||
| 306 | |||
| 307 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 308 | |||
| 309 | <a href="../Docker-resources/" class="btn btn-neutral float-right" title="Docker resources">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 310 | |||
| 311 | |||
| 312 | <a href="../Shaarli-images/" class="btn btn-neutral" title="Shaarli images"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 313 | |||
| 314 | </div> | ||
| 315 | |||
| 316 | |||
| 317 | <hr/> | ||
| 318 | |||
| 319 | <div role="contentinfo"> | ||
| 320 | <!-- Copyright etc --> | ||
| 321 | |||
| 322 | </div> | ||
| 323 | |||
| 324 | 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>. | ||
| 325 | </footer> | ||
| 326 | |||
| 327 | </div> | ||
| 328 | </div> | ||
| 329 | |||
| 330 | </section> | ||
| 331 | |||
| 332 | </div> | ||
| 333 | |||
| 334 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 335 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 336 | |||
| 337 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 338 | |||
| 339 | |||
| 340 | <span><a href="../Shaarli-images/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 341 | |||
| 342 | |||
| 343 | <span style="margin-left: 15px"><a href="../Docker-resources/" style="color: #fcfcfc">Next »</a></span> | ||
| 344 | |||
| 345 | </span> | ||
| 346 | </div> | ||
| 347 | <script src="../js/theme.js"></script> | ||
| 348 | |||
| 349 | </body> | ||
| 350 | </html> | ||
diff --git a/doc/html/Security/index.html b/doc/html/Security/index.html new file mode 100644 index 00000000..19b569e6 --- /dev/null +++ b/doc/html/Security/index.html | |||
| @@ -0,0 +1,386 @@ | |||
| 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>Security - 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 = "Security"; | ||
| 22 | var mkdocs_page_input_path = "Security.md"; | ||
| 23 | var mkdocs_page_url = "/Security/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="../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="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 156 | </li> | ||
| 157 | <li class=""> | ||
| 158 | |||
| 159 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 160 | </li> | ||
| 161 | <li class=""> | ||
| 162 | |||
| 163 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 164 | </li> | ||
| 165 | <li class=""> | ||
| 166 | |||
| 167 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 168 | </li> | ||
| 169 | </ul> | ||
| 170 | </li> | ||
| 171 | |||
| 172 | <li class="toctree-l1"> | ||
| 173 | |||
| 174 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 175 | </li> | ||
| 176 | |||
| 177 | <li class="toctree-l1"> | ||
| 178 | |||
| 179 | <span class="caption-text">Development</span> | ||
| 180 | <ul class="subnav"> | ||
| 181 | <li class=""> | ||
| 182 | |||
| 183 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 184 | </li> | ||
| 185 | <li class=""> | ||
| 186 | |||
| 187 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 188 | </li> | ||
| 189 | <li class=""> | ||
| 190 | |||
| 191 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 192 | </li> | ||
| 193 | <li class=""> | ||
| 194 | |||
| 195 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 196 | </li> | ||
| 197 | <li class=""> | ||
| 198 | |||
| 199 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 200 | </li> | ||
| 201 | <li class=""> | ||
| 202 | |||
| 203 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 204 | </li> | ||
| 205 | <li class=""> | ||
| 206 | |||
| 207 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 208 | </li> | ||
| 209 | <li class=""> | ||
| 210 | |||
| 211 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 212 | </li> | ||
| 213 | <li class=""> | ||
| 214 | |||
| 215 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 216 | </li> | ||
| 217 | <li class=" current"> | ||
| 218 | |||
| 219 | <a class="current" href="./">Security</a> | ||
| 220 | <ul class="subnav"> | ||
| 221 | |||
| 222 | <li class="toctree-l3"><a href="#client-browser">Client browser</a></li> | ||
| 223 | |||
| 224 | |||
| 225 | <li class="toctree-l3"><a href="#php">PHP</a></li> | ||
| 226 | |||
| 227 | |||
| 228 | <li class="toctree-l3"><a href="#server-and-sessions">Server and sessions</a></li> | ||
| 229 | |||
| 230 | |||
| 231 | <li class="toctree-l3"><a href="#shaarli-datastore-and-configuration">Shaarli datastore and configuration</a></li> | ||
| 232 | |||
| 233 | |||
| 234 | </ul> | ||
| 235 | </li> | ||
| 236 | <li class=""> | ||
| 237 | |||
| 238 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 239 | </li> | ||
| 240 | <li class=""> | ||
| 241 | |||
| 242 | <a class="" href="../Theming/">Theming</a> | ||
| 243 | </li> | ||
| 244 | <li class=""> | ||
| 245 | |||
| 246 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 247 | </li> | ||
| 248 | </ul> | ||
| 249 | </li> | ||
| 250 | |||
| 251 | <li class="toctree-l1"> | ||
| 252 | |||
| 253 | <span class="caption-text">About</span> | ||
| 254 | <ul class="subnav"> | ||
| 255 | <li class=""> | ||
| 256 | |||
| 257 | <a class="" href="../FAQ/">FAQ</a> | ||
| 258 | </li> | ||
| 259 | <li class=""> | ||
| 260 | |||
| 261 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 262 | </li> | ||
| 263 | </ul> | ||
| 264 | </li> | ||
| 265 | |||
| 266 | </ul> | ||
| 267 | </div> | ||
| 268 | | ||
| 269 | </nav> | ||
| 270 | |||
| 271 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 272 | |||
| 273 | |||
| 274 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 275 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 276 | <a href="..">Shaarli Documentation</a> | ||
| 277 | </nav> | ||
| 278 | |||
| 279 | |||
| 280 | <div class="wy-nav-content"> | ||
| 281 | <div class="rst-content"> | ||
| 282 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 283 | <ul class="wy-breadcrumbs"> | ||
| 284 | <li><a href="..">Docs</a> »</li> | ||
| 285 | |||
| 286 | |||
| 287 | |||
| 288 | <li>Development »</li> | ||
| 289 | |||
| 290 | |||
| 291 | |||
| 292 | <li>Security</li> | ||
| 293 | <li class="wy-breadcrumbs-aside"> | ||
| 294 | |||
| 295 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Security.md" | ||
| 296 | class="icon icon-github"> Edit on GitHub</a> | ||
| 297 | |||
| 298 | </li> | ||
| 299 | </ul> | ||
| 300 | <hr/> | ||
| 301 | </div> | ||
| 302 | <div role="main"> | ||
| 303 | <div class="section"> | ||
| 304 | |||
| 305 | <h2 id="client-browser">Client browser</h2> | ||
| 306 | <ul> | ||
| 307 | <li>Shaarli relies on <code>HTTP_REFERER</code> for some functions (like redirects and clicking on tags). If you have disabled or masqueraded <code>HTTP_REFERER</code> in your browser, some features of Shaarli may not work</li> | ||
| 308 | </ul> | ||
| 309 | <h2 id="php">PHP</h2> | ||
| 310 | <ul> | ||
| 311 | <li><code>magic_quotes</code> is an horrible option of PHP which is often activated on servers. No serious developer should rely on this horror to secure their code against SQL injections. You should disable it (and Shaarli expects this option to be disabled). Nevertheless, I have added code to cope with <code>magic_quotes</code> on, so you should not be bothered even on crappy hosts.</li> | ||
| 312 | </ul> | ||
| 313 | <h2 id="server-and-sessions">Server and sessions</h2> | ||
| 314 | <ul> | ||
| 315 | <li>Directories are protected using <code>.htaccess</code> files</li> | ||
| 316 | <li>Forms are protected against XSRF (Cross-site requests forgery):</li> | ||
| 317 | <li>Forms which act on data (save,delete…) contain a token generated by the server.</li> | ||
| 318 | <li>Any posted form which does not contain a valid token is rejected.</li> | ||
| 319 | <li>Any token can only be used once.</li> | ||
| 320 | <li>Tokens are attached to the session and cannot be reused in another session.</li> | ||
| 321 | <li>Sessions automatically expire after 60 minutes.</li> | ||
| 322 | <li>Sessions are protected against hijacking: the session ID cannot be used from a different IP address.</li> | ||
| 323 | </ul> | ||
| 324 | <h2 id="shaarli-datastore-and-configuration">Shaarli datastore and configuration</h2> | ||
| 325 | <ul> | ||
| 326 | <li>The password is salted, hashed and stored in the data subdirectory, in a PHP file, and protected by htaccess. Even if the webserver does not support htaccess, the hash is not readable by URL. Even if the .php file is stolen, the password cannot deduced from the hash. The salt prevents rainbow-tables attacks.</li> | ||
| 327 | <li>Links are stored as an associative array which is serialized, compressed (with deflate), base64-encoded and saved as a comment in a <code>.php</code> file.</li> | ||
| 328 | <li>Even if the server does not support <code>.htaccess</code> files, the data file will still not be readable by URL.</li> | ||
| 329 | <li>The database looks like this:</li> | ||
| 330 | </ul> | ||
| 331 | <pre><code class="php"><?php /* zP1ZjxxJtiYIvvevEPJ2lDOaLrZv7o... | ||
| 332 | ...ka7gaco/Z+TFXM2i7BlfMf8qxpaSSYfKlvqv/x8= */ ?> | ||
| 333 | </code></pre> | ||
| 334 | |||
| 335 | <ul> | ||
| 336 | <li>Small hashes are used to make a link to an entry in Shaarli. They are unique. In fact, the date of the items (eg. <code>20110923_150523</code>) is hashed with CRC32, then converted to base64 and some characters are replaced. They are always 6 characters longs and use only <code>A-Z a-z 0-9 - _</code> and <code>@</code>.</li> | ||
| 337 | </ul> | ||
| 338 | |||
| 339 | </div> | ||
| 340 | </div> | ||
| 341 | <footer> | ||
| 342 | |||
| 343 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 344 | |||
| 345 | <a href="../Static-analysis/" class="btn btn-neutral float-right" title="Static analysis">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 346 | |||
| 347 | |||
| 348 | <a href="../Versioning-and-Branches/" class="btn btn-neutral" title="Versioning and Branches"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 349 | |||
| 350 | </div> | ||
| 351 | |||
| 352 | |||
| 353 | <hr/> | ||
| 354 | |||
| 355 | <div role="contentinfo"> | ||
| 356 | <!-- Copyright etc --> | ||
| 357 | |||
| 358 | </div> | ||
| 359 | |||
| 360 | 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>. | ||
| 361 | </footer> | ||
| 362 | |||
| 363 | </div> | ||
| 364 | </div> | ||
| 365 | |||
| 366 | </section> | ||
| 367 | |||
| 368 | </div> | ||
| 369 | |||
| 370 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 371 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 372 | |||
| 373 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 374 | |||
| 375 | |||
| 376 | <span><a href="../Versioning-and-Branches/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 377 | |||
| 378 | |||
| 379 | <span style="margin-left: 15px"><a href="../Static-analysis/" style="color: #fcfcfc">Next »</a></span> | ||
| 380 | |||
| 381 | </span> | ||
| 382 | </div> | ||
| 383 | <script src="../js/theme.js"></script> | ||
| 384 | |||
| 385 | </body> | ||
| 386 | </html> | ||
diff --git a/doc/html/Server-configuration/index.html b/doc/html/Server-configuration/index.html new file mode 100644 index 00000000..beb8cd08 --- /dev/null +++ b/doc/html/Server-configuration/index.html | |||
| @@ -0,0 +1,747 @@ | |||
| 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>Server configuration - 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 = "Server configuration"; | ||
| 22 | var mkdocs_page_input_path = "Server-configuration.md"; | ||
| 23 | var mkdocs_page_url = "/Server-configuration/"; | ||
| 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=" current"> | ||
| 73 | |||
| 74 | <a class="current" href="./">Server configuration</a> | ||
| 75 | <ul class="subnav"> | ||
| 76 | |||
| 77 | <li class="toctree-l3"><a href="#prerequisites">Prerequisites</a></li> | ||
| 78 | |||
| 79 | <ul> | ||
| 80 | |||
| 81 | <li><a class="toctree-l4" href="#shaarli">Shaarli</a></li> | ||
| 82 | |||
| 83 | <li><a class="toctree-l4" href="#https-tls-and-self-signed-certificates">HTTPS, TLS and self-signed certificates</a></li> | ||
| 84 | |||
| 85 | <li><a class="toctree-l4" href="#proxies">Proxies</a></li> | ||
| 86 | |||
| 87 | </ul> | ||
| 88 | |||
| 89 | |||
| 90 | <li class="toctree-l3"><a href="#apache">Apache</a></li> | ||
| 91 | |||
| 92 | <ul> | ||
| 93 | |||
| 94 | <li><a class="toctree-l4" href="#minimal">Minimal</a></li> | ||
| 95 | |||
| 96 | <li><a class="toctree-l4" href="#debug-log-all-the-things">Debug - Log all the things!</a></li> | ||
| 97 | |||
| 98 | <li><a class="toctree-l4" href="#standard-keep-access-and-error-logs">Standard - Keep access and error logs</a></li> | ||
| 99 | |||
| 100 | <li><a class="toctree-l4" href="#paranoid-redirect-http-80-to-https-443">Paranoid - Redirect HTTP (:80) to HTTPS (:443)</a></li> | ||
| 101 | |||
| 102 | <li><a class="toctree-l4" href="#htaccess">.htaccess</a></li> | ||
| 103 | |||
| 104 | </ul> | ||
| 105 | |||
| 106 | |||
| 107 | <li class="toctree-l3"><a href="#lighthttpd">LightHttpd</a></li> | ||
| 108 | |||
| 109 | |||
| 110 | <li class="toctree-l3"><a href="#nginx">Nginx</a></li> | ||
| 111 | |||
| 112 | <ul> | ||
| 113 | |||
| 114 | <li><a class="toctree-l4" href="#foreword">Foreword</a></li> | ||
| 115 | |||
| 116 | <li><a class="toctree-l4" href="#common-setup">Common setup</a></li> | ||
| 117 | |||
| 118 | <li><a class="toctree-l4" href="#optional-increase-the-maximum-file-upload-size">(Optional) Increase the maximum file upload size</a></li> | ||
| 119 | |||
| 120 | <li><a class="toctree-l4" href="#minimal_1">Minimal</a></li> | ||
| 121 | |||
| 122 | <li><a class="toctree-l4" href="#modular">Modular</a></li> | ||
| 123 | |||
| 124 | <li><a class="toctree-l4" href="#redirect-http-to-https">Redirect HTTP to HTTPS</a></li> | ||
| 125 | |||
| 126 | </ul> | ||
| 127 | |||
| 128 | |||
| 129 | </ul> | ||
| 130 | </li> | ||
| 131 | <li class=""> | ||
| 132 | |||
| 133 | <a class="" href="../Server-security/">Server security</a> | ||
| 134 | </li> | ||
| 135 | <li class=""> | ||
| 136 | |||
| 137 | <a class="" href="../Shaarli-configuration/">Shaarli configuration</a> | ||
| 138 | </li> | ||
| 139 | <li class=""> | ||
| 140 | |||
| 141 | <a class="" href="../Plugins/">Plugins</a> | ||
| 142 | </li> | ||
| 143 | </ul> | ||
| 144 | </li> | ||
| 145 | |||
| 146 | <li class="toctree-l1"> | ||
| 147 | |||
| 148 | <span class="caption-text">Docker</span> | ||
| 149 | <ul class="subnav"> | ||
| 150 | <li class=""> | ||
| 151 | |||
| 152 | <a class="" href="../Docker-101/">Docker 101</a> | ||
| 153 | </li> | ||
| 154 | <li class=""> | ||
| 155 | |||
| 156 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 157 | </li> | ||
| 158 | <li class=""> | ||
| 159 | |||
| 160 | <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a> | ||
| 161 | </li> | ||
| 162 | <li class=""> | ||
| 163 | |||
| 164 | <a class="" href="../Docker-resources/">Docker resources</a> | ||
| 165 | </li> | ||
| 166 | </ul> | ||
| 167 | </li> | ||
| 168 | |||
| 169 | <li class="toctree-l1"> | ||
| 170 | |||
| 171 | <span class="caption-text">Usage</span> | ||
| 172 | <ul class="subnav"> | ||
| 173 | <li class=""> | ||
| 174 | |||
| 175 | <a class="" href="../Features/">Features</a> | ||
| 176 | </li> | ||
| 177 | <li class=""> | ||
| 178 | |||
| 179 | <a class="" href="../Bookmarklet/">Bookmarklet</a> | ||
| 180 | </li> | ||
| 181 | <li class=""> | ||
| 182 | |||
| 183 | <a class="" href="../Browsing-and-searching/">Browsing and searching</a> | ||
| 184 | </li> | ||
| 185 | <li class=""> | ||
| 186 | |||
| 187 | <a class="" href="../Firefox-share/">Firefox share</a> | ||
| 188 | </li> | ||
| 189 | <li class=""> | ||
| 190 | |||
| 191 | <a class="" href="../RSS-feeds/">RSS feeds</a> | ||
| 192 | </li> | ||
| 193 | <li class=""> | ||
| 194 | |||
| 195 | <a class="" href="../REST-API/">REST API</a> | ||
| 196 | </li> | ||
| 197 | </ul> | ||
| 198 | </li> | ||
| 199 | |||
| 200 | <li class="toctree-l1"> | ||
| 201 | |||
| 202 | <span class="caption-text">How To</span> | ||
| 203 | <ul class="subnav"> | ||
| 204 | <li class=""> | ||
| 205 | |||
| 206 | <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a> | ||
| 207 | </li> | ||
| 208 | <li class=""> | ||
| 209 | |||
| 210 | <a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 211 | </li> | ||
| 212 | <li class=""> | ||
| 213 | |||
| 214 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 215 | </li> | ||
| 216 | <li class=""> | ||
| 217 | |||
| 218 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 219 | </li> | ||
| 220 | <li class=""> | ||
| 221 | |||
| 222 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 223 | </li> | ||
| 224 | </ul> | ||
| 225 | </li> | ||
| 226 | |||
| 227 | <li class="toctree-l1"> | ||
| 228 | |||
| 229 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 230 | </li> | ||
| 231 | |||
| 232 | <li class="toctree-l1"> | ||
| 233 | |||
| 234 | <span class="caption-text">Development</span> | ||
| 235 | <ul class="subnav"> | ||
| 236 | <li class=""> | ||
| 237 | |||
| 238 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 239 | </li> | ||
| 240 | <li class=""> | ||
| 241 | |||
| 242 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 243 | </li> | ||
| 244 | <li class=""> | ||
| 245 | |||
| 246 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 247 | </li> | ||
| 248 | <li class=""> | ||
| 249 | |||
| 250 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 251 | </li> | ||
| 252 | <li class=""> | ||
| 253 | |||
| 254 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 255 | </li> | ||
| 256 | <li class=""> | ||
| 257 | |||
| 258 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 259 | </li> | ||
| 260 | <li class=""> | ||
| 261 | |||
| 262 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 263 | </li> | ||
| 264 | <li class=""> | ||
| 265 | |||
| 266 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 267 | </li> | ||
| 268 | <li class=""> | ||
| 269 | |||
| 270 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 271 | </li> | ||
| 272 | <li class=""> | ||
| 273 | |||
| 274 | <a class="" href="../Security/">Security</a> | ||
| 275 | </li> | ||
| 276 | <li class=""> | ||
| 277 | |||
| 278 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 279 | </li> | ||
| 280 | <li class=""> | ||
| 281 | |||
| 282 | <a class="" href="../Theming/">Theming</a> | ||
| 283 | </li> | ||
| 284 | <li class=""> | ||
| 285 | |||
| 286 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 287 | </li> | ||
| 288 | </ul> | ||
| 289 | </li> | ||
| 290 | |||
| 291 | <li class="toctree-l1"> | ||
| 292 | |||
| 293 | <span class="caption-text">About</span> | ||
| 294 | <ul class="subnav"> | ||
| 295 | <li class=""> | ||
| 296 | |||
| 297 | <a class="" href="../FAQ/">FAQ</a> | ||
| 298 | </li> | ||
| 299 | <li class=""> | ||
| 300 | |||
| 301 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 302 | </li> | ||
| 303 | </ul> | ||
| 304 | </li> | ||
| 305 | |||
| 306 | </ul> | ||
| 307 | </div> | ||
| 308 | | ||
| 309 | </nav> | ||
| 310 | |||
| 311 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 312 | |||
| 313 | |||
| 314 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 315 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 316 | <a href="..">Shaarli Documentation</a> | ||
| 317 | </nav> | ||
| 318 | |||
| 319 | |||
| 320 | <div class="wy-nav-content"> | ||
| 321 | <div class="rst-content"> | ||
| 322 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 323 | <ul class="wy-breadcrumbs"> | ||
| 324 | <li><a href="..">Docs</a> »</li> | ||
| 325 | |||
| 326 | |||
| 327 | |||
| 328 | <li>Setup »</li> | ||
| 329 | |||
| 330 | |||
| 331 | |||
| 332 | <li>Server configuration</li> | ||
| 333 | <li class="wy-breadcrumbs-aside"> | ||
| 334 | |||
| 335 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Server-configuration.md" | ||
| 336 | class="icon icon-github"> Edit on GitHub</a> | ||
| 337 | |||
| 338 | </li> | ||
| 339 | </ul> | ||
| 340 | <hr/> | ||
| 341 | </div> | ||
| 342 | <div role="main"> | ||
| 343 | <div class="section"> | ||
| 344 | |||
| 345 | <p><em>Example virtual host configurations for popular web servers</em></p> | ||
| 346 | <ul> | ||
| 347 | <li><a href="#apache">Apache</a></li> | ||
| 348 | <li><a href="#nginx">Nginx</a></li> | ||
| 349 | </ul> | ||
| 350 | <h2 id="prerequisites">Prerequisites</h2> | ||
| 351 | <h3 id="shaarli">Shaarli</h3> | ||
| 352 | <ul> | ||
| 353 | <li>Shaarli is installed in a directory readable/writeable by the user</li> | ||
| 354 | <li>the correct read/write permissions have been granted to the web server <em>user and/or group</em></li> | ||
| 355 | <li>for HTTPS / SSL:</li> | ||
| 356 | <li>a key pair (public, private) and a certificate have been generated</li> | ||
| 357 | <li>the appropriate server SSL extension is installed and active</li> | ||
| 358 | </ul> | ||
| 359 | <h3 id="https-tls-and-self-signed-certificates">HTTPS, TLS and self-signed certificates</h3> | ||
| 360 | <p>Related guides: | ||
| 361 | <em> <a href="http://www.xenocafe.com/tutorials/linux/centos/openssl/self_signed_certificates/index.php">How to Create Self-Signed SSL Certificates with OpenSSL</a> | ||
| 362 | </em> <a href="https://workaround.org/certificate-authority">How do I create my own Certificate Authority?</a> | ||
| 363 | * Generate a self-signed certificate (will trigger browser warnings) with apache2: <code>make-ssl-cert generate-default-snakeoil --force-overwrite</code> will create <code>/etc/ssl/certs/ssl-cert-snakeoil.pem</code> and <code>/etc/ssl/private/ssl-cert-snakeoil.key</code></p> | ||
| 364 | <h3 id="proxies">Proxies</h3> | ||
| 365 | <p>If Shaarli is served behind a proxy (i.e. there is a proxy server between clients and the web server hosting Shaarli), please refer to the proxy server documentation for proper configuration. In particular, you have to ensure that the following server variables are properly set: | ||
| 366 | - <code>X-Forwarded-Proto</code>; | ||
| 367 | - <code>X-Forwarded-Host</code>; | ||
| 368 | - <code>X-Forwarded-For</code>.</p> | ||
| 369 | <p>See also <a href="https://github.com/shaarli/Shaarli/issues?utf8=%E2%9C%93&q=label%3Aproxy+">proxy-related</a> issues.</p> | ||
| 370 | <h2 id="apache">Apache</h2> | ||
| 371 | <h3 id="minimal">Minimal</h3> | ||
| 372 | <pre><code class="apache"><VirtualHost *:80> | ||
| 373 | ServerName shaarli.my-domain.org | ||
| 374 | DocumentRoot /absolute/path/to/shaarli/ | ||
| 375 | </VirtualHost> | ||
| 376 | </code></pre> | ||
| 377 | |||
| 378 | <h3 id="debug-log-all-the-things">Debug - Log all the things!</h3> | ||
| 379 | <p>This configuration will log both Apache and PHP errors, which may prove useful to identify server configuration errors.</p> | ||
| 380 | <p>See: | ||
| 381 | <em> <a href="http://stackoverflow.com/q/176">Apache/PHP - error log per VirtualHost</a> (StackOverflow) | ||
| 382 | </em> <a href="https://ma.ttias.be/php-php_value-vs-php_admin_value-and-the-use-of-php_flag-explained/">PHP: php_value vs php_admin_value and the use of php_flag explained</a></p> | ||
| 383 | <pre><code class="apache"><VirtualHost *:80> | ||
| 384 | ServerName shaarli.my-domain.org | ||
| 385 | DocumentRoot /absolute/path/to/shaarli/ | ||
| 386 | |||
| 387 | LogLevel warn | ||
| 388 | ErrorLog /var/log/apache2/shaarli-error.log | ||
| 389 | CustomLog /var/log/apache2/shaarli-access.log combined | ||
| 390 | |||
| 391 | php_flag log_errors on | ||
| 392 | php_flag display_errors on | ||
| 393 | php_value error_reporting 2147483647 | ||
| 394 | php_value error_log /var/log/apache2/shaarli-php-error.log | ||
| 395 | </VirtualHost> | ||
| 396 | </code></pre> | ||
| 397 | |||
| 398 | <h3 id="standard-keep-access-and-error-logs">Standard - Keep access and error logs</h3> | ||
| 399 | <pre><code class="apache"><VirtualHost *:80> | ||
| 400 | ServerName shaarli.my-domain.org | ||
| 401 | DocumentRoot /absolute/path/to/shaarli/ | ||
| 402 | |||
| 403 | LogLevel warn | ||
| 404 | ErrorLog /var/log/apache2/shaarli-error.log | ||
| 405 | CustomLog /var/log/apache2/shaarli-access.log combined | ||
| 406 | </VirtualHost> | ||
| 407 | </code></pre> | ||
| 408 | |||
| 409 | <h3 id="paranoid-redirect-http-80-to-https-443">Paranoid - Redirect HTTP (:80) to HTTPS (:443)</h3> | ||
| 410 | <p>See <a href="https://wiki.mozilla.org/Security/Server_Side_TLS#Apache">Server-side TLS</a> (Mozilla).</p> | ||
| 411 | <pre><code class="apache"><VirtualHost *:443> | ||
| 412 | ServerName shaarli.my-domain.org | ||
| 413 | DocumentRoot /absolute/path/to/shaarli/ | ||
| 414 | |||
| 415 | SSLEngine on | ||
| 416 | SSLCertificateFile /absolute/path/to/the/website/certificate.pem | ||
| 417 | SSLCertificateKeyFile /absolute/path/to/the/website/key.key | ||
| 418 | |||
| 419 | <Directory /absolute/path/to/shaarli/> | ||
| 420 | AllowOverride All | ||
| 421 | Options Indexes FollowSymLinks MultiViews | ||
| 422 | Order allow,deny | ||
| 423 | allow from all | ||
| 424 | </Directory> | ||
| 425 | |||
| 426 | LogLevel warn | ||
| 427 | ErrorLog /var/log/apache2/shaarli-error.log | ||
| 428 | CustomLog /var/log/apache2/shaarli-access.log combined | ||
| 429 | </VirtualHost> | ||
| 430 | <VirtualHost *:80> | ||
| 431 | ServerName shaarli.my-domain.org | ||
| 432 | Redirect 301 / https://shaarli.my-domain.org | ||
| 433 | |||
| 434 | LogLevel warn | ||
| 435 | ErrorLog /var/log/apache2/shaarli-error.log | ||
| 436 | CustomLog /var/log/apache2/shaarli-access.log combined | ||
| 437 | </VirtualHost> | ||
| 438 | </code></pre> | ||
| 439 | |||
| 440 | <h3 id="htaccess">.htaccess</h3> | ||
| 441 | <p>Shaarli use <code>.htaccess</code> Apache files to deny access to files that shouldn't be directly accessed (datastore, config, etc.). You need the directive <code>AllowOverride All</code> in your virtual host configuration for them to work.</p> | ||
| 442 | <p><strong>Warning</strong>: If you use Apache 2.2 or lower, you need <a href="https://httpd.apache.org/docs/current/mod/mod_version.html">mod_version</a> to be installed and enabled.</p> | ||
| 443 | <p>Apache module <code>mod_rewrite</code> <strong>must</strong> be enabled to use the REST API. URL rewriting rules for the Slim microframework are stated in the root <code>.htaccess</code> file.</p> | ||
| 444 | <h2 id="lighthttpd">LightHttpd</h2> | ||
| 445 | <h2 id="nginx">Nginx</h2> | ||
| 446 | <h3 id="foreword">Foreword</h3> | ||
| 447 | <p>Nginx does not natively interpret PHP scripts; to this effect, we will run a <a href="https://en.wikipedia.org/wiki/FastCGI">FastCGI</a> service, to which Nginx's FastCGI module will proxy all requests to PHP resources.</p> | ||
| 448 | <p>Required packages: | ||
| 449 | - <a href="http://nginx.org">nginx</a> | ||
| 450 | - <a href="http://php-fpm.org">php-fpm</a> - PHP FastCGI Process Manager</p> | ||
| 451 | <p>Official documentation: | ||
| 452 | - <a href="http://nginx.org/en/docs/beginners_guide.html">Beginner's guide</a> | ||
| 453 | - <a href="http://nginx.org/en/docs/http/ngx_http_fastcgi_module.html">ngx_http_fastcgi_module</a> | ||
| 454 | - <a href="http://wiki.nginx.org/Pitfalls">Pitfalls</a></p> | ||
| 455 | <p>Community resources: | ||
| 456 | - <a href="https://wiki.mozilla.org/Security/Server_Side_TLS#Nginx">Server-side TLS (Nginx)</a> (Mozilla) | ||
| 457 | - <a href="http://kbeezie.com/nginx-configuration-examples/">PHP configuration examples</a> (Karl Blessing)</p> | ||
| 458 | <h3 id="common-setup">Common setup</h3> | ||
| 459 | <p>Once Nginx and PHP-FPM are installed, we need to ensure: | ||
| 460 | - Nginx and PHP-FPM are running using the <em>same user and group</em> | ||
| 461 | - both these user and group have | ||
| 462 | - <code>read</code> permissions for Shaarli resources | ||
| 463 | - <code>execute</code> permissions for Shaarli directories <em>AND</em> their parent directories</p> | ||
| 464 | <p>On a production server: | ||
| 465 | - <code>user:group</code> will likely be <code>http:http</code>, <code>www:www</code> or <code>www-data:www-data</code> | ||
| 466 | - files will be located under <code>/var/www</code>, <code>/var/http</code> or <code>/usr/share/nginx</code></p> | ||
| 467 | <p>On a development server: | ||
| 468 | - files may be located in a user's home directory | ||
| 469 | - in this case, make sure both Nginx and PHP-FPM are running as the local user/group!</p> | ||
| 470 | <p>For all following configuration examples, this user/group pair will be used: | ||
| 471 | - <code>user:group = john:users</code>,</p> | ||
| 472 | <p>which corresponds to the following service configuration:</p> | ||
| 473 | <pre><code class="ini">; /etc/php/php-fpm.conf | ||
| 474 | user = john | ||
| 475 | group = users | ||
| 476 | |||
| 477 | [...] | ||
| 478 | listen.owner = john | ||
| 479 | listen.group = users | ||
| 480 | </code></pre> | ||
| 481 | |||
| 482 | <pre><code class="nginx"># /etc/nginx/nginx.conf | ||
| 483 | user john users; | ||
| 484 | |||
| 485 | http { | ||
| 486 | [...] | ||
| 487 | } | ||
| 488 | </code></pre> | ||
| 489 | |||
| 490 | <h3 id="optional-increase-the-maximum-file-upload-size">(Optional) Increase the maximum file upload size</h3> | ||
| 491 | <p>Some bookmark dumps generated by web browsers can be <em>huge</em> due to the presence of Base64-encoded images and favicons, as well as extra verbosity when nesting links in (sub-)folders.</p> | ||
| 492 | <p>To increase upload size, you will need to modify both nginx and PHP configuration:</p> | ||
| 493 | <pre><code class="nginx"># /etc/nginx/nginx.conf | ||
| 494 | |||
| 495 | http { | ||
| 496 | [...] | ||
| 497 | |||
| 498 | client_max_body_size 10m; | ||
| 499 | |||
| 500 | [...] | ||
| 501 | } | ||
| 502 | </code></pre> | ||
| 503 | |||
| 504 | <pre><code class="ini"># /etc/php5/fpm/php.ini | ||
| 505 | |||
| 506 | [...] | ||
| 507 | post_max_size = 10M | ||
| 508 | [...] | ||
| 509 | upload_max_filesize = 10M | ||
| 510 | </code></pre> | ||
| 511 | |||
| 512 | <h3 id="minimal_1">Minimal</h3> | ||
| 513 | <p><em>WARNING: Use for development only!</em> </p> | ||
| 514 | <pre><code class="nginx">user john users; | ||
| 515 | worker_processes 1; | ||
| 516 | events { | ||
| 517 | worker_connections 1024; | ||
| 518 | } | ||
| 519 | |||
| 520 | http { | ||
| 521 | include mime.types; | ||
| 522 | default_type application/octet-stream; | ||
| 523 | keepalive_timeout 20; | ||
| 524 | |||
| 525 | index index.html index.php; | ||
| 526 | |||
| 527 | server { | ||
| 528 | listen 80; | ||
| 529 | server_name localhost; | ||
| 530 | root /home/john/web; | ||
| 531 | |||
| 532 | access_log /var/log/nginx/access.log; | ||
| 533 | error_log /var/log/nginx/error.log; | ||
| 534 | |||
| 535 | location /shaarli/ { | ||
| 536 | try_files $uri /shaarli/index.php$is_args$args; | ||
| 537 | access_log /var/log/nginx/shaarli.access.log; | ||
| 538 | error_log /var/log/nginx/shaarli.error.log; | ||
| 539 | } | ||
| 540 | |||
| 541 | location ~ (index)\.php$ { | ||
| 542 | try_files $uri =404; | ||
| 543 | fastcgi_split_path_info ^(.+\.php)(/.+)$; | ||
| 544 | fastcgi_pass unix:/var/run/php-fpm/php-fpm.sock; | ||
| 545 | fastcgi_index index.php; | ||
| 546 | include fastcgi.conf; | ||
| 547 | } | ||
| 548 | } | ||
| 549 | } | ||
| 550 | </code></pre> | ||
| 551 | |||
| 552 | <h3 id="modular">Modular</h3> | ||
| 553 | <p>The previous setup is sufficient for development purposes, but has several major caveats: | ||
| 554 | - every content that does not match the PHP rule will be sent to client browsers: | ||
| 555 | - dotfiles - in our case, <code>.htaccess</code> | ||
| 556 | - temporary files, e.g. Vim or Emacs files: <code>index.php~</code> | ||
| 557 | - asset / static resource caching is not optimized | ||
| 558 | - if serving several PHP sites, there will be a lot of duplication: <code>location /shaarli/</code>, <code>location /mysite/</code>, etc.</p> | ||
| 559 | <p>To solve this, we will split Nginx configuration in several parts, that will be included when needed:</p> | ||
| 560 | <pre><code class="nginx"># /etc/nginx/deny.conf | ||
| 561 | location ~ /\. { | ||
| 562 | # deny access to dotfiles | ||
| 563 | access_log off; | ||
| 564 | log_not_found off; | ||
| 565 | deny all; | ||
| 566 | } | ||
| 567 | |||
| 568 | location ~ ~$ { | ||
| 569 | # deny access to temp editor files, e.g. "script.php~" | ||
| 570 | access_log off; | ||
| 571 | log_not_found off; | ||
| 572 | deny all; | ||
| 573 | } | ||
| 574 | </code></pre> | ||
| 575 | |||
| 576 | <pre><code class="nginx"># /etc/nginx/php.conf | ||
| 577 | location ~ (index)\.php$ { | ||
| 578 | # Slim - split URL path into (script_filename, path_info) | ||
| 579 | try_files $uri =404; | ||
| 580 | fastcgi_split_path_info ^(.+\.php)(/.+)$; | ||
| 581 | |||
| 582 | # filter and proxy PHP requests to PHP-FPM | ||
| 583 | fastcgi_pass unix:/var/run/php-fpm/php-fpm.sock; | ||
| 584 | fastcgi_index index.php; | ||
| 585 | include fastcgi.conf; | ||
| 586 | } | ||
| 587 | |||
| 588 | location ~ \.php$ { | ||
| 589 | # deny access to all other PHP scripts | ||
| 590 | deny all; | ||
| 591 | } | ||
| 592 | </code></pre> | ||
| 593 | |||
| 594 | <pre><code class="nginx"># /etc/nginx/static_assets.conf | ||
| 595 | location ~* \.(?:ico|css|js|gif|jpe?g|png)$ { | ||
| 596 | expires max; | ||
| 597 | add_header Pragma public; | ||
| 598 | add_header Cache-Control "public, must-revalidate, proxy-revalidate"; | ||
| 599 | } | ||
| 600 | </code></pre> | ||
| 601 | |||
| 602 | <pre><code class="nginx"># /etc/nginx/nginx.conf | ||
| 603 | [...] | ||
| 604 | |||
| 605 | http { | ||
| 606 | [...] | ||
| 607 | |||
| 608 | root /home/john/web; | ||
| 609 | access_log /var/log/nginx/access.log; | ||
| 610 | error_log /var/log/nginx/error.log; | ||
| 611 | |||
| 612 | server { | ||
| 613 | # virtual host for a first domain | ||
| 614 | listen 80; | ||
| 615 | server_name my.first.domain.org; | ||
| 616 | |||
| 617 | location /shaarli/ { | ||
| 618 | # Slim - rewrite URLs | ||
| 619 | try_files $uri /shaarli/index.php$is_args$args; | ||
| 620 | |||
| 621 | access_log /var/log/nginx/shaarli.access.log; | ||
| 622 | error_log /var/log/nginx/shaarli.error.log; | ||
| 623 | } | ||
| 624 | |||
| 625 | location = /shaarli/favicon.ico { | ||
| 626 | # serve the Shaarli favicon from its custom location | ||
| 627 | alias /var/www/shaarli/images/favicon.ico; | ||
| 628 | } | ||
| 629 | |||
| 630 | include deny.conf; | ||
| 631 | include static_assets.conf; | ||
| 632 | include php.conf; | ||
| 633 | } | ||
| 634 | |||
| 635 | server { | ||
| 636 | # virtual host for a second domain | ||
| 637 | listen 80; | ||
| 638 | server_name second.domain.com; | ||
| 639 | |||
| 640 | location /minigal/ { | ||
| 641 | access_log /var/log/nginx/minigal.access.log; | ||
| 642 | error_log /var/log/nginx/minigal.error.log; | ||
| 643 | } | ||
| 644 | |||
| 645 | include deny.conf; | ||
| 646 | include static_assets.conf; | ||
| 647 | include php.conf; | ||
| 648 | } | ||
| 649 | } | ||
| 650 | </code></pre> | ||
| 651 | |||
| 652 | <h3 id="redirect-http-to-https">Redirect HTTP to HTTPS</h3> | ||
| 653 | <p>Assuming you have generated a (self-signed) key and certificate, and they are located under <code>/home/john/ssl/localhost.{key,crt}</code>, it is pretty straightforward to set an HTTP (:80) to HTTPS (:443) redirection to force SSL/TLS usage.</p> | ||
| 654 | <pre><code class="nginx"># /etc/nginx/nginx.conf | ||
| 655 | [...] | ||
| 656 | |||
| 657 | http { | ||
| 658 | [...] | ||
| 659 | |||
| 660 | index index.html index.php; | ||
| 661 | |||
| 662 | root /home/john/web; | ||
| 663 | access_log /var/log/nginx/access.log; | ||
| 664 | error_log /var/log/nginx/error.log; | ||
| 665 | |||
| 666 | server { | ||
| 667 | listen 80; | ||
| 668 | server_name localhost; | ||
| 669 | |||
| 670 | return 301 https://localhost$request_uri; | ||
| 671 | } | ||
| 672 | |||
| 673 | server { | ||
| 674 | listen 443 ssl; | ||
| 675 | server_name localhost; | ||
| 676 | |||
| 677 | ssl_certificate /home/john/ssl/localhost.crt; | ||
| 678 | ssl_certificate_key /home/john/ssl/localhost.key; | ||
| 679 | |||
| 680 | location /shaarli/ { | ||
| 681 | # Slim - rewrite URLs | ||
| 682 | try_files $uri /index.php$is_args$args; | ||
| 683 | |||
| 684 | access_log /var/log/nginx/shaarli.access.log; | ||
| 685 | error_log /var/log/nginx/shaarli.error.log; | ||
| 686 | } | ||
| 687 | |||
| 688 | location = /shaarli/favicon.ico { | ||
| 689 | # serve the Shaarli favicon from its custom location | ||
| 690 | alias /var/www/shaarli/images/favicon.ico; | ||
| 691 | } | ||
| 692 | |||
| 693 | include deny.conf; | ||
| 694 | include static_assets.conf; | ||
| 695 | include php.conf; | ||
| 696 | } | ||
| 697 | } | ||
| 698 | </code></pre> | ||
| 699 | |||
| 700 | </div> | ||
| 701 | </div> | ||
| 702 | <footer> | ||
| 703 | |||
| 704 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 705 | |||
| 706 | <a href="../Server-security/" class="btn btn-neutral float-right" title="Server security">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 707 | |||
| 708 | |||
| 709 | <a href="../Server-requirements/" class="btn btn-neutral" title="Server requirements"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 710 | |||
| 711 | </div> | ||
| 712 | |||
| 713 | |||
| 714 | <hr/> | ||
| 715 | |||
| 716 | <div role="contentinfo"> | ||
| 717 | <!-- Copyright etc --> | ||
| 718 | |||
| 719 | </div> | ||
| 720 | |||
| 721 | 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>. | ||
| 722 | </footer> | ||
| 723 | |||
| 724 | </div> | ||
| 725 | </div> | ||
| 726 | |||
| 727 | </section> | ||
| 728 | |||
| 729 | </div> | ||
| 730 | |||
| 731 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 732 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 733 | |||
| 734 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 735 | |||
| 736 | |||
| 737 | <span><a href="../Server-requirements/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 738 | |||
| 739 | |||
| 740 | <span style="margin-left: 15px"><a href="../Server-security/" style="color: #fcfcfc">Next »</a></span> | ||
| 741 | |||
| 742 | </span> | ||
| 743 | </div> | ||
| 744 | <script src="../js/theme.js"></script> | ||
| 745 | |||
| 746 | </body> | ||
| 747 | </html> | ||
diff --git a/doc/html/Server-requirements/index.html b/doc/html/Server-requirements/index.html new file mode 100644 index 00000000..ab1b0d35 --- /dev/null +++ b/doc/html/Server-requirements/index.html | |||
| @@ -0,0 +1,475 @@ | |||
| 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>Server requirements - 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 = "Server requirements"; | ||
| 22 | var mkdocs_page_input_path = "Server-requirements.md"; | ||
| 23 | var mkdocs_page_url = "/Server-requirements/"; | ||
| 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=" current"> | ||
| 69 | |||
| 70 | <a class="current" href="./">Server requirements</a> | ||
| 71 | <ul class="subnav"> | ||
| 72 | |||
| 73 | <li class="toctree-l3"><a href="#php">PHP</a></li> | ||
| 74 | |||
| 75 | <ul> | ||
| 76 | |||
| 77 | <li><a class="toctree-l4" href="#release-information">Release information</a></li> | ||
| 78 | |||
| 79 | <li><a class="toctree-l4" href="#supported-versions">Supported versions</a></li> | ||
| 80 | |||
| 81 | <li><a class="toctree-l4" href="#dependency-management">Dependency management</a></li> | ||
| 82 | |||
| 83 | <li><a class="toctree-l4" href="#extensions">Extensions</a></li> | ||
| 84 | |||
| 85 | </ul> | ||
| 86 | |||
| 87 | |||
| 88 | </ul> | ||
| 89 | </li> | ||
| 90 | <li class=""> | ||
| 91 | |||
| 92 | <a class="" href="../Server-configuration/">Server configuration</a> | ||
| 93 | </li> | ||
| 94 | <li class=""> | ||
| 95 | |||
| 96 | <a class="" href="../Server-security/">Server security</a> | ||
| 97 | </li> | ||
| 98 | <li class=""> | ||
| 99 | |||
| 100 | <a class="" href="../Shaarli-configuration/">Shaarli configuration</a> | ||
| 101 | </li> | ||
| 102 | <li class=""> | ||
| 103 | |||
| 104 | <a class="" href="../Plugins/">Plugins</a> | ||
| 105 | </li> | ||
| 106 | </ul> | ||
| 107 | </li> | ||
| 108 | |||
| 109 | <li class="toctree-l1"> | ||
| 110 | |||
| 111 | <span class="caption-text">Docker</span> | ||
| 112 | <ul class="subnav"> | ||
| 113 | <li class=""> | ||
| 114 | |||
| 115 | <a class="" href="../Docker-101/">Docker 101</a> | ||
| 116 | </li> | ||
| 117 | <li class=""> | ||
| 118 | |||
| 119 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 120 | </li> | ||
| 121 | <li class=""> | ||
| 122 | |||
| 123 | <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a> | ||
| 124 | </li> | ||
| 125 | <li class=""> | ||
| 126 | |||
| 127 | <a class="" href="../Docker-resources/">Docker resources</a> | ||
| 128 | </li> | ||
| 129 | </ul> | ||
| 130 | </li> | ||
| 131 | |||
| 132 | <li class="toctree-l1"> | ||
| 133 | |||
| 134 | <span class="caption-text">Usage</span> | ||
| 135 | <ul class="subnav"> | ||
| 136 | <li class=""> | ||
| 137 | |||
| 138 | <a class="" href="../Features/">Features</a> | ||
| 139 | </li> | ||
| 140 | <li class=""> | ||
| 141 | |||
| 142 | <a class="" href="../Bookmarklet/">Bookmarklet</a> | ||
| 143 | </li> | ||
| 144 | <li class=""> | ||
| 145 | |||
| 146 | <a class="" href="../Browsing-and-searching/">Browsing and searching</a> | ||
| 147 | </li> | ||
| 148 | <li class=""> | ||
| 149 | |||
| 150 | <a class="" href="../Firefox-share/">Firefox share</a> | ||
| 151 | </li> | ||
| 152 | <li class=""> | ||
| 153 | |||
| 154 | <a class="" href="../RSS-feeds/">RSS feeds</a> | ||
| 155 | </li> | ||
| 156 | <li class=""> | ||
| 157 | |||
| 158 | <a class="" href="../REST-API/">REST API</a> | ||
| 159 | </li> | ||
| 160 | </ul> | ||
| 161 | </li> | ||
| 162 | |||
| 163 | <li class="toctree-l1"> | ||
| 164 | |||
| 165 | <span class="caption-text">How To</span> | ||
| 166 | <ul class="subnav"> | ||
| 167 | <li class=""> | ||
| 168 | |||
| 169 | <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a> | ||
| 170 | </li> | ||
| 171 | <li class=""> | ||
| 172 | |||
| 173 | <a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 174 | </li> | ||
| 175 | <li class=""> | ||
| 176 | |||
| 177 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 178 | </li> | ||
| 179 | <li class=""> | ||
| 180 | |||
| 181 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 182 | </li> | ||
| 183 | <li class=""> | ||
| 184 | |||
| 185 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 186 | </li> | ||
| 187 | </ul> | ||
| 188 | </li> | ||
| 189 | |||
| 190 | <li class="toctree-l1"> | ||
| 191 | |||
| 192 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 193 | </li> | ||
| 194 | |||
| 195 | <li class="toctree-l1"> | ||
| 196 | |||
| 197 | <span class="caption-text">Development</span> | ||
| 198 | <ul class="subnav"> | ||
| 199 | <li class=""> | ||
| 200 | |||
| 201 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 202 | </li> | ||
| 203 | <li class=""> | ||
| 204 | |||
| 205 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 206 | </li> | ||
| 207 | <li class=""> | ||
| 208 | |||
| 209 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 210 | </li> | ||
| 211 | <li class=""> | ||
| 212 | |||
| 213 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 214 | </li> | ||
| 215 | <li class=""> | ||
| 216 | |||
| 217 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 218 | </li> | ||
| 219 | <li class=""> | ||
| 220 | |||
| 221 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 222 | </li> | ||
| 223 | <li class=""> | ||
| 224 | |||
| 225 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 226 | </li> | ||
| 227 | <li class=""> | ||
| 228 | |||
| 229 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 230 | </li> | ||
| 231 | <li class=""> | ||
| 232 | |||
| 233 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 234 | </li> | ||
| 235 | <li class=""> | ||
| 236 | |||
| 237 | <a class="" href="../Security/">Security</a> | ||
| 238 | </li> | ||
| 239 | <li class=""> | ||
| 240 | |||
| 241 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 242 | </li> | ||
| 243 | <li class=""> | ||
| 244 | |||
| 245 | <a class="" href="../Theming/">Theming</a> | ||
| 246 | </li> | ||
| 247 | <li class=""> | ||
| 248 | |||
| 249 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 250 | </li> | ||
| 251 | </ul> | ||
| 252 | </li> | ||
| 253 | |||
| 254 | <li class="toctree-l1"> | ||
| 255 | |||
| 256 | <span class="caption-text">About</span> | ||
| 257 | <ul class="subnav"> | ||
| 258 | <li class=""> | ||
| 259 | |||
| 260 | <a class="" href="../FAQ/">FAQ</a> | ||
| 261 | </li> | ||
| 262 | <li class=""> | ||
| 263 | |||
| 264 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 265 | </li> | ||
| 266 | </ul> | ||
| 267 | </li> | ||
| 268 | |||
| 269 | </ul> | ||
| 270 | </div> | ||
| 271 | | ||
| 272 | </nav> | ||
| 273 | |||
| 274 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 275 | |||
| 276 | |||
| 277 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 278 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 279 | <a href="..">Shaarli Documentation</a> | ||
| 280 | </nav> | ||
| 281 | |||
| 282 | |||
| 283 | <div class="wy-nav-content"> | ||
| 284 | <div class="rst-content"> | ||
| 285 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 286 | <ul class="wy-breadcrumbs"> | ||
| 287 | <li><a href="..">Docs</a> »</li> | ||
| 288 | |||
| 289 | |||
| 290 | |||
| 291 | <li>Setup »</li> | ||
| 292 | |||
| 293 | |||
| 294 | |||
| 295 | <li>Server requirements</li> | ||
| 296 | <li class="wy-breadcrumbs-aside"> | ||
| 297 | |||
| 298 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Server-requirements.md" | ||
| 299 | class="icon icon-github"> Edit on GitHub</a> | ||
| 300 | |||
| 301 | </li> | ||
| 302 | </ul> | ||
| 303 | <hr/> | ||
| 304 | </div> | ||
| 305 | <div role="main"> | ||
| 306 | <div class="section"> | ||
| 307 | |||
| 308 | <h2 id="php">PHP</h2> | ||
| 309 | <h3 id="release-information">Release information</h3> | ||
| 310 | <ul> | ||
| 311 | <li><a href="http://php.net/supported-versions.php">PHP: Supported versions</a></li> | ||
| 312 | <li><a href="http://php.net/eol.php">PHP: Unsupported versions</a> <em>(EOL - End Of Life)</em></li> | ||
| 313 | <li><a href="http://php.net/ChangeLog-7.php">PHP 7 Changelog</a></li> | ||
| 314 | <li><a href="http://php.net/ChangeLog-5.php">PHP 5 Changelog</a></li> | ||
| 315 | <li><a href="https://bugs.php.net/">PHP: Bugs</a></li> | ||
| 316 | </ul> | ||
| 317 | <h3 id="supported-versions">Supported versions</h3> | ||
| 318 | <table> | ||
| 319 | <thead> | ||
| 320 | <tr> | ||
| 321 | <th align="center">Version</th> | ||
| 322 | <th align="center">Status</th> | ||
| 323 | <th align="center">Shaarli compatibility</th> | ||
| 324 | </tr> | ||
| 325 | </thead> | ||
| 326 | <tbody> | ||
| 327 | <tr> | ||
| 328 | <td align="center">7.1</td> | ||
| 329 | <td align="center">Supported (v0.9.x)</td> | ||
| 330 | <td align="center">:white_check_mark:</td> | ||
| 331 | </tr> | ||
| 332 | <tr> | ||
| 333 | <td align="center">7.0</td> | ||
| 334 | <td align="center">Supported</td> | ||
| 335 | <td align="center">:white_check_mark:</td> | ||
| 336 | </tr> | ||
| 337 | <tr> | ||
| 338 | <td align="center">5.6</td> | ||
| 339 | <td align="center">Supported</td> | ||
| 340 | <td align="center">:white_check_mark:</td> | ||
| 341 | </tr> | ||
| 342 | <tr> | ||
| 343 | <td align="center">5.5</td> | ||
| 344 | <td align="center">EOL: 2016-07-10</td> | ||
| 345 | <td align="center">:white_check_mark:</td> | ||
| 346 | </tr> | ||
| 347 | <tr> | ||
| 348 | <td align="center">5.4</td> | ||
| 349 | <td align="center">EOL: 2015-09-14</td> | ||
| 350 | <td align="center">:white_check_mark: (up to Shaarli 0.8.x)</td> | ||
| 351 | </tr> | ||
| 352 | <tr> | ||
| 353 | <td align="center">5.3</td> | ||
| 354 | <td align="center">EOL: 2014-08-14</td> | ||
| 355 | <td align="center">:white_check_mark: (up to Shaarli 0.8.x)</td> | ||
| 356 | </tr> | ||
| 357 | </tbody> | ||
| 358 | </table> | ||
| 359 | <p>See also: | ||
| 360 | - <a href="https://github.com/shaarli/Shaarli/blob/master/.travis.yml">Travis configuration</a></p> | ||
| 361 | <h3 id="dependency-management">Dependency management</h3> | ||
| 362 | <p>Starting with Shaarli <code>v0.8.x</code>, <a href="https://getcomposer.org/">Composer</a> is used to resolve, | ||
| 363 | download and install third-party PHP dependencies.</p> | ||
| 364 | <table> | ||
| 365 | <thead> | ||
| 366 | <tr> | ||
| 367 | <th>Library</th> | ||
| 368 | <th align="center">Required?</th> | ||
| 369 | <th>Usage</th> | ||
| 370 | </tr> | ||
| 371 | </thead> | ||
| 372 | <tbody> | ||
| 373 | <tr> | ||
| 374 | <td><a href="https://packagist.org/packages/shaarli/netscape-bookmark-parser"><code>shaarli/netscape-bookmark-parser</code></a></td> | ||
| 375 | <td align="center">All</td> | ||
| 376 | <td>Import bookmarks from Netscape files</td> | ||
| 377 | </tr> | ||
| 378 | <tr> | ||
| 379 | <td><a href="https://packagist.org/packages/erusev/parsedown"><code>erusev/parsedown</code></a></td> | ||
| 380 | <td align="center">All</td> | ||
| 381 | <td>Parse MarkDown syntax for the MarkDown plugin</td> | ||
| 382 | </tr> | ||
| 383 | <tr> | ||
| 384 | <td><a href="https://packagist.org/packages/slim/slim"><code>slim/slim</code></a></td> | ||
| 385 | <td align="center">All</td> | ||
| 386 | <td>Handle routes and middleware for the REST API</td> | ||
| 387 | </tr> | ||
| 388 | </tbody> | ||
| 389 | </table> | ||
| 390 | <h3 id="extensions">Extensions</h3> | ||
| 391 | <table> | ||
| 392 | <thead> | ||
| 393 | <tr> | ||
| 394 | <th>Extension</th> | ||
| 395 | <th align="center">Required?</th> | ||
| 396 | <th>Usage</th> | ||
| 397 | </tr> | ||
| 398 | </thead> | ||
| 399 | <tbody> | ||
| 400 | <tr> | ||
| 401 | <td><a href="http://php.net/manual/en/book.openssl.php"><code>openssl</code></a></td> | ||
| 402 | <td align="center">All</td> | ||
| 403 | <td>OpenSSL, HTTPS</td> | ||
| 404 | </tr> | ||
| 405 | <tr> | ||
| 406 | <td><a href="http://php.net/manual/en/book.mbstring.php"><code>php-mbstring</code></a></td> | ||
| 407 | <td align="center">CentOS, Fedora, RHEL, Windows</td> | ||
| 408 | <td>multibyte (Unicode) string support</td> | ||
| 409 | </tr> | ||
| 410 | <tr> | ||
| 411 | <td><a href="http://php.net/manual/en/book.image.php"><code>php-gd</code></a></td> | ||
| 412 | <td align="center">optional</td> | ||
| 413 | <td>thumbnail resizing</td> | ||
| 414 | </tr> | ||
| 415 | <tr> | ||
| 416 | <td><a href="http://php.net/manual/en/book.intl.php"><code>php-intl</code></a></td> | ||
| 417 | <td align="center">optional</td> | ||
| 418 | <td>localized text sorting (e.g. <code>e->è->f</code>)</td> | ||
| 419 | </tr> | ||
| 420 | <tr> | ||
| 421 | <td><a href="http://php.net/manual/en/book.curl.php"><code>php-curl</code></a></td> | ||
| 422 | <td align="center">optional</td> | ||
| 423 | <td>using cURL for fetching webpages and thumbnails in a more robust way</td> | ||
| 424 | </tr> | ||
| 425 | </tbody> | ||
| 426 | </table> | ||
| 427 | |||
| 428 | </div> | ||
| 429 | </div> | ||
| 430 | <footer> | ||
| 431 | |||
| 432 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 433 | |||
| 434 | <a href="../Server-configuration/" class="btn btn-neutral float-right" title="Server configuration">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 435 | |||
| 436 | |||
| 437 | <a href="../Upgrade-and-migration/" class="btn btn-neutral" title="Upgrade and migration"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 438 | |||
| 439 | </div> | ||
| 440 | |||
| 441 | |||
| 442 | <hr/> | ||
| 443 | |||
| 444 | <div role="contentinfo"> | ||
| 445 | <!-- Copyright etc --> | ||
| 446 | |||
| 447 | </div> | ||
| 448 | |||
| 449 | 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>. | ||
| 450 | </footer> | ||
| 451 | |||
| 452 | </div> | ||
| 453 | </div> | ||
| 454 | |||
| 455 | </section> | ||
| 456 | |||
| 457 | </div> | ||
| 458 | |||
| 459 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 460 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 461 | |||
| 462 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 463 | |||
| 464 | |||
| 465 | <span><a href="../Upgrade-and-migration/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 466 | |||
| 467 | |||
| 468 | <span style="margin-left: 15px"><a href="../Server-configuration/" style="color: #fcfcfc">Next »</a></span> | ||
| 469 | |||
| 470 | </span> | ||
| 471 | </div> | ||
| 472 | <script src="../js/theme.js"></script> | ||
| 473 | |||
| 474 | </body> | ||
| 475 | </html> | ||
diff --git a/doc/html/Server-security/index.html b/doc/html/Server-security/index.html new file mode 100644 index 00000000..dbe99515 --- /dev/null +++ b/doc/html/Server-security/index.html | |||
| @@ -0,0 +1,429 @@ | |||
| 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>Server security - 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 = "Server security"; | ||
| 22 | var mkdocs_page_input_path = "Server-security.md"; | ||
| 23 | var mkdocs_page_url = "/Server-security/"; | ||
| 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=" current"> | ||
| 77 | |||
| 78 | <a class="current" href="./">Server security</a> | ||
| 79 | <ul class="subnav"> | ||
| 80 | |||
| 81 | <li class="toctree-l3"><a href="#phpini">php.ini</a></li> | ||
| 82 | |||
| 83 | <ul> | ||
| 84 | |||
| 85 | <li><a class="toctree-l4" href="#locate-ini-files">Locate .ini files</a></li> | ||
| 86 | |||
| 87 | </ul> | ||
| 88 | |||
| 89 | |||
| 90 | <li class="toctree-l3"><a href="#fail2ban">fail2ban</a></li> | ||
| 91 | |||
| 92 | <ul> | ||
| 93 | |||
| 94 | <li><a class="toctree-l4" href="#read-shaarli-logs-to-ban-ips">Read Shaarli logs to ban IPs</a></li> | ||
| 95 | |||
| 96 | </ul> | ||
| 97 | |||
| 98 | |||
| 99 | <li class="toctree-l3"><a href="#robots-restricting-search-engines-and-web-crawler-traffic">Robots - Restricting search engines and web crawler traffic</a></li> | ||
| 100 | |||
| 101 | |||
| 102 | </ul> | ||
| 103 | </li> | ||
| 104 | <li class=""> | ||
| 105 | |||
| 106 | <a class="" href="../Shaarli-configuration/">Shaarli configuration</a> | ||
| 107 | </li> | ||
| 108 | <li class=""> | ||
| 109 | |||
| 110 | <a class="" href="../Plugins/">Plugins</a> | ||
| 111 | </li> | ||
| 112 | </ul> | ||
| 113 | </li> | ||
| 114 | |||
| 115 | <li class="toctree-l1"> | ||
| 116 | |||
| 117 | <span class="caption-text">Docker</span> | ||
| 118 | <ul class="subnav"> | ||
| 119 | <li class=""> | ||
| 120 | |||
| 121 | <a class="" href="../Docker-101/">Docker 101</a> | ||
| 122 | </li> | ||
| 123 | <li class=""> | ||
| 124 | |||
| 125 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 126 | </li> | ||
| 127 | <li class=""> | ||
| 128 | |||
| 129 | <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a> | ||
| 130 | </li> | ||
| 131 | <li class=""> | ||
| 132 | |||
| 133 | <a class="" href="../Docker-resources/">Docker resources</a> | ||
| 134 | </li> | ||
| 135 | </ul> | ||
| 136 | </li> | ||
| 137 | |||
| 138 | <li class="toctree-l1"> | ||
| 139 | |||
| 140 | <span class="caption-text">Usage</span> | ||
| 141 | <ul class="subnav"> | ||
| 142 | <li class=""> | ||
| 143 | |||
| 144 | <a class="" href="../Features/">Features</a> | ||
| 145 | </li> | ||
| 146 | <li class=""> | ||
| 147 | |||
| 148 | <a class="" href="../Bookmarklet/">Bookmarklet</a> | ||
| 149 | </li> | ||
| 150 | <li class=""> | ||
| 151 | |||
| 152 | <a class="" href="../Browsing-and-searching/">Browsing and searching</a> | ||
| 153 | </li> | ||
| 154 | <li class=""> | ||
| 155 | |||
| 156 | <a class="" href="../Firefox-share/">Firefox share</a> | ||
| 157 | </li> | ||
| 158 | <li class=""> | ||
| 159 | |||
| 160 | <a class="" href="../RSS-feeds/">RSS feeds</a> | ||
| 161 | </li> | ||
| 162 | <li class=""> | ||
| 163 | |||
| 164 | <a class="" href="../REST-API/">REST API</a> | ||
| 165 | </li> | ||
| 166 | </ul> | ||
| 167 | </li> | ||
| 168 | |||
| 169 | <li class="toctree-l1"> | ||
| 170 | |||
| 171 | <span class="caption-text">How To</span> | ||
| 172 | <ul class="subnav"> | ||
| 173 | <li class=""> | ||
| 174 | |||
| 175 | <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a> | ||
| 176 | </li> | ||
| 177 | <li class=""> | ||
| 178 | |||
| 179 | <a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 180 | </li> | ||
| 181 | <li class=""> | ||
| 182 | |||
| 183 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 184 | </li> | ||
| 185 | <li class=""> | ||
| 186 | |||
| 187 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 188 | </li> | ||
| 189 | <li class=""> | ||
| 190 | |||
| 191 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 192 | </li> | ||
| 193 | </ul> | ||
| 194 | </li> | ||
| 195 | |||
| 196 | <li class="toctree-l1"> | ||
| 197 | |||
| 198 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 199 | </li> | ||
| 200 | |||
| 201 | <li class="toctree-l1"> | ||
| 202 | |||
| 203 | <span class="caption-text">Development</span> | ||
| 204 | <ul class="subnav"> | ||
| 205 | <li class=""> | ||
| 206 | |||
| 207 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 208 | </li> | ||
| 209 | <li class=""> | ||
| 210 | |||
| 211 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 212 | </li> | ||
| 213 | <li class=""> | ||
| 214 | |||
| 215 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 216 | </li> | ||
| 217 | <li class=""> | ||
| 218 | |||
| 219 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 220 | </li> | ||
| 221 | <li class=""> | ||
| 222 | |||
| 223 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 224 | </li> | ||
| 225 | <li class=""> | ||
| 226 | |||
| 227 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 228 | </li> | ||
| 229 | <li class=""> | ||
| 230 | |||
| 231 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 232 | </li> | ||
| 233 | <li class=""> | ||
| 234 | |||
| 235 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 236 | </li> | ||
| 237 | <li class=""> | ||
| 238 | |||
| 239 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 240 | </li> | ||
| 241 | <li class=""> | ||
| 242 | |||
| 243 | <a class="" href="../Security/">Security</a> | ||
| 244 | </li> | ||
| 245 | <li class=""> | ||
| 246 | |||
| 247 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 248 | </li> | ||
| 249 | <li class=""> | ||
| 250 | |||
| 251 | <a class="" href="../Theming/">Theming</a> | ||
| 252 | </li> | ||
| 253 | <li class=""> | ||
| 254 | |||
| 255 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 256 | </li> | ||
| 257 | </ul> | ||
| 258 | </li> | ||
| 259 | |||
| 260 | <li class="toctree-l1"> | ||
| 261 | |||
| 262 | <span class="caption-text">About</span> | ||
| 263 | <ul class="subnav"> | ||
| 264 | <li class=""> | ||
| 265 | |||
| 266 | <a class="" href="../FAQ/">FAQ</a> | ||
| 267 | </li> | ||
| 268 | <li class=""> | ||
| 269 | |||
| 270 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 271 | </li> | ||
| 272 | </ul> | ||
| 273 | </li> | ||
| 274 | |||
| 275 | </ul> | ||
| 276 | </div> | ||
| 277 | | ||
| 278 | </nav> | ||
| 279 | |||
| 280 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 281 | |||
| 282 | |||
| 283 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 284 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 285 | <a href="..">Shaarli Documentation</a> | ||
| 286 | </nav> | ||
| 287 | |||
| 288 | |||
| 289 | <div class="wy-nav-content"> | ||
| 290 | <div class="rst-content"> | ||
| 291 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 292 | <ul class="wy-breadcrumbs"> | ||
| 293 | <li><a href="..">Docs</a> »</li> | ||
| 294 | |||
| 295 | |||
| 296 | |||
| 297 | <li>Setup »</li> | ||
| 298 | |||
| 299 | |||
| 300 | |||
| 301 | <li>Server security</li> | ||
| 302 | <li class="wy-breadcrumbs-aside"> | ||
| 303 | |||
| 304 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Server-security.md" | ||
| 305 | class="icon icon-github"> Edit on GitHub</a> | ||
| 306 | |||
| 307 | </li> | ||
| 308 | </ul> | ||
| 309 | <hr/> | ||
| 310 | </div> | ||
| 311 | <div role="main"> | ||
| 312 | <div class="section"> | ||
| 313 | |||
| 314 | <h2 id="phpini">php.ini</h2> | ||
| 315 | <p>PHP settings are defined in: | ||
| 316 | - a main configuration file, usually found under <code>/etc/php5/php.ini</code>; some distributions provide different configuration environments, e.g. | ||
| 317 | - <code>/etc/php5/php.ini</code> - used when running console scripts | ||
| 318 | - <code>/etc/php5/apache2/php.ini</code> - used when a client requests PHP resources from Apache | ||
| 319 | - <code>/etc/php5/php-fpm.conf</code> - used when PHP requests are proxied to PHP-FPM | ||
| 320 | - additional configuration files/entries, depending on the installed/enabled extensions: | ||
| 321 | - <code>/etc/php/conf.d/xdebug.ini</code></p> | ||
| 322 | <h3 id="locate-ini-files">Locate .ini files</h3> | ||
| 323 | <h4 id="console-environment">Console environment</h4> | ||
| 324 | <pre><code class="bash">$ php --ini | ||
| 325 | Configuration File (php.ini) Path: /etc/php | ||
| 326 | Loaded Configuration File: /etc/php/php.ini | ||
| 327 | Scan for additional .ini files in: /etc/php/conf.d | ||
| 328 | Additional .ini files parsed: /etc/php/conf.d/xdebug.ini | ||
| 329 | </code></pre> | ||
| 330 | |||
| 331 | <h4 id="server-environment">Server environment</h4> | ||
| 332 | <ul> | ||
| 333 | <li>create a <code>phpinfo.php</code> script located in a path supported by the web server, e.g.<ul> | ||
| 334 | <li>Apache (with user dirs enabled): <code>/home/myself/public_html/phpinfo.php</code></li> | ||
| 335 | <li><code>/var/www/test/phpinfo.php</code></li> | ||
| 336 | </ul> | ||
| 337 | </li> | ||
| 338 | <li>make sure the script is readable by the web server user/group (usually, <code>www</code>, <code>www-data</code> or <code>httpd</code>)</li> | ||
| 339 | <li>access the script from a web browser</li> | ||
| 340 | <li>look at the <em>Loaded Configuration File</em> and <em>Scan this dir for additional .ini files</em> entries</li> | ||
| 341 | </ul> | ||
| 342 | <pre><code class="php"><?php phpinfo(); ?> | ||
| 343 | </code></pre> | ||
| 344 | |||
| 345 | <h2 id="fail2ban">fail2ban</h2> | ||
| 346 | <p><code>fail2ban</code> is an intrusion prevention framework that reads server (Apache, SSH, etc.) and uses <code>iptables</code> profiles to block brute-force attempts: | ||
| 347 | - <a href="http://www.fail2ban.org/wiki/index.php/Main_Page">Official website</a> | ||
| 348 | - <a href="https://github.com/fail2ban/fail2ban">Source code</a></p> | ||
| 349 | <h3 id="read-shaarli-logs-to-ban-ips">Read Shaarli logs to ban IPs</h3> | ||
| 350 | <p>Example configuration: | ||
| 351 | - allow 3 login attempts per IP address | ||
| 352 | - after 3 failures, permanently ban the corresponding IP adddress</p> | ||
| 353 | <p><code>/etc/fail2ban/jail.local</code></p> | ||
| 354 | <pre><code class="ini">[shaarli-auth] | ||
| 355 | enabled = true | ||
| 356 | port = https,http | ||
| 357 | filter = shaarli-auth | ||
| 358 | logpath = /var/www/path/to/shaarli/data/log.txt | ||
| 359 | maxretry = 3 | ||
| 360 | bantime = -1 | ||
| 361 | </code></pre> | ||
| 362 | |||
| 363 | <p><code>/etc/fail2ban/filter.d/shaarli-auth.conf</code></p> | ||
| 364 | <pre><code class="ini">[INCLUDES] | ||
| 365 | before = common.conf | ||
| 366 | [Definition] | ||
| 367 | failregex = \s-\s<HOST>\s-\sLogin failed for user.*$ | ||
| 368 | ignoreregex = | ||
| 369 | </code></pre> | ||
| 370 | |||
| 371 | <h2 id="robots-restricting-search-engines-and-web-crawler-traffic">Robots - Restricting search engines and web crawler traffic</h2> | ||
| 372 | <p>Creating a <code>robots.txt</code> with the following contents at the root of your Shaarli installation will prevent <em>honest</em> web crawlers from indexing each and every link and Daily page from a Shaarli instance, thus getting rid of a certain amount of unsollicited network traffic.</p> | ||
| 373 | <pre><code>User-agent: * | ||
| 374 | Disallow: / | ||
| 375 | </code></pre> | ||
| 376 | |||
| 377 | <p>See: | ||
| 378 | - http://www.robotstxt.org/ | ||
| 379 | - http://www.robotstxt.org/robotstxt.html | ||
| 380 | - http://www.robotstxt.org/meta.html</p> | ||
| 381 | |||
| 382 | </div> | ||
| 383 | </div> | ||
| 384 | <footer> | ||
| 385 | |||
| 386 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 387 | |||
| 388 | <a href="../Shaarli-configuration/" class="btn btn-neutral float-right" title="Shaarli configuration">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 389 | |||
| 390 | |||
| 391 | <a href="../Server-configuration/" class="btn btn-neutral" title="Server configuration"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 392 | |||
| 393 | </div> | ||
| 394 | |||
| 395 | |||
| 396 | <hr/> | ||
| 397 | |||
| 398 | <div role="contentinfo"> | ||
| 399 | <!-- Copyright etc --> | ||
| 400 | |||
| 401 | </div> | ||
| 402 | |||
| 403 | 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>. | ||
| 404 | </footer> | ||
| 405 | |||
| 406 | </div> | ||
| 407 | </div> | ||
| 408 | |||
| 409 | </section> | ||
| 410 | |||
| 411 | </div> | ||
| 412 | |||
| 413 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 414 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 415 | |||
| 416 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 417 | |||
| 418 | |||
| 419 | <span><a href="../Server-configuration/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 420 | |||
| 421 | |||
| 422 | <span style="margin-left: 15px"><a href="../Shaarli-configuration/" style="color: #fcfcfc">Next »</a></span> | ||
| 423 | |||
| 424 | </span> | ||
| 425 | </div> | ||
| 426 | <script src="../js/theme.js"></script> | ||
| 427 | |||
| 428 | </body> | ||
| 429 | </html> | ||
diff --git a/doc/html/Shaarli-configuration/index.html b/doc/html/Shaarli-configuration/index.html new file mode 100644 index 00000000..95a487d0 --- /dev/null +++ b/doc/html/Shaarli-configuration/index.html | |||
| @@ -0,0 +1,563 @@ | |||
| 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>Shaarli configuration - 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 = "Shaarli configuration"; | ||
| 22 | var mkdocs_page_input_path = "Shaarli-configuration.md"; | ||
| 23 | var mkdocs_page_url = "/Shaarli-configuration/"; | ||
| 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=" current"> | ||
| 81 | |||
| 82 | <a class="current" href="./">Shaarli configuration</a> | ||
| 83 | <ul class="subnav"> | ||
| 84 | |||
| 85 | <li class="toctree-l3"><a href="#foreword">Foreword</a></li> | ||
| 86 | |||
| 87 | |||
| 88 | <li class="toctree-l3"><a href="#file-and-directory-permissions">File and directory permissions</a></li> | ||
| 89 | |||
| 90 | |||
| 91 | <li class="toctree-l3"><a href="#configuration">Configuration</a></li> | ||
| 92 | |||
| 93 | <ul> | ||
| 94 | |||
| 95 | <li><a class="toctree-l4" href="#credentials">Credentials</a></li> | ||
| 96 | |||
| 97 | <li><a class="toctree-l4" href="#general">General</a></li> | ||
| 98 | |||
| 99 | <li><a class="toctree-l4" href="#security">Security</a></li> | ||
| 100 | |||
| 101 | <li><a class="toctree-l4" href="#resources">Resources</a></li> | ||
| 102 | |||
| 103 | <li><a class="toctree-l4" href="#updates">Updates</a></li> | ||
| 104 | |||
| 105 | <li><a class="toctree-l4" href="#privacy">Privacy</a></li> | ||
| 106 | |||
| 107 | <li><a class="toctree-l4" href="#feed">Feed</a></li> | ||
| 108 | |||
| 109 | <li><a class="toctree-l4" href="#thumbnail">Thumbnail</a></li> | ||
| 110 | |||
| 111 | <li><a class="toctree-l4" href="#redirector">Redirector</a></li> | ||
| 112 | |||
| 113 | </ul> | ||
| 114 | |||
| 115 | |||
| 116 | <li class="toctree-l3"><a href="#configuration-file-example">Configuration file example</a></li> | ||
| 117 | |||
| 118 | |||
| 119 | <li class="toctree-l3"><a href="#additional-configuration">Additional configuration</a></li> | ||
| 120 | |||
| 121 | |||
| 122 | </ul> | ||
| 123 | </li> | ||
| 124 | <li class=""> | ||
| 125 | |||
| 126 | <a class="" href="../Plugins/">Plugins</a> | ||
| 127 | </li> | ||
| 128 | </ul> | ||
| 129 | </li> | ||
| 130 | |||
| 131 | <li class="toctree-l1"> | ||
| 132 | |||
| 133 | <span class="caption-text">Docker</span> | ||
| 134 | <ul class="subnav"> | ||
| 135 | <li class=""> | ||
| 136 | |||
| 137 | <a class="" href="../Docker-101/">Docker 101</a> | ||
| 138 | </li> | ||
| 139 | <li class=""> | ||
| 140 | |||
| 141 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 142 | </li> | ||
| 143 | <li class=""> | ||
| 144 | |||
| 145 | <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a> | ||
| 146 | </li> | ||
| 147 | <li class=""> | ||
| 148 | |||
| 149 | <a class="" href="../Docker-resources/">Docker resources</a> | ||
| 150 | </li> | ||
| 151 | </ul> | ||
| 152 | </li> | ||
| 153 | |||
| 154 | <li class="toctree-l1"> | ||
| 155 | |||
| 156 | <span class="caption-text">Usage</span> | ||
| 157 | <ul class="subnav"> | ||
| 158 | <li class=""> | ||
| 159 | |||
| 160 | <a class="" href="../Features/">Features</a> | ||
| 161 | </li> | ||
| 162 | <li class=""> | ||
| 163 | |||
| 164 | <a class="" href="../Bookmarklet/">Bookmarklet</a> | ||
| 165 | </li> | ||
| 166 | <li class=""> | ||
| 167 | |||
| 168 | <a class="" href="../Browsing-and-searching/">Browsing and searching</a> | ||
| 169 | </li> | ||
| 170 | <li class=""> | ||
| 171 | |||
| 172 | <a class="" href="../Firefox-share/">Firefox share</a> | ||
| 173 | </li> | ||
| 174 | <li class=""> | ||
| 175 | |||
| 176 | <a class="" href="../RSS-feeds/">RSS feeds</a> | ||
| 177 | </li> | ||
| 178 | <li class=""> | ||
| 179 | |||
| 180 | <a class="" href="../REST-API/">REST API</a> | ||
| 181 | </li> | ||
| 182 | </ul> | ||
| 183 | </li> | ||
| 184 | |||
| 185 | <li class="toctree-l1"> | ||
| 186 | |||
| 187 | <span class="caption-text">How To</span> | ||
| 188 | <ul class="subnav"> | ||
| 189 | <li class=""> | ||
| 190 | |||
| 191 | <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a> | ||
| 192 | </li> | ||
| 193 | <li class=""> | ||
| 194 | |||
| 195 | <a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 196 | </li> | ||
| 197 | <li class=""> | ||
| 198 | |||
| 199 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 200 | </li> | ||
| 201 | <li class=""> | ||
| 202 | |||
| 203 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 204 | </li> | ||
| 205 | <li class=""> | ||
| 206 | |||
| 207 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 208 | </li> | ||
| 209 | </ul> | ||
| 210 | </li> | ||
| 211 | |||
| 212 | <li class="toctree-l1"> | ||
| 213 | |||
| 214 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 215 | </li> | ||
| 216 | |||
| 217 | <li class="toctree-l1"> | ||
| 218 | |||
| 219 | <span class="caption-text">Development</span> | ||
| 220 | <ul class="subnav"> | ||
| 221 | <li class=""> | ||
| 222 | |||
| 223 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 224 | </li> | ||
| 225 | <li class=""> | ||
| 226 | |||
| 227 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 228 | </li> | ||
| 229 | <li class=""> | ||
| 230 | |||
| 231 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 232 | </li> | ||
| 233 | <li class=""> | ||
| 234 | |||
| 235 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 236 | </li> | ||
| 237 | <li class=""> | ||
| 238 | |||
| 239 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 240 | </li> | ||
| 241 | <li class=""> | ||
| 242 | |||
| 243 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 244 | </li> | ||
| 245 | <li class=""> | ||
| 246 | |||
| 247 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 248 | </li> | ||
| 249 | <li class=""> | ||
| 250 | |||
| 251 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 252 | </li> | ||
| 253 | <li class=""> | ||
| 254 | |||
| 255 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 256 | </li> | ||
| 257 | <li class=""> | ||
| 258 | |||
| 259 | <a class="" href="../Security/">Security</a> | ||
| 260 | </li> | ||
| 261 | <li class=""> | ||
| 262 | |||
| 263 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 264 | </li> | ||
| 265 | <li class=""> | ||
| 266 | |||
| 267 | <a class="" href="../Theming/">Theming</a> | ||
| 268 | </li> | ||
| 269 | <li class=""> | ||
| 270 | |||
| 271 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 272 | </li> | ||
| 273 | </ul> | ||
| 274 | </li> | ||
| 275 | |||
| 276 | <li class="toctree-l1"> | ||
| 277 | |||
| 278 | <span class="caption-text">About</span> | ||
| 279 | <ul class="subnav"> | ||
| 280 | <li class=""> | ||
| 281 | |||
| 282 | <a class="" href="../FAQ/">FAQ</a> | ||
| 283 | </li> | ||
| 284 | <li class=""> | ||
| 285 | |||
| 286 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 287 | </li> | ||
| 288 | </ul> | ||
| 289 | </li> | ||
| 290 | |||
| 291 | </ul> | ||
| 292 | </div> | ||
| 293 | | ||
| 294 | </nav> | ||
| 295 | |||
| 296 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 297 | |||
| 298 | |||
| 299 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 300 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 301 | <a href="..">Shaarli Documentation</a> | ||
| 302 | </nav> | ||
| 303 | |||
| 304 | |||
| 305 | <div class="wy-nav-content"> | ||
| 306 | <div class="rst-content"> | ||
| 307 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 308 | <ul class="wy-breadcrumbs"> | ||
| 309 | <li><a href="..">Docs</a> »</li> | ||
| 310 | |||
| 311 | |||
| 312 | |||
| 313 | <li>Setup »</li> | ||
| 314 | |||
| 315 | |||
| 316 | |||
| 317 | <li>Shaarli configuration</li> | ||
| 318 | <li class="wy-breadcrumbs-aside"> | ||
| 319 | |||
| 320 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Shaarli-configuration.md" | ||
| 321 | class="icon icon-github"> Edit on GitHub</a> | ||
| 322 | |||
| 323 | </li> | ||
| 324 | </ul> | ||
| 325 | <hr/> | ||
| 326 | </div> | ||
| 327 | <div role="main"> | ||
| 328 | <div class="section"> | ||
| 329 | |||
| 330 | <h2 id="foreword">Foreword</h2> | ||
| 331 | <p><strong>Do not edit configuration options in index.php! Your changes would be lost.</strong> </p> | ||
| 332 | <p>Once your Shaarli instance is installed, the file <code>data/config.json.php</code> is generated: | ||
| 333 | <em> it contains all settings in JSON format, and can be edited to customize values | ||
| 334 | </em> it defines which <a href="../Plugin-System">plugins</a> are enabled<a href="../.html"></a> | ||
| 335 | <em> its values override those defined in <code>index.php</code> | ||
| 336 | </em> it is wrap in a PHP comment to prevent anyone accessing it, regardless of server configuration</p> | ||
| 337 | <h2 id="file-and-directory-permissions">File and directory permissions</h2> | ||
| 338 | <p>The server process running Shaarli must have: | ||
| 339 | - <code>read</code> access to the following resources: | ||
| 340 | - PHP scripts: <code>index.php</code>, <code>application/*.php</code>, <code>plugins/*.php</code> | ||
| 341 | - 3rd party PHP and Javascript libraries: <code>inc/*.php</code>, <code>inc/*.js</code> | ||
| 342 | - static assets: | ||
| 343 | - CSS stylesheets: <code>inc/*.css</code> | ||
| 344 | - <code>images/*</code> | ||
| 345 | - RainTPL templates: <code>tpl/*.html</code> | ||
| 346 | - <code>read</code>, <code>write</code> and <code>execution</code> access to the following directories: | ||
| 347 | - <code>cache</code> - thumbnail cache | ||
| 348 | - <code>data</code> - link data store, configuration options | ||
| 349 | - <code>pagecache</code> - Atom/RSS feed cache | ||
| 350 | - <code>tmp</code> - RainTPL page cache</p> | ||
| 351 | <p>On a Linux distribution: | ||
| 352 | - the web server user will likely be <code>www</code> or <code>http</code> (for Apache2) | ||
| 353 | - it will be a member of a group of the same name: <code>www:www</code>, <code>http:http</code> | ||
| 354 | - to give it access to Shaarli, either: | ||
| 355 | - unzip Shaarli in the default web server location (usually <code>/var/www/</code>) and set the web server user as the owner | ||
| 356 | - put users in the same group as the web server, and set the appropriate access rights | ||
| 357 | - if you have a domain / subdomain to serve Shaarli, <a href="../Server-configuration">configure the server</a> accordingly<a href="../.html"></a></p> | ||
| 358 | <h2 id="configuration">Configuration</h2> | ||
| 359 | <p>In <code>data/config.json.php</code>.</p> | ||
| 360 | <p>See also <a href="../Plugin-System.html">Plugin System</a>.</p> | ||
| 361 | <h3 id="credentials">Credentials</h3> | ||
| 362 | <blockquote> | ||
| 363 | <p>You shouldn't edit those.</p> | ||
| 364 | </blockquote> | ||
| 365 | <p><strong>login</strong>: Login username.<br /> | ||
| 366 | <strong>hash</strong>: Generated password hash.<br /> | ||
| 367 | <strong>salt</strong>: Password salt.</p> | ||
| 368 | <h3 id="general">General</h3> | ||
| 369 | <p><strong>title</strong>: Shaarli's instance title.<br /> | ||
| 370 | <strong>header_link</strong>: Link to the homepage.<br /> | ||
| 371 | <strong>links_per_page</strong>: Number of shaares displayed per page.<br /> | ||
| 372 | <strong>timezone</strong>: See <a href="http://php.net/manual/en/timezones.php">the list of supported timezones</a>.<br /> | ||
| 373 | <strong>enabled_plugins</strong>: List of enabled plugins.</p> | ||
| 374 | <h3 id="security">Security</h3> | ||
| 375 | <p><strong>session_protection_disabled</strong>: Disable session cookie hijacking protection (not recommended). | ||
| 376 | It might be useful if your IP adress often changes.<br /> | ||
| 377 | <strong>ban_after</strong>: Failed login attempts before being IP banned.<br /> | ||
| 378 | <strong>ban_duration</strong>: IP ban duration in seconds.<br /> | ||
| 379 | <strong>open_shaarli</strong>: Anyone can add a new link while logged out if enabled.<br /> | ||
| 380 | <strong>trusted_proxies</strong>: List of trusted IP which won't be banned after failed login attemps. Useful if Shaarli is behind a reverse proxy.<br /> | ||
| 381 | <strong>allowed_protocols</strong>: List of allowed protocols in shaare URLs or markdown-rendered descriptions. Useful if you want to store <code>javascript:</code> links (bookmarklets) in Shaarli (default: <code>["ftp", "ftps", "magnet"]</code>).</p> | ||
| 382 | <h3 id="resources">Resources</h3> | ||
| 383 | <p><strong>data_dir</strong>: Data directory.<br /> | ||
| 384 | <strong>datastore</strong>: Shaarli's links database file path.<br /> | ||
| 385 | <strong>history</strong>: Shaarli's operation history file path. | ||
| 386 | <strong>updates</strong>: File path for the ran updates file.<br /> | ||
| 387 | <strong>log</strong>: Log file path.<br /> | ||
| 388 | <strong>update_check</strong>: Last update check file path.<br /> | ||
| 389 | <strong>raintpl_tpl</strong>: Templates directory.<br /> | ||
| 390 | <strong>raintpl_tmp</strong>: Template engine cache directory.<br /> | ||
| 391 | <strong>thumbnails_cache</strong>: Thumbnails cache directory.<br /> | ||
| 392 | <strong>page_cache</strong>: Shaarli's internal cache directory.<br /> | ||
| 393 | <strong>ban_file</strong>: Banned IP file path.</p> | ||
| 394 | <h3 id="updates">Updates</h3> | ||
| 395 | <p><strong>check_updates</strong>: Enable or disable update check to the git repository.<br /> | ||
| 396 | <strong>check_updates_branch</strong>: Git branch used to check updates (e.g. <code>stable</code> or <code>master</code>).<br /> | ||
| 397 | <strong>check_updates_interval</strong>: Look for new version every N seconds (default: every day).</p> | ||
| 398 | <h3 id="privacy">Privacy</h3> | ||
| 399 | <p><strong>default_private_links</strong>: Check the private checkbox by default for every new link.<br /> | ||
| 400 | <strong>hide_public_links</strong>: All links are hidden while logged out.<br /> | ||
| 401 | <strong>hide_timestamps</strong>: Timestamps are hidden.</p> | ||
| 402 | <h3 id="feed">Feed</h3> | ||
| 403 | <p><strong>rss_permalinks</strong>: Enable this to redirect RSS links to Shaarli's permalinks instead of shaared URL.<br /> | ||
| 404 | <strong>show_atom</strong>: Display ATOM feed button.</p> | ||
| 405 | <h3 id="thumbnail">Thumbnail</h3> | ||
| 406 | <p><strong>enable_thumbnails</strong>: Enable or disable thumbnail display.<br /> | ||
| 407 | <strong>enable_localcache</strong>: Enable or disable local cache.</p> | ||
| 408 | <h3 id="redirector">Redirector</h3> | ||
| 409 | <p><strong>url</strong>: Redirector URL, such as <code>anonym.to</code>.<br /> | ||
| 410 | <strong>encode_url</strong>: Enable this if the redirector needs encoded URL to work properly.</p> | ||
| 411 | <h2 id="configuration-file-example">Configuration file example</h2> | ||
| 412 | <pre><code class="json"><?php /* | ||
| 413 | { | ||
| 414 | "credentials": { | ||
| 415 | "login": "<login>", | ||
| 416 | "hash": "<password hash>", | ||
| 417 | "salt": "<password salt>" | ||
| 418 | }, | ||
| 419 | "security": { | ||
| 420 | "ban_after": 4, | ||
| 421 | "session_protection_disabled": false, | ||
| 422 | "ban_duration": 1800, | ||
| 423 | "trusted_proxies": [ | ||
| 424 | "1.2.3.4", | ||
| 425 | "5.6.7.8" | ||
| 426 | ], | ||
| 427 | "allowed_protocols": [ | ||
| 428 | "ftp", | ||
| 429 | "ftps", | ||
| 430 | "magnet" | ||
| 431 | ] | ||
| 432 | }, | ||
| 433 | "resources": { | ||
| 434 | "data_dir": "data", | ||
| 435 | "config": "data\/config.php", | ||
| 436 | "datastore": "data\/datastore.php", | ||
| 437 | "ban_file": "data\/ipbans.php", | ||
| 438 | "updates": "data\/updates.txt", | ||
| 439 | "log": "data\/log.txt", | ||
| 440 | "update_check": "data\/lastupdatecheck.txt", | ||
| 441 | "raintpl_tmp": "tmp\/", | ||
| 442 | "raintpl_tpl": "tpl\/", | ||
| 443 | "thumbnails_cache": "cache", | ||
| 444 | "page_cache": "pagecache" | ||
| 445 | }, | ||
| 446 | "general": { | ||
| 447 | "check_updates": true, | ||
| 448 | "rss_permalinks": true, | ||
| 449 | "links_per_page": 20, | ||
| 450 | "default_private_links": true, | ||
| 451 | "enable_thumbnails": true, | ||
| 452 | "enable_localcache": true, | ||
| 453 | "check_updates_branch": "stable", | ||
| 454 | "check_updates_interval": 86400, | ||
| 455 | "enabled_plugins": [ | ||
| 456 | "markdown", | ||
| 457 | "wallabag", | ||
| 458 | "archiveorg" | ||
| 459 | ], | ||
| 460 | "timezone": "Europe\/Paris", | ||
| 461 | "title": "My Shaarli", | ||
| 462 | "header_link": "?" | ||
| 463 | }, | ||
| 464 | "extras": { | ||
| 465 | "show_atom": false, | ||
| 466 | "hide_public_links": false, | ||
| 467 | "hide_timestamps": false, | ||
| 468 | "open_shaarli": false, | ||
| 469 | "redirector": "http://anonym.to/?", | ||
| 470 | "redirector_encode_url": false | ||
| 471 | }, | ||
| 472 | "general": { | ||
| 473 | "header_link": "?", | ||
| 474 | "links_per_page": 20, | ||
| 475 | "enabled_plugins": [ | ||
| 476 | "markdown", | ||
| 477 | "wallabag" | ||
| 478 | ], | ||
| 479 | "timezone": "Europe\/Paris", | ||
| 480 | "title": "My Shaarli" | ||
| 481 | }, | ||
| 482 | "updates": { | ||
| 483 | "check_updates": true, | ||
| 484 | "check_updates_branch": "stable", | ||
| 485 | "check_updates_interval": 86400 | ||
| 486 | }, | ||
| 487 | "feed": { | ||
| 488 | "rss_permalinks": true, | ||
| 489 | "show_atom": false | ||
| 490 | }, | ||
| 491 | "privacy": { | ||
| 492 | "default_private_links": true, | ||
| 493 | "hide_public_links": false, | ||
| 494 | "hide_timestamps": false | ||
| 495 | }, | ||
| 496 | "thumbnail": { | ||
| 497 | "enable_thumbnails": true, | ||
| 498 | "enable_localcache": true | ||
| 499 | }, | ||
| 500 | "redirector": { | ||
| 501 | "url": "http://anonym.to/?", | ||
| 502 | "encode_url": false | ||
| 503 | }, | ||
| 504 | "plugins": { | ||
| 505 | "WALLABAG_URL": "http://demo.wallabag.org", | ||
| 506 | "WALLABAG_VERSION": "1" | ||
| 507 | } | ||
| 508 | } ?> | ||
| 509 | </code></pre> | ||
| 510 | |||
| 511 | <h2 id="additional-configuration">Additional configuration</h2> | ||
| 512 | <p>The playvideos plugin may require that you adapt your server's | ||
| 513 | <a href="https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md#troubleshooting">Content Security Policy</a> | ||
| 514 | configuration to work properly.<a href="../.html"></a></p> | ||
| 515 | |||
| 516 | </div> | ||
| 517 | </div> | ||
| 518 | <footer> | ||
| 519 | |||
| 520 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 521 | |||
| 522 | <a href="../Plugins/" class="btn btn-neutral float-right" title="Plugins">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 523 | |||
| 524 | |||
| 525 | <a href="../Server-security/" class="btn btn-neutral" title="Server security"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 526 | |||
| 527 | </div> | ||
| 528 | |||
| 529 | |||
| 530 | <hr/> | ||
| 531 | |||
| 532 | <div role="contentinfo"> | ||
| 533 | <!-- Copyright etc --> | ||
| 534 | |||
| 535 | </div> | ||
| 536 | |||
| 537 | 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>. | ||
| 538 | </footer> | ||
| 539 | |||
| 540 | </div> | ||
| 541 | </div> | ||
| 542 | |||
| 543 | </section> | ||
| 544 | |||
| 545 | </div> | ||
| 546 | |||
| 547 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 548 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 549 | |||
| 550 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 551 | |||
| 552 | |||
| 553 | <span><a href="../Server-security/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 554 | |||
| 555 | |||
| 556 | <span style="margin-left: 15px"><a href="../Plugins/" style="color: #fcfcfc">Next »</a></span> | ||
| 557 | |||
| 558 | </span> | ||
| 559 | </div> | ||
| 560 | <script src="../js/theme.js"></script> | ||
| 561 | |||
| 562 | </body> | ||
| 563 | </html> | ||
diff --git a/doc/html/Shaarli-images/index.html b/doc/html/Shaarli-images/index.html new file mode 100644 index 00000000..0fa93ca3 --- /dev/null +++ b/doc/html/Shaarli-images/index.html | |||
| @@ -0,0 +1,425 @@ | |||
| 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>Shaarli images - 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 = "Shaarli images"; | ||
| 22 | var mkdocs_page_input_path = "Shaarli-images.md"; | ||
| 23 | var mkdocs_page_url = "/Shaarli-images/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=" current"> | ||
| 100 | |||
| 101 | <a class="current" href="./">Shaarli images</a> | ||
| 102 | <ul class="subnav"> | ||
| 103 | |||
| 104 | <li class="toctree-l3"><a href="#get-and-run-a-shaarli-image">Get and run a Shaarli image</a></li> | ||
| 105 | |||
| 106 | <ul> | ||
| 107 | |||
| 108 | <li><a class="toctree-l4" href="#dockerhub-repository">DockerHub repository</a></li> | ||
| 109 | |||
| 110 | <li><a class="toctree-l4" href="#available-image-tags">Available image tags</a></li> | ||
| 111 | |||
| 112 | <li><a class="toctree-l4" href="#download-from-dockerhub">Download from DockerHub</a></li> | ||
| 113 | |||
| 114 | <li><a class="toctree-l4" href="#create-and-start-a-new-container-from-the-image">Create and start a new container from the image</a></li> | ||
| 115 | |||
| 116 | <li><a class="toctree-l4" href="#stop-and-destroy-a-container">Stop and destroy a container</a></li> | ||
| 117 | |||
| 118 | </ul> | ||
| 119 | |||
| 120 | |||
| 121 | </ul> | ||
| 122 | </li> | ||
| 123 | <li class=""> | ||
| 124 | |||
| 125 | <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a> | ||
| 126 | </li> | ||
| 127 | <li class=""> | ||
| 128 | |||
| 129 | <a class="" href="../Docker-resources/">Docker resources</a> | ||
| 130 | </li> | ||
| 131 | </ul> | ||
| 132 | </li> | ||
| 133 | |||
| 134 | <li class="toctree-l1"> | ||
| 135 | |||
| 136 | <span class="caption-text">Usage</span> | ||
| 137 | <ul class="subnav"> | ||
| 138 | <li class=""> | ||
| 139 | |||
| 140 | <a class="" href="../Features/">Features</a> | ||
| 141 | </li> | ||
| 142 | <li class=""> | ||
| 143 | |||
| 144 | <a class="" href="../Bookmarklet/">Bookmarklet</a> | ||
| 145 | </li> | ||
| 146 | <li class=""> | ||
| 147 | |||
| 148 | <a class="" href="../Browsing-and-searching/">Browsing and searching</a> | ||
| 149 | </li> | ||
| 150 | <li class=""> | ||
| 151 | |||
| 152 | <a class="" href="../Firefox-share/">Firefox share</a> | ||
| 153 | </li> | ||
| 154 | <li class=""> | ||
| 155 | |||
| 156 | <a class="" href="../RSS-feeds/">RSS feeds</a> | ||
| 157 | </li> | ||
| 158 | <li class=""> | ||
| 159 | |||
| 160 | <a class="" href="../REST-API/">REST API</a> | ||
| 161 | </li> | ||
| 162 | </ul> | ||
| 163 | </li> | ||
| 164 | |||
| 165 | <li class="toctree-l1"> | ||
| 166 | |||
| 167 | <span class="caption-text">How To</span> | ||
| 168 | <ul class="subnav"> | ||
| 169 | <li class=""> | ||
| 170 | |||
| 171 | <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a> | ||
| 172 | </li> | ||
| 173 | <li class=""> | ||
| 174 | |||
| 175 | <a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 176 | </li> | ||
| 177 | <li class=""> | ||
| 178 | |||
| 179 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 180 | </li> | ||
| 181 | <li class=""> | ||
| 182 | |||
| 183 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 184 | </li> | ||
| 185 | <li class=""> | ||
| 186 | |||
| 187 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 188 | </li> | ||
| 189 | </ul> | ||
| 190 | </li> | ||
| 191 | |||
| 192 | <li class="toctree-l1"> | ||
| 193 | |||
| 194 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 195 | </li> | ||
| 196 | |||
| 197 | <li class="toctree-l1"> | ||
| 198 | |||
| 199 | <span class="caption-text">Development</span> | ||
| 200 | <ul class="subnav"> | ||
| 201 | <li class=""> | ||
| 202 | |||
| 203 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 204 | </li> | ||
| 205 | <li class=""> | ||
| 206 | |||
| 207 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 208 | </li> | ||
| 209 | <li class=""> | ||
| 210 | |||
| 211 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 212 | </li> | ||
| 213 | <li class=""> | ||
| 214 | |||
| 215 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 216 | </li> | ||
| 217 | <li class=""> | ||
| 218 | |||
| 219 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 220 | </li> | ||
| 221 | <li class=""> | ||
| 222 | |||
| 223 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 224 | </li> | ||
| 225 | <li class=""> | ||
| 226 | |||
| 227 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 228 | </li> | ||
| 229 | <li class=""> | ||
| 230 | |||
| 231 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 232 | </li> | ||
| 233 | <li class=""> | ||
| 234 | |||
| 235 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 236 | </li> | ||
| 237 | <li class=""> | ||
| 238 | |||
| 239 | <a class="" href="../Security/">Security</a> | ||
| 240 | </li> | ||
| 241 | <li class=""> | ||
| 242 | |||
| 243 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 244 | </li> | ||
| 245 | <li class=""> | ||
| 246 | |||
| 247 | <a class="" href="../Theming/">Theming</a> | ||
| 248 | </li> | ||
| 249 | <li class=""> | ||
| 250 | |||
| 251 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 252 | </li> | ||
| 253 | </ul> | ||
| 254 | </li> | ||
| 255 | |||
| 256 | <li class="toctree-l1"> | ||
| 257 | |||
| 258 | <span class="caption-text">About</span> | ||
| 259 | <ul class="subnav"> | ||
| 260 | <li class=""> | ||
| 261 | |||
| 262 | <a class="" href="../FAQ/">FAQ</a> | ||
| 263 | </li> | ||
| 264 | <li class=""> | ||
| 265 | |||
| 266 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 267 | </li> | ||
| 268 | </ul> | ||
| 269 | </li> | ||
| 270 | |||
| 271 | </ul> | ||
| 272 | </div> | ||
| 273 | | ||
| 274 | </nav> | ||
| 275 | |||
| 276 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 277 | |||
| 278 | |||
| 279 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 280 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 281 | <a href="..">Shaarli Documentation</a> | ||
| 282 | </nav> | ||
| 283 | |||
| 284 | |||
| 285 | <div class="wy-nav-content"> | ||
| 286 | <div class="rst-content"> | ||
| 287 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 288 | <ul class="wy-breadcrumbs"> | ||
| 289 | <li><a href="..">Docs</a> »</li> | ||
| 290 | |||
| 291 | |||
| 292 | |||
| 293 | <li>Docker »</li> | ||
| 294 | |||
| 295 | |||
| 296 | |||
| 297 | <li>Shaarli images</li> | ||
| 298 | <li class="wy-breadcrumbs-aside"> | ||
| 299 | |||
| 300 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Shaarli-images.md" | ||
| 301 | class="icon icon-github"> Edit on GitHub</a> | ||
| 302 | |||
| 303 | </li> | ||
| 304 | </ul> | ||
| 305 | <hr/> | ||
| 306 | </div> | ||
| 307 | <div role="main"> | ||
| 308 | <div class="section"> | ||
| 309 | |||
| 310 | <h2 id="get-and-run-a-shaarli-image">Get and run a Shaarli image</h2> | ||
| 311 | <h3 id="dockerhub-repository">DockerHub repository</h3> | ||
| 312 | <p>The images can be found in the <a href="https://hub.docker.com/r/shaarli/shaarli/"><code>shaarli/shaarli</code></a> | ||
| 313 | repository.</p> | ||
| 314 | <h3 id="available-image-tags">Available image tags</h3> | ||
| 315 | <ul> | ||
| 316 | <li><code>latest</code>: master branch (tarball release)</li> | ||
| 317 | <li><code>stable</code>: stable branch (tarball release)</li> | ||
| 318 | <li><code>dev</code>: master branch (Git clone)</li> | ||
| 319 | </ul> | ||
| 320 | <p>All images rely on: | ||
| 321 | - <a href="https://hub.docker.com/_/debian/">Debian 8 Jessie</a> | ||
| 322 | - <a href="http://php-fpm.org/">PHP5-FPM</a> | ||
| 323 | - <a href="http://nginx.org/">Nginx</a></p> | ||
| 324 | <h3 id="download-from-dockerhub">Download from DockerHub</h3> | ||
| 325 | <pre><code class="bash">$ docker pull shaarli/shaarli | ||
| 326 | latest: Pulling from shaarli/shaarli | ||
| 327 | 32716d9fcddb: Pull complete | ||
| 328 | 84899d045435: Pull complete | ||
| 329 | 4b6ad7444763: Pull complete | ||
| 330 | e0345ef7a3e0: Pull complete | ||
| 331 | 5c1dd344094f: Pull complete | ||
| 332 | 6422305a200b: Pull complete | ||
| 333 | 7d63f861dbef: Pull complete | ||
| 334 | 3eb97210645c: Pull complete | ||
| 335 | 869319d746ff: Already exists | ||
| 336 | 869319d746ff: Pulling fs layer | ||
| 337 | 902b87aaaec9: Already exists | ||
| 338 | Digest: sha256:f836b4627b958b3f83f59c332f22f02fcd495ace3056f2be2c4912bd8704cc98 | ||
| 339 | Status: Downloaded newer image for shaarli/shaarli:latest | ||
| 340 | </code></pre> | ||
| 341 | |||
| 342 | <h3 id="create-and-start-a-new-container-from-the-image">Create and start a new container from the image</h3> | ||
| 343 | <pre><code class="bash"># map the host's :8000 port to the container's :80 port | ||
| 344 | $ docker create -p 8000:80 shaarli/shaarli | ||
| 345 | d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101 | ||
| 346 | |||
| 347 | # launch the container in the background | ||
| 348 | $ docker start d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101 | ||
| 349 | d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101 | ||
| 350 | |||
| 351 | # list active containers | ||
| 352 | $ docker ps | ||
| 353 | CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES | ||
| 354 | d40b7af693d6 shaarli/shaarli /usr/bin/supervisor 15 seconds ago Up 4 seconds 0.0.0.0:8000->80/tcp backstabbing_galileo | ||
| 355 | </code></pre> | ||
| 356 | |||
| 357 | <h3 id="stop-and-destroy-a-container">Stop and destroy a container</h3> | ||
| 358 | <pre><code class="bash">$ docker stop backstabbing_galileo # those docker guys are really rude to physicists! | ||
| 359 | backstabbing_galileo | ||
| 360 | |||
| 361 | # check the container is stopped | ||
| 362 | $ docker ps | ||
| 363 | CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES | ||
| 364 | |||
| 365 | # list ALL containers | ||
| 366 | $ docker ps -a | ||
| 367 | CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES | ||
| 368 | d40b7af693d6 shaarli/shaarli /usr/bin/supervisor 5 minutes ago Exited (0) 48 seconds ago backstabbing_galileo | ||
| 369 | |||
| 370 | # destroy the container | ||
| 371 | $ docker rm backstabbing_galileo # let's put an end to these barbarian practices | ||
| 372 | backstabbing_galileo | ||
| 373 | |||
| 374 | $ docker ps -a | ||
| 375 | CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES | ||
| 376 | </code></pre> | ||
| 377 | |||
| 378 | </div> | ||
| 379 | </div> | ||
| 380 | <footer> | ||
| 381 | |||
| 382 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 383 | |||
| 384 | <a href="../Reverse-proxy-configuration/" class="btn btn-neutral float-right" title="Reverse proxy configuration">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 385 | |||
| 386 | |||
| 387 | <a href="../Docker-101/" class="btn btn-neutral" title="Docker 101"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 388 | |||
| 389 | </div> | ||
| 390 | |||
| 391 | |||
| 392 | <hr/> | ||
| 393 | |||
| 394 | <div role="contentinfo"> | ||
| 395 | <!-- Copyright etc --> | ||
| 396 | |||
| 397 | </div> | ||
| 398 | |||
| 399 | 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>. | ||
| 400 | </footer> | ||
| 401 | |||
| 402 | </div> | ||
| 403 | </div> | ||
| 404 | |||
| 405 | </section> | ||
| 406 | |||
| 407 | </div> | ||
| 408 | |||
| 409 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 410 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 411 | |||
| 412 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 413 | |||
| 414 | |||
| 415 | <span><a href="../Docker-101/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 416 | |||
| 417 | |||
| 418 | <span style="margin-left: 15px"><a href="../Reverse-proxy-configuration/" style="color: #fcfcfc">Next »</a></span> | ||
| 419 | |||
| 420 | </span> | ||
| 421 | </div> | ||
| 422 | <script src="../js/theme.js"></script> | ||
| 423 | |||
| 424 | </body> | ||
| 425 | </html> | ||
diff --git a/doc/html/Static-analysis/index.html b/doc/html/Static-analysis/index.html new file mode 100644 index 00000000..0dfb5519 --- /dev/null +++ b/doc/html/Static-analysis/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>Static analysis - 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 = "Static analysis"; | ||
| 22 | var mkdocs_page_input_path = "Static-analysis.md"; | ||
| 23 | var mkdocs_page_url = "/Static-analysis/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="../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="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 156 | </li> | ||
| 157 | <li class=""> | ||
| 158 | |||
| 159 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 160 | </li> | ||
| 161 | <li class=""> | ||
| 162 | |||
| 163 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 164 | </li> | ||
| 165 | <li class=""> | ||
| 166 | |||
| 167 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 168 | </li> | ||
| 169 | </ul> | ||
| 170 | </li> | ||
| 171 | |||
| 172 | <li class="toctree-l1"> | ||
| 173 | |||
| 174 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 175 | </li> | ||
| 176 | |||
| 177 | <li class="toctree-l1"> | ||
| 178 | |||
| 179 | <span class="caption-text">Development</span> | ||
| 180 | <ul class="subnav"> | ||
| 181 | <li class=""> | ||
| 182 | |||
| 183 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 184 | </li> | ||
| 185 | <li class=""> | ||
| 186 | |||
| 187 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 188 | </li> | ||
| 189 | <li class=""> | ||
| 190 | |||
| 191 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 192 | </li> | ||
| 193 | <li class=""> | ||
| 194 | |||
| 195 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 196 | </li> | ||
| 197 | <li class=""> | ||
| 198 | |||
| 199 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 200 | </li> | ||
| 201 | <li class=""> | ||
| 202 | |||
| 203 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 204 | </li> | ||
| 205 | <li class=""> | ||
| 206 | |||
| 207 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 208 | </li> | ||
| 209 | <li class=""> | ||
| 210 | |||
| 211 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 212 | </li> | ||
| 213 | <li class=""> | ||
| 214 | |||
| 215 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 216 | </li> | ||
| 217 | <li class=""> | ||
| 218 | |||
| 219 | <a class="" href="../Security/">Security</a> | ||
| 220 | </li> | ||
| 221 | <li class=" current"> | ||
| 222 | |||
| 223 | <a class="current" href="./">Static analysis</a> | ||
| 224 | <ul class="subnav"> | ||
| 225 | |||
| 226 | <li class="toctree-l3"><a href="#wip">WIP</a></li> | ||
| 227 | |||
| 228 | <ul> | ||
| 229 | |||
| 230 | <li><a class="toctree-l4" href="#usage">Usage</a></li> | ||
| 231 | |||
| 232 | </ul> | ||
| 233 | |||
| 234 | |||
| 235 | </ul> | ||
| 236 | </li> | ||
| 237 | <li class=""> | ||
| 238 | |||
| 239 | <a class="" href="../Theming/">Theming</a> | ||
| 240 | </li> | ||
| 241 | <li class=""> | ||
| 242 | |||
| 243 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 244 | </li> | ||
| 245 | </ul> | ||
| 246 | </li> | ||
| 247 | |||
| 248 | <li class="toctree-l1"> | ||
| 249 | |||
| 250 | <span class="caption-text">About</span> | ||
| 251 | <ul class="subnav"> | ||
| 252 | <li class=""> | ||
| 253 | |||
| 254 | <a class="" href="../FAQ/">FAQ</a> | ||
| 255 | </li> | ||
| 256 | <li class=""> | ||
| 257 | |||
| 258 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 259 | </li> | ||
| 260 | </ul> | ||
| 261 | </li> | ||
| 262 | |||
| 263 | </ul> | ||
| 264 | </div> | ||
| 265 | | ||
| 266 | </nav> | ||
| 267 | |||
| 268 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 269 | |||
| 270 | |||
| 271 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 272 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 273 | <a href="..">Shaarli Documentation</a> | ||
| 274 | </nav> | ||
| 275 | |||
| 276 | |||
| 277 | <div class="wy-nav-content"> | ||
| 278 | <div class="rst-content"> | ||
| 279 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 280 | <ul class="wy-breadcrumbs"> | ||
| 281 | <li><a href="..">Docs</a> »</li> | ||
| 282 | |||
| 283 | |||
| 284 | |||
| 285 | <li>Development »</li> | ||
| 286 | |||
| 287 | |||
| 288 | |||
| 289 | <li>Static analysis</li> | ||
| 290 | <li class="wy-breadcrumbs-aside"> | ||
| 291 | |||
| 292 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Static-analysis.md" | ||
| 293 | class="icon icon-github"> Edit on GitHub</a> | ||
| 294 | |||
| 295 | </li> | ||
| 296 | </ul> | ||
| 297 | <hr/> | ||
| 298 | </div> | ||
| 299 | <div role="main"> | ||
| 300 | <div class="section"> | ||
| 301 | |||
| 302 | <h2 id="wip">WIP</h2> | ||
| 303 | <p>This topic is currently being discussed here: | ||
| 304 | - <a href="https://github.com/shaarli/Shaarli/issues/95">Fix coding style (static analysis)</a> (#95) | ||
| 305 | - <a href="https://github.com/shaarli/Shaarli/issues/130">Continuous Integration tools & features</a> (#130)</p> | ||
| 306 | <h3 id="usage">Usage</h3> | ||
| 307 | <p>Static analysis tools can be installed with Composer, and used through Shaarli's <a href="https://github.com/shaarli/Shaarli/blob/master/Makefile">Makefile</a>.</p> | ||
| 308 | <p>For an overview of the available features, see: | ||
| 309 | - <a href="https://github.com/shaarli/Shaarli/pull/124">Code quality: Makefile to run static code checkers</a> (#124) | ||
| 310 | - <a href="https://github.com/shaarli/Shaarli/pull/276">Run PHPCS against different coding standards</a> (#276)</p> | ||
| 311 | |||
| 312 | </div> | ||
| 313 | </div> | ||
| 314 | <footer> | ||
| 315 | |||
| 316 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 317 | |||
| 318 | <a href="../Theming/" class="btn btn-neutral float-right" title="Theming">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 319 | |||
| 320 | |||
| 321 | <a href="../Security/" class="btn btn-neutral" title="Security"><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="../Security/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 350 | |||
| 351 | |||
| 352 | <span style="margin-left: 15px"><a href="../Theming/" style="color: #fcfcfc">Next »</a></span> | ||
| 353 | |||
| 354 | </span> | ||
| 355 | </div> | ||
| 356 | <script src="../js/theme.js"></script> | ||
| 357 | |||
| 358 | </body> | ||
| 359 | </html> | ||
diff --git a/doc/html/Theming/index.html b/doc/html/Theming/index.html new file mode 100644 index 00000000..70a36dd4 --- /dev/null +++ b/doc/html/Theming/index.html | |||
| @@ -0,0 +1,435 @@ | |||
| 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>Theming - 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 = "Theming"; | ||
| 22 | var mkdocs_page_input_path = "Theming.md"; | ||
| 23 | var mkdocs_page_url = "/Theming/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="../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="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 156 | </li> | ||
| 157 | <li class=""> | ||
| 158 | |||
| 159 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 160 | </li> | ||
| 161 | <li class=""> | ||
| 162 | |||
| 163 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 164 | </li> | ||
| 165 | <li class=""> | ||
| 166 | |||
| 167 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 168 | </li> | ||
| 169 | </ul> | ||
| 170 | </li> | ||
| 171 | |||
| 172 | <li class="toctree-l1"> | ||
| 173 | |||
| 174 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 175 | </li> | ||
| 176 | |||
| 177 | <li class="toctree-l1"> | ||
| 178 | |||
| 179 | <span class="caption-text">Development</span> | ||
| 180 | <ul class="subnav"> | ||
| 181 | <li class=""> | ||
| 182 | |||
| 183 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 184 | </li> | ||
| 185 | <li class=""> | ||
| 186 | |||
| 187 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 188 | </li> | ||
| 189 | <li class=""> | ||
| 190 | |||
| 191 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 192 | </li> | ||
| 193 | <li class=""> | ||
| 194 | |||
| 195 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 196 | </li> | ||
| 197 | <li class=""> | ||
| 198 | |||
| 199 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 200 | </li> | ||
| 201 | <li class=""> | ||
| 202 | |||
| 203 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 204 | </li> | ||
| 205 | <li class=""> | ||
| 206 | |||
| 207 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 208 | </li> | ||
| 209 | <li class=""> | ||
| 210 | |||
| 211 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 212 | </li> | ||
| 213 | <li class=""> | ||
| 214 | |||
| 215 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 216 | </li> | ||
| 217 | <li class=""> | ||
| 218 | |||
| 219 | <a class="" href="../Security/">Security</a> | ||
| 220 | </li> | ||
| 221 | <li class=""> | ||
| 222 | |||
| 223 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 224 | </li> | ||
| 225 | <li class=" current"> | ||
| 226 | |||
| 227 | <a class="current" href="./">Theming</a> | ||
| 228 | <ul class="subnav"> | ||
| 229 | |||
| 230 | <li class="toctree-l3"><a href="#foreword">Foreword</a></li> | ||
| 231 | |||
| 232 | |||
| 233 | <li class="toctree-l3"><a href="#custom-css">Custom CSS</a></li> | ||
| 234 | |||
| 235 | |||
| 236 | <li class="toctree-l3"><a href="#themes">Themes</a></li> | ||
| 237 | |||
| 238 | |||
| 239 | <li class="toctree-l3"><a href="#community-css-themes">Community CSS & themes</a></li> | ||
| 240 | |||
| 241 | <ul> | ||
| 242 | |||
| 243 | <li><a class="toctree-l4" href="#custom-css_1">Custom CSS</a></li> | ||
| 244 | |||
| 245 | <li><a class="toctree-l4" href="#themes_1">Themes</a></li> | ||
| 246 | |||
| 247 | <li><a class="toctree-l4" href="#shaarli-forks">Shaarli forks</a></li> | ||
| 248 | |||
| 249 | </ul> | ||
| 250 | |||
| 251 | |||
| 252 | <li class="toctree-l3"><a href="#example-installation-albinomouse-theme">Example installation: AlbinoMouse theme</a></li> | ||
| 253 | |||
| 254 | |||
| 255 | </ul> | ||
| 256 | </li> | ||
| 257 | <li class=""> | ||
| 258 | |||
| 259 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 260 | </li> | ||
| 261 | </ul> | ||
| 262 | </li> | ||
| 263 | |||
| 264 | <li class="toctree-l1"> | ||
| 265 | |||
| 266 | <span class="caption-text">About</span> | ||
| 267 | <ul class="subnav"> | ||
| 268 | <li class=""> | ||
| 269 | |||
| 270 | <a class="" href="../FAQ/">FAQ</a> | ||
| 271 | </li> | ||
| 272 | <li class=""> | ||
| 273 | |||
| 274 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 275 | </li> | ||
| 276 | </ul> | ||
| 277 | </li> | ||
| 278 | |||
| 279 | </ul> | ||
| 280 | </div> | ||
| 281 | | ||
| 282 | </nav> | ||
| 283 | |||
| 284 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 285 | |||
| 286 | |||
| 287 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 288 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 289 | <a href="..">Shaarli Documentation</a> | ||
| 290 | </nav> | ||
| 291 | |||
| 292 | |||
| 293 | <div class="wy-nav-content"> | ||
| 294 | <div class="rst-content"> | ||
| 295 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 296 | <ul class="wy-breadcrumbs"> | ||
| 297 | <li><a href="..">Docs</a> »</li> | ||
| 298 | |||
| 299 | |||
| 300 | |||
| 301 | <li>Development »</li> | ||
| 302 | |||
| 303 | |||
| 304 | |||
| 305 | <li>Theming</li> | ||
| 306 | <li class="wy-breadcrumbs-aside"> | ||
| 307 | |||
| 308 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Theming.md" | ||
| 309 | class="icon icon-github"> Edit on GitHub</a> | ||
| 310 | |||
| 311 | </li> | ||
| 312 | </ul> | ||
| 313 | <hr/> | ||
| 314 | </div> | ||
| 315 | <div role="main"> | ||
| 316 | <div class="section"> | ||
| 317 | |||
| 318 | <h2 id="foreword">Foreword</h2> | ||
| 319 | <p>There are two ways of customizing how Shaarli looks:</p> | ||
| 320 | <ol> | ||
| 321 | <li>by using a custom CSS to override Shaarli's CSS</li> | ||
| 322 | <li>by using a full theme that provides its own RainTPL templates, CSS and Javascript resources</li> | ||
| 323 | </ol> | ||
| 324 | <h2 id="custom-css">Custom CSS</h2> | ||
| 325 | <p>Shaarli's appearance can be modified by adding CSS rules to: | ||
| 326 | - Shaarli < <code>v0.9.0</code>: <code>inc/user.css</code> | ||
| 327 | - Shaarli >= <code>v0.9.0</code>: <code>data/user.css</code></p> | ||
| 328 | <p>This file allows overriding rules defined in the template CSS files (only add changed rules), or define a whole new theme.</p> | ||
| 329 | <p><strong>Note</strong>: Do not edit <code>tpl/default/css/shaarli.css</code>! Your changes would be overridden when updating Shaarli.</p> | ||
| 330 | <p>See also <a href="../Download CSS styles from an OPML list">Download CSS styles from an OPML list</a></p> | ||
| 331 | <h2 id="themes">Themes</h2> | ||
| 332 | <p><em>WARNING - This feature is currently being worked on and will be improved in the next releases. Experimental.</em></p> | ||
| 333 | <p>Installation: | ||
| 334 | - find a theme you'd like to install | ||
| 335 | - copy or clone the theme folder under <code>tpl/<a_sweet_theme></code> | ||
| 336 | - enable the theme: | ||
| 337 | - Shaarli < <code>v0.9.0</code>: edit <code>data/config.json.php</code> and set the value of <code>raintpl_tpl</code> to the new theme name: | ||
| 338 | <code>"raintpl_tpl": "tpl\/my-template\/"</code> | ||
| 339 | - Shaarli >= <code>v0.9.0</code>: select the theme through the <em>Tools</em> page</p> | ||
| 340 | <h2 id="community-css-themes">Community CSS & themes</h2> | ||
| 341 | <h3 id="custom-css_1">Custom CSS</h3> | ||
| 342 | <ul> | ||
| 343 | <li><a href="https://github.com/mrjovanovic/serious-theme-shaarli">mrjovanovic/serious-theme-shaarli</a> - A serious theme for Shaarli</li> | ||
| 344 | <li><a href="https://github.com/shaarli/shaarli-themes">shaarli/shaarli-themes</a></li> | ||
| 345 | </ul> | ||
| 346 | <h3 id="themes_1">Themes</h3> | ||
| 347 | <ul> | ||
| 348 | <li><a href="https://github.com/AkibaTech/Shaarli---SuperHero-Theme">AkibaTech/Shaarli Superhero Theme</a> - A template/theme for Shaarli</li> | ||
| 349 | <li><a href="https://github.com/alexisju/albinomouse-template">alexisju/albinomouse-template</a> - A full template for Shaarli</li> | ||
| 350 | <li><a href="https://github.com/ArthurHoaro/shaarli-launch">ArthurHoaro/shaarli-launch</a> - Customizable Shaarli theme</li> | ||
| 351 | <li><a href="https://github.com/dhoko/ShaarliTemplate">dhoko/ShaarliTemplate</a> - A template/theme for Shaarli</li> | ||
| 352 | <li><a href="https://github.com/kalvn/shaarli-blocks">kalvn/shaarli-blocks</a> - A template/theme for Shaarli</li> | ||
| 353 | <li><a href="https://github.com/kalvn/Shaarli-Material">kalvn/Shaarli-Material</a> - A theme (template) based on Google's Material Design for Shaarli, the superfast delicious clone</li> | ||
| 354 | <li><a href="https://github.com/ManufacturaInd/shaarli-2004licious-theme">ManufacturaInd/shaarli-2004licious-theme</a> - A template/theme as a humble homage to the early looks of the del.icio.us site</li> | ||
| 355 | </ul> | ||
| 356 | <h3 id="shaarli-forks">Shaarli forks</h3> | ||
| 357 | <ul> | ||
| 358 | <li><a href="https://github.com/misterair/limonade">misterair/Limonade</a> - A fork of (legacy) Shaarli with a new template</li> | ||
| 359 | <li><a href="https://github.com/vivienhaese/shaarlitheme">vivienhaese/shaarlitheme</a> - A Shaarli fork meant to be run in an openshift instance</li> | ||
| 360 | </ul> | ||
| 361 | <h2 id="example-installation-albinomouse-theme">Example installation: AlbinoMouse theme</h2> | ||
| 362 | <p>With the following configuration: | ||
| 363 | - Apache 2 / PHP 5.6 | ||
| 364 | - user sites are enabled, e.g. <code>/home/user/public_html/somedir</code> is served as <code>http://localhost/~user/somedir</code> | ||
| 365 | - <code>http</code> is the name of the Apache user</p> | ||
| 366 | <pre><code class="bash">$ cd ~/public_html | ||
| 367 | |||
| 368 | # clone repositories | ||
| 369 | $ git clone https://github.com/shaarli/Shaarli.git shaarli | ||
| 370 | $ pushd shaarli/tpl | ||
| 371 | $ git clone https://github.com/alexisju/albinomouse-template.git | ||
| 372 | $ popd | ||
| 373 | |||
| 374 | # set access rights for Apache | ||
| 375 | $ chgrp -R http shaarli | ||
| 376 | $ chmod g+rwx shaarli shaarli/cache shaarli/data shaarli/pagecache shaarli/tmp | ||
| 377 | </code></pre> | ||
| 378 | |||
| 379 | <p>Get config written: | ||
| 380 | - go to the freshly installed site | ||
| 381 | - fill the install form | ||
| 382 | - log in to Shaarli</p> | ||
| 383 | <p>Edit Shaarli's <a href="../configuration|Shaarli configuration">configuration|Shaarli configuration</a>:</p> | ||
| 384 | <pre><code class="bash"># the file should be owned by Apache, thus not writeable => sudo | ||
| 385 | $ sudo sed -i s=tpl=tpl/albinomouse-template=g shaarli/data/config.php | ||
| 386 | </code></pre> | ||
| 387 | |||
| 388 | </div> | ||
| 389 | </div> | ||
| 390 | <footer> | ||
| 391 | |||
| 392 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 393 | |||
| 394 | <a href="../Unit-tests/" class="btn btn-neutral float-right" title="Unit tests">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 395 | |||
| 396 | |||
| 397 | <a href="../Static-analysis/" class="btn btn-neutral" title="Static analysis"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 398 | |||
| 399 | </div> | ||
| 400 | |||
| 401 | |||
| 402 | <hr/> | ||
| 403 | |||
| 404 | <div role="contentinfo"> | ||
| 405 | <!-- Copyright etc --> | ||
| 406 | |||
| 407 | </div> | ||
| 408 | |||
| 409 | 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>. | ||
| 410 | </footer> | ||
| 411 | |||
| 412 | </div> | ||
| 413 | </div> | ||
| 414 | |||
| 415 | </section> | ||
| 416 | |||
| 417 | </div> | ||
| 418 | |||
| 419 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 420 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 421 | |||
| 422 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 423 | |||
| 424 | |||
| 425 | <span><a href="../Static-analysis/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 426 | |||
| 427 | |||
| 428 | <span style="margin-left: 15px"><a href="../Unit-tests/" style="color: #fcfcfc">Next »</a></span> | ||
| 429 | |||
| 430 | </span> | ||
| 431 | </div> | ||
| 432 | <script src="../js/theme.js"></script> | ||
| 433 | |||
| 434 | </body> | ||
| 435 | </html> | ||
diff --git a/doc/html/Troubleshooting/index.html b/doc/html/Troubleshooting/index.html new file mode 100644 index 00000000..ed1c433d --- /dev/null +++ b/doc/html/Troubleshooting/index.html | |||
| @@ -0,0 +1,441 @@ | |||
| 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>Troubleshooting - 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 = "Troubleshooting"; | ||
| 22 | var mkdocs_page_input_path = "Troubleshooting.md"; | ||
| 23 | var mkdocs_page_url = "/Troubleshooting/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="../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="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 156 | </li> | ||
| 157 | <li class=""> | ||
| 158 | |||
| 159 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 160 | </li> | ||
| 161 | <li class=""> | ||
| 162 | |||
| 163 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 164 | </li> | ||
| 165 | <li class=""> | ||
| 166 | |||
| 167 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 168 | </li> | ||
| 169 | </ul> | ||
| 170 | </li> | ||
| 171 | |||
| 172 | <li class="toctree-l1 current"> | ||
| 173 | |||
| 174 | <a class="current" href="./">Troubleshooting</a> | ||
| 175 | <ul class="subnav"> | ||
| 176 | |||
| 177 | <li class="toctree-l2"><a href="#troubleshooting">Troubleshooting</a></li> | ||
| 178 | |||
| 179 | <ul> | ||
| 180 | |||
| 181 | <li><a class="toctree-l3" href="#browser">Browser</a></li> | ||
| 182 | |||
| 183 | <li><a class="toctree-l3" href="#login">Login</a></li> | ||
| 184 | |||
| 185 | <li><a class="toctree-l3" href="#hosting-problems">Hosting problems</a></li> | ||
| 186 | |||
| 187 | <li><a class="toctree-l3" href="#sessions-do-not-seem-to-work-correctly-on-your-server">Sessions do not seem to work correctly on your server</a></li> | ||
| 188 | |||
| 189 | </ul> | ||
| 190 | |||
| 191 | |||
| 192 | </ul> | ||
| 193 | </li> | ||
| 194 | |||
| 195 | <li class="toctree-l1"> | ||
| 196 | |||
| 197 | <span class="caption-text">Development</span> | ||
| 198 | <ul class="subnav"> | ||
| 199 | <li class=""> | ||
| 200 | |||
| 201 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 202 | </li> | ||
| 203 | <li class=""> | ||
| 204 | |||
| 205 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 206 | </li> | ||
| 207 | <li class=""> | ||
| 208 | |||
| 209 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 210 | </li> | ||
| 211 | <li class=""> | ||
| 212 | |||
| 213 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 214 | </li> | ||
| 215 | <li class=""> | ||
| 216 | |||
| 217 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 218 | </li> | ||
| 219 | <li class=""> | ||
| 220 | |||
| 221 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 222 | </li> | ||
| 223 | <li class=""> | ||
| 224 | |||
| 225 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 226 | </li> | ||
| 227 | <li class=""> | ||
| 228 | |||
| 229 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 230 | </li> | ||
| 231 | <li class=""> | ||
| 232 | |||
| 233 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 234 | </li> | ||
| 235 | <li class=""> | ||
| 236 | |||
| 237 | <a class="" href="../Security/">Security</a> | ||
| 238 | </li> | ||
| 239 | <li class=""> | ||
| 240 | |||
| 241 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 242 | </li> | ||
| 243 | <li class=""> | ||
| 244 | |||
| 245 | <a class="" href="../Theming/">Theming</a> | ||
| 246 | </li> | ||
| 247 | <li class=""> | ||
| 248 | |||
| 249 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 250 | </li> | ||
| 251 | </ul> | ||
| 252 | </li> | ||
| 253 | |||
| 254 | <li class="toctree-l1"> | ||
| 255 | |||
| 256 | <span class="caption-text">About</span> | ||
| 257 | <ul class="subnav"> | ||
| 258 | <li class=""> | ||
| 259 | |||
| 260 | <a class="" href="../FAQ/">FAQ</a> | ||
| 261 | </li> | ||
| 262 | <li class=""> | ||
| 263 | |||
| 264 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 265 | </li> | ||
| 266 | </ul> | ||
| 267 | </li> | ||
| 268 | |||
| 269 | </ul> | ||
| 270 | </div> | ||
| 271 | | ||
| 272 | </nav> | ||
| 273 | |||
| 274 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 275 | |||
| 276 | |||
| 277 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 278 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 279 | <a href="..">Shaarli Documentation</a> | ||
| 280 | </nav> | ||
| 281 | |||
| 282 | |||
| 283 | <div class="wy-nav-content"> | ||
| 284 | <div class="rst-content"> | ||
| 285 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 286 | <ul class="wy-breadcrumbs"> | ||
| 287 | <li><a href="..">Docs</a> »</li> | ||
| 288 | |||
| 289 | |||
| 290 | |||
| 291 | <li>Troubleshooting</li> | ||
| 292 | <li class="wy-breadcrumbs-aside"> | ||
| 293 | |||
| 294 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Troubleshooting.md" | ||
| 295 | class="icon icon-github"> Edit on GitHub</a> | ||
| 296 | |||
| 297 | </li> | ||
| 298 | </ul> | ||
| 299 | <hr/> | ||
| 300 | </div> | ||
| 301 | <div role="main"> | ||
| 302 | <div class="section"> | ||
| 303 | |||
| 304 | <h1 id="troubleshooting">Troubleshooting</h1> | ||
| 305 | <h2 id="browser">Browser</h2> | ||
| 306 | <h3 id="redirection-issues-http-referer">Redirection issues (HTTP Referer)</h3> | ||
| 307 | <p>Depending on its configuration and installed plugins, the browser may remove or alter (spoof) HTTP referers, thus preventing Shaarli from properly redirecting between pages.</p> | ||
| 308 | <p>See: | ||
| 309 | - <a href="https://en.wikipedia.org/wiki/HTTP_referer">HTTP referer</a> (Wikipedia) | ||
| 310 | - <a href="http://www.ghacks.net/2015/01/22/improve-online-privacy-by-controlling-referrer-information/">Improve online privacy by controlling referrer information</a> | ||
| 311 | - <a href="http://b.agilob.net/better-security-privacy-and-anonymity-in-firefox/">Better security, privacy and anonymity in Firefox</a></p> | ||
| 312 | <h3 id="firefox-http-referer-options">Firefox HTTP Referer options</h3> | ||
| 313 | <p>HTTP settings are available by browsing <code>about:config</code>, here are the available settings and their values.</p> | ||
| 314 | <p><code>network.http.sendRefererHeader</code> - determines when to send the Referer HTTP header | ||
| 315 | - 0: Never send the referring URL | ||
| 316 | - not recommended, may break some sites | ||
| 317 | - 1: Send only on clicked links | ||
| 318 | - 2 (default): Send for links and images</p> | ||
| 319 | <p><code>network.http.referer.XOriginPolicy</code> - Cross-domain origin policy | ||
| 320 | - 0 (default): Always send | ||
| 321 | - 1: Send if base domains match | ||
| 322 | - 2: Send if hosts match</p> | ||
| 323 | <p><code>network.http.referer.spoofSource</code> - Referer spoofing (~faking) | ||
| 324 | - false (default): real referer | ||
| 325 | - true: spoof referer (use target URI as referer) | ||
| 326 | - known to break some functionality in Shaarli</p> | ||
| 327 | <p><code>network.http.referer.trimmingPolicy</code> - trim the URI not to send a full Referer | ||
| 328 | - 0 (default): send full URI | ||
| 329 | - 1: scheme+host+port+path | ||
| 330 | - 2: scheme+host+port</p> | ||
| 331 | <h3 id="firefox-localhost-and-redirections">Firefox, localhost and redirections</h3> | ||
| 332 | <p><code>localhost</code> is not a proper Fully Qualified Domain Name (FQDN); if Firefox has been set up to spoof referers, or only accept requests from the same base domain/host, Shaarli redirections will not work properly.</p> | ||
| 333 | <p>To solve this, assign a local domain to your host, e.g.</p> | ||
| 334 | <pre><code>127.0.0.1 localhost desktop localhost.lan | ||
| 335 | ::1 localhost desktop localhost.lan | ||
| 336 | </code></pre> | ||
| 337 | |||
| 338 | <p>and browse Shaarli at http://localhost.lan/.</p> | ||
| 339 | <p>Related threads: | ||
| 340 | - <a href="https://bbs.archlinux.org/viewtopic.php?id=156064">What is localhost.localdomain for?</a> | ||
| 341 | - <a href="https://github.com/shaarli/Shaarli/issues/311">Stop returning to the first page after editing a bookmark from another page</a></p> | ||
| 342 | <h2 id="login">Login</h2> | ||
| 343 | <h3 id="i-forgot-my-password">I forgot my password!</h3> | ||
| 344 | <p>Delete the file <code>data/config.php</code> and display the page again. You will be asked for a new login/password.</p> | ||
| 345 | <h3 id="im-locked-out-login-bruteforce-protection">I'm locked out - Login bruteforce protection</h3> | ||
| 346 | <p>Login form is protected against brute force attacks: 4 failed logins will ban the IP address from login for 30 minutes. Banned IPs can still browse links.</p> | ||
| 347 | <p>To remove the current IP bans, delete the file <code>data/ipbans.php</code></p> | ||
| 348 | <h3 id="list-of-all-login-attempts">List of all login attempts</h3> | ||
| 349 | <p>The file <code>data/log.txt</code> shows all logins (successful or failed) and bans/lifted bans. | ||
| 350 | Search for <code>failed</code> in this file to look for unauthorized login attempts.</p> | ||
| 351 | <h2 id="hosting-problems">Hosting problems</h2> | ||
| 352 | <h3 id="old-php-versions">Old PHP versions</h3> | ||
| 353 | <ul> | ||
| 354 | <li>On <strong>free.fr</strong> : free.fr now support php 5.6.x(<a href="http://les.pages.perso.chez.free.fr/migrations/php5v6.io">link</a>)and so support now the tag autocompletion but you have to do the following : At the root of your webspace create a <code>sessions</code> directory and a <code>.htaccess</code> file containing:</li> | ||
| 355 | </ul> | ||
| 356 | <pre><code class="ini"><IfDefine Free> | ||
| 357 | php56 1 | ||
| 358 | </IfDefine> | ||
| 359 | </code></pre> | ||
| 360 | |||
| 361 | <ul> | ||
| 362 | <li>If you have an error such as: <code>Parse error: syntax error, unexpected '=', expecting '(' in /links/index.php on line xxx</code>, it means that your host is using php4, not php5. Shaarli requires php 5.1. Try changing the file extension to <code>.php5</code></li> | ||
| 363 | <li>On <strong>1and1</strong> : If you add the link from the page (and not from the bookmarklet), Shaarli will no be able to get the title of the page. You will have to enter it manually. (Because they have disabled the ability to download a file through HTTP).</li> | ||
| 364 | <li>If you have the error <code>Warning: file_get_contents() [function.file-get-contents]: URL file-access is disabled in the server configuration in /…/index.php on line xxx</code>, it means that your host has disabled the ability to fetch a file by HTTP in the php config (Typically in 1and1 hosting). Bad host. Change host. Or comment the following lines:</li> | ||
| 365 | </ul> | ||
| 366 | <pre><code class="php">//list($status,$headers,$data) = getHTTP($url,4); // Short timeout to keep the application responsive. | ||
| 367 | // FIXME: Decode charset according to charset specified in either 1) HTTP response headers or 2) <head> in html | ||
| 368 | //if (strpos($status,'200 OK')) $title=html_extract_title($data); | ||
| 369 | </code></pre> | ||
| 370 | |||
| 371 | <ul> | ||
| 372 | <li>On hosts which forbid outgoing HTTP requests (such as free.fr), some thumbnails will not work.</li> | ||
| 373 | <li>On <strong>lost-oasis</strong>, RSS doesn't work correctly, because of this message at the begining of the RSS/ATOM feed : <code><? // tout ce qui est charge ici (generalement des includes et require) est charge en permanence. ?></code>. To fix this, remove this message from <code>php-include/prepend.php</code></li> | ||
| 374 | </ul> | ||
| 375 | <h3 id="dates-are-not-properly-formatted">Dates are not properly formatted</h3> | ||
| 376 | <p>Shaarli tries to sniff the language of the browser (using HTTP_ACCEPT_LANGUAGE headers) and choose a date format accordingly. But Shaarli can only use the date formats (and more generaly speaking, the locales) provided by the webserver. So even if you have a browser in French, you may end up with dates in US format (it's the case on sebsauvage.net :-( )</p> | ||
| 377 | <h3 id="problems-on-centos-servers">Problems on CentOS servers</h3> | ||
| 378 | <p>On <strong>CentOS</strong>/RedHat derivatives, you may need to install the <code>php-mbstring</code> package.</p> | ||
| 379 | <h3 id="my-session-expires-i-cant-stay-logged-in">My session expires! I can't stay logged in</h3> | ||
| 380 | <p>This can be caused by several things:</p> | ||
| 381 | <ul> | ||
| 382 | <li>Your php installation may not have a proper directory setup for session files. (eg. on Free.fr you need to create a <code>session</code> directory on the root of your website.) You may need to create the session directory of set it up.</li> | ||
| 383 | <li>Most hosts regularly clean the temporary and session directories. Your host may be cleaning those directories too aggressively (eg.OVH hosts), forcing an expire of the session. You may want to set the session directory in your web root. (eg. Create the <code>sessions</code> subdirectory and add <code>ini_set('session.save_path', $_SERVER['DOCUMENT_ROOT'].'/../sessions');</code>. Make sure this directory is not browsable !)</li> | ||
| 384 | <li>If your IP address changes during surfing, Shaarli will force expire your session for security reasons (to prevent session cookie hijacking). This can happen when surfing from WiFi or 3G (you may have switched WiFi/3G access point), or in some corporate/university proxies which use load balancing (and may have proxies with several external IP addresses).</li> | ||
| 385 | <li>Some browser addons may interfer with HTTP headers (ipfuck/ipflood/GreaseMonkey…). Try disabling those.</li> | ||
| 386 | <li>You may be using OperaTurbo or OperaMini, which use their own proxies which may change from time to time.</li> | ||
| 387 | <li>If you have another application on the same webserver where Shaarli is installed, these application may forcefully expire php sessions.</li> | ||
| 388 | </ul> | ||
| 389 | <h2 id="sessions-do-not-seem-to-work-correctly-on-your-server">Sessions do not seem to work correctly on your server</h2> | ||
| 390 | <p>Follow the instructions in the error message. Make sure you are accessing shaarli via a direct IP address or a proper hostname. If you have <strong>no dots</strong> in the hostname (e.g. <code>localhost</code> or <code>http://my-webserver/shaarli/</code>), some browsers will not store cookies at all (this respects the <a href="http://curl.haxx.se/rfc/cookie_spec.html">HTTP cookie specification</a>).</p> | ||
| 391 | <h3 id="pubsubhubbub-support">pubsubhubbub support</h3> | ||
| 392 | <p>Download <a href="https://pubsubhubbub.googlecode.com/git/publisher_clients/php/library/publisher.php">publisher.php</a> at the root of your Shaarli installation and set <code>$GLOBALS['config']['PUBSUBHUB_URL']</code> in your <code>config.php</code></p> | ||
| 393 | |||
| 394 | </div> | ||
| 395 | </div> | ||
| 396 | <footer> | ||
| 397 | |||
| 398 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 399 | |||
| 400 | <a href="../Development-guidelines/" class="btn btn-neutral float-right" title="Development guidelines">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 401 | |||
| 402 | |||
| 403 | <a href="../Datastore-hacks/" class="btn btn-neutral" title="Datastore hacks"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 404 | |||
| 405 | </div> | ||
| 406 | |||
| 407 | |||
| 408 | <hr/> | ||
| 409 | |||
| 410 | <div role="contentinfo"> | ||
| 411 | <!-- Copyright etc --> | ||
| 412 | |||
| 413 | </div> | ||
| 414 | |||
| 415 | 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>. | ||
| 416 | </footer> | ||
| 417 | |||
| 418 | </div> | ||
| 419 | </div> | ||
| 420 | |||
| 421 | </section> | ||
| 422 | |||
| 423 | </div> | ||
| 424 | |||
| 425 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 426 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 427 | |||
| 428 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 429 | |||
| 430 | |||
| 431 | <span><a href="../Datastore-hacks/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 432 | |||
| 433 | |||
| 434 | <span style="margin-left: 15px"><a href="../Development-guidelines/" style="color: #fcfcfc">Next »</a></span> | ||
| 435 | |||
| 436 | </span> | ||
| 437 | </div> | ||
| 438 | <script src="../js/theme.js"></script> | ||
| 439 | |||
| 440 | </body> | ||
| 441 | </html> | ||
diff --git a/doc/html/Unit-tests/index.html b/doc/html/Unit-tests/index.html new file mode 100644 index 00000000..84580db4 --- /dev/null +++ b/doc/html/Unit-tests/index.html | |||
| @@ -0,0 +1,492 @@ | |||
| 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>Unit tests - 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 = "Unit tests"; | ||
| 22 | var mkdocs_page_input_path = "Unit-tests.md"; | ||
| 23 | var mkdocs_page_url = "/Unit-tests/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="../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="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 156 | </li> | ||
| 157 | <li class=""> | ||
| 158 | |||
| 159 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 160 | </li> | ||
| 161 | <li class=""> | ||
| 162 | |||
| 163 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 164 | </li> | ||
| 165 | <li class=""> | ||
| 166 | |||
| 167 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 168 | </li> | ||
| 169 | </ul> | ||
| 170 | </li> | ||
| 171 | |||
| 172 | <li class="toctree-l1"> | ||
| 173 | |||
| 174 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 175 | </li> | ||
| 176 | |||
| 177 | <li class="toctree-l1"> | ||
| 178 | |||
| 179 | <span class="caption-text">Development</span> | ||
| 180 | <ul class="subnav"> | ||
| 181 | <li class=""> | ||
| 182 | |||
| 183 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 184 | </li> | ||
| 185 | <li class=""> | ||
| 186 | |||
| 187 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 188 | </li> | ||
| 189 | <li class=""> | ||
| 190 | |||
| 191 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 192 | </li> | ||
| 193 | <li class=""> | ||
| 194 | |||
| 195 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 196 | </li> | ||
| 197 | <li class=""> | ||
| 198 | |||
| 199 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 200 | </li> | ||
| 201 | <li class=""> | ||
| 202 | |||
| 203 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 204 | </li> | ||
| 205 | <li class=""> | ||
| 206 | |||
| 207 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 208 | </li> | ||
| 209 | <li class=""> | ||
| 210 | |||
| 211 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 212 | </li> | ||
| 213 | <li class=""> | ||
| 214 | |||
| 215 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 216 | </li> | ||
| 217 | <li class=""> | ||
| 218 | |||
| 219 | <a class="" href="../Security/">Security</a> | ||
| 220 | </li> | ||
| 221 | <li class=""> | ||
| 222 | |||
| 223 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 224 | </li> | ||
| 225 | <li class=""> | ||
| 226 | |||
| 227 | <a class="" href="../Theming/">Theming</a> | ||
| 228 | </li> | ||
| 229 | <li class=" current"> | ||
| 230 | |||
| 231 | <a class="current" href="./">Unit tests</a> | ||
| 232 | <ul class="subnav"> | ||
| 233 | |||
| 234 | <li class="toctree-l3"><a href="#setup-your-environment-for-tests">Setup your environment for tests</a></li> | ||
| 235 | |||
| 236 | <ul> | ||
| 237 | |||
| 238 | <li><a class="toctree-l4" href="#sample-usage">Sample usage</a></li> | ||
| 239 | |||
| 240 | <li><a class="toctree-l4" href="#install-shaarli-dev-dependencies">Install Shaarli dev dependencies</a></li> | ||
| 241 | |||
| 242 | <li><a class="toctree-l4" href="#install-and-enable-xdebug-to-generate-phpunit-coverage-reports">Install and enable Xdebug to generate PHPUnit coverage reports</a></li> | ||
| 243 | |||
| 244 | <li><a class="toctree-l4" href="#run-unit-tests">Run unit tests</a></li> | ||
| 245 | |||
| 246 | <li><a class="toctree-l4" href="#test-results-and-coverage">Test results and coverage</a></li> | ||
| 247 | |||
| 248 | </ul> | ||
| 249 | |||
| 250 | |||
| 251 | <li class="toctree-l3"><a href="#executing-specific-tests">Executing specific tests</a></li> | ||
| 252 | |||
| 253 | |||
| 254 | </ul> | ||
| 255 | </li> | ||
| 256 | </ul> | ||
| 257 | </li> | ||
| 258 | |||
| 259 | <li class="toctree-l1"> | ||
| 260 | |||
| 261 | <span class="caption-text">About</span> | ||
| 262 | <ul class="subnav"> | ||
| 263 | <li class=""> | ||
| 264 | |||
| 265 | <a class="" href="../FAQ/">FAQ</a> | ||
| 266 | </li> | ||
| 267 | <li class=""> | ||
| 268 | |||
| 269 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 270 | </li> | ||
| 271 | </ul> | ||
| 272 | </li> | ||
| 273 | |||
| 274 | </ul> | ||
| 275 | </div> | ||
| 276 | | ||
| 277 | </nav> | ||
| 278 | |||
| 279 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 280 | |||
| 281 | |||
| 282 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 283 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 284 | <a href="..">Shaarli Documentation</a> | ||
| 285 | </nav> | ||
| 286 | |||
| 287 | |||
| 288 | <div class="wy-nav-content"> | ||
| 289 | <div class="rst-content"> | ||
| 290 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 291 | <ul class="wy-breadcrumbs"> | ||
| 292 | <li><a href="..">Docs</a> »</li> | ||
| 293 | |||
| 294 | |||
| 295 | |||
| 296 | <li>Development »</li> | ||
| 297 | |||
| 298 | |||
| 299 | |||
| 300 | <li>Unit tests</li> | ||
| 301 | <li class="wy-breadcrumbs-aside"> | ||
| 302 | |||
| 303 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Unit-tests.md" | ||
| 304 | class="icon icon-github"> Edit on GitHub</a> | ||
| 305 | |||
| 306 | </li> | ||
| 307 | </ul> | ||
| 308 | <hr/> | ||
| 309 | </div> | ||
| 310 | <div role="main"> | ||
| 311 | <div class="section"> | ||
| 312 | |||
| 313 | <h3 id="setup-your-environment-for-tests">Setup your environment for tests</h3> | ||
| 314 | <p>The framework used is <a href="https://phpunit.de/">PHPUnit</a>; it can be installed with <a href="https://getcomposer.org/">Composer</a>, which is a dependency management tool.</p> | ||
| 315 | <p>Regarding Composer, you can either use: | ||
| 316 | <em> a system-wide version, e.g. installed through your distro's package manager | ||
| 317 | </em> a local version, downloadable <a href="https://getcomposer.org/download/">here</a></p> | ||
| 318 | <h4 id="sample-usage">Sample usage</h4> | ||
| 319 | <pre><code class="bash"># system-wide version | ||
| 320 | $ composer install | ||
| 321 | $ composer update | ||
| 322 | |||
| 323 | # local version | ||
| 324 | $ php composer.phar self-update | ||
| 325 | $ php composer.phar install | ||
| 326 | $ php composer.phar update | ||
| 327 | </code></pre> | ||
| 328 | |||
| 329 | <h4 id="install-shaarli-dev-dependencies">Install Shaarli dev dependencies</h4> | ||
| 330 | <pre><code class="bash">$ cd /path/to/shaarli | ||
| 331 | $ composer update | ||
| 332 | </code></pre> | ||
| 333 | |||
| 334 | <h4 id="install-and-enable-xdebug-to-generate-phpunit-coverage-reports">Install and enable Xdebug to generate PHPUnit coverage reports</h4> | ||
| 335 | <p>For Debian-based distros:</p> | ||
| 336 | <pre><code class="bash">$ aptitude install php5-xdebug | ||
| 337 | </code></pre> | ||
| 338 | |||
| 339 | <p>For ArchLinux:</p> | ||
| 340 | <pre><code class="bash">$ pacman -S xdebug | ||
| 341 | </code></pre> | ||
| 342 | |||
| 343 | <p>Then add the following line to <code>/etc/php/php.ini</code>:</p> | ||
| 344 | <pre><code class="ini">zend_extension=xdebug.so | ||
| 345 | </code></pre> | ||
| 346 | |||
| 347 | <h4 id="run-unit-tests">Run unit tests</h4> | ||
| 348 | <p>Successful test suite:</p> | ||
| 349 | <pre><code class="bash">$ make test | ||
| 350 | |||
| 351 | ------- | ||
| 352 | PHPUNIT | ||
| 353 | ------- | ||
| 354 | PHPUnit 4.6.9 by Sebastian Bergmann and contributors. | ||
| 355 | |||
| 356 | Configuration read from /home/virtualtam/public_html/shaarli/phpunit.xml | ||
| 357 | |||
| 358 | .................................... | ||
| 359 | |||
| 360 | Time: 759 ms, Memory: 8.25Mb | ||
| 361 | |||
| 362 | OK (36 tests, 65 assertions) | ||
| 363 | </code></pre> | ||
| 364 | |||
| 365 | <p>Test suite with failures and errors:</p> | ||
| 366 | <pre><code class="bash">$ make test | ||
| 367 | ------- | ||
| 368 | PHPUNIT | ||
| 369 | ------- | ||
| 370 | PHPUnit 4.6.9 by Sebastian Bergmann and contributors. | ||
| 371 | |||
| 372 | Configuration read from /home/virtualtam/public_html/shaarli/phpunit.xml | ||
| 373 | |||
| 374 | E..FF............................... | ||
| 375 | |||
| 376 | Time: 802 ms, Memory: 8.25Mb | ||
| 377 | |||
| 378 | There was 1 error: | ||
| 379 | |||
| 380 | 1) LinkDBTest::testConstructLoggedIn | ||
| 381 | Missing argument 2 for LinkDB::__construct(), called in /home/virtualtam/public_html/shaarli/tests/Link\ | ||
| 382 | DBTest.php on line 79 and defined | ||
| 383 | |||
| 384 | /home/virtualtam/public_html/shaarli/application/LinkDB.php:58 | ||
| 385 | /home/virtualtam/public_html/shaarli/tests/LinkDBTest.php:79 | ||
| 386 | |||
| 387 | -- | ||
| 388 | |||
| 389 | There were 2 failures: | ||
| 390 | |||
| 391 | 1) LinkDBTest::testCheckDBNew | ||
| 392 | Failed asserting that two strings are equal. | ||
| 393 | --- Expected | ||
| 394 | +++ Actual | ||
| 395 | @@ @@ | ||
| 396 | -'e3edea8ea7bb50be4bcb404df53fbb4546a7156e' | ||
| 397 | +'85eab0c610d4f68025f6ed6e6b6b5fabd4b55834' | ||
| 398 | |||
| 399 | /home/virtualtam/public_html/shaarli/tests/LinkDBTest.php:121 | ||
| 400 | |||
| 401 | 2) LinkDBTest::testCheckDBLoad | ||
| 402 | Failed asserting that two strings are equal. | ||
| 403 | --- Expected | ||
| 404 | +++ Actual | ||
| 405 | @@ @@ | ||
| 406 | -'e3edea8ea7bb50be4bcb404df53fbb4546a7156e' | ||
| 407 | +'85eab0c610d4f68025f6ed6e6b6b5fabd4b55834' | ||
| 408 | |||
| 409 | /home/virtualtam/public_html/shaarli/tests/LinkDBTest.php:133 | ||
| 410 | |||
| 411 | FAILURES! | ||
| 412 | Tests: 36, Assertions: 63, Errors: 1, Failures: 2. | ||
| 413 | </code></pre> | ||
| 414 | |||
| 415 | <h4 id="test-results-and-coverage">Test results and coverage</h4> | ||
| 416 | <p>By default, PHPUnit will run all suitable tests found under the <code>tests</code> directory.</p> | ||
| 417 | <p>Each test has 3 possible outcomes: | ||
| 418 | <em> <code>.</code> - success | ||
| 419 | </em> <code>F</code> - failure: the test was run but its results are invalid | ||
| 420 | * the code does not behave as expected | ||
| 421 | * dependencies to external elements: globals, session, cache... | ||
| 422 | * <code>E</code> - error: something went wrong and the tested code has crashed | ||
| 423 | * typos in the code, or in the test code | ||
| 424 | * dependencies to missing external elements</p> | ||
| 425 | <p>If Xdebug has been installed and activated, two coverage reports will be generated: | ||
| 426 | <em> a summary in the console | ||
| 427 | </em> a detailed HTML report with metrics for tested code | ||
| 428 | * to open it in a web browser: <code>firefox coverage/index.html &</code></p> | ||
| 429 | <h3 id="executing-specific-tests">Executing specific tests</h3> | ||
| 430 | <p>Add a <a href="https://phpunit.de/manual/current/en/appendixes.annotations.html#appendixes.annotations.group"><code>@group</code></a> annotation in a test class or method comment:</p> | ||
| 431 | <pre><code class="php">/** | ||
| 432 | * Netscape bookmark import | ||
| 433 | * @group WIP | ||
| 434 | */ | ||
| 435 | class BookmarkImportTest extends PHPUnit_Framework_TestCase | ||
| 436 | { | ||
| 437 | [...] | ||
| 438 | } | ||
| 439 | </code></pre> | ||
| 440 | |||
| 441 | <p>To run all tests annotated with <code>@group WIP</code>:</p> | ||
| 442 | <pre><code class="bash">$ vendor/bin/phpunit --group WIP tests/ | ||
| 443 | </code></pre> | ||
| 444 | |||
| 445 | </div> | ||
| 446 | </div> | ||
| 447 | <footer> | ||
| 448 | |||
| 449 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 450 | |||
| 451 | <a href="../FAQ/" class="btn btn-neutral float-right" title="FAQ">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 452 | |||
| 453 | |||
| 454 | <a href="../Theming/" class="btn btn-neutral" title="Theming"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 455 | |||
| 456 | </div> | ||
| 457 | |||
| 458 | |||
| 459 | <hr/> | ||
| 460 | |||
| 461 | <div role="contentinfo"> | ||
| 462 | <!-- Copyright etc --> | ||
| 463 | |||
| 464 | </div> | ||
| 465 | |||
| 466 | 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>. | ||
| 467 | </footer> | ||
| 468 | |||
| 469 | </div> | ||
| 470 | </div> | ||
| 471 | |||
| 472 | </section> | ||
| 473 | |||
| 474 | </div> | ||
| 475 | |||
| 476 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 477 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 478 | |||
| 479 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 480 | |||
| 481 | |||
| 482 | <span><a href="../Theming/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 483 | |||
| 484 | |||
| 485 | <span style="margin-left: 15px"><a href="../FAQ/" style="color: #fcfcfc">Next »</a></span> | ||
| 486 | |||
| 487 | </span> | ||
| 488 | </div> | ||
| 489 | <script src="../js/theme.js"></script> | ||
| 490 | |||
| 491 | </body> | ||
| 492 | </html> | ||
diff --git a/doc/html/Upgrade-and-migration/index.html b/doc/html/Upgrade-and-migration/index.html new file mode 100644 index 00000000..642942bf --- /dev/null +++ b/doc/html/Upgrade-and-migration/index.html | |||
| @@ -0,0 +1,534 @@ | |||
| 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>Upgrade and migration - 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 = "Upgrade and migration"; | ||
| 22 | var mkdocs_page_input_path = "Upgrade-and-migration.md"; | ||
| 23 | var mkdocs_page_url = "/Upgrade-and-migration/"; | ||
| 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=" current"> | ||
| 65 | |||
| 66 | <a class="current" href="./">Upgrade and migration</a> | ||
| 67 | <ul class="subnav"> | ||
| 68 | |||
| 69 | <li class="toctree-l3"><a href="#preparation">Preparation</a></li> | ||
| 70 | |||
| 71 | <ul> | ||
| 72 | |||
| 73 | <li><a class="toctree-l4" href="#note-your-current-version">Note your current version</a></li> | ||
| 74 | |||
| 75 | <li><a class="toctree-l4" href="#backup-your-data">Backup your data</a></li> | ||
| 76 | |||
| 77 | <li><a class="toctree-l4" href="#migrating-data-from-a-previous-installation">Migrating data from a previous installation</a></li> | ||
| 78 | |||
| 79 | </ul> | ||
| 80 | |||
| 81 | |||
| 82 | <li class="toctree-l3"><a href="#recommended-upgrading-from-release-archives">Recommended : Upgrading from release archives</a></li> | ||
| 83 | |||
| 84 | |||
| 85 | <li class="toctree-l3"><a href="#upgrading-with-git">Upgrading with Git</a></li> | ||
| 86 | |||
| 87 | <ul> | ||
| 88 | |||
| 89 | <li><a class="toctree-l4" href="#updating-a-community-shaarli">Updating a community Shaarli</a></li> | ||
| 90 | |||
| 91 | <li><a class="toctree-l4" href="#migrating-and-upgrading-from-sebsauvages-repository">Migrating and upgrading from Sebsauvage's repository</a></li> | ||
| 92 | |||
| 93 | </ul> | ||
| 94 | |||
| 95 | |||
| 96 | <li class="toctree-l3"><a href="#troubleshooting">Troubleshooting</a></li> | ||
| 97 | |||
| 98 | <ul> | ||
| 99 | |||
| 100 | <li><a class="toctree-l4" href="#you-must-specify-an-integer-as-a-key">You must specify an integer as a key</a></li> | ||
| 101 | |||
| 102 | </ul> | ||
| 103 | |||
| 104 | |||
| 105 | </ul> | ||
| 106 | </li> | ||
| 107 | <li class=""> | ||
| 108 | |||
| 109 | <a class="" href="../Server-requirements/">Server requirements</a> | ||
| 110 | </li> | ||
| 111 | <li class=""> | ||
| 112 | |||
| 113 | <a class="" href="../Server-configuration/">Server configuration</a> | ||
| 114 | </li> | ||
| 115 | <li class=""> | ||
| 116 | |||
| 117 | <a class="" href="../Server-security/">Server security</a> | ||
| 118 | </li> | ||
| 119 | <li class=""> | ||
| 120 | |||
| 121 | <a class="" href="../Shaarli-configuration/">Shaarli configuration</a> | ||
| 122 | </li> | ||
| 123 | <li class=""> | ||
| 124 | |||
| 125 | <a class="" href="../Plugins/">Plugins</a> | ||
| 126 | </li> | ||
| 127 | </ul> | ||
| 128 | </li> | ||
| 129 | |||
| 130 | <li class="toctree-l1"> | ||
| 131 | |||
| 132 | <span class="caption-text">Docker</span> | ||
| 133 | <ul class="subnav"> | ||
| 134 | <li class=""> | ||
| 135 | |||
| 136 | <a class="" href="../Docker-101/">Docker 101</a> | ||
| 137 | </li> | ||
| 138 | <li class=""> | ||
| 139 | |||
| 140 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 141 | </li> | ||
| 142 | <li class=""> | ||
| 143 | |||
| 144 | <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a> | ||
| 145 | </li> | ||
| 146 | <li class=""> | ||
| 147 | |||
| 148 | <a class="" href="../Docker-resources/">Docker resources</a> | ||
| 149 | </li> | ||
| 150 | </ul> | ||
| 151 | </li> | ||
| 152 | |||
| 153 | <li class="toctree-l1"> | ||
| 154 | |||
| 155 | <span class="caption-text">Usage</span> | ||
| 156 | <ul class="subnav"> | ||
| 157 | <li class=""> | ||
| 158 | |||
| 159 | <a class="" href="../Features/">Features</a> | ||
| 160 | </li> | ||
| 161 | <li class=""> | ||
| 162 | |||
| 163 | <a class="" href="../Bookmarklet/">Bookmarklet</a> | ||
| 164 | </li> | ||
| 165 | <li class=""> | ||
| 166 | |||
| 167 | <a class="" href="../Browsing-and-searching/">Browsing and searching</a> | ||
| 168 | </li> | ||
| 169 | <li class=""> | ||
| 170 | |||
| 171 | <a class="" href="../Firefox-share/">Firefox share</a> | ||
| 172 | </li> | ||
| 173 | <li class=""> | ||
| 174 | |||
| 175 | <a class="" href="../RSS-feeds/">RSS feeds</a> | ||
| 176 | </li> | ||
| 177 | <li class=""> | ||
| 178 | |||
| 179 | <a class="" href="../REST-API/">REST API</a> | ||
| 180 | </li> | ||
| 181 | </ul> | ||
| 182 | </li> | ||
| 183 | |||
| 184 | <li class="toctree-l1"> | ||
| 185 | |||
| 186 | <span class="caption-text">How To</span> | ||
| 187 | <ul class="subnav"> | ||
| 188 | <li class=""> | ||
| 189 | |||
| 190 | <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a> | ||
| 191 | </li> | ||
| 192 | <li class=""> | ||
| 193 | |||
| 194 | <a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 195 | </li> | ||
| 196 | <li class=""> | ||
| 197 | |||
| 198 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 199 | </li> | ||
| 200 | <li class=""> | ||
| 201 | |||
| 202 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 203 | </li> | ||
| 204 | <li class=""> | ||
| 205 | |||
| 206 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 207 | </li> | ||
| 208 | </ul> | ||
| 209 | </li> | ||
| 210 | |||
| 211 | <li class="toctree-l1"> | ||
| 212 | |||
| 213 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 214 | </li> | ||
| 215 | |||
| 216 | <li class="toctree-l1"> | ||
| 217 | |||
| 218 | <span class="caption-text">Development</span> | ||
| 219 | <ul class="subnav"> | ||
| 220 | <li class=""> | ||
| 221 | |||
| 222 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 223 | </li> | ||
| 224 | <li class=""> | ||
| 225 | |||
| 226 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 227 | </li> | ||
| 228 | <li class=""> | ||
| 229 | |||
| 230 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 231 | </li> | ||
| 232 | <li class=""> | ||
| 233 | |||
| 234 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 235 | </li> | ||
| 236 | <li class=""> | ||
| 237 | |||
| 238 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 239 | </li> | ||
| 240 | <li class=""> | ||
| 241 | |||
| 242 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 243 | </li> | ||
| 244 | <li class=""> | ||
| 245 | |||
| 246 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 247 | </li> | ||
| 248 | <li class=""> | ||
| 249 | |||
| 250 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 251 | </li> | ||
| 252 | <li class=""> | ||
| 253 | |||
| 254 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
| 255 | </li> | ||
| 256 | <li class=""> | ||
| 257 | |||
| 258 | <a class="" href="../Security/">Security</a> | ||
| 259 | </li> | ||
| 260 | <li class=""> | ||
| 261 | |||
| 262 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 263 | </li> | ||
| 264 | <li class=""> | ||
| 265 | |||
| 266 | <a class="" href="../Theming/">Theming</a> | ||
| 267 | </li> | ||
| 268 | <li class=""> | ||
| 269 | |||
| 270 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 271 | </li> | ||
| 272 | </ul> | ||
| 273 | </li> | ||
| 274 | |||
| 275 | <li class="toctree-l1"> | ||
| 276 | |||
| 277 | <span class="caption-text">About</span> | ||
| 278 | <ul class="subnav"> | ||
| 279 | <li class=""> | ||
| 280 | |||
| 281 | <a class="" href="../FAQ/">FAQ</a> | ||
| 282 | </li> | ||
| 283 | <li class=""> | ||
| 284 | |||
| 285 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 286 | </li> | ||
| 287 | </ul> | ||
| 288 | </li> | ||
| 289 | |||
| 290 | </ul> | ||
| 291 | </div> | ||
| 292 | | ||
| 293 | </nav> | ||
| 294 | |||
| 295 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 296 | |||
| 297 | |||
| 298 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 299 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 300 | <a href="..">Shaarli Documentation</a> | ||
| 301 | </nav> | ||
| 302 | |||
| 303 | |||
| 304 | <div class="wy-nav-content"> | ||
| 305 | <div class="rst-content"> | ||
| 306 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 307 | <ul class="wy-breadcrumbs"> | ||
| 308 | <li><a href="..">Docs</a> »</li> | ||
| 309 | |||
| 310 | |||
| 311 | |||
| 312 | <li>Setup »</li> | ||
| 313 | |||
| 314 | |||
| 315 | |||
| 316 | <li>Upgrade and migration</li> | ||
| 317 | <li class="wy-breadcrumbs-aside"> | ||
| 318 | |||
| 319 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Upgrade-and-migration.md" | ||
| 320 | class="icon icon-github"> Edit on GitHub</a> | ||
| 321 | |||
| 322 | </li> | ||
| 323 | </ul> | ||
| 324 | <hr/> | ||
| 325 | </div> | ||
| 326 | <div role="main"> | ||
| 327 | <div class="section"> | ||
| 328 | |||
| 329 | <h2 id="preparation">Preparation</h2> | ||
| 330 | <h3 id="note-your-current-version">Note your current version</h3> | ||
| 331 | <p>If anything goes wrong, it's important for us to know which version you're upgrading from.<br /> | ||
| 332 | The current version is present in the <code>version.php</code> file.</p> | ||
| 333 | <h3 id="backup-your-data">Backup your data</h3> | ||
| 334 | <p>Shaarli stores all user data under the <code>data</code> directory: | ||
| 335 | - <code>data/config.php</code> - main configuration file | ||
| 336 | - <code>data/datastore.php</code> - bookmarked links | ||
| 337 | - <code>data/ipbans.php</code> - banned IP addresses | ||
| 338 | - <code>data/updates.txt</code> - contains all automatic update to the configuration and datastore files already run</p> | ||
| 339 | <p>See <a href="../Shaarli configuration">Shaarli configuration</a> for more information about Shaarli resources.</p> | ||
| 340 | <p>It is recommended to backup this repository <em>before</em> starting updating/upgrading Shaarli: | ||
| 341 | - users with SSH access: copy or archive the directory to a temporary location | ||
| 342 | - users with FTP access: download a local copy of your Shaarli installation using your favourite client</p> | ||
| 343 | <h3 id="migrating-data-from-a-previous-installation">Migrating data from a previous installation</h3> | ||
| 344 | <p>As all user data is kept under <code>data</code>, this is the only directory you need to worry about when migrating to a new installation, which corresponds to the following steps:</p> | ||
| 345 | <ul> | ||
| 346 | <li>backup the <code>data</code> directory</li> | ||
| 347 | <li>install or update Shaarli:<ul> | ||
| 348 | <li>fresh installation - see <a href="../Download and installation">Download and installation</a></li> | ||
| 349 | <li>update - see the following sections</li> | ||
| 350 | </ul> | ||
| 351 | </li> | ||
| 352 | <li>check or restore the <code>data</code> directory</li> | ||
| 353 | </ul> | ||
| 354 | <h2 id="recommended-upgrading-from-release-archives">Recommended : Upgrading from release archives</h2> | ||
| 355 | <p>All tagged revisions can be downloaded as tarballs or ZIP archives from the <a href="https://github.com/shaarli/Shaarli/releases">releases</a> page.</p> | ||
| 356 | <p>We recommend that you use the latest release tarball with the <code>-full</code> suffix. It contains the dependencies, please read <a href="../Download and installation">Download and installation</a> for <code>git</code> complete instructions.</p> | ||
| 357 | <p>Once downloaded, extract the archive locally and update your remote installation (e.g. via FTP) -be sure you keep the content of the <code>data</code> directory!</p> | ||
| 358 | <p>After upgrading, access your fresh Shaarli installation from a web browser; the configuration and data store will then be automatically updated, and new settings added to <code>data/config.json.php</code> (see <a href="../Shaarli configuration">Shaarli configuration</a> for more details).</p> | ||
| 359 | <h2 id="upgrading-with-git">Upgrading with Git</h2> | ||
| 360 | <h3 id="updating-a-community-shaarli">Updating a community Shaarli</h3> | ||
| 361 | <p>If you have installed Shaarli from the <a href="../Download#clone-with-git-recommended">community Git repository</a>, simply <a href="https://www.git-scm.com/docs/git-pull">pull new changes</a> from your local clone:</p> | ||
| 362 | <pre><code class="bash">$ cd /path/to/shaarli | ||
| 363 | $ git pull | ||
| 364 | |||
| 365 | From github.com:shaarli/Shaarli | ||
| 366 | * branch master -> FETCH_HEAD | ||
| 367 | Updating ebd67c6..521f0e6 | ||
| 368 | Fast-forward | ||
| 369 | application/Url.php | 1 + | ||
| 370 | shaarli_version.php | 2 +- | ||
| 371 | tests/Url/UrlTest.php | 1 + | ||
| 372 | 3 files changed, 3 insertions(+), 1 deletion(-) | ||
| 373 | </code></pre> | ||
| 374 | |||
| 375 | <p>Shaarli >= <code>v0.8.x</code>: install/update third-party PHP dependencies using <a href="https://getcomposer.org/">Composer</a>:</p> | ||
| 376 | <pre><code class="bash">$ composer install --no-dev | ||
| 377 | |||
| 378 | Loading composer repositories with package information | ||
| 379 | Updating dependencies | ||
| 380 | - Installing shaarli/netscape-bookmark-parser (v1.0.1) | ||
| 381 | Downloading: 100% | ||
| 382 | </code></pre> | ||
| 383 | |||
| 384 | <h3 id="migrating-and-upgrading-from-sebsauvages-repository">Migrating and upgrading from Sebsauvage's repository</h3> | ||
| 385 | <p>If you have installed Shaarli from <a href="https://github.com/sebsauvage/Shaarli">Sebsauvage's original Git repository</a>, you can use <a href="https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes">Git remotes</a> to update your working copy.</p> | ||
| 386 | <p>The following guide assumes that: | ||
| 387 | - you have a basic knowledge of Git <a href="https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell">branching</a> and <a href="https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes">remote repositories</a> | ||
| 388 | - the default remote is named <code>origin</code> and points to Sebsauvage's repository | ||
| 389 | - the current branch is <code>master</code> | ||
| 390 | - if you have personal branches containing customizations, you will need to <a href="https://git-scm.com/book/en/v2/Git-Branching-Rebasing">rebase them</a> after the upgrade; beware though, a lot of changes have been made since the community fork has been created, so things are very likely to break! | ||
| 391 | - the working copy is clean: | ||
| 392 | - no versioned file has been locally modified | ||
| 393 | - no untracked files are present</p> | ||
| 394 | <h4 id="step-0-show-repository-information">Step 0: show repository information</h4> | ||
| 395 | <pre><code class="bash">$ cd /path/to/shaarli | ||
| 396 | |||
| 397 | $ git remote -v | ||
| 398 | origin https://github.com/sebsauvage/Shaarli (fetch) | ||
| 399 | origin https://github.com/sebsauvage/Shaarli (push) | ||
| 400 | |||
| 401 | $ git branch -vv | ||
| 402 | * master 029f75f [origin/master] Update README.md | ||
| 403 | |||
| 404 | $ git status | ||
| 405 | On branch master | ||
| 406 | Your branch is up-to-date with 'origin/master'. | ||
| 407 | nothing to commit, working directory clean | ||
| 408 | </code></pre> | ||
| 409 | |||
| 410 | <h4 id="step-1-update-git-remotes">Step 1: update Git remotes</h4> | ||
| 411 | <pre><code>$ git remote rename origin sebsauvage | ||
| 412 | $ git remote -v | ||
| 413 | sebsauvage https://github.com/sebsauvage/Shaarli (fetch) | ||
| 414 | sebsauvage https://github.com/sebsauvage/Shaarli (push) | ||
| 415 | |||
| 416 | $ git remote add origin https://github.com/shaarli/Shaarli | ||
| 417 | $ git fetch origin | ||
| 418 | |||
| 419 | remote: Counting objects: 3015, done. | ||
| 420 | remote: Compressing objects: 100% (19/19), done. | ||
| 421 | remote: Total 3015 (delta 446), reused 457 (delta 446), pack-reused 2550 | ||
| 422 | Receiving objects: 100% (3015/3015), 2.59 MiB | 918.00 KiB/s, done. | ||
| 423 | Resolving deltas: 100% (1899/1899), completed with 48 local objects. | ||
| 424 | From https://github.com/shaarli/Shaarli | ||
| 425 | * [new branch] master -> origin/master | ||
| 426 | * [new branch] stable -> origin/stable | ||
| 427 | [...] | ||
| 428 | * [new tag] v0.6.4 -> v0.6.4 | ||
| 429 | * [new tag] v0.7.0 -> v0.7.0 | ||
| 430 | </code></pre> | ||
| 431 | |||
| 432 | <h4 id="step-2-use-the-stable-community-branch">Step 2: use the stable community branch</h4> | ||
| 433 | <pre><code class="bash">$ git checkout origin/stable -b stable | ||
| 434 | Branch stable set up to track remote branch stable from origin. | ||
| 435 | Switched to a new branch 'stable' | ||
| 436 | |||
| 437 | $ git branch -vv | ||
| 438 | master 029f75f [sebsauvage/master] Update README.md | ||
| 439 | * stable 890afc3 [origin/stable] Merge pull request #509 from ArthurHoaro/v0.6.5 | ||
| 440 | </code></pre> | ||
| 441 | |||
| 442 | <p>Shaarli >= <code>v0.8.x</code>: install/update third-party PHP dependencies using <a href="https://getcomposer.org/">Composer</a>:</p> | ||
| 443 | <pre><code class="bash">$ composer install --no-dev | ||
| 444 | |||
| 445 | Loading composer repositories with package information | ||
| 446 | Updating dependencies | ||
| 447 | - Installing shaarli/netscape-bookmark-parser (v1.0.1) | ||
| 448 | Downloading: 100% | ||
| 449 | </code></pre> | ||
| 450 | |||
| 451 | <p>Optionally, you can delete information related to the legacy version:</p> | ||
| 452 | <pre><code class="bash">$ git branch -D master | ||
| 453 | Deleted branch master (was 029f75f). | ||
| 454 | |||
| 455 | $ git remote remove sebsauvage | ||
| 456 | |||
| 457 | $ git remote -v | ||
| 458 | origin https://github.com/shaarli/Shaarli (fetch) | ||
| 459 | origin https://github.com/shaarli/Shaarli (push) | ||
| 460 | |||
| 461 | $ git gc | ||
| 462 | Counting objects: 3317, done. | ||
| 463 | Delta compression using up to 8 threads. | ||
| 464 | Compressing objects: 100% (1237/1237), done. | ||
| 465 | Writing objects: 100% (3317/3317), done. | ||
| 466 | Total 3317 (delta 2050), reused 3301 (delta 2034)to | ||
| 467 | </code></pre> | ||
| 468 | |||
| 469 | <h4 id="step-3-configuration">Step 3: configuration</h4> | ||
| 470 | <p>After migrating, access your fresh Shaarli installation from a web browser; the configuration will then be automatically updated, and new settings added to <code>data/config.php</code> (see <a href="../Shaarli configuration">Shaarli configuration</a> for more details).</p> | ||
| 471 | <h2 id="troubleshooting">Troubleshooting</h2> | ||
| 472 | <p>If the solutions provided here doesn't work, please open an issue specifying which version you're upgrading from and to.</p> | ||
| 473 | <h3 id="you-must-specify-an-integer-as-a-key">You must specify an integer as a key</h3> | ||
| 474 | <p>In <code>v0.8.1</code> we changed how link keys are handled (from timestamps to incremental integers). | ||
| 475 | Take a look at <code>data/updates.txt</code> content.</p> | ||
| 476 | <h4 id="updatestxt-contains-updatemethoddatastoreids"><code>updates.txt</code> contains <code>updateMethodDatastoreIds</code></h4> | ||
| 477 | <p>Try to delete it and refresh your page while being logged in.</p> | ||
| 478 | <h4 id="updatestxt-doesnt-exists-or-doesnt-contain-updatemethoddatastoreids"><code>updates.txt</code> doesn't exists or doesn't contain <code>updateMethodDatastoreIds</code></h4> | ||
| 479 | <ol> | ||
| 480 | <li>Create <code>data/updates.txt</code> if it doesn't exist.</li> | ||
| 481 | <li>Paste this string in the update file <code>;updateMethodRenameDashTags;</code></li> | ||
| 482 | <li>Login to Shaarli.</li> | ||
| 483 | <li>Delete the update file.</li> | ||
| 484 | <li>Refresh.</li> | ||
| 485 | </ol> | ||
| 486 | |||
| 487 | </div> | ||
| 488 | </div> | ||
| 489 | <footer> | ||
| 490 | |||
| 491 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 492 | |||
| 493 | <a href="../Server-requirements/" class="btn btn-neutral float-right" title="Server requirements">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 494 | |||
| 495 | |||
| 496 | <a href="../Download-and-Installation/" class="btn btn-neutral" title="Download and Installation"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 497 | |||
| 498 | </div> | ||
| 499 | |||
| 500 | |||
| 501 | <hr/> | ||
| 502 | |||
| 503 | <div role="contentinfo"> | ||
| 504 | <!-- Copyright etc --> | ||
| 505 | |||
| 506 | </div> | ||
| 507 | |||
| 508 | 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>. | ||
| 509 | </footer> | ||
| 510 | |||
| 511 | </div> | ||
| 512 | </div> | ||
| 513 | |||
| 514 | </section> | ||
| 515 | |||
| 516 | </div> | ||
| 517 | |||
| 518 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 519 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 520 | |||
| 521 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 522 | |||
| 523 | |||
| 524 | <span><a href="../Download-and-Installation/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 525 | |||
| 526 | |||
| 527 | <span style="margin-left: 15px"><a href="../Server-requirements/" style="color: #fcfcfc">Next »</a></span> | ||
| 528 | |||
| 529 | </span> | ||
| 530 | </div> | ||
| 531 | <script src="../js/theme.js"></script> | ||
| 532 | |||
| 533 | </body> | ||
| 534 | </html> | ||
diff --git a/doc/html/Versioning-and-Branches/index.html b/doc/html/Versioning-and-Branches/index.html new file mode 100644 index 00000000..406ad7f9 --- /dev/null +++ b/doc/html/Versioning-and-Branches/index.html | |||
| @@ -0,0 +1,418 @@ | |||
| 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>Versioning and Branches - 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 = "Versioning and Branches"; | ||
| 22 | var mkdocs_page_input_path = "Versioning-and-Branches.md"; | ||
| 23 | var mkdocs_page_url = "/Versioning-and-Branches/"; | ||
| 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-101/">Docker 101</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="../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="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 156 | </li> | ||
| 157 | <li class=""> | ||
| 158 | |||
| 159 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 160 | </li> | ||
| 161 | <li class=""> | ||
| 162 | |||
| 163 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 164 | </li> | ||
| 165 | <li class=""> | ||
| 166 | |||
| 167 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
| 168 | </li> | ||
| 169 | </ul> | ||
| 170 | </li> | ||
| 171 | |||
| 172 | <li class="toctree-l1"> | ||
| 173 | |||
| 174 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
| 175 | </li> | ||
| 176 | |||
| 177 | <li class="toctree-l1"> | ||
| 178 | |||
| 179 | <span class="caption-text">Development</span> | ||
| 180 | <ul class="subnav"> | ||
| 181 | <li class=""> | ||
| 182 | |||
| 183 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
| 184 | </li> | ||
| 185 | <li class=""> | ||
| 186 | |||
| 187 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
| 188 | </li> | ||
| 189 | <li class=""> | ||
| 190 | |||
| 191 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
| 192 | </li> | ||
| 193 | <li class=""> | ||
| 194 | |||
| 195 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
| 196 | </li> | ||
| 197 | <li class=""> | ||
| 198 | |||
| 199 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
| 200 | </li> | ||
| 201 | <li class=""> | ||
| 202 | |||
| 203 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
| 204 | </li> | ||
| 205 | <li class=""> | ||
| 206 | |||
| 207 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
| 208 | </li> | ||
| 209 | <li class=""> | ||
| 210 | |||
| 211 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
| 212 | </li> | ||
| 213 | <li class=" current"> | ||
| 214 | |||
| 215 | <a class="current" href="./">Versioning and Branches</a> | ||
| 216 | <ul class="subnav"> | ||
| 217 | |||
| 218 | <li class="toctree-l3"><a href="#master-branch">master branch</a></li> | ||
| 219 | |||
| 220 | |||
| 221 | <li class="toctree-l3"><a href="#v0x-branch">v0.x branch</a></li> | ||
| 222 | |||
| 223 | |||
| 224 | <li class="toctree-l3"><a href="#latest-branch">latest branch</a></li> | ||
| 225 | |||
| 226 | |||
| 227 | <li class="toctree-l3"><a href="#stable-branch">stable branch</a></li> | ||
| 228 | |||
| 229 | |||
| 230 | <li class="toctree-l3"><a href="#releases">Releases</a></li> | ||
| 231 | |||
| 232 | |||
| 233 | <li class="toctree-l3"><a href="#advices-on-3rd-party-git-repos-workflow">Advices on 3rd party git repos workflow</a></li> | ||
| 234 | |||
| 235 | <ul> | ||
| 236 | |||
| 237 | <li><a class="toctree-l4" href="#versioning">Versioning</a></li> | ||
| 238 | |||
| 239 | <li><a class="toctree-l4" href="#major-bugfix-backport-releases">Major bugfix backport releases</a></li> | ||
| 240 | |||
| 241 | </ul> | ||
| 242 | |||
| 243 | |||
| 244 | </ul> | ||
| 245 | </li> | ||
| 246 | <li class=""> | ||
| 247 | |||
| 248 | <a class="" href="../Security/">Security</a> | ||
| 249 | </li> | ||
| 250 | <li class=""> | ||
| 251 | |||
| 252 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
| 253 | </li> | ||
| 254 | <li class=""> | ||
| 255 | |||
| 256 | <a class="" href="../Theming/">Theming</a> | ||
| 257 | </li> | ||
| 258 | <li class=""> | ||
| 259 | |||
| 260 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
| 261 | </li> | ||
| 262 | </ul> | ||
| 263 | </li> | ||
| 264 | |||
| 265 | <li class="toctree-l1"> | ||
| 266 | |||
| 267 | <span class="caption-text">About</span> | ||
| 268 | <ul class="subnav"> | ||
| 269 | <li class=""> | ||
| 270 | |||
| 271 | <a class="" href="../FAQ/">FAQ</a> | ||
| 272 | </li> | ||
| 273 | <li class=""> | ||
| 274 | |||
| 275 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
| 276 | </li> | ||
| 277 | </ul> | ||
| 278 | </li> | ||
| 279 | |||
| 280 | </ul> | ||
| 281 | </div> | ||
| 282 | | ||
| 283 | </nav> | ||
| 284 | |||
| 285 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 286 | |||
| 287 | |||
| 288 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 289 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 290 | <a href="..">Shaarli Documentation</a> | ||
| 291 | </nav> | ||
| 292 | |||
| 293 | |||
| 294 | <div class="wy-nav-content"> | ||
| 295 | <div class="rst-content"> | ||
| 296 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 297 | <ul class="wy-breadcrumbs"> | ||
| 298 | <li><a href="..">Docs</a> »</li> | ||
| 299 | |||
| 300 | |||
| 301 | |||
| 302 | <li>Development »</li> | ||
| 303 | |||
| 304 | |||
| 305 | |||
| 306 | <li>Versioning and Branches</li> | ||
| 307 | <li class="wy-breadcrumbs-aside"> | ||
| 308 | |||
| 309 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Versioning-and-Branches.md" | ||
| 310 | class="icon icon-github"> Edit on GitHub</a> | ||
| 311 | |||
| 312 | </li> | ||
| 313 | </ul> | ||
| 314 | <hr/> | ||
| 315 | </div> | ||
| 316 | <div role="main"> | ||
| 317 | <div class="section"> | ||
| 318 | |||
| 319 | <p><strong>WORK IN PROGRESS</strong></p> | ||
| 320 | <p>It's important to understand how Shaarli branches work, especially if you're maintaining a 3rd party tools for Shaarli (theme, plugin, etc.), to be sure stay compatible.</p> | ||
| 321 | <h2 id="master-branch"><code>master</code> branch</h2> | ||
| 322 | <p>The <code>master</code> branch is the development branch. Any new change MUST go through this branch using Pull Requests.</p> | ||
| 323 | <p>Remarks:</p> | ||
| 324 | <ul> | ||
| 325 | <li>This branch shouldn't be used for production as it isn't necessary stable.</li> | ||
| 326 | <li>3rd party aren't required to be compatible with the latest changes.</li> | ||
| 327 | <li>Official plugins, themes and libraries (contained within Shaarli organization repos) must be compatible with the master branch.</li> | ||
| 328 | <li>The version in this branch is always <code>dev</code>.</li> | ||
| 329 | </ul> | ||
| 330 | <h2 id="v0x-branch"><code>v0.x</code> branch</h2> | ||
| 331 | <p>This <code>v0.x</code> branch, points to the latest <code>v0.x.y</code> release.</p> | ||
| 332 | <p>Explanation:</p> | ||
| 333 | <p>When a new version is released, it might contains a major bug which isn't detected right away. For example, a new PHP version is released, containing backward compatibility issue which doesn't work with Shaarli.</p> | ||
| 334 | <p>In this case, the issue is fixed in the <code>master</code> branch, and the fix is backported the to the <code>v0.x</code> branch. Then a new release is made from the <code>v0.x</code> branch.</p> | ||
| 335 | <p>This workflow allow us to fix any major bug detected, without having to release bleeding edge feature too soon.</p> | ||
| 336 | <h2 id="latest-branch"><code>latest</code> branch</h2> | ||
| 337 | <p>This branch point the latest release. It recommended to use it to get the latest tested changes.</p> | ||
| 338 | <h2 id="stable-branch"><code>stable</code> branch</h2> | ||
| 339 | <p>The <code>stable</code> branch doesn't contain any major bug, and is one major digit version behind the latest release.</p> | ||
| 340 | <p>For example, the current latest release is <code>v0.8.3</code>, the stable branch is an alias to the latest <code>v0.7.x</code> release. When the <code>v0.9.0</code> version will be released, the stable will move to the latest <code>v0.8.x</code> release.</p> | ||
| 341 | <p>Remarks:</p> | ||
| 342 | <ul> | ||
| 343 | <li>Shaarli release pace isn't fast, and the stable branch might be a few months behind the latest release.</li> | ||
| 344 | </ul> | ||
| 345 | <h2 id="releases">Releases</h2> | ||
| 346 | <p>Releases are always made from the latest <code>v0.x</code> branch.</p> | ||
| 347 | <p>Note that for every release, we manually generate a tarball which contains all Shaarli dependencies, making Shaarli's installation only one step.</p> | ||
| 348 | <h2 id="advices-on-3rd-party-git-repos-workflow">Advices on 3rd party git repos workflow</h2> | ||
| 349 | <h3 id="versioning">Versioning</h3> | ||
| 350 | <p>Any time a new Shaarli release is published, you should publish a new release of your repo if the changes affected you since the latest release (take a look at the <a href="https://github.com/shaarli/Shaarli/releases">changelog</a> (<em>Draft</em> means not released yet) and the commit log (like <a href="https://github.com/shaarli/Shaarli/commits/master/tpl/default"><code>tpl</code> folder</a> for themes)). You can either:</p> | ||
| 351 | <ul> | ||
| 352 | <li>use the Shaarli version number, with your repo version. For example, if Shaarli <code>v0.8.3</code> is released, publish a <code>v0.8.3-1</code> release, where <code>v0.8.3</code> states Shaarli compatibility and <code>-1</code> is your own version digit for the current Shaarli version.</li> | ||
| 353 | <li>use your own versioning scheme, and state Shaarli compatibility in the release description.</li> | ||
| 354 | </ul> | ||
| 355 | <p>Using this, any user will be able to pick the release matching his own Shaarli version.</p> | ||
| 356 | <h3 id="major-bugfix-backport-releases">Major bugfix backport releases</h3> | ||
| 357 | <p>To be able to support backported fixes, it recommended to use our workflow:</p> | ||
| 358 | <pre><code class="bash"># In master, fix the major bug | ||
| 359 | git commit -m "Katastrophe" | ||
| 360 | git push origin master | ||
| 361 | # Get your commit hash | ||
| 362 | git log --format="%H" -n 1 | ||
| 363 | # Create a new branch from your latest release, let's say v0.8.2-1 (the tag name) | ||
| 364 | git checkout -b katastrophe v0.8.2-1 | ||
| 365 | # Backport the fix commit to your brand new branch | ||
| 366 | git cherry-pick <fix commit hash> | ||
| 367 | git push origin katastrophe | ||
| 368 | # Then you just have to make a new release from the `katastrophe` branch tagged `v0.8.3-1` | ||
| 369 | </code></pre> | ||
| 370 | |||
| 371 | </div> | ||
| 372 | </div> | ||
| 373 | <footer> | ||
| 374 | |||
| 375 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 376 | |||
| 377 | <a href="../Security/" class="btn btn-neutral float-right" title="Security">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 378 | |||
| 379 | |||
| 380 | <a href="../Release-Shaarli/" class="btn btn-neutral" title="Release Shaarli"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| 381 | |||
| 382 | </div> | ||
| 383 | |||
| 384 | |||
| 385 | <hr/> | ||
| 386 | |||
| 387 | <div role="contentinfo"> | ||
| 388 | <!-- Copyright etc --> | ||
| 389 | |||
| 390 | </div> | ||
| 391 | |||
| 392 | 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>. | ||
| 393 | </footer> | ||
| 394 | |||
| 395 | </div> | ||
| 396 | </div> | ||
| 397 | |||
| 398 | </section> | ||
| 399 | |||
| 400 | </div> | ||
| 401 | |||
| 402 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 403 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 404 | |||
| 405 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 406 | |||
| 407 | |||
| 408 | <span><a href="../Release-Shaarli/" style="color: #fcfcfc;">« Previous</a></span> | ||
| 409 | |||
| 410 | |||
| 411 | <span style="margin-left: 15px"><a href="../Security/" style="color: #fcfcfc">Next »</a></span> | ||
| 412 | |||
| 413 | </span> | ||
| 414 | </div> | ||
| 415 | <script src="../js/theme.js"></script> | ||
| 416 | |||
| 417 | </body> | ||
| 418 | </html> | ||
diff --git a/doc/config.json b/doc/html/config.json index cc4de307..cc4de307 100644 --- a/doc/config.json +++ b/doc/html/config.json | |||
diff --git a/doc/html/css/highlight.css b/doc/html/css/highlight.css new file mode 100644 index 00000000..0ae40a72 --- /dev/null +++ b/doc/html/css/highlight.css | |||
| @@ -0,0 +1,124 @@ | |||
| 1 | /* | ||
| 2 | This is the GitHub theme for highlight.js | ||
| 3 | |||
| 4 | github.com style (c) Vasily Polovnyov <vast@whiteants.net> | ||
| 5 | |||
| 6 | */ | ||
| 7 | |||
| 8 | .hljs { | ||
| 9 | display: block; | ||
| 10 | overflow-x: auto; | ||
| 11 | color: #333; | ||
| 12 | -webkit-text-size-adjust: none; | ||
| 13 | } | ||
| 14 | |||
| 15 | .hljs-comment, | ||
| 16 | .diff .hljs-header, | ||
| 17 | .hljs-javadoc { | ||
| 18 | color: #998; | ||
| 19 | font-style: italic; | ||
| 20 | } | ||
| 21 | |||
| 22 | .hljs-keyword, | ||
| 23 | .css .rule .hljs-keyword, | ||
| 24 | .hljs-winutils, | ||
| 25 | .nginx .hljs-title, | ||
| 26 | .hljs-subst, | ||
| 27 | .hljs-request, | ||
| 28 | .hljs-status { | ||
| 29 | color: #333; | ||
| 30 | font-weight: bold; | ||
| 31 | } | ||
| 32 | |||
| 33 | .hljs-number, | ||
| 34 | .hljs-hexcolor, | ||
| 35 | .ruby .hljs-constant { | ||
| 36 | color: #008080; | ||
| 37 | } | ||
| 38 | |||
| 39 | .hljs-string, | ||
| 40 | .hljs-tag .hljs-value, | ||
| 41 | .hljs-phpdoc, | ||
| 42 | .hljs-dartdoc, | ||
| 43 | .tex .hljs-formula { | ||
| 44 | color: #d14; | ||
| 45 | } | ||
| 46 | |||
| 47 | .hljs-title, | ||
| 48 | .hljs-id, | ||
| 49 | .scss .hljs-preprocessor { | ||
| 50 | color: #900; | ||
| 51 | font-weight: bold; | ||
| 52 | } | ||
| 53 | |||
| 54 | .hljs-list .hljs-keyword, | ||
| 55 | .hljs-subst { | ||
| 56 | font-weight: normal; | ||
| 57 | } | ||
| 58 | |||
| 59 | .hljs-class .hljs-title, | ||
| 60 | .hljs-type, | ||
| 61 | .vhdl .hljs-literal, | ||
| 62 | .tex .hljs-command { | ||
| 63 | color: #458; | ||
| 64 | font-weight: bold; | ||
| 65 | } | ||
| 66 | |||
| 67 | .hljs-tag, | ||
| 68 | .hljs-tag .hljs-title, | ||
| 69 | .hljs-rule .hljs-property, | ||
| 70 | .django .hljs-tag .hljs-keyword { | ||
| 71 | color: #000080; | ||
| 72 | font-weight: normal; | ||
| 73 | } | ||
| 74 | |||
| 75 | .hljs-attribute, | ||
| 76 | .hljs-variable, | ||
| 77 | .lisp .hljs-body, | ||
| 78 | .hljs-name { | ||
| 79 | color: #008080; | ||
| 80 | } | ||
| 81 | |||
| 82 | .hljs-regexp { | ||
| 83 | color: #009926; | ||
| 84 | } | ||
| 85 | |||
| 86 | .hljs-symbol, | ||
| 87 | .ruby .hljs-symbol .hljs-string, | ||
| 88 | .lisp .hljs-keyword, | ||
| 89 | .clojure .hljs-keyword, | ||
| 90 | .scheme .hljs-keyword, | ||
| 91 | .tex .hljs-special, | ||
| 92 | .hljs-prompt { | ||
| 93 | color: #990073; | ||
| 94 | } | ||
| 95 | |||
| 96 | .hljs-built_in { | ||
| 97 | color: #0086b3; | ||
| 98 | } | ||
| 99 | |||
| 100 | .hljs-preprocessor, | ||
| 101 | .hljs-pragma, | ||
| 102 | .hljs-pi, | ||
| 103 | .hljs-doctype, | ||
| 104 | .hljs-shebang, | ||
| 105 | .hljs-cdata { | ||
| 106 | color: #999; | ||
| 107 | font-weight: bold; | ||
| 108 | } | ||
| 109 | |||
| 110 | .hljs-deletion { | ||
| 111 | background: #fdd; | ||
| 112 | } | ||
| 113 | |||
| 114 | .hljs-addition { | ||
| 115 | background: #dfd; | ||
| 116 | } | ||
| 117 | |||
| 118 | .diff .hljs-change { | ||
| 119 | background: #0086b3; | ||
| 120 | } | ||
| 121 | |||
| 122 | .hljs-chunk { | ||
| 123 | color: #aaa; | ||
| 124 | } | ||
diff --git a/doc/html/css/theme.css b/doc/html/css/theme.css new file mode 100644 index 00000000..099a2d82 --- /dev/null +++ b/doc/html/css/theme.css | |||
| @@ -0,0 +1,12 @@ | |||
| 1 | /* | ||
| 2 | * This file is copied from the upstream ReadTheDocs Sphinx | ||
| 3 | * theme. To aid upgradability this file should *not* be edited. | ||
| 4 | * modifications we need should be included in theme_extra.css. | ||
| 5 | * | ||
| 6 | * https://github.com/rtfd/readthedocs.org/blob/master/readthedocs/core/static/core/css/theme.css | ||
| 7 | */ | ||
| 8 | |||
| 9 | *{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}audio:not([controls]){display:none}[hidden]{display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:hover,a:active{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:bold}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;color:#000;text-decoration:none}mark{background:#ff0;color:#000;font-style:italic;font-weight:bold}pre,code,.rst-content tt,kbd,samp{font-family:monospace,serif;_font-family:"courier new",monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:before,q:after{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-0.5em}sub{bottom:-0.25em}ul,ol,dl{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure{margin:0}form{margin:0}fieldset{border:0;margin:0;padding:0}label{cursor:pointer}legend{border:0;*margin-left:-7px;padding:0;white-space:normal}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type="button"],input[type="reset"],input[type="submit"]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0;*width:13px;*height:13px}input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}input[type="search"]::-webkit-search-decoration,input[type="search"]::-webkit-search-cancel-button{-webkit-appearance:none}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}textarea{overflow:auto;vertical-align:top;resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:0.2em 0;background:#ccc;color:#000;padding:0.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none !important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{html,body,section{background:none !important}*{box-shadow:none !important;text-shadow:none !important;filter:none !important;-ms-filter:none !important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h2,h3{page-break-after:avoid}}.fa:before,.rst-content .admonition-title:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content dl dt .headerlink:before,.icon:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-alert,.rst-content .note,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .warning,.rst-content .seealso,.rst-content .admonition-todo,.btn,input[type="text"],input[type="password"],input[type="email"],input[type="url"],input[type="date"],input[type="month"],input[type="time"],input[type="datetime"],input[type="datetime-local"],input[type="week"],input[type="number"],input[type="search"],input[type="tel"],input[type="color"],select,textarea,.wy-menu-vertical li.on a,.wy-menu-vertical li.current>a,.wy-side-nav-search>a,.wy-side-nav-search .wy-dropdown>a,.wy-nav-top a{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}/*! | ||
| 10 | * Font Awesome 4.1.0 by @davegandy - http://fontawesome.io - @fontawesome | ||
| 11 | * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) | ||
| 12 | */@font-face{font-family:'FontAwesome';src:url("../fonts/fontawesome-webfont.eot?v=4.1.0");src:url("../fonts/fontawesome-webfont.eot?#iefix&v=4.1.0") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff?v=4.1.0") format("woff"),url("../fonts/fontawesome-webfont.ttf?v=4.1.0") format("truetype"),url("../fonts/fontawesome-webfont.svg?v=4.1.0#fontawesomeregular") format("svg");font-weight:normal;font-style:normal}.fa,.rst-content .admonition-title,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.icon{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:0.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:0.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:solid 0.08em #eee;border-radius:.1em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.rst-content .pull-left.admonition-title,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content dl dt .pull-left.headerlink,.pull-left.icon{margin-right:.3em}.fa.pull-right,.rst-content .pull-right.admonition-title,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content dl dt .pull-right.headerlink,.pull-right.icon{margin-left:.3em}.fa-spin{-webkit-animation:spin 2s infinite linear;-moz-animation:spin 2s infinite linear;-o-animation:spin 2s infinite linear;animation:spin 2s infinite linear}@-moz-keyframes spin{0%{-moz-transform:rotate(0deg)}100%{-moz-transform:rotate(359deg)}}@-webkit-keyframes spin{0%{-webkit-transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg)}}@-o-keyframes spin{0%{-o-transform:rotate(0deg)}100%{-o-transform:rotate(359deg)}}@keyframes spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=1);-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=2);-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=3);-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=0);-webkit-transform:scale(-1, 1);-moz-transform:scale(-1, 1);-ms-transform:scale(-1, 1);-o-transform:scale(-1, 1);transform:scale(-1, 1)}.fa-flip-vertical{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=2);-webkit-transform:scale(1, -1);-moz-transform:scale(1, -1);-ms-transform:scale(1, -1);-o-transform:scale(1, -1);transform:scale(1, -1)}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-gear:before,.fa-cog:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-rotate-right:before,.fa-repeat:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-photo:before,.fa-image:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.rst-content .admonition-title:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-warning:before,.fa-exclamation-triangle:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-gears:before,.fa-cogs:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-save:before,.fa-floppy-o:before{content:""}.fa-square:before{content:""}.fa-navicon:before,.fa-reorder:before,.fa-bars:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.wy-dropdown .caret:before,.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-unsorted:before,.fa-sort:before{content:""}.fa-sort-down:before,.fa-sort-desc:before{content:""}.fa-sort-up:before,.fa-sort-asc:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-legal:before,.fa-gavel:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-flash:before,.fa-bolt:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-paste:before,.fa-clipboard:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-unlink:before,.fa-chain-broken:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-toggle-down:before,.fa-caret-square-o-down:before{content:""}.fa-toggle-up:before,.fa-caret-square-o-up:before{content:""}.fa-toggle-right:before,.fa-caret-square-o-right:before{content:""}.fa-euro:before,.fa-eur:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-rupee:before,.fa-inr:before{content:""}.fa-cny:before,.fa-rmb:before,.fa-yen:before,.fa-jpy:before{content:""}.fa-ruble:before,.fa-rouble:before,.fa-rub:before{content:""}.fa-won:before,.fa-krw:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-toggle-left:before,.fa-caret-square-o-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-turkish-lira:before,.fa-try:before{content:""}.fa-plus-square-o:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-institution:before,.fa-bank:before,.fa-university:before{content:""}.fa-mortar-board:before,.fa-graduation-cap:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-square:before,.fa-pied-piper:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-photo-o:before,.fa-file-picture-o:before,.fa-file-image-o:before{content:""}.fa-file-zip-o:before,.fa-file-archive-o:before{content:""}.fa-file-sound-o:before,.fa-file-audio-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-saver:before,.fa-support:before,.fa-life-ring:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before{content:""}.fa-ge:before,.fa-empire:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-send:before,.fa-paper-plane:before{content:""}.fa-send-o:before,.fa-paper-plane-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa,.rst-content .admonition-title,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.icon,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context{font-family:inherit}.fa:before,.rst-content .admonition-title:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content dl dt .headerlink:before,.icon:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before{font-family:"FontAwesome";display:inline-block;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa,a .rst-content .admonition-title,.rst-content a .admonition-title,a .rst-content h1 .headerlink,.rst-content h1 a .headerlink,a .rst-content h2 .headerlink,.rst-content h2 a .headerlink,a .rst-content h3 .headerlink,.rst-content h3 a .headerlink,a .rst-content h4 .headerlink,.rst-content h4 a .headerlink,a .rst-content h5 .headerlink,.rst-content h5 a .headerlink,a .rst-content h6 .headerlink,.rst-content h6 a .headerlink,a .rst-content dl dt .headerlink,.rst-content dl dt a .headerlink,a .icon{display:inline-block;text-decoration:inherit}.btn .fa,.btn .rst-content .admonition-title,.rst-content .btn .admonition-title,.btn .rst-content h1 .headerlink,.rst-content h1 .btn .headerlink,.btn .rst-content h2 .headerlink,.rst-content h2 .btn .headerlink,.btn .rst-content h3 .headerlink,.rst-content h3 .btn .headerlink,.btn .rst-content h4 .headerlink,.rst-content h4 .btn .headerlink,.btn .rst-content h5 .headerlink,.rst-content h5 .btn .headerlink,.btn .rst-content h6 .headerlink,.rst-content h6 .btn .headerlink,.btn .rst-content dl dt .headerlink,.rst-content dl dt .btn .headerlink,.btn .icon,.nav .fa,.nav .rst-content .admonition-title,.rst-content .nav .admonition-title,.nav .rst-content h1 .headerlink,.rst-content h1 .nav .headerlink,.nav .rst-content h2 .headerlink,.rst-content h2 .nav .headerlink,.nav .rst-content h3 .headerlink,.rst-content h3 .nav .headerlink,.nav .rst-content h4 .headerlink,.rst-content h4 .nav .headerlink,.nav .rst-content h5 .headerlink,.rst-content h5 .nav .headerlink,.nav .rst-content h6 .headerlink,.rst-content h6 .nav .headerlink,.nav .rst-content dl dt .headerlink,.rst-content dl dt .nav .headerlink,.nav .icon{display:inline}.btn .fa.fa-large,.btn .rst-content .fa-large.admonition-title,.rst-content .btn .fa-large.admonition-title,.btn .rst-content h1 .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.btn .rst-content dl dt .fa-large.headerlink,.rst-content dl dt .btn .fa-large.headerlink,.btn .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .fa-large.admonition-title,.rst-content .nav .fa-large.admonition-title,.nav .rst-content h1 .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.nav .rst-content dl dt .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.nav .fa-large.icon{line-height:0.9em}.btn .fa.fa-spin,.btn .rst-content .fa-spin.admonition-title,.rst-content .btn .fa-spin.admonition-title,.btn .rst-content h1 .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.btn .rst-content dl dt .fa-spin.headerlink,.rst-content dl dt .btn .fa-spin.headerlink,.btn .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .fa-spin.admonition-title,.rst-content .nav .fa-spin.admonition-title,.nav .rst-content h1 .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.nav .rst-content dl dt .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.nav .fa-spin.icon{display:inline-block}.btn.fa:before,.rst-content .btn.admonition-title:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content dl dt .btn.headerlink:before,.btn.icon:before{opacity:0.5;-webkit-transition:opacity 0.05s ease-in;-moz-transition:opacity 0.05s ease-in;transition:opacity 0.05s ease-in}.btn.fa:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.btn.icon:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .rst-content .admonition-title:before,.rst-content .btn-mini .admonition-title:before,.btn-mini .rst-content h1 .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.btn-mini .rst-content dl dt .headerlink:before,.rst-content dl dt .btn-mini .headerlink:before,.btn-mini .icon:before{font-size:14px;vertical-align:-15%}.wy-alert,.rst-content .note,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .warning,.rst-content .seealso,.rst-content .admonition-todo{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.wy-alert-title,.rst-content .admonition-title{color:#fff;font-weight:bold;display:block;color:#fff;background:#6ab0de;margin:-12px;padding:6px 12px;margin-bottom:12px}.wy-alert.wy-alert-danger,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.admonition-todo{background:#fdf3f2}.wy-alert.wy-alert-danger .wy-alert-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .danger .wy-alert-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .danger .admonition-title,.rst-content .error .admonition-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title{background:#f29f97}.wy-alert.wy-alert-warning,.rst-content .wy-alert-warning.note,.rst-content .attention,.rst-content .caution,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.tip,.rst-content .warning,.rst-content .wy-alert-warning.seealso,.rst-content .admonition-todo{background:#ffedcc}.wy-alert.wy-alert-warning .wy-alert-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .attention .wy-alert-title,.rst-content .caution .wy-alert-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .admonition-todo .wy-alert-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .attention .admonition-title,.rst-content .caution .admonition-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .warning .admonition-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .admonition-todo .admonition-title{background:#f0b37e}.wy-alert.wy-alert-info,.rst-content .note,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.rst-content .seealso,.rst-content .wy-alert-info.admonition-todo{background:#e7f2fa}.wy-alert.wy-alert-info .wy-alert-title,.rst-content .note .wy-alert-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.rst-content .note .admonition-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .seealso .admonition-title,.rst-content .wy-alert-info.admonition-todo .admonition-title{background:#6ab0de}.wy-alert.wy-alert-success,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.warning,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.admonition-todo{background:#dbfaf4}.wy-alert.wy-alert-success .wy-alert-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .hint .wy-alert-title,.rst-content .important .wy-alert-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .hint .admonition-title,.rst-content .important .admonition-title,.rst-content .tip .admonition-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.admonition-todo .admonition-title{background:#1abc9c}.wy-alert.wy-alert-neutral,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.admonition-todo{background:#f3f6f6}.wy-alert.wy-alert-neutral .wy-alert-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .admonition-title{color:#404040;background:#e1e4e5}.wy-alert.wy-alert-neutral a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.admonition-todo a{color:#2980B9}.wy-alert p:last-child,.rst-content .note p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.rst-content .seealso p:last-child,.rst-content .admonition-todo p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0px;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,0.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all 0.3s ease-in;-moz-transition:all 0.3s ease-in;transition:all 0.3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27AE60}.wy-tray-container li.wy-tray-item-info{background:#2980B9}.wy-tray-container li.wy-tray-item-warning{background:#E67E22}.wy-tray-container li.wy-tray-item-danger{background:#E74C3C}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width: 768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px 12px;color:#fff;border:1px solid rgba(0,0,0,0.1);background-color:#27AE60;text-decoration:none;font-weight:normal;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;box-shadow:0px 1px 2px -1px rgba(255,255,255,0.5) inset,0px -2px 0px 0px rgba(0,0,0,0.1) inset;outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all 0.1s linear;-moz-transition:all 0.1s linear;transition:all 0.1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:0px -1px 0px 0px rgba(0,0,0,0.05) inset,0px 2px 0px 0px rgba(0,0,0,0.1) inset;padding:8px 12px 6px 12px}.btn:visited{color:#fff}.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:0.4;cursor:not-allowed;box-shadow:none}.btn-disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:0.4;cursor:not-allowed;box-shadow:none}.btn-disabled:hover,.btn-disabled:focus,.btn-disabled:active{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:0.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980B9 !important}.btn-info:hover{background-color:#2e8ece !important}.btn-neutral{background-color:#f3f6f6 !important;color:#404040 !important}.btn-neutral:hover{background-color:#e5ebeb !important;color:#404040}.btn-neutral:visited{color:#404040 !important}.btn-success{background-color:#27AE60 !important}.btn-success:hover{background-color:#295 !important}.btn-danger{background-color:#E74C3C !important}.btn-danger:hover{background-color:#ea6153 !important}.btn-warning{background-color:#E67E22 !important}.btn-warning:hover{background-color:#e98b39 !important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f !important}.btn-link{background-color:transparent !important;color:#2980B9;box-shadow:none;border-color:transparent !important}.btn-link:hover{background-color:transparent !important;color:#409ad5 !important;box-shadow:none}.btn-link:active{background-color:transparent !important;color:#409ad5 !important;box-shadow:none}.btn-link:visited{color:#9B59B6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:before,.wy-btn-group:after{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:solid 1px #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,0.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980B9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:solid 1px #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type="search"]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980B9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned input,.wy-form-aligned textarea,.wy-form-aligned select,.wy-form-aligned .wy-help-inline,.wy-form-aligned label{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{border:0;margin:0;padding:0}legend{display:block;width:100%;border:0;padding:0;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label{display:block;margin:0 0 0.3125em 0;color:#999;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;*zoom:1;max-width:68em;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:before,.wy-control-group:after{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group:before,.wy-control-group:after{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#E74C3C}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full input[type="text"],.wy-control-group .wy-form-full input[type="password"],.wy-control-group .wy-form-full input[type="email"],.wy-control-group .wy-form-full input[type="url"],.wy-control-group .wy-form-full input[type="date"],.wy-control-group .wy-form-full input[type="month"],.wy-control-group .wy-form-full input[type="time"],.wy-control-group .wy-form-full input[type="datetime"],.wy-control-group .wy-form-full input[type="datetime-local"],.wy-control-group .wy-form-full input[type="week"],.wy-control-group .wy-form-full input[type="number"],.wy-control-group .wy-form-full input[type="search"],.wy-control-group .wy-form-full input[type="tel"],.wy-control-group .wy-form-full input[type="color"],.wy-control-group .wy-form-halves input[type="text"],.wy-control-group .wy-form-halves input[type="password"],.wy-control-group .wy-form-halves input[type="email"],.wy-control-group .wy-form-halves input[type="url"],.wy-control-group .wy-form-halves input[type="date"],.wy-control-group .wy-form-halves input[type="month"],.wy-control-group .wy-form-halves input[type="time"],.wy-control-group .wy-form-halves input[type="datetime"],.wy-control-group .wy-form-halves input[type="datetime-local"],.wy-control-group .wy-form-halves input[type="week"],.wy-control-group .wy-form-halves input[type="number"],.wy-control-group .wy-form-halves input[type="search"],.wy-control-group .wy-form-halves input[type="tel"],.wy-control-group .wy-form-halves input[type="color"],.wy-control-group .wy-form-thirds input[type="text"],.wy-control-group .wy-form-thirds input[type="password"],.wy-control-group .wy-form-thirds input[type="email"],.wy-control-group .wy-form-thirds input[type="url"],.wy-control-group .wy-form-thirds input[type="date"],.wy-control-group .wy-form-thirds input[type="month"],.wy-control-group .wy-form-thirds input[type="time"],.wy-control-group .wy-form-thirds input[type="datetime"],.wy-control-group .wy-form-thirds input[type="datetime-local"],.wy-control-group .wy-form-thirds input[type="week"],.wy-control-group .wy-form-thirds input[type="number"],.wy-control-group .wy-form-thirds input[type="search"],.wy-control-group .wy-form-thirds input[type="tel"],.wy-control-group .wy-form-thirds input[type="color"]{width:100%}.wy-control-group .wy-form-full{float:left;display:block;margin-right:2.35765%;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child{margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(2n+1){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child{margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control{margin:6px 0 0 0;font-size:90%}.wy-control-no-input{display:inline-block;margin:6px 0 0 0;font-size:90%}.wy-control-group.fluid-input input[type="text"],.wy-control-group.fluid-input input[type="password"],.wy-control-group.fluid-input input[type="email"],.wy-control-group.fluid-input input[type="url"],.wy-control-group.fluid-input input[type="date"],.wy-control-group.fluid-input input[type="month"],.wy-control-group.fluid-input input[type="time"],.wy-control-group.fluid-input input[type="datetime"],.wy-control-group.fluid-input input[type="datetime-local"],.wy-control-group.fluid-input input[type="week"],.wy-control-group.fluid-input input[type="number"],.wy-control-group.fluid-input input[type="search"],.wy-control-group.fluid-input input[type="tel"],.wy-control-group.fluid-input input[type="color"]{width:100%}.wy-form-message-inline{display:inline-block;padding-left:0.3em;color:#666;vertical-align:middle;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:0.3125em;font-style:italic}input{line-height:normal}input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;*overflow:visible}input[type="text"],input[type="password"],input[type="email"],input[type="url"],input[type="date"],input[type="month"],input[type="time"],input[type="datetime"],input[type="datetime-local"],input[type="week"],input[type="number"],input[type="search"],input[type="tel"],input[type="color"]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border 0.3s linear;-moz-transition:border 0.3s linear;transition:border 0.3s linear}input[type="datetime-local"]{padding:0.34375em 0.625em}input[disabled]{cursor:default}input[type="checkbox"],input[type="radio"]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box;padding:0;margin-right:0.3125em;*height:13px;*width:13px}input[type="search"]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}input[type="text"]:focus,input[type="password"]:focus,input[type="email"]:focus,input[type="url"]:focus,input[type="date"]:focus,input[type="month"]:focus,input[type="time"]:focus,input[type="datetime"]:focus,input[type="datetime-local"]:focus,input[type="week"]:focus,input[type="number"]:focus,input[type="search"]:focus,input[type="tel"]:focus,input[type="color"]:focus{outline:0;outline:thin dotted \9;border-color:#333}input.no-focus:focus{border-color:#ccc !important}input[type="file"]:focus,input[type="radio"]:focus,input[type="checkbox"]:focus{outline:thin dotted #333;outline:1px auto #129FEA}input[type="text"][disabled],input[type="password"][disabled],input[type="email"][disabled],input[type="url"][disabled],input[type="date"][disabled],input[type="month"][disabled],input[type="time"][disabled],input[type="datetime"][disabled],input[type="datetime-local"][disabled],input[type="week"][disabled],input[type="number"][disabled],input[type="search"][disabled],input[type="tel"][disabled],input[type="color"][disabled]{cursor:not-allowed;background-color:#f3f6f6;color:#cad2d3}input:focus:invalid,textarea:focus:invalid,select:focus:invalid{color:#E74C3C;border:1px solid #E74C3C}input:focus:invalid:focus,textarea:focus:invalid:focus,select:focus:invalid:focus{border-color:#E74C3C}input[type="file"]:focus:invalid:focus,input[type="radio"]:focus:invalid:focus,input[type="checkbox"]:focus:invalid:focus{outline-color:#E74C3C}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif}select,textarea{padding:0.5em 0.625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border 0.3s linear;-moz-transition:border 0.3s linear;transition:border 0.3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}select[disabled],textarea[disabled],input[readonly],select[readonly],textarea[readonly]{cursor:not-allowed;background-color:#fff;color:#cad2d3;border-color:transparent}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{padding:6px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:solid 1px #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#E74C3C}.wy-control-group.wy-control-group-error input[type="text"],.wy-control-group.wy-control-group-error input[type="password"],.wy-control-group.wy-control-group-error input[type="email"],.wy-control-group.wy-control-group-error input[type="url"],.wy-control-group.wy-control-group-error input[type="date"],.wy-control-group.wy-control-group-error input[type="month"],.wy-control-group.wy-control-group-error input[type="time"],.wy-control-group.wy-control-group-error input[type="datetime"],.wy-control-group.wy-control-group-error input[type="datetime-local"],.wy-control-group.wy-control-group-error input[type="week"],.wy-control-group.wy-control-group-error input[type="number"],.wy-control-group.wy-control-group-error input[type="search"],.wy-control-group.wy-control-group-error input[type="tel"],.wy-control-group.wy-control-group-error input[type="color"]{border:solid 1px #E74C3C}.wy-control-group.wy-control-group-error textarea{border:solid 1px #E74C3C}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:0.5em 0.625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27AE60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#E74C3C}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#E67E22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980B9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width: 480px){.wy-form button[type="submit"]{margin:0.7em 0 0}.wy-form input[type="text"],.wy-form input[type="password"],.wy-form input[type="email"],.wy-form input[type="url"],.wy-form input[type="date"],.wy-form input[type="month"],.wy-form input[type="time"],.wy-form input[type="datetime"],.wy-form input[type="datetime-local"],.wy-form input[type="week"],.wy-form input[type="number"],.wy-form input[type="search"],.wy-form input[type="tel"],.wy-form input[type="color"]{margin-bottom:0.3em;display:block}.wy-form label{margin-bottom:0.3em;display:block}.wy-form input[type="password"],.wy-form input[type="email"],.wy-form input[type="url"],.wy-form input[type="date"],.wy-form input[type="month"],.wy-form input[type="time"],.wy-form input[type="datetime"],.wy-form input[type="datetime-local"],.wy-form input[type="week"],.wy-form input[type="number"],.wy-form input[type="search"],.wy-form input[type="tel"],.wy-form input[type="color"]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:0.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0 0}.wy-form .wy-help-inline,.wy-form-message-inline,.wy-form-message{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width: 768px){.tablet-hide{display:none}}@media screen and (max-width: 480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.wy-table,.rst-content table.docutils,.rst-content table.field-list{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.wy-table caption,.rst-content table.docutils caption,.rst-content table.field-list caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.wy-table td,.rst-content table.docutils td,.rst-content table.field-list td,.wy-table th,.rst-content table.docutils th,.rst-content table.field-list th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.wy-table td:first-child,.rst-content table.docutils td:first-child,.rst-content table.field-list td:first-child,.wy-table th:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list th:first-child{border-left-width:0}.wy-table thead,.rst-content table.docutils thead,.rst-content table.field-list thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.wy-table thead th,.rst-content table.docutils thead th,.rst-content table.field-list thead th{font-weight:bold;border-bottom:solid 2px #e1e4e5}.wy-table td,.rst-content table.docutils td,.rst-content table.field-list td{background-color:transparent;vertical-align:middle}.wy-table td p,.rst-content table.docutils td p,.rst-content table.field-list td p{line-height:18px}.wy-table td p:last-child,.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child{margin-bottom:0}.wy-table .wy-table-cell-min,.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min{width:1%;padding-right:0}.wy-table .wy-table-cell-min input[type=checkbox],.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox],.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:gray;font-size:90%}.wy-table-tertiary{color:gray;font-size:80%}.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td,.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td{background-color:#f3f6f6}.wy-table-backed{background-color:#f3f6f6}.wy-table-bordered-all,.rst-content table.docutils{border:1px solid #e1e4e5}.wy-table-bordered-all td,.rst-content table.docutils td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.wy-table-bordered-all tbody>tr:last-child td,.rst-content table.docutils tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px 0;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0 !important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980B9;text-decoration:none}a:hover{color:#3091d1}a:visited{color:#9B59B6}html{height:100%;overflow-x:hidden}body{font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;font-weight:normal;color:#404040;min-height:100%;overflow-x:hidden;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#E67E22 !important}a.wy-text-warning:hover{color:#eb9950 !important}.wy-text-info{color:#2980B9 !important}a.wy-text-info:hover{color:#409ad5 !important}.wy-text-success{color:#27AE60 !important}a.wy-text-success:hover{color:#36d278 !important}.wy-text-danger{color:#E74C3C !important}a.wy-text-danger:hover{color:#ed7669 !important}.wy-text-neutral{color:#404040 !important}a.wy-text-neutral:hover{color:#595959 !important}h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:"Roboto Slab","ff-tisa-web-pro","Georgia",Arial,sans-serif}p{line-height:24px;margin:0;font-size:16px;margin-bottom:24px}h1{font-size:175%}h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}code,.rst-content tt{white-space:nowrap;max-width:100%;background:#fff;border:solid 1px #e1e4e5;font-size:75%;padding:0 5px;font-family:Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace;color:#E74C3C;overflow-x:auto}code.code-large,.rst-content tt.code-large{font-size:90%}.wy-plain-list-disc,.rst-content .section ul,.rst-content .toctree-wrapper ul,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.wy-plain-list-disc li,.rst-content .section ul li,.rst-content .toctree-wrapper ul li,article ul li{list-style:disc;margin-left:24px}.wy-plain-list-disc li p:last-child,.rst-content .section ul li p:last-child,.rst-content .toctree-wrapper ul li p:last-child,article ul li p:last-child{margin-bottom:0}.wy-plain-list-disc li ul,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li ul,article ul li ul{margin-bottom:0}.wy-plain-list-disc li li,.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,article ul li li{list-style:circle}.wy-plain-list-disc li li li,.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,article ul li li li{list-style:square}.wy-plain-list-disc li ol li,.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,article ul li ol li{list-style:decimal}.wy-plain-list-decimal,.rst-content .section ol,.rst-content ol.arabic,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.wy-plain-list-decimal li,.rst-content .section ol li,.rst-content ol.arabic li,article ol li{list-style:decimal;margin-left:24px}.wy-plain-list-decimal li p:last-child,.rst-content .section ol li p:last-child,.rst-content ol.arabic li p:last-child,article ol li p:last-child{margin-bottom:0}.wy-plain-list-decimal li ul,.rst-content .section ol li ul,.rst-content ol.arabic li ul,article ol li ul{margin-bottom:0}.wy-plain-list-decimal li ul li,.rst-content .section ol li ul li,.rst-content ol.arabic li ul li,article ol li ul li{list-style:disc}.codeblock-example{border:1px solid #e1e4e5;border-bottom:none;padding:24px;padding-top:48px;font-weight:500;background:#fff;position:relative}.codeblock-example:after{content:"Example";position:absolute;top:0px;left:0px;background:#9B59B6;color:#fff;padding:6px 12px}.codeblock-example.prettyprint-example-only{border:1px solid #e1e4e5;margin-bottom:24px}.codeblock,pre.literal-block,.rst-content .literal-block,.rst-content pre.literal-block,div[class^='highlight']{border:1px solid #e1e4e5;padding:0px;overflow-x:auto;background:#fff;margin:1px 0 24px 0}.codeblock div[class^='highlight'],pre.literal-block div[class^='highlight'],.rst-content .literal-block div[class^='highlight'],div[class^='highlight'] div[class^='highlight']{border:none;background:none;margin:0}div[class^='highlight'] td.code{width:100%}.linenodiv pre{border-right:solid 1px #e6e9ea;margin:0;padding:12px 12px;font-family:Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace;font-size:12px;line-height:1.5;color:#d9d9d9}div[class^='highlight'] pre{white-space:pre;margin:0;padding:12px 12px;font-family:Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace;font-size:12px;line-height:1.5;display:block;overflow:auto;color:#404040}@media print{.codeblock,pre.literal-block,.rst-content .literal-block,.rst-content pre.literal-block,div[class^='highlight'],div[class^='highlight'] pre{white-space:pre-wrap}}.hll{background-color:#ffc;margin:0 -12px;padding:0 12px;display:block}.c{color:#998;font-style:italic}.err{color:#a61717;background-color:#e3d2d2}.k{font-weight:bold}.o{font-weight:bold}.cm{color:#998;font-style:italic}.cp{color:#999;font-weight:bold}.c1{color:#998;font-style:italic}.cs{color:#999;font-weight:bold;font-style:italic}.gd{color:#000;background-color:#fdd}.gd .x{color:#000;background-color:#faa}.ge{font-style:italic}.gr{color:#a00}.gh{color:#999}.gi{color:#000;background-color:#dfd}.gi .x{color:#000;background-color:#afa}.go{color:#888}.gp{color:#555}.gs{font-weight:bold}.gu{color:purple;font-weight:bold}.gt{color:#a00}.kc{font-weight:bold}.kd{font-weight:bold}.kn{font-weight:bold}.kp{font-weight:bold}.kr{font-weight:bold}.kt{color:#458;font-weight:bold}.m{color:#099}.s{color:#d14}.n{color:#333}.na{color:teal}.nb{color:#0086b3}.nc{color:#458;font-weight:bold}.no{color:teal}.ni{color:purple}.ne{color:#900;font-weight:bold}.nf{color:#900;font-weight:bold}.nn{color:#555}.nt{color:navy}.nv{color:teal}.ow{font-weight:bold}.w{color:#bbb}.mf{color:#099}.mh{color:#099}.mi{color:#099}.mo{color:#099}.sb{color:#d14}.sc{color:#d14}.sd{color:#d14}.s2{color:#d14}.se{color:#d14}.sh{color:#d14}.si{color:#d14}.sx{color:#d14}.sr{color:#009926}.s1{color:#d14}.ss{color:#990073}.bp{color:#999}.vc{color:teal}.vg{color:teal}.vi{color:teal}.il{color:#099}.gc{color:#999;background-color:#EAF2F5}.wy-breadcrumbs li{display:inline-block}.wy-breadcrumbs li.wy-breadcrumbs-aside{float:right}.wy-breadcrumbs li a{display:inline-block;padding:5px}.wy-breadcrumbs li a:first-child{padding-left:0}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width: 480px){.wy-breadcrumbs-extra{display:none}.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:before,.wy-menu-horiz:after{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz ul,.wy-menu-horiz li{display:inline-block}.wy-menu-horiz li:hover{background:rgba(255,255,255,0.1)}.wy-menu-horiz li.divide-left{border-left:solid 1px #404040}.wy-menu-horiz li.divide-right{border-right:solid 1px #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical header{height:32px;display:inline-block;line-height:32px;padding:0 1.618em;display:block;font-weight:bold;text-transform:uppercase;font-size:80%;color:#2980B9;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:solid 1px #404040}.wy-menu-vertical li.divide-bottom{border-bottom:solid 1px #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:gray;border-right:solid 1px #c9c9c9;padding:0.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.wy-menu-vertical li.on a,.wy-menu-vertical li.current>a{color:#404040;padding:0.4045em 1.618em;font-weight:bold;position:relative;background:#fcfcfc;border:none;border-bottom:solid 1px #c9c9c9;border-top:solid 1px #c9c9c9;padding-left:1.618em -4px}.wy-menu-vertical li.on a:hover,.wy-menu-vertical li.current>a:hover{background:#fcfcfc}.wy-menu-vertical li.toctree-l2.current>a{background:#c9c9c9;padding:0.4045em 2.427em}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical .local-toc li ul{display:block}.wy-menu-vertical li ul li a{margin-bottom:0;color:#b3b3b3;font-weight:normal}.wy-menu-vertical a{display:inline-block;line-height:18px;padding:0.4045em 1.618em;display:block;position:relative;font-size:90%;color:#b3b3b3}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:active{background-color:#2980B9;cursor:pointer;color:#fff}.wy-side-nav-search{z-index:200;background-color:#2980B9;text-align:center;padding:0.809em;display:block;color:#fcfcfc;margin-bottom:0.809em}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto 0.809em auto;height:45px;width:45px;background-color:#2980B9;padding:5px;border-radius:100%}.wy-side-nav-search>a,.wy-side-nav-search .wy-dropdown>a{color:#fcfcfc;font-size:100%;font-weight:bold;display:inline-block;padding:4px 6px;margin-bottom:0.809em}.wy-side-nav-search>a:hover,.wy-side-nav-search .wy-dropdown>a:hover{background:rgba(255,255,255,0.1)}.wy-nav .wy-menu-vertical header{color:#2980B9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980B9;color:#fff}[data-menu-wrap]{-webkit-transition:all 0.2s ease-in;-moz-transition:all 0.2s ease-in;transition:all 0.2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:left repeat-y #fcfcfc;background-image:url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAIAAACQd1PeAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDoxOERBMTRGRDBFMUUxMUUzODUwMkJCOThDMEVFNURFMCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDoxOERBMTRGRTBFMUUxMUUzODUwMkJCOThDMEVFNURFMCI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOjE4REExNEZCMEUxRTExRTM4NTAyQkI5OEMwRUU1REUwIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOjE4REExNEZDMEUxRTExRTM4NTAyQkI5OEMwRUU1REUwIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+EwrlwAAAAA5JREFUeNpiMDU0BAgwAAE2AJgB9BnaAAAAAElFTkSuQmCC);background-size:300px 1px}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:absolute;top:0;left:0;width:300px;overflow:hidden;min-height:100%;background:#343131;z-index:200}.wy-nav-top{display:none;background:#2980B9;color:#fff;padding:0.4045em 0.809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:before,.wy-nav-top:after{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:bold}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980B9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,0.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:#999}footer p{margin-bottom:12px}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:before,.rst-footer-buttons:after{display:table;content:""}.rst-footer-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:solid 1px #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:solid 1px #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:gray;font-size:90%}@media screen and (max-width: 768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width: 1400px){.wy-nav-content-wrap{background:rgba(0,0,0,0.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,footer,.wy-nav-side{display:none}.wy-nav-content-wrap{margin-left:0}}nav.stickynav{position:fixed;top:0}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;border-top:solid 10px #343131;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .icon{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}img{width:100%;height:auto}}.rst-content img{max-width:100%;height:auto !important}.rst-content div.figure{margin-bottom:24px}.rst-content div.figure.align-center{text-align:center}.rst-content .section>img{margin-bottom:24px}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content .note .last,.rst-content .attention .last,.rst-content .caution .last,.rst-content .danger .last,.rst-content .error .last,.rst-content .hint .last,.rst-content .important .last,.rst-content .tip .last,.rst-content .warning .last,.rst-content .seealso .last,.rst-content .admonition-todo .last{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,0.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent !important;border-color:rgba(0,0,0,0.1) !important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha li{list-style:upper-alpha}.rst-content .section ol p,.rst-content .section ul p{margin-bottom:12px}.rst-content .line-block{margin-left:24px}.rst-content .topic-title{font-weight:bold;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0px 0px 24px 24px}.rst-content .align-left{float:left;margin:0px 24px 24px 0px}.rst-content .align-center{margin:auto;display:block}.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink{display:none;visibility:hidden;font-size:14px}.rst-content h1 .headerlink:after,.rst-content h2 .headerlink:after,.rst-content h3 .headerlink:after,.rst-content h4 .headerlink:after,.rst-content h5 .headerlink:after,.rst-content h6 .headerlink:after,.rst-content dl dt .headerlink:after{visibility:visible;content:"";font-family:FontAwesome;display:inline-block}.rst-content h1:hover .headerlink,.rst-content h2:hover .headerlink,.rst-content h3:hover .headerlink,.rst-content h4:hover .headerlink,.rst-content h5:hover .headerlink,.rst-content h6:hover .headerlink,.rst-content dl dt:hover .headerlink{display:inline-block}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:solid 1px #e1e4e5}.rst-content .sidebar p,.rst-content .sidebar ul,.rst-content .sidebar dl{font-size:90%}.rst-content .sidebar .last{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:"Roboto Slab","ff-tisa-web-pro","Georgia",Arial,sans-serif;font-weight:bold;background:#e1e4e5;padding:6px 12px;margin:-24px;margin-bottom:24px;font-size:100%}.rst-content .highlighted{background:#F1C40F;display:inline-block;font-weight:bold;padding:0 6px}.rst-content .footnote-reference,.rst-content .citation-reference{vertical-align:super;font-size:90%}.rst-content table.docutils.citation,.rst-content table.docutils.footnote{background:none;border:none;color:#999}.rst-content table.docutils.citation td,.rst-content table.docutils.citation tr,.rst-content table.docutils.footnote td,.rst-content table.docutils.footnote tr{border:none;background-color:transparent !important;white-space:normal}.rst-content table.docutils.citation td.label,.rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}.rst-content table.field-list{border:none}.rst-content table.field-list td{border:none;padding-top:5px}.rst-content table.field-list td>strong{display:inline-block;margin-top:3px}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left;padding-left:0}.rst-content tt{color:#000}.rst-content tt big,.rst-content tt em{font-size:100% !important;line-height:normal}.rst-content tt .xref,a .rst-content tt{font-weight:bold}.rst-content a tt{color:#2980B9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:bold}.rst-content dl p,.rst-content dl table,.rst-content dl ul,.rst-content dl ol{margin-bottom:12px !important}.rst-content dl dd{margin:0 0 12px 24px}.rst-content dl:not(.docutils){margin-bottom:24px}.rst-content dl:not(.docutils) dt{display:inline-block;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980B9;border-top:solid 3px #6ab0de;padding:6px;position:relative}.rst-content dl:not(.docutils) dt:before{color:#6ab0de}.rst-content dl:not(.docutils) dt .headerlink{color:#404040;font-size:100% !important}.rst-content dl:not(.docutils) dl dt{margin-bottom:6px;border:none;border-left:solid 3px #ccc;background:#f0f0f0;color:gray}.rst-content dl:not(.docutils) dl dt .headerlink{color:#404040;font-size:100% !important}.rst-content dl:not(.docutils) dt:first-child{margin-top:0}.rst-content dl:not(.docutils) tt{font-weight:bold}.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) tt.descclassname{background-color:transparent;border:none;padding:0;font-size:100% !important}.rst-content dl:not(.docutils) tt.descname{font-weight:bold}.rst-content dl:not(.docutils) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:bold}.rst-content dl:not(.docutils) .property{display:inline-block;padding-right:8px}.rst-content .viewcode-link,.rst-content .viewcode-back{display:inline-block;color:#27AE60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:bold}@media screen and (max-width: 480px){.rst-content .sidebar{width:100%}}span[id*='MathJax-Span']{color:#404040}.math{text-align:center} | ||
diff --git a/doc/html/css/theme_extra.css b/doc/html/css/theme_extra.css new file mode 100644 index 00000000..e53d320a --- /dev/null +++ b/doc/html/css/theme_extra.css | |||
| @@ -0,0 +1,193 @@ | |||
| 1 | /* | ||
| 2 | * Sphinx doesn't have support for section dividers like we do in | ||
| 3 | * MkDocs, this styles the section titles in the nav | ||
| 4 | * | ||
| 5 | * https://github.com/mkdocs/mkdocs/issues/175 | ||
| 6 | */ | ||
| 7 | .wy-menu-vertical span { | ||
| 8 | line-height: 18px; | ||
| 9 | padding: 0.4045em 1.618em; | ||
| 10 | display: block; | ||
| 11 | position: relative; | ||
| 12 | font-size: 90%; | ||
| 13 | color: #838383; | ||
| 14 | } | ||
| 15 | |||
| 16 | .wy-menu-vertical .subnav a { | ||
| 17 | padding: 0.4045em 2.427em; | ||
| 18 | } | ||
| 19 | |||
| 20 | /* | ||
| 21 | * Long navigations run off the bottom of the screen as the nav | ||
| 22 | * area doesn't scroll. | ||
| 23 | * | ||
| 24 | * https://github.com/mkdocs/mkdocs/pull/202 | ||
| 25 | * | ||
| 26 | * Builds upon pull 202 https://github.com/mkdocs/mkdocs/pull/202 | ||
| 27 | * to make toc scrollbar end before navigations buttons to not be overlapping. | ||
| 28 | */ | ||
| 29 | .wy-nav-side { | ||
| 30 | height: calc(100% - 45px); | ||
| 31 | overflow-y: auto; | ||
| 32 | min-height: 0; | ||
| 33 | } | ||
| 34 | |||
| 35 | .rst-versions{ | ||
| 36 | border-top: 0; | ||
| 37 | height: 45px; | ||
| 38 | } | ||
| 39 | |||
| 40 | @media screen and (max-width: 768px) { | ||
| 41 | .wy-nav-side { | ||
| 42 | height: 100%; | ||
| 43 | } | ||
| 44 | } | ||
| 45 | |||
| 46 | /* | ||
| 47 | * readthedocs theme hides nav items when the window height is | ||
| 48 | * too small to contain them. | ||
| 49 | * | ||
| 50 | * https://github.com/mkdocs/mkdocs/issues/#348 | ||
| 51 | */ | ||
| 52 | .wy-menu-vertical ul { | ||
| 53 | margin-bottom: 2em; | ||
| 54 | } | ||
| 55 | |||
| 56 | /* | ||
| 57 | * Wrap inline code samples otherwise they shoot of the side and | ||
| 58 | * can't be read at all. | ||
| 59 | * | ||
| 60 | * https://github.com/mkdocs/mkdocs/issues/313 | ||
| 61 | * https://github.com/mkdocs/mkdocs/issues/233 | ||
| 62 | * https://github.com/mkdocs/mkdocs/issues/834 | ||
| 63 | */ | ||
| 64 | code { | ||
| 65 | white-space: pre-wrap; | ||
| 66 | word-wrap: break-word; | ||
| 67 | padding: 2px 5px; | ||
| 68 | } | ||
| 69 | |||
| 70 | /** | ||
| 71 | * Make code blocks display as blocks and give them the appropriate | ||
| 72 | * font size and padding. | ||
| 73 | * | ||
| 74 | * https://github.com/mkdocs/mkdocs/issues/855 | ||
| 75 | * https://github.com/mkdocs/mkdocs/issues/834 | ||
| 76 | * https://github.com/mkdocs/mkdocs/issues/233 | ||
| 77 | */ | ||
| 78 | pre code { | ||
| 79 | white-space: pre; | ||
| 80 | word-wrap: normal; | ||
| 81 | display: block; | ||
| 82 | padding: 12px; | ||
| 83 | font-size: 12px; | ||
| 84 | } | ||
| 85 | |||
| 86 | /* | ||
| 87 | * Fix link colors when the link text is inline code. | ||
| 88 | * | ||
| 89 | * https://github.com/mkdocs/mkdocs/issues/718 | ||
| 90 | */ | ||
| 91 | a code { | ||
| 92 | color: #2980B9; | ||
| 93 | } | ||
| 94 | a:hover code { | ||
| 95 | color: #3091d1; | ||
| 96 | } | ||
| 97 | a:visited code { | ||
| 98 | color: #9B59B6; | ||
| 99 | } | ||
| 100 | |||
| 101 | /* | ||
| 102 | * The CSS classes from highlight.js seem to clash with the | ||
| 103 | * ReadTheDocs theme causing some code to be incorrectly made | ||
| 104 | * bold and italic. | ||
| 105 | * | ||
| 106 | * https://github.com/mkdocs/mkdocs/issues/411 | ||
| 107 | */ | ||
| 108 | pre .cs, pre .c { | ||
| 109 | font-weight: inherit; | ||
| 110 | font-style: inherit; | ||
| 111 | } | ||
| 112 | |||
| 113 | /* | ||
| 114 | * Fix some issues with the theme and non-highlighted code | ||
| 115 | * samples. Without and highlighting styles attached the | ||
| 116 | * formatting is broken. | ||
| 117 | * | ||
| 118 | * https://github.com/mkdocs/mkdocs/issues/319 | ||
| 119 | */ | ||
| 120 | .no-highlight { | ||
| 121 | display: block; | ||
| 122 | padding: 0.5em; | ||
| 123 | color: #333; | ||
| 124 | } | ||
| 125 | |||
| 126 | |||
| 127 | /* | ||
| 128 | * Additions specific to the search functionality provided by MkDocs | ||
| 129 | */ | ||
| 130 | |||
| 131 | .search-results article { | ||
| 132 | margin-top: 23px; | ||
| 133 | border-top: 1px solid #E1E4E5; | ||
| 134 | padding-top: 24px; | ||
| 135 | } | ||
| 136 | |||
| 137 | .search-results article:first-child { | ||
| 138 | border-top: none; | ||
| 139 | } | ||
| 140 | |||
| 141 | form .search-query { | ||
| 142 | width: 100%; | ||
| 143 | border-radius: 50px; | ||
| 144 | padding: 6px 12px; /* csslint allow: box-model */ | ||
| 145 | border-color: #D1D4D5; | ||
| 146 | } | ||
| 147 | |||
| 148 | .wy-menu-vertical li ul { | ||
| 149 | display: inherit; | ||
| 150 | } | ||
| 151 | |||
| 152 | .wy-menu-vertical li ul.subnav ul.subnav{ | ||
| 153 | padding-left: 1em; | ||
| 154 | } | ||
| 155 | |||
| 156 | .wy-menu-vertical .subnav li.current > a { | ||
| 157 | padding-left: 2.42em; | ||
| 158 | } | ||
| 159 | .wy-menu-vertical .subnav li.current > ul li a { | ||
| 160 | padding-left: 3.23em; | ||
| 161 | } | ||
| 162 | |||
| 163 | /* | ||
| 164 | * Improve inline code blocks within admonitions. | ||
| 165 | * | ||
| 166 | * https://github.com/mkdocs/mkdocs/issues/656 | ||
| 167 | */ | ||
| 168 | .admonition code { | ||
| 169 | color: #404040; | ||
| 170 | border: 1px solid #c7c9cb; | ||
| 171 | border: 1px solid rgba(0, 0, 0, 0.2); | ||
| 172 | background: #f8fbfd; | ||
| 173 | background: rgba(255, 255, 255, 0.7); | ||
| 174 | } | ||
| 175 | |||
| 176 | /* | ||
| 177 | * Account for wide tables which go off the side. | ||
| 178 | * Override borders to avoid wierdness on narrow tables. | ||
| 179 | * | ||
| 180 | * https://github.com/mkdocs/mkdocs/issues/834 | ||
| 181 | * https://github.com/mkdocs/mkdocs/pull/1034 | ||
| 182 | */ | ||
| 183 | .rst-content .section .docutils { | ||
| 184 | width: 100%; | ||
| 185 | overflow: auto; | ||
| 186 | display: block; | ||
| 187 | border: none; | ||
| 188 | } | ||
| 189 | |||
| 190 | td, th { | ||
| 191 | border: 1px solid #e1e4e5 !important; /* csslint allow: important */ | ||
| 192 | border-collapse: collapse; | ||
| 193 | } | ||
diff --git a/doc/html/fonts/fontawesome-webfont.eot b/doc/html/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..0662cb96 --- /dev/null +++ b/doc/html/fonts/fontawesome-webfont.eot | |||
| Binary files differ | |||
diff --git a/doc/html/fonts/fontawesome-webfont.svg b/doc/html/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..2edb4ec3 --- /dev/null +++ b/doc/html/fonts/fontawesome-webfont.svg | |||
| @@ -0,0 +1,399 @@ | |||
| 1 | <?xml version="1.0" standalone="no"?> | ||
| 2 | <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd" > | ||
| 3 | <svg xmlns="http://www.w3.org/2000/svg"> | ||
| 4 | <metadata></metadata> | ||
| 5 | <defs> | ||
| 6 | <font id="fontawesomeregular" horiz-adv-x="1536" > | ||
| 7 | <font-face units-per-em="1792" ascent="1536" descent="-256" /> | ||
| 8 | <missing-glyph horiz-adv-x="448" /> | ||
| 9 | <glyph unicode=" " horiz-adv-x="448" /> | ||
| 10 | <glyph unicode="	" horiz-adv-x="448" /> | ||
| 11 | <glyph unicode=" " horiz-adv-x="448" /> | ||
| 12 | <glyph unicode="¨" horiz-adv-x="1792" /> | ||
| 13 | <glyph unicode="©" horiz-adv-x="1792" /> | ||
| 14 | <glyph unicode="®" horiz-adv-x="1792" /> | ||
| 15 | <glyph unicode="´" horiz-adv-x="1792" /> | ||
| 16 | <glyph unicode="Æ" horiz-adv-x="1792" /> | ||
| 17 | <glyph unicode=" " horiz-adv-x="768" /> | ||
| 18 | <glyph unicode=" " /> | ||
| 19 | <glyph unicode=" " horiz-adv-x="768" /> | ||
| 20 | <glyph unicode=" " /> | ||
| 21 | <glyph unicode=" " horiz-adv-x="512" /> | ||
| 22 | <glyph unicode=" " horiz-adv-x="384" /> | ||
| 23 | <glyph unicode=" " horiz-adv-x="256" /> | ||
| 24 | <glyph unicode=" " horiz-adv-x="256" /> | ||
| 25 | <glyph unicode=" " horiz-adv-x="192" /> | ||
| 26 | <glyph unicode=" " horiz-adv-x="307" /> | ||
| 27 | <glyph unicode=" " horiz-adv-x="85" /> | ||
| 28 | <glyph unicode=" " horiz-adv-x="307" /> | ||
| 29 | <glyph unicode=" " horiz-adv-x="384" /> | ||
| 30 | <glyph unicode="™" horiz-adv-x="1792" /> | ||
| 31 | <glyph unicode="∞" horiz-adv-x="1792" /> | ||
| 32 | <glyph unicode="≠" horiz-adv-x="1792" /> | ||
| 33 | <glyph unicode="" horiz-adv-x="500" d="M0 0z" /> | ||
| 34 | <glyph unicode="" horiz-adv-x="1792" d="M1699 1350q0 -35 -43 -78l-632 -632v-768h320q26 0 45 -19t19 -45t-19 -45t-45 -19h-896q-26 0 -45 19t-19 45t19 45t45 19h320v768l-632 632q-43 43 -43 78q0 23 18 36.5t38 17.5t43 4h1408q23 0 43 -4t38 -17.5t18 -36.5z" /> | ||
| 35 | <glyph unicode="" d="M1536 1312v-1120q0 -50 -34 -89t-86 -60.5t-103.5 -32t-96.5 -10.5t-96.5 10.5t-103.5 32t-86 60.5t-34 89t34 89t86 60.5t103.5 32t96.5 10.5q105 0 192 -39v537l-768 -237v-709q0 -50 -34 -89t-86 -60.5t-103.5 -32t-96.5 -10.5t-96.5 10.5t-103.5 32t-86 60.5t-34 89 t34 89t86 60.5t103.5 32t96.5 10.5q105 0 192 -39v967q0 31 19 56.5t49 35.5l832 256q12 4 28 4q40 0 68 -28t28 -68z" /> | ||
| 36 | <glyph unicode="" horiz-adv-x="1664" d="M1152 704q0 185 -131.5 316.5t-316.5 131.5t-316.5 -131.5t-131.5 -316.5t131.5 -316.5t316.5 -131.5t316.5 131.5t131.5 316.5zM1664 -128q0 -52 -38 -90t-90 -38q-54 0 -90 38l-343 342q-179 -124 -399 -124q-143 0 -273.5 55.5t-225 150t-150 225t-55.5 273.5 t55.5 273.5t150 225t225 150t273.5 55.5t273.5 -55.5t225 -150t150 -225t55.5 -273.5q0 -220 -124 -399l343 -343q37 -37 37 -90z" /> | ||
| 37 | <glyph unicode="" horiz-adv-x="1792" d="M1664 32v768q-32 -36 -69 -66q-268 -206 -426 -338q-51 -43 -83 -67t-86.5 -48.5t-102.5 -24.5h-1h-1q-48 0 -102.5 24.5t-86.5 48.5t-83 67q-158 132 -426 338q-37 30 -69 66v-768q0 -13 9.5 -22.5t22.5 -9.5h1472q13 0 22.5 9.5t9.5 22.5zM1664 1083v11v13.5t-0.5 13 t-3 12.5t-5.5 9t-9 7.5t-14 2.5h-1472q-13 0 -22.5 -9.5t-9.5 -22.5q0 -168 147 -284q193 -152 401 -317q6 -5 35 -29.5t46 -37.5t44.5 -31.5t50.5 -27.5t43 -9h1h1q20 0 43 9t50.5 27.5t44.5 31.5t46 37.5t35 29.5q208 165 401 317q54 43 100.5 115.5t46.5 131.5z M1792 1120v-1088q0 -66 -47 -113t-113 -47h-1472q-66 0 -113 47t-47 113v1088q0 66 47 113t113 47h1472q66 0 113 -47t47 -113z" /> | ||
| 38 | <glyph unicode="" horiz-adv-x="1792" d="M896 -128q-26 0 -44 18l-624 602q-10 8 -27.5 26t-55.5 65.5t-68 97.5t-53.5 121t-23.5 138q0 220 127 344t351 124q62 0 126.5 -21.5t120 -58t95.5 -68.5t76 -68q36 36 76 68t95.5 68.5t120 58t126.5 21.5q224 0 351 -124t127 -344q0 -221 -229 -450l-623 -600 q-18 -18 -44 -18z" /> | ||
| 39 | <glyph unicode="" horiz-adv-x="1664" d="M1664 889q0 -22 -26 -48l-363 -354l86 -500q1 -7 1 -20q0 -21 -10.5 -35.5t-30.5 -14.5q-19 0 -40 12l-449 236l-449 -236q-22 -12 -40 -12q-21 0 -31.5 14.5t-10.5 35.5q0 6 2 20l86 500l-364 354q-25 27 -25 48q0 37 56 46l502 73l225 455q19 41 49 41t49 -41l225 -455 l502 -73q56 -9 56 -46z" /> | ||
| 40 | <glyph unicode="" horiz-adv-x="1664" d="M1137 532l306 297l-422 62l-189 382l-189 -382l-422 -62l306 -297l-73 -421l378 199l377 -199zM1664 889q0 -22 -26 -48l-363 -354l86 -500q1 -7 1 -20q0 -50 -41 -50q-19 0 -40 12l-449 236l-449 -236q-22 -12 -40 -12q-21 0 -31.5 14.5t-10.5 35.5q0 6 2 20l86 500 l-364 354q-25 27 -25 48q0 37 56 46l502 73l225 455q19 41 49 41t49 -41l225 -455l502 -73q56 -9 56 -46z" /> | ||
| 41 | <glyph unicode="" horiz-adv-x="1408" d="M1408 131q0 -120 -73 -189.5t-194 -69.5h-874q-121 0 -194 69.5t-73 189.5q0 53 3.5 103.5t14 109t26.5 108.5t43 97.5t62 81t85.5 53.5t111.5 20q9 0 42 -21.5t74.5 -48t108 -48t133.5 -21.5t133.5 21.5t108 48t74.5 48t42 21.5q61 0 111.5 -20t85.5 -53.5t62 -81 t43 -97.5t26.5 -108.5t14 -109t3.5 -103.5zM1088 1024q0 -159 -112.5 -271.5t-271.5 -112.5t-271.5 112.5t-112.5 271.5t112.5 271.5t271.5 112.5t271.5 -112.5t112.5 -271.5z" /> | ||
| 42 | <glyph unicode="" horiz-adv-x="1920" d="M384 -64v128q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h128q26 0 45 19t19 45zM384 320v128q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h128q26 0 45 19t19 45zM384 704v128q0 26 -19 45t-45 19h-128 q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h128q26 0 45 19t19 45zM1408 -64v512q0 26 -19 45t-45 19h-768q-26 0 -45 -19t-19 -45v-512q0 -26 19 -45t45 -19h768q26 0 45 19t19 45zM384 1088v128q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45 t45 -19h128q26 0 45 19t19 45zM1792 -64v128q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h128q26 0 45 19t19 45zM1408 704v512q0 26 -19 45t-45 19h-768q-26 0 -45 -19t-19 -45v-512q0 -26 19 -45t45 -19h768q26 0 45 19t19 45zM1792 320v128 q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h128q26 0 45 19t19 45zM1792 704v128q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h128q26 0 45 19t19 45zM1792 1088v128q0 26 -19 45t-45 19h-128q-26 0 -45 -19 t-19 -45v-128q0 -26 19 -45t45 -19h128q26 0 45 19t19 45zM1920 1248v-1344q0 -66 -47 -113t-113 -47h-1600q-66 0 -113 47t-47 113v1344q0 66 47 113t113 47h1600q66 0 113 -47t47 -113z" /> | ||
| 43 | <glyph unicode="" horiz-adv-x="1664" d="M768 512v-384q0 -52 -38 -90t-90 -38h-512q-52 0 -90 38t-38 90v384q0 52 38 90t90 38h512q52 0 90 -38t38 -90zM768 1280v-384q0 -52 -38 -90t-90 -38h-512q-52 0 -90 38t-38 90v384q0 52 38 90t90 38h512q52 0 90 -38t38 -90zM1664 512v-384q0 -52 -38 -90t-90 -38 h-512q-52 0 -90 38t-38 90v384q0 52 38 90t90 38h512q52 0 90 -38t38 -90zM1664 1280v-384q0 -52 -38 -90t-90 -38h-512q-52 0 -90 38t-38 90v384q0 52 38 90t90 38h512q52 0 90 -38t38 -90z" /> | ||
| 44 | <glyph unicode="" horiz-adv-x="1792" d="M512 288v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM512 800v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM1152 288v-192q0 -40 -28 -68t-68 -28h-320 q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM512 1312v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM1152 800v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28 h320q40 0 68 -28t28 -68zM1792 288v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM1152 1312v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM1792 800v-192 q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM1792 1312v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68z" /> | ||
| 45 | <glyph unicode="" horiz-adv-x="1792" d="M512 288v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM512 800v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM1792 288v-192q0 -40 -28 -68t-68 -28h-960 q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h960q40 0 68 -28t28 -68zM512 1312v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM1792 800v-192q0 -40 -28 -68t-68 -28h-960q-40 0 -68 28t-28 68v192q0 40 28 68t68 28 h960q40 0 68 -28t28 -68zM1792 1312v-192q0 -40 -28 -68t-68 -28h-960q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h960q40 0 68 -28t28 -68z" /> | ||
| 46 | <glyph unicode="" horiz-adv-x="1792" d="M1671 970q0 -40 -28 -68l-724 -724l-136 -136q-28 -28 -68 -28t-68 28l-136 136l-362 362q-28 28 -28 68t28 68l136 136q28 28 68 28t68 -28l294 -295l656 657q28 28 68 28t68 -28l136 -136q28 -28 28 -68z" /> | ||
| 47 | <glyph unicode="" horiz-adv-x="1408" d="M1298 214q0 -40 -28 -68l-136 -136q-28 -28 -68 -28t-68 28l-294 294l-294 -294q-28 -28 -68 -28t-68 28l-136 136q-28 28 -28 68t28 68l294 294l-294 294q-28 28 -28 68t28 68l136 136q28 28 68 28t68 -28l294 -294l294 294q28 28 68 28t68 -28l136 -136q28 -28 28 -68 t-28 -68l-294 -294l294 -294q28 -28 28 -68z" /> | ||
| 48 | <glyph unicode="" horiz-adv-x="1664" d="M1024 736v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-224v-224q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v224h-224q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h224v224q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5v-224h224 q13 0 22.5 -9.5t9.5 -22.5zM1152 704q0 185 -131.5 316.5t-316.5 131.5t-316.5 -131.5t-131.5 -316.5t131.5 -316.5t316.5 -131.5t316.5 131.5t131.5 316.5zM1664 -128q0 -53 -37.5 -90.5t-90.5 -37.5q-54 0 -90 38l-343 342q-179 -124 -399 -124q-143 0 -273.5 55.5 t-225 150t-150 225t-55.5 273.5t55.5 273.5t150 225t225 150t273.5 55.5t273.5 -55.5t225 -150t150 -225t55.5 -273.5q0 -220 -124 -399l343 -343q37 -37 37 -90z" /> | ||
| 49 | <glyph unicode="" horiz-adv-x="1664" d="M1024 736v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-576q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h576q13 0 22.5 -9.5t9.5 -22.5zM1152 704q0 185 -131.5 316.5t-316.5 131.5t-316.5 -131.5t-131.5 -316.5t131.5 -316.5t316.5 -131.5t316.5 131.5t131.5 316.5z M1664 -128q0 -53 -37.5 -90.5t-90.5 -37.5q-54 0 -90 38l-343 342q-179 -124 -399 -124q-143 0 -273.5 55.5t-225 150t-150 225t-55.5 273.5t55.5 273.5t150 225t225 150t273.5 55.5t273.5 -55.5t225 -150t150 -225t55.5 -273.5q0 -220 -124 -399l343 -343q37 -37 37 -90z " /> | ||
| 50 | <glyph unicode="" d="M1536 640q0 -156 -61 -298t-164 -245t-245 -164t-298 -61t-298 61t-245 164t-164 245t-61 298q0 182 80.5 343t226.5 270q43 32 95.5 25t83.5 -50q32 -42 24.5 -94.5t-49.5 -84.5q-98 -74 -151.5 -181t-53.5 -228q0 -104 40.5 -198.5t109.5 -163.5t163.5 -109.5 t198.5 -40.5t198.5 40.5t163.5 109.5t109.5 163.5t40.5 198.5q0 121 -53.5 228t-151.5 181q-42 32 -49.5 84.5t24.5 94.5q31 43 84 50t95 -25q146 -109 226.5 -270t80.5 -343zM896 1408v-640q0 -52 -38 -90t-90 -38t-90 38t-38 90v640q0 52 38 90t90 38t90 -38t38 -90z" /> | ||
| 51 | <glyph unicode="" horiz-adv-x="1792" d="M256 96v-192q0 -14 -9 -23t-23 -9h-192q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h192q14 0 23 -9t9 -23zM640 224v-320q0 -14 -9 -23t-23 -9h-192q-14 0 -23 9t-9 23v320q0 14 9 23t23 9h192q14 0 23 -9t9 -23zM1024 480v-576q0 -14 -9 -23t-23 -9h-192q-14 0 -23 9t-9 23 v576q0 14 9 23t23 9h192q14 0 23 -9t9 -23zM1408 864v-960q0 -14 -9 -23t-23 -9h-192q-14 0 -23 9t-9 23v960q0 14 9 23t23 9h192q14 0 23 -9t9 -23zM1792 1376v-1472q0 -14 -9 -23t-23 -9h-192q-14 0 -23 9t-9 23v1472q0 14 9 23t23 9h192q14 0 23 -9t9 -23z" /> | ||
| 52 | <glyph unicode="" d="M1024 640q0 106 -75 181t-181 75t-181 -75t-75 -181t75 -181t181 -75t181 75t75 181zM1536 749v-222q0 -12 -8 -23t-20 -13l-185 -28q-19 -54 -39 -91q35 -50 107 -138q10 -12 10 -25t-9 -23q-27 -37 -99 -108t-94 -71q-12 0 -26 9l-138 108q-44 -23 -91 -38 q-16 -136 -29 -186q-7 -28 -36 -28h-222q-14 0 -24.5 8.5t-11.5 21.5l-28 184q-49 16 -90 37l-141 -107q-10 -9 -25 -9q-14 0 -25 11q-126 114 -165 168q-7 10 -7 23q0 12 8 23q15 21 51 66.5t54 70.5q-27 50 -41 99l-183 27q-13 2 -21 12.5t-8 23.5v222q0 12 8 23t19 13 l186 28q14 46 39 92q-40 57 -107 138q-10 12 -10 24q0 10 9 23q26 36 98.5 107.5t94.5 71.5q13 0 26 -10l138 -107q44 23 91 38q16 136 29 186q7 28 36 28h222q14 0 24.5 -8.5t11.5 -21.5l28 -184q49 -16 90 -37l142 107q9 9 24 9q13 0 25 -10q129 -119 165 -170q7 -8 7 -22 q0 -12 -8 -23q-15 -21 -51 -66.5t-54 -70.5q26 -50 41 -98l183 -28q13 -2 21 -12.5t8 -23.5z" /> | ||
| 53 | <glyph unicode="" horiz-adv-x="1408" d="M512 800v-576q0 -14 -9 -23t-23 -9h-64q-14 0 -23 9t-9 23v576q0 14 9 23t23 9h64q14 0 23 -9t9 -23zM768 800v-576q0 -14 -9 -23t-23 -9h-64q-14 0 -23 9t-9 23v576q0 14 9 23t23 9h64q14 0 23 -9t9 -23zM1024 800v-576q0 -14 -9 -23t-23 -9h-64q-14 0 -23 9t-9 23v576 q0 14 9 23t23 9h64q14 0 23 -9t9 -23zM1152 76v948h-896v-948q0 -22 7 -40.5t14.5 -27t10.5 -8.5h832q3 0 10.5 8.5t14.5 27t7 40.5zM480 1152h448l-48 117q-7 9 -17 11h-317q-10 -2 -17 -11zM1408 1120v-64q0 -14 -9 -23t-23 -9h-96v-948q0 -83 -47 -143.5t-113 -60.5h-832 q-66 0 -113 58.5t-47 141.5v952h-96q-14 0 -23 9t-9 23v64q0 14 9 23t23 9h309l70 167q15 37 54 63t79 26h320q40 0 79 -26t54 -63l70 -167h309q14 0 23 -9t9 -23z" /> | ||
| 54 | <glyph unicode="" horiz-adv-x="1664" d="M1408 544v-480q0 -26 -19 -45t-45 -19h-384v384h-256v-384h-384q-26 0 -45 19t-19 45v480q0 1 0.5 3t0.5 3l575 474l575 -474q1 -2 1 -6zM1631 613l-62 -74q-8 -9 -21 -11h-3q-13 0 -21 7l-692 577l-692 -577q-12 -8 -24 -7q-13 2 -21 11l-62 74q-8 10 -7 23.5t11 21.5 l719 599q32 26 76 26t76 -26l244 -204v195q0 14 9 23t23 9h192q14 0 23 -9t9 -23v-408l219 -182q10 -8 11 -21.5t-7 -23.5z" /> | ||
| 55 | <glyph unicode="" horiz-adv-x="1280" d="M128 0h1024v768h-416q-40 0 -68 28t-28 68v416h-512v-1280zM768 896h376q-10 29 -22 41l-313 313q-12 12 -41 22v-376zM1280 864v-896q0 -40 -28 -68t-68 -28h-1088q-40 0 -68 28t-28 68v1344q0 40 28 68t68 28h640q40 0 88 -20t76 -48l312 -312q28 -28 48 -76t20 -88z " /> | ||
| 56 | <glyph unicode="" d="M896 992v-448q0 -14 -9 -23t-23 -9h-320q-14 0 -23 9t-9 23v64q0 14 9 23t23 9h224v352q0 14 9 23t23 9h64q14 0 23 -9t9 -23zM1312 640q0 148 -73 273t-198 198t-273 73t-273 -73t-198 -198t-73 -273t73 -273t198 -198t273 -73t273 73t198 198t73 273zM1536 640 q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 57 | <glyph unicode="" horiz-adv-x="1920" d="M1111 540v4l-24 320q-1 13 -11 22.5t-23 9.5h-186q-13 0 -23 -9.5t-11 -22.5l-24 -320v-4q-1 -12 8 -20t21 -8h244q12 0 21 8t8 20zM1870 73q0 -73 -46 -73h-704q13 0 22 9.5t8 22.5l-20 256q-1 13 -11 22.5t-23 9.5h-272q-13 0 -23 -9.5t-11 -22.5l-20 -256 q-1 -13 8 -22.5t22 -9.5h-704q-46 0 -46 73q0 54 26 116l417 1044q8 19 26 33t38 14h339q-13 0 -23 -9.5t-11 -22.5l-15 -192q-1 -14 8 -23t22 -9h166q13 0 22 9t8 23l-15 192q-1 13 -11 22.5t-23 9.5h339q20 0 38 -14t26 -33l417 -1044q26 -62 26 -116z" /> | ||
| 58 | <glyph unicode="" horiz-adv-x="1664" d="M1280 192q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1536 192q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1664 416v-320q0 -40 -28 -68t-68 -28h-1472q-40 0 -68 28t-28 68v320q0 40 28 68t68 28h465l135 -136 q58 -56 136 -56t136 56l136 136h464q40 0 68 -28t28 -68zM1339 985q17 -41 -14 -70l-448 -448q-18 -19 -45 -19t-45 19l-448 448q-31 29 -14 70q17 39 59 39h256v448q0 26 19 45t45 19h256q26 0 45 -19t19 -45v-448h256q42 0 59 -39z" /> | ||
| 59 | <glyph unicode="" d="M1120 608q0 -12 -10 -24l-319 -319q-11 -9 -23 -9t-23 9l-320 320q-15 16 -7 35q8 20 30 20h192v352q0 14 9 23t23 9h192q14 0 23 -9t9 -23v-352h192q14 0 23 -9t9 -23zM768 1184q-148 0 -273 -73t-198 -198t-73 -273t73 -273t198 -198t273 -73t273 73t198 198t73 273 t-73 273t-198 198t-273 73zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 60 | <glyph unicode="" d="M1118 660q-8 -20 -30 -20h-192v-352q0 -14 -9 -23t-23 -9h-192q-14 0 -23 9t-9 23v352h-192q-14 0 -23 9t-9 23q0 12 10 24l319 319q11 9 23 9t23 -9l320 -320q15 -16 7 -35zM768 1184q-148 0 -273 -73t-198 -198t-73 -273t73 -273t198 -198t273 -73t273 73t198 198 t73 273t-73 273t-198 198t-273 73zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 61 | <glyph unicode="" d="M1023 576h316q-1 3 -2.5 8t-2.5 8l-212 496h-708l-212 -496q-1 -2 -2.5 -8t-2.5 -8h316l95 -192h320zM1536 546v-482q0 -26 -19 -45t-45 -19h-1408q-26 0 -45 19t-19 45v482q0 62 25 123l238 552q10 25 36.5 42t52.5 17h832q26 0 52.5 -17t36.5 -42l238 -552 q25 -61 25 -123z" /> | ||
| 62 | <glyph unicode="" d="M1184 640q0 -37 -32 -55l-544 -320q-15 -9 -32 -9q-16 0 -32 8q-32 19 -32 56v640q0 37 32 56q33 18 64 -1l544 -320q32 -18 32 -55zM1312 640q0 148 -73 273t-198 198t-273 73t-273 -73t-198 -198t-73 -273t73 -273t198 -198t273 -73t273 73t198 198t73 273zM1536 640 q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 63 | <glyph unicode="" d="M1536 1280v-448q0 -26 -19 -45t-45 -19h-448q-42 0 -59 40q-17 39 14 69l138 138q-148 137 -349 137q-104 0 -198.5 -40.5t-163.5 -109.5t-109.5 -163.5t-40.5 -198.5t40.5 -198.5t109.5 -163.5t163.5 -109.5t198.5 -40.5q119 0 225 52t179 147q7 10 23 12q14 0 25 -9 l137 -138q9 -8 9.5 -20.5t-7.5 -22.5q-109 -132 -264 -204.5t-327 -72.5q-156 0 -298 61t-245 164t-164 245t-61 298t61 298t164 245t245 164t298 61q147 0 284.5 -55.5t244.5 -156.5l130 129q29 31 70 14q39 -17 39 -59z" /> | ||
| 64 | <glyph unicode="" d="M1511 480q0 -5 -1 -7q-64 -268 -268 -434.5t-478 -166.5q-146 0 -282.5 55t-243.5 157l-129 -129q-19 -19 -45 -19t-45 19t-19 45v448q0 26 19 45t45 19h448q26 0 45 -19t19 -45t-19 -45l-137 -137q71 -66 161 -102t187 -36q134 0 250 65t186 179q11 17 53 117 q8 23 30 23h192q13 0 22.5 -9.5t9.5 -22.5zM1536 1280v-448q0 -26 -19 -45t-45 -19h-448q-26 0 -45 19t-19 45t19 45l138 138q-148 137 -349 137q-134 0 -250 -65t-186 -179q-11 -17 -53 -117q-8 -23 -30 -23h-199q-13 0 -22.5 9.5t-9.5 22.5v7q65 268 270 434.5t480 166.5 q146 0 284 -55.5t245 -156.5l130 129q19 19 45 19t45 -19t19 -45z" /> | ||
| 65 | <glyph unicode="" horiz-adv-x="1792" d="M384 352v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM384 608v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M384 864v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM1536 352v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-960q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h960q13 0 22.5 -9.5t9.5 -22.5z M1536 608v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-960q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h960q13 0 22.5 -9.5t9.5 -22.5zM1536 864v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-960q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h960q13 0 22.5 -9.5 t9.5 -22.5zM1664 160v832q0 13 -9.5 22.5t-22.5 9.5h-1472q-13 0 -22.5 -9.5t-9.5 -22.5v-832q0 -13 9.5 -22.5t22.5 -9.5h1472q13 0 22.5 9.5t9.5 22.5zM1792 1248v-1088q0 -66 -47 -113t-113 -47h-1472q-66 0 -113 47t-47 113v1088q0 66 47 113t113 47h1472q66 0 113 -47 t47 -113z" /> | ||
| 66 | <glyph unicode="" horiz-adv-x="1152" d="M320 768h512v192q0 106 -75 181t-181 75t-181 -75t-75 -181v-192zM1152 672v-576q0 -40 -28 -68t-68 -28h-960q-40 0 -68 28t-28 68v576q0 40 28 68t68 28h32v192q0 184 132 316t316 132t316 -132t132 -316v-192h32q40 0 68 -28t28 -68z" /> | ||
| 67 | <glyph unicode="" horiz-adv-x="1792" d="M320 1280q0 -72 -64 -110v-1266q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v1266q-64 38 -64 110q0 53 37.5 90.5t90.5 37.5t90.5 -37.5t37.5 -90.5zM1792 1216v-763q0 -25 -12.5 -38.5t-39.5 -27.5q-215 -116 -369 -116q-61 0 -123.5 22t-108.5 48 t-115.5 48t-142.5 22q-192 0 -464 -146q-17 -9 -33 -9q-26 0 -45 19t-19 45v742q0 32 31 55q21 14 79 43q236 120 421 120q107 0 200 -29t219 -88q38 -19 88 -19q54 0 117.5 21t110 47t88 47t54.5 21q26 0 45 -19t19 -45z" /> | ||
| 68 | <glyph unicode="" horiz-adv-x="1664" d="M1664 650q0 -166 -60 -314l-20 -49l-185 -33q-22 -83 -90.5 -136.5t-156.5 -53.5v-32q0 -14 -9 -23t-23 -9h-64q-14 0 -23 9t-9 23v576q0 14 9 23t23 9h64q14 0 23 -9t9 -23v-32q71 0 130 -35.5t93 -95.5l68 12q29 95 29 193q0 148 -88 279t-236.5 209t-315.5 78 t-315.5 -78t-236.5 -209t-88 -279q0 -98 29 -193l68 -12q34 60 93 95.5t130 35.5v32q0 14 9 23t23 9h64q14 0 23 -9t9 -23v-576q0 -14 -9 -23t-23 -9h-64q-14 0 -23 9t-9 23v32q-88 0 -156.5 53.5t-90.5 136.5l-185 33l-20 49q-60 148 -60 314q0 151 67 291t179 242.5 t266 163.5t320 61t320 -61t266 -163.5t179 -242.5t67 -291z" /> | ||
| 69 | <glyph unicode="" horiz-adv-x="768" d="M768 1184v-1088q0 -26 -19 -45t-45 -19t-45 19l-333 333h-262q-26 0 -45 19t-19 45v384q0 26 19 45t45 19h262l333 333q19 19 45 19t45 -19t19 -45z" /> | ||
| 70 | <glyph unicode="" horiz-adv-x="1152" d="M768 1184v-1088q0 -26 -19 -45t-45 -19t-45 19l-333 333h-262q-26 0 -45 19t-19 45v384q0 26 19 45t45 19h262l333 333q19 19 45 19t45 -19t19 -45zM1152 640q0 -76 -42.5 -141.5t-112.5 -93.5q-10 -5 -25 -5q-26 0 -45 18.5t-19 45.5q0 21 12 35.5t29 25t34 23t29 35.5 t12 57t-12 57t-29 35.5t-34 23t-29 25t-12 35.5q0 27 19 45.5t45 18.5q15 0 25 -5q70 -27 112.5 -93t42.5 -142z" /> | ||
| 71 | <glyph unicode="" horiz-adv-x="1664" d="M768 1184v-1088q0 -26 -19 -45t-45 -19t-45 19l-333 333h-262q-26 0 -45 19t-19 45v384q0 26 19 45t45 19h262l333 333q19 19 45 19t45 -19t19 -45zM1152 640q0 -76 -42.5 -141.5t-112.5 -93.5q-10 -5 -25 -5q-26 0 -45 18.5t-19 45.5q0 21 12 35.5t29 25t34 23t29 35.5 t12 57t-12 57t-29 35.5t-34 23t-29 25t-12 35.5q0 27 19 45.5t45 18.5q15 0 25 -5q70 -27 112.5 -93t42.5 -142zM1408 640q0 -153 -85 -282.5t-225 -188.5q-13 -5 -25 -5q-27 0 -46 19t-19 45q0 39 39 59q56 29 76 44q74 54 115.5 135.5t41.5 173.5t-41.5 173.5 t-115.5 135.5q-20 15 -76 44q-39 20 -39 59q0 26 19 45t45 19q13 0 26 -5q140 -59 225 -188.5t85 -282.5zM1664 640q0 -230 -127 -422.5t-338 -283.5q-13 -5 -26 -5q-26 0 -45 19t-19 45q0 36 39 59q7 4 22.5 10.5t22.5 10.5q46 25 82 51q123 91 192 227t69 289t-69 289 t-192 227q-36 26 -82 51q-7 4 -22.5 10.5t-22.5 10.5q-39 23 -39 59q0 26 19 45t45 19q13 0 26 -5q211 -91 338 -283.5t127 -422.5z" /> | ||
| 72 | <glyph unicode="" horiz-adv-x="1408" d="M384 384v-128h-128v128h128zM384 1152v-128h-128v128h128zM1152 1152v-128h-128v128h128zM128 129h384v383h-384v-383zM128 896h384v384h-384v-384zM896 896h384v384h-384v-384zM640 640v-640h-640v640h640zM1152 128v-128h-128v128h128zM1408 128v-128h-128v128h128z M1408 640v-384h-384v128h-128v-384h-128v640h384v-128h128v128h128zM640 1408v-640h-640v640h640zM1408 1408v-640h-640v640h640z" /> | ||
| 73 | <glyph unicode="" horiz-adv-x="1792" d="M63 0h-63v1408h63v-1408zM126 1h-32v1407h32v-1407zM220 1h-31v1407h31v-1407zM377 1h-31v1407h31v-1407zM534 1h-62v1407h62v-1407zM660 1h-31v1407h31v-1407zM723 1h-31v1407h31v-1407zM786 1h-31v1407h31v-1407zM943 1h-63v1407h63v-1407zM1100 1h-63v1407h63v-1407z M1226 1h-63v1407h63v-1407zM1352 1h-63v1407h63v-1407zM1446 1h-63v1407h63v-1407zM1635 1h-94v1407h94v-1407zM1698 1h-32v1407h32v-1407zM1792 0h-63v1408h63v-1408z" /> | ||
| 74 | <glyph unicode="" d="M448 1088q0 53 -37.5 90.5t-90.5 37.5t-90.5 -37.5t-37.5 -90.5t37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM1515 512q0 -53 -37 -90l-491 -492q-39 -37 -91 -37q-53 0 -90 37l-715 716q-38 37 -64.5 101t-26.5 117v416q0 52 38 90t90 38h416q53 0 117 -26.5t102 -64.5 l715 -714q37 -39 37 -91z" /> | ||
| 75 | <glyph unicode="" horiz-adv-x="1920" d="M448 1088q0 53 -37.5 90.5t-90.5 37.5t-90.5 -37.5t-37.5 -90.5t37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM1515 512q0 -53 -37 -90l-491 -492q-39 -37 -91 -37q-53 0 -90 37l-715 716q-38 37 -64.5 101t-26.5 117v416q0 52 38 90t90 38h416q53 0 117 -26.5t102 -64.5 l715 -714q37 -39 37 -91zM1899 512q0 -53 -37 -90l-491 -492q-39 -37 -91 -37q-36 0 -59 14t-53 45l470 470q37 37 37 90q0 52 -37 91l-715 714q-38 38 -102 64.5t-117 26.5h224q53 0 117 -26.5t102 -64.5l715 -714q37 -39 37 -91z" /> | ||
| 76 | <glyph unicode="" horiz-adv-x="1664" d="M1639 1058q40 -57 18 -129l-275 -906q-19 -64 -76.5 -107.5t-122.5 -43.5h-923q-77 0 -148.5 53.5t-99.5 131.5q-24 67 -2 127q0 4 3 27t4 37q1 8 -3 21.5t-3 19.5q2 11 8 21t16.5 23.5t16.5 23.5q23 38 45 91.5t30 91.5q3 10 0.5 30t-0.5 28q3 11 17 28t17 23 q21 36 42 92t25 90q1 9 -2.5 32t0.5 28q4 13 22 30.5t22 22.5q19 26 42.5 84.5t27.5 96.5q1 8 -3 25.5t-2 26.5q2 8 9 18t18 23t17 21q8 12 16.5 30.5t15 35t16 36t19.5 32t26.5 23.5t36 11.5t47.5 -5.5l-1 -3q38 9 51 9h761q74 0 114 -56t18 -130l-274 -906 q-36 -119 -71.5 -153.5t-128.5 -34.5h-869q-27 0 -38 -15q-11 -16 -1 -43q24 -70 144 -70h923q29 0 56 15.5t35 41.5l300 987q7 22 5 57q38 -15 59 -43zM575 1056q-4 -13 2 -22.5t20 -9.5h608q13 0 25.5 9.5t16.5 22.5l21 64q4 13 -2 22.5t-20 9.5h-608q-13 0 -25.5 -9.5 t-16.5 -22.5zM492 800q-4 -13 2 -22.5t20 -9.5h608q13 0 25.5 9.5t16.5 22.5l21 64q4 13 -2 22.5t-20 9.5h-608q-13 0 -25.5 -9.5t-16.5 -22.5z" /> | ||
| 77 | <glyph unicode="" horiz-adv-x="1280" d="M1164 1408q23 0 44 -9q33 -13 52.5 -41t19.5 -62v-1289q0 -34 -19.5 -62t-52.5 -41q-19 -8 -44 -8q-48 0 -83 32l-441 424l-441 -424q-36 -33 -83 -33q-23 0 -44 9q-33 13 -52.5 41t-19.5 62v1289q0 34 19.5 62t52.5 41q21 9 44 9h1048z" /> | ||
| 78 | <glyph unicode="" horiz-adv-x="1664" d="M384 0h896v256h-896v-256zM384 640h896v384h-160q-40 0 -68 28t-28 68v160h-640v-640zM1536 576q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1664 576v-416q0 -13 -9.5 -22.5t-22.5 -9.5h-224v-160q0 -40 -28 -68t-68 -28h-960q-40 0 -68 28t-28 68 v160h-224q-13 0 -22.5 9.5t-9.5 22.5v416q0 79 56.5 135.5t135.5 56.5h64v544q0 40 28 68t68 28h672q40 0 88 -20t76 -48l152 -152q28 -28 48 -76t20 -88v-256h64q79 0 135.5 -56.5t56.5 -135.5z" /> | ||
| 79 | <glyph unicode="" horiz-adv-x="1920" d="M960 864q119 0 203.5 -84.5t84.5 -203.5t-84.5 -203.5t-203.5 -84.5t-203.5 84.5t-84.5 203.5t84.5 203.5t203.5 84.5zM1664 1280q106 0 181 -75t75 -181v-896q0 -106 -75 -181t-181 -75h-1408q-106 0 -181 75t-75 181v896q0 106 75 181t181 75h224l51 136 q19 49 69.5 84.5t103.5 35.5h512q53 0 103.5 -35.5t69.5 -84.5l51 -136h224zM960 128q185 0 316.5 131.5t131.5 316.5t-131.5 316.5t-316.5 131.5t-316.5 -131.5t-131.5 -316.5t131.5 -316.5t316.5 -131.5z" /> | ||
| 80 | <glyph unicode="" horiz-adv-x="1664" d="M725 977l-170 -450q73 -1 153.5 -2t119 -1.5t52.5 -0.5l29 2q-32 95 -92 241q-53 132 -92 211zM21 -128h-21l2 79q22 7 80 18q89 16 110 31q20 16 48 68l237 616l280 724h75h53l11 -21l205 -480q103 -242 124 -297q39 -102 96 -235q26 -58 65 -164q24 -67 65 -149 q22 -49 35 -57q22 -19 69 -23q47 -6 103 -27q6 -39 6 -57q0 -14 -1 -26q-80 0 -192 8q-93 8 -189 8q-79 0 -135 -2l-200 -11l-58 -2q0 45 4 78l131 28q56 13 68 23q12 12 12 27t-6 32l-47 114l-92 228l-450 2q-29 -65 -104 -274q-23 -64 -23 -84q0 -31 17 -43 q26 -21 103 -32q3 0 13.5 -2t30 -5t40.5 -6q1 -28 1 -58q0 -17 -2 -27q-66 0 -349 20l-48 -8q-81 -14 -167 -14z" /> | ||
| 81 | <glyph unicode="" horiz-adv-x="1408" d="M555 15q76 -32 140 -32q131 0 216 41t122 113q38 70 38 181q0 114 -41 180q-58 94 -141 126q-80 32 -247 32q-74 0 -101 -10v-144l-1 -173l3 -270q0 -15 12 -44zM541 761q43 -7 109 -7q175 0 264 65t89 224q0 112 -85 187q-84 75 -255 75q-52 0 -130 -13q0 -44 2 -77 q7 -122 6 -279l-1 -98q0 -43 1 -77zM0 -128l2 94q45 9 68 12q77 12 123 31q17 27 21 51q9 66 9 194l-2 497q-5 256 -9 404q-1 87 -11 109q-1 4 -12 12q-18 12 -69 15q-30 2 -114 13l-4 83l260 6l380 13l45 1q5 0 14 0.5t14 0.5q1 0 21.5 -0.5t40.5 -0.5h74q88 0 191 -27 q43 -13 96 -39q57 -29 102 -76q44 -47 65 -104t21 -122q0 -70 -32 -128t-95 -105q-26 -20 -150 -77q177 -41 267 -146q92 -106 92 -236q0 -76 -29 -161q-21 -62 -71 -117q-66 -72 -140 -108q-73 -36 -203 -60q-82 -15 -198 -11l-197 4q-84 2 -298 -11q-33 -3 -272 -11z" /> | ||
| 82 | <glyph unicode="" horiz-adv-x="1024" d="M0 -126l17 85q4 1 77 20q76 19 116 39q29 37 41 101l27 139l56 268l12 64q8 44 17 84.5t16 67t12.5 46.5t9 30.5t3.5 11.5l29 157l16 63l22 135l8 50v38q-41 22 -144 28q-28 2 -38 4l19 103l317 -14q39 -2 73 -2q66 0 214 9q33 2 68 4.5t36 2.5q-2 -19 -6 -38 q-7 -29 -13 -51q-55 -19 -109 -31q-64 -16 -101 -31q-12 -31 -24 -88q-9 -44 -13 -82q-44 -199 -66 -306l-61 -311l-38 -158l-43 -235l-12 -45q-2 -7 1 -27q64 -15 119 -21q36 -5 66 -10q-1 -29 -7 -58q-7 -31 -9 -41q-18 0 -23 -1q-24 -2 -42 -2q-9 0 -28 3q-19 4 -145 17 l-198 2q-41 1 -174 -11q-74 -7 -98 -9z" /> | ||
| 83 | <glyph unicode="" horiz-adv-x="1792" d="M81 1407l54 -27q20 -5 211 -5h130l19 3l115 1l215 -1h293l34 -2q14 -1 28 7t21 16l7 8l42 1q15 0 28 -1v-104.5t1 -131.5l1 -100l-1 -58q0 -32 -4 -51q-39 -15 -68 -18q-25 43 -54 128q-8 24 -15.5 62.5t-11.5 65.5t-6 29q-13 15 -27 19q-7 2 -42.5 2t-103.5 -1t-111 -1 q-34 0 -67 -5q-10 -97 -8 -136l1 -152v-332l3 -359l-1 -147q-1 -46 11 -85q49 -25 89 -32q2 0 18 -5t44 -13t43 -12q30 -8 50 -18q5 -45 5 -50q0 -10 -3 -29q-14 -1 -34 -1q-110 0 -187 10q-72 8 -238 8q-88 0 -233 -14q-48 -4 -70 -4q-2 22 -2 26l-1 26v9q21 33 79 49 q139 38 159 50q9 21 12 56q8 192 6 433l-5 428q-1 62 -0.5 118.5t0.5 102.5t-2 57t-6 15q-6 5 -14 6q-38 6 -148 6q-43 0 -100 -13.5t-73 -24.5q-13 -9 -22 -33t-22 -75t-24 -84q-6 -19 -19.5 -32t-20.5 -13q-44 27 -56 44v297v86zM1744 128q33 0 42 -18.5t-11 -44.5 l-126 -162q-20 -26 -49 -26t-49 26l-126 162q-20 26 -11 44.5t42 18.5h80v1024h-80q-33 0 -42 18.5t11 44.5l126 162q20 26 49 26t49 -26l126 -162q20 -26 11 -44.5t-42 -18.5h-80v-1024h80z" /> | ||
| 84 | <glyph unicode="" d="M81 1407l54 -27q20 -5 211 -5h130l19 3l115 1l446 -1h318l34 -2q14 -1 28 7t21 16l7 8l42 1q15 0 28 -1v-104.5t1 -131.5l1 -100l-1 -58q0 -32 -4 -51q-39 -15 -68 -18q-25 43 -54 128q-8 24 -15.5 62.5t-11.5 65.5t-6 29q-13 15 -27 19q-7 2 -58.5 2t-138.5 -1t-128 -1 q-94 0 -127 -5q-10 -97 -8 -136l1 -152v52l3 -359l-1 -147q-1 -46 11 -85q49 -25 89 -32q2 0 18 -5t44 -13t43 -12q30 -8 50 -18q5 -45 5 -50q0 -10 -3 -29q-14 -1 -34 -1q-110 0 -187 10q-72 8 -238 8q-82 0 -233 -13q-45 -5 -70 -5q-2 22 -2 26l-1 26v9q21 33 79 49 q139 38 159 50q9 21 12 56q6 137 6 433l-5 44q0 265 -2 278q-2 11 -6 15q-6 5 -14 6q-38 6 -148 6q-50 0 -168.5 -14t-132.5 -24q-13 -9 -22 -33t-22 -75t-24 -84q-6 -19 -19.5 -32t-20.5 -13q-44 27 -56 44v297v86zM1505 113q26 -20 26 -49t-26 -49l-162 -126 q-26 -20 -44.5 -11t-18.5 42v80h-1024v-80q0 -33 -18.5 -42t-44.5 11l-162 126q-26 20 -26 49t26 49l162 126q26 20 44.5 11t18.5 -42v-80h1024v80q0 33 18.5 42t44.5 -11z" /> | ||
| 85 | <glyph unicode="" horiz-adv-x="1792" d="M1792 192v-128q0 -26 -19 -45t-45 -19h-1664q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1664q26 0 45 -19t19 -45zM1408 576v-128q0 -26 -19 -45t-45 -19h-1280q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1280q26 0 45 -19t19 -45zM1664 960v-128q0 -26 -19 -45 t-45 -19h-1536q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1536q26 0 45 -19t19 -45zM1280 1344v-128q0 -26 -19 -45t-45 -19h-1152q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1152q26 0 45 -19t19 -45z" /> | ||
| 86 | <glyph unicode="" horiz-adv-x="1792" d="M1792 192v-128q0 -26 -19 -45t-45 -19h-1664q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1664q26 0 45 -19t19 -45zM1408 576v-128q0 -26 -19 -45t-45 -19h-896q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h896q26 0 45 -19t19 -45zM1664 960v-128q0 -26 -19 -45t-45 -19 h-1408q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1408q26 0 45 -19t19 -45zM1280 1344v-128q0 -26 -19 -45t-45 -19h-640q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h640q26 0 45 -19t19 -45z" /> | ||
| 87 | <glyph unicode="" horiz-adv-x="1792" d="M1792 192v-128q0 -26 -19 -45t-45 -19h-1664q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1664q26 0 45 -19t19 -45zM1792 576v-128q0 -26 -19 -45t-45 -19h-1280q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1280q26 0 45 -19t19 -45zM1792 960v-128q0 -26 -19 -45 t-45 -19h-1536q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1536q26 0 45 -19t19 -45zM1792 1344v-128q0 -26 -19 -45t-45 -19h-1152q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1152q26 0 45 -19t19 -45z" /> | ||
| 88 | <glyph unicode="" horiz-adv-x="1792" d="M1792 192v-128q0 -26 -19 -45t-45 -19h-1664q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1664q26 0 45 -19t19 -45zM1792 576v-128q0 -26 -19 -45t-45 -19h-1664q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1664q26 0 45 -19t19 -45zM1792 960v-128q0 -26 -19 -45 t-45 -19h-1664q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1664q26 0 45 -19t19 -45zM1792 1344v-128q0 -26 -19 -45t-45 -19h-1664q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1664q26 0 45 -19t19 -45z" /> | ||
| 89 | <glyph unicode="" horiz-adv-x="1792" d="M256 224v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-192q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h192q13 0 22.5 -9.5t9.5 -22.5zM256 608v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-192q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h192q13 0 22.5 -9.5 t9.5 -22.5zM256 992v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-192q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h192q13 0 22.5 -9.5t9.5 -22.5zM1792 224v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1344q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1344 q13 0 22.5 -9.5t9.5 -22.5zM256 1376v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-192q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h192q13 0 22.5 -9.5t9.5 -22.5zM1792 608v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1344q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5 t22.5 9.5h1344q13 0 22.5 -9.5t9.5 -22.5zM1792 992v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1344q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1344q13 0 22.5 -9.5t9.5 -22.5zM1792 1376v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1344q-13 0 -22.5 9.5t-9.5 22.5v192 q0 13 9.5 22.5t22.5 9.5h1344q13 0 22.5 -9.5t9.5 -22.5z" /> | ||
| 90 | <glyph unicode="" horiz-adv-x="1792" d="M384 992v-576q0 -13 -9.5 -22.5t-22.5 -9.5q-14 0 -23 9l-288 288q-9 9 -9 23t9 23l288 288q9 9 23 9q13 0 22.5 -9.5t9.5 -22.5zM1792 224v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1728q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1728q13 0 22.5 -9.5 t9.5 -22.5zM1792 608v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1088q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1088q13 0 22.5 -9.5t9.5 -22.5zM1792 992v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1088q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1088 q13 0 22.5 -9.5t9.5 -22.5zM1792 1376v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1728q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1728q13 0 22.5 -9.5t9.5 -22.5z" /> | ||
| 91 | <glyph unicode="" horiz-adv-x="1792" d="M352 704q0 -14 -9 -23l-288 -288q-9 -9 -23 -9q-13 0 -22.5 9.5t-9.5 22.5v576q0 13 9.5 22.5t22.5 9.5q14 0 23 -9l288 -288q9 -9 9 -23zM1792 224v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1728q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1728q13 0 22.5 -9.5 t9.5 -22.5zM1792 608v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1088q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1088q13 0 22.5 -9.5t9.5 -22.5zM1792 992v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1088q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1088 q13 0 22.5 -9.5t9.5 -22.5zM1792 1376v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1728q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1728q13 0 22.5 -9.5t9.5 -22.5z" /> | ||
| 92 | <glyph unicode="" horiz-adv-x="1792" d="M1792 1184v-1088q0 -42 -39 -59q-13 -5 -25 -5q-27 0 -45 19l-403 403v-166q0 -119 -84.5 -203.5t-203.5 -84.5h-704q-119 0 -203.5 84.5t-84.5 203.5v704q0 119 84.5 203.5t203.5 84.5h704q119 0 203.5 -84.5t84.5 -203.5v-165l403 402q18 19 45 19q12 0 25 -5 q39 -17 39 -59z" /> | ||
| 93 | <glyph unicode="" horiz-adv-x="1920" d="M640 960q0 -80 -56 -136t-136 -56t-136 56t-56 136t56 136t136 56t136 -56t56 -136zM1664 576v-448h-1408v192l320 320l160 -160l512 512zM1760 1280h-1600q-13 0 -22.5 -9.5t-9.5 -22.5v-1216q0 -13 9.5 -22.5t22.5 -9.5h1600q13 0 22.5 9.5t9.5 22.5v1216 q0 13 -9.5 22.5t-22.5 9.5zM1920 1248v-1216q0 -66 -47 -113t-113 -47h-1600q-66 0 -113 47t-47 113v1216q0 66 47 113t113 47h1600q66 0 113 -47t47 -113z" /> | ||
| 94 | <glyph unicode="" d="M363 0l91 91l-235 235l-91 -91v-107h128v-128h107zM886 928q0 22 -22 22q-10 0 -17 -7l-542 -542q-7 -7 -7 -17q0 -22 22 -22q10 0 17 7l542 542q7 7 7 17zM832 1120l416 -416l-832 -832h-416v416zM1515 1024q0 -53 -37 -90l-166 -166l-416 416l166 165q36 38 90 38 q53 0 91 -38l235 -234q37 -39 37 -91z" /> | ||
| 95 | <glyph unicode="" horiz-adv-x="1024" d="M768 896q0 106 -75 181t-181 75t-181 -75t-75 -181t75 -181t181 -75t181 75t75 181zM1024 896q0 -109 -33 -179l-364 -774q-16 -33 -47.5 -52t-67.5 -19t-67.5 19t-46.5 52l-365 774q-33 70 -33 179q0 212 150 362t362 150t362 -150t150 -362z" /> | ||
| 96 | <glyph unicode="" d="M768 96v1088q-148 0 -273 -73t-198 -198t-73 -273t73 -273t198 -198t273 -73zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 97 | <glyph unicode="" horiz-adv-x="1024" d="M512 384q0 36 -20 69q-1 1 -15.5 22.5t-25.5 38t-25 44t-21 50.5q-4 16 -21 16t-21 -16q-7 -23 -21 -50.5t-25 -44t-25.5 -38t-15.5 -22.5q-20 -33 -20 -69q0 -53 37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM1024 512q0 -212 -150 -362t-362 -150t-362 150t-150 362 q0 145 81 275q6 9 62.5 90.5t101 151t99.5 178t83 201.5q9 30 34 47t51 17t51.5 -17t33.5 -47q28 -93 83 -201.5t99.5 -178t101 -151t62.5 -90.5q81 -127 81 -275z" /> | ||
| 98 | <glyph unicode="" horiz-adv-x="1792" d="M888 352l116 116l-152 152l-116 -116v-56h96v-96h56zM1328 1072q-16 16 -33 -1l-350 -350q-17 -17 -1 -33t33 1l350 350q17 17 1 33zM1408 478v-190q0 -119 -84.5 -203.5t-203.5 -84.5h-832q-119 0 -203.5 84.5t-84.5 203.5v832q0 119 84.5 203.5t203.5 84.5h832 q63 0 117 -25q15 -7 18 -23q3 -17 -9 -29l-49 -49q-14 -14 -32 -8q-23 6 -45 6h-832q-66 0 -113 -47t-47 -113v-832q0 -66 47 -113t113 -47h832q66 0 113 47t47 113v126q0 13 9 22l64 64q15 15 35 7t20 -29zM1312 1216l288 -288l-672 -672h-288v288zM1756 1084l-92 -92 l-288 288l92 92q28 28 68 28t68 -28l152 -152q28 -28 28 -68t-28 -68z" /> | ||
| 99 | <glyph unicode="" horiz-adv-x="1664" d="M1408 547v-259q0 -119 -84.5 -203.5t-203.5 -84.5h-832q-119 0 -203.5 84.5t-84.5 203.5v832q0 119 84.5 203.5t203.5 84.5h255v0q13 0 22.5 -9.5t9.5 -22.5q0 -27 -26 -32q-77 -26 -133 -60q-10 -4 -16 -4h-112q-66 0 -113 -47t-47 -113v-832q0 -66 47 -113t113 -47h832 q66 0 113 47t47 113v214q0 19 18 29q28 13 54 37q16 16 35 8q21 -9 21 -29zM1645 1043l-384 -384q-18 -19 -45 -19q-12 0 -25 5q-39 17 -39 59v192h-160q-323 0 -438 -131q-119 -137 -74 -473q3 -23 -20 -34q-8 -2 -12 -2q-16 0 -26 13q-10 14 -21 31t-39.5 68.5t-49.5 99.5 t-38.5 114t-17.5 122q0 49 3.5 91t14 90t28 88t47 81.5t68.5 74t94.5 61.5t124.5 48.5t159.5 30.5t196.5 11h160v192q0 42 39 59q13 5 25 5q26 0 45 -19l384 -384q19 -19 19 -45t-19 -45z" /> | ||
| 100 | <glyph unicode="" horiz-adv-x="1664" d="M1408 606v-318q0 -119 -84.5 -203.5t-203.5 -84.5h-832q-119 0 -203.5 84.5t-84.5 203.5v832q0 119 84.5 203.5t203.5 84.5h832q63 0 117 -25q15 -7 18 -23q3 -17 -9 -29l-49 -49q-10 -10 -23 -10q-3 0 -9 2q-23 6 -45 6h-832q-66 0 -113 -47t-47 -113v-832 q0 -66 47 -113t113 -47h832q66 0 113 47t47 113v254q0 13 9 22l64 64q10 10 23 10q6 0 12 -3q20 -8 20 -29zM1639 1095l-814 -814q-24 -24 -57 -24t-57 24l-430 430q-24 24 -24 57t24 57l110 110q24 24 57 24t57 -24l263 -263l647 647q24 24 57 24t57 -24l110 -110 q24 -24 24 -57t-24 -57z" /> | ||
| 101 | <glyph unicode="" horiz-adv-x="1792" d="M1792 640q0 -26 -19 -45l-256 -256q-19 -19 -45 -19t-45 19t-19 45v128h-384v-384h128q26 0 45 -19t19 -45t-19 -45l-256 -256q-19 -19 -45 -19t-45 19l-256 256q-19 19 -19 45t19 45t45 19h128v384h-384v-128q0 -26 -19 -45t-45 -19t-45 19l-256 256q-19 19 -19 45 t19 45l256 256q19 19 45 19t45 -19t19 -45v-128h384v384h-128q-26 0 -45 19t-19 45t19 45l256 256q19 19 45 19t45 -19l256 -256q19 -19 19 -45t-19 -45t-45 -19h-128v-384h384v128q0 26 19 45t45 19t45 -19l256 -256q19 -19 19 -45z" /> | ||
| 102 | <glyph unicode="" horiz-adv-x="1024" d="M979 1395q19 19 32 13t13 -32v-1472q0 -26 -13 -32t-32 13l-710 710q-9 9 -13 19v-678q0 -26 -19 -45t-45 -19h-128q-26 0 -45 19t-19 45v1408q0 26 19 45t45 19h128q26 0 45 -19t19 -45v-678q4 11 13 19z" /> | ||
| 103 | <glyph unicode="" horiz-adv-x="1792" d="M1747 1395q19 19 32 13t13 -32v-1472q0 -26 -13 -32t-32 13l-710 710q-9 9 -13 19v-710q0 -26 -13 -32t-32 13l-710 710q-9 9 -13 19v-678q0 -26 -19 -45t-45 -19h-128q-26 0 -45 19t-19 45v1408q0 26 19 45t45 19h128q26 0 45 -19t19 -45v-678q4 11 13 19l710 710 q19 19 32 13t13 -32v-710q4 11 13 19z" /> | ||
| 104 | <glyph unicode="" horiz-adv-x="1664" d="M1619 1395q19 19 32 13t13 -32v-1472q0 -26 -13 -32t-32 13l-710 710q-8 9 -13 19v-710q0 -26 -13 -32t-32 13l-710 710q-19 19 -19 45t19 45l710 710q19 19 32 13t13 -32v-710q5 11 13 19z" /> | ||
| 105 | <glyph unicode="" horiz-adv-x="1408" d="M1384 609l-1328 -738q-23 -13 -39.5 -3t-16.5 36v1472q0 26 16.5 36t39.5 -3l1328 -738q23 -13 23 -31t-23 -31z" /> | ||
| 106 | <glyph unicode="" d="M1536 1344v-1408q0 -26 -19 -45t-45 -19h-512q-26 0 -45 19t-19 45v1408q0 26 19 45t45 19h512q26 0 45 -19t19 -45zM640 1344v-1408q0 -26 -19 -45t-45 -19h-512q-26 0 -45 19t-19 45v1408q0 26 19 45t45 19h512q26 0 45 -19t19 -45z" /> | ||
| 107 | <glyph unicode="" d="M1536 1344v-1408q0 -26 -19 -45t-45 -19h-1408q-26 0 -45 19t-19 45v1408q0 26 19 45t45 19h1408q26 0 45 -19t19 -45z" /> | ||
| 108 | <glyph unicode="" horiz-adv-x="1664" d="M45 -115q-19 -19 -32 -13t-13 32v1472q0 26 13 32t32 -13l710 -710q8 -8 13 -19v710q0 26 13 32t32 -13l710 -710q19 -19 19 -45t-19 -45l-710 -710q-19 -19 -32 -13t-13 32v710q-5 -10 -13 -19z" /> | ||
| 109 | <glyph unicode="" horiz-adv-x="1792" d="M45 -115q-19 -19 -32 -13t-13 32v1472q0 26 13 32t32 -13l710 -710q8 -8 13 -19v710q0 26 13 32t32 -13l710 -710q8 -8 13 -19v678q0 26 19 45t45 19h128q26 0 45 -19t19 -45v-1408q0 -26 -19 -45t-45 -19h-128q-26 0 -45 19t-19 45v678q-5 -10 -13 -19l-710 -710 q-19 -19 -32 -13t-13 32v710q-5 -10 -13 -19z" /> | ||
| 110 | <glyph unicode="" horiz-adv-x="1024" d="M45 -115q-19 -19 -32 -13t-13 32v1472q0 26 13 32t32 -13l710 -710q8 -8 13 -19v678q0 26 19 45t45 19h128q26 0 45 -19t19 -45v-1408q0 -26 -19 -45t-45 -19h-128q-26 0 -45 19t-19 45v678q-5 -10 -13 -19z" /> | ||
| 111 | <glyph unicode="" horiz-adv-x="1538" d="M14 557l710 710q19 19 45 19t45 -19l710 -710q19 -19 13 -32t-32 -13h-1472q-26 0 -32 13t13 32zM1473 0h-1408q-26 0 -45 19t-19 45v256q0 26 19 45t45 19h1408q26 0 45 -19t19 -45v-256q0 -26 -19 -45t-45 -19z" /> | ||
| 112 | <glyph unicode="" horiz-adv-x="1152" d="M742 -37l-652 651q-37 37 -37 90.5t37 90.5l652 651q37 37 90.5 37t90.5 -37l75 -75q37 -37 37 -90.5t-37 -90.5l-486 -486l486 -485q37 -38 37 -91t-37 -90l-75 -75q-37 -37 -90.5 -37t-90.5 37z" /> | ||
| 113 | <glyph unicode="" horiz-adv-x="1152" d="M1099 704q0 -52 -37 -91l-652 -651q-37 -37 -90 -37t-90 37l-76 75q-37 39 -37 91q0 53 37 90l486 486l-486 485q-37 39 -37 91q0 53 37 90l76 75q36 38 90 38t90 -38l652 -651q37 -37 37 -90z" /> | ||
| 114 | <glyph unicode="" d="M1216 576v128q0 26 -19 45t-45 19h-256v256q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-256h-256q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h256v-256q0 -26 19 -45t45 -19h128q26 0 45 19t19 45v256h256q26 0 45 19t19 45zM1536 640q0 -209 -103 -385.5 t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 115 | <glyph unicode="" d="M1216 576v128q0 26 -19 45t-45 19h-768q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h768q26 0 45 19t19 45zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5 t103 -385.5z" /> | ||
| 116 | <glyph unicode="" d="M1149 414q0 26 -19 45l-181 181l181 181q19 19 19 45q0 27 -19 46l-90 90q-19 19 -46 19q-26 0 -45 -19l-181 -181l-181 181q-19 19 -45 19q-27 0 -46 -19l-90 -90q-19 -19 -19 -46q0 -26 19 -45l181 -181l-181 -181q-19 -19 -19 -45q0 -27 19 -46l90 -90q19 -19 46 -19 q26 0 45 19l181 181l181 -181q19 -19 45 -19q27 0 46 19l90 90q19 19 19 46zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 117 | <glyph unicode="" d="M1284 802q0 28 -18 46l-91 90q-19 19 -45 19t-45 -19l-408 -407l-226 226q-19 19 -45 19t-45 -19l-91 -90q-18 -18 -18 -46q0 -27 18 -45l362 -362q19 -19 45 -19q27 0 46 19l543 543q18 18 18 45zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103 t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 118 | <glyph unicode="" d="M896 160v192q0 14 -9 23t-23 9h-192q-14 0 -23 -9t-9 -23v-192q0 -14 9 -23t23 -9h192q14 0 23 9t9 23zM1152 832q0 88 -55.5 163t-138.5 116t-170 41q-243 0 -371 -213q-15 -24 8 -42l132 -100q7 -6 19 -6q16 0 25 12q53 68 86 92q34 24 86 24q48 0 85.5 -26t37.5 -59 q0 -38 -20 -61t-68 -45q-63 -28 -115.5 -86.5t-52.5 -125.5v-36q0 -14 9 -23t23 -9h192q14 0 23 9t9 23q0 19 21.5 49.5t54.5 49.5q32 18 49 28.5t46 35t44.5 48t28 60.5t12.5 81zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5 t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 119 | <glyph unicode="" d="M1024 160v160q0 14 -9 23t-23 9h-96v512q0 14 -9 23t-23 9h-320q-14 0 -23 -9t-9 -23v-160q0 -14 9 -23t23 -9h96v-320h-96q-14 0 -23 -9t-9 -23v-160q0 -14 9 -23t23 -9h448q14 0 23 9t9 23zM896 1056v160q0 14 -9 23t-23 9h-192q-14 0 -23 -9t-9 -23v-160q0 -14 9 -23 t23 -9h192q14 0 23 9t9 23zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 120 | <glyph unicode="" d="M1197 512h-109q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h109q-32 108 -112.5 188.5t-188.5 112.5v-109q0 -26 -19 -45t-45 -19h-128q-26 0 -45 19t-19 45v109q-108 -32 -188.5 -112.5t-112.5 -188.5h109q26 0 45 -19t19 -45v-128q0 -26 -19 -45t-45 -19h-109 q32 -108 112.5 -188.5t188.5 -112.5v109q0 26 19 45t45 19h128q26 0 45 -19t19 -45v-109q108 32 188.5 112.5t112.5 188.5zM1536 704v-128q0 -26 -19 -45t-45 -19h-143q-37 -161 -154.5 -278.5t-278.5 -154.5v-143q0 -26 -19 -45t-45 -19h-128q-26 0 -45 19t-19 45v143 q-161 37 -278.5 154.5t-154.5 278.5h-143q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h143q37 161 154.5 278.5t278.5 154.5v143q0 26 19 45t45 19h128q26 0 45 -19t19 -45v-143q161 -37 278.5 -154.5t154.5 -278.5h143q26 0 45 -19t19 -45z" /> | ||
| 121 | <glyph unicode="" d="M1097 457l-146 -146q-10 -10 -23 -10t-23 10l-137 137l-137 -137q-10 -10 -23 -10t-23 10l-146 146q-10 10 -10 23t10 23l137 137l-137 137q-10 10 -10 23t10 23l146 146q10 10 23 10t23 -10l137 -137l137 137q10 10 23 10t23 -10l146 -146q10 -10 10 -23t-10 -23 l-137 -137l137 -137q10 -10 10 -23t-10 -23zM1312 640q0 148 -73 273t-198 198t-273 73t-273 -73t-198 -198t-73 -273t73 -273t198 -198t273 -73t273 73t198 198t73 273zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5 t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 122 | <glyph unicode="" d="M1171 723l-422 -422q-19 -19 -45 -19t-45 19l-294 294q-19 19 -19 45t19 45l102 102q19 19 45 19t45 -19l147 -147l275 275q19 19 45 19t45 -19l102 -102q19 -19 19 -45t-19 -45zM1312 640q0 148 -73 273t-198 198t-273 73t-273 -73t-198 -198t-73 -273t73 -273t198 -198 t273 -73t273 73t198 198t73 273zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 123 | <glyph unicode="" d="M1312 643q0 161 -87 295l-754 -753q137 -89 297 -89q111 0 211.5 43.5t173.5 116.5t116 174.5t43 212.5zM313 344l755 754q-135 91 -300 91q-148 0 -273 -73t-198 -199t-73 -274q0 -162 89 -299zM1536 643q0 -157 -61 -300t-163.5 -246t-245 -164t-298.5 -61t-298.5 61 t-245 164t-163.5 246t-61 300t61 299.5t163.5 245.5t245 164t298.5 61t298.5 -61t245 -164t163.5 -245.5t61 -299.5z" /> | ||
| 124 | <glyph unicode="" d="M1536 640v-128q0 -53 -32.5 -90.5t-84.5 -37.5h-704l293 -294q38 -36 38 -90t-38 -90l-75 -76q-37 -37 -90 -37q-52 0 -91 37l-651 652q-37 37 -37 90q0 52 37 91l651 650q38 38 91 38q52 0 90 -38l75 -74q38 -38 38 -91t-38 -91l-293 -293h704q52 0 84.5 -37.5 t32.5 -90.5z" /> | ||
| 125 | <glyph unicode="" d="M1472 576q0 -54 -37 -91l-651 -651q-39 -37 -91 -37q-51 0 -90 37l-75 75q-38 38 -38 91t38 91l293 293h-704q-52 0 -84.5 37.5t-32.5 90.5v128q0 53 32.5 90.5t84.5 37.5h704l-293 294q-38 36 -38 90t38 90l75 75q38 38 90 38q53 0 91 -38l651 -651q37 -35 37 -90z" /> | ||
| 126 | <glyph unicode="" horiz-adv-x="1664" d="M1611 565q0 -51 -37 -90l-75 -75q-38 -38 -91 -38q-54 0 -90 38l-294 293v-704q0 -52 -37.5 -84.5t-90.5 -32.5h-128q-53 0 -90.5 32.5t-37.5 84.5v704l-294 -293q-36 -38 -90 -38t-90 38l-75 75q-38 38 -38 90q0 53 38 91l651 651q35 37 90 37q54 0 91 -37l651 -651 q37 -39 37 -91z" /> | ||
| 127 | <glyph unicode="" horiz-adv-x="1664" d="M1611 704q0 -53 -37 -90l-651 -652q-39 -37 -91 -37q-53 0 -90 37l-651 652q-38 36 -38 90q0 53 38 91l74 75q39 37 91 37q53 0 90 -37l294 -294v704q0 52 38 90t90 38h128q52 0 90 -38t38 -90v-704l294 294q37 37 90 37q52 0 91 -37l75 -75q37 -39 37 -91z" /> | ||
| 128 | <glyph unicode="" horiz-adv-x="1792" d="M1792 896q0 -26 -19 -45l-512 -512q-19 -19 -45 -19t-45 19t-19 45v256h-224q-98 0 -175.5 -6t-154 -21.5t-133 -42.5t-105.5 -69.5t-80 -101t-48.5 -138.5t-17.5 -181q0 -55 5 -123q0 -6 2.5 -23.5t2.5 -26.5q0 -15 -8.5 -25t-23.5 -10q-16 0 -28 17q-7 9 -13 22 t-13.5 30t-10.5 24q-127 285 -127 451q0 199 53 333q162 403 875 403h224v256q0 26 19 45t45 19t45 -19l512 -512q19 -19 19 -45z" /> | ||
| 129 | <glyph unicode="" d="M755 480q0 -13 -10 -23l-332 -332l144 -144q19 -19 19 -45t-19 -45t-45 -19h-448q-26 0 -45 19t-19 45v448q0 26 19 45t45 19t45 -19l144 -144l332 332q10 10 23 10t23 -10l114 -114q10 -10 10 -23zM1536 1344v-448q0 -26 -19 -45t-45 -19t-45 19l-144 144l-332 -332 q-10 -10 -23 -10t-23 10l-114 114q-10 10 -10 23t10 23l332 332l-144 144q-19 19 -19 45t19 45t45 19h448q26 0 45 -19t19 -45z" /> | ||
| 130 | <glyph unicode="" d="M768 576v-448q0 -26 -19 -45t-45 -19t-45 19l-144 144l-332 -332q-10 -10 -23 -10t-23 10l-114 114q-10 10 -10 23t10 23l332 332l-144 144q-19 19 -19 45t19 45t45 19h448q26 0 45 -19t19 -45zM1523 1248q0 -13 -10 -23l-332 -332l144 -144q19 -19 19 -45t-19 -45 t-45 -19h-448q-26 0 -45 19t-19 45v448q0 26 19 45t45 19t45 -19l144 -144l332 332q10 10 23 10t23 -10l114 -114q10 -10 10 -23z" /> | ||
| 131 | <glyph unicode="" horiz-adv-x="1408" d="M1408 800v-192q0 -40 -28 -68t-68 -28h-416v-416q0 -40 -28 -68t-68 -28h-192q-40 0 -68 28t-28 68v416h-416q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h416v416q0 40 28 68t68 28h192q40 0 68 -28t28 -68v-416h416q40 0 68 -28t28 -68z" /> | ||
| 132 | <glyph unicode="" horiz-adv-x="1408" d="M1408 800v-192q0 -40 -28 -68t-68 -28h-1216q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h1216q40 0 68 -28t28 -68z" /> | ||
| 133 | <glyph unicode="" horiz-adv-x="1664" d="M1482 486q46 -26 59.5 -77.5t-12.5 -97.5l-64 -110q-26 -46 -77.5 -59.5t-97.5 12.5l-266 153v-307q0 -52 -38 -90t-90 -38h-128q-52 0 -90 38t-38 90v307l-266 -153q-46 -26 -97.5 -12.5t-77.5 59.5l-64 110q-26 46 -12.5 97.5t59.5 77.5l266 154l-266 154 q-46 26 -59.5 77.5t12.5 97.5l64 110q26 46 77.5 59.5t97.5 -12.5l266 -153v307q0 52 38 90t90 38h128q52 0 90 -38t38 -90v-307l266 153q46 26 97.5 12.5t77.5 -59.5l64 -110q26 -46 12.5 -97.5t-59.5 -77.5l-266 -154z" /> | ||
| 134 | <glyph unicode="" d="M768 1408q209 0 385.5 -103t279.5 -279.5t103 -385.5t-103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103zM896 161v190q0 14 -9 23.5t-22 9.5h-192q-13 0 -23 -10t-10 -23v-190q0 -13 10 -23t23 -10h192 q13 0 22 9.5t9 23.5zM894 505l18 621q0 12 -10 18q-10 8 -24 8h-220q-14 0 -24 -8q-10 -6 -10 -18l17 -621q0 -10 10 -17.5t24 -7.5h185q14 0 23.5 7.5t10.5 17.5z" /> | ||
| 135 | <glyph unicode="" d="M928 180v56v468v192h-320v-192v-468v-56q0 -25 18 -38.5t46 -13.5h192q28 0 46 13.5t18 38.5zM472 1024h195l-126 161q-26 31 -69 31q-40 0 -68 -28t-28 -68t28 -68t68 -28zM1160 1120q0 40 -28 68t-68 28q-43 0 -69 -31l-125 -161h194q40 0 68 28t28 68zM1536 864v-320 q0 -14 -9 -23t-23 -9h-96v-416q0 -40 -28 -68t-68 -28h-1088q-40 0 -68 28t-28 68v416h-96q-14 0 -23 9t-9 23v320q0 14 9 23t23 9h440q-93 0 -158.5 65.5t-65.5 158.5t65.5 158.5t158.5 65.5q107 0 168 -77l128 -165l128 165q61 77 168 77q93 0 158.5 -65.5t65.5 -158.5 t-65.5 -158.5t-158.5 -65.5h440q14 0 23 -9t9 -23z" /> | ||
| 136 | <glyph unicode="" horiz-adv-x="1792" d="M1280 832q0 26 -19 45t-45 19q-172 0 -318 -49.5t-259.5 -134t-235.5 -219.5q-19 -21 -19 -45q0 -26 19 -45t45 -19q24 0 45 19q27 24 74 71t67 66q137 124 268.5 176t313.5 52q26 0 45 19t19 45zM1792 1030q0 -95 -20 -193q-46 -224 -184.5 -383t-357.5 -268 q-214 -108 -438 -108q-148 0 -286 47q-15 5 -88 42t-96 37q-16 0 -39.5 -32t-45 -70t-52.5 -70t-60 -32q-30 0 -51 11t-31 24t-27 42q-2 4 -6 11t-5.5 10t-3 9.5t-1.5 13.5q0 35 31 73.5t68 65.5t68 56t31 48q0 4 -14 38t-16 44q-9 51 -9 104q0 115 43.5 220t119 184.5 t170.5 139t204 95.5q55 18 145 25.5t179.5 9t178.5 6t163.5 24t113.5 56.5l29.5 29.5t29.5 28t27 20t36.5 16t43.5 4.5q39 0 70.5 -46t47.5 -112t24 -124t8 -96z" /> | ||
| 137 | <glyph unicode="" horiz-adv-x="1408" d="M1408 -160v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-1344q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h1344q13 0 22.5 -9.5t9.5 -22.5zM1152 896q0 -78 -24.5 -144t-64 -112.5t-87.5 -88t-96 -77.5t-87.5 -72t-64 -81.5t-24.5 -96.5q0 -96 67 -224l-4 1l1 -1 q-90 41 -160 83t-138.5 100t-113.5 122.5t-72.5 150.5t-27.5 184q0 78 24.5 144t64 112.5t87.5 88t96 77.5t87.5 72t64 81.5t24.5 96.5q0 94 -66 224l3 -1l-1 1q90 -41 160 -83t138.5 -100t113.5 -122.5t72.5 -150.5t27.5 -184z" /> | ||
| 138 | <glyph unicode="" horiz-adv-x="1792" d="M1664 576q-152 236 -381 353q61 -104 61 -225q0 -185 -131.5 -316.5t-316.5 -131.5t-316.5 131.5t-131.5 316.5q0 121 61 225q-229 -117 -381 -353q133 -205 333.5 -326.5t434.5 -121.5t434.5 121.5t333.5 326.5zM944 960q0 20 -14 34t-34 14q-125 0 -214.5 -89.5 t-89.5 -214.5q0 -20 14 -34t34 -14t34 14t14 34q0 86 61 147t147 61q20 0 34 14t14 34zM1792 576q0 -34 -20 -69q-140 -230 -376.5 -368.5t-499.5 -138.5t-499.5 139t-376.5 368q-20 35 -20 69t20 69q140 229 376.5 368t499.5 139t499.5 -139t376.5 -368q20 -35 20 -69z" /> | ||
| 139 | <glyph unicode="" horiz-adv-x="1792" d="M555 201l78 141q-87 63 -136 159t-49 203q0 121 61 225q-229 -117 -381 -353q167 -258 427 -375zM944 960q0 20 -14 34t-34 14q-125 0 -214.5 -89.5t-89.5 -214.5q0 -20 14 -34t34 -14t34 14t14 34q0 86 61 147t147 61q20 0 34 14t14 34zM1307 1151q0 -7 -1 -9 q-105 -188 -315 -566t-316 -567l-49 -89q-10 -16 -28 -16q-12 0 -134 70q-16 10 -16 28q0 12 44 87q-143 65 -263.5 173t-208.5 245q-20 31 -20 69t20 69q153 235 380 371t496 136q89 0 180 -17l54 97q10 16 28 16q5 0 18 -6t31 -15.5t33 -18.5t31.5 -18.5t19.5 -11.5 q16 -10 16 -27zM1344 704q0 -139 -79 -253.5t-209 -164.5l280 502q8 -45 8 -84zM1792 576q0 -35 -20 -69q-39 -64 -109 -145q-150 -172 -347.5 -267t-419.5 -95l74 132q212 18 392.5 137t301.5 307q-115 179 -282 294l63 112q95 -64 182.5 -153t144.5 -184q20 -34 20 -69z " /> | ||
| 140 | <glyph unicode="" horiz-adv-x="1792" d="M1024 161v190q0 14 -9.5 23.5t-22.5 9.5h-192q-13 0 -22.5 -9.5t-9.5 -23.5v-190q0 -14 9.5 -23.5t22.5 -9.5h192q13 0 22.5 9.5t9.5 23.5zM1022 535l18 459q0 12 -10 19q-13 11 -24 11h-220q-11 0 -24 -11q-10 -7 -10 -21l17 -457q0 -10 10 -16.5t24 -6.5h185 q14 0 23.5 6.5t10.5 16.5zM1008 1469l768 -1408q35 -63 -2 -126q-17 -29 -46.5 -46t-63.5 -17h-1536q-34 0 -63.5 17t-46.5 46q-37 63 -2 126l768 1408q17 31 47 49t65 18t65 -18t47 -49z" /> | ||
| 141 | <glyph unicode="" horiz-adv-x="1408" d="M1376 1376q44 -52 12 -148t-108 -172l-161 -161l160 -696q5 -19 -12 -33l-128 -96q-7 -6 -19 -6q-4 0 -7 1q-15 3 -21 16l-279 508l-259 -259l53 -194q5 -17 -8 -31l-96 -96q-9 -9 -23 -9h-2q-15 2 -24 13l-189 252l-252 189q-11 7 -13 23q-1 13 9 25l96 97q9 9 23 9 q6 0 8 -1l194 -53l259 259l-508 279q-14 8 -17 24q-2 16 9 27l128 128q14 13 30 8l665 -159l160 160q76 76 172 108t148 -12z" /> | ||
| 142 | <glyph unicode="" horiz-adv-x="1664" d="M128 -128h288v288h-288v-288zM480 -128h320v288h-320v-288zM128 224h288v320h-288v-320zM480 224h320v320h-320v-320zM128 608h288v288h-288v-288zM864 -128h320v288h-320v-288zM480 608h320v288h-320v-288zM1248 -128h288v288h-288v-288zM864 224h320v320h-320v-320z M512 1088v288q0 13 -9.5 22.5t-22.5 9.5h-64q-13 0 -22.5 -9.5t-9.5 -22.5v-288q0 -13 9.5 -22.5t22.5 -9.5h64q13 0 22.5 9.5t9.5 22.5zM1248 224h288v320h-288v-320zM864 608h320v288h-320v-288zM1248 608h288v288h-288v-288zM1280 1088v288q0 13 -9.5 22.5t-22.5 9.5h-64 q-13 0 -22.5 -9.5t-9.5 -22.5v-288q0 -13 9.5 -22.5t22.5 -9.5h64q13 0 22.5 9.5t9.5 22.5zM1664 1152v-1280q0 -52 -38 -90t-90 -38h-1408q-52 0 -90 38t-38 90v1280q0 52 38 90t90 38h128v96q0 66 47 113t113 47h64q66 0 113 -47t47 -113v-96h384v96q0 66 47 113t113 47 h64q66 0 113 -47t47 -113v-96h128q52 0 90 -38t38 -90z" /> | ||
| 143 | <glyph unicode="" horiz-adv-x="1792" d="M666 1055q-60 -92 -137 -273q-22 45 -37 72.5t-40.5 63.5t-51 56.5t-63 35t-81.5 14.5h-224q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h224q250 0 410 -225zM1792 256q0 -14 -9 -23l-320 -320q-9 -9 -23 -9q-13 0 -22.5 9.5t-9.5 22.5v192q-32 0 -85 -0.5t-81 -1t-73 1 t-71 5t-64 10.5t-63 18.5t-58 28.5t-59 40t-55 53.5t-56 69.5q59 93 136 273q22 -45 37 -72.5t40.5 -63.5t51 -56.5t63 -35t81.5 -14.5h256v192q0 14 9 23t23 9q12 0 24 -10l319 -319q9 -9 9 -23zM1792 1152q0 -14 -9 -23l-320 -320q-9 -9 -23 -9q-13 0 -22.5 9.5t-9.5 22.5 v192h-256q-48 0 -87 -15t-69 -45t-51 -61.5t-45 -77.5q-32 -62 -78 -171q-29 -66 -49.5 -111t-54 -105t-64 -100t-74 -83t-90 -68.5t-106.5 -42t-128 -16.5h-224q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h224q48 0 87 15t69 45t51 61.5t45 77.5q32 62 78 171q29 66 49.5 111 t54 105t64 100t74 83t90 68.5t106.5 42t128 16.5h256v192q0 14 9 23t23 9q12 0 24 -10l319 -319q9 -9 9 -23z" /> | ||
| 144 | <glyph unicode="" horiz-adv-x="1792" d="M1792 640q0 -174 -120 -321.5t-326 -233t-450 -85.5q-70 0 -145 8q-198 -175 -460 -242q-49 -14 -114 -22q-17 -2 -30.5 9t-17.5 29v1q-3 4 -0.5 12t2 10t4.5 9.5l6 9t7 8.5t8 9q7 8 31 34.5t34.5 38t31 39.5t32.5 51t27 59t26 76q-157 89 -247.5 220t-90.5 281 q0 130 71 248.5t191 204.5t286 136.5t348 50.5q244 0 450 -85.5t326 -233t120 -321.5z" /> | ||
| 145 | <glyph unicode="" d="M1536 704v-128q0 -201 -98.5 -362t-274 -251.5t-395.5 -90.5t-395.5 90.5t-274 251.5t-98.5 362v128q0 26 19 45t45 19h384q26 0 45 -19t19 -45v-128q0 -52 23.5 -90t53.5 -57t71 -30t64 -13t44 -2t44 2t64 13t71 30t53.5 57t23.5 90v128q0 26 19 45t45 19h384 q26 0 45 -19t19 -45zM512 1344v-384q0 -26 -19 -45t-45 -19h-384q-26 0 -45 19t-19 45v384q0 26 19 45t45 19h384q26 0 45 -19t19 -45zM1536 1344v-384q0 -26 -19 -45t-45 -19h-384q-26 0 -45 19t-19 45v384q0 26 19 45t45 19h384q26 0 45 -19t19 -45z" /> | ||
| 146 | <glyph unicode="" horiz-adv-x="1664" d="M1611 320q0 -53 -37 -90l-75 -75q-38 -38 -91 -38q-54 0 -90 38l-486 485l-486 -485q-36 -38 -90 -38t-90 38l-75 75q-38 36 -38 90q0 53 38 91l651 651q37 37 90 37q52 0 91 -37l650 -651q38 -38 38 -91z" /> | ||
| 147 | <glyph unicode="" horiz-adv-x="1664" d="M1611 832q0 -53 -37 -90l-651 -651q-38 -38 -91 -38q-54 0 -90 38l-651 651q-38 36 -38 90q0 53 38 91l74 75q39 37 91 37q53 0 90 -37l486 -486l486 486q37 37 90 37q52 0 91 -37l75 -75q37 -39 37 -91z" /> | ||
| 148 | <glyph unicode="" horiz-adv-x="1920" d="M1280 32q0 -13 -9.5 -22.5t-22.5 -9.5h-960q-8 0 -13.5 2t-9 7t-5.5 8t-3 11.5t-1 11.5v13v11v160v416h-192q-26 0 -45 19t-19 45q0 24 15 41l320 384q19 22 49 22t49 -22l320 -384q15 -17 15 -41q0 -26 -19 -45t-45 -19h-192v-384h576q16 0 25 -11l160 -192q7 -11 7 -21 zM1920 448q0 -24 -15 -41l-320 -384q-20 -23 -49 -23t-49 23l-320 384q-15 17 -15 41q0 26 19 45t45 19h192v384h-576q-16 0 -25 12l-160 192q-7 9 -7 20q0 13 9.5 22.5t22.5 9.5h960q8 0 13.5 -2t9 -7t5.5 -8t3 -11.5t1 -11.5v-13v-11v-160v-416h192q26 0 45 -19t19 -45z " /> | ||
| 149 | <glyph unicode="" horiz-adv-x="1664" d="M640 0q0 -53 -37.5 -90.5t-90.5 -37.5t-90.5 37.5t-37.5 90.5t37.5 90.5t90.5 37.5t90.5 -37.5t37.5 -90.5zM1536 0q0 -53 -37.5 -90.5t-90.5 -37.5t-90.5 37.5t-37.5 90.5t37.5 90.5t90.5 37.5t90.5 -37.5t37.5 -90.5zM1664 1088v-512q0 -24 -16 -42.5t-41 -21.5 l-1044 -122q1 -7 4.5 -21.5t6 -26.5t2.5 -22q0 -16 -24 -64h920q26 0 45 -19t19 -45t-19 -45t-45 -19h-1024q-26 0 -45 19t-19 45q0 14 11 39.5t29.5 59.5t20.5 38l-177 823h-204q-26 0 -45 19t-19 45t19 45t45 19h256q16 0 28.5 -6.5t20 -15.5t13 -24.5t7.5 -26.5 t5.5 -29.5t4.5 -25.5h1201q26 0 45 -19t19 -45z" /> | ||
| 150 | <glyph unicode="" horiz-adv-x="1664" d="M1664 928v-704q0 -92 -66 -158t-158 -66h-1216q-92 0 -158 66t-66 158v960q0 92 66 158t158 66h320q92 0 158 -66t66 -158v-32h672q92 0 158 -66t66 -158z" /> | ||
| 151 | <glyph unicode="" horiz-adv-x="1920" d="M1879 584q0 -31 -31 -66l-336 -396q-43 -51 -120.5 -86.5t-143.5 -35.5h-1088q-34 0 -60.5 13t-26.5 43q0 31 31 66l336 396q43 51 120.5 86.5t143.5 35.5h1088q34 0 60.5 -13t26.5 -43zM1536 928v-160h-832q-94 0 -197 -47.5t-164 -119.5l-337 -396l-5 -6q0 4 -0.5 12.5 t-0.5 12.5v960q0 92 66 158t158 66h320q92 0 158 -66t66 -158v-32h544q92 0 158 -66t66 -158z" /> | ||
| 152 | <glyph unicode="" horiz-adv-x="768" d="M704 1216q0 -26 -19 -45t-45 -19h-128v-1024h128q26 0 45 -19t19 -45t-19 -45l-256 -256q-19 -19 -45 -19t-45 19l-256 256q-19 19 -19 45t19 45t45 19h128v1024h-128q-26 0 -45 19t-19 45t19 45l256 256q19 19 45 19t45 -19l256 -256q19 -19 19 -45z" /> | ||
| 153 | <glyph unicode="" horiz-adv-x="1792" d="M1792 640q0 -26 -19 -45l-256 -256q-19 -19 -45 -19t-45 19t-19 45v128h-1024v-128q0 -26 -19 -45t-45 -19t-45 19l-256 256q-19 19 -19 45t19 45l256 256q19 19 45 19t45 -19t19 -45v-128h1024v128q0 26 19 45t45 19t45 -19l256 -256q19 -19 19 -45z" /> | ||
| 154 | <glyph unicode="" horiz-adv-x="1920" d="M512 512v-384h-256v384h256zM896 1024v-896h-256v896h256zM1280 768v-640h-256v640h256zM1664 1152v-1024h-256v1024h256zM1792 32v1216q0 13 -9.5 22.5t-22.5 9.5h-1600q-13 0 -22.5 -9.5t-9.5 -22.5v-1216q0 -13 9.5 -22.5t22.5 -9.5h1600q13 0 22.5 9.5t9.5 22.5z M1920 1248v-1216q0 -66 -47 -113t-113 -47h-1600q-66 0 -113 47t-47 113v1216q0 66 47 113t113 47h1600q66 0 113 -47t47 -113z" /> | ||
| 155 | <glyph unicode="" d="M1280 926q-56 -25 -121 -34q68 40 93 117q-65 -38 -134 -51q-61 66 -153 66q-87 0 -148.5 -61.5t-61.5 -148.5q0 -29 5 -48q-129 7 -242 65t-192 155q-29 -50 -29 -106q0 -114 91 -175q-47 1 -100 26v-2q0 -75 50 -133.5t123 -72.5q-29 -8 -51 -8q-13 0 -39 4 q21 -63 74.5 -104t121.5 -42q-116 -90 -261 -90q-26 0 -50 3q148 -94 322 -94q112 0 210 35.5t168 95t120.5 137t75 162t24.5 168.5q0 18 -1 27q63 45 105 109zM1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5 t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> | ||
| 156 | <glyph unicode="" d="M1307 618l23 219h-198v109q0 49 15.5 68.5t71.5 19.5h110v219h-175q-152 0 -218 -72t-66 -213v-131h-131v-219h131v-635h262v635h175zM1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960 q119 0 203.5 -84.5t84.5 -203.5z" /> | ||
| 157 | <glyph unicode="" horiz-adv-x="1792" d="M928 704q0 14 -9 23t-23 9q-66 0 -113 -47t-47 -113q0 -14 9 -23t23 -9t23 9t9 23q0 40 28 68t68 28q14 0 23 9t9 23zM1152 574q0 -106 -75 -181t-181 -75t-181 75t-75 181t75 181t181 75t181 -75t75 -181zM128 0h1536v128h-1536v-128zM1280 574q0 159 -112.5 271.5 t-271.5 112.5t-271.5 -112.5t-112.5 -271.5t112.5 -271.5t271.5 -112.5t271.5 112.5t112.5 271.5zM256 1216h384v128h-384v-128zM128 1024h1536v118v138h-828l-64 -128h-644v-128zM1792 1280v-1280q0 -53 -37.5 -90.5t-90.5 -37.5h-1536q-53 0 -90.5 37.5t-37.5 90.5v1280 q0 53 37.5 90.5t90.5 37.5h1536q53 0 90.5 -37.5t37.5 -90.5z" /> | ||
| 158 | <glyph unicode="" horiz-adv-x="1792" d="M832 1024q0 80 -56 136t-136 56t-136 -56t-56 -136q0 -42 19 -83q-41 19 -83 19q-80 0 -136 -56t-56 -136t56 -136t136 -56t136 56t56 136q0 42 -19 83q41 -19 83 -19q80 0 136 56t56 136zM1683 320q0 -17 -49 -66t-66 -49q-9 0 -28.5 16t-36.5 33t-38.5 40t-24.5 26 l-96 -96l220 -220q28 -28 28 -68q0 -42 -39 -81t-81 -39q-40 0 -68 28l-671 671q-176 -131 -365 -131q-163 0 -265.5 102.5t-102.5 265.5q0 160 95 313t248 248t313 95q163 0 265.5 -102.5t102.5 -265.5q0 -189 -131 -365l355 -355l96 96q-3 3 -26 24.5t-40 38.5t-33 36.5 t-16 28.5q0 17 49 66t66 49q13 0 23 -10q6 -6 46 -44.5t82 -79.5t86.5 -86t73 -78t28.5 -41z" /> | ||
| 159 | <glyph unicode="" horiz-adv-x="1920" d="M896 640q0 106 -75 181t-181 75t-181 -75t-75 -181t75 -181t181 -75t181 75t75 181zM1664 128q0 52 -38 90t-90 38t-90 -38t-38 -90q0 -53 37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM1664 1152q0 52 -38 90t-90 38t-90 -38t-38 -90q0 -53 37.5 -90.5t90.5 -37.5 t90.5 37.5t37.5 90.5zM1280 731v-185q0 -10 -7 -19.5t-16 -10.5l-155 -24q-11 -35 -32 -76q34 -48 90 -115q7 -10 7 -20q0 -12 -7 -19q-23 -30 -82.5 -89.5t-78.5 -59.5q-11 0 -21 7l-115 90q-37 -19 -77 -31q-11 -108 -23 -155q-7 -24 -30 -24h-186q-11 0 -20 7.5t-10 17.5 l-23 153q-34 10 -75 31l-118 -89q-7 -7 -20 -7q-11 0 -21 8q-144 133 -144 160q0 9 7 19q10 14 41 53t47 61q-23 44 -35 82l-152 24q-10 1 -17 9.5t-7 19.5v185q0 10 7 19.5t16 10.5l155 24q11 35 32 76q-34 48 -90 115q-7 11 -7 20q0 12 7 20q22 30 82 89t79 59q11 0 21 -7 l115 -90q34 18 77 32q11 108 23 154q7 24 30 24h186q11 0 20 -7.5t10 -17.5l23 -153q34 -10 75 -31l118 89q8 7 20 7q11 0 21 -8q144 -133 144 -160q0 -9 -7 -19q-12 -16 -42 -54t-45 -60q23 -48 34 -82l152 -23q10 -2 17 -10.5t7 -19.5zM1920 198v-140q0 -16 -149 -31 q-12 -27 -30 -52q51 -113 51 -138q0 -4 -4 -7q-122 -71 -124 -71q-8 0 -46 47t-52 68q-20 -2 -30 -2t-30 2q-14 -21 -52 -68t-46 -47q-2 0 -124 71q-4 3 -4 7q0 25 51 138q-18 25 -30 52q-149 15 -149 31v140q0 16 149 31q13 29 30 52q-51 113 -51 138q0 4 4 7q4 2 35 20 t59 34t30 16q8 0 46 -46.5t52 -67.5q20 2 30 2t30 -2q51 71 92 112l6 2q4 0 124 -70q4 -3 4 -7q0 -25 -51 -138q17 -23 30 -52q149 -15 149 -31zM1920 1222v-140q0 -16 -149 -31q-12 -27 -30 -52q51 -113 51 -138q0 -4 -4 -7q-122 -71 -124 -71q-8 0 -46 47t-52 68 q-20 -2 -30 -2t-30 2q-14 -21 -52 -68t-46 -47q-2 0 -124 71q-4 3 -4 7q0 25 51 138q-18 25 -30 52q-149 15 -149 31v140q0 16 149 31q13 29 30 52q-51 113 -51 138q0 4 4 7q4 2 35 20t59 34t30 16q8 0 46 -46.5t52 -67.5q20 2 30 2t30 -2q51 71 92 112l6 2q4 0 124 -70 q4 -3 4 -7q0 -25 -51 -138q17 -23 30 -52q149 -15 149 -31z" /> | ||
| 160 | <glyph unicode="" horiz-adv-x="1792" d="M1408 768q0 -139 -94 -257t-256.5 -186.5t-353.5 -68.5q-86 0 -176 16q-124 -88 -278 -128q-36 -9 -86 -16h-3q-11 0 -20.5 8t-11.5 21q-1 3 -1 6.5t0.5 6.5t2 6l2.5 5t3.5 5.5t4 5t4.5 5t4 4.5q5 6 23 25t26 29.5t22.5 29t25 38.5t20.5 44q-124 72 -195 177t-71 224 q0 139 94 257t256.5 186.5t353.5 68.5t353.5 -68.5t256.5 -186.5t94 -257zM1792 512q0 -120 -71 -224.5t-195 -176.5q10 -24 20.5 -44t25 -38.5t22.5 -29t26 -29.5t23 -25q1 -1 4 -4.5t4.5 -5t4 -5t3.5 -5.5l2.5 -5t2 -6t0.5 -6.5t-1 -6.5q-3 -14 -13 -22t-22 -7 q-50 7 -86 16q-154 40 -278 128q-90 -16 -176 -16q-271 0 -472 132q58 -4 88 -4q161 0 309 45t264 129q125 92 192 212t67 254q0 77 -23 152q129 -71 204 -178t75 -230z" /> | ||
| 161 | <glyph unicode="" d="M256 192q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1408 768q0 51 -39 89.5t-89 38.5h-352q0 58 48 159.5t48 160.5q0 98 -32 145t-128 47q-26 -26 -38 -85t-30.5 -125.5t-59.5 -109.5q-22 -23 -77 -91q-4 -5 -23 -30t-31.5 -41t-34.5 -42.5 t-40 -44t-38.5 -35.5t-40 -27t-35.5 -9h-32v-640h32q13 0 31.5 -3t33 -6.5t38 -11t35 -11.5t35.5 -12.5t29 -10.5q211 -73 342 -73h121q192 0 192 167q0 26 -5 56q30 16 47.5 52.5t17.5 73.5t-18 69q53 50 53 119q0 25 -10 55.5t-25 47.5q32 1 53.5 47t21.5 81zM1536 769 q0 -89 -49 -163q9 -33 9 -69q0 -77 -38 -144q3 -21 3 -43q0 -101 -60 -178q1 -139 -85 -219.5t-227 -80.5h-36h-93q-96 0 -189.5 22.5t-216.5 65.5q-116 40 -138 40h-288q-53 0 -90.5 37.5t-37.5 90.5v640q0 53 37.5 90.5t90.5 37.5h274q36 24 137 155q58 75 107 128 q24 25 35.5 85.5t30.5 126.5t62 108q39 37 90 37q84 0 151 -32.5t102 -101.5t35 -186q0 -93 -48 -192h176q104 0 180 -76t76 -179z" /> | ||
| 162 | <glyph unicode="" d="M256 1088q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1408 512q0 35 -21.5 81t-53.5 47q15 17 25 47.5t10 55.5q0 69 -53 119q18 32 18 69t-17.5 73.5t-47.5 52.5q5 30 5 56q0 85 -49 126t-136 41h-128q-131 0 -342 -73q-5 -2 -29 -10.5 t-35.5 -12.5t-35 -11.5t-38 -11t-33 -6.5t-31.5 -3h-32v-640h32q16 0 35.5 -9t40 -27t38.5 -35.5t40 -44t34.5 -42.5t31.5 -41t23 -30q55 -68 77 -91q41 -43 59.5 -109.5t30.5 -125.5t38 -85q96 0 128 47t32 145q0 59 -48 160.5t-48 159.5h352q50 0 89 38.5t39 89.5z M1536 511q0 -103 -76 -179t-180 -76h-176q48 -99 48 -192q0 -118 -35 -186q-35 -69 -102 -101.5t-151 -32.5q-51 0 -90 37q-34 33 -54 82t-25.5 90.5t-17.5 84.5t-31 64q-48 50 -107 127q-101 131 -137 155h-274q-53 0 -90.5 37.5t-37.5 90.5v640q0 53 37.5 90.5t90.5 37.5 h288q22 0 138 40q128 44 223 66t200 22h112q140 0 226.5 -79t85.5 -216v-5q60 -77 60 -178q0 -22 -3 -43q38 -67 38 -144q0 -36 -9 -69q49 -74 49 -163z" /> | ||
| 163 | <glyph unicode="" horiz-adv-x="896" d="M832 1504v-1339l-449 -236q-22 -12 -40 -12q-21 0 -31.5 14.5t-10.5 35.5q0 6 2 20l86 500l-364 354q-25 27 -25 48q0 37 56 46l502 73l225 455q19 41 49 41z" /> | ||
| 164 | <glyph unicode="" horiz-adv-x="1792" d="M1664 940q0 81 -21.5 143t-55 98.5t-81.5 59.5t-94 31t-98 8t-112 -25.5t-110.5 -64t-86.5 -72t-60 -61.5q-18 -22 -49 -22t-49 22q-24 28 -60 61.5t-86.5 72t-110.5 64t-112 25.5t-98 -8t-94 -31t-81.5 -59.5t-55 -98.5t-21.5 -143q0 -168 187 -355l581 -560l580 559 q188 188 188 356zM1792 940q0 -221 -229 -450l-623 -600q-18 -18 -44 -18t-44 18l-624 602q-10 8 -27.5 26t-55.5 65.5t-68 97.5t-53.5 121t-23.5 138q0 220 127 344t351 124q62 0 126.5 -21.5t120 -58t95.5 -68.5t76 -68q36 36 76 68t95.5 68.5t120 58t126.5 21.5 q224 0 351 -124t127 -344z" /> | ||
| 165 | <glyph unicode="" horiz-adv-x="1664" d="M640 96q0 -4 1 -20t0.5 -26.5t-3 -23.5t-10 -19.5t-20.5 -6.5h-320q-119 0 -203.5 84.5t-84.5 203.5v704q0 119 84.5 203.5t203.5 84.5h320q13 0 22.5 -9.5t9.5 -22.5q0 -4 1 -20t0.5 -26.5t-3 -23.5t-10 -19.5t-20.5 -6.5h-320q-66 0 -113 -47t-47 -113v-704 q0 -66 47 -113t113 -47h288h11h13t11.5 -1t11.5 -3t8 -5.5t7 -9t2 -13.5zM1568 640q0 -26 -19 -45l-544 -544q-19 -19 -45 -19t-45 19t-19 45v288h-448q-26 0 -45 19t-19 45v384q0 26 19 45t45 19h448v288q0 26 19 45t45 19t45 -19l544 -544q19 -19 19 -45z" /> | ||
| 166 | <glyph unicode="" d="M237 122h231v694h-231v-694zM483 1030q-1 52 -36 86t-93 34t-94.5 -34t-36.5 -86q0 -51 35.5 -85.5t92.5 -34.5h1q59 0 95 34.5t36 85.5zM1068 122h231v398q0 154 -73 233t-193 79q-136 0 -209 -117h2v101h-231q3 -66 0 -694h231v388q0 38 7 56q15 35 45 59.5t74 24.5 q116 0 116 -157v-371zM1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> | ||
| 167 | <glyph unicode="" horiz-adv-x="1152" d="M480 672v448q0 14 -9 23t-23 9t-23 -9t-9 -23v-448q0 -14 9 -23t23 -9t23 9t9 23zM1152 320q0 -26 -19 -45t-45 -19h-429l-51 -483q-2 -12 -10.5 -20.5t-20.5 -8.5h-1q-27 0 -32 27l-76 485h-404q-26 0 -45 19t-19 45q0 123 78.5 221.5t177.5 98.5v512q-52 0 -90 38 t-38 90t38 90t90 38h640q52 0 90 -38t38 -90t-38 -90t-90 -38v-512q99 0 177.5 -98.5t78.5 -221.5z" /> | ||
| 168 | <glyph unicode="" horiz-adv-x="1792" d="M1408 608v-320q0 -119 -84.5 -203.5t-203.5 -84.5h-832q-119 0 -203.5 84.5t-84.5 203.5v832q0 119 84.5 203.5t203.5 84.5h704q14 0 23 -9t9 -23v-64q0 -14 -9 -23t-23 -9h-704q-66 0 -113 -47t-47 -113v-832q0 -66 47 -113t113 -47h832q66 0 113 47t47 113v320 q0 14 9 23t23 9h64q14 0 23 -9t9 -23zM1792 1472v-512q0 -26 -19 -45t-45 -19t-45 19l-176 176l-652 -652q-10 -10 -23 -10t-23 10l-114 114q-10 10 -10 23t10 23l652 652l-176 176q-19 19 -19 45t19 45t45 19h512q26 0 45 -19t19 -45z" /> | ||
| 169 | <glyph unicode="" d="M1184 640q0 -26 -19 -45l-544 -544q-19 -19 -45 -19t-45 19t-19 45v288h-448q-26 0 -45 19t-19 45v384q0 26 19 45t45 19h448v288q0 26 19 45t45 19t45 -19l544 -544q19 -19 19 -45zM1536 992v-704q0 -119 -84.5 -203.5t-203.5 -84.5h-320q-13 0 -22.5 9.5t-9.5 22.5 q0 4 -1 20t-0.5 26.5t3 23.5t10 19.5t20.5 6.5h320q66 0 113 47t47 113v704q0 66 -47 113t-113 47h-288h-11h-13t-11.5 1t-11.5 3t-8 5.5t-7 9t-2 13.5q0 4 -1 20t-0.5 26.5t3 23.5t10 19.5t20.5 6.5h320q119 0 203.5 -84.5t84.5 -203.5z" /> | ||
| 170 | <glyph unicode="" horiz-adv-x="1664" d="M458 653q-74 162 -74 371h-256v-96q0 -78 94.5 -162t235.5 -113zM1536 928v96h-256q0 -209 -74 -371q141 29 235.5 113t94.5 162zM1664 1056v-128q0 -71 -41.5 -143t-112 -130t-173 -97.5t-215.5 -44.5q-42 -54 -95 -95q-38 -34 -52.5 -72.5t-14.5 -89.5q0 -54 30.5 -91 t97.5 -37q75 0 133.5 -45.5t58.5 -114.5v-64q0 -14 -9 -23t-23 -9h-832q-14 0 -23 9t-9 23v64q0 69 58.5 114.5t133.5 45.5q67 0 97.5 37t30.5 91q0 51 -14.5 89.5t-52.5 72.5q-53 41 -95 95q-113 5 -215.5 44.5t-173 97.5t-112 130t-41.5 143v128q0 40 28 68t68 28h288v96 q0 66 47 113t113 47h576q66 0 113 -47t47 -113v-96h288q40 0 68 -28t28 -68z" /> | ||
| 171 | <glyph unicode="" d="M394 184q-8 -9 -20 3q-13 11 -4 19q8 9 20 -3q12 -11 4 -19zM352 245q9 -12 0 -19q-8 -6 -17 7t0 18q9 7 17 -6zM291 305q-5 -7 -13 -2q-10 5 -7 12q3 5 13 2q10 -5 7 -12zM322 271q-6 -7 -16 3q-9 11 -2 16q6 6 16 -3q9 -11 2 -16zM451 159q-4 -12 -19 -6q-17 4 -13 15 t19 7q16 -5 13 -16zM514 154q0 -11 -16 -11q-17 -2 -17 11q0 11 16 11q17 2 17 -11zM572 164q2 -10 -14 -14t-18 8t14 15q16 2 18 -9zM1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-224q-16 0 -24.5 1t-19.5 5t-16 14.5t-5 27.5v239q0 97 -52 142q57 6 102.5 18t94 39 t81 66.5t53 105t20.5 150.5q0 121 -79 206q37 91 -8 204q-28 9 -81 -11t-92 -44l-38 -24q-93 26 -192 26t-192 -26q-16 11 -42.5 27t-83.5 38.5t-86 13.5q-44 -113 -7 -204q-79 -85 -79 -206q0 -85 20.5 -150t52.5 -105t80.5 -67t94 -39t102.5 -18q-40 -36 -49 -103 q-21 -10 -45 -15t-57 -5t-65.5 21.5t-55.5 62.5q-19 32 -48.5 52t-49.5 24l-20 3q-21 0 -29 -4.5t-5 -11.5t9 -14t13 -12l7 -5q22 -10 43.5 -38t31.5 -51l10 -23q13 -38 44 -61.5t67 -30t69.5 -7t55.5 3.5l23 4q0 -38 0.5 -103t0.5 -68q0 -22 -11 -33.5t-22 -13t-33 -1.5 h-224q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> | ||
| 172 | <glyph unicode="" horiz-adv-x="1664" d="M1280 64q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1536 64q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1664 288v-320q0 -40 -28 -68t-68 -28h-1472q-40 0 -68 28t-28 68v320q0 40 28 68t68 28h427q21 -56 70.5 -92 t110.5 -36h256q61 0 110.5 36t70.5 92h427q40 0 68 -28t28 -68zM1339 936q-17 -40 -59 -40h-256v-448q0 -26 -19 -45t-45 -19h-256q-26 0 -45 19t-19 45v448h-256q-42 0 -59 40q-17 39 14 69l448 448q18 19 45 19t45 -19l448 -448q31 -30 14 -69z" /> | ||
| 173 | <glyph unicode="" d="M1407 710q0 44 -7 113.5t-18 96.5q-12 30 -17 44t-9 36.5t-4 48.5q0 23 5 68.5t5 67.5q0 37 -10 55q-4 1 -13 1q-19 0 -58 -4.5t-59 -4.5q-60 0 -176 24t-175 24q-43 0 -94.5 -11.5t-85 -23.5t-89.5 -34q-137 -54 -202 -103q-96 -73 -159.5 -189.5t-88 -236t-24.5 -248.5 q0 -40 12.5 -120t12.5 -121q0 -23 -11 -66.5t-11 -65.5t12 -36.5t34 -14.5q24 0 72.5 11t73.5 11q57 0 169.5 -15.5t169.5 -15.5q181 0 284 36q129 45 235.5 152.5t166 245.5t59.5 275zM1535 712q0 -165 -70 -327.5t-196 -288t-281 -180.5q-124 -44 -326 -44 q-57 0 -170 14.5t-169 14.5q-24 0 -72.5 -14.5t-73.5 -14.5q-73 0 -123.5 55.5t-50.5 128.5q0 24 11 68t11 67q0 40 -12.5 120.5t-12.5 121.5q0 111 18 217.5t54.5 209.5t100.5 194t150 156q78 59 232 120q194 78 316 78q60 0 175.5 -24t173.5 -24q19 0 57 5t58 5 q81 0 118 -50.5t37 -134.5q0 -23 -5 -68t-5 -68q0 -10 1 -18.5t3 -17t4 -13.5t6.5 -16t6.5 -17q16 -40 25 -118.5t9 -136.5z" /> | ||
| 174 | <glyph unicode="" horiz-adv-x="1408" d="M1408 296q0 -27 -10 -70.5t-21 -68.5q-21 -50 -122 -106q-94 -51 -186 -51q-27 0 -52.5 3.5t-57.5 12.5t-47.5 14.5t-55.5 20.5t-49 18q-98 35 -175 83q-128 79 -264.5 215.5t-215.5 264.5q-48 77 -83 175q-3 9 -18 49t-20.5 55.5t-14.5 47.5t-12.5 57.5t-3.5 52.5 q0 92 51 186q56 101 106 122q25 11 68.5 21t70.5 10q14 0 21 -3q18 -6 53 -76q11 -19 30 -54t35 -63.5t31 -53.5q3 -4 17.5 -25t21.5 -35.5t7 -28.5q0 -20 -28.5 -50t-62 -55t-62 -53t-28.5 -46q0 -9 5 -22.5t8.5 -20.5t14 -24t11.5 -19q76 -137 174 -235t235 -174 q2 -1 19 -11.5t24 -14t20.5 -8.5t22.5 -5q18 0 46 28.5t53 62t55 62t50 28.5q14 0 28.5 -7t35.5 -21.5t25 -17.5q25 -15 53.5 -31t63.5 -35t54 -30q70 -35 76 -53q3 -7 3 -21z" /> | ||
| 175 | <glyph unicode="" horiz-adv-x="1408" d="M1120 1280h-832q-66 0 -113 -47t-47 -113v-832q0 -66 47 -113t113 -47h832q66 0 113 47t47 113v832q0 66 -47 113t-113 47zM1408 1120v-832q0 -119 -84.5 -203.5t-203.5 -84.5h-832q-119 0 -203.5 84.5t-84.5 203.5v832q0 119 84.5 203.5t203.5 84.5h832 q119 0 203.5 -84.5t84.5 -203.5z" /> | ||
| 176 | <glyph unicode="" horiz-adv-x="1280" d="M1152 1280h-1024v-1242l423 406l89 85l89 -85l423 -406v1242zM1164 1408q23 0 44 -9q33 -13 52.5 -41t19.5 -62v-1289q0 -34 -19.5 -62t-52.5 -41q-19 -8 -44 -8q-48 0 -83 32l-441 424l-441 -424q-36 -33 -83 -33q-23 0 -44 9q-33 13 -52.5 41t-19.5 62v1289 q0 34 19.5 62t52.5 41q21 9 44 9h1048z" /> | ||
| 177 | <glyph unicode="" d="M1280 343q0 11 -2 16q-3 8 -38.5 29.5t-88.5 49.5l-53 29q-5 3 -19 13t-25 15t-21 5q-18 0 -47 -32.5t-57 -65.5t-44 -33q-7 0 -16.5 3.5t-15.5 6.5t-17 9.5t-14 8.5q-99 55 -170.5 126.5t-126.5 170.5q-2 3 -8.5 14t-9.5 17t-6.5 15.5t-3.5 16.5q0 13 20.5 33.5t45 38.5 t45 39.5t20.5 36.5q0 10 -5 21t-15 25t-13 19q-3 6 -15 28.5t-25 45.5t-26.5 47.5t-25 40.5t-16.5 18t-16 2q-48 0 -101 -22q-46 -21 -80 -94.5t-34 -130.5q0 -16 2.5 -34t5 -30.5t9 -33t10 -29.5t12.5 -33t11 -30q60 -164 216.5 -320.5t320.5 -216.5q6 -2 30 -11t33 -12.5 t29.5 -10t33 -9t30.5 -5t34 -2.5q57 0 130.5 34t94.5 80q22 53 22 101zM1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> | ||
| 178 | <glyph unicode="" horiz-adv-x="1664" d="M1620 1128q-67 -98 -162 -167q1 -14 1 -42q0 -130 -38 -259.5t-115.5 -248.5t-184.5 -210.5t-258 -146t-323 -54.5q-271 0 -496 145q35 -4 78 -4q225 0 401 138q-105 2 -188 64.5t-114 159.5q33 -5 61 -5q43 0 85 11q-112 23 -185.5 111.5t-73.5 205.5v4q68 -38 146 -41 q-66 44 -105 115t-39 154q0 88 44 163q121 -149 294.5 -238.5t371.5 -99.5q-8 38 -8 74q0 134 94.5 228.5t228.5 94.5q140 0 236 -102q109 21 205 78q-37 -115 -142 -178q93 10 186 50z" /> | ||
| 179 | <glyph unicode="" horiz-adv-x="768" d="M511 980h257l-30 -284h-227v-824h-341v824h-170v284h170v171q0 182 86 275.5t283 93.5h227v-284h-142q-39 0 -62.5 -6.5t-34 -23.5t-13.5 -34.5t-3 -49.5v-142z" /> | ||
| 180 | <glyph unicode="" d="M1536 640q0 -251 -146.5 -451.5t-378.5 -277.5q-27 -5 -39.5 7t-12.5 30v211q0 97 -52 142q57 6 102.5 18t94 39t81 66.5t53 105t20.5 150.5q0 121 -79 206q37 91 -8 204q-28 9 -81 -11t-92 -44l-38 -24q-93 26 -192 26t-192 -26q-16 11 -42.5 27t-83.5 38.5t-86 13.5 q-44 -113 -7 -204q-79 -85 -79 -206q0 -85 20.5 -150t52.5 -105t80.5 -67t94 -39t102.5 -18q-40 -36 -49 -103q-21 -10 -45 -15t-57 -5t-65.5 21.5t-55.5 62.5q-19 32 -48.5 52t-49.5 24l-20 3q-21 0 -29 -4.5t-5 -11.5t9 -14t13 -12l7 -5q22 -10 43.5 -38t31.5 -51l10 -23 q13 -38 44 -61.5t67 -30t69.5 -7t55.5 3.5l23 4q0 -38 0.5 -89t0.5 -54q0 -18 -13 -30t-40 -7q-232 77 -378.5 277.5t-146.5 451.5q0 209 103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 181 | <glyph unicode="" horiz-adv-x="1664" d="M1664 960v-256q0 -26 -19 -45t-45 -19h-64q-26 0 -45 19t-19 45v256q0 106 -75 181t-181 75t-181 -75t-75 -181v-192h96q40 0 68 -28t28 -68v-576q0 -40 -28 -68t-68 -28h-960q-40 0 -68 28t-28 68v576q0 40 28 68t68 28h672v192q0 185 131.5 316.5t316.5 131.5 t316.5 -131.5t131.5 -316.5z" /> | ||
| 182 | <glyph unicode="" horiz-adv-x="1920" d="M1760 1408q66 0 113 -47t47 -113v-1216q0 -66 -47 -113t-113 -47h-1600q-66 0 -113 47t-47 113v1216q0 66 47 113t113 47h1600zM160 1280q-13 0 -22.5 -9.5t-9.5 -22.5v-224h1664v224q0 13 -9.5 22.5t-22.5 9.5h-1600zM1760 0q13 0 22.5 9.5t9.5 22.5v608h-1664v-608 q0 -13 9.5 -22.5t22.5 -9.5h1600zM256 128v128h256v-128h-256zM640 128v128h384v-128h-384z" /> | ||
| 183 | <glyph unicode="" horiz-adv-x="1408" d="M384 192q0 -80 -56 -136t-136 -56t-136 56t-56 136t56 136t136 56t136 -56t56 -136zM896 69q2 -28 -17 -48q-18 -21 -47 -21h-135q-25 0 -43 16.5t-20 41.5q-22 229 -184.5 391.5t-391.5 184.5q-25 2 -41.5 20t-16.5 43v135q0 29 21 47q17 17 43 17h5q160 -13 306 -80.5 t259 -181.5q114 -113 181.5 -259t80.5 -306zM1408 67q2 -27 -18 -47q-18 -20 -46 -20h-143q-26 0 -44.5 17.5t-19.5 42.5q-12 215 -101 408.5t-231.5 336t-336 231.5t-408.5 102q-25 1 -42.5 19.5t-17.5 43.5v143q0 28 20 46q18 18 44 18h3q262 -13 501.5 -120t425.5 -294 q187 -186 294 -425.5t120 -501.5z" /> | ||
| 184 | <glyph unicode="" d="M1040 320q0 -33 -23.5 -56.5t-56.5 -23.5t-56.5 23.5t-23.5 56.5t23.5 56.5t56.5 23.5t56.5 -23.5t23.5 -56.5zM1296 320q0 -33 -23.5 -56.5t-56.5 -23.5t-56.5 23.5t-23.5 56.5t23.5 56.5t56.5 23.5t56.5 -23.5t23.5 -56.5zM1408 160v320q0 13 -9.5 22.5t-22.5 9.5 h-1216q-13 0 -22.5 -9.5t-9.5 -22.5v-320q0 -13 9.5 -22.5t22.5 -9.5h1216q13 0 22.5 9.5t9.5 22.5zM178 640h1180l-157 482q-4 13 -16 21.5t-26 8.5h-782q-14 0 -26 -8.5t-16 -21.5zM1536 480v-320q0 -66 -47 -113t-113 -47h-1216q-66 0 -113 47t-47 113v320q0 25 16 75 l197 606q17 53 63 86t101 33h782q55 0 101 -33t63 -86l197 -606q16 -50 16 -75z" /> | ||
| 185 | <glyph unicode="" horiz-adv-x="1792" d="M1664 896q53 0 90.5 -37.5t37.5 -90.5t-37.5 -90.5t-90.5 -37.5v-384q0 -52 -38 -90t-90 -38q-417 347 -812 380q-58 -19 -91 -66t-31 -100.5t40 -92.5q-20 -33 -23 -65.5t6 -58t33.5 -55t48 -50t61.5 -50.5q-29 -58 -111.5 -83t-168.5 -11.5t-132 55.5q-7 23 -29.5 87.5 t-32 94.5t-23 89t-15 101t3.5 98.5t22 110.5h-122q-66 0 -113 47t-47 113v192q0 66 47 113t113 47h480q435 0 896 384q52 0 90 -38t38 -90v-384zM1536 292v954q-394 -302 -768 -343v-270q377 -42 768 -341z" /> | ||
| 186 | <glyph unicode="" horiz-adv-x="1664" d="M848 -160q0 16 -16 16q-59 0 -101.5 42.5t-42.5 101.5q0 16 -16 16t-16 -16q0 -73 51.5 -124.5t124.5 -51.5q16 0 16 16zM183 128h1298q-164 181 -246.5 411.5t-82.5 484.5q0 256 -320 256t-320 -256q0 -254 -82.5 -484.5t-246.5 -411.5zM1664 128q0 -52 -38 -90t-90 -38 h-448q0 -106 -75 -181t-181 -75t-181 75t-75 181h-448q-52 0 -90 38t-38 90q190 161 287 397.5t97 498.5q0 165 96 262t264 117q-8 18 -8 37q0 40 28 68t68 28t68 -28t28 -68q0 -19 -8 -37q168 -20 264 -117t96 -262q0 -262 97 -498.5t287 -397.5z" /> | ||
| 187 | <glyph unicode="" d="M1376 640l138 -135q30 -28 20 -70q-12 -41 -52 -51l-188 -48l53 -186q12 -41 -19 -70q-29 -31 -70 -19l-186 53l-48 -188q-10 -40 -51 -52q-12 -2 -19 -2q-31 0 -51 22l-135 138l-135 -138q-28 -30 -70 -20q-41 11 -51 52l-48 188l-186 -53q-41 -12 -70 19q-31 29 -19 70 l53 186l-188 48q-40 10 -52 51q-10 42 20 70l138 135l-138 135q-30 28 -20 70q12 41 52 51l188 48l-53 186q-12 41 19 70q29 31 70 19l186 -53l48 188q10 41 51 51q41 12 70 -19l135 -139l135 139q29 30 70 19q41 -10 51 -51l48 -188l186 53q41 12 70 -19q31 -29 19 -70 l-53 -186l188 -48q40 -10 52 -51q10 -42 -20 -70z" /> | ||
| 188 | <glyph unicode="" horiz-adv-x="1792" d="M256 192q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1664 768q0 51 -39 89.5t-89 38.5h-576q0 20 15 48.5t33 55t33 68t15 84.5q0 67 -44.5 97.5t-115.5 30.5q-24 0 -90 -139q-24 -44 -37 -65q-40 -64 -112 -145q-71 -81 -101 -106 q-69 -57 -140 -57h-32v-640h32q72 0 167 -32t193.5 -64t179.5 -32q189 0 189 167q0 26 -5 56q30 16 47.5 52.5t17.5 73.5t-18 69q53 50 53 119q0 25 -10 55.5t-25 47.5h331q52 0 90 38t38 90zM1792 769q0 -105 -75.5 -181t-180.5 -76h-169q-4 -62 -37 -119q3 -21 3 -43 q0 -101 -60 -178q1 -139 -85 -219.5t-227 -80.5q-133 0 -322 69q-164 59 -223 59h-288q-53 0 -90.5 37.5t-37.5 90.5v640q0 53 37.5 90.5t90.5 37.5h288q10 0 21.5 4.5t23.5 14t22.5 18t24 22.5t20.5 21.5t19 21.5t14 17q65 74 100 129q13 21 33 62t37 72t40.5 63t55 49.5 t69.5 17.5q125 0 206.5 -67t81.5 -189q0 -68 -22 -128h374q104 0 180 -76t76 -179z" /> | ||
| 189 | <glyph unicode="" horiz-adv-x="1792" d="M1376 128h32v640h-32q-35 0 -67.5 12t-62.5 37t-50 46t-49 54q-2 3 -3.5 4.5t-4 4.5t-4.5 5q-72 81 -112 145q-14 22 -38 68q-1 3 -10.5 22.5t-18.5 36t-20 35.5t-21.5 30.5t-18.5 11.5q-71 0 -115.5 -30.5t-44.5 -97.5q0 -43 15 -84.5t33 -68t33 -55t15 -48.5h-576 q-50 0 -89 -38.5t-39 -89.5q0 -52 38 -90t90 -38h331q-15 -17 -25 -47.5t-10 -55.5q0 -69 53 -119q-18 -32 -18 -69t17.5 -73.5t47.5 -52.5q-4 -24 -4 -56q0 -85 48.5 -126t135.5 -41q84 0 183 32t194 64t167 32zM1664 192q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45 t45 -19t45 19t19 45zM1792 768v-640q0 -53 -37.5 -90.5t-90.5 -37.5h-288q-59 0 -223 -59q-190 -69 -317 -69q-142 0 -230 77.5t-87 217.5l1 5q-61 76 -61 178q0 22 3 43q-33 57 -37 119h-169q-105 0 -180.5 76t-75.5 181q0 103 76 179t180 76h374q-22 60 -22 128 q0 122 81.5 189t206.5 67q38 0 69.5 -17.5t55 -49.5t40.5 -63t37 -72t33 -62q35 -55 100 -129q2 -3 14 -17t19 -21.5t20.5 -21.5t24 -22.5t22.5 -18t23.5 -14t21.5 -4.5h288q53 0 90.5 -37.5t37.5 -90.5z" /> | ||
| 190 | <glyph unicode="" d="M1280 -64q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1408 700q0 189 -167 189q-26 0 -56 -5q-16 30 -52.5 47.5t-73.5 17.5t-69 -18q-50 53 -119 53q-25 0 -55.5 -10t-47.5 -25v331q0 52 -38 90t-90 38q-51 0 -89.5 -39t-38.5 -89v-576 q-20 0 -48.5 15t-55 33t-68 33t-84.5 15q-67 0 -97.5 -44.5t-30.5 -115.5q0 -24 139 -90q44 -24 65 -37q64 -40 145 -112q81 -71 106 -101q57 -69 57 -140v-32h640v32q0 72 32 167t64 193.5t32 179.5zM1536 705q0 -133 -69 -322q-59 -164 -59 -223v-288q0 -53 -37.5 -90.5 t-90.5 -37.5h-640q-53 0 -90.5 37.5t-37.5 90.5v288q0 10 -4.5 21.5t-14 23.5t-18 22.5t-22.5 24t-21.5 20.5t-21.5 19t-17 14q-74 65 -129 100q-21 13 -62 33t-72 37t-63 40.5t-49.5 55t-17.5 69.5q0 125 67 206.5t189 81.5q68 0 128 -22v374q0 104 76 180t179 76 q105 0 181 -75.5t76 -180.5v-169q62 -4 119 -37q21 3 43 3q101 0 178 -60q139 1 219.5 -85t80.5 -227z" /> | ||
| 191 | <glyph unicode="" d="M1408 576q0 84 -32 183t-64 194t-32 167v32h-640v-32q0 -35 -12 -67.5t-37 -62.5t-46 -50t-54 -49q-9 -8 -14 -12q-81 -72 -145 -112q-22 -14 -68 -38q-3 -1 -22.5 -10.5t-36 -18.5t-35.5 -20t-30.5 -21.5t-11.5 -18.5q0 -71 30.5 -115.5t97.5 -44.5q43 0 84.5 15t68 33 t55 33t48.5 15v-576q0 -50 38.5 -89t89.5 -39q52 0 90 38t38 90v331q46 -35 103 -35q69 0 119 53q32 -18 69 -18t73.5 17.5t52.5 47.5q24 -4 56 -4q85 0 126 48.5t41 135.5zM1280 1344q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1536 580 q0 -142 -77.5 -230t-217.5 -87l-5 1q-76 -61 -178 -61q-22 0 -43 3q-54 -30 -119 -37v-169q0 -105 -76 -180.5t-181 -75.5q-103 0 -179 76t-76 180v374q-54 -22 -128 -22q-121 0 -188.5 81.5t-67.5 206.5q0 38 17.5 69.5t49.5 55t63 40.5t72 37t62 33q55 35 129 100 q3 2 17 14t21.5 19t21.5 20.5t22.5 24t18 22.5t14 23.5t4.5 21.5v288q0 53 37.5 90.5t90.5 37.5h640q53 0 90.5 -37.5t37.5 -90.5v-288q0 -59 59 -223q69 -190 69 -317z" /> | ||
| 192 | <glyph unicode="" d="M1280 576v128q0 26 -19 45t-45 19h-502l189 189q19 19 19 45t-19 45l-91 91q-18 18 -45 18t-45 -18l-362 -362l-91 -91q-18 -18 -18 -45t18 -45l91 -91l362 -362q18 -18 45 -18t45 18l91 91q18 18 18 45t-18 45l-189 189h502q26 0 45 19t19 45zM1536 640 q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 193 | <glyph unicode="" d="M1285 640q0 27 -18 45l-91 91l-362 362q-18 18 -45 18t-45 -18l-91 -91q-18 -18 -18 -45t18 -45l189 -189h-502q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h502l-189 -189q-19 -19 -19 -45t19 -45l91 -91q18 -18 45 -18t45 18l362 362l91 91q18 18 18 45zM1536 640 q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 194 | <glyph unicode="" d="M1284 641q0 27 -18 45l-362 362l-91 91q-18 18 -45 18t-45 -18l-91 -91l-362 -362q-18 -18 -18 -45t18 -45l91 -91q18 -18 45 -18t45 18l189 189v-502q0 -26 19 -45t45 -19h128q26 0 45 19t19 45v502l189 -189q19 -19 45 -19t45 19l91 91q18 18 18 45zM1536 640 q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 195 | <glyph unicode="" d="M1284 639q0 27 -18 45l-91 91q-18 18 -45 18t-45 -18l-189 -189v502q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-502l-189 189q-19 19 -45 19t-45 -19l-91 -91q-18 -18 -18 -45t18 -45l362 -362l91 -91q18 -18 45 -18t45 18l91 91l362 362q18 18 18 45zM1536 640 q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 196 | <glyph unicode="" d="M768 1408q209 0 385.5 -103t279.5 -279.5t103 -385.5t-103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103zM1042 887q-2 -1 -9.5 -9.5t-13.5 -9.5q2 0 4.5 5t5 11t3.5 7q6 7 22 15q14 6 52 12q34 8 51 -11 q-2 2 9.5 13t14.5 12q3 2 15 4.5t15 7.5l2 22q-12 -1 -17.5 7t-6.5 21q0 -2 -6 -8q0 7 -4.5 8t-11.5 -1t-9 -1q-10 3 -15 7.5t-8 16.5t-4 15q-2 5 -9.5 10.5t-9.5 10.5q-1 2 -2.5 5.5t-3 6.5t-4 5.5t-5.5 2.5t-7 -5t-7.5 -10t-4.5 -5q-3 2 -6 1.5t-4.5 -1t-4.5 -3t-5 -3.5 q-3 -2 -8.5 -3t-8.5 -2q15 5 -1 11q-10 4 -16 3q9 4 7.5 12t-8.5 14h5q-1 4 -8.5 8.5t-17.5 8.5t-13 6q-8 5 -34 9.5t-33 0.5q-5 -6 -4.5 -10.5t4 -14t3.5 -12.5q1 -6 -5.5 -13t-6.5 -12q0 -7 14 -15.5t10 -21.5q-3 -8 -16 -16t-16 -12q-5 -8 -1.5 -18.5t10.5 -16.5 q2 -2 1.5 -4t-3.5 -4.5t-5.5 -4t-6.5 -3.5l-3 -2q-11 -5 -20.5 6t-13.5 26q-7 25 -16 30q-23 8 -29 -1q-5 13 -41 26q-25 9 -58 4q6 1 0 15q-7 15 -19 12q3 6 4 17.5t1 13.5q3 13 12 23q1 1 7 8.5t9.5 13.5t0.5 6q35 -4 50 11q5 5 11.5 17t10.5 17q9 6 14 5.5t14.5 -5.5 t14.5 -5q14 -1 15.5 11t-7.5 20q12 -1 3 17q-5 7 -8 9q-12 4 -27 -5q-8 -4 2 -8q-1 1 -9.5 -10.5t-16.5 -17.5t-16 5q-1 1 -5.5 13.5t-9.5 13.5q-8 0 -16 -15q3 8 -11 15t-24 8q19 12 -8 27q-7 4 -20.5 5t-19.5 -4q-5 -7 -5.5 -11.5t5 -8t10.5 -5.5t11.5 -4t8.5 -3 q14 -10 8 -14q-2 -1 -8.5 -3.5t-11.5 -4.5t-6 -4q-3 -4 0 -14t-2 -14q-5 5 -9 17.5t-7 16.5q7 -9 -25 -6l-10 1q-4 0 -16 -2t-20.5 -1t-13.5 8q-4 8 0 20q1 4 4 2q-4 3 -11 9.5t-10 8.5q-46 -15 -94 -41q6 -1 12 1q5 2 13 6.5t10 5.5q34 14 42 7l5 5q14 -16 20 -25 q-7 4 -30 1q-20 -6 -22 -12q7 -12 5 -18q-4 3 -11.5 10t-14.5 11t-15 5q-16 0 -22 -1q-146 -80 -235 -222q7 -7 12 -8q4 -1 5 -9t2.5 -11t11.5 3q9 -8 3 -19q1 1 44 -27q19 -17 21 -21q3 -11 -10 -18q-1 2 -9 9t-9 4q-3 -5 0.5 -18.5t10.5 -12.5q-7 0 -9.5 -16t-2.5 -35.5 t-1 -23.5l2 -1q-3 -12 5.5 -34.5t21.5 -19.5q-13 -3 20 -43q6 -8 8 -9q3 -2 12 -7.5t15 -10t10 -10.5q4 -5 10 -22.5t14 -23.5q-2 -6 9.5 -20t10.5 -23q-1 0 -2.5 -1t-2.5 -1q3 -7 15.5 -14t15.5 -13q1 -3 2 -10t3 -11t8 -2q2 20 -24 62q-15 25 -17 29q-3 5 -5.5 15.5 t-4.5 14.5q2 0 6 -1.5t8.5 -3.5t7.5 -4t2 -3q-3 -7 2 -17.5t12 -18.5t17 -19t12 -13q6 -6 14 -19.5t0 -13.5q9 0 20 -10t17 -20q5 -8 8 -26t5 -24q2 -7 8.5 -13.5t12.5 -9.5l16 -8t13 -7q5 -2 18.5 -10.5t21.5 -11.5q10 -4 16 -4t14.5 2.5t13.5 3.5q15 2 29 -15t21 -21 q36 -19 55 -11q-2 -1 0.5 -7.5t8 -15.5t9 -14.5t5.5 -8.5q5 -6 18 -15t18 -15q6 4 7 9q-3 -8 7 -20t18 -10q14 3 14 32q-31 -15 -49 18q0 1 -2.5 5.5t-4 8.5t-2.5 8.5t0 7.5t5 3q9 0 10 3.5t-2 12.5t-4 13q-1 8 -11 20t-12 15q-5 -9 -16 -8t-16 9q0 -1 -1.5 -5.5t-1.5 -6.5 q-13 0 -15 1q1 3 2.5 17.5t3.5 22.5q1 4 5.5 12t7.5 14.5t4 12.5t-4.5 9.5t-17.5 2.5q-19 -1 -26 -20q-1 -3 -3 -10.5t-5 -11.5t-9 -7q-7 -3 -24 -2t-24 5q-13 8 -22.5 29t-9.5 37q0 10 2.5 26.5t3 25t-5.5 24.5q3 2 9 9.5t10 10.5q2 1 4.5 1.5t4.5 0t4 1.5t3 6q-1 1 -4 3 q-3 3 -4 3q7 -3 28.5 1.5t27.5 -1.5q15 -11 22 2q0 1 -2.5 9.5t-0.5 13.5q5 -27 29 -9q3 -3 15.5 -5t17.5 -5q3 -2 7 -5.5t5.5 -4.5t5 0.5t8.5 6.5q10 -14 12 -24q11 -40 19 -44q7 -3 11 -2t4.5 9.5t0 14t-1.5 12.5l-1 8v18l-1 8q-15 3 -18.5 12t1.5 18.5t15 18.5q1 1 8 3.5 t15.5 6.5t12.5 8q21 19 15 35q7 0 11 9q-1 0 -5 3t-7.5 5t-4.5 2q9 5 2 16q5 3 7.5 11t7.5 10q9 -12 21 -2q7 8 1 16q5 7 20.5 10.5t18.5 9.5q7 -2 8 2t1 12t3 12q4 5 15 9t13 5l17 11q3 4 0 4q18 -2 31 11q10 11 -6 20q3 6 -3 9.5t-15 5.5q3 1 11.5 0.5t10.5 1.5 q15 10 -7 16q-17 5 -43 -12zM879 10q206 36 351 189q-3 3 -12.5 4.5t-12.5 3.5q-18 7 -24 8q1 7 -2.5 13t-8 9t-12.5 8t-11 7q-2 2 -7 6t-7 5.5t-7.5 4.5t-8.5 2t-10 -1l-3 -1q-3 -1 -5.5 -2.5t-5.5 -3t-4 -3t0 -2.5q-21 17 -36 22q-5 1 -11 5.5t-10.5 7t-10 1.5t-11.5 -7 q-5 -5 -6 -15t-2 -13q-7 5 0 17.5t2 18.5q-3 6 -10.5 4.5t-12 -4.5t-11.5 -8.5t-9 -6.5t-8.5 -5.5t-8.5 -7.5q-3 -4 -6 -12t-5 -11q-2 4 -11.5 6.5t-9.5 5.5q2 -10 4 -35t5 -38q7 -31 -12 -48q-27 -25 -29 -40q-4 -22 12 -26q0 -7 -8 -20.5t-7 -21.5q0 -6 2 -16z" /> | ||
| 197 | <glyph unicode="" horiz-adv-x="1664" d="M384 64q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1028 484l-682 -682q-37 -37 -90 -37q-52 0 -91 37l-106 108q-38 36 -38 90q0 53 38 91l681 681q39 -98 114.5 -173.5t173.5 -114.5zM1662 919q0 -39 -23 -106q-47 -134 -164.5 -217.5 t-258.5 -83.5q-185 0 -316.5 131.5t-131.5 316.5t131.5 316.5t316.5 131.5q58 0 121.5 -16.5t107.5 -46.5q16 -11 16 -28t-16 -28l-293 -169v-224l193 -107q5 3 79 48.5t135.5 81t70.5 35.5q15 0 23.5 -10t8.5 -25z" /> | ||
| 198 | <glyph unicode="" horiz-adv-x="1792" d="M1024 128h640v128h-640v-128zM640 640h1024v128h-1024v-128zM1280 1152h384v128h-384v-128zM1792 320v-256q0 -26 -19 -45t-45 -19h-1664q-26 0 -45 19t-19 45v256q0 26 19 45t45 19h1664q26 0 45 -19t19 -45zM1792 832v-256q0 -26 -19 -45t-45 -19h-1664q-26 0 -45 19 t-19 45v256q0 26 19 45t45 19h1664q26 0 45 -19t19 -45zM1792 1344v-256q0 -26 -19 -45t-45 -19h-1664q-26 0 -45 19t-19 45v256q0 26 19 45t45 19h1664q26 0 45 -19t19 -45z" /> | ||
| 199 | <glyph unicode="" horiz-adv-x="1408" d="M1403 1241q17 -41 -14 -70l-493 -493v-742q0 -42 -39 -59q-13 -5 -25 -5q-27 0 -45 19l-256 256q-19 19 -19 45v486l-493 493q-31 29 -14 70q17 39 59 39h1280q42 0 59 -39z" /> | ||
| 200 | <glyph unicode="" horiz-adv-x="1792" d="M640 1280h512v128h-512v-128zM1792 640v-480q0 -66 -47 -113t-113 -47h-1472q-66 0 -113 47t-47 113v480h672v-160q0 -26 19 -45t45 -19h320q26 0 45 19t19 45v160h672zM1024 640v-128h-256v128h256zM1792 1120v-384h-1792v384q0 66 47 113t113 47h352v160q0 40 28 68 t68 28h576q40 0 68 -28t28 -68v-160h352q66 0 113 -47t47 -113z" /> | ||
| 201 | <glyph unicode="" d="M1283 995l-355 -355l355 -355l144 144q29 31 70 14q39 -17 39 -59v-448q0 -26 -19 -45t-45 -19h-448q-42 0 -59 40q-17 39 14 69l144 144l-355 355l-355 -355l144 -144q31 -30 14 -69q-17 -40 -59 -40h-448q-26 0 -45 19t-19 45v448q0 42 40 59q39 17 69 -14l144 -144 l355 355l-355 355l-144 -144q-19 -19 -45 -19q-12 0 -24 5q-40 17 -40 59v448q0 26 19 45t45 19h448q42 0 59 -40q17 -39 -14 -69l-144 -144l355 -355l355 355l-144 144q-31 30 -14 69q17 40 59 40h448q26 0 45 -19t19 -45v-448q0 -42 -39 -59q-13 -5 -25 -5q-26 0 -45 19z " /> | ||
| 202 | <glyph unicode="" horiz-adv-x="1920" d="M593 640q-162 -5 -265 -128h-134q-82 0 -138 40.5t-56 118.5q0 353 124 353q6 0 43.5 -21t97.5 -42.5t119 -21.5q67 0 133 23q-5 -37 -5 -66q0 -139 81 -256zM1664 3q0 -120 -73 -189.5t-194 -69.5h-874q-121 0 -194 69.5t-73 189.5q0 53 3.5 103.5t14 109t26.5 108.5 t43 97.5t62 81t85.5 53.5t111.5 20q10 0 43 -21.5t73 -48t107 -48t135 -21.5t135 21.5t107 48t73 48t43 21.5q61 0 111.5 -20t85.5 -53.5t62 -81t43 -97.5t26.5 -108.5t14 -109t3.5 -103.5zM640 1280q0 -106 -75 -181t-181 -75t-181 75t-75 181t75 181t181 75t181 -75 t75 -181zM1344 896q0 -159 -112.5 -271.5t-271.5 -112.5t-271.5 112.5t-112.5 271.5t112.5 271.5t271.5 112.5t271.5 -112.5t112.5 -271.5zM1920 671q0 -78 -56 -118.5t-138 -40.5h-134q-103 123 -265 128q81 117 81 256q0 29 -5 66q66 -23 133 -23q59 0 119 21.5t97.5 42.5 t43.5 21q124 0 124 -353zM1792 1280q0 -106 -75 -181t-181 -75t-181 75t-75 181t75 181t181 75t181 -75t75 -181z" /> | ||
| 203 | <glyph unicode="" horiz-adv-x="1664" d="M1456 320q0 40 -28 68l-208 208q-28 28 -68 28q-42 0 -72 -32q3 -3 19 -18.5t21.5 -21.5t15 -19t13 -25.5t3.5 -27.5q0 -40 -28 -68t-68 -28q-15 0 -27.5 3.5t-25.5 13t-19 15t-21.5 21.5t-18.5 19q-33 -31 -33 -73q0 -40 28 -68l206 -207q27 -27 68 -27q40 0 68 26 l147 146q28 28 28 67zM753 1025q0 40 -28 68l-206 207q-28 28 -68 28q-39 0 -68 -27l-147 -146q-28 -28 -28 -67q0 -40 28 -68l208 -208q27 -27 68 -27q42 0 72 31q-3 3 -19 18.5t-21.5 21.5t-15 19t-13 25.5t-3.5 27.5q0 40 28 68t68 28q15 0 27.5 -3.5t25.5 -13t19 -15 t21.5 -21.5t18.5 -19q33 31 33 73zM1648 320q0 -120 -85 -203l-147 -146q-83 -83 -203 -83q-121 0 -204 85l-206 207q-83 83 -83 203q0 123 88 209l-88 88q-86 -88 -208 -88q-120 0 -204 84l-208 208q-84 84 -84 204t85 203l147 146q83 83 203 83q121 0 204 -85l206 -207 q83 -83 83 -203q0 -123 -88 -209l88 -88q86 88 208 88q120 0 204 -84l208 -208q84 -84 84 -204z" /> | ||
| 204 | <glyph unicode="" horiz-adv-x="1920" d="M1920 384q0 -159 -112.5 -271.5t-271.5 -112.5h-1088q-185 0 -316.5 131.5t-131.5 316.5q0 132 71 241.5t187 163.5q-2 28 -2 43q0 212 150 362t362 150q158 0 286.5 -88t187.5 -230q70 62 166 62q106 0 181 -75t75 -181q0 -75 -41 -138q129 -30 213 -134.5t84 -239.5z " /> | ||
| 205 | <glyph unicode="" horiz-adv-x="1664" d="M1527 88q56 -89 21.5 -152.5t-140.5 -63.5h-1152q-106 0 -140.5 63.5t21.5 152.5l503 793v399h-64q-26 0 -45 19t-19 45t19 45t45 19h512q26 0 45 -19t19 -45t-19 -45t-45 -19h-64v-399zM748 813l-272 -429h712l-272 429l-20 31v37v399h-128v-399v-37z" /> | ||
| 206 | <glyph unicode="" horiz-adv-x="1792" d="M960 640q26 0 45 -19t19 -45t-19 -45t-45 -19t-45 19t-19 45t19 45t45 19zM1260 576l507 -398q28 -20 25 -56q-5 -35 -35 -51l-128 -64q-13 -7 -29 -7q-17 0 -31 8l-690 387l-110 -66q-8 -4 -12 -5q14 -49 10 -97q-7 -77 -56 -147.5t-132 -123.5q-132 -84 -277 -84 q-136 0 -222 78q-90 84 -79 207q7 76 56 147t131 124q132 84 278 84q83 0 151 -31q9 13 22 22l122 73l-122 73q-13 9 -22 22q-68 -31 -151 -31q-146 0 -278 84q-82 53 -131 124t-56 147q-5 59 15.5 113t63.5 93q85 79 222 79q145 0 277 -84q83 -52 132 -123t56 -148 q4 -48 -10 -97q4 -1 12 -5l110 -66l690 387q14 8 31 8q16 0 29 -7l128 -64q30 -16 35 -51q3 -36 -25 -56zM579 836q46 42 21 108t-106 117q-92 59 -192 59q-74 0 -113 -36q-46 -42 -21 -108t106 -117q92 -59 192 -59q74 0 113 36zM494 91q81 51 106 117t-21 108 q-39 36 -113 36q-100 0 -192 -59q-81 -51 -106 -117t21 -108q39 -36 113 -36q100 0 192 59zM672 704l96 -58v11q0 36 33 56l14 8l-79 47l-26 -26q-3 -3 -10 -11t-12 -12q-2 -2 -4 -3.5t-3 -2.5zM896 480l96 -32l736 576l-128 64l-768 -431v-113l-160 -96l9 -8q2 -2 7 -6 q4 -4 11 -12t11 -12l26 -26zM1600 64l128 64l-520 408l-177 -138q-2 -3 -13 -7z" /> | ||
| 207 | <glyph unicode="" horiz-adv-x="1792" d="M1696 1152q40 0 68 -28t28 -68v-1216q0 -40 -28 -68t-68 -28h-960q-40 0 -68 28t-28 68v288h-544q-40 0 -68 28t-28 68v672q0 40 20 88t48 76l408 408q28 28 76 48t88 20h416q40 0 68 -28t28 -68v-328q68 40 128 40h416zM1152 939l-299 -299h299v299zM512 1323l-299 -299 h299v299zM708 676l316 316v416h-384v-416q0 -40 -28 -68t-68 -28h-416v-640h512v256q0 40 20 88t48 76zM1664 -128v1152h-384v-416q0 -40 -28 -68t-68 -28h-416v-640h896z" /> | ||
| 208 | <glyph unicode="" horiz-adv-x="1408" d="M1404 151q0 -117 -79 -196t-196 -79q-135 0 -235 100l-777 776q-113 115 -113 271q0 159 110 270t269 111q158 0 273 -113l605 -606q10 -10 10 -22q0 -16 -30.5 -46.5t-46.5 -30.5q-13 0 -23 10l-606 607q-79 77 -181 77q-106 0 -179 -75t-73 -181q0 -105 76 -181 l776 -777q63 -63 145 -63q64 0 106 42t42 106q0 82 -63 145l-581 581q-26 24 -60 24q-29 0 -48 -19t-19 -48q0 -32 25 -59l410 -410q10 -10 10 -22q0 -16 -31 -47t-47 -31q-12 0 -22 10l-410 410q-63 61 -63 149q0 82 57 139t139 57q88 0 149 -63l581 -581q100 -98 100 -235 z" /> | ||
| 209 | <glyph unicode="" d="M384 0h768v384h-768v-384zM1280 0h128v896q0 14 -10 38.5t-20 34.5l-281 281q-10 10 -34 20t-39 10v-416q0 -40 -28 -68t-68 -28h-576q-40 0 -68 28t-28 68v416h-128v-1280h128v416q0 40 28 68t68 28h832q40 0 68 -28t28 -68v-416zM896 928v320q0 13 -9.5 22.5t-22.5 9.5 h-192q-13 0 -22.5 -9.5t-9.5 -22.5v-320q0 -13 9.5 -22.5t22.5 -9.5h192q13 0 22.5 9.5t9.5 22.5zM1536 896v-928q0 -40 -28 -68t-68 -28h-1344q-40 0 -68 28t-28 68v1344q0 40 28 68t68 28h928q40 0 88 -20t76 -48l280 -280q28 -28 48 -76t20 -88z" /> | ||
| 210 | <glyph unicode="" d="M1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> | ||
| 211 | <glyph unicode="" d="M1536 192v-128q0 -26 -19 -45t-45 -19h-1408q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1408q26 0 45 -19t19 -45zM1536 704v-128q0 -26 -19 -45t-45 -19h-1408q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1408q26 0 45 -19t19 -45zM1536 1216v-128q0 -26 -19 -45 t-45 -19h-1408q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1408q26 0 45 -19t19 -45z" /> | ||
| 212 | <glyph unicode="" horiz-adv-x="1792" d="M384 128q0 -80 -56 -136t-136 -56t-136 56t-56 136t56 136t136 56t136 -56t56 -136zM384 640q0 -80 -56 -136t-136 -56t-136 56t-56 136t56 136t136 56t136 -56t56 -136zM1792 224v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1216q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5 t22.5 9.5h1216q13 0 22.5 -9.5t9.5 -22.5zM384 1152q0 -80 -56 -136t-136 -56t-136 56t-56 136t56 136t136 56t136 -56t56 -136zM1792 736v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1216q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1216q13 0 22.5 -9.5t9.5 -22.5z M1792 1248v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1216q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1216q13 0 22.5 -9.5t9.5 -22.5z" /> | ||
| 213 | <glyph unicode="" horiz-adv-x="1792" d="M381 -84q0 -80 -54.5 -126t-135.5 -46q-106 0 -172 66l57 88q49 -45 106 -45q29 0 50.5 14.5t21.5 42.5q0 64 -105 56l-26 56q8 10 32.5 43.5t42.5 54t37 38.5v1q-16 0 -48.5 -1t-48.5 -1v-53h-106v152h333v-88l-95 -115q51 -12 81 -49t30 -88zM383 543v-159h-362 q-6 36 -6 54q0 51 23.5 93t56.5 68t66 47.5t56.5 43.5t23.5 45q0 25 -14.5 38.5t-39.5 13.5q-46 0 -81 -58l-85 59q24 51 71.5 79.5t105.5 28.5q73 0 123 -41.5t50 -112.5q0 -50 -34 -91.5t-75 -64.5t-75.5 -50.5t-35.5 -52.5h127v60h105zM1792 224v-192q0 -13 -9.5 -22.5 t-22.5 -9.5h-1216q-13 0 -22.5 9.5t-9.5 22.5v192q0 14 9 23t23 9h1216q13 0 22.5 -9.5t9.5 -22.5zM384 1123v-99h-335v99h107q0 41 0.5 122t0.5 121v12h-2q-8 -17 -50 -54l-71 76l136 127h106v-404h108zM1792 736v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1216q-13 0 -22.5 9.5 t-9.5 22.5v192q0 14 9 23t23 9h1216q13 0 22.5 -9.5t9.5 -22.5zM1792 1248v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1216q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1216q13 0 22.5 -9.5t9.5 -22.5z" /> | ||
| 214 | <glyph unicode="" horiz-adv-x="1792" d="M1760 640q14 0 23 -9t9 -23v-64q0 -14 -9 -23t-23 -9h-1728q-14 0 -23 9t-9 23v64q0 14 9 23t23 9h1728zM483 704q-28 35 -51 80q-48 97 -48 188q0 181 134 309q133 127 393 127q50 0 167 -19q66 -12 177 -48q10 -38 21 -118q14 -123 14 -183q0 -18 -5 -45l-12 -3l-84 6 l-14 2q-50 149 -103 205q-88 91 -210 91q-114 0 -182 -59q-67 -58 -67 -146q0 -73 66 -140t279 -129q69 -20 173 -66q58 -28 95 -52h-743zM990 448h411q7 -39 7 -92q0 -111 -41 -212q-23 -55 -71 -104q-37 -35 -109 -81q-80 -48 -153 -66q-80 -21 -203 -21q-114 0 -195 23 l-140 40q-57 16 -72 28q-8 8 -8 22v13q0 108 -2 156q-1 30 0 68l2 37v44l102 2q15 -34 30 -71t22.5 -56t12.5 -27q35 -57 80 -94q43 -36 105 -57q59 -22 132 -22q64 0 139 27q77 26 122 86q47 61 47 129q0 84 -81 157q-34 29 -137 71z" /> | ||
| 215 | <glyph unicode="" d="M48 1313q-37 2 -45 4l-3 88q13 1 40 1q60 0 112 -4q132 -7 166 -7q86 0 168 3q116 4 146 5q56 0 86 2l-1 -14l2 -64v-9q-60 -9 -124 -9q-60 0 -79 -25q-13 -14 -13 -132q0 -13 0.5 -32.5t0.5 -25.5l1 -229l14 -280q6 -124 51 -202q35 -59 96 -92q88 -47 177 -47 q104 0 191 28q56 18 99 51q48 36 65 64q36 56 53 114q21 73 21 229q0 79 -3.5 128t-11 122.5t-13.5 159.5l-4 59q-5 67 -24 88q-34 35 -77 34l-100 -2l-14 3l2 86h84l205 -10q76 -3 196 10l18 -2q6 -38 6 -51q0 -7 -4 -31q-45 -12 -84 -13q-73 -11 -79 -17q-15 -15 -15 -41 q0 -7 1.5 -27t1.5 -31q8 -19 22 -396q6 -195 -15 -304q-15 -76 -41 -122q-38 -65 -112 -123q-75 -57 -182 -89q-109 -33 -255 -33q-167 0 -284 46q-119 47 -179 122q-61 76 -83 195q-16 80 -16 237v333q0 188 -17 213q-25 36 -147 39zM1536 -96v64q0 14 -9 23t-23 9h-1472 q-14 0 -23 -9t-9 -23v-64q0 -14 9 -23t23 -9h1472q14 0 23 9t9 23z" /> | ||
| 216 | <glyph unicode="" horiz-adv-x="1664" d="M512 160v192q0 14 -9 23t-23 9h-320q-14 0 -23 -9t-9 -23v-192q0 -14 9 -23t23 -9h320q14 0 23 9t9 23zM512 544v192q0 14 -9 23t-23 9h-320q-14 0 -23 -9t-9 -23v-192q0 -14 9 -23t23 -9h320q14 0 23 9t9 23zM1024 160v192q0 14 -9 23t-23 9h-320q-14 0 -23 -9t-9 -23 v-192q0 -14 9 -23t23 -9h320q14 0 23 9t9 23zM512 928v192q0 14 -9 23t-23 9h-320q-14 0 -23 -9t-9 -23v-192q0 -14 9 -23t23 -9h320q14 0 23 9t9 23zM1024 544v192q0 14 -9 23t-23 9h-320q-14 0 -23 -9t-9 -23v-192q0 -14 9 -23t23 -9h320q14 0 23 9t9 23zM1536 160v192 q0 14 -9 23t-23 9h-320q-14 0 -23 -9t-9 -23v-192q0 -14 9 -23t23 -9h320q14 0 23 9t9 23zM1024 928v192q0 14 -9 23t-23 9h-320q-14 0 -23 -9t-9 -23v-192q0 -14 9 -23t23 -9h320q14 0 23 9t9 23zM1536 544v192q0 14 -9 23t-23 9h-320q-14 0 -23 -9t-9 -23v-192 q0 -14 9 -23t23 -9h320q14 0 23 9t9 23zM1536 928v192q0 14 -9 23t-23 9h-320q-14 0 -23 -9t-9 -23v-192q0 -14 9 -23t23 -9h320q14 0 23 9t9 23zM1664 1248v-1088q0 -66 -47 -113t-113 -47h-1344q-66 0 -113 47t-47 113v1088q0 66 47 113t113 47h1344q66 0 113 -47t47 -113 z" /> | ||
| 217 | <glyph unicode="" horiz-adv-x="1664" d="M1190 955l293 293l-107 107l-293 -293zM1637 1248q0 -27 -18 -45l-1286 -1286q-18 -18 -45 -18t-45 18l-198 198q-18 18 -18 45t18 45l1286 1286q18 18 45 18t45 -18l198 -198q18 -18 18 -45zM286 1438l98 -30l-98 -30l-30 -98l-30 98l-98 30l98 30l30 98zM636 1276 l196 -60l-196 -60l-60 -196l-60 196l-196 60l196 60l60 196zM1566 798l98 -30l-98 -30l-30 -98l-30 98l-98 30l98 30l30 98zM926 1438l98 -30l-98 -30l-30 -98l-30 98l-98 30l98 30l30 98z" /> | ||
| 218 | <glyph unicode="" horiz-adv-x="1792" d="M640 128q0 52 -38 90t-90 38t-90 -38t-38 -90t38 -90t90 -38t90 38t38 90zM256 640h384v256h-158q-13 0 -22 -9l-195 -195q-9 -9 -9 -22v-30zM1536 128q0 52 -38 90t-90 38t-90 -38t-38 -90t38 -90t90 -38t90 38t38 90zM1792 1216v-1024q0 -15 -4 -26.5t-13.5 -18.5 t-16.5 -11.5t-23.5 -6t-22.5 -2t-25.5 0t-22.5 0.5q0 -106 -75 -181t-181 -75t-181 75t-75 181h-384q0 -106 -75 -181t-181 -75t-181 75t-75 181h-64q-3 0 -22.5 -0.5t-25.5 0t-22.5 2t-23.5 6t-16.5 11.5t-13.5 18.5t-4 26.5q0 26 19 45t45 19v320q0 8 -0.5 35t0 38 t2.5 34.5t6.5 37t14 30.5t22.5 30l198 198q19 19 50.5 32t58.5 13h160v192q0 26 19 45t45 19h1024q26 0 45 -19t19 -45z" /> | ||
| 219 | <glyph unicode="" d="M1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103q-111 0 -218 32q59 93 78 164q9 34 54 211q20 -39 73 -67.5t114 -28.5q121 0 216 68.5t147 188.5t52 270q0 114 -59.5 214t-172.5 163t-255 63q-105 0 -196 -29t-154.5 -77t-109 -110.5t-67 -129.5t-21.5 -134 q0 -104 40 -183t117 -111q30 -12 38 20q2 7 8 31t8 30q6 23 -11 43q-51 61 -51 151q0 151 104.5 259.5t273.5 108.5q151 0 235.5 -82t84.5 -213q0 -170 -68.5 -289t-175.5 -119q-61 0 -98 43.5t-23 104.5q8 35 26.5 93.5t30 103t11.5 75.5q0 50 -27 83t-77 33 q-62 0 -105 -57t-43 -142q0 -73 25 -122l-99 -418q-17 -70 -13 -177q-206 91 -333 281t-127 423q0 209 103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 220 | <glyph unicode="" d="M1248 1408q119 0 203.5 -84.5t84.5 -203.5v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-725q85 122 108 210q9 34 53 209q21 -39 73.5 -67t112.5 -28q181 0 295.5 147.5t114.5 373.5q0 84 -35 162.5t-96.5 139t-152.5 97t-197 36.5q-104 0 -194.5 -28.5t-153 -76.5 t-107.5 -109.5t-66.5 -128t-21.5 -132.5q0 -102 39.5 -180t116.5 -110q13 -5 23.5 0t14.5 19q10 44 15 61q6 23 -11 42q-50 62 -50 150q0 150 103.5 256.5t270.5 106.5q149 0 232.5 -81t83.5 -210q0 -168 -67.5 -286t-173.5 -118q-60 0 -97 43.5t-23 103.5q8 34 26.5 92.5 t29.5 102t11 74.5q0 49 -26.5 81.5t-75.5 32.5q-61 0 -103.5 -56.5t-42.5 -139.5q0 -72 24 -121l-98 -414q-24 -100 -7 -254h-183q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960z" /> | ||
| 221 | <glyph unicode="" d="M678 -57q0 -38 -10 -71h-380q-95 0 -171.5 56.5t-103.5 147.5q24 45 69 77.5t100 49.5t107 24t107 7q32 0 49 -2q6 -4 30.5 -21t33 -23t31 -23t32 -25.5t27.5 -25.5t26.5 -29.5t21 -30.5t17.5 -34.5t9.5 -36t4.5 -40.5zM385 294q-234 -7 -385 -85v433q103 -118 273 -118 q32 0 70 5q-21 -61 -21 -86q0 -67 63 -149zM558 805q0 -100 -43.5 -160.5t-140.5 -60.5q-51 0 -97 26t-78 67.5t-56 93.5t-35.5 104t-11.5 99q0 96 51.5 165t144.5 69q66 0 119 -41t84 -104t47 -130t16 -128zM1536 896v-736q0 -119 -84.5 -203.5t-203.5 -84.5h-468 q39 73 39 157q0 66 -22 122.5t-55.5 93t-72 71t-72 59.5t-55.5 54.5t-22 59.5q0 36 23 68t56 61.5t65.5 64.5t55.5 93t23 131t-26.5 145.5t-75.5 118.5q-6 6 -14 11t-12.5 7.5t-10 9.5t-10.5 17h135l135 64h-437q-138 0 -244.5 -38.5t-182.5 -133.5q0 126 81 213t207 87h960 q119 0 203.5 -84.5t84.5 -203.5v-96h-256v256h-128v-256h-256v-128h256v-256h128v256h256z" /> | ||
| 222 | <glyph unicode="" horiz-adv-x="1664" d="M876 71q0 21 -4.5 40.5t-9.5 36t-17.5 34.5t-21 30.5t-26.5 29.5t-27.5 25.5t-32 25.5t-31 23t-33 23t-30.5 21q-17 2 -50 2q-54 0 -106 -7t-108 -25t-98 -46t-69 -75t-27 -107q0 -68 35.5 -121.5t93 -84t120.5 -45.5t127 -15q59 0 112.5 12.5t100.5 39t74.5 73.5 t27.5 110zM756 933q0 60 -16.5 127.5t-47 130.5t-84 104t-119.5 41q-93 0 -144 -69t-51 -165q0 -47 11.5 -99t35.5 -104t56 -93.5t78 -67.5t97 -26q97 0 140.5 60.5t43.5 160.5zM625 1408h437l-135 -79h-135q71 -45 110 -126t39 -169q0 -74 -23 -131.5t-56 -92.5t-66 -64.5 t-56 -61t-23 -67.5q0 -26 16.5 -51t43 -48t58.5 -48t64 -55.5t58.5 -66t43 -85t16.5 -106.5q0 -160 -140 -282q-152 -131 -420 -131q-59 0 -119.5 10t-122 33.5t-108.5 58t-77 89t-30 121.5q0 61 37 135q32 64 96 110.5t145 71t155 36t150 13.5q-64 83 -64 149q0 12 2 23.5 t5 19.5t8 21.5t7 21.5q-40 -5 -70 -5q-149 0 -255.5 98t-106.5 246q0 140 95 250.5t234 141.5q94 20 187 20zM1664 1152v-128h-256v-256h-128v256h-256v128h256v256h128v-256h256z" /> | ||
| 223 | <glyph unicode="" horiz-adv-x="1920" d="M768 384h384v96h-128v448h-114l-148 -137l77 -80q42 37 55 57h2v-288h-128v-96zM1280 640q0 -70 -21 -142t-59.5 -134t-101.5 -101t-138 -39t-138 39t-101.5 101t-59.5 134t-21 142t21 142t59.5 134t101.5 101t138 39t138 -39t101.5 -101t59.5 -134t21 -142zM1792 384 v512q-106 0 -181 75t-75 181h-1152q0 -106 -75 -181t-181 -75v-512q106 0 181 -75t75 -181h1152q0 106 75 181t181 75zM1920 1216v-1152q0 -26 -19 -45t-45 -19h-1792q-26 0 -45 19t-19 45v1152q0 26 19 45t45 19h1792q26 0 45 -19t19 -45z" /> | ||
| 224 | <glyph unicode="" horiz-adv-x="1024" d="M1024 832q0 -26 -19 -45l-448 -448q-19 -19 -45 -19t-45 19l-448 448q-19 19 -19 45t19 45t45 19h896q26 0 45 -19t19 -45z" /> | ||
| 225 | <glyph unicode="" horiz-adv-x="1024" d="M1024 320q0 -26 -19 -45t-45 -19h-896q-26 0 -45 19t-19 45t19 45l448 448q19 19 45 19t45 -19l448 -448q19 -19 19 -45z" /> | ||
| 226 | <glyph unicode="" horiz-adv-x="640" d="M640 1088v-896q0 -26 -19 -45t-45 -19t-45 19l-448 448q-19 19 -19 45t19 45l448 448q19 19 45 19t45 -19t19 -45z" /> | ||
| 227 | <glyph unicode="" horiz-adv-x="640" d="M576 640q0 -26 -19 -45l-448 -448q-19 -19 -45 -19t-45 19t-19 45v896q0 26 19 45t45 19t45 -19l448 -448q19 -19 19 -45z" /> | ||
| 228 | <glyph unicode="" horiz-adv-x="1664" d="M160 0h608v1152h-640v-1120q0 -13 9.5 -22.5t22.5 -9.5zM1536 32v1120h-640v-1152h608q13 0 22.5 9.5t9.5 22.5zM1664 1248v-1216q0 -66 -47 -113t-113 -47h-1344q-66 0 -113 47t-47 113v1216q0 66 47 113t113 47h1344q66 0 113 -47t47 -113z" /> | ||
| 229 | <glyph unicode="" horiz-adv-x="1024" d="M1024 448q0 -26 -19 -45l-448 -448q-19 -19 -45 -19t-45 19l-448 448q-19 19 -19 45t19 45t45 19h896q26 0 45 -19t19 -45zM1024 832q0 -26 -19 -45t-45 -19h-896q-26 0 -45 19t-19 45t19 45l448 448q19 19 45 19t45 -19l448 -448q19 -19 19 -45z" /> | ||
| 230 | <glyph unicode="" horiz-adv-x="1024" d="M1024 448q0 -26 -19 -45l-448 -448q-19 -19 -45 -19t-45 19l-448 448q-19 19 -19 45t19 45t45 19h896q26 0 45 -19t19 -45z" /> | ||
| 231 | <glyph unicode="" horiz-adv-x="1024" d="M1024 832q0 -26 -19 -45t-45 -19h-896q-26 0 -45 19t-19 45t19 45l448 448q19 19 45 19t45 -19l448 -448q19 -19 19 -45z" /> | ||
| 232 | <glyph unicode="" horiz-adv-x="1792" d="M1792 826v-794q0 -66 -47 -113t-113 -47h-1472q-66 0 -113 47t-47 113v794q44 -49 101 -87q362 -246 497 -345q57 -42 92.5 -65.5t94.5 -48t110 -24.5h1h1q51 0 110 24.5t94.5 48t92.5 65.5q170 123 498 345q57 39 100 87zM1792 1120q0 -79 -49 -151t-122 -123 q-376 -261 -468 -325q-10 -7 -42.5 -30.5t-54 -38t-52 -32.5t-57.5 -27t-50 -9h-1h-1q-23 0 -50 9t-57.5 27t-52 32.5t-54 38t-42.5 30.5q-91 64 -262 182.5t-205 142.5q-62 42 -117 115.5t-55 136.5q0 78 41.5 130t118.5 52h1472q65 0 112.5 -47t47.5 -113z" /> | ||
| 233 | <glyph unicode="" d="M349 911v-991h-330v991h330zM370 1217q1 -73 -50.5 -122t-135.5 -49h-2q-82 0 -132 49t-50 122q0 74 51.5 122.5t134.5 48.5t133 -48.5t51 -122.5zM1536 488v-568h-329v530q0 105 -40.5 164.5t-126.5 59.5q-63 0 -105.5 -34.5t-63.5 -85.5q-11 -30 -11 -81v-553h-329 q2 399 2 647t-1 296l-1 48h329v-144h-2q20 32 41 56t56.5 52t87 43.5t114.5 15.5q171 0 275 -113.5t104 -332.5z" /> | ||
| 234 | <glyph unicode="" d="M1536 640q0 -156 -61 -298t-164 -245t-245 -164t-298 -61q-172 0 -327 72.5t-264 204.5q-7 10 -6.5 22.5t8.5 20.5l137 138q10 9 25 9q16 -2 23 -12q73 -95 179 -147t225 -52q104 0 198.5 40.5t163.5 109.5t109.5 163.5t40.5 198.5t-40.5 198.5t-109.5 163.5 t-163.5 109.5t-198.5 40.5q-98 0 -188 -35.5t-160 -101.5l137 -138q31 -30 14 -69q-17 -40 -59 -40h-448q-26 0 -45 19t-19 45v448q0 42 40 59q39 17 69 -14l130 -129q107 101 244.5 156.5t284.5 55.5q156 0 298 -61t245 -164t164 -245t61 -298z" /> | ||
| 235 | <glyph unicode="" horiz-adv-x="1792" d="M1771 0q0 -53 -37 -90l-107 -108q-39 -37 -91 -37q-53 0 -90 37l-363 364q-38 36 -38 90q0 53 43 96l-256 256l-126 -126q-14 -14 -34 -14t-34 14q2 -2 12.5 -12t12.5 -13t10 -11.5t10 -13.5t6 -13.5t5.5 -16.5t1.5 -18q0 -38 -28 -68q-3 -3 -16.5 -18t-19 -20.5 t-18.5 -16.5t-22 -15.5t-22 -9t-26 -4.5q-40 0 -68 28l-408 408q-28 28 -28 68q0 13 4.5 26t9 22t15.5 22t16.5 18.5t20.5 19t18 16.5q30 28 68 28q10 0 18 -1.5t16.5 -5.5t13.5 -6t13.5 -10t11.5 -10t13 -12.5t12 -12.5q-14 14 -14 34t14 34l348 348q14 14 34 14t34 -14 q-2 2 -12.5 12t-12.5 13t-10 11.5t-10 13.5t-6 13.5t-5.5 16.5t-1.5 18q0 38 28 68q3 3 16.5 18t19 20.5t18.5 16.5t22 15.5t22 9t26 4.5q40 0 68 -28l408 -408q28 -28 28 -68q0 -13 -4.5 -26t-9 -22t-15.5 -22t-16.5 -18.5t-20.5 -19t-18 -16.5q-30 -28 -68 -28 q-10 0 -18 1.5t-16.5 5.5t-13.5 6t-13.5 10t-11.5 10t-13 12.5t-12 12.5q14 -14 14 -34t-14 -34l-126 -126l256 -256q43 43 96 43q52 0 91 -37l363 -363q37 -39 37 -91z" /> | ||
| 236 | <glyph unicode="" horiz-adv-x="1792" d="M384 384q0 53 -37.5 90.5t-90.5 37.5t-90.5 -37.5t-37.5 -90.5t37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM576 832q0 53 -37.5 90.5t-90.5 37.5t-90.5 -37.5t-37.5 -90.5t37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM1004 351l101 382q6 26 -7.5 48.5t-38.5 29.5 t-48 -6.5t-30 -39.5l-101 -382q-60 -5 -107 -43.5t-63 -98.5q-20 -77 20 -146t117 -89t146 20t89 117q16 60 -6 117t-72 91zM1664 384q0 53 -37.5 90.5t-90.5 37.5t-90.5 -37.5t-37.5 -90.5t37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM1024 1024q0 53 -37.5 90.5 t-90.5 37.5t-90.5 -37.5t-37.5 -90.5t37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM1472 832q0 53 -37.5 90.5t-90.5 37.5t-90.5 -37.5t-37.5 -90.5t37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM1792 384q0 -261 -141 -483q-19 -29 -54 -29h-1402q-35 0 -54 29 q-141 221 -141 483q0 182 71 348t191 286t286 191t348 71t348 -71t286 -191t191 -286t71 -348z" /> | ||
| 237 | <glyph unicode="" horiz-adv-x="1792" d="M896 1152q-204 0 -381.5 -69.5t-282 -187.5t-104.5 -255q0 -112 71.5 -213.5t201.5 -175.5l87 -50l-27 -96q-24 -91 -70 -172q152 63 275 171l43 38l57 -6q69 -8 130 -8q204 0 381.5 69.5t282 187.5t104.5 255t-104.5 255t-282 187.5t-381.5 69.5zM1792 640 q0 -174 -120 -321.5t-326 -233t-450 -85.5q-70 0 -145 8q-198 -175 -460 -242q-49 -14 -114 -22h-5q-15 0 -27 10.5t-16 27.5v1q-3 4 -0.5 12t2 10t4.5 9.5l6 9t7 8.5t8 9q7 8 31 34.5t34.5 38t31 39.5t32.5 51t27 59t26 76q-157 89 -247.5 220t-90.5 281q0 174 120 321.5 t326 233t450 85.5t450 -85.5t326 -233t120 -321.5z" /> | ||
| 238 | <glyph unicode="" horiz-adv-x="1792" d="M704 1152q-153 0 -286 -52t-211.5 -141t-78.5 -191q0 -82 53 -158t149 -132l97 -56l-35 -84q34 20 62 39l44 31l53 -10q78 -14 153 -14q153 0 286 52t211.5 141t78.5 191t-78.5 191t-211.5 141t-286 52zM704 1280q191 0 353.5 -68.5t256.5 -186.5t94 -257t-94 -257 t-256.5 -186.5t-353.5 -68.5q-86 0 -176 16q-124 -88 -278 -128q-36 -9 -86 -16h-3q-11 0 -20.5 8t-11.5 21q-1 3 -1 6.5t0.5 6.5t2 6l2.5 5t3.5 5.5t4 5t4.5 5t4 4.5q5 6 23 25t26 29.5t22.5 29t25 38.5t20.5 44q-124 72 -195 177t-71 224q0 139 94 257t256.5 186.5 t353.5 68.5zM1526 111q10 -24 20.5 -44t25 -38.5t22.5 -29t26 -29.5t23 -25q1 -1 4 -4.5t4.5 -5t4 -5t3.5 -5.5l2.5 -5t2 -6t0.5 -6.5t-1 -6.5q-3 -14 -13 -22t-22 -7q-50 7 -86 16q-154 40 -278 128q-90 -16 -176 -16q-271 0 -472 132q58 -4 88 -4q161 0 309 45t264 129 q125 92 192 212t67 254q0 77 -23 152q129 -71 204 -178t75 -230q0 -120 -71 -224.5t-195 -176.5z" /> | ||
| 239 | <glyph unicode="" horiz-adv-x="896" d="M885 970q18 -20 7 -44l-540 -1157q-13 -25 -42 -25q-4 0 -14 2q-17 5 -25.5 19t-4.5 30l197 808l-406 -101q-4 -1 -12 -1q-18 0 -31 11q-18 15 -13 39l201 825q4 14 16 23t28 9h328q19 0 32 -12.5t13 -29.5q0 -8 -5 -18l-171 -463l396 98q8 2 12 2q19 0 34 -15z" /> | ||
| 240 | <glyph unicode="" horiz-adv-x="1792" d="M1792 288v-320q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v320q0 40 28 68t68 28h96v192h-512v-192h96q40 0 68 -28t28 -68v-320q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v320q0 40 28 68t68 28h96v192h-512v-192h96q40 0 68 -28t28 -68v-320 q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v320q0 40 28 68t68 28h96v192q0 52 38 90t90 38h512v192h-96q-40 0 -68 28t-28 68v320q0 40 28 68t68 28h320q40 0 68 -28t28 -68v-320q0 -40 -28 -68t-68 -28h-96v-192h512q52 0 90 -38t38 -90v-192h96q40 0 68 -28t28 -68 z" /> | ||
| 241 | <glyph unicode="" horiz-adv-x="1664" d="M896 708v-580q0 -104 -76 -180t-180 -76t-180 76t-76 180q0 26 19 45t45 19t45 -19t19 -45q0 -50 39 -89t89 -39t89 39t39 89v580q33 11 64 11t64 -11zM1664 681q0 -13 -9.5 -22.5t-22.5 -9.5q-11 0 -23 10q-49 46 -93 69t-102 23q-68 0 -128 -37t-103 -97 q-7 -10 -17.5 -28t-14.5 -24q-11 -17 -28 -17q-18 0 -29 17q-4 6 -14.5 24t-17.5 28q-43 60 -102.5 97t-127.5 37t-127.5 -37t-102.5 -97q-7 -10 -17.5 -28t-14.5 -24q-11 -17 -29 -17q-17 0 -28 17q-4 6 -14.5 24t-17.5 28q-43 60 -103 97t-128 37q-58 0 -102 -23t-93 -69 q-12 -10 -23 -10q-13 0 -22.5 9.5t-9.5 22.5q0 5 1 7q45 183 172.5 319.5t298 204.5t360.5 68q140 0 274.5 -40t246.5 -113.5t194.5 -187t115.5 -251.5q1 -2 1 -7zM896 1408v-98q-42 2 -64 2t-64 -2v98q0 26 19 45t45 19t45 -19t19 -45z" /> | ||
| 242 | <glyph unicode="" horiz-adv-x="1792" d="M768 -128h896v640h-416q-40 0 -68 28t-28 68v416h-384v-1152zM1024 1312v64q0 13 -9.5 22.5t-22.5 9.5h-704q-13 0 -22.5 -9.5t-9.5 -22.5v-64q0 -13 9.5 -22.5t22.5 -9.5h704q13 0 22.5 9.5t9.5 22.5zM1280 640h299l-299 299v-299zM1792 512v-672q0 -40 -28 -68t-68 -28 h-960q-40 0 -68 28t-28 68v160h-544q-40 0 -68 28t-28 68v1344q0 40 28 68t68 28h1088q40 0 68 -28t28 -68v-328q21 -13 36 -28l408 -408q28 -28 48 -76t20 -88z" /> | ||
| 243 | <glyph unicode="" horiz-adv-x="1024" d="M736 960q0 -13 -9.5 -22.5t-22.5 -9.5t-22.5 9.5t-9.5 22.5q0 46 -54 71t-106 25q-13 0 -22.5 9.5t-9.5 22.5t9.5 22.5t22.5 9.5q50 0 99.5 -16t87 -54t37.5 -90zM896 960q0 72 -34.5 134t-90 101.5t-123 62t-136.5 22.5t-136.5 -22.5t-123 -62t-90 -101.5t-34.5 -134 q0 -101 68 -180q10 -11 30.5 -33t30.5 -33q128 -153 141 -298h228q13 145 141 298q10 11 30.5 33t30.5 33q68 79 68 180zM1024 960q0 -155 -103 -268q-45 -49 -74.5 -87t-59.5 -95.5t-34 -107.5q47 -28 47 -82q0 -37 -25 -64q25 -27 25 -64q0 -52 -45 -81q13 -23 13 -47 q0 -46 -31.5 -71t-77.5 -25q-20 -44 -60 -70t-87 -26t-87 26t-60 70q-46 0 -77.5 25t-31.5 71q0 24 13 47q-45 29 -45 81q0 37 25 64q-25 27 -25 64q0 54 47 82q-4 50 -34 107.5t-59.5 95.5t-74.5 87q-103 113 -103 268q0 99 44.5 184.5t117 142t164 89t186.5 32.5 t186.5 -32.5t164 -89t117 -142t44.5 -184.5z" /> | ||
| 244 | <glyph unicode="" horiz-adv-x="1792" d="M1792 352v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1376v-192q0 -13 -9.5 -22.5t-22.5 -9.5q-12 0 -24 10l-319 320q-9 9 -9 22q0 14 9 23l320 320q9 9 23 9q13 0 22.5 -9.5t9.5 -22.5v-192h1376q13 0 22.5 -9.5t9.5 -22.5zM1792 896q0 -14 -9 -23l-320 -320q-9 -9 -23 -9 q-13 0 -22.5 9.5t-9.5 22.5v192h-1376q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1376v192q0 14 9 23t23 9q12 0 24 -10l319 -319q9 -9 9 -23z" /> | ||
| 245 | <glyph unicode="" horiz-adv-x="1920" d="M1280 608q0 14 -9 23t-23 9h-224v352q0 13 -9.5 22.5t-22.5 9.5h-192q-13 0 -22.5 -9.5t-9.5 -22.5v-352h-224q-13 0 -22.5 -9.5t-9.5 -22.5q0 -14 9 -23l352 -352q9 -9 23 -9t23 9l351 351q10 12 10 24zM1920 384q0 -159 -112.5 -271.5t-271.5 -112.5h-1088 q-185 0 -316.5 131.5t-131.5 316.5q0 130 70 240t188 165q-2 30 -2 43q0 212 150 362t362 150q156 0 285.5 -87t188.5 -231q71 62 166 62q106 0 181 -75t75 -181q0 -76 -41 -138q130 -31 213.5 -135.5t83.5 -238.5z" /> | ||
| 246 | <glyph unicode="" horiz-adv-x="1920" d="M1280 672q0 14 -9 23l-352 352q-9 9 -23 9t-23 -9l-351 -351q-10 -12 -10 -24q0 -14 9 -23t23 -9h224v-352q0 -13 9.5 -22.5t22.5 -9.5h192q13 0 22.5 9.5t9.5 22.5v352h224q13 0 22.5 9.5t9.5 22.5zM1920 384q0 -159 -112.5 -271.5t-271.5 -112.5h-1088 q-185 0 -316.5 131.5t-131.5 316.5q0 130 70 240t188 165q-2 30 -2 43q0 212 150 362t362 150q156 0 285.5 -87t188.5 -231q71 62 166 62q106 0 181 -75t75 -181q0 -76 -41 -138q130 -31 213.5 -135.5t83.5 -238.5z" /> | ||
| 247 | <glyph unicode="" horiz-adv-x="1408" d="M384 192q0 -26 -19 -45t-45 -19t-45 19t-19 45t19 45t45 19t45 -19t19 -45zM1408 131q0 -121 -73 -190t-194 -69h-874q-121 0 -194 69t-73 190q0 68 5.5 131t24 138t47.5 132.5t81 103t120 60.5q-22 -52 -22 -120v-203q-58 -20 -93 -70t-35 -111q0 -80 56 -136t136 -56 t136 56t56 136q0 61 -35.5 111t-92.5 70v203q0 62 25 93q132 -104 295 -104t295 104q25 -31 25 -93v-64q-106 0 -181 -75t-75 -181v-89q-32 -29 -32 -71q0 -40 28 -68t68 -28t68 28t28 68q0 42 -32 71v89q0 52 38 90t90 38t90 -38t38 -90v-89q-32 -29 -32 -71q0 -40 28 -68 t68 -28t68 28t28 68q0 42 -32 71v89q0 68 -34.5 127.5t-93.5 93.5q0 10 0.5 42.5t0 48t-2.5 41.5t-7 47t-13 40q68 -15 120 -60.5t81 -103t47.5 -132.5t24 -138t5.5 -131zM1088 1024q0 -159 -112.5 -271.5t-271.5 -112.5t-271.5 112.5t-112.5 271.5t112.5 271.5t271.5 112.5 t271.5 -112.5t112.5 -271.5z" /> | ||
| 248 | <glyph unicode="" horiz-adv-x="1408" d="M1280 832q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1408 832q0 -62 -35.5 -111t-92.5 -70v-395q0 -159 -131.5 -271.5t-316.5 -112.5t-316.5 112.5t-131.5 271.5v132q-164 20 -274 128t-110 252v512q0 26 19 45t45 19q6 0 16 -2q17 30 47 48 t65 18q53 0 90.5 -37.5t37.5 -90.5t-37.5 -90.5t-90.5 -37.5q-33 0 -64 18v-402q0 -106 94 -181t226 -75t226 75t94 181v402q-31 -18 -64 -18q-53 0 -90.5 37.5t-37.5 90.5t37.5 90.5t90.5 37.5q35 0 65 -18t47 -48q10 2 16 2q26 0 45 -19t19 -45v-512q0 -144 -110 -252 t-274 -128v-132q0 -106 94 -181t226 -75t226 75t94 181v395q-57 21 -92.5 70t-35.5 111q0 80 56 136t136 56t136 -56t56 -136z" /> | ||
| 249 | <glyph unicode="" horiz-adv-x="1792" d="M640 1152h512v128h-512v-128zM288 1152v-1280h-64q-92 0 -158 66t-66 158v832q0 92 66 158t158 66h64zM1408 1152v-1280h-1024v1280h128v160q0 40 28 68t68 28h576q40 0 68 -28t28 -68v-160h128zM1792 928v-832q0 -92 -66 -158t-158 -66h-64v1280h64q92 0 158 -66 t66 -158z" /> | ||
| 250 | <glyph unicode="" horiz-adv-x="1664" d="M848 -160q0 16 -16 16q-59 0 -101.5 42.5t-42.5 101.5q0 16 -16 16t-16 -16q0 -73 51.5 -124.5t124.5 -51.5q16 0 16 16zM1664 128q0 -52 -38 -90t-90 -38h-448q0 -106 -75 -181t-181 -75t-181 75t-75 181h-448q-52 0 -90 38t-38 90q190 161 287 397.5t97 498.5 q0 165 96 262t264 117q-8 18 -8 37q0 40 28 68t68 28t68 -28t28 -68q0 -19 -8 -37q168 -20 264 -117t96 -262q0 -262 97 -498.5t287 -397.5z" /> | ||
| 251 | <glyph unicode="" horiz-adv-x="1920" d="M1664 896q0 80 -56 136t-136 56h-64v-384h64q80 0 136 56t56 136zM0 128h1792q0 -106 -75 -181t-181 -75h-1280q-106 0 -181 75t-75 181zM1856 896q0 -159 -112.5 -271.5t-271.5 -112.5h-64v-32q0 -92 -66 -158t-158 -66h-704q-92 0 -158 66t-66 158v736q0 26 19 45 t45 19h1152q159 0 271.5 -112.5t112.5 -271.5z" /> | ||
| 252 | <glyph unicode="" horiz-adv-x="1408" d="M640 1472v-640q0 -61 -35.5 -111t-92.5 -70v-779q0 -52 -38 -90t-90 -38h-128q-52 0 -90 38t-38 90v779q-57 20 -92.5 70t-35.5 111v640q0 26 19 45t45 19t45 -19t19 -45v-416q0 -26 19 -45t45 -19t45 19t19 45v416q0 26 19 45t45 19t45 -19t19 -45v-416q0 -26 19 -45 t45 -19t45 19t19 45v416q0 26 19 45t45 19t45 -19t19 -45zM1408 1472v-1600q0 -52 -38 -90t-90 -38h-128q-52 0 -90 38t-38 90v512h-224q-13 0 -22.5 9.5t-9.5 22.5v800q0 132 94 226t226 94h256q26 0 45 -19t19 -45z" /> | ||
| 253 | <glyph unicode="" horiz-adv-x="1280" d="M1024 352v-64q0 -14 -9 -23t-23 -9h-704q-14 0 -23 9t-9 23v64q0 14 9 23t23 9h704q14 0 23 -9t9 -23zM1024 608v-64q0 -14 -9 -23t-23 -9h-704q-14 0 -23 9t-9 23v64q0 14 9 23t23 9h704q14 0 23 -9t9 -23zM128 0h1024v768h-416q-40 0 -68 28t-28 68v416h-512v-1280z M768 896h376q-10 29 -22 41l-313 313q-12 12 -41 22v-376zM1280 864v-896q0 -40 -28 -68t-68 -28h-1088q-40 0 -68 28t-28 68v1344q0 40 28 68t68 28h640q40 0 88 -20t76 -48l312 -312q28 -28 48 -76t20 -88z" /> | ||
| 254 | <glyph unicode="" horiz-adv-x="1408" d="M384 224v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM384 480v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M640 480v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM384 736v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M1152 224v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM896 480v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M640 736v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM384 992v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M1152 480v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM896 736v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M640 992v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM384 1248v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M1152 736v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM896 992v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M640 1248v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM1152 992v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M896 1248v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM1152 1248v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M896 -128h384v1536h-1152v-1536h384v224q0 13 9.5 22.5t22.5 9.5h320q13 0 22.5 -9.5t9.5 -22.5v-224zM1408 1472v-1664q0 -26 -19 -45t-45 -19h-1280q-26 0 -45 19t-19 45v1664q0 26 19 45t45 19h1280q26 0 45 -19t19 -45z" /> | ||
| 255 | <glyph unicode="" horiz-adv-x="1408" d="M384 224v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM384 480v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M640 480v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM384 736v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M1152 224v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM896 480v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M640 736v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM1152 480v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M896 736v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM1152 736v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M896 -128h384v1152h-256v-32q0 -40 -28 -68t-68 -28h-448q-40 0 -68 28t-28 68v32h-256v-1152h384v224q0 13 9.5 22.5t22.5 9.5h320q13 0 22.5 -9.5t9.5 -22.5v-224zM896 1056v320q0 13 -9.5 22.5t-22.5 9.5h-64q-13 0 -22.5 -9.5t-9.5 -22.5v-96h-128v96q0 13 -9.5 22.5 t-22.5 9.5h-64q-13 0 -22.5 -9.5t-9.5 -22.5v-320q0 -13 9.5 -22.5t22.5 -9.5h64q13 0 22.5 9.5t9.5 22.5v96h128v-96q0 -13 9.5 -22.5t22.5 -9.5h64q13 0 22.5 9.5t9.5 22.5zM1408 1088v-1280q0 -26 -19 -45t-45 -19h-1280q-26 0 -45 19t-19 45v1280q0 26 19 45t45 19h320 v288q0 40 28 68t68 28h448q40 0 68 -28t28 -68v-288h320q26 0 45 -19t19 -45z" /> | ||
| 256 | <glyph unicode="" horiz-adv-x="1920" d="M640 128q0 53 -37.5 90.5t-90.5 37.5t-90.5 -37.5t-37.5 -90.5t37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM256 640h384v256h-158q-14 -2 -22 -9l-195 -195q-7 -12 -9 -22v-30zM1536 128q0 53 -37.5 90.5t-90.5 37.5t-90.5 -37.5t-37.5 -90.5t37.5 -90.5t90.5 -37.5 t90.5 37.5t37.5 90.5zM1664 800v192q0 14 -9 23t-23 9h-224v224q0 14 -9 23t-23 9h-192q-14 0 -23 -9t-9 -23v-224h-224q-14 0 -23 -9t-9 -23v-192q0 -14 9 -23t23 -9h224v-224q0 -14 9 -23t23 -9h192q14 0 23 9t9 23v224h224q14 0 23 9t9 23zM1920 1344v-1152 q0 -26 -19 -45t-45 -19h-192q0 -106 -75 -181t-181 -75t-181 75t-75 181h-384q0 -106 -75 -181t-181 -75t-181 75t-75 181h-128q-26 0 -45 19t-19 45t19 45t45 19v416q0 26 13 58t32 51l198 198q19 19 51 32t58 13h160v320q0 26 19 45t45 19h1152q26 0 45 -19t19 -45z" /> | ||
| 257 | <glyph unicode="" horiz-adv-x="1792" d="M1280 416v192q0 14 -9 23t-23 9h-224v224q0 14 -9 23t-23 9h-192q-14 0 -23 -9t-9 -23v-224h-224q-14 0 -23 -9t-9 -23v-192q0 -14 9 -23t23 -9h224v-224q0 -14 9 -23t23 -9h192q14 0 23 9t9 23v224h224q14 0 23 9t9 23zM640 1152h512v128h-512v-128zM256 1152v-1280h-32 q-92 0 -158 66t-66 158v832q0 92 66 158t158 66h32zM1440 1152v-1280h-1088v1280h160v160q0 40 28 68t68 28h576q40 0 68 -28t28 -68v-160h160zM1792 928v-832q0 -92 -66 -158t-158 -66h-32v1280h32q92 0 158 -66t66 -158z" /> | ||
| 258 | <glyph unicode="" horiz-adv-x="1920" d="M1920 576q-1 -32 -288 -96l-352 -32l-224 -64h-64l-293 -352h69q26 0 45 -4.5t19 -11.5t-19 -11.5t-45 -4.5h-96h-160h-64v32h64v416h-160l-192 -224h-96l-32 32v192h32v32h128v8l-192 24v128l192 24v8h-128v32h-32v192l32 32h96l192 -224h160v416h-64v32h64h160h96 q26 0 45 -4.5t19 -11.5t-19 -11.5t-45 -4.5h-69l293 -352h64l224 -64l352 -32q261 -58 287 -93z" /> | ||
| 259 | <glyph unicode="" horiz-adv-x="1664" d="M640 640v384h-256v-256q0 -53 37.5 -90.5t90.5 -37.5h128zM1664 192v-192h-1152v192l128 192h-128q-159 0 -271.5 112.5t-112.5 271.5v320l-64 64l32 128h480l32 128h960l32 -192l-64 -32v-800z" /> | ||
| 260 | <glyph unicode="" d="M1280 192v896q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-320h-512v320q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-896q0 -26 19 -45t45 -19h128q26 0 45 19t19 45v320h512v-320q0 -26 19 -45t45 -19h128q26 0 45 19t19 45zM1536 1120v-960 q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> | ||
| 261 | <glyph unicode="" d="M1280 576v128q0 26 -19 45t-45 19h-320v320q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-320h-320q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h320v-320q0 -26 19 -45t45 -19h128q26 0 45 19t19 45v320h320q26 0 45 19t19 45zM1536 1120v-960 q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> | ||
| 262 | <glyph unicode="" horiz-adv-x="1024" d="M627 160q0 -13 -10 -23l-50 -50q-10 -10 -23 -10t-23 10l-466 466q-10 10 -10 23t10 23l466 466q10 10 23 10t23 -10l50 -50q10 -10 10 -23t-10 -23l-393 -393l393 -393q10 -10 10 -23zM1011 160q0 -13 -10 -23l-50 -50q-10 -10 -23 -10t-23 10l-466 466q-10 10 -10 23 t10 23l466 466q10 10 23 10t23 -10l50 -50q10 -10 10 -23t-10 -23l-393 -393l393 -393q10 -10 10 -23z" /> | ||
| 263 | <glyph unicode="" horiz-adv-x="1024" d="M595 576q0 -13 -10 -23l-466 -466q-10 -10 -23 -10t-23 10l-50 50q-10 10 -10 23t10 23l393 393l-393 393q-10 10 -10 23t10 23l50 50q10 10 23 10t23 -10l466 -466q10 -10 10 -23zM979 576q0 -13 -10 -23l-466 -466q-10 -10 -23 -10t-23 10l-50 50q-10 10 -10 23t10 23 l393 393l-393 393q-10 10 -10 23t10 23l50 50q10 10 23 10t23 -10l466 -466q10 -10 10 -23z" /> | ||
| 264 | <glyph unicode="" horiz-adv-x="1152" d="M1075 224q0 -13 -10 -23l-50 -50q-10 -10 -23 -10t-23 10l-393 393l-393 -393q-10 -10 -23 -10t-23 10l-50 50q-10 10 -10 23t10 23l466 466q10 10 23 10t23 -10l466 -466q10 -10 10 -23zM1075 608q0 -13 -10 -23l-50 -50q-10 -10 -23 -10t-23 10l-393 393l-393 -393 q-10 -10 -23 -10t-23 10l-50 50q-10 10 -10 23t10 23l466 466q10 10 23 10t23 -10l466 -466q10 -10 10 -23z" /> | ||
| 265 | <glyph unicode="" horiz-adv-x="1152" d="M1075 672q0 -13 -10 -23l-466 -466q-10 -10 -23 -10t-23 10l-466 466q-10 10 -10 23t10 23l50 50q10 10 23 10t23 -10l393 -393l393 393q10 10 23 10t23 -10l50 -50q10 -10 10 -23zM1075 1056q0 -13 -10 -23l-466 -466q-10 -10 -23 -10t-23 10l-466 466q-10 10 -10 23 t10 23l50 50q10 10 23 10t23 -10l393 -393l393 393q10 10 23 10t23 -10l50 -50q10 -10 10 -23z" /> | ||
| 266 | <glyph unicode="" horiz-adv-x="640" d="M627 992q0 -13 -10 -23l-393 -393l393 -393q10 -10 10 -23t-10 -23l-50 -50q-10 -10 -23 -10t-23 10l-466 466q-10 10 -10 23t10 23l466 466q10 10 23 10t23 -10l50 -50q10 -10 10 -23z" /> | ||
| 267 | <glyph unicode="" horiz-adv-x="640" d="M595 576q0 -13 -10 -23l-466 -466q-10 -10 -23 -10t-23 10l-50 50q-10 10 -10 23t10 23l393 393l-393 393q-10 10 -10 23t10 23l50 50q10 10 23 10t23 -10l466 -466q10 -10 10 -23z" /> | ||
| 268 | <glyph unicode="" horiz-adv-x="1152" d="M1075 352q0 -13 -10 -23l-50 -50q-10 -10 -23 -10t-23 10l-393 393l-393 -393q-10 -10 -23 -10t-23 10l-50 50q-10 10 -10 23t10 23l466 466q10 10 23 10t23 -10l466 -466q10 -10 10 -23z" /> | ||
| 269 | <glyph unicode="" horiz-adv-x="1152" d="M1075 800q0 -13 -10 -23l-466 -466q-10 -10 -23 -10t-23 10l-466 466q-10 10 -10 23t10 23l50 50q10 10 23 10t23 -10l393 -393l393 393q10 10 23 10t23 -10l50 -50q10 -10 10 -23z" /> | ||
| 270 | <glyph unicode="" horiz-adv-x="1920" d="M1792 544v832q0 13 -9.5 22.5t-22.5 9.5h-1600q-13 0 -22.5 -9.5t-9.5 -22.5v-832q0 -13 9.5 -22.5t22.5 -9.5h1600q13 0 22.5 9.5t9.5 22.5zM1920 1376v-1088q0 -66 -47 -113t-113 -47h-544q0 -37 16 -77.5t32 -71t16 -43.5q0 -26 -19 -45t-45 -19h-512q-26 0 -45 19 t-19 45q0 14 16 44t32 70t16 78h-544q-66 0 -113 47t-47 113v1088q0 66 47 113t113 47h1600q66 0 113 -47t47 -113z" /> | ||
| 271 | <glyph unicode="" horiz-adv-x="1920" d="M416 256q-66 0 -113 47t-47 113v704q0 66 47 113t113 47h1088q66 0 113 -47t47 -113v-704q0 -66 -47 -113t-113 -47h-1088zM384 1120v-704q0 -13 9.5 -22.5t22.5 -9.5h1088q13 0 22.5 9.5t9.5 22.5v704q0 13 -9.5 22.5t-22.5 9.5h-1088q-13 0 -22.5 -9.5t-9.5 -22.5z M1760 192h160v-96q0 -40 -47 -68t-113 -28h-1600q-66 0 -113 28t-47 68v96h160h1600zM1040 96q16 0 16 16t-16 16h-160q-16 0 -16 -16t16 -16h160z" /> | ||
| 272 | <glyph unicode="" horiz-adv-x="1152" d="M640 128q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1024 288v960q0 13 -9.5 22.5t-22.5 9.5h-832q-13 0 -22.5 -9.5t-9.5 -22.5v-960q0 -13 9.5 -22.5t22.5 -9.5h832q13 0 22.5 9.5t9.5 22.5zM1152 1248v-1088q0 -66 -47 -113t-113 -47h-832 q-66 0 -113 47t-47 113v1088q0 66 47 113t113 47h832q66 0 113 -47t47 -113z" /> | ||
| 273 | <glyph unicode="" horiz-adv-x="768" d="M464 128q0 33 -23.5 56.5t-56.5 23.5t-56.5 -23.5t-23.5 -56.5t23.5 -56.5t56.5 -23.5t56.5 23.5t23.5 56.5zM672 288v704q0 13 -9.5 22.5t-22.5 9.5h-512q-13 0 -22.5 -9.5t-9.5 -22.5v-704q0 -13 9.5 -22.5t22.5 -9.5h512q13 0 22.5 9.5t9.5 22.5zM480 1136 q0 16 -16 16h-160q-16 0 -16 -16t16 -16h160q16 0 16 16zM768 1152v-1024q0 -52 -38 -90t-90 -38h-512q-52 0 -90 38t-38 90v1024q0 52 38 90t90 38h512q52 0 90 -38t38 -90z" /> | ||
| 274 | <glyph unicode="" d="M768 1184q-148 0 -273 -73t-198 -198t-73 -273t73 -273t198 -198t273 -73t273 73t198 198t73 273t-73 273t-198 198t-273 73zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103 t279.5 -279.5t103 -385.5z" /> | ||
| 275 | <glyph unicode="" horiz-adv-x="1664" d="M768 576v-384q0 -80 -56 -136t-136 -56h-384q-80 0 -136 56t-56 136v704q0 104 40.5 198.5t109.5 163.5t163.5 109.5t198.5 40.5h64q26 0 45 -19t19 -45v-128q0 -26 -19 -45t-45 -19h-64q-106 0 -181 -75t-75 -181v-32q0 -40 28 -68t68 -28h224q80 0 136 -56t56 -136z M1664 576v-384q0 -80 -56 -136t-136 -56h-384q-80 0 -136 56t-56 136v704q0 104 40.5 198.5t109.5 163.5t163.5 109.5t198.5 40.5h64q26 0 45 -19t19 -45v-128q0 -26 -19 -45t-45 -19h-64q-106 0 -181 -75t-75 -181v-32q0 -40 28 -68t68 -28h224q80 0 136 -56t56 -136z" /> | ||
| 276 | <glyph unicode="" horiz-adv-x="1664" d="M768 1216v-704q0 -104 -40.5 -198.5t-109.5 -163.5t-163.5 -109.5t-198.5 -40.5h-64q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h64q106 0 181 75t75 181v32q0 40 -28 68t-68 28h-224q-80 0 -136 56t-56 136v384q0 80 56 136t136 56h384q80 0 136 -56t56 -136zM1664 1216 v-704q0 -104 -40.5 -198.5t-109.5 -163.5t-163.5 -109.5t-198.5 -40.5h-64q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h64q106 0 181 75t75 181v32q0 40 -28 68t-68 28h-224q-80 0 -136 56t-56 136v384q0 80 56 136t136 56h384q80 0 136 -56t56 -136z" /> | ||
| 277 | <glyph unicode="" horiz-adv-x="1568" d="M496 192q0 -60 -42.5 -102t-101.5 -42q-60 0 -102 42t-42 102t42 102t102 42q59 0 101.5 -42t42.5 -102zM928 0q0 -53 -37.5 -90.5t-90.5 -37.5t-90.5 37.5t-37.5 90.5t37.5 90.5t90.5 37.5t90.5 -37.5t37.5 -90.5zM320 640q0 -66 -47 -113t-113 -47t-113 47t-47 113 t47 113t113 47t113 -47t47 -113zM1360 192q0 -46 -33 -79t-79 -33t-79 33t-33 79t33 79t79 33t79 -33t33 -79zM528 1088q0 -73 -51.5 -124.5t-124.5 -51.5t-124.5 51.5t-51.5 124.5t51.5 124.5t124.5 51.5t124.5 -51.5t51.5 -124.5zM992 1280q0 -80 -56 -136t-136 -56 t-136 56t-56 136t56 136t136 56t136 -56t56 -136zM1536 640q0 -40 -28 -68t-68 -28t-68 28t-28 68t28 68t68 28t68 -28t28 -68zM1328 1088q0 -33 -23.5 -56.5t-56.5 -23.5t-56.5 23.5t-23.5 56.5t23.5 56.5t56.5 23.5t56.5 -23.5t23.5 -56.5z" /> | ||
| 278 | <glyph unicode="" d="M1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 279 | <glyph unicode="" horiz-adv-x="1792" d="M1792 416q0 -166 -127 -451q-3 -7 -10.5 -24t-13.5 -30t-13 -22q-12 -17 -28 -17q-15 0 -23.5 10t-8.5 25q0 9 2.5 26.5t2.5 23.5q5 68 5 123q0 101 -17.5 181t-48.5 138.5t-80 101t-105.5 69.5t-133 42.5t-154 21.5t-175.5 6h-224v-256q0 -26 -19 -45t-45 -19t-45 19 l-512 512q-19 19 -19 45t19 45l512 512q19 19 45 19t45 -19t19 -45v-256h224q713 0 875 -403q53 -134 53 -333z" /> | ||
| 280 | <glyph unicode="" horiz-adv-x="1664" d="M640 320q0 -40 -12.5 -82t-43 -76t-72.5 -34t-72.5 34t-43 76t-12.5 82t12.5 82t43 76t72.5 34t72.5 -34t43 -76t12.5 -82zM1280 320q0 -40 -12.5 -82t-43 -76t-72.5 -34t-72.5 34t-43 76t-12.5 82t12.5 82t43 76t72.5 34t72.5 -34t43 -76t12.5 -82zM1440 320 q0 120 -69 204t-187 84q-41 0 -195 -21q-71 -11 -157 -11t-157 11q-152 21 -195 21q-118 0 -187 -84t-69 -204q0 -88 32 -153.5t81 -103t122 -60t140 -29.5t149 -7h168q82 0 149 7t140 29.5t122 60t81 103t32 153.5zM1664 496q0 -207 -61 -331q-38 -77 -105.5 -133t-141 -86 t-170 -47.5t-171.5 -22t-167 -4.5q-78 0 -142 3t-147.5 12.5t-152.5 30t-137 51.5t-121 81t-86 115q-62 123 -62 331q0 237 136 396q-27 82 -27 170q0 116 51 218q108 0 190 -39.5t189 -123.5q147 35 309 35q148 0 280 -32q105 82 187 121t189 39q51 -102 51 -218 q0 -87 -27 -168q136 -160 136 -398z" /> | ||
| 281 | <glyph unicode="" horiz-adv-x="1664" d="M1536 224v704q0 40 -28 68t-68 28h-704q-40 0 -68 28t-28 68v64q0 40 -28 68t-68 28h-320q-40 0 -68 -28t-28 -68v-960q0 -40 28 -68t68 -28h1216q40 0 68 28t28 68zM1664 928v-704q0 -92 -66 -158t-158 -66h-1216q-92 0 -158 66t-66 158v960q0 92 66 158t158 66h320 q92 0 158 -66t66 -158v-32h672q92 0 158 -66t66 -158z" /> | ||
| 282 | <glyph unicode="" horiz-adv-x="1920" d="M1781 605q0 35 -53 35h-1088q-40 0 -85.5 -21.5t-71.5 -52.5l-294 -363q-18 -24 -18 -40q0 -35 53 -35h1088q40 0 86 22t71 53l294 363q18 22 18 39zM640 768h768v160q0 40 -28 68t-68 28h-576q-40 0 -68 28t-28 68v64q0 40 -28 68t-68 28h-320q-40 0 -68 -28t-28 -68 v-853l256 315q44 53 116 87.5t140 34.5zM1909 605q0 -62 -46 -120l-295 -363q-43 -53 -116 -87.5t-140 -34.5h-1088q-92 0 -158 66t-66 158v960q0 92 66 158t158 66h320q92 0 158 -66t66 -158v-32h544q92 0 158 -66t66 -158v-160h192q54 0 99 -24.5t67 -70.5q15 -32 15 -68z " /> | ||
| 283 | <glyph unicode="" horiz-adv-x="1152" d="M896 608v-64q0 -14 -9 -23t-23 -9h-224v-224q0 -14 -9 -23t-23 -9h-64q-14 0 -23 9t-9 23v224h-224q-14 0 -23 9t-9 23v64q0 14 9 23t23 9h224v224q0 14 9 23t23 9h64q14 0 23 -9t9 -23v-224h224q14 0 23 -9t9 -23zM1024 224v704q0 40 -28 68t-68 28h-704q-40 0 -68 -28 t-28 -68v-704q0 -40 28 -68t68 -28h704q40 0 68 28t28 68zM1152 928v-704q0 -92 -65.5 -158t-158.5 -66h-704q-93 0 -158.5 66t-65.5 158v704q0 93 65.5 158.5t158.5 65.5h704q93 0 158.5 -65.5t65.5 -158.5z" /> | ||
| 284 | <glyph unicode="" horiz-adv-x="1152" d="M928 1152q93 0 158.5 -65.5t65.5 -158.5v-704q0 -92 -65.5 -158t-158.5 -66h-704q-93 0 -158.5 66t-65.5 158v704q0 93 65.5 158.5t158.5 65.5h704zM1024 224v704q0 40 -28 68t-68 28h-704q-40 0 -68 -28t-28 -68v-704q0 -40 28 -68t68 -28h704q40 0 68 28t28 68z M864 640q14 0 23 -9t9 -23v-64q0 -14 -9 -23t-23 -9h-576q-14 0 -23 9t-9 23v64q0 14 9 23t23 9h576z" /> | ||
| 285 | <glyph unicode="" d="M1134 461q-37 -121 -138 -195t-228 -74t-228 74t-138 195q-8 25 4 48.5t38 31.5q25 8 48.5 -4t31.5 -38q25 -80 92.5 -129.5t151.5 -49.5t151.5 49.5t92.5 129.5q8 26 32 38t49 4t37 -31.5t4 -48.5zM640 896q0 -53 -37.5 -90.5t-90.5 -37.5t-90.5 37.5t-37.5 90.5 t37.5 90.5t90.5 37.5t90.5 -37.5t37.5 -90.5zM1152 896q0 -53 -37.5 -90.5t-90.5 -37.5t-90.5 37.5t-37.5 90.5t37.5 90.5t90.5 37.5t90.5 -37.5t37.5 -90.5zM1408 640q0 130 -51 248.5t-136.5 204t-204 136.5t-248.5 51t-248.5 -51t-204 -136.5t-136.5 -204t-51 -248.5 t51 -248.5t136.5 -204t204 -136.5t248.5 -51t248.5 51t204 136.5t136.5 204t51 248.5zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 286 | <glyph unicode="" d="M1134 307q8 -25 -4 -48.5t-37 -31.5t-49 4t-32 38q-25 80 -92.5 129.5t-151.5 49.5t-151.5 -49.5t-92.5 -129.5q-8 -26 -31.5 -38t-48.5 -4q-26 8 -38 31.5t-4 48.5q37 121 138 195t228 74t228 -74t138 -195zM640 896q0 -53 -37.5 -90.5t-90.5 -37.5t-90.5 37.5 t-37.5 90.5t37.5 90.5t90.5 37.5t90.5 -37.5t37.5 -90.5zM1152 896q0 -53 -37.5 -90.5t-90.5 -37.5t-90.5 37.5t-37.5 90.5t37.5 90.5t90.5 37.5t90.5 -37.5t37.5 -90.5zM1408 640q0 130 -51 248.5t-136.5 204t-204 136.5t-248.5 51t-248.5 -51t-204 -136.5t-136.5 -204 t-51 -248.5t51 -248.5t136.5 -204t204 -136.5t248.5 -51t248.5 51t204 136.5t136.5 204t51 248.5zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 287 | <glyph unicode="" d="M1152 448q0 -26 -19 -45t-45 -19h-640q-26 0 -45 19t-19 45t19 45t45 19h640q26 0 45 -19t19 -45zM640 896q0 -53 -37.5 -90.5t-90.5 -37.5t-90.5 37.5t-37.5 90.5t37.5 90.5t90.5 37.5t90.5 -37.5t37.5 -90.5zM1152 896q0 -53 -37.5 -90.5t-90.5 -37.5t-90.5 37.5 t-37.5 90.5t37.5 90.5t90.5 37.5t90.5 -37.5t37.5 -90.5zM1408 640q0 130 -51 248.5t-136.5 204t-204 136.5t-248.5 51t-248.5 -51t-204 -136.5t-136.5 -204t-51 -248.5t51 -248.5t136.5 -204t204 -136.5t248.5 -51t248.5 51t204 136.5t136.5 204t51 248.5zM1536 640 q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 288 | <glyph unicode="" horiz-adv-x="1920" d="M832 448v128q0 14 -9 23t-23 9h-192v192q0 14 -9 23t-23 9h-128q-14 0 -23 -9t-9 -23v-192h-192q-14 0 -23 -9t-9 -23v-128q0 -14 9 -23t23 -9h192v-192q0 -14 9 -23t23 -9h128q14 0 23 9t9 23v192h192q14 0 23 9t9 23zM1408 384q0 53 -37.5 90.5t-90.5 37.5t-90.5 -37.5 t-37.5 -90.5t37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM1664 640q0 53 -37.5 90.5t-90.5 37.5t-90.5 -37.5t-37.5 -90.5t37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM1920 512q0 -212 -150 -362t-362 -150q-192 0 -338 128h-220q-146 -128 -338 -128q-212 0 -362 150 t-150 362t150 362t362 150h896q212 0 362 -150t150 -362z" /> | ||
| 289 | <glyph unicode="" horiz-adv-x="1920" d="M384 368v-96q0 -16 -16 -16h-96q-16 0 -16 16v96q0 16 16 16h96q16 0 16 -16zM512 624v-96q0 -16 -16 -16h-224q-16 0 -16 16v96q0 16 16 16h224q16 0 16 -16zM384 880v-96q0 -16 -16 -16h-96q-16 0 -16 16v96q0 16 16 16h96q16 0 16 -16zM1408 368v-96q0 -16 -16 -16 h-864q-16 0 -16 16v96q0 16 16 16h864q16 0 16 -16zM768 624v-96q0 -16 -16 -16h-96q-16 0 -16 16v96q0 16 16 16h96q16 0 16 -16zM640 880v-96q0 -16 -16 -16h-96q-16 0 -16 16v96q0 16 16 16h96q16 0 16 -16zM1024 624v-96q0 -16 -16 -16h-96q-16 0 -16 16v96q0 16 16 16 h96q16 0 16 -16zM896 880v-96q0 -16 -16 -16h-96q-16 0 -16 16v96q0 16 16 16h96q16 0 16 -16zM1280 624v-96q0 -16 -16 -16h-96q-16 0 -16 16v96q0 16 16 16h96q16 0 16 -16zM1664 368v-96q0 -16 -16 -16h-96q-16 0 -16 16v96q0 16 16 16h96q16 0 16 -16zM1152 880v-96 q0 -16 -16 -16h-96q-16 0 -16 16v96q0 16 16 16h96q16 0 16 -16zM1408 880v-96q0 -16 -16 -16h-96q-16 0 -16 16v96q0 16 16 16h96q16 0 16 -16zM1664 880v-352q0 -16 -16 -16h-224q-16 0 -16 16v96q0 16 16 16h112v240q0 16 16 16h96q16 0 16 -16zM1792 128v896h-1664v-896 h1664zM1920 1024v-896q0 -53 -37.5 -90.5t-90.5 -37.5h-1664q-53 0 -90.5 37.5t-37.5 90.5v896q0 53 37.5 90.5t90.5 37.5h1664q53 0 90.5 -37.5t37.5 -90.5z" /> | ||
| 290 | <glyph unicode="" horiz-adv-x="1792" d="M1664 491v616q-169 -91 -306 -91q-82 0 -145 32q-100 49 -184 76.5t-178 27.5q-173 0 -403 -127v-599q245 113 433 113q55 0 103.5 -7.5t98 -26t77 -31t82.5 -39.5l28 -14q44 -22 101 -22q120 0 293 92zM320 1280q0 -35 -17.5 -64t-46.5 -46v-1266q0 -14 -9 -23t-23 -9 h-64q-14 0 -23 9t-9 23v1266q-29 17 -46.5 46t-17.5 64q0 53 37.5 90.5t90.5 37.5t90.5 -37.5t37.5 -90.5zM1792 1216v-763q0 -39 -35 -57q-10 -5 -17 -9q-218 -116 -369 -116q-88 0 -158 35l-28 14q-64 33 -99 48t-91 29t-114 14q-102 0 -235.5 -44t-228.5 -102 q-15 -9 -33 -9q-16 0 -32 8q-32 19 -32 56v742q0 35 31 55q35 21 78.5 42.5t114 52t152.5 49.5t155 19q112 0 209 -31t209 -86q38 -19 89 -19q122 0 310 112q22 12 31 17q31 16 62 -2q31 -20 31 -55z" /> | ||
| 291 | <glyph unicode="" horiz-adv-x="1792" d="M832 536v192q-181 -16 -384 -117v-185q205 96 384 110zM832 954v197q-172 -8 -384 -126v-189q215 111 384 118zM1664 491v184q-235 -116 -384 -71v224q-20 6 -39 15q-5 3 -33 17t-34.5 17t-31.5 15t-34.5 15.5t-32.5 13t-36 12.5t-35 8.5t-39.5 7.5t-39.5 4t-44 2 q-23 0 -49 -3v-222h19q102 0 192.5 -29t197.5 -82q19 -9 39 -15v-188q42 -17 91 -17q120 0 293 92zM1664 918v189q-169 -91 -306 -91q-45 0 -78 8v-196q148 -42 384 90zM320 1280q0 -35 -17.5 -64t-46.5 -46v-1266q0 -14 -9 -23t-23 -9h-64q-14 0 -23 9t-9 23v1266 q-29 17 -46.5 46t-17.5 64q0 53 37.5 90.5t90.5 37.5t90.5 -37.5t37.5 -90.5zM1792 1216v-763q0 -39 -35 -57q-10 -5 -17 -9q-218 -116 -369 -116q-88 0 -158 35l-28 14q-64 33 -99 48t-91 29t-114 14q-102 0 -235.5 -44t-228.5 -102q-15 -9 -33 -9q-16 0 -32 8 q-32 19 -32 56v742q0 35 31 55q35 21 78.5 42.5t114 52t152.5 49.5t155 19q112 0 209 -31t209 -86q38 -19 89 -19q122 0 310 112q22 12 31 17q31 16 62 -2q31 -20 31 -55z" /> | ||
| 292 | <glyph unicode="" horiz-adv-x="1664" d="M585 553l-466 -466q-10 -10 -23 -10t-23 10l-50 50q-10 10 -10 23t10 23l393 393l-393 393q-10 10 -10 23t10 23l50 50q10 10 23 10t23 -10l466 -466q10 -10 10 -23t-10 -23zM1664 96v-64q0 -14 -9 -23t-23 -9h-960q-14 0 -23 9t-9 23v64q0 14 9 23t23 9h960q14 0 23 -9 t9 -23z" /> | ||
| 293 | <glyph unicode="" horiz-adv-x="1920" d="M617 137l-50 -50q-10 -10 -23 -10t-23 10l-466 466q-10 10 -10 23t10 23l466 466q10 10 23 10t23 -10l50 -50q10 -10 10 -23t-10 -23l-393 -393l393 -393q10 -10 10 -23t-10 -23zM1208 1204l-373 -1291q-4 -13 -15.5 -19.5t-23.5 -2.5l-62 17q-13 4 -19.5 15.5t-2.5 24.5 l373 1291q4 13 15.5 19.5t23.5 2.5l62 -17q13 -4 19.5 -15.5t2.5 -24.5zM1865 553l-466 -466q-10 -10 -23 -10t-23 10l-50 50q-10 10 -10 23t10 23l393 393l-393 393q-10 10 -10 23t10 23l50 50q10 10 23 10t23 -10l466 -466q10 -10 10 -23t-10 -23z" /> | ||
| 294 | <glyph unicode="" horiz-adv-x="1792" d="M640 454v-70q0 -42 -39 -59q-13 -5 -25 -5q-27 0 -45 19l-512 512q-19 19 -19 45t19 45l512 512q29 31 70 14q39 -17 39 -59v-69l-397 -398q-19 -19 -19 -45t19 -45zM1792 416q0 -58 -17 -133.5t-38.5 -138t-48 -125t-40.5 -90.5l-20 -40q-8 -17 -28 -17q-6 0 -9 1 q-25 8 -23 34q43 400 -106 565q-64 71 -170.5 110.5t-267.5 52.5v-251q0 -42 -39 -59q-13 -5 -25 -5q-27 0 -45 19l-512 512q-19 19 -19 45t19 45l512 512q29 31 70 14q39 -17 39 -59v-262q411 -28 599 -221q169 -173 169 -509z" /> | ||
| 295 | <glyph unicode="" horiz-adv-x="1664" d="M1186 579l257 250l-356 52l-66 10l-30 60l-159 322v-963l59 -31l318 -168l-60 355l-12 66zM1638 841l-363 -354l86 -500q5 -33 -6 -51.5t-34 -18.5q-17 0 -40 12l-449 236l-449 -236q-23 -12 -40 -12q-23 0 -34 18.5t-6 51.5l86 500l-364 354q-32 32 -23 59.5t54 34.5 l502 73l225 455q20 41 49 41q28 0 49 -41l225 -455l502 -73q45 -7 54 -34.5t-24 -59.5z" /> | ||
| 296 | <glyph unicode="" horiz-adv-x="1408" d="M1401 1187l-640 -1280q-17 -35 -57 -35q-5 0 -15 2q-22 5 -35.5 22.5t-13.5 39.5v576h-576q-22 0 -39.5 13.5t-22.5 35.5t4 42t29 30l1280 640q13 7 29 7q27 0 45 -19q15 -14 18.5 -34.5t-6.5 -39.5z" /> | ||
| 297 | <glyph unicode="" horiz-adv-x="1664" d="M557 256h595v595zM512 301l595 595h-595v-595zM1664 224v-192q0 -14 -9 -23t-23 -9h-224v-224q0 -14 -9 -23t-23 -9h-192q-14 0 -23 9t-9 23v224h-864q-14 0 -23 9t-9 23v864h-224q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h224v224q0 14 9 23t23 9h192q14 0 23 -9t9 -23 v-224h851l246 247q10 9 23 9t23 -9q9 -10 9 -23t-9 -23l-247 -246v-851h224q14 0 23 -9t9 -23z" /> | ||
| 298 | <glyph unicode="" horiz-adv-x="1024" d="M288 64q0 40 -28 68t-68 28t-68 -28t-28 -68t28 -68t68 -28t68 28t28 68zM288 1216q0 40 -28 68t-68 28t-68 -28t-28 -68t28 -68t68 -28t68 28t28 68zM928 1088q0 40 -28 68t-68 28t-68 -28t-28 -68t28 -68t68 -28t68 28t28 68zM1024 1088q0 -52 -26 -96.5t-70 -69.5 q-2 -287 -226 -414q-68 -38 -203 -81q-128 -40 -169.5 -71t-41.5 -100v-26q44 -25 70 -69.5t26 -96.5q0 -80 -56 -136t-136 -56t-136 56t-56 136q0 52 26 96.5t70 69.5v820q-44 25 -70 69.5t-26 96.5q0 80 56 136t136 56t136 -56t56 -136q0 -52 -26 -96.5t-70 -69.5v-497 q54 26 154 57q55 17 87.5 29.5t70.5 31t59 39.5t40.5 51t28 69.5t8.5 91.5q-44 25 -70 69.5t-26 96.5q0 80 56 136t136 56t136 -56t56 -136z" /> | ||
| 299 | <glyph unicode="" horiz-adv-x="1664" d="M439 265l-256 -256q-10 -9 -23 -9q-12 0 -23 9q-9 10 -9 23t9 23l256 256q10 9 23 9t23 -9q9 -10 9 -23t-9 -23zM608 224v-320q0 -14 -9 -23t-23 -9t-23 9t-9 23v320q0 14 9 23t23 9t23 -9t9 -23zM384 448q0 -14 -9 -23t-23 -9h-320q-14 0 -23 9t-9 23t9 23t23 9h320 q14 0 23 -9t9 -23zM1648 320q0 -120 -85 -203l-147 -146q-83 -83 -203 -83q-121 0 -204 85l-334 335q-21 21 -42 56l239 18l273 -274q27 -27 68 -27.5t68 26.5l147 146q28 28 28 67q0 40 -28 68l-274 275l18 239q35 -21 56 -42l336 -336q84 -86 84 -204zM1031 1044l-239 -18 l-273 274q-28 28 -68 28q-39 0 -68 -27l-147 -146q-28 -28 -28 -67q0 -40 28 -68l274 -274l-18 -240q-35 21 -56 42l-336 336q-84 86 -84 204q0 120 85 203l147 146q83 83 203 83q121 0 204 -85l334 -335q21 -21 42 -56zM1664 960q0 -14 -9 -23t-23 -9h-320q-14 0 -23 9 t-9 23t9 23t23 9h320q14 0 23 -9t9 -23zM1120 1504v-320q0 -14 -9 -23t-23 -9t-23 9t-9 23v320q0 14 9 23t23 9t23 -9t9 -23zM1527 1353l-256 -256q-11 -9 -23 -9t-23 9q-9 10 -9 23t9 23l256 256q10 9 23 9t23 -9q9 -10 9 -23t-9 -23z" /> | ||
| 300 | <glyph unicode="" horiz-adv-x="1024" d="M704 280v-240q0 -16 -12 -28t-28 -12h-240q-16 0 -28 12t-12 28v240q0 16 12 28t28 12h240q16 0 28 -12t12 -28zM1020 880q0 -54 -15.5 -101t-35 -76.5t-55 -59.5t-57.5 -43.5t-61 -35.5q-41 -23 -68.5 -65t-27.5 -67q0 -17 -12 -32.5t-28 -15.5h-240q-15 0 -25.5 18.5 t-10.5 37.5v45q0 83 65 156.5t143 108.5q59 27 84 56t25 76q0 42 -46.5 74t-107.5 32q-65 0 -108 -29q-35 -25 -107 -115q-13 -16 -31 -16q-12 0 -25 8l-164 125q-13 10 -15.5 25t5.5 28q160 266 464 266q80 0 161 -31t146 -83t106 -127.5t41 -158.5z" /> | ||
| 301 | <glyph unicode="" horiz-adv-x="640" d="M640 192v-128q0 -26 -19 -45t-45 -19h-512q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h64v384h-64q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h384q26 0 45 -19t19 -45v-576h64q26 0 45 -19t19 -45zM512 1344v-192q0 -26 -19 -45t-45 -19h-256q-26 0 -45 19t-19 45v192 q0 26 19 45t45 19h256q26 0 45 -19t19 -45z" /> | ||
| 302 | <glyph unicode="" horiz-adv-x="640" d="M512 288v-224q0 -26 -19 -45t-45 -19h-256q-26 0 -45 19t-19 45v224q0 26 19 45t45 19h256q26 0 45 -19t19 -45zM542 1344l-28 -768q-1 -26 -20.5 -45t-45.5 -19h-256q-26 0 -45.5 19t-20.5 45l-28 768q-1 26 17.5 45t44.5 19h320q26 0 44.5 -19t17.5 -45z" /> | ||
| 303 | <glyph unicode="" d="M897 167v-167h-248l-159 252l-24 42q-8 9 -11 21h-3l-9 -21q-10 -20 -25 -44l-155 -250h-258v167h128l197 291l-185 272h-137v168h276l139 -228q2 -4 23 -42q8 -9 11 -21h3q3 9 11 21l25 42l140 228h257v-168h-125l-184 -267l204 -296h109zM1534 846v-206h-514l-3 27 q-4 28 -4 46q0 64 26 117t65 86.5t84 65t84 54.5t65 54t26 64q0 38 -29.5 62.5t-70.5 24.5q-51 0 -97 -39q-14 -11 -36 -38l-105 92q26 37 63 66q83 65 188 65q110 0 178 -59.5t68 -158.5q0 -56 -24.5 -103t-62 -76.5t-81.5 -58.5t-82 -50.5t-65.5 -51.5t-30.5 -63h232v80 h126z" /> | ||
| 304 | <glyph unicode="" d="M897 167v-167h-248l-159 252l-24 42q-8 9 -11 21h-3l-9 -21q-10 -20 -25 -44l-155 -250h-258v167h128l197 291l-185 272h-137v168h276l139 -228q2 -4 23 -42q8 -9 11 -21h3q3 9 11 21l25 42l140 228h257v-168h-125l-184 -267l204 -296h109zM1536 -50v-206h-514l-4 27 q-3 45 -3 46q0 64 26 117t65 86.5t84 65t84 54.5t65 54t26 64q0 38 -29.5 62.5t-70.5 24.5q-51 0 -97 -39q-14 -11 -36 -38l-105 92q26 37 63 66q80 65 188 65q110 0 178 -59.5t68 -158.5q0 -66 -34.5 -118.5t-84 -86t-99.5 -62.5t-87 -63t-41 -73h232v80h126z" /> | ||
| 305 | <glyph unicode="" horiz-adv-x="1920" d="M896 128l336 384h-768l-336 -384h768zM1909 1205q15 -34 9.5 -71.5t-30.5 -65.5l-896 -1024q-38 -44 -96 -44h-768q-38 0 -69.5 20.5t-47.5 54.5q-15 34 -9.5 71.5t30.5 65.5l896 1024q38 44 96 44h768q38 0 69.5 -20.5t47.5 -54.5z" /> | ||
| 306 | <glyph unicode="" horiz-adv-x="1664" d="M1664 438q0 -81 -44.5 -135t-123.5 -54q-41 0 -77.5 17.5t-59 38t-56.5 38t-71 17.5q-110 0 -110 -124q0 -39 16 -115t15 -115v-5q-22 0 -33 -1q-34 -3 -97.5 -11.5t-115.5 -13.5t-98 -5q-61 0 -103 26.5t-42 83.5q0 37 17.5 71t38 56.5t38 59t17.5 77.5q0 79 -54 123.5 t-135 44.5q-84 0 -143 -45.5t-59 -127.5q0 -43 15 -83t33.5 -64.5t33.5 -53t15 -50.5q0 -45 -46 -89q-37 -35 -117 -35q-95 0 -245 24q-9 2 -27.5 4t-27.5 4l-13 2q-1 0 -3 1q-2 0 -2 1v1024q2 -1 17.5 -3.5t34 -5t21.5 -3.5q150 -24 245 -24q80 0 117 35q46 44 46 89 q0 22 -15 50.5t-33.5 53t-33.5 64.5t-15 83q0 82 59 127.5t144 45.5q80 0 134 -44.5t54 -123.5q0 -41 -17.5 -77.5t-38 -59t-38 -56.5t-17.5 -71q0 -57 42 -83.5t103 -26.5q64 0 180 15t163 17v-2q-1 -2 -3.5 -17.5t-5 -34t-3.5 -21.5q-24 -150 -24 -245q0 -80 35 -117 q44 -46 89 -46q22 0 50.5 15t53 33.5t64.5 33.5t83 15q82 0 127.5 -59t45.5 -143z" /> | ||
| 307 | <glyph unicode="" horiz-adv-x="1152" d="M1152 832v-128q0 -221 -147.5 -384.5t-364.5 -187.5v-132h256q26 0 45 -19t19 -45t-19 -45t-45 -19h-640q-26 0 -45 19t-19 45t19 45t45 19h256v132q-217 24 -364.5 187.5t-147.5 384.5v128q0 26 19 45t45 19t45 -19t19 -45v-128q0 -185 131.5 -316.5t316.5 -131.5 t316.5 131.5t131.5 316.5v128q0 26 19 45t45 19t45 -19t19 -45zM896 1216v-512q0 -132 -94 -226t-226 -94t-226 94t-94 226v512q0 132 94 226t226 94t226 -94t94 -226z" /> | ||
| 308 | <glyph unicode="" horiz-adv-x="1408" d="M271 591l-101 -101q-42 103 -42 214v128q0 26 19 45t45 19t45 -19t19 -45v-128q0 -53 15 -113zM1385 1193l-361 -361v-128q0 -132 -94 -226t-226 -94q-55 0 -109 19l-96 -96q97 -51 205 -51q185 0 316.5 131.5t131.5 316.5v128q0 26 19 45t45 19t45 -19t19 -45v-128 q0 -221 -147.5 -384.5t-364.5 -187.5v-132h256q26 0 45 -19t19 -45t-19 -45t-45 -19h-640q-26 0 -45 19t-19 45t19 45t45 19h256v132q-125 13 -235 81l-254 -254q-10 -10 -23 -10t-23 10l-82 82q-10 10 -10 23t10 23l1234 1234q10 10 23 10t23 -10l82 -82q10 -10 10 -23 t-10 -23zM1005 1325l-621 -621v512q0 132 94 226t226 94q102 0 184.5 -59t116.5 -152z" /> | ||
| 309 | <glyph unicode="" horiz-adv-x="1280" d="M1088 576v640h-448v-1137q119 63 213 137q235 184 235 360zM1280 1344v-768q0 -86 -33.5 -170.5t-83 -150t-118 -127.5t-126.5 -103t-121 -77.5t-89.5 -49.5t-42.5 -20q-12 -6 -26 -6t-26 6q-16 7 -42.5 20t-89.5 49.5t-121 77.5t-126.5 103t-118 127.5t-83 150 t-33.5 170.5v768q0 26 19 45t45 19h1152q26 0 45 -19t19 -45z" /> | ||
| 310 | <glyph unicode="" horiz-adv-x="1664" d="M128 -128h1408v1024h-1408v-1024zM512 1088v288q0 14 -9 23t-23 9h-64q-14 0 -23 -9t-9 -23v-288q0 -14 9 -23t23 -9h64q14 0 23 9t9 23zM1280 1088v288q0 14 -9 23t-23 9h-64q-14 0 -23 -9t-9 -23v-288q0 -14 9 -23t23 -9h64q14 0 23 9t9 23zM1664 1152v-1280 q0 -52 -38 -90t-90 -38h-1408q-52 0 -90 38t-38 90v1280q0 52 38 90t90 38h128v96q0 66 47 113t113 47h64q66 0 113 -47t47 -113v-96h384v96q0 66 47 113t113 47h64q66 0 113 -47t47 -113v-96h128q52 0 90 -38t38 -90z" /> | ||
| 311 | <glyph unicode="" horiz-adv-x="1408" d="M512 1344q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1408 1376v-320q0 -16 -12 -25q-8 -7 -20 -7q-4 0 -7 1l-448 96q-11 2 -18 11t-7 20h-256v-102q111 -23 183.5 -111t72.5 -203v-800q0 -26 -19 -45t-45 -19h-512q-26 0 -45 19t-19 45v800 q0 106 62.5 190.5t161.5 114.5v111h-32q-59 0 -115 -23.5t-91.5 -53t-66 -66.5t-40.5 -53.5t-14 -24.5q-17 -35 -57 -35q-16 0 -29 7q-23 12 -31.5 37t3.5 49q5 10 14.5 26t37.5 53.5t60.5 70t85 67t108.5 52.5q-25 42 -25 86q0 66 47 113t113 47t113 -47t47 -113 q0 -33 -14 -64h302q0 11 7 20t18 11l448 96q3 1 7 1q12 0 20 -7q12 -9 12 -25z" /> | ||
| 312 | <glyph unicode="" horiz-adv-x="1664" d="M1440 1088q0 40 -28 68t-68 28t-68 -28t-28 -68t28 -68t68 -28t68 28t28 68zM1664 1376q0 -249 -75.5 -430.5t-253.5 -360.5q-81 -80 -195 -176l-20 -379q-2 -16 -16 -26l-384 -224q-7 -4 -16 -4q-12 0 -23 9l-64 64q-13 14 -8 32l85 276l-281 281l-276 -85q-3 -1 -9 -1 q-14 0 -23 9l-64 64q-17 19 -5 39l224 384q10 14 26 16l379 20q96 114 176 195q188 187 358 258t431 71q14 0 24 -9.5t10 -22.5z" /> | ||
| 313 | <glyph unicode="" horiz-adv-x="1792" d="M1708 881l-188 -881h-304l181 849q4 21 1 43q-4 20 -16 35q-10 14 -28 24q-18 9 -40 9h-197l-205 -960h-303l204 960h-304l-205 -960h-304l272 1280h1139q157 0 245 -118q86 -116 52 -281z" /> | ||
| 314 | <glyph unicode="" d="M909 141l102 102q19 19 19 45t-19 45l-307 307l307 307q19 19 19 45t-19 45l-102 102q-19 19 -45 19t-45 -19l-454 -454q-19 -19 -19 -45t19 -45l454 -454q19 -19 45 -19t45 19zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5 t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 315 | <glyph unicode="" d="M717 141l454 454q19 19 19 45t-19 45l-454 454q-19 19 -45 19t-45 -19l-102 -102q-19 -19 -19 -45t19 -45l307 -307l-307 -307q-19 -19 -19 -45t19 -45l102 -102q19 -19 45 -19t45 19zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5 t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 316 | <glyph unicode="" d="M1165 397l102 102q19 19 19 45t-19 45l-454 454q-19 19 -45 19t-45 -19l-454 -454q-19 -19 -19 -45t19 -45l102 -102q19 -19 45 -19t45 19l307 307l307 -307q19 -19 45 -19t45 19zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5 t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 317 | <glyph unicode="" d="M813 237l454 454q19 19 19 45t-19 45l-102 102q-19 19 -45 19t-45 -19l-307 -307l-307 307q-19 19 -45 19t-45 -19l-102 -102q-19 -19 -19 -45t19 -45l454 -454q19 -19 45 -19t45 19zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5 t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 318 | <glyph unicode="" horiz-adv-x="1408" d="M1130 939l16 175h-884l47 -534h612l-22 -228l-197 -53l-196 53l-13 140h-175l22 -278l362 -100h4v1l359 99l50 544h-644l-15 181h674zM0 1408h1408l-128 -1438l-578 -162l-574 162z" /> | ||
| 319 | <glyph unicode="" horiz-adv-x="1792" d="M275 1408h1505l-266 -1333l-804 -267l-698 267l71 356h297l-29 -147l422 -161l486 161l68 339h-1208l58 297h1209l38 191h-1208z" /> | ||
| 320 | <glyph unicode="" horiz-adv-x="1792" d="M960 1280q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1792 352v-352q0 -22 -20 -30q-8 -2 -12 -2q-13 0 -23 9l-93 93q-119 -143 -318.5 -226.5t-429.5 -83.5t-429.5 83.5t-318.5 226.5l-93 -93q-9 -9 -23 -9q-4 0 -12 2q-20 8 -20 30v352 q0 14 9 23t23 9h352q22 0 30 -20q8 -19 -7 -35l-100 -100q67 -91 189.5 -153.5t271.5 -82.5v647h-192q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h192v163q-58 34 -93 92.5t-35 128.5q0 106 75 181t181 75t181 -75t75 -181q0 -70 -35 -128.5t-93 -92.5v-163h192q26 0 45 -19 t19 -45v-128q0 -26 -19 -45t-45 -19h-192v-647q149 20 271.5 82.5t189.5 153.5l-100 100q-15 16 -7 35q8 20 30 20h352q14 0 23 -9t9 -23z" /> | ||
| 321 | <glyph unicode="" horiz-adv-x="1152" d="M1056 768q40 0 68 -28t28 -68v-576q0 -40 -28 -68t-68 -28h-960q-40 0 -68 28t-28 68v576q0 40 28 68t68 28h32v320q0 185 131.5 316.5t316.5 131.5t316.5 -131.5t131.5 -316.5q0 -26 -19 -45t-45 -19h-64q-26 0 -45 19t-19 45q0 106 -75 181t-181 75t-181 -75t-75 -181 v-320h736z" /> | ||
| 322 | <glyph unicode="" d="M1024 640q0 -106 -75 -181t-181 -75t-181 75t-75 181t75 181t181 75t181 -75t75 -181zM1152 640q0 159 -112.5 271.5t-271.5 112.5t-271.5 -112.5t-112.5 -271.5t112.5 -271.5t271.5 -112.5t271.5 112.5t112.5 271.5zM1280 640q0 -212 -150 -362t-362 -150t-362 150 t-150 362t150 362t362 150t362 -150t150 -362zM1408 640q0 130 -51 248.5t-136.5 204t-204 136.5t-248.5 51t-248.5 -51t-204 -136.5t-136.5 -204t-51 -248.5t51 -248.5t136.5 -204t204 -136.5t248.5 -51t248.5 51t204 136.5t136.5 204t51 248.5zM1536 640 q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 323 | <glyph unicode="" horiz-adv-x="1408" d="M384 800v-192q0 -40 -28 -68t-68 -28h-192q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h192q40 0 68 -28t28 -68zM896 800v-192q0 -40 -28 -68t-68 -28h-192q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h192q40 0 68 -28t28 -68zM1408 800v-192q0 -40 -28 -68t-68 -28h-192 q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h192q40 0 68 -28t28 -68z" /> | ||
| 324 | <glyph unicode="" horiz-adv-x="384" d="M384 288v-192q0 -40 -28 -68t-68 -28h-192q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h192q40 0 68 -28t28 -68zM384 800v-192q0 -40 -28 -68t-68 -28h-192q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h192q40 0 68 -28t28 -68zM384 1312v-192q0 -40 -28 -68t-68 -28h-192 q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h192q40 0 68 -28t28 -68z" /> | ||
| 325 | <glyph unicode="" d="M512 256q0 53 -37.5 90.5t-90.5 37.5t-90.5 -37.5t-37.5 -90.5t37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM863 162q-13 232 -177 396t-396 177q-14 1 -24 -9t-10 -23v-128q0 -13 8.5 -22t21.5 -10q154 -11 264 -121t121 -264q1 -13 10 -21.5t22 -8.5h128q13 0 23 10 t9 24zM1247 161q-5 154 -56 297.5t-139.5 260t-205 205t-260 139.5t-297.5 56q-14 1 -23 -9q-10 -10 -10 -23v-128q0 -13 9 -22t22 -10q204 -7 378 -111.5t278.5 -278.5t111.5 -378q1 -13 10 -22t22 -9h128q13 0 23 10q11 9 9 23zM1536 1120v-960q0 -119 -84.5 -203.5 t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> | ||
| 326 | <glyph unicode="" d="M768 1408q209 0 385.5 -103t279.5 -279.5t103 -385.5t-103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103zM1152 585q32 18 32 55t-32 55l-544 320q-31 19 -64 1q-32 -19 -32 -56v-640q0 -37 32 -56 q16 -8 32 -8q17 0 32 9z" /> | ||
| 327 | <glyph unicode="" horiz-adv-x="1792" d="M1024 1084l316 -316l-572 -572l-316 316zM813 105l618 618q19 19 19 45t-19 45l-362 362q-18 18 -45 18t-45 -18l-618 -618q-19 -19 -19 -45t19 -45l362 -362q18 -18 45 -18t45 18zM1702 742l-907 -908q-37 -37 -90.5 -37t-90.5 37l-126 126q56 56 56 136t-56 136 t-136 56t-136 -56l-125 126q-37 37 -37 90.5t37 90.5l907 906q37 37 90.5 37t90.5 -37l125 -125q-56 -56 -56 -136t56 -136t136 -56t136 56l126 -125q37 -37 37 -90.5t-37 -90.5z" /> | ||
| 328 | <glyph unicode="" d="M1280 576v128q0 26 -19 45t-45 19h-896q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h896q26 0 45 19t19 45zM1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5 t84.5 -203.5z" /> | ||
| 329 | <glyph unicode="" horiz-adv-x="1408" d="M1152 736v-64q0 -14 -9 -23t-23 -9h-832q-14 0 -23 9t-9 23v64q0 14 9 23t23 9h832q14 0 23 -9t9 -23zM1280 288v832q0 66 -47 113t-113 47h-832q-66 0 -113 -47t-47 -113v-832q0 -66 47 -113t113 -47h832q66 0 113 47t47 113zM1408 1120v-832q0 -119 -84.5 -203.5 t-203.5 -84.5h-832q-119 0 -203.5 84.5t-84.5 203.5v832q0 119 84.5 203.5t203.5 84.5h832q119 0 203.5 -84.5t84.5 -203.5z" /> | ||
| 330 | <glyph unicode="" horiz-adv-x="1024" d="M1018 933q-18 -37 -58 -37h-192v-864q0 -14 -9 -23t-23 -9h-704q-21 0 -29 18q-8 20 4 35l160 192q9 11 25 11h320v640h-192q-40 0 -58 37q-17 37 9 68l320 384q18 22 49 22t49 -22l320 -384q27 -32 9 -68z" /> | ||
| 331 | <glyph unicode="" horiz-adv-x="1024" d="M32 1280h704q13 0 22.5 -9.5t9.5 -23.5v-863h192q40 0 58 -37t-9 -69l-320 -384q-18 -22 -49 -22t-49 22l-320 384q-26 31 -9 69q18 37 58 37h192v640h-320q-14 0 -25 11l-160 192q-13 14 -4 34q9 19 29 19z" /> | ||
| 332 | <glyph unicode="" d="M685 237l614 614q19 19 19 45t-19 45l-102 102q-19 19 -45 19t-45 -19l-467 -467l-211 211q-19 19 -45 19t-45 -19l-102 -102q-19 -19 -19 -45t19 -45l358 -358q19 -19 45 -19t45 19zM1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5 t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> | ||
| 333 | <glyph unicode="" d="M404 428l152 -152l-52 -52h-56v96h-96v56zM818 818q14 -13 -3 -30l-291 -291q-17 -17 -30 -3q-14 13 3 30l291 291q17 17 30 3zM544 128l544 544l-288 288l-544 -544v-288h288zM1152 736l92 92q28 28 28 68t-28 68l-152 152q-28 28 -68 28t-68 -28l-92 -92zM1536 1120 v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> | ||
| 334 | <glyph unicode="" d="M1280 608v480q0 26 -19 45t-45 19h-480q-42 0 -59 -39q-17 -41 14 -70l144 -144l-534 -534q-19 -19 -19 -45t19 -45l102 -102q19 -19 45 -19t45 19l534 534l144 -144q18 -19 45 -19q12 0 25 5q39 17 39 59zM1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960 q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> | ||
| 335 | <glyph unicode="" d="M1005 435l352 352q19 19 19 45t-19 45l-352 352q-30 31 -69 14q-40 -17 -40 -59v-160q-119 0 -216 -19.5t-162.5 -51t-114 -79t-76.5 -95.5t-44.5 -109t-21.5 -111.5t-5 -110.5q0 -181 167 -404q10 -12 25 -12q7 0 13 3q22 9 19 33q-44 354 62 473q46 52 130 75.5 t224 23.5v-160q0 -42 40 -59q12 -5 24 -5q26 0 45 19zM1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> | ||
| 336 | <glyph unicode="" d="M640 448l256 128l-256 128v-256zM1024 1039v-542l-512 -256v542zM1312 640q0 148 -73 273t-198 198t-273 73t-273 -73t-198 -198t-73 -273t73 -273t198 -198t273 -73t273 73t198 198t73 273zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103 t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 337 | <glyph unicode="" d="M1145 861q18 -35 -5 -66l-320 -448q-19 -27 -52 -27t-52 27l-320 448q-23 31 -5 66q17 35 57 35h640q40 0 57 -35zM1280 160v960q0 13 -9.5 22.5t-22.5 9.5h-960q-13 0 -22.5 -9.5t-9.5 -22.5v-960q0 -13 9.5 -22.5t22.5 -9.5h960q13 0 22.5 9.5t9.5 22.5zM1536 1120 v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> | ||
| 338 | <glyph unicode="" d="M1145 419q-17 -35 -57 -35h-640q-40 0 -57 35q-18 35 5 66l320 448q19 27 52 27t52 -27l320 -448q23 -31 5 -66zM1280 160v960q0 13 -9.5 22.5t-22.5 9.5h-960q-13 0 -22.5 -9.5t-9.5 -22.5v-960q0 -13 9.5 -22.5t22.5 -9.5h960q13 0 22.5 9.5t9.5 22.5zM1536 1120v-960 q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> | ||
| 339 | <glyph unicode="" d="M1088 640q0 -33 -27 -52l-448 -320q-31 -23 -66 -5q-35 17 -35 57v640q0 40 35 57q35 18 66 -5l448 -320q27 -19 27 -52zM1280 160v960q0 14 -9 23t-23 9h-960q-14 0 -23 -9t-9 -23v-960q0 -14 9 -23t23 -9h960q14 0 23 9t9 23zM1536 1120v-960q0 -119 -84.5 -203.5 t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> | ||
| 340 | <glyph unicode="" horiz-adv-x="1024" d="M976 229l35 -159q3 -12 -3 -22.5t-17 -14.5l-5 -1q-4 -2 -10.5 -3.5t-16 -4.5t-21.5 -5.5t-25.5 -5t-30 -5t-33.5 -4.5t-36.5 -3t-38.5 -1q-234 0 -409 130.5t-238 351.5h-95q-13 0 -22.5 9.5t-9.5 22.5v113q0 13 9.5 22.5t22.5 9.5h66q-2 57 1 105h-67q-14 0 -23 9 t-9 23v114q0 14 9 23t23 9h98q67 210 243.5 338t400.5 128q102 0 194 -23q11 -3 20 -15q6 -11 3 -24l-43 -159q-3 -13 -14 -19.5t-24 -2.5l-4 1q-4 1 -11.5 2.5l-17.5 3.5t-22.5 3.5t-26 3t-29 2.5t-29.5 1q-126 0 -226 -64t-150 -176h468q16 0 25 -12q10 -12 7 -26 l-24 -114q-5 -26 -32 -26h-488q-3 -37 0 -105h459q15 0 25 -12q9 -12 6 -27l-24 -112q-2 -11 -11 -18.5t-20 -7.5h-387q48 -117 149.5 -185.5t228.5 -68.5q18 0 36 1.5t33.5 3.5t29.5 4.5t24.5 5t18.5 4.5l12 3l5 2q13 5 26 -2q12 -7 15 -21z" /> | ||
| 341 | <glyph unicode="" horiz-adv-x="1024" d="M1020 399v-367q0 -14 -9 -23t-23 -9h-956q-14 0 -23 9t-9 23v150q0 13 9.5 22.5t22.5 9.5h97v383h-95q-14 0 -23 9.5t-9 22.5v131q0 14 9 23t23 9h95v223q0 171 123.5 282t314.5 111q185 0 335 -125q9 -8 10 -20.5t-7 -22.5l-103 -127q-9 -11 -22 -12q-13 -2 -23 7 q-5 5 -26 19t-69 32t-93 18q-85 0 -137 -47t-52 -123v-215h305q13 0 22.5 -9t9.5 -23v-131q0 -13 -9.5 -22.5t-22.5 -9.5h-305v-379h414v181q0 13 9 22.5t23 9.5h162q14 0 23 -9.5t9 -22.5z" /> | ||
| 342 | <glyph unicode="" horiz-adv-x="1024" d="M978 351q0 -153 -99.5 -263.5t-258.5 -136.5v-175q0 -14 -9 -23t-23 -9h-135q-13 0 -22.5 9.5t-9.5 22.5v175q-66 9 -127.5 31t-101.5 44.5t-74 48t-46.5 37.5t-17.5 18q-17 21 -2 41l103 135q7 10 23 12q15 2 24 -9l2 -2q113 -99 243 -125q37 -8 74 -8q81 0 142.5 43 t61.5 122q0 28 -15 53t-33.5 42t-58.5 37.5t-66 32t-80 32.5q-39 16 -61.5 25t-61.5 26.5t-62.5 31t-56.5 35.5t-53.5 42.5t-43.5 49t-35.5 58t-21 66.5t-8.5 78q0 138 98 242t255 134v180q0 13 9.5 22.5t22.5 9.5h135q14 0 23 -9t9 -23v-176q57 -6 110.5 -23t87 -33.5 t63.5 -37.5t39 -29t15 -14q17 -18 5 -38l-81 -146q-8 -15 -23 -16q-14 -3 -27 7q-3 3 -14.5 12t-39 26.5t-58.5 32t-74.5 26t-85.5 11.5q-95 0 -155 -43t-60 -111q0 -26 8.5 -48t29.5 -41.5t39.5 -33t56 -31t60.5 -27t70 -27.5q53 -20 81 -31.5t76 -35t75.5 -42.5t62 -50 t53 -63.5t31.5 -76.5t13 -94z" /> | ||
| 343 | <glyph unicode="" horiz-adv-x="898" d="M898 1066v-102q0 -14 -9 -23t-23 -9h-168q-23 -144 -129 -234t-276 -110q167 -178 459 -536q14 -16 4 -34q-8 -18 -29 -18h-195q-16 0 -25 12q-306 367 -498 571q-9 9 -9 22v127q0 13 9.5 22.5t22.5 9.5h112q132 0 212.5 43t102.5 125h-427q-14 0 -23 9t-9 23v102 q0 14 9 23t23 9h413q-57 113 -268 113h-145q-13 0 -22.5 9.5t-9.5 22.5v133q0 14 9 23t23 9h832q14 0 23 -9t9 -23v-102q0 -14 -9 -23t-23 -9h-233q47 -61 64 -144h171q14 0 23 -9t9 -23z" /> | ||
| 344 | <glyph unicode="" horiz-adv-x="1027" d="M603 0h-172q-13 0 -22.5 9t-9.5 23v330h-288q-13 0 -22.5 9t-9.5 23v103q0 13 9.5 22.5t22.5 9.5h288v85h-288q-13 0 -22.5 9t-9.5 23v104q0 13 9.5 22.5t22.5 9.5h214l-321 578q-8 16 0 32q10 16 28 16h194q19 0 29 -18l215 -425q19 -38 56 -125q10 24 30.5 68t27.5 61 l191 420q8 19 29 19h191q17 0 27 -16q9 -14 1 -31l-313 -579h215q13 0 22.5 -9.5t9.5 -22.5v-104q0 -14 -9.5 -23t-22.5 -9h-290v-85h290q13 0 22.5 -9.5t9.5 -22.5v-103q0 -14 -9.5 -23t-22.5 -9h-290v-330q0 -13 -9.5 -22.5t-22.5 -9.5z" /> | ||
| 345 | <glyph unicode="" horiz-adv-x="1664" d="M1664 352v-32q0 -132 -94 -226t-226 -94h-128q-132 0 -226 94t-94 226v480h-224q-2 -102 -14.5 -190.5t-30.5 -156t-48.5 -126.5t-57 -99.5t-67.5 -77.5t-69.5 -58.5t-74 -44t-69 -32t-65.5 -25.5q-4 -2 -32 -13q-8 -2 -12 -2q-22 0 -30 20l-71 178q-5 13 0 25t17 17 q7 3 20 7.5t18 6.5q31 12 46.5 18.5t44.5 20t45.5 26t42 32.5t40.5 42.5t34.5 53.5t30.5 68.5t22.5 83.5t17 103t6.5 123h-256q-14 0 -23 9t-9 23v160q0 14 9 23t23 9h1216q14 0 23 -9t9 -23v-160q0 -14 -9 -23t-23 -9h-224v-512q0 -26 19 -45t45 -19h128q26 0 45 19t19 45 v64q0 14 9 23t23 9h192q14 0 23 -9t9 -23zM1280 1376v-160q0 -14 -9 -23t-23 -9h-960q-14 0 -23 9t-9 23v160q0 14 9 23t23 9h960q14 0 23 -9t9 -23z" /> | ||
| 346 | <glyph unicode="" horiz-adv-x="1792" d="M514 341l81 299h-159l75 -300q1 -1 1 -3t1 -3q0 1 0.5 3.5t0.5 3.5zM630 768l35 128h-292l32 -128h225zM822 768h139l-35 128h-70zM1271 340l78 300h-162l81 -299q0 -1 0.5 -3.5t1.5 -3.5q0 1 0.5 3t0.5 3zM1382 768l33 128h-297l34 -128h230zM1792 736v-64q0 -14 -9 -23 t-23 -9h-213l-164 -616q-7 -24 -31 -24h-159q-24 0 -31 24l-166 616h-209l-167 -616q-7 -24 -31 -24h-159q-11 0 -19.5 7t-10.5 17l-160 616h-208q-14 0 -23 9t-9 23v64q0 14 9 23t23 9h175l-33 128h-142q-14 0 -23 9t-9 23v64q0 14 9 23t23 9h109l-89 344q-5 15 5 28 q10 12 26 12h137q26 0 31 -24l90 -360h359l97 360q7 24 31 24h126q24 0 31 -24l98 -360h365l93 360q5 24 31 24h137q16 0 26 -12q10 -13 5 -28l-91 -344h111q14 0 23 -9t9 -23v-64q0 -14 -9 -23t-23 -9h-145l-34 -128h179q14 0 23 -9t9 -23z" /> | ||
| 347 | <glyph unicode="" horiz-adv-x="1280" d="M1167 896q18 -182 -131 -258q117 -28 175 -103t45 -214q-7 -71 -32.5 -125t-64.5 -89t-97 -58.5t-121.5 -34.5t-145.5 -15v-255h-154v251q-80 0 -122 1v-252h-154v255q-18 0 -54 0.5t-55 0.5h-200l31 183h111q50 0 58 51v402h16q-6 1 -16 1v287q-13 68 -89 68h-111v164 l212 -1q64 0 97 1v252h154v-247q82 2 122 2v245h154v-252q79 -7 140 -22.5t113 -45t82.5 -78t36.5 -114.5zM952 351q0 36 -15 64t-37 46t-57.5 30.5t-65.5 18.5t-74 9t-69 3t-64.5 -1t-47.5 -1v-338q8 0 37 -0.5t48 -0.5t53 1.5t58.5 4t57 8.5t55.5 14t47.5 21t39.5 30 t24.5 40t9.5 51zM881 827q0 33 -12.5 58.5t-30.5 42t-48 28t-55 16.5t-61.5 8t-58 2.5t-54 -1t-39.5 -0.5v-307q5 0 34.5 -0.5t46.5 0t50 2t55 5.5t51.5 11t48.5 18.5t37 27t27 38.5t9 51z" /> | ||
| 348 | <glyph unicode="" horiz-adv-x="1280" d="M1280 768v-800q0 -40 -28 -68t-68 -28h-1088q-40 0 -68 28t-28 68v1344q0 40 28 68t68 28h544v-544q0 -40 28 -68t68 -28h544zM1277 896h-509v509q82 -15 132 -65l312 -312q50 -50 65 -132z" /> | ||
| 349 | <glyph unicode="" horiz-adv-x="1280" d="M1024 160v64q0 14 -9 23t-23 9h-704q-14 0 -23 -9t-9 -23v-64q0 -14 9 -23t23 -9h704q14 0 23 9t9 23zM1024 416v64q0 14 -9 23t-23 9h-704q-14 0 -23 -9t-9 -23v-64q0 -14 9 -23t23 -9h704q14 0 23 9t9 23zM1280 768v-800q0 -40 -28 -68t-68 -28h-1088q-40 0 -68 28 t-28 68v1344q0 40 28 68t68 28h544v-544q0 -40 28 -68t68 -28h544zM1277 896h-509v509q82 -15 132 -65l312 -312q50 -50 65 -132z" /> | ||
| 350 | <glyph unicode="" horiz-adv-x="1664" d="M1191 1128h177l-72 218l-12 47q-2 16 -2 20h-4l-3 -20q0 -1 -3.5 -18t-7.5 -29zM736 96q0 -12 -10 -24l-319 -319q-10 -9 -23 -9q-12 0 -23 9l-320 320q-15 16 -7 35q8 20 30 20h192v1376q0 14 9 23t23 9h192q14 0 23 -9t9 -23v-1376h192q14 0 23 -9t9 -23zM1572 -23 v-233h-584v90l369 529q12 18 21 27l11 9v3q-2 0 -6.5 -0.5t-7.5 -0.5q-12 -3 -30 -3h-232v-115h-120v229h567v-89l-369 -530q-6 -8 -21 -26l-11 -11v-2l14 2q9 2 30 2h248v119h121zM1661 874v-106h-288v106h75l-47 144h-243l-47 -144h75v-106h-287v106h70l230 662h162 l230 -662h70z" /> | ||
| 351 | <glyph unicode="" horiz-adv-x="1664" d="M1191 104h177l-72 218l-12 47q-2 16 -2 20h-4l-3 -20q0 -1 -3.5 -18t-7.5 -29zM736 96q0 -12 -10 -24l-319 -319q-10 -9 -23 -9q-12 0 -23 9l-320 320q-15 16 -7 35q8 20 30 20h192v1376q0 14 9 23t23 9h192q14 0 23 -9t9 -23v-1376h192q14 0 23 -9t9 -23zM1661 -150 v-106h-288v106h75l-47 144h-243l-47 -144h75v-106h-287v106h70l230 662h162l230 -662h70zM1572 1001v-233h-584v90l369 529q12 18 21 27l11 9v3q-2 0 -6.5 -0.5t-7.5 -0.5q-12 -3 -30 -3h-232v-115h-120v229h567v-89l-369 -530q-6 -8 -21 -26l-11 -10v-3l14 3q9 1 30 1h248 v119h121z" /> | ||
| 352 | <glyph unicode="" horiz-adv-x="1792" d="M736 96q0 -12 -10 -24l-319 -319q-10 -9 -23 -9q-12 0 -23 9l-320 320q-15 16 -7 35q8 20 30 20h192v1376q0 14 9 23t23 9h192q14 0 23 -9t9 -23v-1376h192q14 0 23 -9t9 -23zM1792 -32v-192q0 -14 -9 -23t-23 -9h-832q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h832 q14 0 23 -9t9 -23zM1600 480v-192q0 -14 -9 -23t-23 -9h-640q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h640q14 0 23 -9t9 -23zM1408 992v-192q0 -14 -9 -23t-23 -9h-448q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h448q14 0 23 -9t9 -23zM1216 1504v-192q0 -14 -9 -23t-23 -9h-256 q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h256q14 0 23 -9t9 -23z" /> | ||
| 353 | <glyph unicode="" horiz-adv-x="1792" d="M1216 -32v-192q0 -14 -9 -23t-23 -9h-256q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h256q14 0 23 -9t9 -23zM736 96q0 -12 -10 -24l-319 -319q-10 -9 -23 -9q-12 0 -23 9l-320 320q-15 16 -7 35q8 20 30 20h192v1376q0 14 9 23t23 9h192q14 0 23 -9t9 -23v-1376h192 q14 0 23 -9t9 -23zM1408 480v-192q0 -14 -9 -23t-23 -9h-448q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h448q14 0 23 -9t9 -23zM1600 992v-192q0 -14 -9 -23t-23 -9h-640q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h640q14 0 23 -9t9 -23zM1792 1504v-192q0 -14 -9 -23t-23 -9h-832 q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h832q14 0 23 -9t9 -23z" /> | ||
| 354 | <glyph unicode="" d="M1346 223q0 63 -44 116t-103 53q-52 0 -83 -37t-31 -94t36.5 -95t104.5 -38q50 0 85 27t35 68zM736 96q0 -12 -10 -24l-319 -319q-10 -9 -23 -9q-12 0 -23 9l-320 320q-15 16 -7 35q8 20 30 20h192v1376q0 14 9 23t23 9h192q14 0 23 -9t9 -23v-1376h192q14 0 23 -9t9 -23 zM1486 165q0 -62 -13 -121.5t-41 -114t-68 -95.5t-98.5 -65.5t-127.5 -24.5q-62 0 -108 16q-24 8 -42 15l39 113q15 -7 31 -11q37 -13 75 -13q84 0 134.5 58.5t66.5 145.5h-2q-21 -23 -61.5 -37t-84.5 -14q-106 0 -173 71.5t-67 172.5q0 105 72 178t181 73q123 0 205 -94.5 t82 -252.5zM1456 882v-114h-469v114h167v432q0 7 0.5 19t0.5 17v16h-2l-7 -12q-8 -13 -26 -31l-62 -58l-82 86l192 185h123v-654h165z" /> | ||
| 355 | <glyph unicode="" d="M1346 1247q0 63 -44 116t-103 53q-52 0 -83 -37t-31 -94t36.5 -95t104.5 -38q50 0 85 27t35 68zM736 96q0 -12 -10 -24l-319 -319q-10 -9 -23 -9q-12 0 -23 9l-320 320q-15 16 -7 35q8 20 30 20h192v1376q0 14 9 23t23 9h192q14 0 23 -9t9 -23v-1376h192q14 0 23 -9 t9 -23zM1456 -142v-114h-469v114h167v432q0 7 0.5 19t0.5 17v16h-2l-7 -12q-8 -13 -26 -31l-62 -58l-82 86l192 185h123v-654h165zM1486 1189q0 -62 -13 -121.5t-41 -114t-68 -95.5t-98.5 -65.5t-127.5 -24.5q-62 0 -108 16q-24 8 -42 15l39 113q15 -7 31 -11q37 -13 75 -13 q84 0 134.5 58.5t66.5 145.5h-2q-21 -23 -61.5 -37t-84.5 -14q-106 0 -173 71.5t-67 172.5q0 105 72 178t181 73q123 0 205 -94.5t82 -252.5z" /> | ||
| 356 | <glyph unicode="" horiz-adv-x="1664" d="M256 192q0 26 -19 45t-45 19q-27 0 -45.5 -19t-18.5 -45q0 -27 18.5 -45.5t45.5 -18.5q26 0 45 18.5t19 45.5zM416 704v-640q0 -26 -19 -45t-45 -19h-288q-26 0 -45 19t-19 45v640q0 26 19 45t45 19h288q26 0 45 -19t19 -45zM1600 704q0 -86 -55 -149q15 -44 15 -76 q3 -76 -43 -137q17 -56 0 -117q-15 -57 -54 -94q9 -112 -49 -181q-64 -76 -197 -78h-36h-76h-17q-66 0 -144 15.5t-121.5 29t-120.5 39.5q-123 43 -158 44q-26 1 -45 19.5t-19 44.5v641q0 25 18 43.5t43 20.5q24 2 76 59t101 121q68 87 101 120q18 18 31 48t17.5 48.5 t13.5 60.5q7 39 12.5 61t19.5 52t34 50q19 19 45 19q46 0 82.5 -10.5t60 -26t40 -40.5t24 -45t12 -50t5 -45t0.5 -39q0 -38 -9.5 -76t-19 -60t-27.5 -56q-3 -6 -10 -18t-11 -22t-8 -24h277q78 0 135 -57t57 -135z" /> | ||
| 357 | <glyph unicode="" horiz-adv-x="1664" d="M256 960q0 -26 -19 -45t-45 -19q-27 0 -45.5 19t-18.5 45q0 27 18.5 45.5t45.5 18.5q26 0 45 -18.5t19 -45.5zM416 448v640q0 26 -19 45t-45 19h-288q-26 0 -45 -19t-19 -45v-640q0 -26 19 -45t45 -19h288q26 0 45 19t19 45zM1545 597q55 -61 55 -149q-1 -78 -57.5 -135 t-134.5 -57h-277q4 -14 8 -24t11 -22t10 -18q18 -37 27 -57t19 -58.5t10 -76.5q0 -24 -0.5 -39t-5 -45t-12 -50t-24 -45t-40 -40.5t-60 -26t-82.5 -10.5q-26 0 -45 19q-20 20 -34 50t-19.5 52t-12.5 61q-9 42 -13.5 60.5t-17.5 48.5t-31 48q-33 33 -101 120q-49 64 -101 121 t-76 59q-25 2 -43 20.5t-18 43.5v641q0 26 19 44.5t45 19.5q35 1 158 44q77 26 120.5 39.5t121.5 29t144 15.5h17h76h36q133 -2 197 -78q58 -69 49 -181q39 -37 54 -94q17 -61 0 -117q46 -61 43 -137q0 -32 -15 -76z" /> | ||
| 358 | <glyph unicode="" d="M919 233v157q0 50 -29 50q-17 0 -33 -16v-224q16 -16 33 -16q29 0 29 49zM1103 355h66v34q0 51 -33 51t-33 -51v-34zM532 621v-70h-80v-423h-74v423h-78v70h232zM733 495v-367h-67v40q-39 -45 -76 -45q-33 0 -42 28q-6 16 -6 54v290h66v-270q0 -24 1 -26q1 -15 15 -15 q20 0 42 31v280h67zM985 384v-146q0 -52 -7 -73q-12 -42 -53 -42q-35 0 -68 41v-36h-67v493h67v-161q32 40 68 40q41 0 53 -42q7 -21 7 -74zM1236 255v-9q0 -29 -2 -43q-3 -22 -15 -40q-27 -40 -80 -40q-52 0 -81 38q-21 27 -21 86v129q0 59 20 86q29 38 80 38t78 -38 q21 -28 21 -86v-76h-133v-65q0 -51 34 -51q24 0 30 26q0 1 0.5 7t0.5 16.5v21.5h68zM785 1079v-156q0 -51 -32 -51t-32 51v156q0 52 32 52t32 -52zM1318 366q0 177 -19 260q-10 44 -43 73.5t-76 34.5q-136 15 -412 15q-275 0 -411 -15q-44 -5 -76.5 -34.5t-42.5 -73.5 q-20 -87 -20 -260q0 -176 20 -260q10 -43 42.5 -73t75.5 -35q137 -15 412 -15t412 15q43 5 75.5 35t42.5 73q20 84 20 260zM563 1017l90 296h-75l-51 -195l-53 195h-78l24 -69t23 -69q35 -103 46 -158v-201h74v201zM852 936v130q0 58 -21 87q-29 38 -78 38q-51 0 -78 -38 q-21 -29 -21 -87v-130q0 -58 21 -87q27 -38 78 -38q49 0 78 38q21 27 21 87zM1033 816h67v370h-67v-283q-22 -31 -42 -31q-15 0 -16 16q-1 2 -1 26v272h-67v-293q0 -37 6 -55q11 -27 43 -27q36 0 77 45v-40zM1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960 q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> | ||
| 359 | <glyph unicode="" d="M971 292v-211q0 -67 -39 -67q-23 0 -45 22v301q22 22 45 22q39 0 39 -67zM1309 291v-46h-90v46q0 68 45 68t45 -68zM343 509h107v94h-312v-94h105v-569h100v569zM631 -60h89v494h-89v-378q-30 -42 -57 -42q-18 0 -21 21q-1 3 -1 35v364h-89v-391q0 -49 8 -73 q12 -37 58 -37q48 0 102 61v-54zM1060 88v197q0 73 -9 99q-17 56 -71 56q-50 0 -93 -54v217h-89v-663h89v48q45 -55 93 -55q54 0 71 55q9 27 9 100zM1398 98v13h-91q0 -51 -2 -61q-7 -36 -40 -36q-46 0 -46 69v87h179v103q0 79 -27 116q-39 51 -106 51q-68 0 -107 -51 q-28 -37 -28 -116v-173q0 -79 29 -116q39 -51 108 -51q72 0 108 53q18 27 21 54q2 9 2 58zM790 1011v210q0 69 -43 69t-43 -69v-210q0 -70 43 -70t43 70zM1509 260q0 -234 -26 -350q-14 -59 -58 -99t-102 -46q-184 -21 -555 -21t-555 21q-58 6 -102.5 46t-57.5 99 q-26 112 -26 350q0 234 26 350q14 59 58 99t103 47q183 20 554 20t555 -20q58 -7 102.5 -47t57.5 -99q26 -112 26 -350zM511 1536h102l-121 -399v-271h-100v271q-14 74 -61 212q-37 103 -65 187h106l71 -263zM881 1203v-175q0 -81 -28 -118q-37 -51 -106 -51q-67 0 -105 51 q-28 38 -28 118v175q0 80 28 117q38 51 105 51q69 0 106 -51q28 -37 28 -117zM1216 1365v-499h-91v55q-53 -62 -103 -62q-46 0 -59 37q-8 24 -8 75v394h91v-367q0 -33 1 -35q3 -22 21 -22q27 0 57 43v381h91z" /> | ||
| 360 | <glyph unicode="" horiz-adv-x="1408" d="M597 869q-10 -18 -257 -456q-27 -46 -65 -46h-239q-21 0 -31 17t0 36l253 448q1 0 0 1l-161 279q-12 22 -1 37q9 15 32 15h239q40 0 66 -45zM1403 1511q11 -16 0 -37l-528 -934v-1l336 -615q11 -20 1 -37q-10 -15 -32 -15h-239q-42 0 -66 45l-339 622q18 32 531 942 q25 45 64 45h241q22 0 31 -15z" /> | ||
| 361 | <glyph unicode="" d="M685 771q0 1 -126 222q-21 34 -52 34h-184q-18 0 -26 -11q-7 -12 1 -29l125 -216v-1l-196 -346q-9 -14 0 -28q8 -13 24 -13h185q31 0 50 36zM1309 1268q-7 12 -24 12h-187q-30 0 -49 -35l-411 -729q1 -2 262 -481q20 -35 52 -35h184q18 0 25 12q8 13 -1 28l-260 476v1 l409 723q8 16 0 28zM1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> | ||
| 362 | <glyph unicode="" horiz-adv-x="1792" d="M1280 640q0 37 -30 54l-512 320q-31 20 -65 2q-33 -18 -33 -56v-640q0 -38 33 -56q16 -8 31 -8q20 0 34 10l512 320q30 17 30 54zM1792 640q0 -96 -1 -150t-8.5 -136.5t-22.5 -147.5q-16 -73 -69 -123t-124 -58q-222 -25 -671 -25t-671 25q-71 8 -124.5 58t-69.5 123 q-14 65 -21.5 147.5t-8.5 136.5t-1 150t1 150t8.5 136.5t22.5 147.5q16 73 69 123t124 58q222 25 671 25t671 -25q71 -8 124.5 -58t69.5 -123q14 -65 21.5 -147.5t8.5 -136.5t1 -150z" /> | ||
| 363 | <glyph unicode="" horiz-adv-x="1792" d="M402 829l494 -305l-342 -285l-490 319zM1388 274v-108l-490 -293v-1l-1 1l-1 -1v1l-489 293v108l147 -96l342 284v2l1 -1l1 1v-2l343 -284zM554 1418l342 -285l-494 -304l-338 270zM1390 829l338 -271l-489 -319l-343 285zM1239 1418l489 -319l-338 -270l-494 304z" /> | ||
| 364 | <glyph unicode="" horiz-adv-x="1408" d="M928 135v-151l-707 -1v151zM1169 481v-701l-1 -35v-1h-1132l-35 1h-1v736h121v-618h928v618h120zM241 393l704 -65l-13 -150l-705 65zM309 709l683 -183l-39 -146l-683 183zM472 1058l609 -360l-77 -130l-609 360zM832 1389l398 -585l-124 -85l-399 584zM1285 1536 l121 -697l-149 -26l-121 697z" /> | ||
| 365 | <glyph unicode="" d="M1362 110v648h-135q20 -63 20 -131q0 -126 -64 -232.5t-174 -168.5t-240 -62q-197 0 -337 135.5t-140 327.5q0 68 20 131h-141v-648q0 -26 17.5 -43.5t43.5 -17.5h1069q25 0 43 17.5t18 43.5zM1078 643q0 124 -90.5 211.5t-218.5 87.5q-127 0 -217.5 -87.5t-90.5 -211.5 t90.5 -211.5t217.5 -87.5q128 0 218.5 87.5t90.5 211.5zM1362 1003v165q0 28 -20 48.5t-49 20.5h-174q-29 0 -49 -20.5t-20 -48.5v-165q0 -29 20 -49t49 -20h174q29 0 49 20t20 49zM1536 1211v-1142q0 -81 -58 -139t-139 -58h-1142q-81 0 -139 58t-58 139v1142q0 81 58 139 t139 58h1142q81 0 139 -58t58 -139z" /> | ||
| 366 | <glyph unicode="" d="M1248 1408q119 0 203.5 -84.5t84.5 -203.5v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960zM698 640q0 88 -62 150t-150 62t-150 -62t-62 -150t62 -150t150 -62t150 62t62 150zM1262 640q0 88 -62 150 t-150 62t-150 -62t-62 -150t62 -150t150 -62t150 62t62 150z" /> | ||
| 367 | <glyph unicode="" d="M768 914l201 -306h-402zM1133 384h94l-459 691l-459 -691h94l104 160h522zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 368 | <glyph unicode="" horiz-adv-x="1408" d="M815 677q8 -63 -50.5 -101t-111.5 -6q-39 17 -53.5 58t-0.5 82t52 58q36 18 72.5 12t64 -35.5t27.5 -67.5zM926 698q-14 107 -113 164t-197 13q-63 -28 -100.5 -88.5t-34.5 -129.5q4 -91 77.5 -155t165.5 -56q91 8 152 84t50 168zM1165 1240q-20 27 -56 44.5t-58 22 t-71 12.5q-291 47 -566 -2q-43 -7 -66 -12t-55 -22t-50 -43q30 -28 76 -45.5t73.5 -22t87.5 -11.5q228 -29 448 -1q63 8 89.5 12t72.5 21.5t75 46.5zM1222 205q-8 -26 -15.5 -76.5t-14 -84t-28.5 -70t-58 -56.5q-86 -48 -189.5 -71.5t-202 -22t-201.5 18.5q-46 8 -81.5 18 t-76.5 27t-73 43.5t-52 61.5q-25 96 -57 292l6 16l18 9q223 -148 506.5 -148t507.5 148q21 -6 24 -23t-5 -45t-8 -37zM1403 1166q-26 -167 -111 -655q-5 -30 -27 -56t-43.5 -40t-54.5 -31q-252 -126 -610 -88q-248 27 -394 139q-15 12 -25.5 26.5t-17 35t-9 34t-6 39.5 t-5.5 35q-9 50 -26.5 150t-28 161.5t-23.5 147.5t-22 158q3 26 17.5 48.5t31.5 37.5t45 30t46 22.5t48 18.5q125 46 313 64q379 37 676 -50q155 -46 215 -122q16 -20 16.5 -51t-5.5 -54z" /> | ||
| 369 | <glyph unicode="" d="M848 666q0 43 -41 66t-77 1q-43 -20 -42.5 -72.5t43.5 -70.5q39 -23 81 4t36 72zM928 682q8 -66 -36 -121t-110 -61t-119 40t-56 113q-2 49 25.5 93t72.5 64q70 31 141.5 -10t81.5 -118zM1100 1073q-20 -21 -53.5 -34t-53 -16t-63.5 -8q-155 -20 -324 0q-44 6 -63 9.5 t-52.5 16t-54.5 32.5q13 19 36 31t40 15.5t47 8.5q198 35 408 1q33 -5 51 -8.5t43 -16t39 -31.5zM1142 327q0 7 5.5 26.5t3 32t-17.5 16.5q-161 -106 -365 -106t-366 106l-12 -6l-5 -12q26 -154 41 -210q47 -81 204 -108q249 -46 428 53q34 19 49 51.5t22.5 85.5t12.5 71z M1272 1020q9 53 -8 75q-43 55 -155 88q-216 63 -487 36q-132 -12 -226 -46q-38 -15 -59.5 -25t-47 -34t-29.5 -54q8 -68 19 -138t29 -171t24 -137q1 -5 5 -31t7 -36t12 -27t22 -28q105 -80 284 -100q259 -28 440 63q24 13 39.5 23t31 29t19.5 40q48 267 80 473zM1536 1120 v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> | ||
| 370 | <glyph unicode="" horiz-adv-x="1024" d="M390 1408h219v-388h364v-241h-364v-394q0 -136 14 -172q13 -37 52 -60q50 -31 117 -31q117 0 232 76v-242q-102 -48 -178 -65q-77 -19 -173 -19q-105 0 -186 27q-78 25 -138 75q-58 51 -79 105q-22 54 -22 161v539h-170v217q91 30 155 84q64 55 103 132q39 78 54 196z " /> | ||
| 371 | <glyph unicode="" d="M1123 127v181q-88 -56 -174 -56q-51 0 -88 23q-29 17 -39 45q-11 30 -11 129v295h274v181h-274v291h-164q-11 -90 -40 -147t-78 -99q-48 -40 -116 -63v-163h127v-404q0 -78 17 -121q17 -42 59 -78q43 -37 104 -57q62 -20 140 -20q67 0 129 14q57 13 134 49zM1536 1120 v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> | ||
| 372 | <glyph unicode="" horiz-adv-x="768" d="M765 237q8 -19 -5 -35l-350 -384q-10 -10 -23 -10q-14 0 -24 10l-355 384q-13 16 -5 35q9 19 29 19h224v1248q0 14 9 23t23 9h192q14 0 23 -9t9 -23v-1248h224q21 0 29 -19z" /> | ||
| 373 | <glyph unicode="" horiz-adv-x="768" d="M765 1043q-9 -19 -29 -19h-224v-1248q0 -14 -9 -23t-23 -9h-192q-14 0 -23 9t-9 23v1248h-224q-21 0 -29 19t5 35l350 384q10 10 23 10q14 0 24 -10l355 -384q13 -16 5 -35z" /> | ||
| 374 | <glyph unicode="" horiz-adv-x="1792" d="M1792 736v-192q0 -14 -9 -23t-23 -9h-1248v-224q0 -21 -19 -29t-35 5l-384 350q-10 10 -10 23q0 14 10 24l384 354q16 14 35 6q19 -9 19 -29v-224h1248q14 0 23 -9t9 -23z" /> | ||
| 375 | <glyph unicode="" horiz-adv-x="1792" d="M1728 643q0 -14 -10 -24l-384 -354q-16 -14 -35 -6q-19 9 -19 29v224h-1248q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h1248v224q0 21 19 29t35 -5l384 -350q10 -10 10 -23z" /> | ||
| 376 | <glyph unicode="" horiz-adv-x="1408" d="M1393 321q-39 -125 -123 -250q-129 -196 -257 -196q-49 0 -140 32q-86 32 -151 32q-61 0 -142 -33q-81 -34 -132 -34q-152 0 -301 259q-147 261 -147 503q0 228 113 374q112 144 284 144q72 0 177 -30q104 -30 138 -30q45 0 143 34q102 34 173 34q119 0 213 -65 q52 -36 104 -100q-79 -67 -114 -118q-65 -94 -65 -207q0 -124 69 -223t158 -126zM1017 1494q0 -61 -29 -136q-30 -75 -93 -138q-54 -54 -108 -72q-37 -11 -104 -17q3 149 78 257q74 107 250 148q1 -3 2.5 -11t2.5 -11q0 -4 0.5 -10t0.5 -10z" /> | ||
| 377 | <glyph unicode="" horiz-adv-x="1664" d="M682 530v-651l-682 94v557h682zM682 1273v-659h-682v565zM1664 530v-786l-907 125v661h907zM1664 1408v-794h-907v669z" /> | ||
| 378 | <glyph unicode="" horiz-adv-x="1408" d="M493 1053q16 0 27.5 11.5t11.5 27.5t-11.5 27.5t-27.5 11.5t-27 -11.5t-11 -27.5t11 -27.5t27 -11.5zM915 1053q16 0 27 11.5t11 27.5t-11 27.5t-27 11.5t-27.5 -11.5t-11.5 -27.5t11.5 -27.5t27.5 -11.5zM103 869q42 0 72 -30t30 -72v-430q0 -43 -29.5 -73t-72.5 -30 t-73 30t-30 73v430q0 42 30 72t73 30zM1163 850v-666q0 -46 -32 -78t-77 -32h-75v-227q0 -43 -30 -73t-73 -30t-73 30t-30 73v227h-138v-227q0 -43 -30 -73t-73 -30q-42 0 -72 30t-30 73l-1 227h-74q-46 0 -78 32t-32 78v666h918zM931 1255q107 -55 171 -153.5t64 -215.5 h-925q0 117 64 215.5t172 153.5l-71 131q-7 13 5 20q13 6 20 -6l72 -132q95 42 201 42t201 -42l72 132q7 12 20 6q12 -7 5 -20zM1408 767v-430q0 -43 -30 -73t-73 -30q-42 0 -72 30t-30 73v430q0 43 30 72.5t72 29.5q43 0 73 -29.5t30 -72.5z" /> | ||
| 379 | <glyph unicode="" d="M663 1125q-11 -1 -15.5 -10.5t-8.5 -9.5q-5 -1 -5 5q0 12 19 15h10zM750 1111q-4 -1 -11.5 6.5t-17.5 4.5q24 11 32 -2q3 -6 -3 -9zM399 684q-4 1 -6 -3t-4.5 -12.5t-5.5 -13.5t-10 -13q-7 -10 -1 -12q4 -1 12.5 7t12.5 18q1 3 2 7t2 6t1.5 4.5t0.5 4v3t-1 2.5t-3 2z M1254 325q0 18 -55 42q4 15 7.5 27.5t5 26t3 21.5t0.5 22.5t-1 19.5t-3.5 22t-4 20.5t-5 25t-5.5 26.5q-10 48 -47 103t-72 75q24 -20 57 -83q87 -162 54 -278q-11 -40 -50 -42q-31 -4 -38.5 18.5t-8 83.5t-11.5 107q-9 39 -19.5 69t-19.5 45.5t-15.5 24.5t-13 15t-7.5 7 q-14 62 -31 103t-29.5 56t-23.5 33t-15 40q-4 21 6 53.5t4.5 49.5t-44.5 25q-15 3 -44.5 18t-35.5 16q-8 1 -11 26t8 51t36 27q37 3 51 -30t4 -58q-11 -19 -2 -26.5t30 -0.5q13 4 13 36v37q-5 30 -13.5 50t-21 30.5t-23.5 15t-27 7.5q-107 -8 -89 -134q0 -15 -1 -15 q-9 9 -29.5 10.5t-33 -0.5t-15.5 5q1 57 -16 90t-45 34q-27 1 -41.5 -27.5t-16.5 -59.5q-1 -15 3.5 -37t13 -37.5t15.5 -13.5q10 3 16 14q4 9 -7 8q-7 0 -15.5 14.5t-9.5 33.5q-1 22 9 37t34 14q17 0 27 -21t9.5 -39t-1.5 -22q-22 -15 -31 -29q-8 -12 -27.5 -23.5 t-20.5 -12.5q-13 -14 -15.5 -27t7.5 -18q14 -8 25 -19.5t16 -19t18.5 -13t35.5 -6.5q47 -2 102 15q2 1 23 7t34.5 10.5t29.5 13t21 17.5q9 14 20 8q5 -3 6.5 -8.5t-3 -12t-16.5 -9.5q-20 -6 -56.5 -21.5t-45.5 -19.5q-44 -19 -70 -23q-25 -5 -79 2q-10 2 -9 -2t17 -19 q25 -23 67 -22q17 1 36 7t36 14t33.5 17.5t30 17t24.5 12t17.5 2.5t8.5 -11q0 -2 -1 -4.5t-4 -5t-6 -4.5t-8.5 -5t-9 -4.5t-10 -5t-9.5 -4.5q-28 -14 -67.5 -44t-66.5 -43t-49 -1q-21 11 -63 73q-22 31 -25 22q-1 -3 -1 -10q0 -25 -15 -56.5t-29.5 -55.5t-21 -58t11.5 -63 q-23 -6 -62.5 -90t-47.5 -141q-2 -18 -1.5 -69t-5.5 -59q-8 -24 -29 -3q-32 31 -36 94q-2 28 4 56q4 19 -1 18l-4 -5q-36 -65 10 -166q5 -12 25 -28t24 -20q20 -23 104 -90.5t93 -76.5q16 -15 17.5 -38t-14 -43t-45.5 -23q8 -15 29 -44.5t28 -54t7 -70.5q46 24 7 92 q-4 8 -10.5 16t-9.5 12t-2 6q3 5 13 9.5t20 -2.5q46 -52 166 -36q133 15 177 87q23 38 34 30q12 -6 10 -52q-1 -25 -23 -92q-9 -23 -6 -37.5t24 -15.5q3 19 14.5 77t13.5 90q2 21 -6.5 73.5t-7.5 97t23 70.5q15 18 51 18q1 37 34.5 53t72.5 10.5t60 -22.5zM626 1152 q3 17 -2.5 30t-11.5 15q-9 2 -9 -7q2 -5 5 -6q10 0 7 -15q-3 -20 8 -20q3 0 3 3zM1045 955q-2 8 -6.5 11.5t-13 5t-14.5 5.5q-5 3 -9.5 8t-7 8t-5.5 6.5t-4 4t-4 -1.5q-14 -16 7 -43.5t39 -31.5q9 -1 14.5 8t3.5 20zM867 1168q0 11 -5 19.5t-11 12.5t-9 3q-14 -1 -7 -7l4 -2 q14 -4 18 -31q0 -3 8 2zM921 1401q0 2 -2.5 5t-9 7t-9.5 6q-15 15 -24 15q-9 -1 -11.5 -7.5t-1 -13t-0.5 -12.5q-1 -4 -6 -10.5t-6 -9t3 -8.5q4 -3 8 0t11 9t15 9q1 1 9 1t15 2t9 7zM1486 60q20 -12 31 -24.5t12 -24t-2.5 -22.5t-15.5 -22t-23.5 -19.5t-30 -18.5 t-31.5 -16.5t-32 -15.5t-27 -13q-38 -19 -85.5 -56t-75.5 -64q-17 -16 -68 -19.5t-89 14.5q-18 9 -29.5 23.5t-16.5 25.5t-22 19.5t-47 9.5q-44 1 -130 1q-19 0 -57 -1.5t-58 -2.5q-44 -1 -79.5 -15t-53.5 -30t-43.5 -28.5t-53.5 -11.5q-29 1 -111 31t-146 43q-19 4 -51 9.5 t-50 9t-39.5 9.5t-33.5 14.5t-17 19.5q-10 23 7 66.5t18 54.5q1 16 -4 40t-10 42.5t-4.5 36.5t10.5 27q14 12 57 14t60 12q30 18 42 35t12 51q21 -73 -32 -106q-32 -20 -83 -15q-34 3 -43 -10q-13 -15 5 -57q2 -6 8 -18t8.5 -18t4.5 -17t1 -22q0 -15 -17 -49t-14 -48 q3 -17 37 -26q20 -6 84.5 -18.5t99.5 -20.5q24 -6 74 -22t82.5 -23t55.5 -4q43 6 64.5 28t23 48t-7.5 58.5t-19 52t-20 36.5q-121 190 -169 242q-68 74 -113 40q-11 -9 -15 15q-3 16 -2 38q1 29 10 52t24 47t22 42q8 21 26.5 72t29.5 78t30 61t39 54q110 143 124 195 q-12 112 -16 310q-2 90 24 151.5t106 104.5q39 21 104 21q53 1 106 -13.5t89 -41.5q57 -42 91.5 -121.5t29.5 -147.5q-5 -95 30 -214q34 -113 133 -218q55 -59 99.5 -163t59.5 -191q8 -49 5 -84.5t-12 -55.5t-20 -22q-10 -2 -23.5 -19t-27 -35.5t-40.5 -33.5t-61 -14 q-18 1 -31.5 5t-22.5 13.5t-13.5 15.5t-11.5 20.5t-9 19.5q-22 37 -41 30t-28 -49t7 -97q20 -70 1 -195q-10 -65 18 -100.5t73 -33t85 35.5q59 49 89.5 66.5t103.5 42.5q53 18 77 36.5t18.5 34.5t-25 28.5t-51.5 23.5q-33 11 -49.5 48t-15 72.5t15.5 47.5q1 -31 8 -56.5 t14.5 -40.5t20.5 -28.5t21 -19t21.5 -13t16.5 -9.5z" /> | ||
| 380 | <glyph unicode="" d="M1024 36q-42 241 -140 498h-2l-2 -1q-16 -6 -43 -16.5t-101 -49t-137 -82t-131 -114.5t-103 -148l-15 11q184 -150 418 -150q132 0 256 52zM839 643q-21 49 -53 111q-311 -93 -673 -93q-1 -7 -1 -21q0 -124 44 -236.5t124 -201.5q50 89 123.5 166.5t142.5 124.5t130.5 81 t99.5 48l37 13q4 1 13 3.5t13 4.5zM732 855q-120 213 -244 378q-138 -65 -234 -186t-128 -272q302 0 606 80zM1416 536q-210 60 -409 29q87 -239 128 -469q111 75 185 189.5t96 250.5zM611 1277q-1 0 -2 -1q1 1 2 1zM1201 1132q-185 164 -433 164q-76 0 -155 -19 q131 -170 246 -382q69 26 130 60.5t96.5 61.5t65.5 57t37.5 40.5zM1424 647q-3 232 -149 410l-1 -1q-9 -12 -19 -24.5t-43.5 -44.5t-71 -60.5t-100 -65t-131.5 -64.5q25 -53 44 -95q2 -6 6.5 -17.5t7.5 -16.5q36 5 74.5 7t73.5 2t69 -1.5t64 -4t56.5 -5.5t48 -6.5t36.5 -6 t25 -4.5zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 381 | <glyph unicode="" d="M1173 473q0 50 -19.5 91.5t-48.5 68.5t-73 49t-82.5 34t-87.5 23l-104 24q-30 7 -44 10.5t-35 11.5t-30 16t-16.5 21t-7.5 30q0 77 144 77q43 0 77 -12t54 -28.5t38 -33.5t40 -29t48 -12q47 0 75.5 32t28.5 77q0 55 -56 99.5t-142 67.5t-182 23q-68 0 -132 -15.5 t-119.5 -47t-89 -87t-33.5 -128.5q0 -61 19 -106.5t56 -75.5t80 -48.5t103 -32.5l146 -36q90 -22 112 -36q32 -20 32 -60q0 -39 -40 -64.5t-105 -25.5q-51 0 -91.5 16t-65 38.5t-45.5 45t-46 38.5t-54 16q-50 0 -75.5 -30t-25.5 -75q0 -92 122 -157.5t291 -65.5 q73 0 140 18.5t122.5 53.5t88.5 93.5t33 131.5zM1536 256q0 -159 -112.5 -271.5t-271.5 -112.5q-130 0 -234 80q-77 -16 -150 -16q-143 0 -273.5 55.5t-225 150t-150 225t-55.5 273.5q0 73 16 150q-80 104 -80 234q0 159 112.5 271.5t271.5 112.5q130 0 234 -80 q77 16 150 16q143 0 273.5 -55.5t225 -150t150 -225t55.5 -273.5q0 -73 -16 -150q80 -104 80 -234z" /> | ||
| 382 | <glyph unicode="" horiz-adv-x="1664" d="M1483 512l-587 -587q-52 -53 -127.5 -53t-128.5 53l-587 587q-53 53 -53 128t53 128l587 587q53 53 128 53t128 -53l265 -265l-398 -399l-188 188q-42 42 -99 42q-59 0 -100 -41l-120 -121q-42 -40 -42 -99q0 -58 42 -100l406 -408q30 -28 67 -37l6 -4h28q60 0 99 41 l619 619l2 -3q53 -53 53 -128t-53 -128zM1406 1138l120 -120q14 -15 14 -36t-14 -36l-730 -730q-17 -15 -37 -15v0q-4 0 -6 1q-18 2 -30 14l-407 408q-14 15 -14 36t14 35l121 120q13 15 35 15t36 -15l252 -252l574 575q15 15 36 15t36 -15z" /> | ||
| 383 | <glyph unicode="" d="M704 192v1024q0 14 -9 23t-23 9h-480q-14 0 -23 -9t-9 -23v-1024q0 -14 9 -23t23 -9h480q14 0 23 9t9 23zM1376 576v640q0 14 -9 23t-23 9h-480q-14 0 -23 -9t-9 -23v-640q0 -14 9 -23t23 -9h480q14 0 23 9t9 23zM1536 1344v-1408q0 -26 -19 -45t-45 -19h-1408 q-26 0 -45 19t-19 45v1408q0 26 19 45t45 19h1408q26 0 45 -19t19 -45z" /> | ||
| 384 | <glyph unicode="" horiz-adv-x="1280" d="M1280 480q0 -40 -28 -68t-68 -28q-51 0 -80 43l-227 341h-45v-132l247 -411q9 -15 9 -33q0 -26 -19 -45t-45 -19h-192v-272q0 -46 -33 -79t-79 -33h-160q-46 0 -79 33t-33 79v272h-192q-26 0 -45 19t-19 45q0 18 9 33l247 411v132h-45l-227 -341q-29 -43 -80 -43 q-40 0 -68 28t-28 68q0 29 16 53l256 384q73 107 176 107h384q103 0 176 -107l256 -384q16 -24 16 -53zM864 1280q0 -93 -65.5 -158.5t-158.5 -65.5t-158.5 65.5t-65.5 158.5t65.5 158.5t158.5 65.5t158.5 -65.5t65.5 -158.5z" /> | ||
| 385 | <glyph unicode="" horiz-adv-x="1024" d="M1024 832v-416q0 -40 -28 -68t-68 -28t-68 28t-28 68v352h-64v-912q0 -46 -33 -79t-79 -33t-79 33t-33 79v464h-64v-464q0 -46 -33 -79t-79 -33t-79 33t-33 79v912h-64v-352q0 -40 -28 -68t-68 -28t-68 28t-28 68v416q0 80 56 136t136 56h640q80 0 136 -56t56 -136z M736 1280q0 -93 -65.5 -158.5t-158.5 -65.5t-158.5 65.5t-65.5 158.5t65.5 158.5t158.5 65.5t158.5 -65.5t65.5 -158.5z" /> | ||
| 386 | <glyph unicode="" d="M773 234l350 473q16 22 24.5 59t-6 85t-61.5 79q-40 26 -83 25.5t-73.5 -17.5t-54.5 -45q-36 -40 -96 -40q-59 0 -95 40q-24 28 -54.5 45t-73.5 17.5t-84 -25.5q-46 -31 -60.5 -79t-6 -85t24.5 -59zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103 t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> | ||
| 387 | <glyph unicode="" horiz-adv-x="1792" d="M1472 640q0 117 -45.5 223.5t-123 184t-184 123t-223.5 45.5t-223.5 -45.5t-184 -123t-123 -184t-45.5 -223.5t45.5 -223.5t123 -184t184 -123t223.5 -45.5t223.5 45.5t184 123t123 184t45.5 223.5zM1748 363q-4 -15 -20 -20l-292 -96v-306q0 -16 -13 -26q-15 -10 -29 -4 l-292 94l-180 -248q-10 -13 -26 -13t-26 13l-180 248l-292 -94q-14 -6 -29 4q-13 10 -13 26v306l-292 96q-16 5 -20 20q-5 17 4 29l180 248l-180 248q-9 13 -4 29q4 15 20 20l292 96v306q0 16 13 26q15 10 29 4l292 -94l180 248q9 12 26 12t26 -12l180 -248l292 94 q14 6 29 -4q13 -10 13 -26v-306l292 -96q16 -5 20 -20q5 -16 -4 -29l-180 -248l180 -248q9 -12 4 -29z" /> | ||
| 388 | <glyph unicode="" d="M1262 233q-54 -9 -110 -9q-182 0 -337 90t-245 245t-90 337q0 192 104 357q-201 -60 -328.5 -229t-127.5 -384q0 -130 51 -248.5t136.5 -204t204 -136.5t248.5 -51q144 0 273.5 61.5t220.5 171.5zM1465 318q-94 -203 -283.5 -324.5t-413.5 -121.5q-156 0 -298 61 t-245 164t-164 245t-61 298q0 153 57.5 292.5t156 241.5t235.5 164.5t290 68.5q44 2 61 -39q18 -41 -15 -72q-86 -78 -131.5 -181.5t-45.5 -218.5q0 -148 73 -273t198 -198t273 -73q118 0 228 51q41 18 72 -13q14 -14 17.5 -34t-4.5 -38z" /> | ||
| 389 | <glyph unicode="" horiz-adv-x="1792" d="M1088 704q0 26 -19 45t-45 19h-256q-26 0 -45 -19t-19 -45t19 -45t45 -19h256q26 0 45 19t19 45zM1664 896v-960q0 -26 -19 -45t-45 -19h-1408q-26 0 -45 19t-19 45v960q0 26 19 45t45 19h1408q26 0 45 -19t19 -45zM1728 1344v-256q0 -26 -19 -45t-45 -19h-1536 q-26 0 -45 19t-19 45v256q0 26 19 45t45 19h1536q26 0 45 -19t19 -45z" /> | ||
| 390 | <glyph unicode="" horiz-adv-x="1664" d="M1632 576q0 -26 -19 -45t-45 -19h-224q0 -171 -67 -290l208 -209q19 -19 19 -45t-19 -45q-18 -19 -45 -19t-45 19l-198 197q-5 -5 -15 -13t-42 -28.5t-65 -36.5t-82 -29t-97 -13v896h-128v-896q-51 0 -101.5 13.5t-87 33t-66 39t-43.5 32.5l-15 14l-183 -207 q-20 -21 -48 -21q-24 0 -43 16q-19 18 -20.5 44.5t15.5 46.5l202 227q-58 114 -58 274h-224q-26 0 -45 19t-19 45t19 45t45 19h224v294l-173 173q-19 19 -19 45t19 45t45 19t45 -19l173 -173h844l173 173q19 19 45 19t45 -19t19 -45t-19 -45l-173 -173v-294h224q26 0 45 -19 t19 -45zM1152 1152h-640q0 133 93.5 226.5t226.5 93.5t226.5 -93.5t93.5 -226.5z" /> | ||
| 391 | <glyph unicode="" horiz-adv-x="1920" d="M1917 1016q23 -64 -150 -294q-24 -32 -65 -85q-78 -100 -90 -131q-17 -41 14 -81q17 -21 81 -82h1l1 -1l1 -1l2 -2q141 -131 191 -221q3 -5 6.5 -12.5t7 -26.5t-0.5 -34t-25 -27.5t-59 -12.5l-256 -4q-24 -5 -56 5t-52 22l-20 12q-30 21 -70 64t-68.5 77.5t-61 58 t-56.5 15.5q-3 -1 -8 -3.5t-17 -14.5t-21.5 -29.5t-17 -52t-6.5 -77.5q0 -15 -3.5 -27.5t-7.5 -18.5l-4 -5q-18 -19 -53 -22h-115q-71 -4 -146 16.5t-131.5 53t-103 66t-70.5 57.5l-25 24q-10 10 -27.5 30t-71.5 91t-106 151t-122.5 211t-130.5 272q-6 16 -6 27t3 16l4 6 q15 19 57 19l274 2q12 -2 23 -6.5t16 -8.5l5 -3q16 -11 24 -32q20 -50 46 -103.5t41 -81.5l16 -29q29 -60 56 -104t48.5 -68.5t41.5 -38.5t34 -14t27 5q2 1 5 5t12 22t13.5 47t9.5 81t0 125q-2 40 -9 73t-14 46l-6 12q-25 34 -85 43q-13 2 5 24q17 19 38 30q53 26 239 24 q82 -1 135 -13q20 -5 33.5 -13.5t20.5 -24t10.5 -32t3.5 -45.5t-1 -55t-2.5 -70.5t-1.5 -82.5q0 -11 -1 -42t-0.5 -48t3.5 -40.5t11.5 -39t22.5 -24.5q8 -2 17 -4t26 11t38 34.5t52 67t68 107.5q60 104 107 225q4 10 10 17.5t11 10.5l4 3l5 2.5t13 3t20 0.5l288 2 q39 5 64 -2.5t31 -16.5z" /> | ||
| 392 | <glyph unicode="" horiz-adv-x="1792" d="M675 252q21 34 11 69t-45 50q-34 14 -73 1t-60 -46q-22 -34 -13 -68.5t43 -50.5t74.5 -2.5t62.5 47.5zM769 373q8 13 3.5 26.5t-17.5 18.5q-14 5 -28.5 -0.5t-21.5 -18.5q-17 -31 13 -45q14 -5 29 0.5t22 18.5zM943 266q-45 -102 -158 -150t-224 -12 q-107 34 -147.5 126.5t6.5 187.5q47 93 151.5 139t210.5 19q111 -29 158.5 -119.5t2.5 -190.5zM1255 426q-9 96 -89 170t-208.5 109t-274.5 21q-223 -23 -369.5 -141.5t-132.5 -264.5q9 -96 89 -170t208.5 -109t274.5 -21q223 23 369.5 141.5t132.5 264.5zM1563 422 q0 -68 -37 -139.5t-109 -137t-168.5 -117.5t-226 -83t-270.5 -31t-275 33.5t-240.5 93t-171.5 151t-65 199.5q0 115 69.5 245t197.5 258q169 169 341.5 236t246.5 -7q65 -64 20 -209q-4 -14 -1 -20t10 -7t14.5 0.5t13.5 3.5l6 2q139 59 246 59t153 -61q45 -63 0 -178 q-2 -13 -4.5 -20t4.5 -12.5t12 -7.5t17 -6q57 -18 103 -47t80 -81.5t34 -116.5zM1489 1046q42 -47 54.5 -108.5t-6.5 -117.5q-8 -23 -29.5 -34t-44.5 -4q-23 8 -34 29.5t-4 44.5q20 63 -24 111t-107 35q-24 -5 -45 8t-25 37q-5 24 8 44.5t37 25.5q60 13 119 -5.5t101 -65.5z M1670 1209q87 -96 112.5 -222.5t-13.5 -241.5q-9 -27 -34 -40t-52 -4t-40 34t-5 52q28 82 10 172t-80 158q-62 69 -148 95.5t-173 8.5q-28 -6 -52 9.5t-30 43.5t9.5 51.5t43.5 29.5q123 26 244 -11.5t208 -134.5z" /> | ||
| 393 | <glyph unicode="" horiz-adv-x="1920" d="M805 163q-122 -67 -261 -67q-141 0 -261 67q98 61 167 149t94 191q25 -103 94 -191t167 -149zM453 1176v-344q0 -179 -89.5 -326t-234.5 -217q-129 152 -129 351q0 200 129.5 352t323.5 184zM958 991q-128 -152 -128 -351q0 -201 128 -351q-145 70 -234.5 218t-89.5 328 v341q196 -33 324 -185zM1638 163q-122 -67 -261 -67q-141 0 -261 67q98 61 167 149t94 191q25 -103 94 -191t167 -149zM1286 1176v-344q0 -179 -91 -326t-237 -217v0q133 154 133 351q0 195 -133 351q129 151 328 185zM1920 640q0 -201 -129 -351q-145 70 -234.5 218 t-89.5 328v341q194 -32 323.5 -184t129.5 -352z" /> | ||
| 394 | <glyph unicode="" horiz-adv-x="1792" /> | ||
| 395 | <glyph unicode="" horiz-adv-x="1792" /> | ||
| 396 | <glyph unicode="" horiz-adv-x="1792" /> | ||
| 397 | <glyph unicode="" horiz-adv-x="1792" /> | ||
| 398 | </font> | ||
| 399 | </defs></svg> \ No newline at end of file | ||
diff --git a/doc/html/fonts/fontawesome-webfont.ttf b/doc/html/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..d3659246 --- /dev/null +++ b/doc/html/fonts/fontawesome-webfont.ttf | |||
| Binary files differ | |||
diff --git a/doc/html/fonts/fontawesome-webfont.woff b/doc/html/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..b9bd17e1 --- /dev/null +++ b/doc/html/fonts/fontawesome-webfont.woff | |||
| Binary files differ | |||
diff --git a/doc/github-markdown.css b/doc/html/github-markdown.css index 581350ae..581350ae 100644 --- a/doc/github-markdown.css +++ b/doc/html/github-markdown.css | |||
diff --git a/doc/images/bookmarklet.png b/doc/html/images/bookmarklet.png index 0262578e..0262578e 100644 --- a/doc/images/bookmarklet.png +++ b/doc/html/images/bookmarklet.png | |||
| Binary files differ | |||
diff --git a/doc/images/doc-logo.png b/doc/html/images/doc-logo.png index 3d8d1787..3d8d1787 100644 --- a/doc/images/doc-logo.png +++ b/doc/html/images/doc-logo.png | |||
| Binary files differ | |||
diff --git a/doc/images/doc-logo.svg b/doc/html/images/doc-logo.svg index 37fc6658..37fc6658 100644 --- a/doc/images/doc-logo.svg +++ b/doc/html/images/doc-logo.svg | |||
diff --git a/doc/images/firefoxshare.png b/doc/html/images/firefoxshare.png index 98c2fdd3..98c2fdd3 100644 --- a/doc/images/firefoxshare.png +++ b/doc/html/images/firefoxshare.png | |||
| Binary files differ | |||
diff --git a/doc/images/rss-filter-1.png b/doc/html/images/rss-filter-1.png index d2a03f67..d2a03f67 100644 --- a/doc/images/rss-filter-1.png +++ b/doc/html/images/rss-filter-1.png | |||
| Binary files differ | |||
diff --git a/doc/images/rss-filter-2.png b/doc/html/images/rss-filter-2.png index 538b126e..538b126e 100644 --- a/doc/images/rss-filter-2.png +++ b/doc/html/images/rss-filter-2.png | |||
| Binary files differ | |||
diff --git a/doc/html/img/favicon.ico b/doc/html/img/favicon.ico new file mode 100644 index 00000000..e85006a3 --- /dev/null +++ b/doc/html/img/favicon.ico | |||
| Binary files differ | |||
diff --git a/doc/html/index.html b/doc/html/index.html new file mode 100644 index 00000000..a9b0c7b9 --- /dev/null +++ b/doc/html/index.html | |||
| @@ -0,0 +1,344 @@ | |||
| 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 | <meta name="description" content="The personal, minimalist, super-fast, database free, bookmarking service"> | ||
| 9 | |||
| 10 | <link rel="shortcut icon" href="./img/favicon.ico"> | ||
| 11 | <title>Home - 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 = "Home"; | ||
| 22 | var mkdocs_page_input_path = "index.md"; | ||
| 23 | var mkdocs_page_url = "/"; | ||
| 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 current"> | ||
| 52 | |||
| 53 | <a class="current" href=".">Home</a> | ||
| 54 | <ul class="subnav"> | ||
| 55 | |||
| 56 | </ul> | ||
| 57 | </li> | ||
| 58 | |||
| 59 | <li class="toctree-l1"> | ||
| 60 | |||
| 61 | <span class="caption-text">Setup</span> | ||
| 62 | <ul class="subnav"> | ||
| 63 | <li class=""> | ||
| 64 | |||
| 65 | <a class="" href="Download-and-Installation/">Download and Installation</a> | ||
| 66 | </li> | ||
| 67 | <li class=""> | ||
| 68 | |||
| 69 | <a class="" href="Upgrade-and-migration/">Upgrade and migration</a> | ||
| 70 | </li> | ||
| 71 | <li class=""> | ||
| 72 | |||
| 73 | <a class="" href="Server-requirements/">Server requirements</a> | ||
| 74 | </li> | ||
| 75 | <li class=""> | ||
| 76 | |||
| 77 | <a class="" href="Server-configuration/">Server configuration</a> | ||
| 78 | </li> | ||
| 79 | <li class=""> | ||
| 80 | |||
| 81 | <a class="" href="Server-security/">Server security</a> | ||
| 82 | </li> | ||
| 83 | <li class=""> | ||
| 84 | |||
| 85 | <a class="" href="Shaarli-configuration/">Shaarli configuration</a> | ||
| 86 | </li> | ||
| 87 | <li class=""> | ||
| 88 | |||
| 89 | <a class="" href="Plugins/">Plugins</a> | ||
| 90 | </li> | ||
| 91 | </ul> | ||
| 92 | </li> | ||
| 93 | |||
| 94 | <li class="toctree-l1"> | ||
| 95 | |||
| 96 | <span class="caption-text">Docker</span> | ||
| 97 | <ul class="subnav"> | ||
| 98 | <li class=""> | ||
| 99 | |||
| 100 | <a class="" href="Docker-101/">Docker 101</a> | ||
| 101 | </li> | ||
| 102 | <li class=""> | ||
| 103 | |||
| 104 | <a class="" href="Shaarli-images/">Shaarli images</a> | ||
| 105 | </li> | ||
| 106 | <li class=""> | ||
| 107 | |||
| 108 | <a class="" href="Reverse-proxy-configuration/">Reverse proxy configuration</a> | ||
| 109 | </li> | ||
| 110 | <li class=""> | ||
| 111 | |||
| 112 | <a class="" href="Docker-resources/">Docker resources</a> | ||
| 113 | </li> | ||
| 114 | </ul> | ||
| 115 | </li> | ||
| 116 | |||
| 117 | <li class="toctree-l1"> | ||
| 118 | |||
| 119 | <span class="caption-text">Usage</span> | ||
| 120 | <ul class="subnav"> | ||
| 121 | <li class=""> | ||
| 122 | |||
| 123 | <a class="" href="Features/">Features</a> | ||
| 124 | </li> | ||
| 125 | <li class=""> | ||
| 126 | |||
| 127 | <a class="" href="Bookmarklet/">Bookmarklet</a> | ||
| 128 | </li> | ||
| 129 | <li class=""> | ||
| 130 | |||
| 131 | <a class="" href="Browsing-and-searching/">Browsing and searching</a> | ||
| 132 | </li> | ||
| 133 | <li class=""> | ||
| 134 | |||
| 135 | <a class="" href="Firefox-share/">Firefox share</a> | ||
| 136 | </li> | ||
| 137 | <li class=""> | ||
| 138 | |||
| 139 | <a class="" href="RSS-feeds/">RSS feeds</a> | ||
| 140 | </li> | ||
| 141 | <li class=""> | ||
| 142 | |||
| 143 | <a class="" href="REST-API/">REST API</a> | ||
| 144 | </li> | ||
| 145 | </ul> | ||
| 146 | </li> | ||
| 147 | |||
| 148 | <li class="toctree-l1"> | ||
| 149 | |||
| 150 | <span class="caption-text">How To</span> | ||
| 151 | <ul class="subnav"> | ||
| 152 | <li class=""> | ||
| 153 | |||
| 154 | <a class="" href="Backup,-restore,-import-and-export/">Backup, restore, import and export</a> | ||
| 155 | </li> | ||
| 156 | <li class=""> | ||
| 157 | |||
| 158 | <a class="" href="Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 159 | </li> | ||
| 160 | <li class=""> | ||
| 161 | |||
| 162 | <a class="" href="Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 163 | </li> | ||
| 164 | <li class=""> | ||
| 165 | |||
| 166 | <a class="" href="Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 167 | </li> | ||
| 168 | <li class=""> | ||
| 169 | |||
| 170 | <a class="" href="Datastore-hacks/">Datastore hacks</a> | ||
| 171 | </li> | ||
| 172 | </ul> | ||
| 173 | </li> | ||
| 174 | |||
| 175 | <li class="toctree-l1"> | ||
| 176 | |||
| 177 | <a class="" href="Troubleshooting/">Troubleshooting</a> | ||
| 178 | </li> | ||
| 179 | |||
| 180 | <li class="toctree-l1"> | ||
| 181 | |||
| 182 | <span class="caption-text">Development</span> | ||
| 183 | <ul class="subnav"> | ||
| 184 | <li class=""> | ||
| 185 | |||
| 186 | <a class="" href="Development-guidelines/">Development guidelines</a> | ||
| 187 | </li> | ||
| 188 | <li class=""> | ||
| 189 | |||
| 190 | <a class="" href="Continuous-integration-tools/">Continuous integration tools</a> | ||
| 191 | </li> | ||
| 192 | <li class=""> | ||
| 193 | |||
| 194 | <a class="" href="GnuPG-signature/">GnuPG signature</a> | ||
| 195 | </li> | ||
| 196 | <li class=""> | ||
| 197 | |||
| 198 | <a class="" href="Coding-guidelines/">Coding guidelines</a> | ||
| 199 | </li> | ||
| 200 | <li class=""> | ||
| 201 | |||
| 202 | <a class="" href="Directory-structure/">Directory structure</a> | ||
| 203 | </li> | ||
| 204 | <li class=""> | ||
| 205 | |||
| 206 | <a class="" href="3rd-party-libraries/">3rd party libraries</a> | ||
| 207 | </li> | ||
| 208 | <li class=""> | ||
| 209 | |||
| 210 | <a class="" href="Plugin-System/">Plugin System</a> | ||
| 211 | </li> | ||
| 212 | <li class=""> | ||
| 213 | |||
| 214 | <a class="" href="Release-Shaarli/">Release Shaarli</a> | ||
| 215 | </li> | ||
| 216 | <li class=""> | ||
| 217 | |||
| 218 | <a class="" href="Versioning-and-Branches/">Versioning and Branches</a> | ||
| 219 | </li> | ||
| 220 | <li class=""> | ||
| 221 | |||
| 222 | <a class="" href="Security/">Security</a> | ||
| 223 | </li> | ||
| 224 | <li class=""> | ||
| 225 | |||
| 226 | <a class="" href="Static-analysis/">Static analysis</a> | ||
| 227 | </li> | ||
| 228 | <li class=""> | ||
| 229 | |||
| 230 | <a class="" href="Theming/">Theming</a> | ||
| 231 | </li> | ||
| 232 | <li class=""> | ||
| 233 | |||
| 234 | <a class="" href="Unit-tests/">Unit tests</a> | ||
| 235 | </li> | ||
| 236 | </ul> | ||
| 237 | </li> | ||
| 238 | |||
| 239 | <li class="toctree-l1"> | ||
| 240 | |||
| 241 | <span class="caption-text">About</span> | ||
| 242 | <ul class="subnav"> | ||
| 243 | <li class=""> | ||
| 244 | |||
| 245 | <a class="" href="FAQ/">FAQ</a> | ||
| 246 | </li> | ||
| 247 | <li class=""> | ||
| 248 | |||
| 249 | <a class="" href="Community-&-Related-software/">Community & Related software</a> | ||
| 250 | </li> | ||
| 251 | </ul> | ||
| 252 | </li> | ||
| 253 | |||
| 254 | </ul> | ||
| 255 | </div> | ||
| 256 | | ||
| 257 | </nav> | ||
| 258 | |||
| 259 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 260 | |||
| 261 | |||
| 262 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 263 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 264 | <a href=".">Shaarli Documentation</a> | ||
| 265 | </nav> | ||
| 266 | |||
| 267 | |||
| 268 | <div class="wy-nav-content"> | ||
| 269 | <div class="rst-content"> | ||
| 270 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 271 | <ul class="wy-breadcrumbs"> | ||
| 272 | <li><a href=".">Docs</a> »</li> | ||
| 273 | |||
| 274 | |||
| 275 | |||
| 276 | <li>Home</li> | ||
| 277 | <li class="wy-breadcrumbs-aside"> | ||
| 278 | |||
| 279 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/index.md" | ||
| 280 | class="icon icon-github"> Edit on GitHub</a> | ||
| 281 | |||
| 282 | </li> | ||
| 283 | </ul> | ||
| 284 | <hr/> | ||
| 285 | </div> | ||
| 286 | <div role="main"> | ||
| 287 | <div class="section"> | ||
| 288 | |||
| 289 | <p>Welcome to the <a href="https://github.com/shaarli/Shaarli/">Shaarli</a> wiki!</p> | ||
| 290 | <p>Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli.</p> | ||
| 291 | <p>For general info, read the <a href="https://github.com/shaarli/Shaarli/blob/master/README.md">README</a>.</p> | ||
| 292 | <p>If you have any questions or ideas, please join the <a href="https://gitter.im/shaarli/Shaarli">chat</a> (also reachable via <a href="https://irc.gitter.im/">IRC</a>), post them in our <a href="https://github.com/shaarli/Shaarli/issues/308">general discussion</a> (<a href="https://github.com/shaarli/Shaarli/issues/44">archive</a>) or read the current <a href="https://github.com/shaarli/Shaarli/issues">issues</a>. If you've found a bug, please create a <a href="https://github.com/shaarli/Shaarli/issues/new">new issue</a>.</p> | ||
| 293 | <p>If you would like a feature added to Shaarli, check the issues labeled <a href="https://github.com/shaarli/Shaarli/labels/feature"><code>feature</code></a>, <a href="https://github.com/shaarli/Shaarli/labels/enhancement"><code>enhancement</code></a>, and <a href="https://github.com/shaarli/Shaarli/labels/plugin"><code>plugin</code></a>.</p> | ||
| 294 | <p><em>Note: This documentation is available online at https://github.com/shaarli/Shaarli/wiki, and locally in the <code>doc/</code> directory of your Shaarli installation.</em></p> | ||
| 295 | |||
| 296 | </div> | ||
| 297 | </div> | ||
| 298 | <footer> | ||
| 299 | |||
| 300 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| 301 | |||
| 302 | <a href="Download-and-Installation/" class="btn btn-neutral float-right" title="Download and Installation">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| 303 | |||
| 304 | |||
| 305 | </div> | ||
| 306 | |||
| 307 | |||
| 308 | <hr/> | ||
| 309 | |||
| 310 | <div role="contentinfo"> | ||
| 311 | <!-- Copyright etc --> | ||
| 312 | |||
| 313 | </div> | ||
| 314 | |||
| 315 | 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>. | ||
| 316 | </footer> | ||
| 317 | |||
| 318 | </div> | ||
| 319 | </div> | ||
| 320 | |||
| 321 | </section> | ||
| 322 | |||
| 323 | </div> | ||
| 324 | |||
| 325 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 326 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 327 | |||
| 328 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 329 | |||
| 330 | |||
| 331 | |||
| 332 | <span style="margin-left: 15px"><a href="Download-and-Installation/" style="color: #fcfcfc">Next »</a></span> | ||
| 333 | |||
| 334 | </span> | ||
| 335 | </div> | ||
| 336 | <script src="./js/theme.js"></script> | ||
| 337 | |||
| 338 | </body> | ||
| 339 | </html> | ||
| 340 | |||
| 341 | <!-- | ||
| 342 | MkDocs version : 0.16.3 | ||
| 343 | Build Date UTC : 2017-06-17 22:04:25 | ||
| 344 | --> | ||
diff --git a/doc/html/js/highlight.pack.js b/doc/html/js/highlight.pack.js new file mode 100644 index 00000000..a5818dfb --- /dev/null +++ b/doc/html/js/highlight.pack.js | |||
| @@ -0,0 +1,2 @@ | |||
| 1 | !function(e){"undefined"!=typeof exports?e(exports):(window.hljs=e({}),"function"==typeof define&&define.amd&&define([],function(){return window.hljs}))}(function(e){function n(e){return e.replace(/&/gm,"&").replace(/</gm,"<").replace(/>/gm,">")}function t(e){return e.nodeName.toLowerCase()}function r(e,n){var t=e&&e.exec(n);return t&&0==t.index}function a(e){var n=(e.className+" "+(e.parentNode?e.parentNode.className:"")).split(/\s+/);return n=n.map(function(e){return e.replace(/^lang(uage)?-/,"")}),n.filter(function(e){return N(e)||/no(-?)highlight|plain|text/.test(e)})[0]}function i(e,n){var t,r={};for(t in e)r[t]=e[t];if(n)for(t in n)r[t]=n[t];return r}function o(e){var n=[];return function r(e,a){for(var i=e.firstChild;i;i=i.nextSibling)3==i.nodeType?a+=i.nodeValue.length:1==i.nodeType&&(n.push({event:"start",offset:a,node:i}),a=r(i,a),t(i).match(/br|hr|img|input/)||n.push({event:"stop",offset:a,node:i}));return a}(e,0),n}function u(e,r,a){function i(){return e.length&&r.length?e[0].offset!=r[0].offset?e[0].offset<r[0].offset?e:r:"start"==r[0].event?e:r:e.length?e:r}function o(e){function r(e){return" "+e.nodeName+'="'+n(e.value)+'"'}l+="<"+t(e)+Array.prototype.map.call(e.attributes,r).join("")+">"}function u(e){l+="</"+t(e)+">"}function c(e){("start"==e.event?o:u)(e.node)}for(var s=0,l="",f=[];e.length||r.length;){var g=i();if(l+=n(a.substr(s,g[0].offset-s)),s=g[0].offset,g==e){f.reverse().forEach(u);do c(g.splice(0,1)[0]),g=i();while(g==e&&g.length&&g[0].offset==s);f.reverse().forEach(o)}else"start"==g[0].event?f.push(g[0].node):f.pop(),c(g.splice(0,1)[0])}return l+n(a.substr(s))}function c(e){function n(e){return e&&e.source||e}function t(t,r){return new RegExp(n(t),"m"+(e.cI?"i":"")+(r?"g":""))}function r(a,o){if(!a.compiled){if(a.compiled=!0,a.k=a.k||a.bK,a.k){var u={},c=function(n,t){e.cI&&(t=t.toLowerCase()),t.split(" ").forEach(function(e){var t=e.split("|");u[t[0]]=[n,t[1]?Number(t[1]):1]})};"string"==typeof a.k?c("keyword",a.k):Object.keys(a.k).forEach(function(e){c(e,a.k[e])}),a.k=u}a.lR=t(a.l||/\b\w+\b/,!0),o&&(a.bK&&(a.b="\\b("+a.bK.split(" ").join("|")+")\\b"),a.b||(a.b=/\B|\b/),a.bR=t(a.b),a.e||a.eW||(a.e=/\B|\b/),a.e&&(a.eR=t(a.e)),a.tE=n(a.e)||"",a.eW&&o.tE&&(a.tE+=(a.e?"|":"")+o.tE)),a.i&&(a.iR=t(a.i)),void 0===a.r&&(a.r=1),a.c||(a.c=[]);var s=[];a.c.forEach(function(e){e.v?e.v.forEach(function(n){s.push(i(e,n))}):s.push("self"==e?a:e)}),a.c=s,a.c.forEach(function(e){r(e,a)}),a.starts&&r(a.starts,o);var l=a.c.map(function(e){return e.bK?"\\.?("+e.b+")\\.?":e.b}).concat([a.tE,a.i]).map(n).filter(Boolean);a.t=l.length?t(l.join("|"),!0):{exec:function(){return null}}}}r(e)}function s(e,t,a,i){function o(e,n){for(var t=0;t<n.c.length;t++)if(r(n.c[t].bR,e))return n.c[t]}function u(e,n){if(r(e.eR,n)){for(;e.endsParent&&e.parent;)e=e.parent;return e}return e.eW?u(e.parent,n):void 0}function f(e,n){return!a&&r(n.iR,e)}function g(e,n){var t=E.cI?n[0].toLowerCase():n[0];return e.k.hasOwnProperty(t)&&e.k[t]}function p(e,n,t,r){var a=r?"":x.classPrefix,i='<span class="'+a,o=t?"":"</span>";return i+=e+'">',i+n+o}function d(){if(!L.k)return n(y);var e="",t=0;L.lR.lastIndex=0;for(var r=L.lR.exec(y);r;){e+=n(y.substr(t,r.index-t));var a=g(L,r);a?(B+=a[1],e+=p(a[0],n(r[0]))):e+=n(r[0]),t=L.lR.lastIndex,r=L.lR.exec(y)}return e+n(y.substr(t))}function h(){if(L.sL&&!w[L.sL])return n(y);var e=L.sL?s(L.sL,y,!0,M[L.sL]):l(y);return L.r>0&&(B+=e.r),"continuous"==L.subLanguageMode&&(M[L.sL]=e.top),p(e.language,e.value,!1,!0)}function b(){return void 0!==L.sL?h():d()}function v(e,t){var r=e.cN?p(e.cN,"",!0):"";e.rB?(k+=r,y=""):e.eB?(k+=n(t)+r,y=""):(k+=r,y=t),L=Object.create(e,{parent:{value:L}})}function m(e,t){if(y+=e,void 0===t)return k+=b(),0;var r=o(t,L);if(r)return k+=b(),v(r,t),r.rB?0:t.length;var a=u(L,t);if(a){var i=L;i.rE||i.eE||(y+=t),k+=b();do L.cN&&(k+="</span>"),B+=L.r,L=L.parent;while(L!=a.parent);return i.eE&&(k+=n(t)),y="",a.starts&&v(a.starts,""),i.rE?0:t.length}if(f(t,L))throw new Error('Illegal lexeme "'+t+'" for mode "'+(L.cN||"<unnamed>")+'"');return y+=t,t.length||1}var E=N(e);if(!E)throw new Error('Unknown language: "'+e+'"');c(E);var R,L=i||E,M={},k="";for(R=L;R!=E;R=R.parent)R.cN&&(k=p(R.cN,"",!0)+k);var y="",B=0;try{for(var C,j,I=0;;){if(L.t.lastIndex=I,C=L.t.exec(t),!C)break;j=m(t.substr(I,C.index-I),C[0]),I=C.index+j}for(m(t.substr(I)),R=L;R.parent;R=R.parent)R.cN&&(k+="</span>");return{r:B,value:k,language:e,top:L}}catch(S){if(-1!=S.message.indexOf("Illegal"))return{r:0,value:n(t)};throw S}}function l(e,t){t=t||x.languages||Object.keys(w);var r={r:0,value:n(e)},a=r;return t.forEach(function(n){if(N(n)){var t=s(n,e,!1);t.language=n,t.r>a.r&&(a=t),t.r>r.r&&(a=r,r=t)}}),a.language&&(r.second_best=a),r}function f(e){return x.tabReplace&&(e=e.replace(/^((<[^>]+>|\t)+)/gm,function(e,n){return n.replace(/\t/g,x.tabReplace)})),x.useBR&&(e=e.replace(/\n/g,"<br>")),e}function g(e,n,t){var r=n?E[n]:t,a=[e.trim()];return e.match(/\bhljs\b/)||a.push("hljs"),-1===e.indexOf(r)&&a.push(r),a.join(" ").trim()}function p(e){var n=a(e);if(!/no(-?)highlight|plain|text/.test(n)){var t;x.useBR?(t=document.createElementNS("http://www.w3.org/1999/xhtml","div"),t.innerHTML=e.innerHTML.replace(/\n/g,"").replace(/<br[ \/]*>/g,"\n")):t=e;var r=t.textContent,i=n?s(n,r,!0):l(r),c=o(t);if(c.length){var p=document.createElementNS("http://www.w3.org/1999/xhtml","div");p.innerHTML=i.value,i.value=u(c,o(p),r)}i.value=f(i.value),e.innerHTML=i.value,e.className=g(e.className,n,i.language),e.result={language:i.language,re:i.r},i.second_best&&(e.second_best={language:i.second_best.language,re:i.second_best.r})}}function d(e){x=i(x,e)}function h(){if(!h.called){h.called=!0;var e=document.querySelectorAll("pre code");Array.prototype.forEach.call(e,p)}}function b(){addEventListener("DOMContentLoaded",h,!1),addEventListener("load",h,!1)}function v(n,t){var r=w[n]=t(e);r.aliases&&r.aliases.forEach(function(e){E[e]=n})}function m(){return Object.keys(w)}function N(e){return w[e]||w[E[e]]}var x={classPrefix:"hljs-",tabReplace:null,useBR:!1,languages:void 0},w={},E={};return e.highlight=s,e.highlightAuto=l,e.fixMarkup=f,e.highlightBlock=p,e.configure=d,e.initHighlighting=h,e.initHighlightingOnLoad=b,e.registerLanguage=v,e.listLanguages=m,e.getLanguage=N,e.inherit=i,e.IR="[a-zA-Z]\\w*",e.UIR="[a-zA-Z_]\\w*",e.NR="\\b\\d+(\\.\\d+)?",e.CNR="\\b(0[xX][a-fA-F0-9]+|(\\d+(\\.\\d*)?|\\.\\d+)([eE][-+]?\\d+)?)",e.BNR="\\b(0b[01]+)",e.RSR="!|!=|!==|%|%=|&|&&|&=|\\*|\\*=|\\+|\\+=|,|-|-=|/=|/|:|;|<<|<<=|<=|<|===|==|=|>>>=|>>=|>=|>>>|>>|>|\\?|\\[|\\{|\\(|\\^|\\^=|\\||\\|=|\\|\\||~",e.BE={b:"\\\\[\\s\\S]",r:0},e.ASM={cN:"string",b:"'",e:"'",i:"\\n",c:[e.BE]},e.QSM={cN:"string",b:'"',e:'"',i:"\\n",c:[e.BE]},e.PWM={b:/\b(a|an|the|are|I|I'm|isn't|don't|doesn't|won't|but|just|should|pretty|simply|enough|gonna|going|wtf|so|such)\b/},e.C=function(n,t,r){var a=e.inherit({cN:"comment",b:n,e:t,c:[]},r||{});return a.c.push(e.PWM),a},e.CLCM=e.C("//","$"),e.CBCM=e.C("/\\*","\\*/"),e.HCM=e.C("#","$"),e.NM={cN:"number",b:e.NR,r:0},e.CNM={cN:"number",b:e.CNR,r:0},e.BNM={cN:"number",b:e.BNR,r:0},e.CSSNM={cN:"number",b:e.NR+"(%|em|ex|ch|rem|vw|vh|vmin|vmax|cm|mm|in|pt|pc|px|deg|grad|rad|turn|s|ms|Hz|kHz|dpi|dpcm|dppx)?",r:0},e.RM={cN:"regexp",b:/\//,e:/\/[gimuy]*/,i:/\n/,c:[e.BE,{b:/\[/,e:/\]/,r:0,c:[e.BE]}]},e.TM={cN:"title",b:e.IR,r:0},e.UTM={cN:"title",b:e.UIR,r:0},e});hljs.registerLanguage("objectivec",function(e){var t={cN:"built_in",b:"(AV|CA|CF|CG|CI|MK|MP|NS|UI)\\w+"},i={keyword:"int float while char export sizeof typedef const struct for union unsigned long volatile static bool mutable if do return goto void enum else break extern asm case short default double register explicit signed typename this switch continue wchar_t inline readonly assign readwrite self @synchronized id typeof nonatomic super unichar IBOutlet IBAction strong weak copy in out inout bycopy byref oneway __strong __weak __block __autoreleasing @private @protected @public @try @property @end @throw @catch @finally @autoreleasepool @synthesize @dynamic @selector @optional @required",literal:"false true FALSE TRUE nil YES NO NULL",built_in:"BOOL dispatch_once_t dispatch_queue_t dispatch_sync dispatch_async dispatch_once"},o=/[a-zA-Z@][a-zA-Z0-9_]*/,n="@interface @class @protocol @implementation";return{aliases:["m","mm","objc","obj-c"],k:i,l:o,i:"</",c:[t,e.CLCM,e.CBCM,e.CNM,e.QSM,{cN:"string",v:[{b:'@"',e:'"',i:"\\n",c:[e.BE]},{b:"'",e:"[^\\\\]'",i:"[^\\\\][^']"}]},{cN:"preprocessor",b:"#",e:"$",c:[{cN:"title",v:[{b:'"',e:'"'},{b:"<",e:">"}]}]},{cN:"class",b:"("+n.split(" ").join("|")+")\\b",e:"({|$)",eE:!0,k:n,l:o,c:[e.UTM]},{cN:"variable",b:"\\."+e.UIR,r:0}]}});hljs.registerLanguage("sql",function(e){var t=e.C("--","$");return{cI:!0,i:/[<>]/,c:[{cN:"operator",bK:"begin end start commit rollback savepoint lock alter create drop rename call delete do handler insert load replace select truncate update set show pragma grant merge describe use explain help declare prepare execute deallocate savepoint release unlock purge reset change stop analyze cache flush optimize repair kill install uninstall checksum restore check backup revoke",e:/;/,eW:!0,k:{keyword:"abs absolute acos action add adddate addtime aes_decrypt aes_encrypt after aggregate all allocate alter analyze and any are as asc ascii asin assertion at atan atan2 atn2 authorization authors avg backup before begin benchmark between bin binlog bit_and bit_count bit_length bit_or bit_xor both by cache call cascade cascaded case cast catalog ceil ceiling chain change changed char_length character_length charindex charset check checksum checksum_agg choose close coalesce coercibility collate collation collationproperty column columns columns_updated commit compress concat concat_ws concurrent connect connection connection_id consistent constraint constraints continue contributors conv convert convert_tz corresponding cos cot count count_big crc32 create cross cume_dist curdate current current_date current_time current_timestamp current_user cursor curtime data database databases datalength date_add date_format date_sub dateadd datediff datefromparts datename datepart datetime2fromparts datetimeoffsetfromparts day dayname dayofmonth dayofweek dayofyear deallocate declare decode default deferrable deferred degrees delayed delete des_decrypt des_encrypt des_key_file desc describe descriptor diagnostics difference disconnect distinct distinctrow div do domain double drop dumpfile each else elt enclosed encode encrypt end end-exec engine engines eomonth errors escape escaped event eventdata events except exception exec execute exists exp explain export_set extended external extract fast fetch field fields find_in_set first first_value floor flush for force foreign format found found_rows from from_base64 from_days from_unixtime full function get get_format get_lock getdate getutcdate global go goto grant grants greatest group group_concat grouping grouping_id gtid_subset gtid_subtract handler having help hex high_priority hosts hour ident_current ident_incr ident_seed identified identity if ifnull ignore iif ilike immediate in index indicator inet6_aton inet6_ntoa inet_aton inet_ntoa infile initially inner innodb input insert install instr intersect into is is_free_lock is_ipv4 is_ipv4_compat is_ipv4_mapped is_not is_not_null is_used_lock isdate isnull isolation join key kill language last last_day last_insert_id last_value lcase lead leading least leaves left len lenght level like limit lines ln load load_file local localtime localtimestamp locate lock log log10 log2 logfile logs low_priority lower lpad ltrim make_set makedate maketime master master_pos_wait match matched max md5 medium merge microsecond mid min minute mod mode module month monthname mutex name_const names national natural nchar next no no_write_to_binlog not now nullif nvarchar oct octet_length of old_password on only open optimize option optionally or ord order outer outfile output pad parse partial partition password patindex percent_rank percentile_cont percentile_disc period_add period_diff pi plugin position pow power pragma precision prepare preserve primary prior privileges procedure procedure_analyze processlist profile profiles public publishingservername purge quarter query quick quote quotename radians rand read references regexp relative relaylog release release_lock rename repair repeat replace replicate reset restore restrict return returns reverse revoke right rlike rollback rollup round row row_count rows rpad rtrim savepoint schema scroll sec_to_time second section select serializable server session session_user set sha sha1 sha2 share show sign sin size slave sleep smalldatetimefromparts snapshot some soname soundex sounds_like space sql sql_big_result sql_buffer_result sql_cache sql_calc_found_rows sql_no_cache sql_small_result sql_variant_property sqlstate sqrt square start starting status std stddev stddev_pop stddev_samp stdev stdevp stop str str_to_date straight_join strcmp string stuff subdate substr substring subtime subtring_index sum switchoffset sysdate sysdatetime sysdatetimeoffset system_user sysutcdatetime table tables tablespace tan temporary terminated tertiary_weights then time time_format time_to_sec timediff timefromparts timestamp timestampadd timestampdiff timezone_hour timezone_minute to to_base64 to_days to_seconds todatetimeoffset trailing transaction translation trigger trigger_nestlevel triggers trim truncate try_cast try_convert try_parse ucase uncompress uncompressed_length unhex unicode uninstall union unique unix_timestamp unknown unlock update upgrade upped upper usage use user user_resources using utc_date utc_time utc_timestamp uuid uuid_short validate_password_strength value values var var_pop var_samp variables variance varp version view warnings week weekday weekofyear weight_string when whenever where with work write xml xor year yearweek zon",literal:"true false null",built_in:"array bigint binary bit blob boolean char character date dec decimal float int integer interval number numeric real serial smallint varchar varying int8 serial8 text"},c:[{cN:"string",b:"'",e:"'",c:[e.BE,{b:"''"}]},{cN:"string",b:'"',e:'"',c:[e.BE,{b:'""'}]},{cN:"string",b:"`",e:"`",c:[e.BE]},e.CNM,e.CBCM,t]},e.CBCM,t]}});hljs.registerLanguage("javascript",function(e){return{aliases:["js"],k:{keyword:"in of if for while finally var new function do return void else break catch instanceof with throw case default try this switch continue typeof delete let yield const export super debugger as await",literal:"true false null undefined NaN Infinity",built_in:"eval isFinite isNaN parseFloat parseInt decodeURI decodeURIComponent encodeURI encodeURIComponent escape unescape Object Function Boolean Error EvalError InternalError RangeError ReferenceError StopIteration SyntaxError TypeError URIError Number Math Date String RegExp Array Float32Array Float64Array Int16Array Int32Array Int8Array Uint16Array Uint32Array Uint8Array Uint8ClampedArray ArrayBuffer DataView JSON Intl arguments require module console window document Symbol Set Map WeakSet WeakMap Proxy Reflect Promise"},c:[{cN:"pi",r:10,v:[{b:/^\s*('|")use strict('|")/},{b:/^\s*('|")use asm('|")/}]},e.ASM,e.QSM,{cN:"string",b:"`",e:"`",c:[e.BE,{cN:"subst",b:"\\$\\{",e:"\\}"}]},e.CLCM,e.CBCM,{cN:"number",b:"\\b(0[xXbBoO][a-fA-F0-9]+|(\\d+(\\.\\d*)?|\\.\\d+)([eE][-+]?\\d+)?)",r:0},{b:"("+e.RSR+"|\\b(case|return|throw)\\b)\\s*",k:"return throw case",c:[e.CLCM,e.CBCM,e.RM,{b:/</,e:/>\s*[);\]]/,r:0,sL:"xml"}],r:0},{cN:"function",bK:"function",e:/\{/,eE:!0,c:[e.inherit(e.TM,{b:/[A-Za-z$_][0-9A-Za-z$_]*/}),{cN:"params",b:/\(/,e:/\)/,c:[e.CLCM,e.CBCM],i:/["'\(]/}],i:/\[|%/},{b:/\$[(.]/},{b:"\\."+e.IR,r:0},{bK:"import",e:"[;$]",k:"import from as",c:[e.ASM,e.QSM]},{cN:"class",bK:"class",e:/[{;=]/,eE:!0,i:/[:"\[\]]/,c:[{bK:"extends"},e.UTM]}]}});hljs.registerLanguage("scss",function(e){{var t="[a-zA-Z-][a-zA-Z0-9_-]*",i={cN:"variable",b:"(\\$"+t+")\\b"},r={cN:"function",b:t+"\\(",rB:!0,eE:!0,e:"\\("},o={cN:"hexcolor",b:"#[0-9A-Fa-f]+"};({cN:"attribute",b:"[A-Z\\_\\.\\-]+",e:":",eE:!0,i:"[^\\s]",starts:{cN:"value",eW:!0,eE:!0,c:[r,o,e.CSSNM,e.QSM,e.ASM,e.CBCM,{cN:"important",b:"!important"}]}})}return{cI:!0,i:"[=/|']",c:[e.CLCM,e.CBCM,r,{cN:"id",b:"\\#[A-Za-z0-9_-]+",r:0},{cN:"class",b:"\\.[A-Za-z0-9_-]+",r:0},{cN:"attr_selector",b:"\\[",e:"\\]",i:"$"},{cN:"tag",b:"\\b(a|abbr|acronym|address|area|article|aside|audio|b|base|big|blockquote|body|br|button|canvas|caption|cite|code|col|colgroup|command|datalist|dd|del|details|dfn|div|dl|dt|em|embed|fieldset|figcaption|figure|footer|form|frame|frameset|(h[1-6])|head|header|hgroup|hr|html|i|iframe|img|input|ins|kbd|keygen|label|legend|li|link|map|mark|meta|meter|nav|noframes|noscript|object|ol|optgroup|option|output|p|param|pre|progress|q|rp|rt|ruby|samp|script|section|select|small|span|strike|strong|style|sub|sup|table|tbody|td|textarea|tfoot|th|thead|time|title|tr|tt|ul|var|video)\\b",r:0},{cN:"pseudo",b:":(visited|valid|root|right|required|read-write|read-only|out-range|optional|only-of-type|only-child|nth-of-type|nth-last-of-type|nth-last-child|nth-child|not|link|left|last-of-type|last-child|lang|invalid|indeterminate|in-range|hover|focus|first-of-type|first-line|first-letter|first-child|first|enabled|empty|disabled|default|checked|before|after|active)"},{cN:"pseudo",b:"::(after|before|choices|first-letter|first-line|repeat-index|repeat-item|selection|value)"},i,{cN:"attribute",b:"\\b(z-index|word-wrap|word-spacing|word-break|width|widows|white-space|visibility|vertical-align|unicode-bidi|transition-timing-function|transition-property|transition-duration|transition-delay|transition|transform-style|transform-origin|transform|top|text-underline-position|text-transform|text-shadow|text-rendering|text-overflow|text-indent|text-decoration-style|text-decoration-line|text-decoration-color|text-decoration|text-align-last|text-align|tab-size|table-layout|right|resize|quotes|position|pointer-events|perspective-origin|perspective|page-break-inside|page-break-before|page-break-after|padding-top|padding-right|padding-left|padding-bottom|padding|overflow-y|overflow-x|overflow-wrap|overflow|outline-width|outline-style|outline-offset|outline-color|outline|orphans|order|opacity|object-position|object-fit|normal|none|nav-up|nav-right|nav-left|nav-index|nav-down|min-width|min-height|max-width|max-height|mask|marks|margin-top|margin-right|margin-left|margin-bottom|margin|list-style-type|list-style-position|list-style-image|list-style|line-height|letter-spacing|left|justify-content|initial|inherit|ime-mode|image-orientation|image-resolution|image-rendering|icon|hyphens|height|font-weight|font-variant-ligatures|font-variant|font-style|font-stretch|font-size-adjust|font-size|font-language-override|font-kerning|font-feature-settings|font-family|font|float|flex-wrap|flex-shrink|flex-grow|flex-flow|flex-direction|flex-basis|flex|filter|empty-cells|display|direction|cursor|counter-reset|counter-increment|content|column-width|column-span|column-rule-width|column-rule-style|column-rule-color|column-rule|column-gap|column-fill|column-count|columns|color|clip-path|clip|clear|caption-side|break-inside|break-before|break-after|box-sizing|box-shadow|box-decoration-break|bottom|border-width|border-top-width|border-top-style|border-top-right-radius|border-top-left-radius|border-top-color|border-top|border-style|border-spacing|border-right-width|border-right-style|border-right-color|border-right|border-radius|border-left-width|border-left-style|border-left-color|border-left|border-image-width|border-image-source|border-image-slice|border-image-repeat|border-image-outset|border-image|border-color|border-collapse|border-bottom-width|border-bottom-style|border-bottom-right-radius|border-bottom-left-radius|border-bottom-color|border-bottom|border|background-size|background-repeat|background-position|background-origin|background-image|background-color|background-clip|background-attachment|background-blend-mode|background|backface-visibility|auto|animation-timing-function|animation-play-state|animation-name|animation-iteration-count|animation-fill-mode|animation-duration|animation-direction|animation-delay|animation|align-self|align-items|align-content)\\b",i:"[^\\s]"},{cN:"value",b:"\\b(whitespace|wait|w-resize|visible|vertical-text|vertical-ideographic|uppercase|upper-roman|upper-alpha|underline|transparent|top|thin|thick|text|text-top|text-bottom|tb-rl|table-header-group|table-footer-group|sw-resize|super|strict|static|square|solid|small-caps|separate|se-resize|scroll|s-resize|rtl|row-resize|ridge|right|repeat|repeat-y|repeat-x|relative|progress|pointer|overline|outside|outset|oblique|nowrap|not-allowed|normal|none|nw-resize|no-repeat|no-drop|newspaper|ne-resize|n-resize|move|middle|medium|ltr|lr-tb|lowercase|lower-roman|lower-alpha|loose|list-item|line|line-through|line-edge|lighter|left|keep-all|justify|italic|inter-word|inter-ideograph|inside|inset|inline|inline-block|inherit|inactive|ideograph-space|ideograph-parenthesis|ideograph-numeric|ideograph-alpha|horizontal|hidden|help|hand|groove|fixed|ellipsis|e-resize|double|dotted|distribute|distribute-space|distribute-letter|distribute-all-lines|disc|disabled|default|decimal|dashed|crosshair|collapse|col-resize|circle|char|center|capitalize|break-word|break-all|bottom|both|bolder|bold|block|bidi-override|below|baseline|auto|always|all-scroll|absolute|table|table-cell)\\b"},{cN:"value",b:":",e:";",c:[r,i,o,e.CSSNM,e.QSM,e.ASM,{cN:"important",b:"!important"}]},{cN:"at_rule",b:"@",e:"[{;]",k:"mixin include extend for if else each while charset import debug media page content font-face namespace warn",c:[r,i,e.QSM,e.ASM,o,e.CSSNM,{cN:"preprocessor",b:"\\s[A-Za-z0-9_.-]+",r:0}]}]}});hljs.registerLanguage("mel",function(e){return{k:"int float string vector matrix if else switch case default while do for in break continue global proc return about abs addAttr addAttributeEditorNodeHelp addDynamic addNewShelfTab addPP addPanelCategory addPrefixToName advanceToNextDrivenKey affectedNet affects aimConstraint air alias aliasAttr align alignCtx alignCurve alignSurface allViewFit ambientLight angle angleBetween animCone animCurveEditor animDisplay animView annotate appendStringArray applicationName applyAttrPreset applyTake arcLenDimContext arcLengthDimension arclen arrayMapper art3dPaintCtx artAttrCtx artAttrPaintVertexCtx artAttrSkinPaintCtx artAttrTool artBuildPaintMenu artFluidAttrCtx artPuttyCtx artSelectCtx artSetPaintCtx artUserPaintCtx assignCommand assignInputDevice assignViewportFactories attachCurve attachDeviceAttr attachSurface attrColorSliderGrp attrCompatibility attrControlGrp attrEnumOptionMenu attrEnumOptionMenuGrp attrFieldGrp attrFieldSliderGrp attrNavigationControlGrp attrPresetEditWin attributeExists attributeInfo attributeMenu attributeQuery autoKeyframe autoPlace bakeClip bakeFluidShading bakePartialHistory bakeResults bakeSimulation basename basenameEx batchRender bessel bevel bevelPlus binMembership bindSkin blend2 blendShape blendShapeEditor blendShapePanel blendTwoAttr blindDataType boneLattice boundary boxDollyCtx boxZoomCtx bufferCurve buildBookmarkMenu buildKeyframeMenu button buttonManip CBG cacheFile cacheFileCombine cacheFileMerge cacheFileTrack camera cameraView canCreateManip canvas capitalizeString catch catchQuiet ceil changeSubdivComponentDisplayLevel changeSubdivRegion channelBox character characterMap characterOutlineEditor characterize chdir checkBox checkBoxGrp checkDefaultRenderGlobals choice circle circularFillet clamp clear clearCache clip clipEditor clipEditorCurrentTimeCtx clipSchedule clipSchedulerOutliner clipTrimBefore closeCurve closeSurface cluster cmdFileOutput cmdScrollFieldExecuter cmdScrollFieldReporter cmdShell coarsenSubdivSelectionList collision color colorAtPoint colorEditor colorIndex colorIndexSliderGrp colorSliderButtonGrp colorSliderGrp columnLayout commandEcho commandLine commandPort compactHairSystem componentEditor compositingInterop computePolysetVolume condition cone confirmDialog connectAttr connectControl connectDynamic connectJoint connectionInfo constrain constrainValue constructionHistory container containsMultibyte contextInfo control convertFromOldLayers convertIffToPsd convertLightmap convertSolidTx convertTessellation convertUnit copyArray copyFlexor copyKey copySkinWeights cos cpButton cpCache cpClothSet cpCollision cpConstraint cpConvClothToMesh cpForces cpGetSolverAttr cpPanel cpProperty cpRigidCollisionFilter cpSeam cpSetEdit cpSetSolverAttr cpSolver cpSolverTypes cpTool cpUpdateClothUVs createDisplayLayer createDrawCtx createEditor createLayeredPsdFile createMotionField createNewShelf createNode createRenderLayer createSubdivRegion cross crossProduct ctxAbort ctxCompletion ctxEditMode ctxTraverse currentCtx currentTime currentTimeCtx currentUnit curve curveAddPtCtx curveCVCtx curveEPCtx curveEditorCtx curveIntersect curveMoveEPCtx curveOnSurface curveSketchCtx cutKey cycleCheck cylinder dagPose date defaultLightListCheckBox defaultNavigation defineDataServer defineVirtualDevice deformer deg_to_rad delete deleteAttr deleteShadingGroupsAndMaterials deleteShelfTab deleteUI deleteUnusedBrushes delrandstr detachCurve detachDeviceAttr detachSurface deviceEditor devicePanel dgInfo dgdirty dgeval dgtimer dimWhen directKeyCtx directionalLight dirmap dirname disable disconnectAttr disconnectJoint diskCache displacementToPoly displayAffected displayColor displayCull displayLevelOfDetail displayPref displayRGBColor displaySmoothness displayStats displayString displaySurface distanceDimContext distanceDimension doBlur dolly dollyCtx dopeSheetEditor dot dotProduct doubleProfileBirailSurface drag dragAttrContext draggerContext dropoffLocator duplicate duplicateCurve duplicateSurface dynCache dynControl dynExport dynExpression dynGlobals dynPaintEditor dynParticleCtx dynPref dynRelEdPanel dynRelEditor dynamicLoad editAttrLimits editDisplayLayerGlobals editDisplayLayerMembers editRenderLayerAdjustment editRenderLayerGlobals editRenderLayerMembers editor editorTemplate effector emit emitter enableDevice encodeString endString endsWith env equivalent equivalentTol erf error eval evalDeferred evalEcho event exactWorldBoundingBox exclusiveLightCheckBox exec executeForEachObject exists exp expression expressionEditorListen extendCurve extendSurface extrude fcheck fclose feof fflush fgetline fgetword file fileBrowserDialog fileDialog fileExtension fileInfo filetest filletCurve filter filterCurve filterExpand filterStudioImport findAllIntersections findAnimCurves findKeyframe findMenuItem findRelatedSkinCluster finder firstParentOf fitBspline flexor floatEq floatField floatFieldGrp floatScrollBar floatSlider floatSlider2 floatSliderButtonGrp floatSliderGrp floor flow fluidCacheInfo fluidEmitter fluidVoxelInfo flushUndo fmod fontDialog fopen formLayout format fprint frameLayout fread freeFormFillet frewind fromNativePath fwrite gamma gauss geometryConstraint getApplicationVersionAsFloat getAttr getClassification getDefaultBrush getFileList getFluidAttr getInputDeviceRange getMayaPanelTypes getModifiers getPanel getParticleAttr getPluginResource getenv getpid glRender glRenderEditor globalStitch gmatch goal gotoBindPose grabColor gradientControl gradientControlNoAttr graphDollyCtx graphSelectContext graphTrackCtx gravity grid gridLayout group groupObjectsByName HfAddAttractorToAS HfAssignAS HfBuildEqualMap HfBuildFurFiles HfBuildFurImages HfCancelAFR HfConnectASToHF HfCreateAttractor HfDeleteAS HfEditAS HfPerformCreateAS HfRemoveAttractorFromAS HfSelectAttached HfSelectAttractors HfUnAssignAS hardenPointCurve hardware hardwareRenderPanel headsUpDisplay headsUpMessage help helpLine hermite hide hilite hitTest hotBox hotkey hotkeyCheck hsv_to_rgb hudButton hudSlider hudSliderButton hwReflectionMap hwRender hwRenderLoad hyperGraph hyperPanel hyperShade hypot iconTextButton iconTextCheckBox iconTextRadioButton iconTextRadioCollection iconTextScrollList iconTextStaticLabel ikHandle ikHandleCtx ikHandleDisplayScale ikSolver ikSplineHandleCtx ikSystem ikSystemInfo ikfkDisplayMethod illustratorCurves image imfPlugins inheritTransform insertJoint insertJointCtx insertKeyCtx insertKnotCurve insertKnotSurface instance instanceable instancer intField intFieldGrp intScrollBar intSlider intSliderGrp interToUI internalVar intersect iprEngine isAnimCurve isConnected isDirty isParentOf isSameObject isTrue isValidObjectName isValidString isValidUiName isolateSelect itemFilter itemFilterAttr itemFilterRender itemFilterType joint jointCluster jointCtx jointDisplayScale jointLattice keyTangent keyframe keyframeOutliner keyframeRegionCurrentTimeCtx keyframeRegionDirectKeyCtx keyframeRegionDollyCtx keyframeRegionInsertKeyCtx keyframeRegionMoveKeyCtx keyframeRegionScaleKeyCtx keyframeRegionSelectKeyCtx keyframeRegionSetKeyCtx keyframeRegionTrackCtx keyframeStats lassoContext lattice latticeDeformKeyCtx launch launchImageEditor layerButton layeredShaderPort layeredTexturePort layout layoutDialog lightList lightListEditor lightListPanel lightlink lineIntersection linearPrecision linstep listAnimatable listAttr listCameras listConnections listDeviceAttachments listHistory listInputDeviceAxes listInputDeviceButtons listInputDevices listMenuAnnotation listNodeTypes listPanelCategories listRelatives listSets listTransforms listUnselected listerEditor loadFluid loadNewShelf loadPlugin loadPluginLanguageResources loadPrefObjects localizedPanelLabel lockNode loft log longNameOf lookThru ls lsThroughFilter lsType lsUI Mayatomr mag makeIdentity makeLive makePaintable makeRoll makeSingleSurface makeTubeOn makebot manipMoveContext manipMoveLimitsCtx manipOptions manipRotateContext manipRotateLimitsCtx manipScaleContext manipScaleLimitsCtx marker match max memory menu menuBarLayout menuEditor menuItem menuItemToShelf menuSet menuSetPref messageLine min minimizeApp mirrorJoint modelCurrentTimeCtx modelEditor modelPanel mouse movIn movOut move moveIKtoFK moveKeyCtx moveVertexAlongDirection multiProfileBirailSurface mute nParticle nameCommand nameField namespace namespaceInfo newPanelItems newton nodeCast nodeIconButton nodeOutliner nodePreset nodeType noise nonLinear normalConstraint normalize nurbsBoolean nurbsCopyUVSet nurbsCube nurbsEditUV nurbsPlane nurbsSelect nurbsSquare nurbsToPoly nurbsToPolygonsPref nurbsToSubdiv nurbsToSubdivPref nurbsUVSet nurbsViewDirectionVector objExists objectCenter objectLayer objectType objectTypeUI obsoleteProc oceanNurbsPreviewPlane offsetCurve offsetCurveOnSurface offsetSurface openGLExtension openMayaPref optionMenu optionMenuGrp optionVar orbit orbitCtx orientConstraint outlinerEditor outlinerPanel overrideModifier paintEffectsDisplay pairBlend palettePort paneLayout panel panelConfiguration panelHistory paramDimContext paramDimension paramLocator parent parentConstraint particle particleExists particleInstancer particleRenderInfo partition pasteKey pathAnimation pause pclose percent performanceOptions pfxstrokes pickWalk picture pixelMove planarSrf plane play playbackOptions playblast plugAttr plugNode pluginInfo pluginResourceUtil pointConstraint pointCurveConstraint pointLight pointMatrixMult pointOnCurve pointOnSurface pointPosition poleVectorConstraint polyAppend polyAppendFacetCtx polyAppendVertex polyAutoProjection polyAverageNormal polyAverageVertex polyBevel polyBlendColor polyBlindData polyBoolOp polyBridgeEdge polyCacheMonitor polyCheck polyChipOff polyClipboard polyCloseBorder polyCollapseEdge polyCollapseFacet polyColorBlindData polyColorDel polyColorPerVertex polyColorSet polyCompare polyCone polyCopyUV polyCrease polyCreaseCtx polyCreateFacet polyCreateFacetCtx polyCube polyCut polyCutCtx polyCylinder polyCylindricalProjection polyDelEdge polyDelFacet polyDelVertex polyDuplicateAndConnect polyDuplicateEdge polyEditUV polyEditUVShell polyEvaluate polyExtrudeEdge polyExtrudeFacet polyExtrudeVertex polyFlipEdge polyFlipUV polyForceUV polyGeoSampler polyHelix polyInfo polyInstallAction polyLayoutUV polyListComponentConversion polyMapCut polyMapDel polyMapSew polyMapSewMove polyMergeEdge polyMergeEdgeCtx polyMergeFacet polyMergeFacetCtx polyMergeUV polyMergeVertex polyMirrorFace polyMoveEdge polyMoveFacet polyMoveFacetUV polyMoveUV polyMoveVertex polyNormal polyNormalPerVertex polyNormalizeUV polyOptUvs polyOptions polyOutput polyPipe polyPlanarProjection polyPlane polyPlatonicSolid polyPoke polyPrimitive polyPrism polyProjection polyPyramid polyQuad polyQueryBlindData polyReduce polySelect polySelectConstraint polySelectConstraintMonitor polySelectCtx polySelectEditCtx polySeparate polySetToFaceNormal polySewEdge polyShortestPathCtx polySmooth polySoftEdge polySphere polySphericalProjection polySplit polySplitCtx polySplitEdge polySplitRing polySplitVertex polyStraightenUVBorder polySubdivideEdge polySubdivideFacet polyToSubdiv polyTorus polyTransfer polyTriangulate polyUVSet polyUnite polyWedgeFace popen popupMenu pose pow preloadRefEd print progressBar progressWindow projFileViewer projectCurve projectTangent projectionContext projectionManip promptDialog propModCtx propMove psdChannelOutliner psdEditTextureFile psdExport psdTextureFile putenv pwd python querySubdiv quit rad_to_deg radial radioButton radioButtonGrp radioCollection radioMenuItemCollection rampColorPort rand randomizeFollicles randstate rangeControl readTake rebuildCurve rebuildSurface recordAttr recordDevice redo reference referenceEdit referenceQuery refineSubdivSelectionList refresh refreshAE registerPluginResource rehash reloadImage removeJoint removeMultiInstance removePanelCategory rename renameAttr renameSelectionList renameUI render renderGlobalsNode renderInfo renderLayerButton renderLayerParent renderLayerPostProcess renderLayerUnparent renderManip renderPartition renderQualityNode renderSettings renderThumbnailUpdate renderWindowEditor renderWindowSelectContext renderer reorder reorderDeformers requires reroot resampleFluid resetAE resetPfxToPolyCamera resetTool resolutionNode retarget reverseCurve reverseSurface revolve rgb_to_hsv rigidBody rigidSolver roll rollCtx rootOf rot rotate rotationInterpolation roundConstantRadius rowColumnLayout rowLayout runTimeCommand runup sampleImage saveAllShelves saveAttrPreset saveFluid saveImage saveInitialState saveMenu savePrefObjects savePrefs saveShelf saveToolSettings scale scaleBrushBrightness scaleComponents scaleConstraint scaleKey scaleKeyCtx sceneEditor sceneUIReplacement scmh scriptCtx scriptEditorInfo scriptJob scriptNode scriptTable scriptToShelf scriptedPanel scriptedPanelType scrollField scrollLayout sculpt searchPathArray seed selLoadSettings select selectContext selectCurveCV selectKey selectKeyCtx selectKeyframeRegionCtx selectMode selectPref selectPriority selectType selectedNodes selectionConnection separator setAttr setAttrEnumResource setAttrMapping setAttrNiceNameResource setConstraintRestPosition setDefaultShadingGroup setDrivenKeyframe setDynamic setEditCtx setEditor setFluidAttr setFocus setInfinity setInputDeviceMapping setKeyCtx setKeyPath setKeyframe setKeyframeBlendshapeTargetWts setMenuMode setNodeNiceNameResource setNodeTypeFlag setParent setParticleAttr setPfxToPolyCamera setPluginResource setProject setStampDensity setStartupMessage setState setToolTo setUITemplate setXformManip sets shadingConnection shadingGeometryRelCtx shadingLightRelCtx shadingNetworkCompare shadingNode shapeCompare shelfButton shelfLayout shelfTabLayout shellField shortNameOf showHelp showHidden showManipCtx showSelectionInTitle showShadingGroupAttrEditor showWindow sign simplify sin singleProfileBirailSurface size sizeBytes skinCluster skinPercent smoothCurve smoothTangentSurface smoothstep snap2to2 snapKey snapMode snapTogetherCtx snapshot soft softMod softModCtx sort sound soundControl source spaceLocator sphere sphrand spotLight spotLightPreviewPort spreadSheetEditor spring sqrt squareSurface srtContext stackTrace startString startsWith stitchAndExplodeShell stitchSurface stitchSurfacePoints strcmp stringArrayCatenate stringArrayContains stringArrayCount stringArrayInsertAtIndex stringArrayIntersector stringArrayRemove stringArrayRemoveAtIndex stringArrayRemoveDuplicates stringArrayRemoveExact stringArrayToString stringToStringArray strip stripPrefixFromName stroke subdAutoProjection subdCleanTopology subdCollapse subdDuplicateAndConnect subdEditUV subdListComponentConversion subdMapCut subdMapSewMove subdMatchTopology subdMirror subdToBlind subdToPoly subdTransferUVsToCache subdiv subdivCrease subdivDisplaySmoothness substitute substituteAllString substituteGeometry substring surface surfaceSampler surfaceShaderList swatchDisplayPort switchTable symbolButton symbolCheckBox sysFile system tabLayout tan tangentConstraint texLatticeDeformContext texManipContext texMoveContext texMoveUVShellContext texRotateContext texScaleContext texSelectContext texSelectShortestPathCtx texSmudgeUVContext texWinToolCtx text textCurves textField textFieldButtonGrp textFieldGrp textManip textScrollList textToShelf textureDisplacePlane textureHairColor texturePlacementContext textureWindow threadCount threePointArcCtx timeControl timePort timerX toNativePath toggle toggleAxis toggleWindowVisibility tokenize tokenizeList tolerance tolower toolButton toolCollection toolDropped toolHasOptions toolPropertyWindow torus toupper trace track trackCtx transferAttributes transformCompare transformLimits translator trim trunc truncateFluidCache truncateHairCache tumble tumbleCtx turbulence twoPointArcCtx uiRes uiTemplate unassignInputDevice undo undoInfo ungroup uniform unit unloadPlugin untangleUV untitledFileName untrim upAxis updateAE userCtx uvLink uvSnapshot validateShelfName vectorize view2dToolCtx viewCamera viewClipPlane viewFit viewHeadOn viewLookAt viewManip viewPlace viewSet visor volumeAxis vortex waitCursor warning webBrowser webBrowserPrefs whatIs window windowPref wire wireContext workspace wrinkle wrinkleContext writeTake xbmLangPathList xform",i:"</",c:[e.CNM,e.ASM,e.QSM,{cN:"string",b:"`",e:"`",c:[e.BE]},{cN:"variable",v:[{b:"\\$\\d"},{b:"[\\$\\%\\@](\\^\\w\\b|#\\w+|[^\\s\\w{]|{\\w+}|\\w+)"},{b:"\\*(\\^\\w\\b|#\\w+|[^\\s\\w{]|{\\w+}|\\w+)",r:0}]},e.CLCM,e.CBCM]}});hljs.registerLanguage("d",function(e){var r={keyword:"abstract alias align asm assert auto body break byte case cast catch class const continue debug default delete deprecated do else enum export extern final finally for foreach foreach_reverse|10 goto if immutable import in inout int interface invariant is lazy macro mixin module new nothrow out override package pragma private protected public pure ref return scope shared static struct super switch synchronized template this throw try typedef typeid typeof union unittest version void volatile while with __FILE__ __LINE__ __gshared|10 __thread __traits __DATE__ __EOF__ __TIME__ __TIMESTAMP__ __VENDOR__ __VERSION__",built_in:"bool cdouble cent cfloat char creal dchar delegate double dstring float function idouble ifloat ireal long real short string ubyte ucent uint ulong ushort wchar wstring",literal:"false null true"},t="(0|[1-9][\\d_]*)",a="(0|[1-9][\\d_]*|\\d[\\d_]*|[\\d_]+?\\d)",i="0[bB][01_]+",n="([\\da-fA-F][\\da-fA-F_]*|_[\\da-fA-F][\\da-fA-F_]*)",c="0[xX]"+n,_="([eE][+-]?"+a+")",d="("+a+"(\\.\\d*|"+_+")|\\d+\\."+a+a+"|\\."+t+_+"?)",o="(0[xX]("+n+"\\."+n+"|\\.?"+n+")[pP][+-]?"+a+")",s="("+t+"|"+i+"|"+c+")",l="("+o+"|"+d+")",u="\\\\(['\"\\?\\\\abfnrtv]|u[\\dA-Fa-f]{4}|[0-7]{1,3}|x[\\dA-Fa-f]{2}|U[\\dA-Fa-f]{8})|&[a-zA-Z\\d]{2,};",b={cN:"number",b:"\\b"+s+"(L|u|U|Lu|LU|uL|UL)?",r:0},f={cN:"number",b:"\\b("+l+"([fF]|L|i|[fF]i|Li)?|"+s+"(i|[fF]i|Li))",r:0},g={cN:"string",b:"'("+u+"|.)",e:"'",i:"."},h={b:u,r:0},p={cN:"string",b:'"',c:[h],e:'"[cwd]?'},w={cN:"string",b:'[rq]"',e:'"[cwd]?',r:5},N={cN:"string",b:"`",e:"`[cwd]?"},A={cN:"string",b:'x"[\\da-fA-F\\s\\n\\r]*"[cwd]?',r:10},F={cN:"string",b:'q"\\{',e:'\\}"'},m={cN:"shebang",b:"^#!",e:"$",r:5},y={cN:"preprocessor",b:"#(line)",e:"$",r:5},L={cN:"keyword",b:"@[a-zA-Z_][a-zA-Z_\\d]*"},v=e.C("\\/\\+","\\+\\/",{c:["self"],r:10});return{l:e.UIR,k:r,c:[e.CLCM,e.CBCM,v,A,p,w,N,F,f,b,g,m,y,L]}});hljs.registerLanguage("ruleslanguage",function(T){return{k:{keyword:"BILL_PERIOD BILL_START BILL_STOP RS_EFFECTIVE_START RS_EFFECTIVE_STOP RS_JURIS_CODE RS_OPCO_CODE INTDADDATTRIBUTE|5 INTDADDVMSG|5 INTDBLOCKOP|5 INTDBLOCKOPNA|5 INTDCLOSE|5 INTDCOUNT|5 INTDCOUNTSTATUSCODE|5 INTDCREATEMASK|5 INTDCREATEDAYMASK|5 INTDCREATEFACTORMASK|5 INTDCREATEHANDLE|5 INTDCREATEOVERRIDEDAYMASK|5 INTDCREATEOVERRIDEMASK|5 INTDCREATESTATUSCODEMASK|5 INTDCREATETOUPERIOD|5 INTDDELETE|5 INTDDIPTEST|5 INTDEXPORT|5 INTDGETERRORCODE|5 INTDGETERRORMESSAGE|5 INTDISEQUAL|5 INTDJOIN|5 INTDLOAD|5 INTDLOADACTUALCUT|5 INTDLOADDATES|5 INTDLOADHIST|5 INTDLOADLIST|5 INTDLOADLISTDATES|5 INTDLOADLISTENERGY|5 INTDLOADLISTHIST|5 INTDLOADRELATEDCHANNEL|5 INTDLOADSP|5 INTDLOADSTAGING|5 INTDLOADUOM|5 INTDLOADUOMDATES|5 INTDLOADUOMHIST|5 INTDLOADVERSION|5 INTDOPEN|5 INTDREADFIRST|5 INTDREADNEXT|5 INTDRECCOUNT|5 INTDRELEASE|5 INTDREPLACE|5 INTDROLLAVG|5 INTDROLLPEAK|5 INTDSCALAROP|5 INTDSCALE|5 INTDSETATTRIBUTE|5 INTDSETDSTPARTICIPANT|5 INTDSETSTRING|5 INTDSETVALUE|5 INTDSETVALUESTATUS|5 INTDSHIFTSTARTTIME|5 INTDSMOOTH|5 INTDSORT|5 INTDSPIKETEST|5 INTDSUBSET|5 INTDTOU|5 INTDTOURELEASE|5 INTDTOUVALUE|5 INTDUPDATESTATS|5 INTDVALUE|5 STDEV INTDDELETEEX|5 INTDLOADEXACTUAL|5 INTDLOADEXCUT|5 INTDLOADEXDATES|5 INTDLOADEX|5 INTDLOADEXRELATEDCHANNEL|5 INTDSAVEEX|5 MVLOAD|5 MVLOADACCT|5 MVLOADACCTDATES|5 MVLOADACCTHIST|5 MVLOADDATES|5 MVLOADHIST|5 MVLOADLIST|5 MVLOADLISTDATES|5 MVLOADLISTHIST|5 IF FOR NEXT DONE SELECT END CALL ABORT CLEAR CHANNEL FACTOR LIST NUMBER OVERRIDE SET WEEK DISTRIBUTIONNODE ELSE WHEN THEN OTHERWISE IENUM CSV INCLUDE LEAVE RIDER SAVE DELETE NOVALUE SECTION WARN SAVE_UPDATE DETERMINANT LABEL REPORT REVENUE EACH IN FROM TOTAL CHARGE BLOCK AND OR CSV_FILE RATE_CODE AUXILIARY_DEMAND UIDACCOUNT RS BILL_PERIOD_SELECT HOURS_PER_MONTH INTD_ERROR_STOP SEASON_SCHEDULE_NAME ACCOUNTFACTOR ARRAYUPPERBOUND CALLSTOREDPROC GETADOCONNECTION GETCONNECT GETDATASOURCE GETQUALIFIER GETUSERID HASVALUE LISTCOUNT LISTOP LISTUPDATE LISTVALUE PRORATEFACTOR RSPRORATE SETBINPATH SETDBMONITOR WQ_OPEN BILLINGHOURS DATE DATEFROMFLOAT DATETIMEFROMSTRING DATETIMETOSTRING DATETOFLOAT DAY DAYDIFF DAYNAME DBDATETIME HOUR MINUTE MONTH MONTHDIFF MONTHHOURS MONTHNAME ROUNDDATE SAMEWEEKDAYLASTYEAR SECOND WEEKDAY WEEKDIFF YEAR YEARDAY YEARSTR COMPSUM HISTCOUNT HISTMAX HISTMIN HISTMINNZ HISTVALUE MAXNRANGE MAXRANGE MINRANGE COMPIKVA COMPKVA COMPKVARFROMKQKW COMPLF IDATTR FLAG LF2KW LF2KWH MAXKW POWERFACTOR READING2USAGE AVGSEASON MAXSEASON MONTHLYMERGE SEASONVALUE SUMSEASON ACCTREADDATES ACCTTABLELOAD CONFIGADD CONFIGGET CREATEOBJECT CREATEREPORT EMAILCLIENT EXPBLKMDMUSAGE EXPMDMUSAGE EXPORT_USAGE FACTORINEFFECT GETUSERSPECIFIEDSTOP INEFFECT ISHOLIDAY RUNRATE SAVE_PROFILE SETREPORTTITLE USEREXIT WATFORRUNRATE TO TABLE ACOS ASIN ATAN ATAN2 BITAND CEIL COS COSECANT COSH COTANGENT DIVQUOT DIVREM EXP FABS FLOOR FMOD FREPM FREXPN LOG LOG10 MAX MAXN MIN MINNZ MODF POW ROUND ROUND2VALUE ROUNDINT SECANT SIN SINH SQROOT TAN TANH FLOAT2STRING FLOAT2STRINGNC INSTR LEFT LEN LTRIM MID RIGHT RTRIM STRING STRINGNC TOLOWER TOUPPER TRIM NUMDAYS READ_DATE STAGING",built_in:"IDENTIFIER OPTIONS XML_ELEMENT XML_OP XML_ELEMENT_OF DOMDOCCREATE DOMDOCLOADFILE DOMDOCLOADXML DOMDOCSAVEFILE DOMDOCGETROOT DOMDOCADDPI DOMNODEGETNAME DOMNODEGETTYPE DOMNODEGETVALUE DOMNODEGETCHILDCT DOMNODEGETFIRSTCHILD DOMNODEGETSIBLING DOMNODECREATECHILDELEMENT DOMNODESETATTRIBUTE DOMNODEGETCHILDELEMENTCT DOMNODEGETFIRSTCHILDELEMENT DOMNODEGETSIBLINGELEMENT DOMNODEGETATTRIBUTECT DOMNODEGETATTRIBUTEI DOMNODEGETATTRIBUTEBYNAME DOMNODEGETBYNAME"},c:[T.CLCM,T.CBCM,T.ASM,T.QSM,T.CNM,{cN:"array",b:"#[a-zA-Z .]+"}]}});hljs.registerLanguage("actionscript",function(e){var a="[a-zA-Z_$][a-zA-Z0-9_$]*",c="([*]|[a-zA-Z_$][a-zA-Z0-9_$]*)",t={cN:"rest_arg",b:"[.]{3}",e:a,r:10};return{aliases:["as"],k:{keyword:"as break case catch class const continue default delete do dynamic each else extends final finally for function get if implements import in include instanceof interface internal is namespace native new override package private protected public return set static super switch this throw try typeof use var void while with",literal:"true false null undefined"},c:[e.ASM,e.QSM,e.CLCM,e.CBCM,e.CNM,{cN:"package",bK:"package",e:"{",c:[e.TM]},{cN:"class",bK:"class interface",e:"{",eE:!0,c:[{bK:"extends implements"},e.TM]},{cN:"preprocessor",bK:"import include",e:";"},{cN:"function",bK:"function",e:"[{;]",eE:!0,i:"\\S",c:[e.TM,{cN:"params",b:"\\(",e:"\\)",c:[e.ASM,e.QSM,e.CLCM,e.CBCM,t]},{cN:"type",b:":",e:c,r:10}]}]}});hljs.registerLanguage("coffeescript",function(e){var c={keyword:"in if for while finally new do return else break catch instanceof throw try this switch continue typeof delete debugger super then unless until loop of by when and or is isnt not",literal:"true false null undefined yes no on off",reserved:"case default function var void with const let enum export import native __hasProp __extends __slice __bind __indexOf",built_in:"npm require console print module global window document"},n="[A-Za-z$_][0-9A-Za-z$_]*",t={cN:"subst",b:/#\{/,e:/}/,k:c},r=[e.BNM,e.inherit(e.CNM,{starts:{e:"(\\s*/)?",r:0}}),{cN:"string",v:[{b:/'''/,e:/'''/,c:[e.BE]},{b:/'/,e:/'/,c:[e.BE]},{b:/"""/,e:/"""/,c:[e.BE,t]},{b:/"/,e:/"/,c:[e.BE,t]}]},{cN:"regexp",v:[{b:"///",e:"///",c:[t,e.HCM]},{b:"//[gim]*",r:0},{b:/\/(?![ *])(\\\/|.)*?\/[gim]*(?=\W|$)/}]},{cN:"property",b:"@"+n},{b:"`",e:"`",eB:!0,eE:!0,sL:"javascript"}];t.c=r;var i=e.inherit(e.TM,{b:n}),s="(\\(.*\\))?\\s*\\B[-=]>",o={cN:"params",b:"\\([^\\(]",rB:!0,c:[{b:/\(/,e:/\)/,k:c,c:["self"].concat(r)}]};return{aliases:["coffee","cson","iced"],k:c,i:/\/\*/,c:r.concat([e.C("###","###"),e.HCM,{cN:"function",b:"^\\s*"+n+"\\s*=\\s*"+s,e:"[-=]>",rB:!0,c:[i,o]},{b:/[:\(,=]\s*/,r:0,c:[{cN:"function",b:s,e:"[-=]>",rB:!0,c:[o]}]},{cN:"class",bK:"class",e:"$",i:/[:="\[\]]/,c:[{bK:"extends",eW:!0,i:/[:="\[\]]/,c:[i]},i]},{cN:"attribute",b:n+":",e:":",rB:!0,rE:!0,r:0}])}});hljs.registerLanguage("tex",function(c){var e={cN:"command",b:"\\\\[a-zA-Zа-яА-я]+[\\*]?"},m={cN:"command",b:"\\\\[^a-zA-Zа-яА-я0-9]"},r={cN:"special",b:"[{}\\[\\]\\&#~]",r:0};return{c:[{b:"\\\\[a-zA-Zа-яА-я]+[\\*]? *= *-?\\d*\\.?\\d+(pt|pc|mm|cm|in|dd|cc|ex|em)?",rB:!0,c:[e,m,{cN:"number",b:" *=",e:"-?\\d*\\.?\\d+(pt|pc|mm|cm|in|dd|cc|ex|em)?",eB:!0}],r:10},e,m,r,{cN:"formula",b:"\\$\\$",e:"\\$\\$",c:[e,m,r],r:0},{cN:"formula",b:"\\$",e:"\\$",c:[e,m,r],r:0},c.C("%","$",{r:0})]}});hljs.registerLanguage("go",function(e){var t={keyword:"break default func interface select case map struct chan else goto package switch const fallthrough if range type continue for import return var go defer",constant:"true false iota nil",typename:"bool byte complex64 complex128 float32 float64 int8 int16 int32 int64 string uint8 uint16 uint32 uint64 int uint uintptr rune",built_in:"append cap close complex copy imag len make new panic print println real recover delete"};return{aliases:["golang"],k:t,i:"</",c:[e.CLCM,e.CBCM,e.QSM,{cN:"string",b:"'",e:"[^\\\\]'"},{cN:"string",b:"`",e:"`"},{cN:"number",b:e.CNR+"[dflsi]?",r:0},e.CNM]}});hljs.registerLanguage("vbscript-html",function(s){return{sL:"xml",subLanguageMode:"continuous",c:[{b:"<%",e:"%>",sL:"vbscript"}]}});hljs.registerLanguage("haskell",function(e){var c=[e.C("--","$"),e.C("{-","-}",{c:["self"]})],a={cN:"pragma",b:"{-#",e:"#-}"},i={cN:"preprocessor",b:"^#",e:"$"},n={cN:"type",b:"\\b[A-Z][\\w']*",r:0},t={cN:"container",b:"\\(",e:"\\)",i:'"',c:[a,i,{cN:"type",b:"\\b[A-Z][\\w]*(\\((\\.\\.|,|\\w+)\\))?"},e.inherit(e.TM,{b:"[_a-z][\\w']*"})].concat(c)},l={cN:"container",b:"{",e:"}",c:t.c};return{aliases:["hs"],k:"let in if then else case of where do module import hiding qualified type data newtype deriving class instance as default infix infixl infixr foreign export ccall stdcall cplusplus jvm dotnet safe unsafe family forall mdo proc rec",c:[{cN:"module",b:"\\bmodule\\b",e:"where",k:"module where",c:[t].concat(c),i:"\\W\\.|;"},{cN:"import",b:"\\bimport\\b",e:"$",k:"import|0 qualified as hiding",c:[t].concat(c),i:"\\W\\.|;"},{cN:"class",b:"^(\\s*)?(class|instance)\\b",e:"where",k:"class family instance where",c:[n,t].concat(c)},{cN:"typedef",b:"\\b(data|(new)?type)\\b",e:"$",k:"data family type newtype deriving",c:[a,n,t,l].concat(c)},{cN:"default",bK:"default",e:"$",c:[n,t].concat(c)},{cN:"infix",bK:"infix infixl infixr",e:"$",c:[e.CNM].concat(c)},{cN:"foreign",b:"\\bforeign\\b",e:"$",k:"foreign import export ccall stdcall cplusplus jvm dotnet safe unsafe",c:[n,e.QSM].concat(c)},{cN:"shebang",b:"#!\\/usr\\/bin\\/env runhaskell",e:"$"},a,i,e.QSM,e.CNM,n,e.inherit(e.TM,{b:"^[_a-z][\\w']*"}),{b:"->|<-"}].concat(c)}});hljs.registerLanguage("scilab",function(e){var n=[e.CNM,{cN:"string",b:"'|\"",e:"'|\"",c:[e.BE,{b:"''"}]}];return{aliases:["sci"],k:{keyword:"abort break case clear catch continue do elseif else endfunction end for functionglobal if pause return resume select try then while%f %F %t %T %pi %eps %inf %nan %e %i %z %s",built_in:"abs and acos asin atan ceil cd chdir clearglobal cosh cos cumprod deff disp errorexec execstr exists exp eye gettext floor fprintf fread fsolve imag isdef isemptyisinfisnan isvector lasterror length load linspace list listfiles log10 log2 logmax min msprintf mclose mopen ones or pathconvert poly printf prod pwd rand realround sinh sin size gsort sprintf sqrt strcat strcmps tring sum system tanh tantype typename warning zeros matrix"},i:'("|#|/\\*|\\s+/\\w+)',c:[{cN:"function",bK:"function endfunction",e:"$",k:"function endfunction|10",c:[e.UTM,{cN:"params",b:"\\(",e:"\\)"}]},{cN:"transposed_variable",b:"[a-zA-Z_][a-zA-Z_0-9]*('+[\\.']*|[\\.']+)",e:"",r:0},{cN:"matrix",b:"\\[",e:"\\]'*[\\.']*",r:0,c:n},e.C("//","$")].concat(n)}});hljs.registerLanguage("profile",function(e){return{c:[e.CNM,{cN:"built_in",b:"{",e:"}$",eB:!0,eE:!0,c:[e.ASM,e.QSM],r:0},{cN:"filename",b:"[a-zA-Z_][\\da-zA-Z_]+\\.[\\da-zA-Z_]{1,3}",e:":",eE:!0},{cN:"header",b:"(ncalls|tottime|cumtime)",e:"$",k:"ncalls tottime|10 cumtime|10 filename",r:10},{cN:"summary",b:"function calls",e:"$",c:[e.CNM],r:10},e.ASM,e.QSM,{cN:"function",b:"\\(",e:"\\)$",c:[e.UTM],r:0}]}});hljs.registerLanguage("thrift",function(e){var t="bool byte i16 i32 i64 double string binary";return{k:{keyword:"namespace const typedef struct enum service exception void oneway set list map required optional",built_in:t,literal:"true false"},c:[e.QSM,e.NM,e.CLCM,e.CBCM,{cN:"class",bK:"struct enum service exception",e:/\{/,i:/\n/,c:[e.inherit(e.TM,{starts:{eW:!0,eE:!0}})]},{b:"\\b(set|list|map)\\s*<",e:">",k:t,c:["self"]}]}});hljs.registerLanguage("matlab",function(e){var a=[e.CNM,{cN:"string",b:"'",e:"'",c:[e.BE,{b:"''"}]}],s={r:0,c:[{cN:"operator",b:/'['\.]*/}]};return{k:{keyword:"break case catch classdef continue else elseif end enumerated events for function global if methods otherwise parfor persistent properties return spmd switch try while",built_in:"sin sind sinh asin asind asinh cos cosd cosh acos acosd acosh tan tand tanh atan atand atan2 atanh sec secd sech asec asecd asech csc cscd csch acsc acscd acsch cot cotd coth acot acotd acoth hypot exp expm1 log log1p log10 log2 pow2 realpow reallog realsqrt sqrt nthroot nextpow2 abs angle complex conj imag real unwrap isreal cplxpair fix floor ceil round mod rem sign airy besselj bessely besselh besseli besselk beta betainc betaln ellipj ellipke erf erfc erfcx erfinv expint gamma gammainc gammaln psi legendre cross dot factor isprime primes gcd lcm rat rats perms nchoosek factorial cart2sph cart2pol pol2cart sph2cart hsv2rgb rgb2hsv zeros ones eye repmat rand randn linspace logspace freqspace meshgrid accumarray size length ndims numel disp isempty isequal isequalwithequalnans cat reshape diag blkdiag tril triu fliplr flipud flipdim rot90 find sub2ind ind2sub bsxfun ndgrid permute ipermute shiftdim circshift squeeze isscalar isvector ans eps realmax realmin pi i inf nan isnan isinf isfinite j why compan gallery hadamard hankel hilb invhilb magic pascal rosser toeplitz vander wilkinson"},i:'(//|"|#|/\\*|\\s+/\\w+)',c:[{cN:"function",bK:"function",e:"$",c:[e.UTM,{cN:"params",b:"\\(",e:"\\)"},{cN:"params",b:"\\[",e:"\\]"}]},{b:/[a-zA-Z_][a-zA-Z_0-9]*'['\.]*/,rB:!0,r:0,c:[{b:/[a-zA-Z_][a-zA-Z_0-9]*/,r:0},s.c[0]]},{cN:"matrix",b:"\\[",e:"\\]",c:a,r:0,starts:s},{cN:"cell",b:"\\{",e:/}/,c:a,r:0,starts:s},{b:/\)/,r:0,starts:s},e.C("^\\s*\\%\\{\\s*$","^\\s*\\%\\}\\s*$"),e.C("\\%","$")].concat(a)}});hljs.registerLanguage("vbscript",function(e){return{aliases:["vbs"],cI:!0,k:{keyword:"call class const dim do loop erase execute executeglobal exit for each next function if then else on error option explicit new private property let get public randomize redim rem select case set stop sub while wend with end to elseif is or xor and not class_initialize class_terminate default preserve in me byval byref step resume goto",built_in:"lcase month vartype instrrev ubound setlocale getobject rgb getref string weekdayname rnd dateadd monthname now day minute isarray cbool round formatcurrency conversions csng timevalue second year space abs clng timeserial fixs len asc isempty maths dateserial atn timer isobject filter weekday datevalue ccur isdate instr datediff formatdatetime replace isnull right sgn array snumeric log cdbl hex chr lbound msgbox ucase getlocale cos cdate cbyte rtrim join hour oct typename trim strcomp int createobject loadpicture tan formatnumber mid scriptenginebuildversion scriptengine split scriptengineminorversion cint sin datepart ltrim sqr scriptenginemajorversion time derived eval date formatpercent exp inputbox left ascw chrw regexp server response request cstr err",literal:"true false null nothing empty"},i:"//",c:[e.inherit(e.QSM,{c:[{b:'""'}]}),e.C(/'/,/$/,{r:0}),e.CNM]}});hljs.registerLanguage("capnproto",function(t){return{aliases:["capnp"],k:{keyword:"struct enum interface union group import using const annotation extends in of on as with from fixed",built_in:"Void Bool Int8 Int16 Int32 Int64 UInt8 UInt16 UInt32 UInt64 Float32 Float64 Text Data AnyPointer AnyStruct Capability List",literal:"true false"},c:[t.QSM,t.NM,t.HCM,{cN:"shebang",b:/@0x[\w\d]{16};/,i:/\n/},{cN:"number",b:/@\d+\b/},{cN:"class",bK:"struct enum",e:/\{/,i:/\n/,c:[t.inherit(t.TM,{starts:{eW:!0,eE:!0}})]},{cN:"class",bK:"interface",e:/\{/,i:/\n/,c:[t.inherit(t.TM,{starts:{eW:!0,eE:!0}})]}]}});hljs.registerLanguage("xl",function(e){var t="ObjectLoader Animate MovieCredits Slides Filters Shading Materials LensFlare Mapping VLCAudioVideo StereoDecoder PointCloud NetworkAccess RemoteControl RegExp ChromaKey Snowfall NodeJS Speech Charts",o={keyword:"if then else do while until for loop import with is as where when by data constant",literal:"true false nil",type:"integer real text name boolean symbol infix prefix postfix block tree",built_in:"in mod rem and or xor not abs sign floor ceil sqrt sin cos tan asin acos atan exp expm1 log log2 log10 log1p pi at",module:t,id:"text_length text_range text_find text_replace contains page slide basic_slide title_slide title subtitle fade_in fade_out fade_at clear_color color line_color line_width texture_wrap texture_transform texture scale_?x scale_?y scale_?z? translate_?x translate_?y translate_?z? rotate_?x rotate_?y rotate_?z? rectangle circle ellipse sphere path line_to move_to quad_to curve_to theme background contents locally time mouse_?x mouse_?y mouse_buttons"},a={cN:"constant",b:"[A-Z][A-Z_0-9]+",r:0},r={cN:"variable",b:"([A-Z][a-z_0-9]+)+",r:0},i={cN:"id",b:"[a-z][a-z_0-9]+",r:0},l={cN:"string",b:'"',e:'"',i:"\\n"},n={cN:"string",b:"'",e:"'",i:"\\n"},s={cN:"string",b:"<<",e:">>"},c={cN:"number",b:"[0-9]+#[0-9A-Z_]+(\\.[0-9-A-Z_]+)?#?([Ee][+-]?[0-9]+)?",r:10},_={cN:"import",bK:"import",e:"$",k:{keyword:"import",module:t},r:0,c:[l]},d={cN:"function",b:"[a-z].*->"};return{aliases:["tao"],l:/[a-zA-Z][a-zA-Z0-9_?]*/,k:o,c:[e.CLCM,e.CBCM,l,n,s,d,_,a,r,i,c,e.NM]}});hljs.registerLanguage("scala",function(e){var t={cN:"annotation",b:"@[A-Za-z]+"},a={cN:"string",b:'u?r?"""',e:'"""',r:10},r={cN:"symbol",b:"'\\w[\\w\\d_]*(?!')"},c={cN:"type",b:"\\b[A-Z][A-Za-z0-9_]*",r:0},i={cN:"title",b:/[^0-9\n\t "'(),.`{}\[\]:;][^\n\t "'(),.`{}\[\]:;]+|[^0-9\n\t "'(),.`{}\[\]:;=]/,r:0},l={cN:"class",bK:"class object trait type",e:/[:={\[(\n;]/,c:[{cN:"keyword",bK:"extends with",r:10},i]},n={cN:"function",bK:"def val",e:/[:={\[(\n;]/,c:[i]};return{k:{literal:"true false null",keyword:"type yield lazy override def with val var sealed abstract private trait object if forSome for while throw finally protected extends import final return else break new catch super class case package default try this match continue throws implicit"},c:[e.CLCM,e.CBCM,a,e.QSM,r,c,n,l,e.CNM,t]}});hljs.registerLanguage("elixir",function(e){var n="[a-zA-Z_][a-zA-Z0-9_]*(\\!|\\?)?",r="[a-zA-Z_]\\w*[!?=]?|[-+~]\\@|<<|>>|=~|===?|<=>|[<>]=?|\\*\\*|[-/+%^&*~`|]|\\[\\]=?",b="and false then defined module in return redo retry end for true self when next until do begin unless nil break not case cond alias while ensure or include use alias fn quote",c={cN:"subst",b:"#\\{",e:"}",l:n,k:b},a={cN:"string",c:[e.BE,c],v:[{b:/'/,e:/'/},{b:/"/,e:/"/}]},i={cN:"function",bK:"def defp defmacro",e:/\B\b/,c:[e.inherit(e.TM,{b:n,endsParent:!0})]},s=e.inherit(i,{cN:"class",bK:"defmodule defrecord",e:/\bdo\b|$|;/}),l=[a,e.HCM,s,i,{cN:"constant",b:"(\\b[A-Z_]\\w*(.)?)+",r:0},{cN:"symbol",b:":",c:[a,{b:r}],r:0},{cN:"symbol",b:n+":",r:0},{cN:"number",b:"(\\b0[0-7_]+)|(\\b0x[0-9a-fA-F_]+)|(\\b[1-9][0-9_]*(\\.[0-9_]+)?)|[0_]\\b",r:0},{cN:"variable",b:"(\\$\\W)|((\\$|\\@\\@?)(\\w+))"},{b:"->"},{b:"("+e.RSR+")\\s*",c:[e.HCM,{cN:"regexp",i:"\\n",c:[e.BE,c],v:[{b:"/",e:"/[a-z]*"},{b:"%r\\[",e:"\\][a-z]*"}]}],r:0}];return c.c=l,{l:n,k:b,c:l}});hljs.registerLanguage("sml",function(e){return{aliases:["ml"],k:{keyword:"abstype and andalso as case datatype do else end eqtype exception fn fun functor handle if in include infix infixr let local nonfix of op open orelse raise rec sharing sig signature struct structure then type val with withtype where while",built_in:"array bool char exn int list option order real ref string substring vector unit word",literal:"true false NONE SOME LESS EQUAL GREATER nil"},i:/\/\/|>>/,l:"[a-z_]\\w*!?",c:[{cN:"literal",b:"\\[(\\|\\|)?\\]|\\(\\)"},e.C("\\(\\*","\\*\\)",{c:["self"]}),{cN:"symbol",b:"'[A-Za-z_](?!')[\\w']*"},{cN:"tag",b:"`[A-Z][\\w']*"},{cN:"type",b:"\\b[A-Z][\\w']*",r:0},{b:"[a-z_]\\w*'[\\w']*"},e.inherit(e.ASM,{cN:"char",r:0}),e.inherit(e.QSM,{i:null}),{cN:"number",b:"\\b(0[xX][a-fA-F0-9_]+[Lln]?|0[oO][0-7_]+[Lln]?|0[bB][01_]+[Lln]?|[0-9][0-9_]*([Lln]|(\\.[0-9_]*)?([eE][-+]?[0-9_]+)?)?)",r:0},{b:/[-=]>/}]}});hljs.registerLanguage("apache",function(e){var r={cN:"number",b:"[\\$%]\\d+"};return{aliases:["apacheconf"],cI:!0,c:[e.HCM,{cN:"tag",b:"</?",e:">"},{cN:"keyword",b:/\w+/,r:0,k:{common:"order deny allow setenv rewriterule rewriteengine rewritecond documentroot sethandler errordocument loadmodule options header listen serverroot servername"},starts:{e:/$/,r:0,k:{literal:"on off all"},c:[{cN:"sqbracket",b:"\\s\\[",e:"\\]$"},{cN:"cbracket",b:"[\\$%]\\{",e:"\\}",c:["self",r]},r,e.QSM]}}],i:/\S/}});hljs.registerLanguage("dockerfile",function(n){return{aliases:["docker"],cI:!0,k:{built_ins:"from maintainer cmd expose add copy entrypoint volume user workdir onbuild run env"},c:[n.HCM,{k:{built_in:"run cmd entrypoint volume add copy workdir onbuild"},b:/^ *(onbuild +)?(run|cmd|entrypoint|volume|add|copy|workdir) +/,starts:{e:/[^\\]\n/,sL:"bash",subLanguageMode:"continuous"}},{k:{built_in:"from maintainer expose env user onbuild"},b:/^ *(onbuild +)?(from|maintainer|expose|env|user|onbuild) +/,e:/[^\\]\n/,c:[n.ASM,n.QSM,n.NM,n.HCM]}]}});hljs.registerLanguage("markdown",function(e){return{aliases:["md","mkdown","mkd"],c:[{cN:"header",v:[{b:"^#{1,6}",e:"$"},{b:"^.+?\\n[=-]{2,}$"}]},{b:"<",e:">",sL:"xml",r:0},{cN:"bullet",b:"^([*+-]|(\\d+\\.))\\s+"},{cN:"strong",b:"[*_]{2}.+?[*_]{2}"},{cN:"emphasis",v:[{b:"\\*.+?\\*"},{b:"_.+?_",r:0}]},{cN:"blockquote",b:"^>\\s+",e:"$"},{cN:"code",v:[{b:"`.+?`"},{b:"^( {4}| )",e:"$",r:0}]},{cN:"horizontal_rule",b:"^[-\\*]{3,}",e:"$"},{b:"\\[.+?\\][\\(\\[].*?[\\)\\]]",rB:!0,c:[{cN:"link_label",b:"\\[",e:"\\]",eB:!0,rE:!0,r:0},{cN:"link_url",b:"\\]\\(",e:"\\)",eB:!0,eE:!0},{cN:"link_reference",b:"\\]\\[",e:"\\]",eB:!0,eE:!0}],r:10},{b:"^\\[.+\\]:",rB:!0,c:[{cN:"link_reference",b:"\\[",e:"\\]:",eB:!0,eE:!0,starts:{cN:"link_url",e:"$"}}]}]}});hljs.registerLanguage("haml",function(s){return{cI:!0,c:[{cN:"doctype",b:"^!!!( (5|1\\.1|Strict|Frameset|Basic|Mobile|RDFa|XML\\b.*))?$",r:10},s.C("^\\s*(!=#|=#|-#|/).*$",!1,{r:0}),{b:"^\\s*(-|=|!=)(?!#)",starts:{e:"\\n",sL:"ruby"}},{cN:"tag",b:"^\\s*%",c:[{cN:"title",b:"\\w+"},{cN:"value",b:"[#\\.]\\w+"},{b:"{\\s*",e:"\\s*}",eE:!0,c:[{b:":\\w+\\s*=>",e:",\\s+",rB:!0,eW:!0,c:[{cN:"symbol",b:":\\w+"},{cN:"string",b:'"',e:'"'},{cN:"string",b:"'",e:"'"},{b:"\\w+",r:0}]}]},{b:"\\(\\s*",e:"\\s*\\)",eE:!0,c:[{b:"\\w+\\s*=",e:"\\s+",rB:!0,eW:!0,c:[{cN:"attribute",b:"\\w+",r:0},{cN:"string",b:'"',e:'"'},{cN:"string",b:"'",e:"'"},{b:"\\w+",r:0}]}]}]},{cN:"bullet",b:"^\\s*[=~]\\s*",r:0},{b:"#{",starts:{e:"}",sL:"ruby"}}]}});hljs.registerLanguage("fortran",function(e){var t={cN:"params",b:"\\(",e:"\\)"},n={constant:".False. .True.",type:"integer real character complex logical dimension allocatable|10 parameter external implicit|10 none double precision assign intent optional pointer target in out common equivalence data",keyword:"kind do while private call intrinsic where elsewhere type endtype endmodule endselect endinterface end enddo endif if forall endforall only contains default return stop then public subroutine|10 function program .and. .or. .not. .le. .eq. .ge. .gt. .lt. goto save else use module select case access blank direct exist file fmt form formatted iostat name named nextrec number opened rec recl sequential status unformatted unit continue format pause cycle exit c_null_char c_alert c_backspace c_form_feed flush wait decimal round iomsg synchronous nopass non_overridable pass protected volatile abstract extends import non_intrinsic value deferred generic final enumerator class associate bind enum c_int c_short c_long c_long_long c_signed_char c_size_t c_int8_t c_int16_t c_int32_t c_int64_t c_int_least8_t c_int_least16_t c_int_least32_t c_int_least64_t c_int_fast8_t c_int_fast16_t c_int_fast32_t c_int_fast64_t c_intmax_t C_intptr_t c_float c_double c_long_double c_float_complex c_double_complex c_long_double_complex c_bool c_char c_null_ptr c_null_funptr c_new_line c_carriage_return c_horizontal_tab c_vertical_tab iso_c_binding c_loc c_funloc c_associated c_f_pointer c_ptr c_funptr iso_fortran_env character_storage_size error_unit file_storage_size input_unit iostat_end iostat_eor numeric_storage_size output_unit c_f_procpointer ieee_arithmetic ieee_support_underflow_control ieee_get_underflow_mode ieee_set_underflow_mode newunit contiguous pad position action delim readwrite eor advance nml interface procedure namelist include sequence elemental pure",built_in:"alog alog10 amax0 amax1 amin0 amin1 amod cabs ccos cexp clog csin csqrt dabs dacos dasin datan datan2 dcos dcosh ddim dexp dint dlog dlog10 dmax1 dmin1 dmod dnint dsign dsin dsinh dsqrt dtan dtanh float iabs idim idint idnint ifix isign max0 max1 min0 min1 sngl algama cdabs cdcos cdexp cdlog cdsin cdsqrt cqabs cqcos cqexp cqlog cqsin cqsqrt dcmplx dconjg derf derfc dfloat dgamma dimag dlgama iqint qabs qacos qasin qatan qatan2 qcmplx qconjg qcos qcosh qdim qerf qerfc qexp qgamma qimag qlgama qlog qlog10 qmax1 qmin1 qmod qnint qsign qsin qsinh qsqrt qtan qtanh abs acos aimag aint anint asin atan atan2 char cmplx conjg cos cosh exp ichar index int log log10 max min nint sign sin sinh sqrt tan tanh print write dim lge lgt lle llt mod nullify allocate deallocate adjustl adjustr all allocated any associated bit_size btest ceiling count cshift date_and_time digits dot_product eoshift epsilon exponent floor fraction huge iand ibclr ibits ibset ieor ior ishft ishftc lbound len_trim matmul maxexponent maxloc maxval merge minexponent minloc minval modulo mvbits nearest pack present product radix random_number random_seed range repeat reshape rrspacing scale scan selected_int_kind selected_real_kind set_exponent shape size spacing spread sum system_clock tiny transpose trim ubound unpack verify achar iachar transfer dble entry dprod cpu_time command_argument_count get_command get_command_argument get_environment_variable is_iostat_end ieee_arithmetic ieee_support_underflow_control ieee_get_underflow_mode ieee_set_underflow_mode is_iostat_eor move_alloc new_line selected_char_kind same_type_as extends_type_ofacosh asinh atanh bessel_j0 bessel_j1 bessel_jn bessel_y0 bessel_y1 bessel_yn erf erfc erfc_scaled gamma log_gamma hypot norm2 atomic_define atomic_ref execute_command_line leadz trailz storage_size merge_bits bge bgt ble blt dshiftl dshiftr findloc iall iany iparity image_index lcobound ucobound maskl maskr num_images parity popcnt poppar shifta shiftl shiftr this_image"};return{cI:!0,aliases:["f90","f95"],k:n,c:[e.inherit(e.ASM,{cN:"string",r:0}),e.inherit(e.QSM,{cN:"string",r:0}),{cN:"function",bK:"subroutine function program",i:"[${=\\n]",c:[e.UTM,t]},e.C("!","$",{r:0}),{cN:"number",b:"(?=\\b|\\+|\\-|\\.)(?=\\.\\d|\\d)(?:\\d+)?(?:\\.?\\d*)(?:[de][+-]?\\d+)?\\b\\.?",r:0}]}});hljs.registerLanguage("smali",function(r){var t=["add","and","cmp","cmpg","cmpl","const","div","double","float","goto","if","int","long","move","mul","neg","new","nop","not","or","rem","return","shl","shr","sput","sub","throw","ushr","xor"],n=["aget","aput","array","check","execute","fill","filled","goto/16","goto/32","iget","instance","invoke","iput","monitor","packed","sget","sparse"],s=["transient","constructor","abstract","final","synthetic","public","private","protected","static","bridge","system"];return{aliases:["smali"],c:[{cN:"string",b:'"',e:'"',r:0},r.C("#","$",{r:0}),{cN:"keyword",b:"\\s*\\.end\\s[a-zA-Z0-9]*",r:1},{cN:"keyword",b:"^[ ]*\\.[a-zA-Z]*",r:0},{cN:"keyword",b:"\\s:[a-zA-Z_0-9]*",r:0},{cN:"keyword",b:"\\s("+s.join("|")+")",r:1},{cN:"keyword",b:"\\[",r:0},{cN:"instruction",b:"\\s("+t.join("|")+")\\s",r:1},{cN:"instruction",b:"\\s("+t.join("|")+")((\\-|/)[a-zA-Z0-9]+)+\\s",r:10},{cN:"instruction",b:"\\s("+n.join("|")+")((\\-|/)[a-zA-Z0-9]+)*\\s",r:10},{cN:"class",b:"L[^(;:\n]*;",r:0},{cN:"function",b:'( |->)[^(\n ;"]*\\(',r:0},{cN:"function",b:"\\)",r:0},{cN:"variable",b:"[vp][0-9]+",r:0}]}});hljs.registerLanguage("julia",function(r){var e={keyword:"in abstract baremodule begin bitstype break catch ccall const continue do else elseif end export finally for function global if immutable import importall let local macro module quote return try type typealias using while",literal:"true false ANY ARGS CPU_CORES C_NULL DL_LOAD_PATH DevNull ENDIAN_BOM ENV I|0 Inf Inf16 Inf32 InsertionSort JULIA_HOME LOAD_PATH MS_ASYNC MS_INVALIDATE MS_SYNC MergeSort NaN NaN16 NaN32 OS_NAME QuickSort RTLD_DEEPBIND RTLD_FIRST RTLD_GLOBAL RTLD_LAZY RTLD_LOCAL RTLD_NODELETE RTLD_NOLOAD RTLD_NOW RoundDown RoundFromZero RoundNearest RoundToZero RoundUp STDERR STDIN STDOUT VERSION WORD_SIZE catalan cglobal e eu eulergamma golden im nothing pi γ π φ",built_in:"ASCIIString AbstractArray AbstractRNG AbstractSparseArray Any ArgumentError Array Associative Base64Pipe Bidiagonal BigFloat BigInt BitArray BitMatrix BitVector Bool BoundsError Box CFILE Cchar Cdouble Cfloat Char CharString Cint Clong Clonglong ClusterManager Cmd Coff_t Colon Complex Complex128 Complex32 Complex64 Condition Cptrdiff_t Cshort Csize_t Cssize_t Cuchar Cuint Culong Culonglong Cushort Cwchar_t DArray DataType DenseArray Diagonal Dict DimensionMismatch DirectIndexString Display DivideError DomainError EOFError EachLine Enumerate ErrorException Exception Expr Factorization FileMonitor FileOffset Filter Float16 Float32 Float64 FloatRange FloatingPoint Function GetfieldNode GotoNode Hermitian IO IOBuffer IOStream IPv4 IPv6 InexactError Int Int128 Int16 Int32 Int64 Int8 IntSet Integer InterruptException IntrinsicFunction KeyError LabelNode LambdaStaticData LineNumberNode LoadError LocalProcess MIME MathConst MemoryError MersenneTwister Method MethodError MethodTable Module NTuple NewvarNode Nothing Number ObjectIdDict OrdinalRange OverflowError ParseError PollingFileWatcher ProcessExitedException ProcessGroup Ptr QuoteNode Range Range1 Ranges Rational RawFD Real Regex RegexMatch RemoteRef RepString RevString RopeString RoundingMode Set SharedArray Signed SparseMatrixCSC StackOverflowError Stat StatStruct StepRange String SubArray SubString SymTridiagonal Symbol SymbolNode Symmetric SystemError Task TextDisplay Timer TmStruct TopNode Triangular Tridiagonal Type TypeConstructor TypeError TypeName TypeVar UTF16String UTF32String UTF8String UdpSocket Uint Uint128 Uint16 Uint32 Uint64 Uint8 UndefRefError UndefVarError UniformScaling UnionType UnitRange Unsigned Vararg VersionNumber WString WeakKeyDict WeakRef Woodbury Zip"},t="[A-Za-z_\\u00A1-\\uFFFF][A-Za-z_0-9\\u00A1-\\uFFFF]*",o={l:t,k:e},n={cN:"type-annotation",b:/::/},a={cN:"subtype",b:/<:/},i={cN:"number",b:/(\b0x[\d_]*(\.[\d_]*)?|0x\.\d[\d_]*)p[-+]?\d+|\b0[box][a-fA-F0-9][a-fA-F0-9_]*|(\b\d[\d_]*(\.[\d_]*)?|\.\d[\d_]*)([eEfF][-+]?\d+)?/,r:0},l={cN:"char",b:/'(.|\\[xXuU][a-zA-Z0-9]+)'/},c={cN:"subst",b:/\$\(/,e:/\)/,k:e},u={cN:"variable",b:"\\$"+t},d={cN:"string",c:[r.BE,c,u],v:[{b:/\w*"/,e:/"\w*/},{b:/\w*"""/,e:/"""\w*/}]},g={cN:"string",c:[r.BE,c,u],b:"`",e:"`"},s={cN:"macrocall",b:"@"+t},S={cN:"comment",v:[{b:"#=",e:"=#",r:10},{b:"#",e:"$"}]};return o.c=[i,l,n,a,d,g,s,S,r.HCM],c.c=o.c,o});hljs.registerLanguage("delphi",function(e){var r="exports register file shl array record property for mod while set ally label uses raise not stored class safecall var interface or private static exit index inherited to else stdcall override shr asm far resourcestring finalization packed virtual out and protected library do xorwrite goto near function end div overload object unit begin string on inline repeat until destructor write message program with read initialization except default nil if case cdecl in downto threadvar of try pascal const external constructor type public then implementation finally published procedure",t=[e.CLCM,e.C(/\{/,/\}/,{r:0}),e.C(/\(\*/,/\*\)/,{r:10})],i={cN:"string",b:/'/,e:/'/,c:[{b:/''/}]},c={cN:"string",b:/(#\d+)+/},o={b:e.IR+"\\s*=\\s*class\\s*\\(",rB:!0,c:[e.TM]},n={cN:"function",bK:"function constructor destructor procedure",e:/[:;]/,k:"function constructor|10 destructor|10 procedure|10",c:[e.TM,{cN:"params",b:/\(/,e:/\)/,k:r,c:[i,c]}].concat(t)};return{cI:!0,k:r,i:/"|\$[G-Zg-z]|\/\*|<\/|\|/,c:[i,c,e.NM,o,n].concat(t)}});hljs.registerLanguage("brainfuck",function(r){var n={cN:"literal",b:"[\\+\\-]",r:0};return{aliases:["bf"],c:[r.C("[^\\[\\]\\.,\\+\\-<> \r\n]","[\\[\\]\\.,\\+\\-<> \r\n]",{rE:!0,r:0}),{cN:"title",b:"[\\[\\]]",r:0},{cN:"string",b:"[\\.,]",r:0},{b:/\+\+|\-\-/,rB:!0,c:[n]},n]}});hljs.registerLanguage("ini",function(e){return{cI:!0,i:/\S/,c:[e.C(";","$"),{cN:"title",b:"^\\[",e:"\\]"},{cN:"setting",b:"^[a-z0-9\\[\\]_-]+[ \\t]*=[ \\t]*",e:"$",c:[{cN:"value",eW:!0,k:"on off true false yes no",c:[e.QSM,e.NM],r:0}]}]}});hljs.registerLanguage("json",function(e){var t={literal:"true false null"},i=[e.QSM,e.CNM],l={cN:"value",e:",",eW:!0,eE:!0,c:i,k:t},c={b:"{",e:"}",c:[{cN:"attribute",b:'\\s*"',e:'"\\s*:\\s*',eB:!0,eE:!0,c:[e.BE],i:"\\n",starts:l}],i:"\\S"},n={b:"\\[",e:"\\]",c:[e.inherit(l,{cN:null})],i:"\\S"};return i.splice(i.length,0,c,n),{c:i,k:t,i:"\\S"}});hljs.registerLanguage("powershell",function(e){var t={b:"`[\\s\\S]",r:0},r={cN:"variable",v:[{b:/\$[\w\d][\w\d_:]*/}]},o={cN:"string",b:/"/,e:/"/,c:[t,r,{cN:"variable",b:/\$[A-z]/,e:/[^A-z]/}]},a={cN:"string",b:/'/,e:/'/};return{aliases:["ps"],l:/-?[A-z\.\-]+/,cI:!0,k:{keyword:"if else foreach return function do while until elseif begin for trap data dynamicparam end break throw param continue finally in switch exit filter try process catch",literal:"$null $true $false",built_in:"Add-Content Add-History Add-Member Add-PSSnapin Clear-Content Clear-Item Clear-Item Property Clear-Variable Compare-Object ConvertFrom-SecureString Convert-Path ConvertTo-Html ConvertTo-SecureString Copy-Item Copy-ItemProperty Export-Alias Export-Clixml Export-Console Export-Csv ForEach-Object Format-Custom Format-List Format-Table Format-Wide Get-Acl Get-Alias Get-AuthenticodeSignature Get-ChildItem Get-Command Get-Content Get-Credential Get-Culture Get-Date Get-EventLog Get-ExecutionPolicy Get-Help Get-History Get-Host Get-Item Get-ItemProperty Get-Location Get-Member Get-PfxCertificate Get-Process Get-PSDrive Get-PSProvider Get-PSSnapin Get-Service Get-TraceSource Get-UICulture Get-Unique Get-Variable Get-WmiObject Group-Object Import-Alias Import-Clixml Import-Csv Invoke-Expression Invoke-History Invoke-Item Join-Path Measure-Command Measure-Object Move-Item Move-ItemProperty New-Alias New-Item New-ItemProperty New-Object New-PSDrive New-Service New-TimeSpan New-Variable Out-Default Out-File Out-Host Out-Null Out-Printer Out-String Pop-Location Push-Location Read-Host Remove-Item Remove-ItemProperty Remove-PSDrive Remove-PSSnapin Remove-Variable Rename-Item Rename-ItemProperty Resolve-Path Restart-Service Resume-Service Select-Object Select-String Set-Acl Set-Alias Set-AuthenticodeSignature Set-Content Set-Date Set-ExecutionPolicy Set-Item Set-ItemProperty Set-Location Set-PSDebug Set-Service Set-TraceSource Set-Variable Sort-Object Split-Path Start-Service Start-Sleep Start-Transcript Stop-Process Stop-Service Stop-Transcript Suspend-Service Tee-Object Test-Path Trace-Command Update-FormatData Update-TypeData Where-Object Write-Debug Write-Error Write-Host Write-Output Write-Progress Write-Verbose Write-Warning",operator:"-ne -eq -lt -gt -ge -le -not -like -notlike -match -notmatch -contains -notcontains -in -notin -replace"},c:[e.HCM,e.NM,o,a,r]}});hljs.registerLanguage("gradle",function(e){return{cI:!0,k:{keyword:"task project allprojects subprojects artifacts buildscript configurations dependencies repositories sourceSets description delete from into include exclude source classpath destinationDir includes options sourceCompatibility targetCompatibility group flatDir doLast doFirst flatten todir fromdir ant def abstract break case catch continue default do else extends final finally for if implements instanceof native new private protected public return static switch synchronized throw throws transient try volatile while strictfp package import false null super this true antlrtask checkstyle codenarc copy boolean byte char class double float int interface long short void compile runTime file fileTree abs any append asList asWritable call collect compareTo count div dump each eachByte eachFile eachLine every find findAll flatten getAt getErr getIn getOut getText grep immutable inject inspect intersect invokeMethods isCase join leftShift minus multiply newInputStream newOutputStream newPrintWriter newReader newWriter next plus pop power previous print println push putAt read readBytes readLines reverse reverseEach round size sort splitEachLine step subMap times toInteger toList tokenize upto waitForOrKill withPrintWriter withReader withStream withWriter withWriterAppend write writeLine"},c:[e.CLCM,e.CBCM,e.ASM,e.QSM,e.NM,e.RM]}});hljs.registerLanguage("erb",function(e){return{sL:"xml",subLanguageMode:"continuous",c:[e.C("<%#","%>"),{b:"<%[%=-]?",e:"[%-]?%>",sL:"ruby",eB:!0,eE:!0}]}});hljs.registerLanguage("swift",function(e){var i={keyword:"class deinit enum extension func import init let protocol static struct subscript typealias var break case continue default do else fallthrough if in for return switch where while as dynamicType is new super self Self Type __COLUMN__ __FILE__ __FUNCTION__ __LINE__ associativity didSet get infix inout left mutating none nonmutating operator override postfix precedence prefix right set unowned unowned safe unsafe weak willSet",literal:"true false nil",built_in:"abs advance alignof alignofValue assert bridgeFromObjectiveC bridgeFromObjectiveCUnconditional bridgeToObjectiveC bridgeToObjectiveCUnconditional c contains count countElements countLeadingZeros debugPrint debugPrintln distance dropFirst dropLast dump encodeBitsAsWords enumerate equal false filter find getBridgedObjectiveCType getVaList indices insertionSort isBridgedToObjectiveC isBridgedVerbatimToObjectiveC isUniquelyReferenced join lexicographicalCompare map max maxElement min minElement nil numericCast partition posix print println quickSort reduce reflect reinterpretCast reverse roundUpToAlignment sizeof sizeofValue sort split startsWith strideof strideofValue swap swift toString transcode true underestimateCount unsafeReflect withExtendedLifetime withObjectAtPlusZero withUnsafePointer withUnsafePointerToObject withUnsafePointers withVaList"},t={cN:"type",b:"\\b[A-Z][\\w']*",r:0},n=e.C("/\\*","\\*/",{c:["self"]}),r={cN:"subst",b:/\\\(/,e:"\\)",k:i,c:[]},s={cN:"number",b:"\\b([\\d_]+(\\.[\\deE_]+)?|0x[a-fA-F0-9_]+(\\.[a-fA-F0-9p_]+)?|0b[01_]+|0o[0-7_]+)\\b",r:0},o=e.inherit(e.QSM,{c:[r,e.BE]});return r.c=[s],{k:i,c:[o,e.CLCM,n,t,s,{cN:"func",bK:"func",e:"{",eE:!0,c:[e.inherit(e.TM,{b:/[A-Za-z$_][0-9A-Za-z$_]*/,i:/\(/}),{cN:"generics",b:/</,e:/>/,i:/>/},{cN:"params",b:/\(/,e:/\)/,endsParent:!0,k:i,c:["self",s,o,e.CBCM,{b:":"}],i:/["']/}],i:/\[|%/},{cN:"class",bK:"struct protocol class extension enum",k:i,e:"\\{",eE:!0,c:[e.inherit(e.TM,{b:/[A-Za-z$_][0-9A-Za-z$_]*/})]},{cN:"preprocessor",b:"(@assignment|@class_protocol|@exported|@final|@lazy|@noreturn|@NSCopying|@NSManaged|@objc|@optional|@required|@auto_closure|@noreturn|@IBAction|@IBDesignable|@IBInspectable|@IBOutlet|@infix|@prefix|@postfix)"}]}});hljs.registerLanguage("lisp",function(b){var e="[a-zA-Z_\\-\\+\\*\\/\\<\\=\\>\\&\\#][a-zA-Z0-9_\\-\\+\\*\\/\\<\\=\\>\\&\\#!]*",c="\\|[^]*?\\|",r="(\\-|\\+)?\\d+(\\.\\d+|\\/\\d+)?((d|e|f|l|s|D|E|F|L|S)(\\+|\\-)?\\d+)?",a={cN:"shebang",b:"^#!",e:"$"},i={cN:"literal",b:"\\b(t{1}|nil)\\b"},l={cN:"number",v:[{b:r,r:0},{b:"#(b|B)[0-1]+(/[0-1]+)?"},{b:"#(o|O)[0-7]+(/[0-7]+)?"},{b:"#(x|X)[0-9a-fA-F]+(/[0-9a-fA-F]+)?"},{b:"#(c|C)\\("+r+" +"+r,e:"\\)"}]},t=b.inherit(b.QSM,{i:null}),d=b.C(";","$",{r:0}),n={cN:"variable",b:"\\*",e:"\\*"},u={cN:"keyword",b:"[:&]"+e},N={b:e,r:0},o={b:c},s={b:"\\(",e:"\\)",c:["self",i,t,l,N]},v={cN:"quoted",c:[l,t,n,u,s,N],v:[{b:"['`]\\(",e:"\\)"},{b:"\\(quote ",e:"\\)",k:"quote"},{b:"'"+c}]},f={cN:"quoted",v:[{b:"'"+e},{b:"#'"+e+"(::"+e+")*"}]},g={cN:"list",b:"\\(\\s*",e:"\\)"},q={eW:!0,r:0};return g.c=[{cN:"keyword",v:[{b:e},{b:c}]},q],q.c=[v,f,g,i,l,t,d,n,u,o,N],{i:/\S/,c:[l,a,i,t,d,v,f,g,N]}});hljs.registerLanguage("rsl",function(e){return{k:{keyword:"float color point normal vector matrix while for if do return else break extern continue",built_in:"abs acos ambient area asin atan atmosphere attribute calculatenormal ceil cellnoise clamp comp concat cos degrees depth Deriv diffuse distance Du Dv environment exp faceforward filterstep floor format fresnel incident length lightsource log match max min mod noise normalize ntransform opposite option phong pnoise pow printf ptlined radians random reflect refract renderinfo round setcomp setxcomp setycomp setzcomp shadow sign sin smoothstep specular specularbrdf spline sqrt step tan texture textureinfo trace transform vtransform xcomp ycomp zcomp"},i:"</",c:[e.CLCM,e.CBCM,e.QSM,e.ASM,e.CNM,{cN:"preprocessor",b:"#",e:"$"},{cN:"shader",bK:"surface displacement light volume imager",e:"\\("},{cN:"shading",bK:"illuminate illuminance gather",e:"\\("}]}});hljs.registerLanguage("scheme",function(e){var t="[^\\(\\)\\[\\]\\{\\}\",'`;#|\\\\\\s]+",r="(\\-|\\+)?\\d+([./]\\d+)?",i=r+"[+\\-]"+r+"i",a={built_in:"case-lambda call/cc class define-class exit-handler field import inherit init-field interface let*-values let-values let/ec mixin opt-lambda override protect provide public rename require require-for-syntax syntax syntax-case syntax-error unit/sig unless when with-syntax and begin call-with-current-continuation call-with-input-file call-with-output-file case cond define define-syntax delay do dynamic-wind else for-each if lambda let let* let-syntax letrec letrec-syntax map or syntax-rules ' * + , ,@ - ... / ; < <= = => > >= ` abs acos angle append apply asin assoc assq assv atan boolean? caar cadr call-with-input-file call-with-output-file call-with-values car cdddar cddddr cdr ceiling char->integer char-alphabetic? char-ci<=? char-ci<? char-ci=? char-ci>=? char-ci>? char-downcase char-lower-case? char-numeric? char-ready? char-upcase char-upper-case? char-whitespace? char<=? char<? char=? char>=? char>? char? close-input-port close-output-port complex? cons cos current-input-port current-output-port denominator display eof-object? eq? equal? eqv? eval even? exact->inexact exact? exp expt floor force gcd imag-part inexact->exact inexact? input-port? integer->char integer? interaction-environment lcm length list list->string list->vector list-ref list-tail list? load log magnitude make-polar make-rectangular make-string make-vector max member memq memv min modulo negative? newline not null-environment null? number->string number? numerator odd? open-input-file open-output-file output-port? pair? peek-char port? positive? procedure? quasiquote quote quotient rational? rationalize read read-char real-part real? remainder reverse round scheme-report-environment set! set-car! set-cdr! sin sqrt string string->list string->number string->symbol string-append string-ci<=? string-ci<? string-ci=? string-ci>=? string-ci>? string-copy string-fill! string-length string-ref string-set! string<=? string<? string=? string>=? string>? string? substring symbol->string symbol? tan transcript-off transcript-on truncate values vector vector->list vector-fill! vector-length vector-ref vector-set! with-input-from-file with-output-to-file write write-char zero?"},n={cN:"shebang",b:"^#!",e:"$"},c={cN:"literal",b:"(#t|#f|#\\\\"+t+"|#\\\\.)"},l={cN:"number",v:[{b:r,r:0},{b:i,r:0},{b:"#b[0-1]+(/[0-1]+)?"},{b:"#o[0-7]+(/[0-7]+)?"},{b:"#x[0-9a-f]+(/[0-9a-f]+)?"}]},s=e.QSM,o=[e.C(";","$",{r:0}),e.C("#\\|","\\|#")],u={b:t,r:0},p={cN:"variable",b:"'"+t},d={eW:!0,r:0},g={cN:"list",v:[{b:"\\(",e:"\\)"},{b:"\\[",e:"\\]"}],c:[{cN:"keyword",b:t,l:t,k:a},d]};return d.c=[c,l,s,u,p,g].concat(o),{i:/\S/,c:[n,l,s,p,g].concat(o)}});hljs.registerLanguage("stata",function(e){return{aliases:["do","ado"],cI:!0,k:"if else in foreach for forv forva forval forvalu forvalue forvalues by bys bysort xi quietly qui capture about ac ac_7 acprplot acprplot_7 adjust ado adopath adoupdate alpha ameans an ano anov anova anova_estat anova_terms anovadef aorder ap app appe appen append arch arch_dr arch_estat arch_p archlm areg areg_p args arima arima_dr arima_estat arima_p as asmprobit asmprobit_estat asmprobit_lf asmprobit_mfx__dlg asmprobit_p ass asse asser assert avplot avplot_7 avplots avplots_7 bcskew0 bgodfrey binreg bip0_lf biplot bipp_lf bipr_lf bipr_p biprobit bitest bitesti bitowt blogit bmemsize boot bootsamp bootstrap bootstrap_8 boxco_l boxco_p boxcox boxcox_6 boxcox_p bprobit br break brier bro brow brows browse brr brrstat bs bs_7 bsampl_w bsample bsample_7 bsqreg bstat bstat_7 bstat_8 bstrap bstrap_7 ca ca_estat ca_p cabiplot camat canon canon_8 canon_8_p canon_estat canon_p cap caprojection capt captu captur capture cat cc cchart cchart_7 cci cd censobs_table centile cf char chdir checkdlgfiles checkestimationsample checkhlpfiles checksum chelp ci cii cl class classutil clear cli clis clist clo clog clog_lf clog_p clogi clogi_sw clogit clogit_lf clogit_p clogitp clogl_sw cloglog clonevar clslistarray cluster cluster_measures cluster_stop cluster_tree cluster_tree_8 clustermat cmdlog cnr cnre cnreg cnreg_p cnreg_sw cnsreg codebook collaps4 collapse colormult_nb colormult_nw compare compress conf confi confir confirm conren cons const constr constra constrai constrain constraint continue contract copy copyright copysource cor corc corr corr2data corr_anti corr_kmo corr_smc corre correl correla correlat correlate corrgram cou coun count cox cox_p cox_sw coxbase coxhaz coxvar cprplot cprplot_7 crc cret cretu cretur creturn cross cs cscript cscript_log csi ct ct_is ctset ctst_5 ctst_st cttost cumsp cumsp_7 cumul cusum cusum_7 cutil d datasig datasign datasigna datasignat datasignatu datasignatur datasignature datetof db dbeta de dec deco decod decode deff des desc descr descri describ describe destring dfbeta dfgls dfuller di di_g dir dirstats dis discard disp disp_res disp_s displ displa display distinct do doe doed doedi doedit dotplot dotplot_7 dprobit drawnorm drop ds ds_util dstdize duplicates durbina dwstat dydx e ed edi edit egen eivreg emdef en enc enco encod encode eq erase ereg ereg_lf ereg_p ereg_sw ereghet ereghet_glf ereghet_glf_sh ereghet_gp ereghet_ilf ereghet_ilf_sh ereghet_ip eret eretu eretur ereturn err erro error est est_cfexist est_cfname est_clickable est_expand est_hold est_table est_unhold est_unholdok estat estat_default estat_summ estat_vce_only esti estimates etodow etof etomdy ex exi exit expand expandcl fac fact facto factor factor_estat factor_p factor_pca_rotated factor_rotate factormat fcast fcast_compute fcast_graph fdades fdadesc fdadescr fdadescri fdadescrib fdadescribe fdasav fdasave fdause fh_st file open file read file close file filefilter fillin find_hlp_file findfile findit findit_7 fit fl fli flis flist for5_0 form forma format fpredict frac_154 frac_adj frac_chk frac_cox frac_ddp frac_dis frac_dv frac_in frac_mun frac_pp frac_pq frac_pv frac_wgt frac_xo fracgen fracplot fracplot_7 fracpoly fracpred fron_ex fron_hn fron_p fron_tn fron_tn2 frontier ftodate ftoe ftomdy ftowdate g gamhet_glf gamhet_gp gamhet_ilf gamhet_ip gamma gamma_d2 gamma_p gamma_sw gammahet gdi_hexagon gdi_spokes ge gen gene gener genera generat generate genrank genstd genvmean gettoken gl gladder gladder_7 glim_l01 glim_l02 glim_l03 glim_l04 glim_l05 glim_l06 glim_l07 glim_l08 glim_l09 glim_l10 glim_l11 glim_l12 glim_lf glim_mu glim_nw1 glim_nw2 glim_nw3 glim_p glim_v1 glim_v2 glim_v3 glim_v4 glim_v5 glim_v6 glim_v7 glm glm_6 glm_p glm_sw glmpred glo glob globa global glogit glogit_8 glogit_p gmeans gnbre_lf gnbreg gnbreg_5 gnbreg_p gomp_lf gompe_sw gomper_p gompertz gompertzhet gomphet_glf gomphet_glf_sh gomphet_gp gomphet_ilf gomphet_ilf_sh gomphet_ip gphdot gphpen gphprint gprefs gprobi_p gprobit gprobit_8 gr gr7 gr_copy gr_current gr_db gr_describe gr_dir gr_draw gr_draw_replay gr_drop gr_edit gr_editviewopts gr_example gr_example2 gr_export gr_print gr_qscheme gr_query gr_read gr_rename gr_replay gr_save gr_set gr_setscheme gr_table gr_undo gr_use graph graph7 grebar greigen greigen_7 greigen_8 grmeanby grmeanby_7 gs_fileinfo gs_filetype gs_graphinfo gs_stat gsort gwood h hadimvo hareg hausman haver he heck_d2 heckma_p heckman heckp_lf heckpr_p heckprob hel help hereg hetpr_lf hetpr_p hetprob hettest hexdump hilite hist hist_7 histogram hlogit hlu hmeans hotel hotelling hprobit hreg hsearch icd9 icd9_ff icd9p iis impute imtest inbase include inf infi infil infile infix inp inpu input ins insheet insp inspe inspec inspect integ inten intreg intreg_7 intreg_p intrg2_ll intrg_ll intrg_ll2 ipolate iqreg ir irf irf_create irfm iri is_svy is_svysum isid istdize ivprob_1_lf ivprob_lf ivprobit ivprobit_p ivreg ivreg_footnote ivtob_1_lf ivtob_lf ivtobit ivtobit_p jackknife jacknife jknife jknife_6 jknife_8 jkstat joinby kalarma1 kap kap_3 kapmeier kappa kapwgt kdensity kdensity_7 keep ksm ksmirnov ktau kwallis l la lab labe label labelbook ladder levels levelsof leverage lfit lfit_p li lincom line linktest lis list lloghet_glf lloghet_glf_sh lloghet_gp lloghet_ilf lloghet_ilf_sh lloghet_ip llogi_sw llogis_p llogist llogistic llogistichet lnorm_lf lnorm_sw lnorma_p lnormal lnormalhet lnormhet_glf lnormhet_glf_sh lnormhet_gp lnormhet_ilf lnormhet_ilf_sh lnormhet_ip lnskew0 loadingplot loc loca local log logi logis_lf logistic logistic_p logit logit_estat logit_p loglogs logrank loneway lookfor lookup lowess lowess_7 lpredict lrecomp lroc lroc_7 lrtest ls lsens lsens_7 lsens_x lstat ltable ltable_7 ltriang lv lvr2plot lvr2plot_7 m ma mac macr macro makecns man manova manova_estat manova_p manovatest mantel mark markin markout marksample mat mat_capp mat_order mat_put_rr mat_rapp mata mata_clear mata_describe mata_drop mata_matdescribe mata_matsave mata_matuse mata_memory mata_mlib mata_mosave mata_rename mata_which matalabel matcproc matlist matname matr matri matrix matrix_input__dlg matstrik mcc mcci md0_ md1_ md1debug_ md2_ md2debug_ mds mds_estat mds_p mdsconfig mdslong mdsmat mdsshepard mdytoe mdytof me_derd mean means median memory memsize meqparse mer merg merge mfp mfx mhelp mhodds minbound mixed_ll mixed_ll_reparm mkassert mkdir mkmat mkspline ml ml_5 ml_adjs ml_bhhhs ml_c_d ml_check ml_clear ml_cnt ml_debug ml_defd ml_e0 ml_e0_bfgs ml_e0_cycle ml_e0_dfp ml_e0i ml_e1 ml_e1_bfgs ml_e1_bhhh ml_e1_cycle ml_e1_dfp ml_e2 ml_e2_cycle ml_ebfg0 ml_ebfr0 ml_ebfr1 ml_ebh0q ml_ebhh0 ml_ebhr0 ml_ebr0i ml_ecr0i ml_edfp0 ml_edfr0 ml_edfr1 ml_edr0i ml_eds ml_eer0i ml_egr0i ml_elf ml_elf_bfgs ml_elf_bhhh ml_elf_cycle ml_elf_dfp ml_elfi ml_elfs ml_enr0i ml_enrr0 ml_erdu0 ml_erdu0_bfgs ml_erdu0_bhhh ml_erdu0_bhhhq ml_erdu0_cycle ml_erdu0_dfp ml_erdu0_nrbfgs ml_exde ml_footnote ml_geqnr ml_grad0 ml_graph ml_hbhhh ml_hd0 ml_hold ml_init ml_inv ml_log ml_max ml_mlout ml_mlout_8 ml_model ml_nb0 ml_opt ml_p ml_plot ml_query ml_rdgrd ml_repor ml_s_e ml_score ml_searc ml_technique ml_unhold mleval mlf_ mlmatbysum mlmatsum mlog mlogi mlogit mlogit_footnote mlogit_p mlopts mlsum mlvecsum mnl0_ mor more mov move mprobit mprobit_lf mprobit_p mrdu0_ mrdu1_ mvdecode mvencode mvreg mvreg_estat n nbreg nbreg_al nbreg_lf nbreg_p nbreg_sw nestreg net newey newey_7 newey_p news nl nl_7 nl_9 nl_9_p nl_p nl_p_7 nlcom nlcom_p nlexp2 nlexp2_7 nlexp2a nlexp2a_7 nlexp3 nlexp3_7 nlgom3 nlgom3_7 nlgom4 nlgom4_7 nlinit nllog3 nllog3_7 nllog4 nllog4_7 nlog_rd nlogit nlogit_p nlogitgen nlogittree nlpred no nobreak noi nois noisi noisil noisily note notes notes_dlg nptrend numlabel numlist odbc old_ver olo olog ologi ologi_sw ologit ologit_p ologitp on one onew onewa oneway op_colnm op_comp op_diff op_inv op_str opr opro oprob oprob_sw oprobi oprobi_p oprobit oprobitp opts_exclusive order orthog orthpoly ou out outf outfi outfil outfile outs outsh outshe outshee outsheet ovtest pac pac_7 palette parse parse_dissim pause pca pca_8 pca_display pca_estat pca_p pca_rotate pcamat pchart pchart_7 pchi pchi_7 pcorr pctile pentium pergram pergram_7 permute permute_8 personal peto_st pkcollapse pkcross pkequiv pkexamine pkexamine_7 pkshape pksumm pksumm_7 pl plo plot plugin pnorm pnorm_7 poisgof poiss_lf poiss_sw poisso_p poisson poisson_estat post postclose postfile postutil pperron pr prais prais_e prais_e2 prais_p predict predictnl preserve print pro prob probi probit probit_estat probit_p proc_time procoverlay procrustes procrustes_estat procrustes_p profiler prog progr progra program prop proportion prtest prtesti pwcorr pwd q\\s qby qbys qchi qchi_7 qladder qladder_7 qnorm qnorm_7 qqplot qqplot_7 qreg qreg_c qreg_p qreg_sw qu quadchk quantile quantile_7 que quer query range ranksum ratio rchart rchart_7 rcof recast reclink recode reg reg3 reg3_p regdw regr regre regre_p2 regres regres_p regress regress_estat regriv_p remap ren rena renam rename renpfix repeat replace report reshape restore ret retu retur return rm rmdir robvar roccomp roccomp_7 roccomp_8 rocf_lf rocfit rocfit_8 rocgold rocplot rocplot_7 roctab roctab_7 rolling rologit rologit_p rot rota rotat rotate rotatemat rreg rreg_p ru run runtest rvfplot rvfplot_7 rvpplot rvpplot_7 sa safesum sample sampsi sav save savedresults saveold sc sca scal scala scalar scatter scm_mine sco scob_lf scob_p scobi_sw scobit scor score scoreplot scoreplot_help scree screeplot screeplot_help sdtest sdtesti se search separate seperate serrbar serrbar_7 serset set set_defaults sfrancia sh she shel shell shewhart shewhart_7 signestimationsample signrank signtest simul simul_7 simulate simulate_8 sktest sleep slogit slogit_d2 slogit_p smooth snapspan so sor sort spearman spikeplot spikeplot_7 spikeplt spline_x split sqreg sqreg_p sret sretu sretur sreturn ssc st st_ct st_hc st_hcd st_hcd_sh st_is st_issys st_note st_promo st_set st_show st_smpl st_subid stack statsby statsby_8 stbase stci stci_7 stcox stcox_estat stcox_fr stcox_fr_ll stcox_p stcox_sw stcoxkm stcoxkm_7 stcstat stcurv stcurve stcurve_7 stdes stem stepwise stereg stfill stgen stir stjoin stmc stmh stphplot stphplot_7 stphtest stphtest_7 stptime strate strate_7 streg streg_sw streset sts sts_7 stset stsplit stsum sttocc sttoct stvary stweib su suest suest_8 sum summ summa summar summari summariz summarize sunflower sureg survcurv survsum svar svar_p svmat svy svy_disp svy_dreg svy_est svy_est_7 svy_estat svy_get svy_gnbreg_p svy_head svy_header svy_heckman_p svy_heckprob_p svy_intreg_p svy_ivreg_p svy_logistic_p svy_logit_p svy_mlogit_p svy_nbreg_p svy_ologit_p svy_oprobit_p svy_poisson_p svy_probit_p svy_regress_p svy_sub svy_sub_7 svy_x svy_x_7 svy_x_p svydes svydes_8 svygen svygnbreg svyheckman svyheckprob svyintreg svyintreg_7 svyintrg svyivreg svylc svylog_p svylogit svymarkout svymarkout_8 svymean svymlog svymlogit svynbreg svyolog svyologit svyoprob svyoprobit svyopts svypois svypois_7 svypoisson svyprobit svyprobt svyprop svyprop_7 svyratio svyreg svyreg_p svyregress svyset svyset_7 svyset_8 svytab svytab_7 svytest svytotal sw sw_8 swcnreg swcox swereg swilk swlogis swlogit swologit swoprbt swpois swprobit swqreg swtobit swweib symmetry symmi symplot symplot_7 syntax sysdescribe sysdir sysuse szroeter ta tab tab1 tab2 tab_or tabd tabdi tabdis tabdisp tabi table tabodds tabodds_7 tabstat tabu tabul tabula tabulat tabulate te tempfile tempname tempvar tes test testnl testparm teststd tetrachoric time_it timer tis tob tobi tobit tobit_p tobit_sw token tokeni tokeniz tokenize tostring total translate translator transmap treat_ll treatr_p treatreg trim trnb_cons trnb_mean trpoiss_d2 trunc_ll truncr_p truncreg tsappend tset tsfill tsline tsline_ex tsreport tsrevar tsrline tsset tssmooth tsunab ttest ttesti tut_chk tut_wait tutorial tw tware_st two twoway twoway__fpfit_serset twoway__function_gen twoway__histogram_gen twoway__ipoint_serset twoway__ipoints_serset twoway__kdensity_gen twoway__lfit_serset twoway__normgen_gen twoway__pci_serset twoway__qfit_serset twoway__scatteri_serset twoway__sunflower_gen twoway_ksm_serset ty typ type typeof u unab unabbrev unabcmd update us use uselabel var var_mkcompanion var_p varbasic varfcast vargranger varirf varirf_add varirf_cgraph varirf_create varirf_ctable varirf_describe varirf_dir varirf_drop varirf_erase varirf_graph varirf_ograph varirf_rename varirf_set varirf_table varlist varlmar varnorm varsoc varstable varstable_w varstable_w2 varwle vce vec vec_fevd vec_mkphi vec_p vec_p_w vecirf_create veclmar veclmar_w vecnorm vecnorm_w vecrank vecstable verinst vers versi versio version view viewsource vif vwls wdatetof webdescribe webseek webuse weib1_lf weib2_lf weib_lf weib_lf0 weibhet_glf weibhet_glf_sh weibhet_glfa weibhet_glfa_sh weibhet_gp weibhet_ilf weibhet_ilf_sh weibhet_ilfa weibhet_ilfa_sh weibhet_ip weibu_sw weibul_p weibull weibull_c weibull_s weibullhet wh whelp whi which whil while wilc_st wilcoxon win wind windo window winexec wntestb wntestb_7 wntestq xchart xchart_7 xcorr xcorr_7 xi xi_6 xmlsav xmlsave xmluse xpose xsh xshe xshel xshell xt_iis xt_tis xtab_p xtabond xtbin_p xtclog xtcloglog xtcloglog_8 xtcloglog_d2 xtcloglog_pa_p xtcloglog_re_p xtcnt_p xtcorr xtdata xtdes xtfront_p xtfrontier xtgee xtgee_elink xtgee_estat xtgee_makeivar xtgee_p xtgee_plink xtgls xtgls_p xthaus xthausman xtht_p xthtaylor xtile xtint_p xtintreg xtintreg_8 xtintreg_d2 xtintreg_p xtivp_1 xtivp_2 xtivreg xtline xtline_ex xtlogit xtlogit_8 xtlogit_d2 xtlogit_fe_p xtlogit_pa_p xtlogit_re_p xtmixed xtmixed_estat xtmixed_p xtnb_fe xtnb_lf xtnbreg xtnbreg_pa_p xtnbreg_refe_p xtpcse xtpcse_p xtpois xtpoisson xtpoisson_d2 xtpoisson_pa_p xtpoisson_refe_p xtpred xtprobit xtprobit_8 xtprobit_d2 xtprobit_re_p xtps_fe xtps_lf xtps_ren xtps_ren_8 xtrar_p xtrc xtrc_p xtrchh xtrefe_p xtreg xtreg_be xtreg_fe xtreg_ml xtreg_pa_p xtreg_re xtregar xtrere_p xtset xtsf_ll xtsf_llti xtsum xttab xttest0 xttobit xttobit_8 xttobit_p xttrans yx yxview__barlike_draw yxview_area_draw yxview_bar_draw yxview_dot_draw yxview_dropline_draw yxview_function_draw yxview_iarrow_draw yxview_ilabels_draw yxview_normal_draw yxview_pcarrow_draw yxview_pcbarrow_draw yxview_pccapsym_draw yxview_pcscatter_draw yxview_pcspike_draw yxview_rarea_draw yxview_rbar_draw yxview_rbarm_draw yxview_rcap_draw yxview_rcapsym_draw yxview_rconnected_draw yxview_rline_draw yxview_rscatter_draw yxview_rspike_draw yxview_spike_draw yxview_sunflower_draw zap_s zinb zinb_llf zinb_plf zip zip_llf zip_p zip_plf zt_ct_5 zt_hc_5 zt_hcd_5 zt_is_5 zt_iss_5 zt_sho_5 zt_smp_5 ztbase_5 ztcox_5 ztdes_5 ztereg_5 ztfill_5 ztgen_5 ztir_5 ztjoin_5 ztnb ztnb_p ztp ztp_p zts_5 ztset_5 ztspli_5 ztsum_5 zttoct_5 ztvary_5 ztweib_5",c:[{cN:"label",v:[{b:"\\$\\{?[a-zA-Z0-9_]+\\}?"},{b:"`[a-zA-Z0-9_]+'"}]},{cN:"string",v:[{b:'`"[^\r\n]*?"\''},{b:'"[^\r\n"]*"'}]},{cN:"literal",v:[{b:"\\b(abs|acos|asin|atan|atan2|atanh|ceil|cloglog|comb|cos|digamma|exp|floor|invcloglog|invlogit|ln|lnfact|lnfactorial|lngamma|log|log10|max|min|mod|reldif|round|sign|sin|sqrt|sum|tan|tanh|trigamma|trunc|betaden|Binomial|binorm|binormal|chi2|chi2tail|dgammapda|dgammapdada|dgammapdadx|dgammapdx|dgammapdxdx|F|Fden|Ftail|gammaden|gammap|ibeta|invbinomial|invchi2|invchi2tail|invF|invFtail|invgammap|invibeta|invnchi2|invnFtail|invnibeta|invnorm|invnormal|invttail|nbetaden|nchi2|nFden|nFtail|nibeta|norm|normal|normalden|normd|npnchi2|tden|ttail|uniform|abbrev|char|index|indexnot|length|lower|ltrim|match|plural|proper|real|regexm|regexr|regexs|reverse|rtrim|string|strlen|strlower|strltrim|strmatch|strofreal|strpos|strproper|strreverse|strrtrim|strtrim|strupper|subinstr|subinword|substr|trim|upper|word|wordcount|_caller|autocode|byteorder|chop|clip|cond|e|epsdouble|epsfloat|group|inlist|inrange|irecode|matrix|maxbyte|maxdouble|maxfloat|maxint|maxlong|mi|minbyte|mindouble|minfloat|minint|minlong|missing|r|recode|replay|return|s|scalar|d|date|day|dow|doy|halfyear|mdy|month|quarter|week|year|d|daily|dofd|dofh|dofm|dofq|dofw|dofy|h|halfyearly|hofd|m|mofd|monthly|q|qofd|quarterly|tin|twithin|w|weekly|wofd|y|yearly|yh|ym|yofd|yq|yw|cholesky|colnumb|colsof|corr|det|diag|diag0cnt|el|get|hadamard|I|inv|invsym|issym|issymmetric|J|matmissing|matuniform|mreldif|nullmat|rownumb|rowsof|sweep|syminv|trace|vec|vecdiag)(?=\\(|$)"}]},e.C("^[ ]*\\*.*$",!1),e.CLCM,e.CBCM]}});hljs.registerLanguage("asciidoc",function(e){return{aliases:["adoc"],c:[e.C("^/{4,}\\n","\\n/{4,}$",{r:10}),e.C("^//","$",{r:0}),{cN:"title",b:"^\\.\\w.*$"},{b:"^[=\\*]{4,}\\n",e:"\\n^[=\\*]{4,}$",r:10},{cN:"header",b:"^(={1,5}) .+?( \\1)?$",r:10},{cN:"header",b:"^[^\\[\\]\\n]+?\\n[=\\-~\\^\\+]{2,}$",r:10},{cN:"attribute",b:"^:.+?:",e:"\\s",eE:!0,r:10},{cN:"attribute",b:"^\\[.+?\\]$",r:0},{cN:"blockquote",b:"^_{4,}\\n",e:"\\n_{4,}$",r:10},{cN:"code",b:"^[\\-\\.]{4,}\\n",e:"\\n[\\-\\.]{4,}$",r:10},{b:"^\\+{4,}\\n",e:"\\n\\+{4,}$",c:[{b:"<",e:">",sL:"xml",r:0}],r:10},{cN:"bullet",b:"^(\\*+|\\-+|\\.+|[^\\n]+?::)\\s+"},{cN:"label",b:"^(NOTE|TIP|IMPORTANT|WARNING|CAUTION):\\s+",r:10},{cN:"strong",b:"\\B\\*(?![\\*\\s])",e:"(\\n{2}|\\*)",c:[{b:"\\\\*\\w",r:0}]},{cN:"emphasis",b:"\\B'(?!['\\s])",e:"(\\n{2}|')",c:[{b:"\\\\'\\w",r:0}],r:0},{cN:"emphasis",b:"_(?![_\\s])",e:"(\\n{2}|_)",r:0},{cN:"smartquote",v:[{b:"``.+?''"},{b:"`.+?'"}]},{cN:"code",b:"(`.+?`|\\+.+?\\+)",r:0},{cN:"code",b:"^[ \\t]",e:"$",r:0},{cN:"horizontal_rule",b:"^'{3,}[ \\t]*$",r:10},{b:"(link:)?(http|https|ftp|file|irc|image:?):\\S+\\[.*?\\]",rB:!0,c:[{b:"(link|image:?):",r:0},{cN:"link_url",b:"\\w",e:"[^\\[]+",r:0},{cN:"link_label",b:"\\[",e:"\\]",eB:!0,eE:!0,r:0}],r:10}]}});hljs.registerLanguage("php",function(e){var c={cN:"variable",b:"\\$+[a-zA-Z_-ÿ][a-zA-Z0-9_-ÿ]*"},i={cN:"preprocessor",b:/<\?(php)?|\?>/},a={cN:"string",c:[e.BE,i],v:[{b:'b"',e:'"'},{b:"b'",e:"'"},e.inherit(e.ASM,{i:null}),e.inherit(e.QSM,{i:null})]},n={v:[e.BNM,e.CNM]};return{aliases:["php3","php4","php5","php6"],cI:!0,k:"and include_once list abstract global private echo interface as static endswitch array null if endwhile or const for endforeach self var while isset public protected exit foreach throw elseif include __FILE__ empty require_once do xor return parent clone use __CLASS__ __LINE__ else break print eval new catch __METHOD__ case exception default die require __FUNCTION__ enddeclare final try switch continue endfor endif declare unset true false trait goto instanceof insteadof __DIR__ __NAMESPACE__ yield finally",c:[e.CLCM,e.HCM,e.C("/\\*","\\*/",{c:[{cN:"phpdoc",b:"\\s@[A-Za-z]+"},i]}),e.C("__halt_compiler.+?;",!1,{eW:!0,k:"__halt_compiler",l:e.UIR}),{cN:"string",b:"<<<['\"]?\\w+['\"]?$",e:"^\\w+;",c:[e.BE]},i,c,{b:/(::|->)+[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*/},{cN:"function",bK:"function",e:/[;{]/,eE:!0,i:"\\$|\\[|%",c:[e.UTM,{cN:"params",b:"\\(",e:"\\)",c:["self",c,e.CBCM,a,n]}]},{cN:"class",bK:"class interface",e:"{",eE:!0,i:/[:\(\$"]/,c:[{bK:"extends implements"},e.UTM]},{bK:"namespace",e:";",i:/[\.']/,c:[e.UTM]},{bK:"use",e:";",c:[e.UTM]},{b:"=>"},a,n]}});hljs.registerLanguage("java",function(e){var a=e.UIR+"(<"+e.UIR+">)?",t="false synchronized int abstract float private char boolean static null if const for true while long strictfp finally protected import native final void enum else break transient catch instanceof byte super volatile case assert short package default double public try this switch continue throws protected public private",c="(\\b(0b[01_]+)|\\b0[xX][a-fA-F0-9_]+|(\\b[\\d_]+(\\.[\\d_]*)?|\\.[\\d_]+)([eE][-+]?\\d+)?)[lLfF]?",r={cN:"number",b:c,r:0};return{aliases:["jsp"],k:t,i:/<\//,c:[{cN:"javadoc",b:"/\\*\\*",e:"\\*/",r:0,c:[{cN:"javadoctag",b:"(^|\\s)@[A-Za-z]+"}]},e.CLCM,e.CBCM,e.ASM,e.QSM,{cN:"class",bK:"class interface",e:/[{;=]/,eE:!0,k:"class interface",i:/[:"\[\]]/,c:[{bK:"extends implements"},e.UTM]},{bK:"new throw return",r:0},{cN:"function",b:"("+a+"\\s+)+"+e.UIR+"\\s*\\(",rB:!0,e:/[{;=]/,eE:!0,k:t,c:[{b:e.UIR+"\\s*\\(",rB:!0,r:0,c:[e.UTM]},{cN:"params",b:/\(/,e:/\)/,k:t,r:0,c:[e.ASM,e.QSM,e.CNM,e.CBCM]},e.CLCM,e.CBCM]},r,{cN:"annotation",b:"@[A-Za-z]+"}]}});hljs.registerLanguage("glsl",function(e){return{k:{keyword:"atomic_uint attribute bool break bvec2 bvec3 bvec4 case centroid coherent const continue default discard dmat2 dmat2x2 dmat2x3 dmat2x4 dmat3 dmat3x2 dmat3x3 dmat3x4 dmat4 dmat4x2 dmat4x3 dmat4x4 do double dvec2 dvec3 dvec4 else flat float for highp if iimage1D iimage1DArray iimage2D iimage2DArray iimage2DMS iimage2DMSArray iimage2DRect iimage3D iimageBuffer iimageCube iimageCubeArray image1D image1DArray image2D image2DArray image2DMS image2DMSArray image2DRect image3D imageBuffer imageCube imageCubeArray in inout int invariant isampler1D isampler1DArray isampler2D isampler2DArray isampler2DMS isampler2DMSArray isampler2DRect isampler3D isamplerBuffer isamplerCube isamplerCubeArray ivec2 ivec3 ivec4 layout lowp mat2 mat2x2 mat2x3 mat2x4 mat3 mat3x2 mat3x3 mat3x4 mat4 mat4x2 mat4x3 mat4x4 mediump noperspective out patch precision readonly restrict return sample sampler1D sampler1DArray sampler1DArrayShadow sampler1DShadow sampler2D sampler2DArray sampler2DArrayShadow sampler2DMS sampler2DMSArray sampler2DRect sampler2DRectShadow sampler2DShadow sampler3D samplerBuffer samplerCube samplerCubeArray samplerCubeArrayShadow samplerCubeShadow smooth struct subroutine switch uimage1D uimage1DArray uimage2D uimage2DArray uimage2DMS uimage2DMSArray uimage2DRect uimage3D uimageBuffer uimageCube uimageCubeArray uint uniform usampler1D usampler1DArray usampler2D usampler2DArray usampler2DMS usampler2DMSArray usampler2DRect usampler3D usamplerBuffer usamplerCube usamplerCubeArray uvec2 uvec3 uvec4 varying vec2 vec3 vec4 void volatile while writeonly",built_in:"gl_BackColor gl_BackLightModelProduct gl_BackLightProduct gl_BackMaterial gl_BackSecondaryColor gl_ClipDistance gl_ClipPlane gl_ClipVertex gl_Color gl_DepthRange gl_EyePlaneQ gl_EyePlaneR gl_EyePlaneS gl_EyePlaneT gl_Fog gl_FogCoord gl_FogFragCoord gl_FragColor gl_FragCoord gl_FragData gl_FragDepth gl_FrontColor gl_FrontFacing gl_FrontLightModelProduct gl_FrontLightProduct gl_FrontMaterial gl_FrontSecondaryColor gl_InstanceID gl_InvocationID gl_Layer gl_LightModel gl_LightSource gl_MaxAtomicCounterBindings gl_MaxAtomicCounterBufferSize gl_MaxClipDistances gl_MaxClipPlanes gl_MaxCombinedAtomicCounterBuffers gl_MaxCombinedAtomicCounters gl_MaxCombinedImageUniforms gl_MaxCombinedImageUnitsAndFragmentOutputs gl_MaxCombinedTextureImageUnits gl_MaxDrawBuffers gl_MaxFragmentAtomicCounterBuffers gl_MaxFragmentAtomicCounters gl_MaxFragmentImageUniforms gl_MaxFragmentInputComponents gl_MaxFragmentUniformComponents gl_MaxFragmentUniformVectors gl_MaxGeometryAtomicCounterBuffers gl_MaxGeometryAtomicCounters gl_MaxGeometryImageUniforms gl_MaxGeometryInputComponents gl_MaxGeometryOutputComponents gl_MaxGeometryOutputVertices gl_MaxGeometryTextureImageUnits gl_MaxGeometryTotalOutputComponents gl_MaxGeometryUniformComponents gl_MaxGeometryVaryingComponents gl_MaxImageSamples gl_MaxImageUnits gl_MaxLights gl_MaxPatchVertices gl_MaxProgramTexelOffset gl_MaxTessControlAtomicCounterBuffers gl_MaxTessControlAtomicCounters gl_MaxTessControlImageUniforms gl_MaxTessControlInputComponents gl_MaxTessControlOutputComponents gl_MaxTessControlTextureImageUnits gl_MaxTessControlTotalOutputComponents gl_MaxTessControlUniformComponents gl_MaxTessEvaluationAtomicCounterBuffers gl_MaxTessEvaluationAtomicCounters gl_MaxTessEvaluationImageUniforms gl_MaxTessEvaluationInputComponents gl_MaxTessEvaluationOutputComponents gl_MaxTessEvaluationTextureImageUnits gl_MaxTessEvaluationUniformComponents gl_MaxTessGenLevel gl_MaxTessPatchComponents gl_MaxTextureCoords gl_MaxTextureImageUnits gl_MaxTextureUnits gl_MaxVaryingComponents gl_MaxVaryingFloats gl_MaxVaryingVectors gl_MaxVertexAtomicCounterBuffers gl_MaxVertexAtomicCounters gl_MaxVertexAttribs gl_MaxVertexImageUniforms gl_MaxVertexOutputComponents gl_MaxVertexTextureImageUnits gl_MaxVertexUniformComponents gl_MaxVertexUniformVectors gl_MaxViewports gl_MinProgramTexelOffsetgl_ModelViewMatrix gl_ModelViewMatrixInverse gl_ModelViewMatrixInverseTranspose gl_ModelViewMatrixTranspose gl_ModelViewProjectionMatrix gl_ModelViewProjectionMatrixInverse gl_ModelViewProjectionMatrixInverseTranspose gl_ModelViewProjectionMatrixTranspose gl_MultiTexCoord0 gl_MultiTexCoord1 gl_MultiTexCoord2 gl_MultiTexCoord3 gl_MultiTexCoord4 gl_MultiTexCoord5 gl_MultiTexCoord6 gl_MultiTexCoord7 gl_Normal gl_NormalMatrix gl_NormalScale gl_ObjectPlaneQ gl_ObjectPlaneR gl_ObjectPlaneS gl_ObjectPlaneT gl_PatchVerticesIn gl_PerVertex gl_Point gl_PointCoord gl_PointSize gl_Position gl_PrimitiveID gl_PrimitiveIDIn gl_ProjectionMatrix gl_ProjectionMatrixInverse gl_ProjectionMatrixInverseTranspose gl_ProjectionMatrixTranspose gl_SampleID gl_SampleMask gl_SampleMaskIn gl_SamplePosition gl_SecondaryColor gl_TessCoord gl_TessLevelInner gl_TessLevelOuter gl_TexCoord gl_TextureEnvColor gl_TextureMatrixInverseTranspose gl_TextureMatrixTranspose gl_Vertex gl_VertexID gl_ViewportIndex gl_in gl_out EmitStreamVertex EmitVertex EndPrimitive EndStreamPrimitive abs acos acosh all any asin asinh atan atanh atomicCounter atomicCounterDecrement atomicCounterIncrement barrier bitCount bitfieldExtract bitfieldInsert bitfieldReverse ceil clamp cos cosh cross dFdx dFdy degrees determinant distance dot equal exp exp2 faceforward findLSB findMSB floatBitsToInt floatBitsToUint floor fma fract frexp ftransform fwidth greaterThan greaterThanEqual imageAtomicAdd imageAtomicAnd imageAtomicCompSwap imageAtomicExchange imageAtomicMax imageAtomicMin imageAtomicOr imageAtomicXor imageLoad imageStore imulExtended intBitsToFloat interpolateAtCentroid interpolateAtOffset interpolateAtSample inverse inversesqrt isinf isnan ldexp length lessThan lessThanEqual log log2 matrixCompMult max memoryBarrier min mix mod modf noise1 noise2 noise3 noise4 normalize not notEqual outerProduct packDouble2x32 packHalf2x16 packSnorm2x16 packSnorm4x8 packUnorm2x16 packUnorm4x8 pow radians reflect refract round roundEven shadow1D shadow1DLod shadow1DProj shadow1DProjLod shadow2D shadow2DLod shadow2DProj shadow2DProjLod sign sin sinh smoothstep sqrt step tan tanh texelFetch texelFetchOffset texture texture1D texture1DLod texture1DProj texture1DProjLod texture2D texture2DLod texture2DProj texture2DProjLod texture3D texture3DLod texture3DProj texture3DProjLod textureCube textureCubeLod textureGather textureGatherOffset textureGatherOffsets textureGrad textureGradOffset textureLod textureLodOffset textureOffset textureProj textureProjGrad textureProjGradOffset textureProjLod textureProjLodOffset textureProjOffset textureQueryLod textureSize transpose trunc uaddCarry uintBitsToFloat umulExtended unpackDouble2x32 unpackHalf2x16 unpackSnorm2x16 unpackSnorm4x8 unpackUnorm2x16 unpackUnorm4x8 usubBorrow gl_TextureMatrix gl_TextureMatrixInverse",literal:"true false"},i:'"',c:[e.CLCM,e.CBCM,e.CNM,{cN:"preprocessor",b:"#",e:"$"}]}});hljs.registerLanguage("lua",function(e){var t="\\[=*\\[",a="\\]=*\\]",r={b:t,e:a,c:["self"]},n=[e.C("--(?!"+t+")","$"),e.C("--"+t,a,{c:[r],r:10})];return{l:e.UIR,k:{keyword:"and break do else elseif end false for if in local nil not or repeat return then true until while",built_in:"_G _VERSION assert collectgarbage dofile error getfenv getmetatable ipairs load loadfile loadstring module next pairs pcall print rawequal rawget rawset require select setfenv setmetatable tonumber tostring type unpack xpcall coroutine debug io math os package string table"},c:n.concat([{cN:"function",bK:"function",e:"\\)",c:[e.inherit(e.TM,{b:"([_a-zA-Z]\\w*\\.)*([_a-zA-Z]\\w*:)?[_a-zA-Z]\\w*"}),{cN:"params",b:"\\(",eW:!0,c:n}].concat(n)},e.CNM,e.ASM,e.QSM,{cN:"string",b:t,e:a,c:[r],r:5}])}});hljs.registerLanguage("protobuf",function(e){return{k:{keyword:"package import option optional required repeated group",built_in:"double float int32 int64 uint32 uint64 sint32 sint64 fixed32 fixed64 sfixed32 sfixed64 bool string bytes",literal:"true false"},c:[e.QSM,e.NM,e.CLCM,{cN:"class",bK:"message enum service",e:/\{/,i:/\n/,c:[e.inherit(e.TM,{starts:{eW:!0,eE:!0}})]},{cN:"function",bK:"rpc",e:/;/,eE:!0,k:"rpc returns"},{cN:"constant",b:/^\s*[A-Z_]+/,e:/\s*=/,eE:!0}]}});hljs.registerLanguage("gcode",function(e){var N="[A-Z_][A-Z0-9_.]*",i="\\%",c={literal:"",built_in:"",keyword:"IF DO WHILE ENDWHILE CALL ENDIF SUB ENDSUB GOTO REPEAT ENDREPEAT EQ LT GT NE GE LE OR XOR"},r={cN:"preprocessor",b:"([O])([0-9]+)"},l=[e.CLCM,e.CBCM,e.C(/\(/,/\)/),e.inherit(e.CNM,{b:"([-+]?([0-9]*\\.?[0-9]+\\.?))|"+e.CNR}),e.inherit(e.ASM,{i:null}),e.inherit(e.QSM,{i:null}),{cN:"keyword",b:"([G])([0-9]+\\.?[0-9]?)"},{cN:"title",b:"([M])([0-9]+\\.?[0-9]?)"},{cN:"title",b:"(VC|VS|#)",e:"(\\d+)"},{cN:"title",b:"(VZOFX|VZOFY|VZOFZ)"},{cN:"built_in",b:"(ATAN|ABS|ACOS|ASIN|SIN|COS|EXP|FIX|FUP|ROUND|LN|TAN)(\\[)",e:"([-+]?([0-9]*\\.?[0-9]+\\.?))(\\])"},{cN:"label",v:[{b:"N",e:"\\d+",i:"\\W"}]}];return{aliases:["nc"],cI:!0,l:N,k:c,c:[{cN:"preprocessor",b:i},r].concat(l)}});hljs.registerLanguage("vim",function(e){return{l:/[!#@\w]+/,k:{keyword:"N|0 P|0 X|0 a|0 ab abc abo al am an|0 ar arga argd arge argdo argg argl argu as au aug aun b|0 bN ba bad bd be bel bf bl bm bn bo bp br brea breaka breakd breakl bro bufdo buffers bun bw c|0 cN cNf ca cabc caddb cad caddf cal cat cb cc ccl cd ce cex cf cfir cgetb cgete cg changes chd che checkt cl cla clo cm cmapc cme cn cnew cnf cno cnorea cnoreme co col colo com comc comp con conf cope cp cpf cq cr cs cst cu cuna cunme cw d|0 delm deb debugg delc delf dif diffg diffo diffp diffpu diffs diffthis dig di dl dell dj dli do doautoa dp dr ds dsp e|0 ea ec echoe echoh echom echon el elsei em en endfo endf endt endw ene ex exe exi exu f|0 files filet fin fina fini fir fix fo foldc foldd folddoc foldo for fu g|0 go gr grepa gu gv ha h|0 helpf helpg helpt hi hid his i|0 ia iabc if ij il im imapc ime ino inorea inoreme int is isp iu iuna iunme j|0 ju k|0 keepa kee keepj lN lNf l|0 lad laddb laddf la lan lat lb lc lch lcl lcs le lefta let lex lf lfir lgetb lgete lg lgr lgrepa lh ll lla lli lmak lm lmapc lne lnew lnf ln loadk lo loc lockv lol lope lp lpf lr ls lt lu lua luad luaf lv lvimgrepa lw m|0 ma mak map mapc marks mat me menut mes mk mks mksp mkv mkvie mod mz mzf nbc nb nbs n|0 new nm nmapc nme nn nnoreme noa no noh norea noreme norm nu nun nunme ol o|0 om omapc ome on ono onoreme opt ou ounme ow p|0 profd prof pro promptr pc ped pe perld po popu pp pre prev ps pt ptN ptf ptj ptl ptn ptp ptr pts pu pw py3 python3 py3d py3f py pyd pyf q|0 quita qa r|0 rec red redi redr redraws reg res ret retu rew ri rightb rub rubyd rubyf rund ru rv s|0 sN san sa sal sav sb sbN sba sbf sbl sbm sbn sbp sbr scrip scripte scs se setf setg setl sf sfir sh sim sig sil sl sla sm smap smapc sme sn sni sno snor snoreme sor so spelld spe spelli spellr spellu spellw sp spr sre st sta startg startr star stopi stj sts sun sunm sunme sus sv sw sy synti sync t|0 tN tabN tabc tabdo tabe tabf tabfir tabl tabm tabnew tabn tabo tabp tabr tabs tab ta tags tc tcld tclf te tf th tj tl tm tn to tp tr try ts tu u|0 undoj undol una unh unl unlo unm unme uns up v|0 ve verb vert vim vimgrepa vi viu vie vm vmapc vme vne vn vnoreme vs vu vunme windo w|0 wN wa wh wi winc winp wn wp wq wqa ws wu wv x|0 xa xmapc xm xme xn xnoreme xu xunme y|0 z|0 ~ Next Print append abbreviate abclear aboveleft all amenu anoremenu args argadd argdelete argedit argglobal arglocal argument ascii autocmd augroup aunmenu buffer bNext ball badd bdelete behave belowright bfirst blast bmodified bnext botright bprevious brewind break breakadd breakdel breaklist browse bunload bwipeout change cNext cNfile cabbrev cabclear caddbuffer caddexpr caddfile call catch cbuffer cclose center cexpr cfile cfirst cgetbuffer cgetexpr cgetfile chdir checkpath checktime clist clast close cmap cmapclear cmenu cnext cnewer cnfile cnoremap cnoreabbrev cnoremenu copy colder colorscheme command comclear compiler continue confirm copen cprevious cpfile cquit crewind cscope cstag cunmap cunabbrev cunmenu cwindow delete delmarks debug debuggreedy delcommand delfunction diffupdate diffget diffoff diffpatch diffput diffsplit digraphs display deletel djump dlist doautocmd doautoall deletep drop dsearch dsplit edit earlier echo echoerr echohl echomsg else elseif emenu endif endfor endfunction endtry endwhile enew execute exit exusage file filetype find finally finish first fixdel fold foldclose folddoopen folddoclosed foldopen function global goto grep grepadd gui gvim hardcopy help helpfind helpgrep helptags highlight hide history insert iabbrev iabclear ijump ilist imap imapclear imenu inoremap inoreabbrev inoremenu intro isearch isplit iunmap iunabbrev iunmenu join jumps keepalt keepmarks keepjumps lNext lNfile list laddexpr laddbuffer laddfile last language later lbuffer lcd lchdir lclose lcscope left leftabove lexpr lfile lfirst lgetbuffer lgetexpr lgetfile lgrep lgrepadd lhelpgrep llast llist lmake lmap lmapclear lnext lnewer lnfile lnoremap loadkeymap loadview lockmarks lockvar lolder lopen lprevious lpfile lrewind ltag lunmap luado luafile lvimgrep lvimgrepadd lwindow move mark make mapclear match menu menutranslate messages mkexrc mksession mkspell mkvimrc mkview mode mzscheme mzfile nbclose nbkey nbsart next nmap nmapclear nmenu nnoremap nnoremenu noautocmd noremap nohlsearch noreabbrev noremenu normal number nunmap nunmenu oldfiles open omap omapclear omenu only onoremap onoremenu options ounmap ounmenu ownsyntax print profdel profile promptfind promptrepl pclose pedit perl perldo pop popup ppop preserve previous psearch ptag ptNext ptfirst ptjump ptlast ptnext ptprevious ptrewind ptselect put pwd py3do py3file python pydo pyfile quit quitall qall read recover redo redir redraw redrawstatus registers resize retab return rewind right rightbelow ruby rubydo rubyfile rundo runtime rviminfo substitute sNext sandbox sargument sall saveas sbuffer sbNext sball sbfirst sblast sbmodified sbnext sbprevious sbrewind scriptnames scriptencoding scscope set setfiletype setglobal setlocal sfind sfirst shell simalt sign silent sleep slast smagic smapclear smenu snext sniff snomagic snoremap snoremenu sort source spelldump spellgood spellinfo spellrepall spellundo spellwrong split sprevious srewind stop stag startgreplace startreplace startinsert stopinsert stjump stselect sunhide sunmap sunmenu suspend sview swapname syntax syntime syncbind tNext tabNext tabclose tabedit tabfind tabfirst tablast tabmove tabnext tabonly tabprevious tabrewind tag tcl tcldo tclfile tearoff tfirst throw tjump tlast tmenu tnext topleft tprevious trewind tselect tunmenu undo undojoin undolist unabbreviate unhide unlet unlockvar unmap unmenu unsilent update vglobal version verbose vertical vimgrep vimgrepadd visual viusage view vmap vmapclear vmenu vnew vnoremap vnoremenu vsplit vunmap vunmenu write wNext wall while winsize wincmd winpos wnext wprevious wqall wsverb wundo wviminfo xit xall xmapclear xmap xmenu xnoremap xnoremenu xunmap xunmenu yank",built_in:"abs acos add and append argc argidx argv asin atan atan2 browse browsedir bufexists buflisted bufloaded bufname bufnr bufwinnr byte2line byteidx call ceil changenr char2nr cindent clearmatches col complete complete_add complete_check confirm copy cos cosh count cscope_connection cursor deepcopy delete did_filetype diff_filler diff_hlID empty escape eval eventhandler executable exists exp expand extend feedkeys filereadable filewritable filter finddir findfile float2nr floor fmod fnameescape fnamemodify foldclosed foldclosedend foldlevel foldtext foldtextresult foreground function garbagecollect get getbufline getbufvar getchar getcharmod getcmdline getcmdpos getcmdtype getcwd getfontname getfperm getfsize getftime getftype getline getloclist getmatches getpid getpos getqflist getreg getregtype gettabvar gettabwinvar getwinposx getwinposy getwinvar glob globpath has has_key haslocaldir hasmapto histadd histdel histget histnr hlexists hlID hostname iconv indent index input inputdialog inputlist inputrestore inputsave inputsecret insert invert isdirectory islocked items join keys len libcall libcallnr line line2byte lispindent localtime log log10 luaeval map maparg mapcheck match matchadd matcharg matchdelete matchend matchlist matchstr max min mkdir mode mzeval nextnonblank nr2char or pathshorten pow prevnonblank printf pumvisible py3eval pyeval range readfile reltime reltimestr remote_expr remote_foreground remote_peek remote_read remote_send remove rename repeat resolve reverse round screenattr screenchar screencol screenrow search searchdecl searchpair searchpairpos searchpos server2client serverlist setbufvar setcmdpos setline setloclist setmatches setpos setqflist setreg settabvar settabwinvar setwinvar sha256 shellescape shiftwidth simplify sin sinh sort soundfold spellbadword spellsuggest split sqrt str2float str2nr strchars strdisplaywidth strftime stridx string strlen strpart strridx strtrans strwidth submatch substitute synconcealed synID synIDattr synIDtrans synstack system tabpagebuflist tabpagenr tabpagewinnr tagfiles taglist tan tanh tempname tolower toupper tr trunc type undofile undotree values virtcol visualmode wildmenumode winbufnr wincol winheight winline winnr winrestcmd winrestview winsaveview winwidth writefile xor"},i:/[{:]/,c:[e.NM,e.ASM,{cN:"string",b:/"((\\")|[^"\n])*("|\n)/},{cN:"variable",b:/[bwtglsav]:[\w\d_]*/},{cN:"function",bK:"function function!",e:"$",r:0,c:[e.TM,{cN:"params",b:"\\(",e:"\\)"}]}]}});hljs.registerLanguage("processing",function(e){return{k:{keyword:"BufferedReader PVector PFont PImage PGraphics HashMap boolean byte char color double float int long String Array FloatDict FloatList IntDict IntList JSONArray JSONObject Object StringDict StringList Table TableRow XML false synchronized int abstract float private char boolean static null if const for true while long throw strictfp finally protected import native final return void enum else break transient new catch instanceof byte super volatile case assert short package default double public try this switch continue throws protected public private",constant:"P2D P3D HALF_PI PI QUARTER_PI TAU TWO_PI",variable:"displayHeight displayWidth mouseY mouseX mousePressed pmouseX pmouseY key keyCode pixels focused frameCount frameRate height width",title:"setup draw",built_in:"size createGraphics beginDraw createShape loadShape PShape arc ellipse line point quad rect triangle bezier bezierDetail bezierPoint bezierTangent curve curveDetail curvePoint curveTangent curveTightness shape shapeMode beginContour beginShape bezierVertex curveVertex endContour endShape quadraticVertex vertex ellipseMode noSmooth rectMode smooth strokeCap strokeJoin strokeWeight mouseClicked mouseDragged mouseMoved mousePressed mouseReleased mouseWheel keyPressed keyPressedkeyReleased keyTyped print println save saveFrame day hour millis minute month second year background clear colorMode fill noFill noStroke stroke alpha blue brightness color green hue lerpColor red saturation modelX modelY modelZ screenX screenY screenZ ambient emissive shininess specular add createImage beginCamera camera endCamera frustum ortho perspective printCamera printProjection cursor frameRate noCursor exit loop noLoop popStyle pushStyle redraw binary boolean byte char float hex int str unbinary unhex join match matchAll nf nfc nfp nfs split splitTokens trim append arrayCopy concat expand reverse shorten sort splice subset box sphere sphereDetail createInput createReader loadBytes loadJSONArray loadJSONObject loadStrings loadTable loadXML open parseXML saveTable selectFolder selectInput beginRaw beginRecord createOutput createWriter endRaw endRecord PrintWritersaveBytes saveJSONArray saveJSONObject saveStream saveStrings saveXML selectOutput popMatrix printMatrix pushMatrix resetMatrix rotate rotateX rotateY rotateZ scale shearX shearY translate ambientLight directionalLight lightFalloff lights lightSpecular noLights normal pointLight spotLight image imageMode loadImage noTint requestImage tint texture textureMode textureWrap blend copy filter get loadPixels set updatePixels blendMode loadShader PShaderresetShader shader createFont loadFont text textFont textAlign textLeading textMode textSize textWidth textAscent textDescent abs ceil constrain dist exp floor lerp log mag map max min norm pow round sq sqrt acos asin atan atan2 cos degrees radians sin tan noise noiseDetail noiseSeed random randomGaussian randomSeed"},c:[e.CLCM,e.CBCM,e.ASM,e.QSM,e.CNM]}});hljs.registerLanguage("mizar",function(e){return{k:"environ vocabularies notations constructors definitions registrations theorems schemes requirements begin end definition registration cluster existence pred func defpred deffunc theorem proof let take assume then thus hence ex for st holds consider reconsider such that and in provided of as from be being by means equals implies iff redefine define now not or attr is mode suppose per cases set thesis contradiction scheme reserve struct correctness compatibility coherence symmetry assymetry reflexivity irreflexivity connectedness uniqueness commutativity idempotence involutiveness projectivity",c:[e.C("::","$")]}});hljs.registerLanguage("vbnet",function(e){return{aliases:["vb"],cI:!0,k:{keyword:"addhandler addressof alias and andalso aggregate ansi as assembly auto binary by byref byval call case catch class compare const continue custom declare default delegate dim distinct do each equals else elseif end enum erase error event exit explicit finally for friend from function get global goto group handles if implements imports in inherits interface into is isfalse isnot istrue join key let lib like loop me mid mod module mustinherit mustoverride mybase myclass namespace narrowing new next not notinheritable notoverridable of off on operator option optional or order orelse overloads overridable overrides paramarray partial preserve private property protected public raiseevent readonly redim rem removehandler resume return select set shadows shared skip static step stop structure strict sub synclock take text then throw to try unicode until using when where while widening with withevents writeonly xor",built_in:"boolean byte cbool cbyte cchar cdate cdec cdbl char cint clng cobj csbyte cshort csng cstr ctype date decimal directcast double gettype getxmlnamespace iif integer long object sbyte short single string trycast typeof uinteger ulong ushort",literal:"true false nothing"},i:"//|{|}|endif|gosub|variant|wend",c:[e.inherit(e.QSM,{c:[{b:'""'}]}),e.C("'","$",{rB:!0,c:[{cN:"xmlDocTag",b:"'''|<!--|-->",c:[e.PWM]},{cN:"xmlDocTag",b:"</?",e:">",c:[e.PWM]}]}),e.CNM,{cN:"preprocessor",b:"#",e:"$",k:"if else elseif end region externalsource"}]}});hljs.registerLanguage("q",function(e){var s={keyword:"do while select delete by update from",constant:"0b 1b",built_in:"neg not null string reciprocal floor ceiling signum mod xbar xlog and or each scan over prior mmu lsq inv md5 ltime gtime count first var dev med cov cor all any rand sums prds mins maxs fills deltas ratios avgs differ prev next rank reverse iasc idesc asc desc msum mcount mavg mdev xrank mmin mmax xprev rotate distinct group where flip type key til get value attr cut set upsert raze union inter except cross sv vs sublist enlist read0 read1 hopen hclose hdel hsym hcount peach system ltrim rtrim trim lower upper ssr view tables views cols xcols keys xkey xcol xasc xdesc fkeys meta lj aj aj0 ij pj asof uj ww wj wj1 fby xgroup ungroup ej save load rsave rload show csv parse eval min max avg wavg wsum sin cos tan sum",typename:"`float `double int `timestamp `timespan `datetime `time `boolean `symbol `char `byte `short `long `real `month `date `minute `second `guid"};return{aliases:["k","kdb"],k:s,l:/\b(`?)[A-Za-z0-9_]+\b/,c:[e.CLCM,e.QSM,e.CNM]}});hljs.registerLanguage("livescript",function(e){var t={keyword:"in if for while finally new do return else break catch instanceof throw try this switch continue typeof delete debugger case default function var with then unless until loop of by when and or is isnt not it that otherwise from to til fallthrough super case default function var void const let enum export import native __hasProp __extends __slice __bind __indexOf",literal:"true false null undefined yes no on off it that void",built_in:"npm require console print module global window document"},s="[A-Za-z$_](?:-[0-9A-Za-z$_]|[0-9A-Za-z$_])*",i=e.inherit(e.TM,{b:s}),n={cN:"subst",b:/#\{/,e:/}/,k:t},r={cN:"subst",b:/#[A-Za-z$_]/,e:/(?:\-[0-9A-Za-z$_]|[0-9A-Za-z$_])*/,k:t},c=[e.BNM,{cN:"number",b:"(\\b0[xX][a-fA-F0-9_]+)|(\\b\\d(\\d|_\\d)*(\\.(\\d(\\d|_\\d)*)?)?(_*[eE]([-+]\\d(_\\d|\\d)*)?)?[_a-z]*)",r:0,starts:{e:"(\\s*/)?",r:0}},{cN:"string",v:[{b:/'''/,e:/'''/,c:[e.BE]},{b:/'/,e:/'/,c:[e.BE]},{b:/"""/,e:/"""/,c:[e.BE,n,r]},{b:/"/,e:/"/,c:[e.BE,n,r]},{b:/\\/,e:/(\s|$)/,eE:!0}]},{cN:"pi",v:[{b:"//",e:"//[gim]*",c:[n,e.HCM]},{b:/\/(?![ *])(\\\/|.)*?\/[gim]*(?=\W|$)/}]},{cN:"property",b:"@"+s},{b:"``",e:"``",eB:!0,eE:!0,sL:"javascript"}];n.c=c;var a={cN:"params",b:"\\(",rB:!0,c:[{b:/\(/,e:/\)/,k:t,c:["self"].concat(c)}]};return{aliases:["ls"],k:t,i:/\/\*/,c:c.concat([e.C("\\/\\*","\\*\\/"),e.HCM,{cN:"function",c:[i,a],rB:!0,v:[{b:"("+s+"\\s*(?:=|:=)\\s*)?(\\(.*\\))?\\s*\\B\\->\\*?",e:"\\->\\*?"},{b:"("+s+"\\s*(?:=|:=)\\s*)?!?(\\(.*\\))?\\s*\\B[-~]{1,2}>\\*?",e:"[-~]{1,2}>\\*?"},{b:"("+s+"\\s*(?:=|:=)\\s*)?(\\(.*\\))?\\s*\\B!?[-~]{1,2}>\\*?",e:"!?[-~]{1,2}>\\*?"}]},{cN:"class",bK:"class",e:"$",i:/[:="\[\]]/,c:[{bK:"extends",eW:!0,i:/[:="\[\]]/,c:[i]},i]},{cN:"attribute",b:s+":",e:":",rB:!0,rE:!0,r:0}])}});hljs.registerLanguage("haxe",function(e){var r="([*]|[a-zA-Z_$][a-zA-Z0-9_$]*)";return{aliases:["hx"],k:{keyword:"break callback case cast catch class continue default do dynamic else enum extends extern for function here if implements import in inline interface never new override package private public return static super switch this throw trace try typedef untyped using var while",literal:"true false null"},c:[e.ASM,e.QSM,e.CLCM,e.CBCM,e.CNM,{cN:"class",bK:"class interface",e:"{",eE:!0,c:[{bK:"extends implements"},e.TM]},{cN:"preprocessor",b:"#",e:"$",k:"if else elseif end error"},{cN:"function",bK:"function",e:"[{;]",eE:!0,i:"\\S",c:[e.TM,{cN:"params",b:"\\(",e:"\\)",c:[e.ASM,e.QSM,e.CLCM,e.CBCM]},{cN:"type",b:":",e:r,r:10}]}]}});hljs.registerLanguage("monkey",function(e){var n={cN:"number",r:0,v:[{b:"[$][a-fA-F0-9]+"},e.NM]};return{cI:!0,k:{keyword:"public private property continue exit extern new try catch eachin not abstract final select case default const local global field end if then else elseif endif while wend repeat until forever for to step next return module inline throw",built_in:"DebugLog DebugStop Error Print ACos ACosr ASin ASinr ATan ATan2 ATan2r ATanr Abs Abs Ceil Clamp Clamp Cos Cosr Exp Floor Log Max Max Min Min Pow Sgn Sgn Sin Sinr Sqrt Tan Tanr Seed PI HALFPI TWOPI",literal:"true false null and or shl shr mod"},c:[e.C("#rem","#end"),e.C("'","$",{r:0}),{cN:"function",bK:"function method",e:"[(=:]|$",i:/\n/,c:[e.UTM]},{cN:"class",bK:"class interface",e:"$",c:[{bK:"extends implements"},e.UTM]},{cN:"variable",b:"\\b(self|super)\\b"},{cN:"preprocessor",bK:"import",e:"$"},{cN:"preprocessor",b:"\\s*#",e:"$",k:"if else elseif endif end then"},{cN:"pi",b:"^\\s*strict\\b"},{bK:"alias",e:"=",c:[e.UTM]},e.QSM,n]}});hljs.registerLanguage("bash",function(e){var t={cN:"variable",v:[{b:/\$[\w\d#@][\w\d_]*/},{b:/\$\{(.*?)}/}]},s={cN:"string",b:/"/,e:/"/,c:[e.BE,t,{cN:"variable",b:/\$\(/,e:/\)/,c:[e.BE]}]},a={cN:"string",b:/'/,e:/'/};return{aliases:["sh","zsh"],l:/-?[a-z\.]+/,k:{keyword:"if then else elif fi for while in do done case esac function",literal:"true false",built_in:"break cd continue eval exec exit export getopts hash pwd readonly return shift test times trap umask unset alias bind builtin caller command declare echo enable help let local logout mapfile printf read readarray source type typeset ulimit unalias set shopt autoload bg bindkey bye cap chdir clone comparguments compcall compctl compdescribe compfiles compgroups compquote comptags comptry compvalues dirs disable disown echotc echoti emulate fc fg float functions getcap getln history integer jobs kill limit log noglob popd print pushd pushln rehash sched setcap setopt stat suspend ttyctl unfunction unhash unlimit unsetopt vared wait whence where which zcompile zformat zftp zle zmodload zparseopts zprof zpty zregexparse zsocket zstyle ztcp",operator:"-ne -eq -lt -gt -f -d -e -s -l -a"},c:[{cN:"shebang",b:/^#![^\n]+sh\s*$/,r:10},{cN:"function",b:/\w[\w\d_]*\s*\(\s*\)\s*\{/,rB:!0,c:[e.inherit(e.TM,{b:/\w[\w\d_]*/})],r:0},e.HCM,e.NM,s,a,t]}});hljs.registerLanguage("erlang",function(e){var r="[a-z'][a-zA-Z0-9_']*",c="("+r+":"+r+"|"+r+")",a={keyword:"after and andalso|10 band begin bnot bor bsl bzr bxor case catch cond div end fun if let not of orelse|10 query receive rem try when xor",literal:"false true"},n=e.C("%","$"),i={cN:"number",b:"\\b(\\d+#[a-fA-F0-9]+|\\d+(\\.\\d+)?([eE][-+]?\\d+)?)",r:0},b={b:"fun\\s+"+r+"/\\d+"},d={b:c+"\\(",e:"\\)",rB:!0,r:0,c:[{cN:"function_name",b:c,r:0},{b:"\\(",e:"\\)",eW:!0,rE:!0,r:0}]},o={cN:"tuple",b:"{",e:"}",r:0},t={cN:"variable",b:"\\b_([A-Z][A-Za-z0-9_]*)?",r:0},l={cN:"variable",b:"[A-Z][a-zA-Z0-9_]*",r:0},f={b:"#"+e.UIR,r:0,rB:!0,c:[{cN:"record_name",b:"#"+e.UIR,r:0},{b:"{",e:"}",r:0}]},s={bK:"fun receive if try case",e:"end",k:a};s.c=[n,b,e.inherit(e.ASM,{cN:""}),s,d,e.QSM,i,o,t,l,f];var u=[n,b,s,d,e.QSM,i,o,t,l,f];d.c[1].c=u,o.c=u,f.c[1].c=u;var v={cN:"params",b:"\\(",e:"\\)",c:u};return{aliases:["erl"],k:a,i:"(</|\\*=|\\+=|-=|/\\*|\\*/|\\(\\*|\\*\\))",c:[{cN:"function",b:"^"+r+"\\s*\\(",e:"->",rB:!0,i:"\\(|#|//|/\\*|\\\\|:|;",c:[v,e.inherit(e.TM,{b:r})],starts:{e:";|\\.",k:a,c:u}},n,{cN:"pp",b:"^-",e:"\\.",r:0,eE:!0,rB:!0,l:"-"+e.IR,k:"-module -record -undef -export -ifdef -ifndef -author -copyright -doc -vsn -import -include -include_lib -compile -define -else -endif -file -behaviour -behavior -spec",c:[v]},i,e.QSM,f,t,l,o,{b:/\.$/}]}});hljs.registerLanguage("kotlin",function(e){var a="val var get set class trait object public open private protected final enum if else do while for when break continue throw try catch finally import package is as in return fun override default companion reified inline volatile transient native";return{k:{typename:"Byte Short Char Int Long Boolean Float Double Void Unit Nothing",literal:"true false null",keyword:a},c:[e.CLCM,{cN:"javadoc",b:"/\\*\\*",e:"\\*//*",r:0,c:[{cN:"javadoctag",b:"(^|\\s)@[A-Za-z]+"}]},e.CBCM,{cN:"type",b:/</,e:/>/,rB:!0,eE:!1,r:0},{cN:"function",bK:"fun",e:"[(]|$",rB:!0,eE:!0,k:a,i:/fun\s+(<.*>)?[^\s\(]+(\s+[^\s\(]+)\s*=/,r:5,c:[{b:e.UIR+"\\s*\\(",rB:!0,r:0,c:[e.UTM]},{cN:"type",b:/</,e:/>/,k:"reified",r:0},{cN:"params",b:/\(/,e:/\)/,k:a,r:0,i:/\([^\(,\s:]+,/,c:[{cN:"typename",b:/:\s*/,e:/\s*[=\)]/,eB:!0,rE:!0,r:0}]},e.CLCM,e.CBCM]},{cN:"class",bK:"class trait",e:/[:\{(]|$/,eE:!0,i:"extends implements",c:[e.UTM,{cN:"type",b:/</,e:/>/,eB:!0,eE:!0,r:0},{cN:"typename",b:/[,:]\s*/,e:/[<\(,]|$/,eB:!0,rE:!0}]},{cN:"variable",bK:"var val",e:/\s*[=:$]/,eE:!0},e.QSM,{cN:"shebang",b:"^#!/usr/bin/env",e:"$",i:"\n"},e.CNM]}});hljs.registerLanguage("stylus",function(t){var e={cN:"variable",b:"\\$"+t.IR},o={cN:"hexcolor",b:"#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})",r:10},i=["charset","css","debug","extend","font-face","for","import","include","media","mixin","page","warn","while"],r=["after","before","first-letter","first-line","active","first-child","focus","hover","lang","link","visited"],n=["a","abbr","address","article","aside","audio","b","blockquote","body","button","canvas","caption","cite","code","dd","del","details","dfn","div","dl","dt","em","fieldset","figcaption","figure","footer","form","h1","h2","h3","h4","h5","h6","header","hgroup","html","i","iframe","img","input","ins","kbd","label","legend","li","mark","menu","nav","object","ol","p","q","quote","samp","section","span","strong","summary","sup","table","tbody","td","textarea","tfoot","th","thead","time","tr","ul","var","video"],a="[\\.\\s\\n\\[\\:,]",l=["align-content","align-items","align-self","animation","animation-delay","animation-direction","animation-duration","animation-fill-mode","animation-iteration-count","animation-name","animation-play-state","animation-timing-function","auto","backface-visibility","background","background-attachment","background-clip","background-color","background-image","background-origin","background-position","background-repeat","background-size","border","border-bottom","border-bottom-color","border-bottom-left-radius","border-bottom-right-radius","border-bottom-style","border-bottom-width","border-collapse","border-color","border-image","border-image-outset","border-image-repeat","border-image-slice","border-image-source","border-image-width","border-left","border-left-color","border-left-style","border-left-width","border-radius","border-right","border-right-color","border-right-style","border-right-width","border-spacing","border-style","border-top","border-top-color","border-top-left-radius","border-top-right-radius","border-top-style","border-top-width","border-width","bottom","box-decoration-break","box-shadow","box-sizing","break-after","break-before","break-inside","caption-side","clear","clip","clip-path","color","column-count","column-fill","column-gap","column-rule","column-rule-color","column-rule-style","column-rule-width","column-span","column-width","columns","content","counter-increment","counter-reset","cursor","direction","display","empty-cells","filter","flex","flex-basis","flex-direction","flex-flow","flex-grow","flex-shrink","flex-wrap","float","font","font-family","font-feature-settings","font-kerning","font-language-override","font-size","font-size-adjust","font-stretch","font-style","font-variant","font-variant-ligatures","font-weight","height","hyphens","icon","image-orientation","image-rendering","image-resolution","ime-mode","inherit","initial","justify-content","left","letter-spacing","line-height","list-style","list-style-image","list-style-position","list-style-type","margin","margin-bottom","margin-left","margin-right","margin-top","marks","mask","max-height","max-width","min-height","min-width","nav-down","nav-index","nav-left","nav-right","nav-up","none","normal","object-fit","object-position","opacity","order","orphans","outline","outline-color","outline-offset","outline-style","outline-width","overflow","overflow-wrap","overflow-x","overflow-y","padding","padding-bottom","padding-left","padding-right","padding-top","page-break-after","page-break-before","page-break-inside","perspective","perspective-origin","pointer-events","position","quotes","resize","right","tab-size","table-layout","text-align","text-align-last","text-decoration","text-decoration-color","text-decoration-line","text-decoration-style","text-indent","text-overflow","text-rendering","text-shadow","text-transform","text-underline-position","top","transform","transform-origin","transform-style","transition","transition-delay","transition-duration","transition-property","transition-timing-function","unicode-bidi","vertical-align","visibility","white-space","widows","width","word-break","word-spacing","word-wrap","z-index"],d=["\\{","\\}","\\?","(\\bReturn\\b)","(\\bEnd\\b)","(\\bend\\b)",";","#\\s","\\*\\s","===\\s","\\|","%"];return{aliases:["styl"],cI:!1,i:"("+d.join("|")+")",k:"if else for in",c:[t.QSM,t.ASM,t.CLCM,t.CBCM,o,{b:"\\.[a-zA-Z][a-zA-Z0-9_-]*"+a,rB:!0,c:[{cN:"class",b:"\\.[a-zA-Z][a-zA-Z0-9_-]*"}]},{b:"\\#[a-zA-Z][a-zA-Z0-9_-]*"+a,rB:!0,c:[{cN:"id",b:"\\#[a-zA-Z][a-zA-Z0-9_-]*"}]},{b:"\\b("+n.join("|")+")"+a,rB:!0,c:[{cN:"tag",b:"\\b[a-zA-Z][a-zA-Z0-9_-]*"}]},{cN:"pseudo",b:"&?:?:\\b("+r.join("|")+")"+a},{cN:"at_rule",b:"@("+i.join("|")+")\\b"},e,t.CSSNM,t.NM,{cN:"function",b:"\\b[a-zA-Z][a-zA-Z0-9_-]*\\(.*\\)",i:"[\\n]",rB:!0,c:[{cN:"title",b:"\\b[a-zA-Z][a-zA-Z0-9_-]*"},{cN:"params",b:/\(/,e:/\)/,c:[o,e,t.ASM,t.CSSNM,t.NM,t.QSM]}]},{cN:"attribute",b:"\\b("+l.reverse().join("|")+")\\b"}]}});hljs.registerLanguage("css",function(e){var c="[a-zA-Z-][a-zA-Z0-9_-]*",a={cN:"function",b:c+"\\(",rB:!0,eE:!0,e:"\\("},r={cN:"rule",b:/[A-Z\_\.\-]+\s*:/,rB:!0,e:";",eW:!0,c:[{cN:"attribute",b:/\S/,e:":",eE:!0,starts:{cN:"value",eW:!0,eE:!0,c:[a,e.CSSNM,e.QSM,e.ASM,e.CBCM,{cN:"hexcolor",b:"#[0-9A-Fa-f]+"},{cN:"important",b:"!important"}]}}]};return{cI:!0,i:/[=\/|']/,c:[e.CBCM,r,{cN:"id",b:/\#[A-Za-z0-9_-]+/},{cN:"class",b:/\.[A-Za-z0-9_-]+/,r:0},{cN:"attr_selector",b:/\[/,e:/\]/,i:"$"},{cN:"pseudo",b:/:(:)?[a-zA-Z0-9\_\-\+\(\)"']+/},{cN:"at_rule",b:"@(font-face|page)",l:"[a-z-]+",k:"font-face page"},{cN:"at_rule",b:"@",e:"[{;]",c:[{cN:"keyword",b:/\S+/},{b:/\s/,eW:!0,eE:!0,r:0,c:[a,e.ASM,e.QSM,e.CSSNM]}]},{cN:"tag",b:c,r:0},{cN:"rules",b:"{",e:"}",i:/\S/,r:0,c:[e.CBCM,r]}]}});hljs.registerLanguage("puppet",function(e){var s="augeas computer cron exec file filebucket host interface k5login macauthorization mailalias maillist mcx mount nagios_command nagios_contact nagios_contactgroup nagios_host nagios_hostdependency nagios_hostescalation nagios_hostextinfo nagios_hostgroup nagios_service firewall nagios_servicedependency nagios_serviceescalation nagios_serviceextinfo nagios_servicegroup nagios_timeperiod notify package resources router schedule scheduled_task selboolean selmodule service ssh_authorized_key sshkey stage tidy user vlan yumrepo zfs zone zpool",r="alias audit before loglevel noop require subscribe tag owner ensure group mode name|0 changes context force incl lens load_path onlyif provider returns root show_diff type_check en_address ip_address realname command environment hour monute month monthday special target weekday creates cwd ogoutput refresh refreshonly tries try_sleep umask backup checksum content ctime force ignore links mtime purge recurse recurselimit replace selinux_ignore_defaults selrange selrole seltype seluser source souirce_permissions sourceselect validate_cmd validate_replacement allowdupe attribute_membership auth_membership forcelocal gid ia_load_module members system host_aliases ip allowed_trunk_vlans description device_url duplex encapsulation etherchannel native_vlan speed principals allow_root auth_class auth_type authenticate_user k_of_n mechanisms rule session_owner shared options device fstype enable hasrestart directory present absent link atboot blockdevice device dump pass remounts poller_tag use message withpath adminfile allow_virtual allowcdrom category configfiles flavor install_options instance package_settings platform responsefile status uninstall_options vendor unless_system_user unless_uid binary control flags hasstatus manifest pattern restart running start stop allowdupe auths expiry gid groups home iterations key_membership keys managehome membership password password_max_age password_min_age profile_membership profiles project purge_ssh_keys role_membership roles salt shell uid baseurl cost descr enabled enablegroups exclude failovermethod gpgcheck gpgkey http_caching include includepkgs keepalive metadata_expire metalink mirrorlist priority protect proxy proxy_password proxy_username repo_gpgcheck s3_enabled skip_if_unavailable sslcacert sslclientcert sslclientkey sslverify mounted",a={keyword:"and case class default define else elsif false if in import enherits node or true undef unless main settings $string "+s,literal:r,built_in:"architecture augeasversion blockdevices boardmanufacturer boardproductname boardserialnumber cfkey dhcp_servers domain ec2_ ec2_userdata facterversion filesystems ldom fqdn gid hardwareisa hardwaremodel hostname id|0 interfaces ipaddress ipaddress_ ipaddress6 ipaddress6_ iphostnumber is_virtual kernel kernelmajversion kernelrelease kernelversion kernelrelease kernelversion lsbdistcodename lsbdistdescription lsbdistid lsbdistrelease lsbmajdistrelease lsbminordistrelease lsbrelease macaddress macaddress_ macosx_buildversion macosx_productname macosx_productversion macosx_productverson_major macosx_productversion_minor manufacturer memoryfree memorysize netmask metmask_ network_ operatingsystem operatingsystemmajrelease operatingsystemrelease osfamily partitions path physicalprocessorcount processor processorcount productname ps puppetversion rubysitedir rubyversion selinux selinux_config_mode selinux_config_policy selinux_current_mode selinux_current_mode selinux_enforced selinux_policyversion serialnumber sp_ sshdsakey sshecdsakey sshrsakey swapencrypted swapfree swapsize timezone type uniqueid uptime uptime_days uptime_hours uptime_seconds uuid virtual vlans xendomains zfs_version zonenae zones zpool_version"},i=e.C("#","$"),o={cN:"string",c:[e.BE],v:[{b:/'/,e:/'/},{b:/"/,e:/"/}]},n=[o,i,{cN:"keyword",bK:"class",e:"$|;",i:/=/,c:[e.inherit(e.TM,{b:"(::)?[A-Za-z_]\\w*(::\\w+)*"}),i,o]},{cN:"keyword",b:"([a-zA-Z_(::)]+ *\\{)",c:[o,i],r:0},{cN:"keyword",b:"(\\}|\\{)",r:0},{cN:"function",b:"[a-zA-Z_]+\\s*=>"},{cN:"constant",b:"(::)?(\\b[A-Z][a-z_]*(::)?)+",r:0},{cN:"number",b:"(\\b0[0-7_]+)|(\\b0x[0-9a-fA-F_]+)|(\\b[1-9][0-9_]*(\\.[0-9_]+)?)|[0_]\\b",r:0}];return{aliases:["pp"],k:a,c:n}});hljs.registerLanguage("nimrod",function(t){return{aliases:["nim"],k:{keyword:"addr and as asm bind block break|0 case|0 cast const|0 continue|0 converter discard distinct|10 div do elif else|0 end|0 enum|0 except export finally for from generic if|0 import|0 in include|0 interface is isnot|10 iterator|10 let|0 macro method|10 mixin mod nil not notin|10 object|0 of or out proc|10 ptr raise ref|10 return shl shr static template|10 try|0 tuple type|0 using|0 var|0 when while|0 with without xor yield",literal:"shared guarded stdin stdout stderr result|10 true false"},c:[{cN:"decorator",b:/{\./,e:/\.}/,r:10},{cN:"string",b:/[a-zA-Z]\w*"/,e:/"/,c:[{b:/""/}]},{cN:"string",b:/([a-zA-Z]\w*)?"""/,e:/"""/},t.QSM,{cN:"type",b:/\b[A-Z]\w+\b/,r:0},{cN:"type",b:/\b(int|int8|int16|int32|int64|uint|uint8|uint16|uint32|uint64|float|float32|float64|bool|char|string|cstring|pointer|expr|stmt|void|auto|any|range|array|openarray|varargs|seq|set|clong|culong|cchar|cschar|cshort|cint|csize|clonglong|cfloat|cdouble|clongdouble|cuchar|cushort|cuint|culonglong|cstringarray|semistatic)\b/},{cN:"number",b:/\b(0[xX][0-9a-fA-F][_0-9a-fA-F]*)('?[iIuU](8|16|32|64))?/,r:0},{cN:"number",b:/\b(0o[0-7][_0-7]*)('?[iIuUfF](8|16|32|64))?/,r:0},{cN:"number",b:/\b(0(b|B)[01][_01]*)('?[iIuUfF](8|16|32|64))?/,r:0},{cN:"number",b:/\b(\d[_\d]*)('?[iIuUfF](8|16|32|64))?/,r:0},t.HCM]}});hljs.registerLanguage("smalltalk",function(a){var r="[a-z][a-zA-Z0-9_]*",s={cN:"char",b:"\\$.{1}"},c={cN:"symbol",b:"#"+a.UIR};return{aliases:["st"],k:"self super nil true false thisContext",c:[a.C('"','"'),a.ASM,{cN:"class",b:"\\b[A-Z][A-Za-z0-9_]*",r:0},{cN:"method",b:r+":",r:0},a.CNM,c,s,{cN:"localvars",b:"\\|[ ]*"+r+"([ ]+"+r+")*[ ]*\\|",rB:!0,e:/\|/,i:/\S/,c:[{b:"(\\|[ ]*)?"+r}]},{cN:"array",b:"\\#\\(",e:"\\)",c:[a.ASM,s,a.CNM,c]}]}});hljs.registerLanguage("x86asm",function(s){return{cI:!0,l:"\\.?"+s.IR,k:{keyword:"lock rep repe repz repne repnz xaquire xrelease bnd nobnd aaa aad aam aas adc add and arpl bb0_reset bb1_reset bound bsf bsr bswap bt btc btr bts call cbw cdq cdqe clc cld cli clts cmc cmp cmpsb cmpsd cmpsq cmpsw cmpxchg cmpxchg486 cmpxchg8b cmpxchg16b cpuid cpu_read cpu_write cqo cwd cwde daa das dec div dmint emms enter equ f2xm1 fabs fadd faddp fbld fbstp fchs fclex fcmovb fcmovbe fcmove fcmovnb fcmovnbe fcmovne fcmovnu fcmovu fcom fcomi fcomip fcomp fcompp fcos fdecstp fdisi fdiv fdivp fdivr fdivrp femms feni ffree ffreep fiadd ficom ficomp fidiv fidivr fild fimul fincstp finit fist fistp fisttp fisub fisubr fld fld1 fldcw fldenv fldl2e fldl2t fldlg2 fldln2 fldpi fldz fmul fmulp fnclex fndisi fneni fninit fnop fnsave fnstcw fnstenv fnstsw fpatan fprem fprem1 fptan frndint frstor fsave fscale fsetpm fsin fsincos fsqrt fst fstcw fstenv fstp fstsw fsub fsubp fsubr fsubrp ftst fucom fucomi fucomip fucomp fucompp fxam fxch fxtract fyl2x fyl2xp1 hlt ibts icebp idiv imul in inc incbin insb insd insw int int01 int1 int03 int3 into invd invpcid invlpg invlpga iret iretd iretq iretw jcxz jecxz jrcxz jmp jmpe lahf lar lds lea leave les lfence lfs lgdt lgs lidt lldt lmsw loadall loadall286 lodsb lodsd lodsq lodsw loop loope loopne loopnz loopz lsl lss ltr mfence monitor mov movd movq movsb movsd movsq movsw movsx movsxd movzx mul mwait neg nop not or out outsb outsd outsw packssdw packsswb packuswb paddb paddd paddsb paddsiw paddsw paddusb paddusw paddw pand pandn pause paveb pavgusb pcmpeqb pcmpeqd pcmpeqw pcmpgtb pcmpgtd pcmpgtw pdistib pf2id pfacc pfadd pfcmpeq pfcmpge pfcmpgt pfmax pfmin pfmul pfrcp pfrcpit1 pfrcpit2 pfrsqit1 pfrsqrt pfsub pfsubr pi2fd pmachriw pmaddwd pmagw pmulhriw pmulhrwa pmulhrwc pmulhw pmullw pmvgezb pmvlzb pmvnzb pmvzb pop popa popad popaw popf popfd popfq popfw por prefetch prefetchw pslld psllq psllw psrad psraw psrld psrlq psrlw psubb psubd psubsb psubsiw psubsw psubusb psubusw psubw punpckhbw punpckhdq punpckhwd punpcklbw punpckldq punpcklwd push pusha pushad pushaw pushf pushfd pushfq pushfw pxor rcl rcr rdshr rdmsr rdpmc rdtsc rdtscp ret retf retn rol ror rdm rsdc rsldt rsm rsts sahf sal salc sar sbb scasb scasd scasq scasw sfence sgdt shl shld shr shrd sidt sldt skinit smi smint smintold smsw stc std sti stosb stosd stosq stosw str sub svdc svldt svts swapgs syscall sysenter sysexit sysret test ud0 ud1 ud2b ud2 ud2a umov verr verw fwait wbinvd wrshr wrmsr xadd xbts xchg xlatb xlat xor cmove cmovz cmovne cmovnz cmova cmovnbe cmovae cmovnb cmovb cmovnae cmovbe cmovna cmovg cmovnle cmovge cmovnl cmovl cmovnge cmovle cmovng cmovc cmovnc cmovo cmovno cmovs cmovns cmovp cmovpe cmovnp cmovpo je jz jne jnz ja jnbe jae jnb jb jnae jbe jna jg jnle jge jnl jl jnge jle jng jc jnc jo jno js jns jpo jnp jpe jp sete setz setne setnz seta setnbe setae setnb setnc setb setnae setcset setbe setna setg setnle setge setnl setl setnge setle setng sets setns seto setno setpe setp setpo setnp addps addss andnps andps cmpeqps cmpeqss cmpleps cmpless cmpltps cmpltss cmpneqps cmpneqss cmpnleps cmpnless cmpnltps cmpnltss cmpordps cmpordss cmpunordps cmpunordss cmpps cmpss comiss cvtpi2ps cvtps2pi cvtsi2ss cvtss2si cvttps2pi cvttss2si divps divss ldmxcsr maxps maxss minps minss movaps movhps movlhps movlps movhlps movmskps movntps movss movups mulps mulss orps rcpps rcpss rsqrtps rsqrtss shufps sqrtps sqrtss stmxcsr subps subss ucomiss unpckhps unpcklps xorps fxrstor fxrstor64 fxsave fxsave64 xgetbv xsetbv xsave xsave64 xsaveopt xsaveopt64 xrstor xrstor64 prefetchnta prefetcht0 prefetcht1 prefetcht2 maskmovq movntq pavgb pavgw pextrw pinsrw pmaxsw pmaxub pminsw pminub pmovmskb pmulhuw psadbw pshufw pf2iw pfnacc pfpnacc pi2fw pswapd maskmovdqu clflush movntdq movnti movntpd movdqa movdqu movdq2q movq2dq paddq pmuludq pshufd pshufhw pshuflw pslldq psrldq psubq punpckhqdq punpcklqdq addpd addsd andnpd andpd cmpeqpd cmpeqsd cmplepd cmplesd cmpltpd cmpltsd cmpneqpd cmpneqsd cmpnlepd cmpnlesd cmpnltpd cmpnltsd cmpordpd cmpordsd cmpunordpd cmpunordsd cmppd comisd cvtdq2pd cvtdq2ps cvtpd2dq cvtpd2pi cvtpd2ps cvtpi2pd cvtps2dq cvtps2pd cvtsd2si cvtsd2ss cvtsi2sd cvtss2sd cvttpd2pi cvttpd2dq cvttps2dq cvttsd2si divpd divsd maxpd maxsd minpd minsd movapd movhpd movlpd movmskpd movupd mulpd mulsd orpd shufpd sqrtpd sqrtsd subpd subsd ucomisd unpckhpd unpcklpd xorpd addsubpd addsubps haddpd haddps hsubpd hsubps lddqu movddup movshdup movsldup clgi stgi vmcall vmclear vmfunc vmlaunch vmload vmmcall vmptrld vmptrst vmread vmresume vmrun vmsave vmwrite vmxoff vmxon invept invvpid pabsb pabsw pabsd palignr phaddw phaddd phaddsw phsubw phsubd phsubsw pmaddubsw pmulhrsw pshufb psignb psignw psignd extrq insertq movntsd movntss lzcnt blendpd blendps blendvpd blendvps dppd dpps extractps insertps movntdqa mpsadbw packusdw pblendvb pblendw pcmpeqq pextrb pextrd pextrq phminposuw pinsrb pinsrd pinsrq pmaxsb pmaxsd pmaxud pmaxuw pminsb pminsd pminud pminuw pmovsxbw pmovsxbd pmovsxbq pmovsxwd pmovsxwq pmovsxdq pmovzxbw pmovzxbd pmovzxbq pmovzxwd pmovzxwq pmovzxdq pmuldq pmulld ptest roundpd roundps roundsd roundss crc32 pcmpestri pcmpestrm pcmpistri pcmpistrm pcmpgtq popcnt getsec pfrcpv pfrsqrtv movbe aesenc aesenclast aesdec aesdeclast aesimc aeskeygenassist vaesenc vaesenclast vaesdec vaesdeclast vaesimc vaeskeygenassist vaddpd vaddps vaddsd vaddss vaddsubpd vaddsubps vandpd vandps vandnpd vandnps vblendpd vblendps vblendvpd vblendvps vbroadcastss vbroadcastsd vbroadcastf128 vcmpeq_ospd vcmpeqpd vcmplt_ospd vcmpltpd vcmple_ospd vcmplepd vcmpunord_qpd vcmpunordpd vcmpneq_uqpd vcmpneqpd vcmpnlt_uspd vcmpnltpd vcmpnle_uspd vcmpnlepd vcmpord_qpd vcmpordpd vcmpeq_uqpd vcmpnge_uspd vcmpngepd vcmpngt_uspd vcmpngtpd vcmpfalse_oqpd vcmpfalsepd vcmpneq_oqpd vcmpge_ospd vcmpgepd vcmpgt_ospd vcmpgtpd vcmptrue_uqpd vcmptruepd vcmplt_oqpd vcmple_oqpd vcmpunord_spd vcmpneq_uspd vcmpnlt_uqpd vcmpnle_uqpd vcmpord_spd vcmpeq_uspd vcmpnge_uqpd vcmpngt_uqpd vcmpfalse_ospd vcmpneq_ospd vcmpge_oqpd vcmpgt_oqpd vcmptrue_uspd vcmppd vcmpeq_osps vcmpeqps vcmplt_osps vcmpltps vcmple_osps vcmpleps vcmpunord_qps vcmpunordps vcmpneq_uqps vcmpneqps vcmpnlt_usps vcmpnltps vcmpnle_usps vcmpnleps vcmpord_qps vcmpordps vcmpeq_uqps vcmpnge_usps vcmpngeps vcmpngt_usps vcmpngtps vcmpfalse_oqps vcmpfalseps vcmpneq_oqps vcmpge_osps vcmpgeps vcmpgt_osps vcmpgtps vcmptrue_uqps vcmptrueps vcmplt_oqps vcmple_oqps vcmpunord_sps vcmpneq_usps vcmpnlt_uqps vcmpnle_uqps vcmpord_sps vcmpeq_usps vcmpnge_uqps vcmpngt_uqps vcmpfalse_osps vcmpneq_osps vcmpge_oqps vcmpgt_oqps vcmptrue_usps vcmpps vcmpeq_ossd vcmpeqsd vcmplt_ossd vcmpltsd vcmple_ossd vcmplesd vcmpunord_qsd vcmpunordsd vcmpneq_uqsd vcmpneqsd vcmpnlt_ussd vcmpnltsd vcmpnle_ussd vcmpnlesd vcmpord_qsd vcmpordsd vcmpeq_uqsd vcmpnge_ussd vcmpngesd vcmpngt_ussd vcmpngtsd vcmpfalse_oqsd vcmpfalsesd vcmpneq_oqsd vcmpge_ossd vcmpgesd vcmpgt_ossd vcmpgtsd vcmptrue_uqsd vcmptruesd vcmplt_oqsd vcmple_oqsd vcmpunord_ssd vcmpneq_ussd vcmpnlt_uqsd vcmpnle_uqsd vcmpord_ssd vcmpeq_ussd vcmpnge_uqsd vcmpngt_uqsd vcmpfalse_ossd vcmpneq_ossd vcmpge_oqsd vcmpgt_oqsd vcmptrue_ussd vcmpsd vcmpeq_osss vcmpeqss vcmplt_osss vcmpltss vcmple_osss vcmpless vcmpunord_qss vcmpunordss vcmpneq_uqss vcmpneqss vcmpnlt_usss vcmpnltss vcmpnle_usss vcmpnless vcmpord_qss vcmpordss vcmpeq_uqss vcmpnge_usss vcmpngess vcmpngt_usss vcmpngtss vcmpfalse_oqss vcmpfalsess vcmpneq_oqss vcmpge_osss vcmpgess vcmpgt_osss vcmpgtss vcmptrue_uqss vcmptruess vcmplt_oqss vcmple_oqss vcmpunord_sss vcmpneq_usss vcmpnlt_uqss vcmpnle_uqss vcmpord_sss vcmpeq_usss vcmpnge_uqss vcmpngt_uqss vcmpfalse_osss vcmpneq_osss vcmpge_oqss vcmpgt_oqss vcmptrue_usss vcmpss vcomisd vcomiss vcvtdq2pd vcvtdq2ps vcvtpd2dq vcvtpd2ps vcvtps2dq vcvtps2pd vcvtsd2si vcvtsd2ss vcvtsi2sd vcvtsi2ss vcvtss2sd vcvtss2si vcvttpd2dq vcvttps2dq vcvttsd2si vcvttss2si vdivpd vdivps vdivsd vdivss vdppd vdpps vextractf128 vextractps vhaddpd vhaddps vhsubpd vhsubps vinsertf128 vinsertps vlddqu vldqqu vldmxcsr vmaskmovdqu vmaskmovps vmaskmovpd vmaxpd vmaxps vmaxsd vmaxss vminpd vminps vminsd vminss vmovapd vmovaps vmovd vmovq vmovddup vmovdqa vmovqqa vmovdqu vmovqqu vmovhlps vmovhpd vmovhps vmovlhps vmovlpd vmovlps vmovmskpd vmovmskps vmovntdq vmovntqq vmovntdqa vmovntpd vmovntps vmovsd vmovshdup vmovsldup vmovss vmovupd vmovups vmpsadbw vmulpd vmulps vmulsd vmulss vorpd vorps vpabsb vpabsw vpabsd vpacksswb vpackssdw vpackuswb vpackusdw vpaddb vpaddw vpaddd vpaddq vpaddsb vpaddsw vpaddusb vpaddusw vpalignr vpand vpandn vpavgb vpavgw vpblendvb vpblendw vpcmpestri vpcmpestrm vpcmpistri vpcmpistrm vpcmpeqb vpcmpeqw vpcmpeqd vpcmpeqq vpcmpgtb vpcmpgtw vpcmpgtd vpcmpgtq vpermilpd vpermilps vperm2f128 vpextrb vpextrw vpextrd vpextrq vphaddw vphaddd vphaddsw vphminposuw vphsubw vphsubd vphsubsw vpinsrb vpinsrw vpinsrd vpinsrq vpmaddwd vpmaddubsw vpmaxsb vpmaxsw vpmaxsd vpmaxub vpmaxuw vpmaxud vpminsb vpminsw vpminsd vpminub vpminuw vpminud vpmovmskb vpmovsxbw vpmovsxbd vpmovsxbq vpmovsxwd vpmovsxwq vpmovsxdq vpmovzxbw vpmovzxbd vpmovzxbq vpmovzxwd vpmovzxwq vpmovzxdq vpmulhuw vpmulhrsw vpmulhw vpmullw vpmulld vpmuludq vpmuldq vpor vpsadbw vpshufb vpshufd vpshufhw vpshuflw vpsignb vpsignw vpsignd vpslldq vpsrldq vpsllw vpslld vpsllq vpsraw vpsrad vpsrlw vpsrld vpsrlq vptest vpsubb vpsubw vpsubd vpsubq vpsubsb vpsubsw vpsubusb vpsubusw vpunpckhbw vpunpckhwd vpunpckhdq vpunpckhqdq vpunpcklbw vpunpcklwd vpunpckldq vpunpcklqdq vpxor vrcpps vrcpss vrsqrtps vrsqrtss vroundpd vroundps vroundsd vroundss vshufpd vshufps vsqrtpd vsqrtps vsqrtsd vsqrtss vstmxcsr vsubpd vsubps vsubsd vsubss vtestps vtestpd vucomisd vucomiss vunpckhpd vunpckhps vunpcklpd vunpcklps vxorpd vxorps vzeroall vzeroupper pclmullqlqdq pclmulhqlqdq pclmullqhqdq pclmulhqhqdq pclmulqdq vpclmullqlqdq vpclmulhqlqdq vpclmullqhqdq vpclmulhqhqdq vpclmulqdq vfmadd132ps vfmadd132pd vfmadd312ps vfmadd312pd vfmadd213ps vfmadd213pd vfmadd123ps vfmadd123pd vfmadd231ps vfmadd231pd vfmadd321ps vfmadd321pd vfmaddsub132ps vfmaddsub132pd vfmaddsub312ps vfmaddsub312pd vfmaddsub213ps vfmaddsub213pd vfmaddsub123ps vfmaddsub123pd vfmaddsub231ps vfmaddsub231pd vfmaddsub321ps vfmaddsub321pd vfmsub132ps vfmsub132pd vfmsub312ps vfmsub312pd vfmsub213ps vfmsub213pd vfmsub123ps vfmsub123pd vfmsub231ps vfmsub231pd vfmsub321ps vfmsub321pd vfmsubadd132ps vfmsubadd132pd vfmsubadd312ps vfmsubadd312pd vfmsubadd213ps vfmsubadd213pd vfmsubadd123ps vfmsubadd123pd vfmsubadd231ps vfmsubadd231pd vfmsubadd321ps vfmsubadd321pd vfnmadd132ps vfnmadd132pd vfnmadd312ps vfnmadd312pd vfnmadd213ps vfnmadd213pd vfnmadd123ps vfnmadd123pd vfnmadd231ps vfnmadd231pd vfnmadd321ps vfnmadd321pd vfnmsub132ps vfnmsub132pd vfnmsub312ps vfnmsub312pd vfnmsub213ps vfnmsub213pd vfnmsub123ps vfnmsub123pd vfnmsub231ps vfnmsub231pd vfnmsub321ps vfnmsub321pd vfmadd132ss vfmadd132sd vfmadd312ss vfmadd312sd vfmadd213ss vfmadd213sd vfmadd123ss vfmadd123sd vfmadd231ss vfmadd231sd vfmadd321ss vfmadd321sd vfmsub132ss vfmsub132sd vfmsub312ss vfmsub312sd vfmsub213ss vfmsub213sd vfmsub123ss vfmsub123sd vfmsub231ss vfmsub231sd vfmsub321ss vfmsub321sd vfnmadd132ss vfnmadd132sd vfnmadd312ss vfnmadd312sd vfnmadd213ss vfnmadd213sd vfnmadd123ss vfnmadd123sd vfnmadd231ss vfnmadd231sd vfnmadd321ss vfnmadd321sd vfnmsub132ss vfnmsub132sd vfnmsub312ss vfnmsub312sd vfnmsub213ss vfnmsub213sd vfnmsub123ss vfnmsub123sd vfnmsub231ss vfnmsub231sd vfnmsub321ss vfnmsub321sd rdfsbase rdgsbase rdrand wrfsbase wrgsbase vcvtph2ps vcvtps2ph adcx adox rdseed clac stac xstore xcryptecb xcryptcbc xcryptctr xcryptcfb xcryptofb montmul xsha1 xsha256 llwpcb slwpcb lwpval lwpins vfmaddpd vfmaddps vfmaddsd vfmaddss vfmaddsubpd vfmaddsubps vfmsubaddpd vfmsubaddps vfmsubpd vfmsubps vfmsubsd vfmsubss vfnmaddpd vfnmaddps vfnmaddsd vfnmaddss vfnmsubpd vfnmsubps vfnmsubsd vfnmsubss vfrczpd vfrczps vfrczsd vfrczss vpcmov vpcomb vpcomd vpcomq vpcomub vpcomud vpcomuq vpcomuw vpcomw vphaddbd vphaddbq vphaddbw vphadddq vphaddubd vphaddubq vphaddubw vphaddudq vphadduwd vphadduwq vphaddwd vphaddwq vphsubbw vphsubdq vphsubwd vpmacsdd vpmacsdqh vpmacsdql vpmacssdd vpmacssdqh vpmacssdql vpmacsswd vpmacssww vpmacswd vpmacsww vpmadcsswd vpmadcswd vpperm vprotb vprotd vprotq vprotw vpshab vpshad vpshaq vpshaw vpshlb vpshld vpshlq vpshlw vbroadcasti128 vpblendd vpbroadcastb vpbroadcastw vpbroadcastd vpbroadcastq vpermd vpermpd vpermps vpermq vperm2i128 vextracti128 vinserti128 vpmaskmovd vpmaskmovq vpsllvd vpsllvq vpsravd vpsrlvd vpsrlvq vgatherdpd vgatherqpd vgatherdps vgatherqps vpgatherdd vpgatherqd vpgatherdq vpgatherqq xabort xbegin xend xtest andn bextr blci blcic blsi blsic blcfill blsfill blcmsk blsmsk blsr blcs bzhi mulx pdep pext rorx sarx shlx shrx tzcnt tzmsk t1mskc valignd valignq vblendmpd vblendmps vbroadcastf32x4 vbroadcastf64x4 vbroadcasti32x4 vbroadcasti64x4 vcompresspd vcompressps vcvtpd2udq vcvtps2udq vcvtsd2usi vcvtss2usi vcvttpd2udq vcvttps2udq vcvttsd2usi vcvttss2usi vcvtudq2pd vcvtudq2ps vcvtusi2sd vcvtusi2ss vexpandpd vexpandps vextractf32x4 vextractf64x4 vextracti32x4 vextracti64x4 vfixupimmpd vfixupimmps vfixupimmsd vfixupimmss vgetexppd vgetexpps vgetexpsd vgetexpss vgetmantpd vgetmantps vgetmantsd vgetmantss vinsertf32x4 vinsertf64x4 vinserti32x4 vinserti64x4 vmovdqa32 vmovdqa64 vmovdqu32 vmovdqu64 vpabsq vpandd vpandnd vpandnq vpandq vpblendmd vpblendmq vpcmpltd vpcmpled vpcmpneqd vpcmpnltd vpcmpnled vpcmpd vpcmpltq vpcmpleq vpcmpneqq vpcmpnltq vpcmpnleq vpcmpq vpcmpequd vpcmpltud vpcmpleud vpcmpnequd vpcmpnltud vpcmpnleud vpcmpud vpcmpequq vpcmpltuq vpcmpleuq vpcmpnequq vpcmpnltuq vpcmpnleuq vpcmpuq vpcompressd vpcompressq vpermi2d vpermi2pd vpermi2ps vpermi2q vpermt2d vpermt2pd vpermt2ps vpermt2q vpexpandd vpexpandq vpmaxsq vpmaxuq vpminsq vpminuq vpmovdb vpmovdw vpmovqb vpmovqd vpmovqw vpmovsdb vpmovsdw vpmovsqb vpmovsqd vpmovsqw vpmovusdb vpmovusdw vpmovusqb vpmovusqd vpmovusqw vpord vporq vprold vprolq vprolvd vprolvq vprord vprorq vprorvd vprorvq vpscatterdd vpscatterdq vpscatterqd vpscatterqq vpsraq vpsravq vpternlogd vpternlogq vptestmd vptestmq vptestnmd vptestnmq vpxord vpxorq vrcp14pd vrcp14ps vrcp14sd vrcp14ss vrndscalepd vrndscaleps vrndscalesd vrndscaless vrsqrt14pd vrsqrt14ps vrsqrt14sd vrsqrt14ss vscalefpd vscalefps vscalefsd vscalefss vscatterdpd vscatterdps vscatterqpd vscatterqps vshuff32x4 vshuff64x2 vshufi32x4 vshufi64x2 kandnw kandw kmovw knotw kortestw korw kshiftlw kshiftrw kunpckbw kxnorw kxorw vpbroadcastmb2q vpbroadcastmw2d vpconflictd vpconflictq vplzcntd vplzcntq vexp2pd vexp2ps vrcp28pd vrcp28ps vrcp28sd vrcp28ss vrsqrt28pd vrsqrt28ps vrsqrt28sd vrsqrt28ss vgatherpf0dpd vgatherpf0dps vgatherpf0qpd vgatherpf0qps vgatherpf1dpd vgatherpf1dps vgatherpf1qpd vgatherpf1qps vscatterpf0dpd vscatterpf0dps vscatterpf0qpd vscatterpf0qps vscatterpf1dpd vscatterpf1dps vscatterpf1qpd vscatterpf1qps prefetchwt1 bndmk bndcl bndcu bndcn bndmov bndldx bndstx sha1rnds4 sha1nexte sha1msg1 sha1msg2 sha256rnds2 sha256msg1 sha256msg2 hint_nop0 hint_nop1 hint_nop2 hint_nop3 hint_nop4 hint_nop5 hint_nop6 hint_nop7 hint_nop8 hint_nop9 hint_nop10 hint_nop11 hint_nop12 hint_nop13 hint_nop14 hint_nop15 hint_nop16 hint_nop17 hint_nop18 hint_nop19 hint_nop20 hint_nop21 hint_nop22 hint_nop23 hint_nop24 hint_nop25 hint_nop26 hint_nop27 hint_nop28 hint_nop29 hint_nop30 hint_nop31 hint_nop32 hint_nop33 hint_nop34 hint_nop35 hint_nop36 hint_nop37 hint_nop38 hint_nop39 hint_nop40 hint_nop41 hint_nop42 hint_nop43 hint_nop44 hint_nop45 hint_nop46 hint_nop47 hint_nop48 hint_nop49 hint_nop50 hint_nop51 hint_nop52 hint_nop53 hint_nop54 hint_nop55 hint_nop56 hint_nop57 hint_nop58 hint_nop59 hint_nop60 hint_nop61 hint_nop62 hint_nop63",literal:"ip eip rip al ah bl bh cl ch dl dh sil dil bpl spl r8b r9b r10b r11b r12b r13b r14b r15b ax bx cx dx si di bp sp r8w r9w r10w r11w r12w r13w r14w r15w eax ebx ecx edx esi edi ebp esp eip r8d r9d r10d r11d r12d r13d r14d r15d rax rbx rcx rdx rsi rdi rbp rsp r8 r9 r10 r11 r12 r13 r14 r15 cs ds es fs gs ss st st0 st1 st2 st3 st4 st5 st6 st7 mm0 mm1 mm2 mm3 mm4 mm5 mm6 mm7 xmm0 xmm1 xmm2 xmm3 xmm4 xmm5 xmm6 xmm7 xmm8 xmm9 xmm10 xmm11 xmm12 xmm13 xmm14 xmm15 xmm16 xmm17 xmm18 xmm19 xmm20 xmm21 xmm22 xmm23 xmm24 xmm25 xmm26 xmm27 xmm28 xmm29 xmm30 xmm31 ymm0 ymm1 ymm2 ymm3 ymm4 ymm5 ymm6 ymm7 ymm8 ymm9 ymm10 ymm11 ymm12 ymm13 ymm14 ymm15 ymm16 ymm17 ymm18 ymm19 ymm20 ymm21 ymm22 ymm23 ymm24 ymm25 ymm26 ymm27 ymm28 ymm29 ymm30 ymm31 zmm0 zmm1 zmm2 zmm3 zmm4 zmm5 zmm6 zmm7 zmm8 zmm9 zmm10 zmm11 zmm12 zmm13 zmm14 zmm15 zmm16 zmm17 zmm18 zmm19 zmm20 zmm21 zmm22 zmm23 zmm24 zmm25 zmm26 zmm27 zmm28 zmm29 zmm30 zmm31 k0 k1 k2 k3 k4 k5 k6 k7 bnd0 bnd1 bnd2 bnd3 cr0 cr1 cr2 cr3 cr4 cr8 dr0 dr1 dr2 dr3 dr8 tr3 tr4 tr5 tr6 tr7 r0 r1 r2 r3 r4 r5 r6 r7 r0b r1b r2b r3b r4b r5b r6b r7b r0w r1w r2w r3w r4w r5w r6w r7w r0d r1d r2d r3d r4d r5d r6d r7d r0h r1h r2h r3h r0l r1l r2l r3l r4l r5l r6l r7l r8l r9l r10l r11l r12l r13l r14l r15l",pseudo:"db dw dd dq dt ddq do dy dz resb resw resd resq rest resdq reso resy resz incbin equ times",preprocessor:"%define %xdefine %+ %undef %defstr %deftok %assign %strcat %strlen %substr %rotate %elif %else %endif %ifmacro %ifctx %ifidn %ifidni %ifid %ifnum %ifstr %iftoken %ifempty %ifenv %error %warning %fatal %rep %endrep %include %push %pop %repl %pathsearch %depend %use %arg %stacksize %local %line %comment %endcomment .nolist byte word dword qword nosplit rel abs seg wrt strict near far a32 ptr __FILE__ __LINE__ __SECT__ __BITS__ __OUTPUT_FORMAT__ __DATE__ __TIME__ __DATE_NUM__ __TIME_NUM__ __UTC_DATE__ __UTC_TIME__ __UTC_DATE_NUM__ __UTC_TIME_NUM__ __PASS__ struc endstruc istruc at iend align alignb sectalign daz nodaz up down zero default option assume public ",built_in:"bits use16 use32 use64 default section segment absolute extern global common cpu float __utf16__ __utf16le__ __utf16be__ __utf32__ __utf32le__ __utf32be__ __float8__ __float16__ __float32__ __float64__ __float80m__ __float80e__ __float128l__ __float128h__ __Infinity__ __QNaN__ __SNaN__ Inf NaN QNaN SNaN float8 float16 float32 float64 float80m float80e float128l float128h __FLOAT_DAZ__ __FLOAT_ROUND__ __FLOAT__"},c:[s.C(";","$",{r:0}),{cN:"number",b:"\\b(?:([0-9][0-9_]*)?\\.[0-9_]*(?:[eE][+-]?[0-9_]+)?|(0[Xx])?[0-9][0-9_]*\\.?[0-9_]*(?:[pP](?:[+-]?[0-9_]+)?)?)\\b",r:0},{cN:"number",b:"\\$[0-9][0-9A-Fa-f]*",r:0},{cN:"number",b:"\\b(?:[0-9A-Fa-f][0-9A-Fa-f_]*[HhXx]|[0-9][0-9_]*[DdTt]?|[0-7][0-7_]*[QqOo]|[0-1][0-1_]*[BbYy])\\b"},{cN:"number",b:"\\b(?:0[HhXx][0-9A-Fa-f_]+|0[DdTt][0-9_]+|0[QqOo][0-7_]+|0[BbYy][0-1_]+)\\b"},s.QSM,{cN:"string",b:"'",e:"[^\\\\]'",r:0},{cN:"string",b:"`",e:"[^\\\\]`",r:0},{cN:"string",b:"\\.[A-Za-z0-9]+",r:0},{cN:"label",b:"^\\s*[A-Za-z._?][A-Za-z0-9_$#@~.?]*(:|\\s+label)",r:0},{cN:"label",b:"^\\s*%%[A-Za-z0-9_$#@~.?]*:",r:0},{cN:"argument",b:"%[0-9]+",r:0},{cN:"built_in",b:"%!S+",r:0}]}});hljs.registerLanguage("roboconf",function(e){var n="[a-zA-Z-_][^\n{\r\n]+\\{";return{aliases:["graph","instances"],cI:!0,k:"import",c:[{cN:"facet",b:"^facet "+n,e:"}",k:"facet installer exports children extends",c:[e.HCM]},{cN:"instance-of",b:"^instance of "+n,e:"}",k:"name count channels instance-data instance-state instance of",c:[{cN:"keyword",b:"[a-zA-Z-_]+( | )*:"},e.HCM]},{cN:"component",b:"^"+n,e:"}",l:"\\(?[a-zA-Z]+\\)?",k:"installer exports children extends imports facets alias (optional)",c:[{cN:"string",b:"\\.[a-zA-Z-_]+",e:"\\s|,|;",eE:!0},e.HCM]},e.HCM]}});hljs.registerLanguage("ruby",function(e){var c="[a-zA-Z_]\\w*[!?=]?|[-+~]\\@|<<|>>|=~|===?|<=>|[<>]=?|\\*\\*|[-/+%^&*~`|]|\\[\\]=?",r="and false then defined module in return redo if BEGIN retry end for true self when next until do begin unless END rescue nil else break undef not super class case require yield alias while ensure elsif or include attr_reader attr_writer attr_accessor",b={cN:"yardoctag",b:"@[A-Za-z]+"},a={cN:"value",b:"#<",e:">"},n=[e.C("#","$",{c:[b]}),e.C("^\\=begin","^\\=end",{c:[b],r:10}),e.C("^__END__","\\n$")],s={cN:"subst",b:"#\\{",e:"}",k:r},t={cN:"string",c:[e.BE,s],v:[{b:/'/,e:/'/},{b:/"/,e:/"/},{b:/`/,e:/`/},{b:"%[qQwWx]?\\(",e:"\\)"},{b:"%[qQwWx]?\\[",e:"\\]"},{b:"%[qQwWx]?{",e:"}"},{b:"%[qQwWx]?<",e:">"},{b:"%[qQwWx]?/",e:"/"},{b:"%[qQwWx]?%",e:"%"},{b:"%[qQwWx]?-",e:"-"},{b:"%[qQwWx]?\\|",e:"\\|"},{b:/\B\?(\\\d{1,3}|\\x[A-Fa-f0-9]{1,2}|\\u[A-Fa-f0-9]{4}|\\?\S)\b/}]},i={cN:"params",b:"\\(",e:"\\)",k:r},d=[t,a,{cN:"class",bK:"class module",e:"$|;",i:/=/,c:[e.inherit(e.TM,{b:"[A-Za-z_]\\w*(::\\w+)*(\\?|\\!)?"}),{cN:"inheritance",b:"<\\s*",c:[{cN:"parent",b:"("+e.IR+"::)?"+e.IR}]}].concat(n)},{cN:"function",bK:"def",e:" |$|;",r:0,c:[e.inherit(e.TM,{b:c}),i].concat(n)},{cN:"constant",b:"(::)?(\\b[A-Z]\\w*(::)?)+",r:0},{cN:"symbol",b:e.UIR+"(\\!|\\?)?:",r:0},{cN:"symbol",b:":",c:[t,{b:c}],r:0},{cN:"number",b:"(\\b0[0-7_]+)|(\\b0x[0-9a-fA-F_]+)|(\\b[1-9][0-9_]*(\\.[0-9_]+)?)|[0_]\\b",r:0},{cN:"variable",b:"(\\$\\W)|((\\$|\\@\\@?)(\\w+))"},{b:"("+e.RSR+")\\s*",c:[a,{cN:"regexp",c:[e.BE,s],i:/\n/,v:[{b:"/",e:"/[a-z]*"},{b:"%r{",e:"}[a-z]*"},{b:"%r\\(",e:"\\)[a-z]*"},{b:"%r!",e:"![a-z]*"},{b:"%r\\[",e:"\\][a-z]*"}]}].concat(n),r:0}].concat(n);s.c=d,i.c=d;var o="[>?]>",l="[\\w#]+\\(\\w+\\):\\d+:\\d+>",u="(\\w+-)?\\d+\\.\\d+\\.\\d(p\\d+)?[^>]+>",N=[{b:/^\s*=>/,cN:"status",starts:{e:"$",c:d}},{cN:"prompt",b:"^("+o+"|"+l+"|"+u+")",starts:{e:"$",c:d}}];return{aliases:["rb","gemspec","podspec","thor","irb"],k:r,c:n.concat(N).concat(d)}});hljs.registerLanguage("typescript",function(e){return{aliases:["ts"],k:{keyword:"in if for while finally var new function|0 do return void else break catch instanceof with throw case default try this switch continue typeof delete let yield const class public private get set super interface extendsstatic constructor implements enum export import declare type protected",literal:"true false null undefined NaN Infinity",built_in:"eval isFinite isNaN parseFloat parseInt decodeURI decodeURIComponent encodeURI encodeURIComponent escape unescape Object Function Boolean Error EvalError InternalError RangeError ReferenceError StopIteration SyntaxError TypeError URIError Number Math Date String RegExp Array Float32Array Float64Array Int16Array Int32Array Int8Array Uint16Array Uint32Array Uint8Array Uint8ClampedArray ArrayBuffer DataView JSON Intl arguments require module console window document any number boolean string void"},c:[{cN:"pi",b:/^\s*('|")use strict('|")/,r:0},e.ASM,e.QSM,e.CLCM,e.CBCM,e.CNM,{b:"("+e.RSR+"|\\b(case|return|throw)\\b)\\s*",k:"return throw case",c:[e.CLCM,e.CBCM,e.RM,{b:/</,e:/>;/,r:0,sL:"xml"}],r:0},{cN:"function",bK:"function",e:/\{/,eE:!0,c:[e.inherit(e.TM,{b:/[A-Za-z$_][0-9A-Za-z$_]*/}),{cN:"params",b:/\(/,e:/\)/,c:[e.CLCM,e.CBCM],i:/["'\(]/}],i:/\[|%/,r:0},{cN:"constructor",bK:"constructor",e:/\{/,eE:!0,r:10},{cN:"module",bK:"module",e:/\{/,eE:!0},{cN:"interface",bK:"interface",e:/\{/,eE:!0},{b:/\$[(.]/},{b:"\\."+e.IR,r:0}]}});hljs.registerLanguage("handlebars",function(e){var a="each in with if else unless bindattr action collection debugger log outlet template unbound view yield";return{aliases:["hbs","html.hbs","html.handlebars"],cI:!0,sL:"xml",subLanguageMode:"continuous",c:[{cN:"expression",b:"{{",e:"}}",c:[{cN:"begin-block",b:"#[a-zA-Z- .]+",k:a},{cN:"string",b:'"',e:'"'},{cN:"end-block",b:"\\/[a-zA-Z- .]+",k:a},{cN:"variable",b:"[a-zA-Z-.]+",k:a}]}]}});hljs.registerLanguage("mercury",function(e){var i={keyword:"module use_module import_module include_module end_module initialise mutable initialize finalize finalise interface implementation pred mode func type inst solver any_pred any_func is semidet det nondet multi erroneous failure cc_nondet cc_multi typeclass instance where pragma promise external trace atomic or_else require_complete_switch require_det require_semidet require_multi require_nondet require_cc_multi require_cc_nondet require_erroneous require_failure",pragma:"inline no_inline type_spec source_file fact_table obsolete memo loop_check minimal_model terminates does_not_terminate check_termination promise_equivalent_clauses",preprocessor:"foreign_proc foreign_decl foreign_code foreign_type foreign_import_module foreign_export_enum foreign_export foreign_enum may_call_mercury will_not_call_mercury thread_safe not_thread_safe maybe_thread_safe promise_pure promise_semipure tabled_for_io local untrailed trailed attach_to_io_state can_pass_as_mercury_type stable will_not_throw_exception may_modify_trail will_not_modify_trail may_duplicate may_not_duplicate affects_liveness does_not_affect_liveness doesnt_affect_liveness no_sharing unknown_sharing sharing",built_in:"some all not if then else true fail false try catch catch_any semidet_true semidet_false semidet_fail impure_true impure semipure"},r={cN:"label",b:"XXX",e:"$",eW:!0,r:0},t=e.inherit(e.CLCM,{b:"%"}),_=e.inherit(e.CBCM,{r:0});t.c.push(r),_.c.push(r);var n={cN:"number",b:"0'.\\|0[box][0-9a-fA-F]*"},a=e.inherit(e.ASM,{r:0}),o=e.inherit(e.QSM,{r:0}),l={cN:"constant",b:"\\\\[abfnrtv]\\|\\\\x[0-9a-fA-F]*\\\\\\|%[-+# *.0-9]*[dioxXucsfeEgGp]",r:0};o.c.push(l);var s={cN:"built_in",v:[{b:"<=>"},{b:"<=",r:0},{b:"=>",r:0},{b:"/\\\\"},{b:"\\\\/"}]},c={cN:"built_in",v:[{b:":-\\|-->"},{b:"=",r:0}]};return{aliases:["m","moo"],k:i,c:[s,c,t,_,n,e.NM,a,o,{b:/:-/}]}});hljs.registerLanguage("fix",function(u){return{c:[{b:/[^\u2401\u0001]+/,e:/[\u2401\u0001]/,eE:!0,rB:!0,rE:!1,c:[{b:/([^\u2401\u0001=]+)/,e:/=([^\u2401\u0001=]+)/,rE:!0,rB:!1,cN:"attribute"},{b:/=/,e:/([\u2401\u0001])/,eE:!0,eB:!0,cN:"string"}]}],cI:!0}});hljs.registerLanguage("clojure",function(e){var t={built_in:"def cond apply if-not if-let if not not= = < > <= >= == + / * - rem quot neg? pos? delay? symbol? keyword? true? false? integer? empty? coll? list? set? ifn? fn? associative? sequential? sorted? counted? reversible? number? decimal? class? distinct? isa? float? rational? reduced? ratio? odd? even? char? seq? vector? string? map? nil? contains? zero? instance? not-every? not-any? libspec? -> ->> .. . inc compare do dotimes mapcat take remove take-while drop letfn drop-last take-last drop-while while intern condp case reduced cycle split-at split-with repeat replicate iterate range merge zipmap declare line-seq sort comparator sort-by dorun doall nthnext nthrest partition eval doseq await await-for let agent atom send send-off release-pending-sends add-watch mapv filterv remove-watch agent-error restart-agent set-error-handler error-handler set-error-mode! error-mode shutdown-agents quote var fn loop recur throw try monitor-enter monitor-exit defmacro defn defn- macroexpand macroexpand-1 for dosync and or when when-not when-let comp juxt partial sequence memoize constantly complement identity assert peek pop doto proxy defstruct first rest cons defprotocol cast coll deftype defrecord last butlast sigs reify second ffirst fnext nfirst nnext defmulti defmethod meta with-meta ns in-ns create-ns import refer keys select-keys vals key val rseq name namespace promise into transient persistent! conj! assoc! dissoc! pop! disj! use class type num float double short byte boolean bigint biginteger bigdec print-method print-dup throw-if printf format load compile get-in update-in pr pr-on newline flush read slurp read-line subvec with-open memfn time re-find re-groups rand-int rand mod locking assert-valid-fdecl alias resolve ref deref refset swap! reset! set-validator! compare-and-set! alter-meta! reset-meta! commute get-validator alter ref-set ref-history-count ref-min-history ref-max-history ensure sync io! new next conj set! to-array future future-call into-array aset gen-class reduce map filter find empty hash-map hash-set sorted-map sorted-map-by sorted-set sorted-set-by vec vector seq flatten reverse assoc dissoc list disj get union difference intersection extend extend-type extend-protocol int nth delay count concat chunk chunk-buffer chunk-append chunk-first chunk-rest max min dec unchecked-inc-int unchecked-inc unchecked-dec-inc unchecked-dec unchecked-negate unchecked-add-int unchecked-add unchecked-subtract-int unchecked-subtract chunk-next chunk-cons chunked-seq? prn vary-meta lazy-seq spread list* str find-keyword keyword symbol gensym force rationalize"},r="a-zA-Z_\\-!.?+*=<>&#'",n="["+r+"]["+r+"0-9/;:]*",a="[-+]?\\d+(\\.\\d+)?",o={b:n,r:0},s={cN:"number",b:a,r:0},i=e.inherit(e.QSM,{i:null}),c=e.C(";","$",{r:0}),d={cN:"literal",b:/\b(true|false|nil)\b/},l={cN:"collection",b:"[\\[\\{]",e:"[\\]\\}]"},m={cN:"comment",b:"\\^"+n},p=e.C("\\^\\{","\\}"),u={cN:"attribute",b:"[:]"+n},f={cN:"list",b:"\\(",e:"\\)"},h={eW:!0,r:0},y={k:t,l:n,cN:"keyword",b:n,starts:h},b=[f,i,m,p,c,u,l,s,d,o];return f.c=[e.C("comment",""),y,h],h.c=b,l.c=b,{aliases:["clj"],i:/\S/,c:[f,i,m,p,c,u,l,s,d]}});hljs.registerLanguage("perl",function(e){var t="getpwent getservent quotemeta msgrcv scalar kill dbmclose undef lc ma syswrite tr send umask sysopen shmwrite vec qx utime local oct semctl localtime readpipe do return format read sprintf dbmopen pop getpgrp not getpwnam rewinddir qqfileno qw endprotoent wait sethostent bless s|0 opendir continue each sleep endgrent shutdown dump chomp connect getsockname die socketpair close flock exists index shmgetsub for endpwent redo lstat msgctl setpgrp abs exit select print ref gethostbyaddr unshift fcntl syscall goto getnetbyaddr join gmtime symlink semget splice x|0 getpeername recv log setsockopt cos last reverse gethostbyname getgrnam study formline endhostent times chop length gethostent getnetent pack getprotoent getservbyname rand mkdir pos chmod y|0 substr endnetent printf next open msgsnd readdir use unlink getsockopt getpriority rindex wantarray hex system getservbyport endservent int chr untie rmdir prototype tell listen fork shmread ucfirst setprotoent else sysseek link getgrgid shmctl waitpid unpack getnetbyname reset chdir grep split require caller lcfirst until warn while values shift telldir getpwuid my getprotobynumber delete and sort uc defined srand accept package seekdir getprotobyname semop our rename seek if q|0 chroot sysread setpwent no crypt getc chown sqrt write setnetent setpriority foreach tie sin msgget map stat getlogin unless elsif truncate exec keys glob tied closedirioctl socket readlink eval xor readline binmode setservent eof ord bind alarm pipe atan2 getgrent exp time push setgrent gt lt or ne m|0 break given say state when",r={cN:"subst",b:"[$@]\\{",e:"\\}",k:t},s={b:"->{",e:"}"},n={cN:"variable",v:[{b:/\$\d/},{b:/[\$%@](\^\w\b|#\w+(::\w+)*|{\w+}|\w+(::\w*)*)/},{b:/[\$%@][^\s\w{]/,r:0}]},i=e.C("^(__END__|__DATA__)","\\n$",{r:5}),o=[e.BE,r,n],a=[n,e.HCM,i,e.C("^\\=\\w","\\=cut",{eW:!0}),s,{cN:"string",c:o,v:[{b:"q[qwxr]?\\s*\\(",e:"\\)",r:5},{b:"q[qwxr]?\\s*\\[",e:"\\]",r:5},{b:"q[qwxr]?\\s*\\{",e:"\\}",r:5},{b:"q[qwxr]?\\s*\\|",e:"\\|",r:5},{b:"q[qwxr]?\\s*\\<",e:"\\>",r:5},{b:"qw\\s+q",e:"q",r:5},{b:"'",e:"'",c:[e.BE]},{b:'"',e:'"'},{b:"`",e:"`",c:[e.BE]},{b:"{\\w+}",c:[],r:0},{b:"-?\\w+\\s*\\=\\>",c:[],r:0}]},{cN:"number",b:"(\\b0[0-7_]+)|(\\b0x[0-9a-fA-F_]+)|(\\b[1-9][0-9_]*(\\.[0-9_]+)?)|[0_]\\b",r:0},{b:"(\\/\\/|"+e.RSR+"|\\b(split|return|print|reverse|grep)\\b)\\s*",k:"split return print reverse grep",r:0,c:[e.HCM,i,{cN:"regexp",b:"(s|tr|y)/(\\\\.|[^/])*/(\\\\.|[^/])*/[a-z]*",r:10},{cN:"regexp",b:"(m|qr)?/",e:"/[a-z]*",c:[e.BE],r:0}]},{cN:"sub",bK:"sub",e:"(\\s*\\(.*?\\))?[;{]",r:5},{cN:"operator",b:"-\\w\\b",r:0}];return r.c=a,s.c=a,{aliases:["pl"],k:t,c:a}});hljs.registerLanguage("twig",function(e){var t={cN:"params",b:"\\(",e:"\\)"},a="attribute block constant cycle date dump include max min parent random range source template_from_string",r={cN:"function",bK:a,r:0,c:[t]},c={cN:"filter",b:/\|[A-Za-z_]+:?/,k:"abs batch capitalize convert_encoding date date_modify default escape first format join json_encode keys last length lower merge nl2br number_format raw replace reverse round slice sort split striptags title trim upper url_encode",c:[r]},n="autoescape block do embed extends filter flush for if import include macro sandbox set spaceless use verbatim";return n=n+" "+n.split(" ").map(function(e){return"end"+e}).join(" "),{aliases:["craftcms"],cI:!0,sL:"xml",subLanguageMode:"continuous",c:[e.C(/\{#/,/#}/),{cN:"template_tag",b:/\{%/,e:/%}/,k:n,c:[c,r]},{cN:"variable",b:/\{\{/,e:/}}/,c:[c,r]}]}});hljs.registerLanguage("livecodeserver",function(e){var r={cN:"variable",b:"\\b[gtps][A-Z]+[A-Za-z0-9_\\-]*\\b|\\$_[A-Z]+",r:0},t=[e.CBCM,e.HCM,e.C("--","$"),e.C("[^:]//","$")],a=e.inherit(e.TM,{v:[{b:"\\b_*rig[A-Z]+[A-Za-z0-9_\\-]*"},{b:"\\b_[a-z0-9\\-]+"}]}),o=e.inherit(e.TM,{b:"\\b([A-Za-z0-9_\\-]+)\\b"});return{cI:!1,k:{keyword:"$_COOKIE $_FILES $_GET $_GET_BINARY $_GET_RAW $_POST $_POST_BINARY $_POST_RAW $_SESSION $_SERVER codepoint codepoints segment segments codeunit codeunits sentence sentences trueWord trueWords paragraph after byte bytes english the until http forever descending using line real8 with seventh for stdout finally element word words fourth before black ninth sixth characters chars stderr uInt1 uInt1s uInt2 uInt2s stdin string lines relative rel any fifth items from middle mid at else of catch then third it file milliseconds seconds second secs sec int1 int1s int4 int4s internet int2 int2s normal text item last long detailed effective uInt4 uInt4s repeat end repeat URL in try into switch to words https token binfile each tenth as ticks tick system real4 by dateItems without char character ascending eighth whole dateTime numeric short first ftp integer abbreviated abbr abbrev private case while if",constant:"SIX TEN FORMFEED NINE ZERO NONE SPACE FOUR FALSE COLON CRLF PI COMMA ENDOFFILE EOF EIGHT FIVE QUOTE EMPTY ONE TRUE RETURN CR LINEFEED RIGHT BACKSLASH NULL SEVEN TAB THREE TWO six ten formfeed nine zero none space four false colon crlf pi comma endoffile eof eight five quote empty one true return cr linefeed right backslash null seven tab three two RIVERSION RISTATE FILE_READ_MODE FILE_WRITE_MODE FILE_WRITE_MODE DIR_WRITE_MODE FILE_READ_UMASK FILE_WRITE_UMASK DIR_READ_UMASK DIR_WRITE_UMASK",operator:"div mod wrap and or bitAnd bitNot bitOr bitXor among not in a an within contains ends with begins the keys of keys",built_in:"put abs acos aliasReference annuity arrayDecode arrayEncode asin atan atan2 average avg avgDev base64Decode base64Encode baseConvert binaryDecode binaryEncode byteOffset byteToNum cachedURL cachedURLs charToNum cipherNames codepointOffset codepointProperty codepointToNum codeunitOffset commandNames compound compress constantNames cos date dateFormat decompress directories diskSpace DNSServers exp exp1 exp2 exp10 extents files flushEvents folders format functionNames geometricMean global globals hasMemory harmonicMean hostAddress hostAddressToName hostName hostNameToAddress isNumber ISOToMac itemOffset keys len length libURLErrorData libUrlFormData libURLftpCommand libURLLastHTTPHeaders libURLLastRHHeaders libUrlMultipartFormAddPart libUrlMultipartFormData libURLVersion lineOffset ln ln1 localNames log log2 log10 longFilePath lower macToISO matchChunk matchText matrixMultiply max md5Digest median merge millisec millisecs millisecond milliseconds min monthNames nativeCharToNum normalizeText num number numToByte numToChar numToCodepoint numToNativeChar offset open openfiles openProcesses openProcessIDs openSockets paragraphOffset paramCount param params peerAddress pendingMessages platform popStdDev populationStandardDeviation populationVariance popVariance processID random randomBytes replaceText result revCreateXMLTree revCreateXMLTreeFromFile revCurrentRecord revCurrentRecordIsFirst revCurrentRecordIsLast revDatabaseColumnCount revDatabaseColumnIsNull revDatabaseColumnLengths revDatabaseColumnNames revDatabaseColumnNamed revDatabaseColumnNumbered revDatabaseColumnTypes revDatabaseConnectResult revDatabaseCursors revDatabaseID revDatabaseTableNames revDatabaseType revDataFromQuery revdb_closeCursor revdb_columnbynumber revdb_columncount revdb_columnisnull revdb_columnlengths revdb_columnnames revdb_columntypes revdb_commit revdb_connect revdb_connections revdb_connectionerr revdb_currentrecord revdb_cursorconnection revdb_cursorerr revdb_cursors revdb_dbtype revdb_disconnect revdb_execute revdb_iseof revdb_isbof revdb_movefirst revdb_movelast revdb_movenext revdb_moveprev revdb_query revdb_querylist revdb_recordcount revdb_rollback revdb_tablenames revGetDatabaseDriverPath revNumberOfRecords revOpenDatabase revOpenDatabases revQueryDatabase revQueryDatabaseBlob revQueryResult revQueryIsAtStart revQueryIsAtEnd revUnixFromMacPath revXMLAttribute revXMLAttributes revXMLAttributeValues revXMLChildContents revXMLChildNames revXMLCreateTreeFromFileWithNamespaces revXMLCreateTreeWithNamespaces revXMLDataFromXPathQuery revXMLEvaluateXPath revXMLFirstChild revXMLMatchingNode revXMLNextSibling revXMLNodeContents revXMLNumberOfChildren revXMLParent revXMLPreviousSibling revXMLRootNode revXMLRPC_CreateRequest revXMLRPC_Documents revXMLRPC_Error revXMLRPC_GetHost revXMLRPC_GetMethod revXMLRPC_GetParam revXMLText revXMLRPC_Execute revXMLRPC_GetParamCount revXMLRPC_GetParamNode revXMLRPC_GetParamType revXMLRPC_GetPath revXMLRPC_GetPort revXMLRPC_GetProtocol revXMLRPC_GetRequest revXMLRPC_GetResponse revXMLRPC_GetSocket revXMLTree revXMLTrees revXMLValidateDTD revZipDescribeItem revZipEnumerateItems revZipOpenArchives round sampVariance sec secs seconds sentenceOffset sha1Digest shell shortFilePath sin specialFolderPath sqrt standardDeviation statRound stdDev sum sysError systemVersion tan tempName textDecode textEncode tick ticks time to tokenOffset toLower toUpper transpose truewordOffset trunc uniDecode uniEncode upper URLDecode URLEncode URLStatus uuid value variableNames variance version waitDepth weekdayNames wordOffset xsltApplyStylesheet xsltApplyStylesheetFromFile xsltLoadStylesheet xsltLoadStylesheetFromFile add breakpoint cancel clear local variable file word line folder directory URL close socket process combine constant convert create new alias folder directory decrypt delete variable word line folder directory URL dispatch divide do encrypt filter get include intersect kill libURLDownloadToFile libURLFollowHttpRedirects libURLftpUpload libURLftpUploadFile libURLresetAll libUrlSetAuthCallback libURLSetCustomHTTPHeaders libUrlSetExpect100 libURLSetFTPListCommand libURLSetFTPMode libURLSetFTPStopTime libURLSetStatusCallback load multiply socket prepare process post seek rel relative read from process rename replace require resetAll resolve revAddXMLNode revAppendXML revCloseCursor revCloseDatabase revCommitDatabase revCopyFile revCopyFolder revCopyXMLNode revDeleteFolder revDeleteXMLNode revDeleteAllXMLTrees revDeleteXMLTree revExecuteSQL revGoURL revInsertXMLNode revMoveFolder revMoveToFirstRecord revMoveToLastRecord revMoveToNextRecord revMoveToPreviousRecord revMoveToRecord revMoveXMLNode revPutIntoXMLNode revRollBackDatabase revSetDatabaseDriverPath revSetXMLAttribute revXMLRPC_AddParam revXMLRPC_DeleteAllDocuments revXMLAddDTD revXMLRPC_Free revXMLRPC_FreeAll revXMLRPC_DeleteDocument revXMLRPC_DeleteParam revXMLRPC_SetHost revXMLRPC_SetMethod revXMLRPC_SetPort revXMLRPC_SetProtocol revXMLRPC_SetSocket revZipAddItemWithData revZipAddItemWithFile revZipAddUncompressedItemWithData revZipAddUncompressedItemWithFile revZipCancel revZipCloseArchive revZipDeleteItem revZipExtractItemToFile revZipExtractItemToVariable revZipSetProgressCallback revZipRenameItem revZipReplaceItemWithData revZipReplaceItemWithFile revZipOpenArchive send set sort split start stop subtract union unload wait write"},c:[r,{cN:"keyword",b:"\\bend\\sif\\b"},{cN:"function",bK:"function",e:"$",c:[r,o,e.ASM,e.QSM,e.BNM,e.CNM,a]},{cN:"function",bK:"end",e:"$",c:[o,a]},{cN:"command",bK:"command on",e:"$",c:[r,o,e.ASM,e.QSM,e.BNM,e.CNM,a]},{cN:"command",bK:"end",e:"$",c:[o,a]},{cN:"preprocessor",b:"<\\?rev|<\\?lc|<\\?livecode",r:10},{cN:"preprocessor",b:"<\\?"},{cN:"preprocessor",b:"\\?>"},e.ASM,e.QSM,e.BNM,e.CNM,a].concat(t),i:";$|^\\[|^="}});hljs.registerLanguage("step21",function(e){var r="[A-Z_][A-Z0-9_.]*",i="END-ISO-10303-21;",l={literal:"",built_in:"",keyword:"HEADER ENDSEC DATA"},s={cN:"preprocessor",b:"ISO-10303-21;",r:10},t=[e.CLCM,e.CBCM,e.C("/\\*\\*!","\\*/"),e.CNM,e.inherit(e.ASM,{i:null}),e.inherit(e.QSM,{i:null}),{cN:"string",b:"'",e:"'"},{cN:"label",v:[{b:"#",e:"\\d+",i:"\\W"}]}];return{aliases:["p21","step","stp"],cI:!0,l:r,k:l,c:[{cN:"preprocessor",b:i,r:10},s].concat(t)}});hljs.registerLanguage("cpp",function(t){var i={keyword:"false int float while private char catch export virtual operator sizeof dynamic_cast|10 typedef const_cast|10 const struct for static_cast|10 union namespace unsigned long volatile static protected bool template mutable if public friend do goto auto void enum else break extern using true class asm case typeid short reinterpret_cast|10 default double register explicit signed typename try this switch continue wchar_t inline delete alignof char16_t char32_t constexpr decltype noexcept nullptr static_assert thread_local restrict _Bool complex _Complex _Imaginary intmax_t uintmax_t int8_t uint8_t int16_t uint16_t int32_t uint32_t int64_t uint64_t int_least8_t uint_least8_t int_least16_t uint_least16_t int_least32_t uint_least32_t int_least64_t uint_least64_t int_fast8_t uint_fast8_t int_fast16_t uint_fast16_t int_fast32_t uint_fast32_t int_fast64_t uint_fast64_t intptr_t uintptr_t atomic_bool atomic_char atomic_schar atomic_uchar atomic_short atomic_ushort atomic_int atomic_uint atomic_long atomic_ulong atomic_llong atomic_ullong atomic_wchar_t atomic_char16_t atomic_char32_t atomic_intmax_t atomic_uintmax_t atomic_intptr_t atomic_uintptr_t atomic_size_t atomic_ptrdiff_t atomic_int_least8_t atomic_int_least16_t atomic_int_least32_t atomic_int_least64_t atomic_uint_least8_t atomic_uint_least16_t atomic_uint_least32_t atomic_uint_least64_t atomic_int_fast8_t atomic_int_fast16_t atomic_int_fast32_t atomic_int_fast64_t atomic_uint_fast8_t atomic_uint_fast16_t atomic_uint_fast32_t atomic_uint_fast64_t",built_in:"std string cin cout cerr clog stringstream istringstream ostringstream auto_ptr deque list queue stack vector map set bitset multiset multimap unordered_set unordered_map unordered_multiset unordered_multimap array shared_ptr abort abs acos asin atan2 atan calloc ceil cosh cos exit exp fabs floor fmod fprintf fputs free frexp fscanf isalnum isalpha iscntrl isdigit isgraph islower isprint ispunct isspace isupper isxdigit tolower toupper labs ldexp log10 log malloc memchr memcmp memcpy memset modf pow printf putchar puts scanf sinh sin snprintf sprintf sqrt sscanf strcat strchr strcmp strcpy strcspn strlen strncat strncmp strncpy strpbrk strrchr strspn strstr tanh tan vfprintf vprintf vsprintf"};return{aliases:["c","cc","h","c++","h++","hpp"],k:i,i:"</",c:[t.CLCM,t.CBCM,t.QSM,{cN:"string",b:"'\\\\?.",e:"'",i:"."},{cN:"number",b:"\\b(\\d+(\\.\\d*)?|\\.\\d+)(u|U|l|L|ul|UL|f|F)"},t.CNM,{cN:"preprocessor",b:"#",e:"$",k:"if else elif endif define undef warning error line pragma",c:[{b:/\\\n/,r:0},{b:'include\\s*[<"]',e:'[>"]',k:"include",i:"\\n"},t.CLCM]},{b:"\\b(deque|list|queue|stack|vector|map|set|bitset|multiset|multimap|unordered_map|unordered_set|unordered_multiset|unordered_multimap|array)\\s*<",e:">",k:i,c:["self"]},{b:t.IR+"::",k:i},{bK:"new throw return else",r:0},{cN:"function",b:"("+t.IR+"\\s+)+"+t.IR+"\\s*\\(",rB:!0,e:/[{;=]/,eE:!0,k:i,c:[{b:t.IR+"\\s*\\(",rB:!0,c:[t.TM],r:0},{cN:"params",b:/\(/,e:/\)/,k:i,r:0,c:[t.CBCM]},t.CLCM,t.CBCM]}]}});hljs.registerLanguage("vala",function(e){return{k:{keyword:"char uchar unichar int uint long ulong short ushort int8 int16 int32 int64 uint8 uint16 uint32 uint64 float double bool struct enum string void weak unowned owned async signal static abstract interface override while do for foreach else switch case break default return try catch public private protected internal using new this get set const stdout stdin stderr var",built_in:"DBus GLib CCode Gee Object",literal:"false true null"},c:[{cN:"class",bK:"class interface delegate namespace",e:"{",eE:!0,i:"[^,:\\n\\s\\.]",c:[e.UTM]},e.CLCM,e.CBCM,{cN:"string",b:'"""',e:'"""',r:5},e.ASM,e.QSM,e.CNM,{cN:"preprocessor",b:"^#",e:"$",r:2},{cN:"constant",b:" [A-Z_]+ ",r:0}]}});hljs.registerLanguage("http",function(t){return{aliases:["https"],i:"\\S",c:[{cN:"status",b:"^HTTP/[0-9\\.]+",e:"$",c:[{cN:"number",b:"\\b\\d{3}\\b"}]},{cN:"request",b:"^[A-Z]+ (.*?) HTTP/[0-9\\.]+$",rB:!0,e:"$",c:[{cN:"string",b:" ",e:" ",eB:!0,eE:!0}]},{cN:"attribute",b:"^\\w",e:": ",eE:!0,i:"\\n|\\s|=",starts:{cN:"string",e:"$"}},{b:"\\n\\n",starts:{sL:"",eW:!0}}]}});hljs.registerLanguage("avrasm",function(r){return{cI:!0,l:"\\.?"+r.IR,k:{keyword:"adc add adiw and andi asr bclr bld brbc brbs brcc brcs break breq brge brhc brhs brid brie brlo brlt brmi brne brpl brsh brtc brts brvc brvs bset bst call cbi cbr clc clh cli cln clr cls clt clv clz com cp cpc cpi cpse dec eicall eijmp elpm eor fmul fmuls fmulsu icall ijmp in inc jmp ld ldd ldi lds lpm lsl lsr mov movw mul muls mulsu neg nop or ori out pop push rcall ret reti rjmp rol ror sbc sbr sbrc sbrs sec seh sbi sbci sbic sbis sbiw sei sen ser ses set sev sez sleep spm st std sts sub subi swap tst wdr",built_in:"r0 r1 r2 r3 r4 r5 r6 r7 r8 r9 r10 r11 r12 r13 r14 r15 r16 r17 r18 r19 r20 r21 r22 r23 r24 r25 r26 r27 r28 r29 r30 r31 x|0 xh xl y|0 yh yl z|0 zh zl ucsr1c udr1 ucsr1a ucsr1b ubrr1l ubrr1h ucsr0c ubrr0h tccr3c tccr3a tccr3b tcnt3h tcnt3l ocr3ah ocr3al ocr3bh ocr3bl ocr3ch ocr3cl icr3h icr3l etimsk etifr tccr1c ocr1ch ocr1cl twcr twdr twar twsr twbr osccal xmcra xmcrb eicra spmcsr spmcr portg ddrg ping portf ddrf sreg sph spl xdiv rampz eicrb eimsk gimsk gicr eifr gifr timsk tifr mcucr mcucsr tccr0 tcnt0 ocr0 assr tccr1a tccr1b tcnt1h tcnt1l ocr1ah ocr1al ocr1bh ocr1bl icr1h icr1l tccr2 tcnt2 ocr2 ocdr wdtcr sfior eearh eearl eedr eecr porta ddra pina portb ddrb pinb portc ddrc pinc portd ddrd pind spdr spsr spcr udr0 ucsr0a ucsr0b ubrr0l acsr admux adcsr adch adcl porte ddre pine pinf",preprocessor:".byte .cseg .db .def .device .dseg .dw .endmacro .equ .eseg .exit .include .list .listmac .macro .nolist .org .set"},c:[r.CBCM,r.C(";","$",{r:0}),r.CNM,r.BNM,{cN:"number",b:"\\b(\\$[a-zA-Z0-9]+|0o[0-7]+)"},r.QSM,{cN:"string",b:"'",e:"[^\\\\]'",i:"[^\\\\][^']"},{cN:"label",b:"^[A-Za-z0-9_.$]+:"},{cN:"preprocessor",b:"#",e:"$"},{cN:"localvars",b:"@[0-9]+"}]}});hljs.registerLanguage("aspectj",function(e){var t="false synchronized int abstract float private char boolean static null if const for true while long throw strictfp finally protected import native final return void enum else extends implements break transient new catch instanceof byte super volatile case assert short package default double public try this switch continue throws privileged aspectOf adviceexecution proceed cflowbelow cflow initialization preinitialization staticinitialization withincode target within execution getWithinTypeName handler thisJoinPoint thisJoinPointStaticPart thisEnclosingJoinPointStaticPart declare parents warning error soft precedence thisAspectInstance",i="get set args call";return{k:t,i:/<\//,c:[{cN:"javadoc",b:"/\\*\\*",e:"\\*/",r:0,c:[{cN:"javadoctag",b:"(^|\\s)@[A-Za-z]+"}]},e.CLCM,e.CBCM,e.ASM,e.QSM,{cN:"aspect",bK:"aspect",e:/[{;=]/,eE:!0,i:/[:;"\[\]]/,c:[{bK:"extends implements pertypewithin perthis pertarget percflowbelow percflow issingleton"},e.UTM,{b:/\([^\)]*/,e:/[)]+/,k:t+" "+i,eE:!1}]},{cN:"class",bK:"class interface",e:/[{;=]/,eE:!0,r:0,k:"class interface",i:/[:"\[\]]/,c:[{bK:"extends implements"},e.UTM]},{bK:"pointcut after before around throwing returning",e:/[)]/,eE:!1,i:/["\[\]]/,c:[{b:e.UIR+"\\s*\\(",rB:!0,c:[e.UTM]}]},{b:/[:]/,rB:!0,e:/[{;]/,r:0,eE:!1,k:t,i:/["\[\]]/,c:[{b:e.UIR+"\\s*\\(",k:t+" "+i},e.QSM]},{bK:"new throw",r:0},{cN:"function",b:/\w+ +\w+(\.)?\w+\s*\([^\)]*\)\s*((throws)[\w\s,]+)?[\{;]/,rB:!0,e:/[{;=]/,k:t,eE:!0,c:[{b:e.UIR+"\\s*\\(",rB:!0,r:0,c:[e.UTM]},{cN:"params",b:/\(/,e:/\)/,r:0,k:t,c:[e.ASM,e.QSM,e.CNM,e.CBCM]},e.CLCM,e.CBCM]},e.CNM,{cN:"annotation",b:"@[A-Za-z]+"}]}});hljs.registerLanguage("rib",function(e){return{k:"ArchiveRecord AreaLightSource Atmosphere Attribute AttributeBegin AttributeEnd Basis Begin Blobby Bound Clipping ClippingPlane Color ColorSamples ConcatTransform Cone CoordinateSystem CoordSysTransform CropWindow Curves Cylinder DepthOfField Detail DetailRange Disk Displacement Display End ErrorHandler Exposure Exterior Format FrameAspectRatio FrameBegin FrameEnd GeneralPolygon GeometricApproximation Geometry Hider Hyperboloid Identity Illuminate Imager Interior LightSource MakeCubeFaceEnvironment MakeLatLongEnvironment MakeShadow MakeTexture Matte MotionBegin MotionEnd NuPatch ObjectBegin ObjectEnd ObjectInstance Opacity Option Orientation Paraboloid Patch PatchMesh Perspective PixelFilter PixelSamples PixelVariance Points PointsGeneralPolygons PointsPolygons Polygon Procedural Projection Quantize ReadArchive RelativeDetail ReverseOrientation Rotate Scale ScreenWindow ShadingInterpolation ShadingRate Shutter Sides Skew SolidBegin SolidEnd Sphere SubdivisionMesh Surface TextureCoordinates Torus Transform TransformBegin TransformEnd TransformPoints Translate TrimCurve WorldBegin WorldEnd",i:"</",c:[e.HCM,e.CNM,e.ASM,e.QSM]}});hljs.registerLanguage("python",function(e){var r={cN:"prompt",b:/^(>>>|\.\.\.) /},b={cN:"string",c:[e.BE],v:[{b:/(u|b)?r?'''/,e:/'''/,c:[r],r:10},{b:/(u|b)?r?"""/,e:/"""/,c:[r],r:10},{b:/(u|r|ur)'/,e:/'/,r:10},{b:/(u|r|ur)"/,e:/"/,r:10},{b:/(b|br)'/,e:/'/},{b:/(b|br)"/,e:/"/},e.ASM,e.QSM]},l={cN:"number",r:0,v:[{b:e.BNR+"[lLjJ]?"},{b:"\\b(0o[0-7]+)[lLjJ]?"},{b:e.CNR+"[lLjJ]?"}]},c={cN:"params",b:/\(/,e:/\)/,c:["self",r,l,b]};return{aliases:["py","gyp"],k:{keyword:"and elif is global as in if from raise for except finally print import pass return exec else break not with class assert yield try while continue del or def lambda nonlocal|10 None True False",built_in:"Ellipsis NotImplemented"},i:/(<\/|->|\?)/,c:[r,l,b,e.HCM,{v:[{cN:"function",bK:"def",r:10},{cN:"class",bK:"class"}],e:/:/,i:/[${=;\n,]/,c:[e.UTM,c]},{cN:"decorator",b:/@/,e:/$/},{b:/\b(print|exec)\(/}]}});hljs.registerLanguage("axapta",function(e){return{k:"false int abstract private char boolean static null if for true while long throw finally protected final return void enum else break new catch byte super case short default double public try this switch continue reverse firstfast firstonly forupdate nofetch sum avg minof maxof count order group by asc desc index hint like dispaly edit client server ttsbegin ttscommit str real date container anytype common div mod",c:[e.CLCM,e.CBCM,e.ASM,e.QSM,e.CNM,{cN:"preprocessor",b:"#",e:"$"},{cN:"class",bK:"class interface",e:"{",eE:!0,i:":",c:[{bK:"extends implements"},e.UTM]}]}});hljs.registerLanguage("nix",function(e){var t={keyword:"rec with let in inherit assert if else then",constant:"true false or and null",built_in:"import abort baseNameOf dirOf isNull builtins map removeAttrs throw toString derivation"},i={cN:"subst",b:/\$\{/,e:/}/,k:t},r={cN:"variable",b:/[a-zA-Z0-9-_]+(\s*=)/},n={cN:"string",b:"''",e:"''",c:[i]},s={cN:"string",b:'"',e:'"',c:[i]},a=[e.NM,e.HCM,e.CBCM,n,s,r];return i.c=a,{aliases:["nixos"],k:t,c:a}});hljs.registerLanguage("diff",function(e){return{aliases:["patch"],c:[{cN:"chunk",r:10,v:[{b:/^@@ +\-\d+,\d+ +\+\d+,\d+ +@@$/},{b:/^\*\*\* +\d+,\d+ +\*\*\*\*$/},{b:/^\-\-\- +\d+,\d+ +\-\-\-\-$/}]},{cN:"header",v:[{b:/Index: /,e:/$/},{b:/=====/,e:/=====$/},{b:/^\-\-\-/,e:/$/},{b:/^\*{3} /,e:/$/},{b:/^\+\+\+/,e:/$/},{b:/\*{5}/,e:/\*{5}$/}]},{cN:"addition",b:"^\\+",e:"$"},{cN:"deletion",b:"^\\-",e:"$"},{cN:"change",b:"^\\!",e:"$"}]}});hljs.registerLanguage("parser3",function(r){var e=r.C("{","}",{c:["self"]});return{sL:"xml",r:0,c:[r.C("^#","$"),r.C("\\^rem{","}",{r:10,c:[e]}),{cN:"preprocessor",b:"^@(?:BASE|USE|CLASS|OPTIONS)$",r:10},{cN:"title",b:"@[\\w\\-]+\\[[\\w^;\\-]*\\](?:\\[[\\w^;\\-]*\\])?(?:.*)$"},{cN:"variable",b:"\\$\\{?[\\w\\-\\.\\:]+\\}?"},{cN:"keyword",b:"\\^[\\w\\-\\.\\:]+"},{cN:"number",b:"\\^#[0-9a-fA-F]+"},r.CNM]}});hljs.registerLanguage("django",function(e){var t={cN:"filter",b:/\|[A-Za-z]+:?/,k:"truncatewords removetags linebreaksbr yesno get_digit timesince random striptags filesizeformat escape linebreaks length_is ljust rjust cut urlize fix_ampersands title floatformat capfirst pprint divisibleby add make_list unordered_list urlencode timeuntil urlizetrunc wordcount stringformat linenumbers slice date dictsort dictsortreversed default_if_none pluralize lower join center default truncatewords_html upper length phone2numeric wordwrap time addslashes slugify first escapejs force_escape iriencode last safe safeseq truncatechars localize unlocalize localtime utc timezone",c:[{cN:"argument",b:/"/,e:/"/},{cN:"argument",b:/'/,e:/'/}]};return{aliases:["jinja"],cI:!0,sL:"xml",subLanguageMode:"continuous",c:[e.C(/\{%\s*comment\s*%}/,/\{%\s*endcomment\s*%}/),e.C(/\{#/,/#}/),{cN:"template_tag",b:/\{%/,e:/%}/,k:"comment endcomment load templatetag ifchanged endifchanged if endif firstof for endfor in ifnotequal endifnotequal widthratio extends include spaceless endspaceless regroup by as ifequal endifequal ssi now with cycle url filter endfilter debug block endblock else autoescape endautoescape csrf_token empty elif endwith static trans blocktrans endblocktrans get_static_prefix get_media_prefix plural get_current_language language get_available_languages get_current_language_bidi get_language_info get_language_info_list localize endlocalize localtime endlocaltime timezone endtimezone get_current_timezone verbatim",c:[t]},{cN:"variable",b:/\{\{/,e:/}}/,c:[t]}]}});hljs.registerLanguage("rust",function(e){var t=e.inherit(e.CBCM);return t.c.push("self"),{aliases:["rs"],k:{keyword:"alignof as be box break const continue crate do else enum extern false fn for if impl in let loop match mod mut offsetof once priv proc pub pure ref return self sizeof static struct super trait true type typeof unsafe unsized use virtual while yield int i8 i16 i32 i64 uint u8 u32 u64 float f32 f64 str char bool",built_in:"assert! assert_eq! bitflags! bytes! cfg! col! concat! concat_idents! debug_assert! debug_assert_eq! env! panic! file! format! format_args! include_bin! include_str! line! local_data_key! module_path! option_env! print! println! select! stringify! try! unimplemented! unreachable! vec! write! writeln!"},l:e.IR+"!?",i:"</",c:[e.CLCM,t,e.inherit(e.QSM,{i:null}),{cN:"string",b:/r(#*)".*?"\1(?!#)/},{cN:"string",b:/'\\?(x\w{2}|u\w{4}|U\w{8}|.)'/},{b:/'[a-zA-Z_][a-zA-Z0-9_]*/},{cN:"number",b:/\b(0[xbo][A-Fa-f0-9_]+|\d[\d_]*(\.[0-9_]+)?([eE][+-]?[0-9_]+)?)([uif](8|16|32|64|size))?/,r:0},{cN:"function",bK:"fn",e:"(\\(|<)",eE:!0,c:[e.UTM]},{cN:"preprocessor",b:"#\\!?\\[",e:"\\]"},{bK:"type",e:"(=|<)",c:[e.UTM],i:"\\S"},{bK:"trait enum",e:"({|<)",c:[e.UTM],i:"\\S"},{b:e.IR+"::"},{b:"->"}]}});hljs.registerLanguage("vhdl",function(e){var t="\\d(_|\\d)*",r="[eE][-+]?"+t,n=t+"(\\."+t+")?("+r+")?",o="\\w+",i=t+"#"+o+"(\\."+o+")?#("+r+")?",a="\\b("+i+"|"+n+")";return{cI:!0,k:{keyword:"abs access after alias all and architecture array assert attribute begin block body buffer bus case component configuration constant context cover disconnect downto default else elsif end entity exit fairness file for force function generate generic group guarded if impure in inertial inout is label library linkage literal loop map mod nand new next nor not null of on open or others out package port postponed procedure process property protected pure range record register reject release rem report restrict restrict_guarantee return rol ror select sequence severity shared signal sla sll sra srl strong subtype then to transport type unaffected units until use variable vmode vprop vunit wait when while with xnor xor",typename:"boolean bit character severity_level integer time delay_length natural positive string bit_vector file_open_kind file_open_status std_ulogic std_ulogic_vector std_logic std_logic_vector unsigned signed boolean_vector integer_vector real_vector time_vector"},i:"{",c:[e.CBCM,e.C("--","$"),e.QSM,{cN:"number",b:a,r:0},{cN:"literal",b:"'(U|X|0|1|Z|W|L|H|-)'",c:[e.BE]},{cN:"attribute",b:"'[A-Za-z](_?[A-Za-z0-9])*",c:[e.BE]}]}});hljs.registerLanguage("ocaml",function(e){return{aliases:["ml"],k:{keyword:"and as assert asr begin class constraint do done downto else end exception external for fun function functor if in include inherit! inherit initializer land lazy let lor lsl lsr lxor match method!|10 method mod module mutable new object of open! open or private rec sig struct then to try type val! val virtual when while with parser value",built_in:"array bool bytes char exn|5 float int int32 int64 list lazy_t|5 nativeint|5 string unit in_channel out_channel ref",literal:"true false"},i:/\/\/|>>/,l:"[a-z_]\\w*!?",c:[{cN:"literal",b:"\\[(\\|\\|)?\\]|\\(\\)"},e.C("\\(\\*","\\*\\)",{c:["self"]}),{cN:"symbol",b:"'[A-Za-z_](?!')[\\w']*"},{cN:"tag",b:"`[A-Z][\\w']*"},{cN:"type",b:"\\b[A-Z][\\w']*",r:0},{b:"[a-z_]\\w*'[\\w']*"},e.inherit(e.ASM,{cN:"char",r:0}),e.inherit(e.QSM,{i:null}),{cN:"number",b:"\\b(0[xX][a-fA-F0-9_]+[Lln]?|0[oO][0-7_]+[Lln]?|0[bB][01_]+[Lln]?|[0-9][0-9_]*([Lln]|(\\.[0-9_]*)?([eE][-+]?[0-9_]+)?)?)",r:0},{b:/[-=]>/}]}});hljs.registerLanguage("cmake",function(e){return{aliases:["cmake.in"],cI:!0,k:{keyword:"add_custom_command add_custom_target add_definitions add_dependencies add_executable add_library add_subdirectory add_test aux_source_directory break build_command cmake_minimum_required cmake_policy configure_file create_test_sourcelist define_property else elseif enable_language enable_testing endforeach endfunction endif endmacro endwhile execute_process export find_file find_library find_package find_path find_program fltk_wrap_ui foreach function get_cmake_property get_directory_property get_filename_component get_property get_source_file_property get_target_property get_test_property if include include_directories include_external_msproject include_regular_expression install link_directories load_cache load_command macro mark_as_advanced message option output_required_files project qt_wrap_cpp qt_wrap_ui remove_definitions return separate_arguments set set_directory_properties set_property set_source_files_properties set_target_properties set_tests_properties site_name source_group string target_link_libraries try_compile try_run unset variable_watch while build_name exec_program export_library_dependencies install_files install_programs install_targets link_libraries make_directory remove subdir_depends subdirs use_mangled_mesa utility_source variable_requires write_file qt5_use_modules qt5_use_package qt5_wrap_cpp on off true false and or",operator:"equal less greater strless strgreater strequal matches"},c:[{cN:"envvar",b:"\\${",e:"}"},e.HCM,e.QSM,e.NM]}});hljs.registerLanguage("1c",function(c){var e="[a-zA-Zа-яА-Я][a-zA-Z0-9_а-яА-Я]*",r="возврат дата для если и или иначе иначеесли исключение конецесли конецпопытки конецпроцедуры конецфункции конеццикла константа не перейти перем перечисление по пока попытка прервать продолжить процедура строка тогда фс функция цикл число экспорт",t="ansitooem oemtoansi ввестивидсубконто ввестидату ввестизначение ввестиперечисление ввестипериод ввестиплансчетов ввестистроку ввестичисло вопрос восстановитьзначение врег выбранныйплансчетов вызватьисключение датагод датамесяц датачисло добавитьмесяц завершитьработусистемы заголовоксистемы записьжурналарегистрации запуститьприложение зафиксироватьтранзакцию значениевстроку значениевстрокувнутр значениевфайл значениеизстроки значениеизстрокивнутр значениеизфайла имякомпьютера имяпользователя каталогвременныхфайлов каталогиб каталогпользователя каталогпрограммы кодсимв командасистемы конгода конецпериодаби конецрассчитанногопериодаби конецстандартногоинтервала конквартала конмесяца коннедели лев лог лог10 макс максимальноеколичествосубконто мин монопольныйрежим названиеинтерфейса названиенабораправ назначитьвид назначитьсчет найти найтипомеченныенаудаление найтиссылки началопериодаби началостандартногоинтервала начатьтранзакцию начгода начквартала начмесяца начнедели номерднягода номерднянедели номернеделигода нрег обработкаожидания окр описаниеошибки основнойжурналрасчетов основнойплансчетов основнойязык открытьформу открытьформумодально отменитьтранзакцию очиститьокносообщений периодстр полноеимяпользователя получитьвремята получитьдатута получитьдокументта получитьзначенияотбора получитьпозициюта получитьпустоезначение получитьта прав праводоступа предупреждение префиксавтонумерации пустаястрока пустоезначение рабочаядаттьпустоезначение рабочаядата разделительстраниц разделительстрок разм разобратьпозициюдокумента рассчитатьрегистрына рассчитатьрегистрыпо сигнал симв символтабуляции создатьобъект сокрл сокрлп сокрп сообщить состояние сохранитьзначение сред статусвозврата стрдлина стрзаменить стрколичествострок стрполучитьстроку стрчисловхождений сформироватьпозициюдокумента счетпокоду текущаядата текущеевремя типзначения типзначениястр удалитьобъекты установитьтана установитьтапо фиксшаблон формат цел шаблон",i={cN:"dquote",b:'""'},n={cN:"string",b:'"',e:'"|$',c:[i]},a={cN:"string",b:"\\|",e:'"|$',c:[i]};return{cI:!0,l:e,k:{keyword:r,built_in:t},c:[c.CLCM,c.NM,n,a,{cN:"function",b:"(процедура|функция)",e:"$",l:e,k:"процедура функция",c:[c.inherit(c.TM,{b:e}),{cN:"tail",eW:!0,c:[{cN:"params",b:"\\(",e:"\\)",l:e,k:"знач",c:[n,a]},{cN:"export",b:"экспорт",eW:!0,l:e,k:"экспорт",c:[c.CLCM]}]},c.CLCM]},{cN:"preprocessor",b:"#",e:"$"},{cN:"date",b:"'\\d{2}\\.\\d{2}\\.(\\d{2}|\\d{4})'"}]}});hljs.registerLanguage("tcl",function(e){return{aliases:["tk"],k:"after append apply array auto_execok auto_import auto_load auto_mkindex auto_mkindex_old auto_qualify auto_reset bgerror binary break catch cd chan clock close concat continue dde dict encoding eof error eval exec exit expr fblocked fconfigure fcopy file fileevent filename flush for foreach format gets glob global history http if incr info interp join lappend|10 lassign|10 lindex|10 linsert|10 list llength|10 load lrange|10 lrepeat|10 lreplace|10 lreverse|10 lsearch|10 lset|10 lsort|10 mathfunc mathop memory msgcat namespace open package parray pid pkg::create pkg_mkIndex platform platform::shell proc puts pwd read refchan regexp registry regsub|10 rename return safe scan seek set socket source split string subst switch tcl_endOfWord tcl_findLibrary tcl_startOfNextWord tcl_startOfPreviousWord tcl_wordBreakAfter tcl_wordBreakBefore tcltest tclvars tell time tm trace unknown unload unset update uplevel upvar variable vwait while",c:[e.C(";[ \\t]*#","$"),e.C("^[ \\t]*#","$"),{bK:"proc",e:"[\\{]",eE:!0,c:[{cN:"symbol",b:"[ \\t\\n\\r]+(::)?[a-zA-Z_]((::)?[a-zA-Z0-9_])*",e:"[ \\t\\n\\r]",eW:!0,eE:!0}]},{cN:"variable",eE:!0,v:[{b:"\\$(\\{)?(::)?[a-zA-Z_]((::)?[a-zA-Z0-9_])*\\(([a-zA-Z0-9_])*\\)",e:"[^a-zA-Z0-9_\\}\\$]"},{b:"\\$(\\{)?(::)?[a-zA-Z_]((::)?[a-zA-Z0-9_])*",e:"(\\))?[^a-zA-Z0-9_\\}\\$]"}]},{cN:"string",c:[e.BE],v:[e.inherit(e.ASM,{i:null}),e.inherit(e.QSM,{i:null})]},{cN:"number",v:[e.BNM,e.CNM]}]}});hljs.registerLanguage("groovy",function(e){return{k:{typename:"byte short char int long boolean float double void",literal:"true false null",keyword:"def as in assert trait super this abstract static volatile transient public private protected synchronized final class interface enum if else for while switch case break default continue throw throws try catch finally implements extends new import package return instanceof"},c:[e.CLCM,{cN:"javadoc",b:"/\\*\\*",e:"\\*//*",r:0,c:[{cN:"javadoctag",b:"(^|\\s)@[A-Za-z]+"}]},e.CBCM,{cN:"string",b:'"""',e:'"""'},{cN:"string",b:"'''",e:"'''"},{cN:"string",b:"\\$/",e:"/\\$",r:10},e.ASM,{cN:"regexp",b:/~?\/[^\/\n]+\//,c:[e.BE]},e.QSM,{cN:"shebang",b:"^#!/usr/bin/env",e:"$",i:"\n"},e.BNM,{cN:"class",bK:"class interface trait enum",e:"{",i:":",c:[{bK:"extends implements"},e.UTM]},e.CNM,{cN:"annotation",b:"@[A-Za-z]+"},{cN:"string",b:/[^\?]{0}[A-Za-z0-9_$]+ *:/},{b:/\?/,e:/\:/},{cN:"label",b:"^\\s*[A-Za-z0-9_$]+:",r:0}]}});hljs.registerLanguage("erlang-repl",function(r){return{k:{special_functions:"spawn spawn_link self",reserved:"after and andalso|10 band begin bnot bor bsl bsr bxor case catch cond div end fun if let not of or orelse|10 query receive rem try when xor"},c:[{cN:"prompt",b:"^[0-9]+> ",r:10},r.C("%","$"),{cN:"number",b:"\\b(\\d+#[a-fA-F0-9]+|\\d+(\\.\\d+)?([eE][-+]?\\d+)?)",r:0},r.ASM,r.QSM,{cN:"constant",b:"\\?(::)?([A-Z]\\w*(::)?)+"},{cN:"arrow",b:"->"},{cN:"ok",b:"ok"},{cN:"exclamation_mark",b:"!"},{cN:"function_or_atom",b:"(\\b[a-z'][a-zA-Z0-9_']*:[a-z'][a-zA-Z0-9_']*)|(\\b[a-z'][a-zA-Z0-9_']*)",r:0},{cN:"variable",b:"[A-Z][a-zA-Z0-9_']*",r:0}]}});hljs.registerLanguage("nginx",function(e){var r={cN:"variable",v:[{b:/\$\d+/},{b:/\$\{/,e:/}/},{b:"[\\$\\@]"+e.UIR}]},b={eW:!0,l:"[a-z/_]+",k:{built_in:"on off yes no true false none blocked debug info notice warn error crit select break last permanent redirect kqueue rtsig epoll poll /dev/poll"},r:0,i:"=>",c:[e.HCM,{cN:"string",c:[e.BE,r],v:[{b:/"/,e:/"/},{b:/'/,e:/'/}]},{cN:"url",b:"([a-z]+):/",e:"\\s",eW:!0,eE:!0,c:[r]},{cN:"regexp",c:[e.BE,r],v:[{b:"\\s\\^",e:"\\s|{|;",rE:!0},{b:"~\\*?\\s+",e:"\\s|{|;",rE:!0},{b:"\\*(\\.[a-z\\-]+)+"},{b:"([a-z\\-]+\\.)+\\*"}]},{cN:"number",b:"\\b\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}(:\\d{1,5})?\\b"},{cN:"number",b:"\\b\\d+[kKmMgGdshdwy]*\\b",r:0},r]};return{aliases:["nginxconf"],c:[e.HCM,{b:e.UIR+"\\s",e:";|{",rB:!0,c:[{cN:"title",b:e.UIR,starts:b}],r:0}],i:"[^\\s\\}]"}});hljs.registerLanguage("mathematica",function(e){return{aliases:["mma"],l:"(\\$|\\b)"+e.IR+"\\b",k:"AbelianGroup Abort AbortKernels AbortProtect Above Abs Absolute AbsoluteCorrelation AbsoluteCorrelationFunction AbsoluteCurrentValue AbsoluteDashing AbsoluteFileName AbsoluteOptions AbsolutePointSize AbsoluteThickness AbsoluteTime AbsoluteTiming AccountingForm Accumulate Accuracy AccuracyGoal ActionDelay ActionMenu ActionMenuBox ActionMenuBoxOptions Active ActiveItem ActiveStyle AcyclicGraphQ AddOnHelpPath AddTo AdjacencyGraph AdjacencyList AdjacencyMatrix AdjustmentBox AdjustmentBoxOptions AdjustTimeSeriesForecast AffineTransform After AiryAi AiryAiPrime AiryAiZero AiryBi AiryBiPrime AiryBiZero AlgebraicIntegerQ AlgebraicNumber AlgebraicNumberDenominator AlgebraicNumberNorm AlgebraicNumberPolynomial AlgebraicNumberTrace AlgebraicRules AlgebraicRulesData Algebraics AlgebraicUnitQ Alignment AlignmentMarker AlignmentPoint All AllowedDimensions AllowGroupClose AllowInlineCells AllowKernelInitialization AllowReverseGroupClose AllowScriptLevelChange AlphaChannel AlternatingGroup AlternativeHypothesis Alternatives AmbientLight Analytic AnchoredSearch And AndersonDarlingTest AngerJ AngleBracket AngularGauge Animate AnimationCycleOffset AnimationCycleRepetitions AnimationDirection AnimationDisplayTime AnimationRate AnimationRepetitions AnimationRunning Animator AnimatorBox AnimatorBoxOptions AnimatorElements Annotation Annuity AnnuityDue Antialiasing Antisymmetric Apart ApartSquareFree Appearance AppearanceElements AppellF1 Append AppendTo Apply ArcCos ArcCosh ArcCot ArcCoth ArcCsc ArcCsch ArcSec ArcSech ArcSin ArcSinDistribution ArcSinh ArcTan ArcTanh Arg ArgMax ArgMin ArgumentCountQ ARIMAProcess ArithmeticGeometricMean ARMAProcess ARProcess Array ArrayComponents ArrayDepth ArrayFlatten ArrayPad ArrayPlot ArrayQ ArrayReshape ArrayRules Arrays Arrow Arrow3DBox ArrowBox Arrowheads AspectRatio AspectRatioFixed Assert Assuming Assumptions AstronomicalData Asynchronous AsynchronousTaskObject AsynchronousTasks AtomQ Attributes AugmentedSymmetricPolynomial AutoAction AutoDelete AutoEvaluateEvents AutoGeneratedPackage AutoIndent AutoIndentSpacings AutoItalicWords AutoloadPath AutoMatch Automatic AutomaticImageSize AutoMultiplicationSymbol AutoNumberFormatting AutoOpenNotebooks AutoOpenPalettes AutorunSequencing AutoScaling AutoScroll AutoSpacing AutoStyleOptions AutoStyleWords Axes AxesEdge AxesLabel AxesOrigin AxesStyle Axis BabyMonsterGroupB Back Background BackgroundTasksSettings Backslash Backsubstitution Backward Band BandpassFilter BandstopFilter BarabasiAlbertGraphDistribution BarChart BarChart3D BarLegend BarlowProschanImportance BarnesG BarOrigin BarSpacing BartlettHannWindow BartlettWindow BaseForm Baseline BaselinePosition BaseStyle BatesDistribution BattleLemarieWavelet Because BeckmannDistribution Beep Before Begin BeginDialogPacket BeginFrontEndInteractionPacket BeginPackage BellB BellY Below BenfordDistribution BeniniDistribution BenktanderGibratDistribution BenktanderWeibullDistribution BernoulliB BernoulliDistribution BernoulliGraphDistribution BernoulliProcess BernsteinBasis BesselFilterModel BesselI BesselJ BesselJZero BesselK BesselY BesselYZero Beta BetaBinomialDistribution BetaDistribution BetaNegativeBinomialDistribution BetaPrimeDistribution BetaRegularized BetweennessCentrality BezierCurve BezierCurve3DBox BezierCurve3DBoxOptions BezierCurveBox BezierCurveBoxOptions BezierFunction BilateralFilter Binarize BinaryFormat BinaryImageQ BinaryRead BinaryReadList BinaryWrite BinCounts BinLists Binomial BinomialDistribution BinomialProcess BinormalDistribution BiorthogonalSplineWavelet BipartiteGraphQ BirnbaumImportance BirnbaumSaundersDistribution BitAnd BitClear BitGet BitLength BitNot BitOr BitSet BitShiftLeft BitShiftRight BitXor Black BlackmanHarrisWindow BlackmanNuttallWindow BlackmanWindow Blank BlankForm BlankNullSequence BlankSequence Blend Block BlockRandom BlomqvistBeta BlomqvistBetaTest Blue Blur BodePlot BohmanWindow Bold Bookmarks Boole BooleanConsecutiveFunction BooleanConvert BooleanCountingFunction BooleanFunction BooleanGraph BooleanMaxterms BooleanMinimize BooleanMinterms Booleans BooleanTable BooleanVariables BorderDimensions BorelTannerDistribution Bottom BottomHatTransform BoundaryStyle Bounds Box BoxBaselineShift BoxData BoxDimensions Boxed Boxes BoxForm BoxFormFormatTypes BoxFrame BoxID BoxMargins BoxMatrix BoxRatios BoxRotation BoxRotationPoint BoxStyle BoxWhiskerChart Bra BracketingBar BraKet BrayCurtisDistance BreadthFirstScan Break Brown BrownForsytheTest BrownianBridgeProcess BrowserCategory BSplineBasis BSplineCurve BSplineCurve3DBox BSplineCurveBox BSplineCurveBoxOptions BSplineFunction BSplineSurface BSplineSurface3DBox BubbleChart BubbleChart3D BubbleScale BubbleSizes BulletGauge BusinessDayQ ButterflyGraph ButterworthFilterModel Button ButtonBar ButtonBox ButtonBoxOptions ButtonCell ButtonContents ButtonData ButtonEvaluator ButtonExpandable ButtonFrame ButtonFunction ButtonMargins ButtonMinHeight ButtonNote ButtonNotebook ButtonSource ButtonStyle ButtonStyleMenuListing Byte ByteCount ByteOrdering C CachedValue CacheGraphics CalendarData CalendarType CallPacket CanberraDistance Cancel CancelButton CandlestickChart Cap CapForm CapitalDifferentialD CardinalBSplineBasis CarmichaelLambda Cases Cashflow Casoratian Catalan CatalanNumber Catch CauchyDistribution CauchyWindow CayleyGraph CDF CDFDeploy CDFInformation CDFWavelet Ceiling Cell CellAutoOverwrite CellBaseline CellBoundingBox CellBracketOptions CellChangeTimes CellContents CellContext CellDingbat CellDynamicExpression CellEditDuplicate CellElementsBoundingBox CellElementSpacings CellEpilog CellEvaluationDuplicate CellEvaluationFunction CellEventActions CellFrame CellFrameColor CellFrameLabelMargins CellFrameLabels CellFrameMargins CellGroup CellGroupData CellGrouping CellGroupingRules CellHorizontalScrolling CellID CellLabel CellLabelAutoDelete CellLabelMargins CellLabelPositioning CellMargins CellObject CellOpen CellPrint CellProlog Cells CellSize CellStyle CellTags CellularAutomaton CensoredDistribution Censoring Center CenterDot CentralMoment CentralMomentGeneratingFunction CForm ChampernowneNumber ChanVeseBinarize Character CharacterEncoding CharacterEncodingsPath CharacteristicFunction CharacteristicPolynomial CharacterRange Characters ChartBaseStyle ChartElementData ChartElementDataFunction ChartElementFunction ChartElements ChartLabels ChartLayout ChartLegends ChartStyle Chebyshev1FilterModel Chebyshev2FilterModel ChebyshevDistance ChebyshevT ChebyshevU Check CheckAbort CheckAll Checkbox CheckboxBar CheckboxBox CheckboxBoxOptions ChemicalData ChessboardDistance ChiDistribution ChineseRemainder ChiSquareDistribution ChoiceButtons ChoiceDialog CholeskyDecomposition Chop Circle CircleBox CircleDot CircleMinus CirclePlus CircleTimes CirculantGraph CityData Clear ClearAll ClearAttributes ClearSystemCache ClebschGordan ClickPane Clip ClipboardNotebook ClipFill ClippingStyle ClipPlanes ClipRange Clock ClockGauge ClockwiseContourIntegral Close Closed CloseKernels ClosenessCentrality Closing ClosingAutoSave ClosingEvent ClusteringComponents CMYKColor Coarse Coefficient CoefficientArrays CoefficientDomain CoefficientList CoefficientRules CoifletWavelet Collect Colon ColonForm ColorCombine ColorConvert ColorData ColorDataFunction ColorFunction ColorFunctionScaling Colorize ColorNegate ColorOutput ColorProfileData ColorQuantize ColorReplace ColorRules ColorSelectorSettings ColorSeparate ColorSetter ColorSetterBox ColorSetterBoxOptions ColorSlider ColorSpace Column ColumnAlignments ColumnBackgrounds ColumnForm ColumnLines ColumnsEqual ColumnSpacings ColumnWidths CommonDefaultFormatTypes Commonest CommonestFilter CommonUnits CommunityBoundaryStyle CommunityGraphPlot CommunityLabels CommunityRegionStyle CompatibleUnitQ CompilationOptions CompilationTarget Compile Compiled CompiledFunction Complement CompleteGraph CompleteGraphQ CompleteKaryTree CompletionsListPacket Complex Complexes ComplexExpand ComplexInfinity ComplexityFunction ComponentMeasurements ComponentwiseContextMenu Compose ComposeList ComposeSeries Composition CompoundExpression CompoundPoissonDistribution CompoundPoissonProcess CompoundRenewalProcess Compress CompressedData Condition ConditionalExpression Conditioned Cone ConeBox ConfidenceLevel ConfidenceRange ConfidenceTransform ConfigurationPath Congruent Conjugate ConjugateTranspose Conjunction Connect ConnectedComponents ConnectedGraphQ ConnesWindow ConoverTest ConsoleMessage ConsoleMessagePacket ConsolePrint Constant ConstantArray Constants ConstrainedMax ConstrainedMin ContentPadding ContentsBoundingBox ContentSelectable ContentSize Context ContextMenu Contexts ContextToFilename ContextToFileName Continuation Continue ContinuedFraction ContinuedFractionK ContinuousAction ContinuousMarkovProcess ContinuousTimeModelQ ContinuousWaveletData ContinuousWaveletTransform ContourDetect ContourGraphics ContourIntegral ContourLabels ContourLines ContourPlot ContourPlot3D Contours ContourShading ContourSmoothing ContourStyle ContraharmonicMean Control ControlActive ControlAlignment ControllabilityGramian ControllabilityMatrix ControllableDecomposition ControllableModelQ ControllerDuration ControllerInformation ControllerInformationData ControllerLinking ControllerManipulate ControllerMethod ControllerPath ControllerState ControlPlacement ControlsRendering ControlType Convergents ConversionOptions ConversionRules ConvertToBitmapPacket ConvertToPostScript ConvertToPostScriptPacket Convolve ConwayGroupCo1 ConwayGroupCo2 ConwayGroupCo3 CoordinateChartData CoordinatesToolOptions CoordinateTransform CoordinateTransformData CoprimeQ Coproduct CopulaDistribution Copyable CopyDirectory CopyFile CopyTag CopyToClipboard CornerFilter CornerNeighbors Correlation CorrelationDistance CorrelationFunction CorrelationTest Cos Cosh CoshIntegral CosineDistance CosineWindow CosIntegral Cot Coth Count CounterAssignments CounterBox CounterBoxOptions CounterClockwiseContourIntegral CounterEvaluator CounterFunction CounterIncrements CounterStyle CounterStyleMenuListing CountRoots CountryData Covariance CovarianceEstimatorFunction CovarianceFunction CoxianDistribution CoxIngersollRossProcess CoxModel CoxModelFit CramerVonMisesTest CreateArchive CreateDialog CreateDirectory CreateDocument CreateIntermediateDirectories CreatePalette CreatePalettePacket CreateScheduledTask CreateTemporary CreateWindow CriticalityFailureImportance CriticalitySuccessImportance CriticalSection Cross CrossingDetect CrossMatrix Csc Csch CubeRoot Cubics Cuboid CuboidBox Cumulant CumulantGeneratingFunction Cup CupCap Curl CurlyDoubleQuote CurlyQuote CurrentImage CurrentlySpeakingPacket CurrentValue CurvatureFlowFilter CurveClosed Cyan CycleGraph CycleIndexPolynomial Cycles CyclicGroup Cyclotomic Cylinder CylinderBox CylindricalDecomposition D DagumDistribution DamerauLevenshteinDistance DampingFactor Darker Dashed Dashing DataCompression DataDistribution DataRange DataReversed Date DateDelimiters DateDifference DateFunction DateList DateListLogPlot DateListPlot DatePattern DatePlus DateRange DateString DateTicksFormat DaubechiesWavelet DavisDistribution DawsonF DayCount DayCountConvention DayMatchQ DayName DayPlus DayRange DayRound DeBruijnGraph Debug DebugTag Decimal DeclareKnownSymbols DeclarePackage Decompose Decrement DedekindEta Default DefaultAxesStyle DefaultBaseStyle DefaultBoxStyle DefaultButton DefaultColor DefaultControlPlacement DefaultDuplicateCellStyle DefaultDuration DefaultElement DefaultFaceGridsStyle DefaultFieldHintStyle DefaultFont DefaultFontProperties DefaultFormatType DefaultFormatTypeForStyle DefaultFrameStyle DefaultFrameTicksStyle DefaultGridLinesStyle DefaultInlineFormatType DefaultInputFormatType DefaultLabelStyle DefaultMenuStyle DefaultNaturalLanguage DefaultNewCellStyle DefaultNewInlineCellStyle DefaultNotebook DefaultOptions DefaultOutputFormatType DefaultStyle DefaultStyleDefinitions DefaultTextFormatType DefaultTextInlineFormatType DefaultTicksStyle DefaultTooltipStyle DefaultValues Defer DefineExternal DefineInputStreamMethod DefineOutputStreamMethod Definition Degree DegreeCentrality DegreeGraphDistribution DegreeLexicographic DegreeReverseLexicographic Deinitialization Del Deletable Delete DeleteBorderComponents DeleteCases DeleteContents DeleteDirectory DeleteDuplicates DeleteFile DeleteSmallComponents DeleteWithContents DeletionWarning Delimiter DelimiterFlashTime DelimiterMatching Delimiters Denominator DensityGraphics DensityHistogram DensityPlot DependentVariables Deploy Deployed Depth DepthFirstScan Derivative DerivativeFilter DescriptorStateSpace DesignMatrix Det DGaussianWavelet DiacriticalPositioning Diagonal DiagonalMatrix Dialog DialogIndent DialogInput DialogLevel DialogNotebook DialogProlog DialogReturn DialogSymbols Diamond DiamondMatrix DiceDissimilarity DictionaryLookup DifferenceDelta DifferenceOrder DifferenceRoot DifferenceRootReduce Differences DifferentialD DifferentialRoot DifferentialRootReduce DifferentiatorFilter DigitBlock DigitBlockMinimum DigitCharacter DigitCount DigitQ DihedralGroup Dilation Dimensions DiracComb DiracDelta DirectedEdge DirectedEdges DirectedGraph DirectedGraphQ DirectedInfinity Direction Directive Directory DirectoryName DirectoryQ DirectoryStack DirichletCharacter DirichletConvolve DirichletDistribution DirichletL DirichletTransform DirichletWindow DisableConsolePrintPacket DiscreteChirpZTransform DiscreteConvolve DiscreteDelta DiscreteHadamardTransform DiscreteIndicator DiscreteLQEstimatorGains DiscreteLQRegulatorGains DiscreteLyapunovSolve DiscreteMarkovProcess DiscretePlot DiscretePlot3D DiscreteRatio DiscreteRiccatiSolve DiscreteShift DiscreteTimeModelQ DiscreteUniformDistribution DiscreteVariables DiscreteWaveletData DiscreteWaveletPacketTransform DiscreteWaveletTransform Discriminant Disjunction Disk DiskBox DiskMatrix Dispatch DispersionEstimatorFunction Display DisplayAllSteps DisplayEndPacket DisplayFlushImagePacket DisplayForm DisplayFunction DisplayPacket DisplayRules DisplaySetSizePacket DisplayString DisplayTemporary DisplayWith DisplayWithRef DisplayWithVariable DistanceFunction DistanceTransform Distribute Distributed DistributedContexts DistributeDefinitions DistributionChart DistributionDomain DistributionFitTest DistributionParameterAssumptions DistributionParameterQ Dithering Div Divergence Divide DivideBy Dividers Divisible Divisors DivisorSigma DivisorSum DMSList DMSString Do DockedCells DocumentNotebook DominantColors DOSTextFormat Dot DotDashed DotEqual Dotted DoubleBracketingBar DoubleContourIntegral DoubleDownArrow DoubleLeftArrow DoubleLeftRightArrow DoubleLeftTee DoubleLongLeftArrow DoubleLongLeftRightArrow DoubleLongRightArrow DoubleRightArrow DoubleRightTee DoubleUpArrow DoubleUpDownArrow DoubleVerticalBar DoublyInfinite Down DownArrow DownArrowBar DownArrowUpArrow DownLeftRightVector DownLeftTeeVector DownLeftVector DownLeftVectorBar DownRightTeeVector DownRightVector DownRightVectorBar Downsample DownTee DownTeeArrow DownValues DragAndDrop DrawEdges DrawFrontFaces DrawHighlighted Drop DSolve Dt DualLinearProgramming DualSystemsModel DumpGet DumpSave DuplicateFreeQ Dynamic DynamicBox DynamicBoxOptions DynamicEvaluationTimeout DynamicLocation DynamicModule DynamicModuleBox DynamicModuleBoxOptions DynamicModuleParent DynamicModuleValues DynamicName DynamicNamespace DynamicReference DynamicSetting DynamicUpdating DynamicWrapper DynamicWrapperBox DynamicWrapperBoxOptions E EccentricityCentrality EdgeAdd EdgeBetweennessCentrality EdgeCapacity EdgeCapForm EdgeColor EdgeConnectivity EdgeCost EdgeCount EdgeCoverQ EdgeDashing EdgeDelete EdgeDetect EdgeForm EdgeIndex EdgeJoinForm EdgeLabeling EdgeLabels EdgeLabelStyle EdgeList EdgeOpacity EdgeQ EdgeRenderingFunction EdgeRules EdgeShapeFunction EdgeStyle EdgeThickness EdgeWeight Editable EditButtonSettings EditCellTagsSettings EditDistance EffectiveInterest Eigensystem Eigenvalues EigenvectorCentrality Eigenvectors Element ElementData Eliminate EliminationOrder EllipticE EllipticExp EllipticExpPrime EllipticF EllipticFilterModel EllipticK EllipticLog EllipticNomeQ EllipticPi EllipticReducedHalfPeriods EllipticTheta EllipticThetaPrime EmitSound EmphasizeSyntaxErrors EmpiricalDistribution Empty EmptyGraphQ EnableConsolePrintPacket Enabled Encode End EndAdd EndDialogPacket EndFrontEndInteractionPacket EndOfFile EndOfLine EndOfString EndPackage EngineeringForm Enter EnterExpressionPacket EnterTextPacket Entropy EntropyFilter Environment Epilog Equal EqualColumns EqualRows EqualTilde EquatedTo Equilibrium EquirippleFilterKernel Equivalent Erf Erfc Erfi ErlangB ErlangC ErlangDistribution Erosion ErrorBox ErrorBoxOptions ErrorNorm ErrorPacket ErrorsDialogSettings EstimatedDistribution EstimatedProcess EstimatorGains EstimatorRegulator EuclideanDistance EulerE EulerGamma EulerianGraphQ EulerPhi Evaluatable Evaluate Evaluated EvaluatePacket EvaluationCell EvaluationCompletionAction EvaluationElements EvaluationMode EvaluationMonitor EvaluationNotebook EvaluationObject EvaluationOrder Evaluator EvaluatorNames EvenQ EventData EventEvaluator EventHandler EventHandlerTag EventLabels ExactBlackmanWindow ExactNumberQ ExactRootIsolation ExampleData Except ExcludedForms ExcludePods Exclusions ExclusionsStyle Exists Exit ExitDialog Exp Expand ExpandAll ExpandDenominator ExpandFileName ExpandNumerator Expectation ExpectationE ExpectedValue ExpGammaDistribution ExpIntegralE ExpIntegralEi Exponent ExponentFunction ExponentialDistribution ExponentialFamily ExponentialGeneratingFunction ExponentialMovingAverage ExponentialPowerDistribution ExponentPosition ExponentStep Export ExportAutoReplacements ExportPacket ExportString Expression ExpressionCell ExpressionPacket ExpToTrig ExtendedGCD Extension ExtentElementFunction ExtentMarkers ExtentSize ExternalCall ExternalDataCharacterEncoding Extract ExtractArchive ExtremeValueDistribution FaceForm FaceGrids FaceGridsStyle Factor FactorComplete Factorial Factorial2 FactorialMoment FactorialMomentGeneratingFunction FactorialPower FactorInteger FactorList FactorSquareFree FactorSquareFreeList FactorTerms FactorTermsList Fail FailureDistribution False FARIMAProcess FEDisableConsolePrintPacket FeedbackSector FeedbackSectorStyle FeedbackType FEEnableConsolePrintPacket Fibonacci FieldHint FieldHintStyle FieldMasked FieldSize File FileBaseName FileByteCount FileDate FileExistsQ FileExtension FileFormat FileHash FileInformation FileName FileNameDepth FileNameDialogSettings FileNameDrop FileNameJoin FileNames FileNameSetter FileNameSplit FileNameTake FilePrint FileType FilledCurve FilledCurveBox Filling FillingStyle FillingTransform FilterRules FinancialBond FinancialData FinancialDerivative FinancialIndicator Find FindArgMax FindArgMin FindClique FindClusters FindCurvePath FindDistributionParameters FindDivisions FindEdgeCover FindEdgeCut FindEulerianCycle FindFaces FindFile FindFit FindGeneratingFunction FindGeoLocation FindGeometricTransform FindGraphCommunities FindGraphIsomorphism FindGraphPartition FindHamiltonianCycle FindIndependentEdgeSet FindIndependentVertexSet FindInstance FindIntegerNullVector FindKClan FindKClique FindKClub FindKPlex FindLibrary FindLinearRecurrence FindList FindMaximum FindMaximumFlow FindMaxValue FindMinimum FindMinimumCostFlow FindMinimumCut FindMinValue FindPermutation FindPostmanTour FindProcessParameters FindRoot FindSequenceFunction FindSettings FindShortestPath FindShortestTour FindThreshold FindVertexCover FindVertexCut Fine FinishDynamic FiniteAbelianGroupCount FiniteGroupCount FiniteGroupData First FirstPassageTimeDistribution FischerGroupFi22 FischerGroupFi23 FischerGroupFi24Prime FisherHypergeometricDistribution FisherRatioTest FisherZDistribution Fit FitAll FittedModel FixedPoint FixedPointList FlashSelection Flat Flatten FlattenAt FlatTopWindow FlipView Floor FlushPrintOutputPacket Fold FoldList Font FontColor FontFamily FontForm FontName FontOpacity FontPostScriptName FontProperties FontReencoding FontSize FontSlant FontSubstitutions FontTracking FontVariations FontWeight For ForAll Format FormatRules FormatType FormatTypeAutoConvert FormatValues FormBox FormBoxOptions FortranForm Forward ForwardBackward Fourier FourierCoefficient FourierCosCoefficient FourierCosSeries FourierCosTransform FourierDCT FourierDCTFilter FourierDCTMatrix FourierDST FourierDSTMatrix FourierMatrix FourierParameters FourierSequenceTransform FourierSeries FourierSinCoefficient FourierSinSeries FourierSinTransform FourierTransform FourierTrigSeries FractionalBrownianMotionProcess FractionalPart FractionBox FractionBoxOptions FractionLine Frame FrameBox FrameBoxOptions Framed FrameInset FrameLabel Frameless FrameMargins FrameStyle FrameTicks FrameTicksStyle FRatioDistribution FrechetDistribution FreeQ FrequencySamplingFilterKernel FresnelC FresnelS Friday FrobeniusNumber FrobeniusSolve FromCharacterCode FromCoefficientRules FromContinuedFraction FromDate FromDigits FromDMS Front FrontEndDynamicExpression FrontEndEventActions FrontEndExecute FrontEndObject FrontEndResource FrontEndResourceString FrontEndStackSize FrontEndToken FrontEndTokenExecute FrontEndValueCache FrontEndVersion FrontFaceColor FrontFaceOpacity Full FullAxes FullDefinition FullForm FullGraphics FullOptions FullSimplify Function FunctionExpand FunctionInterpolation FunctionSpace FussellVeselyImportance GaborFilter GaborMatrix GaborWavelet GainMargins GainPhaseMargins Gamma GammaDistribution GammaRegularized GapPenalty Gather GatherBy GaugeFaceElementFunction GaugeFaceStyle GaugeFrameElementFunction GaugeFrameSize GaugeFrameStyle GaugeLabels GaugeMarkers GaugeStyle GaussianFilter GaussianIntegers GaussianMatrix GaussianWindow GCD GegenbauerC General GeneralizedLinearModelFit GenerateConditions GeneratedCell GeneratedParameters GeneratingFunction Generic GenericCylindricalDecomposition GenomeData GenomeLookup GeodesicClosing GeodesicDilation GeodesicErosion GeodesicOpening GeoDestination GeodesyData GeoDirection GeoDistance GeoGridPosition GeometricBrownianMotionProcess GeometricDistribution GeometricMean GeometricMeanFilter GeometricTransformation GeometricTransformation3DBox GeometricTransformation3DBoxOptions GeometricTransformationBox GeometricTransformationBoxOptions GeoPosition GeoPositionENU GeoPositionXYZ GeoProjectionData GestureHandler GestureHandlerTag Get GetBoundingBoxSizePacket GetContext GetEnvironment GetFileName GetFrontEndOptionsDataPacket GetLinebreakInformationPacket GetMenusPacket GetPageBreakInformationPacket Glaisher GlobalClusteringCoefficient GlobalPreferences GlobalSession Glow GoldenRatio GompertzMakehamDistribution GoodmanKruskalGamma GoodmanKruskalGammaTest Goto Grad Gradient GradientFilter GradientOrientationFilter Graph GraphAssortativity GraphCenter GraphComplement GraphData GraphDensity GraphDiameter GraphDifference GraphDisjointUnion GraphDistance GraphDistanceMatrix GraphElementData GraphEmbedding GraphHighlight GraphHighlightStyle GraphHub Graphics Graphics3D Graphics3DBox Graphics3DBoxOptions GraphicsArray GraphicsBaseline GraphicsBox GraphicsBoxOptions GraphicsColor GraphicsColumn GraphicsComplex GraphicsComplex3DBox GraphicsComplex3DBoxOptions GraphicsComplexBox GraphicsComplexBoxOptions GraphicsContents GraphicsData GraphicsGrid GraphicsGridBox GraphicsGroup GraphicsGroup3DBox GraphicsGroup3DBoxOptions GraphicsGroupBox GraphicsGroupBoxOptions GraphicsGrouping GraphicsHighlightColor GraphicsRow GraphicsSpacing GraphicsStyle GraphIntersection GraphLayout GraphLinkEfficiency GraphPeriphery GraphPlot GraphPlot3D GraphPower GraphPropertyDistribution GraphQ GraphRadius GraphReciprocity GraphRoot GraphStyle GraphUnion Gray GrayLevel GreatCircleDistance Greater GreaterEqual GreaterEqualLess GreaterFullEqual GreaterGreater GreaterLess GreaterSlantEqual GreaterTilde Green Grid GridBaseline GridBox GridBoxAlignment GridBoxBackground GridBoxDividers GridBoxFrame GridBoxItemSize GridBoxItemStyle GridBoxOptions GridBoxSpacings GridCreationSettings GridDefaultElement GridElementStyleOptions GridFrame GridFrameMargins GridGraph GridLines GridLinesStyle GroebnerBasis GroupActionBase GroupCentralizer GroupElementFromWord GroupElementPosition GroupElementQ GroupElements GroupElementToWord GroupGenerators GroupMultiplicationTable GroupOrbits GroupOrder GroupPageBreakWithin GroupSetwiseStabilizer GroupStabilizer GroupStabilizerChain Gudermannian GumbelDistribution HaarWavelet HadamardMatrix HalfNormalDistribution HamiltonianGraphQ HammingDistance HammingWindow HankelH1 HankelH2 HankelMatrix HannPoissonWindow HannWindow HaradaNortonGroupHN HararyGraph HarmonicMean HarmonicMeanFilter HarmonicNumber Hash HashTable Haversine HazardFunction Head HeadCompose Heads HeavisideLambda HeavisidePi HeavisideTheta HeldGroupHe HeldPart HelpBrowserLookup HelpBrowserNotebook HelpBrowserSettings HermiteDecomposition HermiteH HermitianMatrixQ HessenbergDecomposition Hessian HexadecimalCharacter Hexahedron HexahedronBox HexahedronBoxOptions HiddenSurface HighlightGraph HighlightImage HighpassFilter HigmanSimsGroupHS HilbertFilter HilbertMatrix Histogram Histogram3D HistogramDistribution HistogramList HistogramTransform HistogramTransformInterpolation HitMissTransform HITSCentrality HodgeDual HoeffdingD HoeffdingDTest Hold HoldAll HoldAllComplete HoldComplete HoldFirst HoldForm HoldPattern HoldRest HolidayCalendar HomeDirectory HomePage Horizontal HorizontalForm HorizontalGauge HorizontalScrollPosition HornerForm HotellingTSquareDistribution HoytDistribution HTMLSave Hue HumpDownHump HumpEqual HurwitzLerchPhi HurwitzZeta HyperbolicDistribution HypercubeGraph HyperexponentialDistribution Hyperfactorial Hypergeometric0F1 Hypergeometric0F1Regularized Hypergeometric1F1 Hypergeometric1F1Regularized Hypergeometric2F1 Hypergeometric2F1Regularized HypergeometricDistribution HypergeometricPFQ HypergeometricPFQRegularized HypergeometricU Hyperlink HyperlinkCreationSettings Hyphenation HyphenationOptions HypoexponentialDistribution HypothesisTestData I Identity IdentityMatrix If IgnoreCase Im Image Image3D Image3DSlices ImageAccumulate ImageAdd ImageAdjust ImageAlign ImageApply ImageAspectRatio ImageAssemble ImageCache ImageCacheValid ImageCapture ImageChannels ImageClip ImageColorSpace ImageCompose ImageConvolve ImageCooccurrence ImageCorners ImageCorrelate ImageCorrespondingPoints ImageCrop ImageData ImageDataPacket ImageDeconvolve ImageDemosaic ImageDifference ImageDimensions ImageDistance ImageEffect ImageFeatureTrack ImageFileApply ImageFileFilter ImageFileScan ImageFilter ImageForestingComponents ImageForwardTransformation ImageHistogram ImageKeypoints ImageLevels ImageLines ImageMargins ImageMarkers ImageMeasurements ImageMultiply ImageOffset ImagePad ImagePadding ImagePartition ImagePeriodogram ImagePerspectiveTransformation ImageQ ImageRangeCache ImageReflect ImageRegion ImageResize ImageResolution ImageRotate ImageRotated ImageScaled ImageScan ImageSize ImageSizeAction ImageSizeCache ImageSizeMultipliers ImageSizeRaw ImageSubtract ImageTake ImageTransformation ImageTrim ImageType ImageValue ImageValuePositions Implies Import ImportAutoReplacements ImportString ImprovementImportance In IncidenceGraph IncidenceList IncidenceMatrix IncludeConstantBasis IncludeFileExtension IncludePods IncludeSingularTerm Increment Indent IndentingNewlineSpacings IndentMaxFraction IndependenceTest IndependentEdgeSetQ IndependentUnit IndependentVertexSetQ Indeterminate IndexCreationOptions Indexed IndexGraph IndexTag Inequality InexactNumberQ InexactNumbers Infinity Infix Information Inherited InheritScope Initialization InitializationCell InitializationCellEvaluation InitializationCellWarning InlineCounterAssignments InlineCounterIncrements InlineRules Inner Inpaint Input InputAliases InputAssumptions InputAutoReplacements InputField InputFieldBox InputFieldBoxOptions InputForm InputGrouping InputNamePacket InputNotebook InputPacket InputSettings InputStream InputString InputStringPacket InputToBoxFormPacket Insert InsertionPointObject InsertResults Inset Inset3DBox Inset3DBoxOptions InsetBox InsetBoxOptions Install InstallService InString Integer IntegerDigits IntegerExponent IntegerLength IntegerPart IntegerPartitions IntegerQ Integers IntegerString Integral Integrate Interactive InteractiveTradingChart Interlaced Interleaving InternallyBalancedDecomposition InterpolatingFunction InterpolatingPolynomial Interpolation InterpolationOrder InterpolationPoints InterpolationPrecision Interpretation InterpretationBox InterpretationBoxOptions InterpretationFunction InterpretTemplate InterquartileRange Interrupt InterruptSettings Intersection Interval IntervalIntersection IntervalMemberQ IntervalUnion Inverse InverseBetaRegularized InverseCDF InverseChiSquareDistribution InverseContinuousWaveletTransform InverseDistanceTransform InverseEllipticNomeQ InverseErf InverseErfc InverseFourier InverseFourierCosTransform InverseFourierSequenceTransform InverseFourierSinTransform InverseFourierTransform InverseFunction InverseFunctions InverseGammaDistribution InverseGammaRegularized InverseGaussianDistribution InverseGudermannian InverseHaversine InverseJacobiCD InverseJacobiCN InverseJacobiCS InverseJacobiDC InverseJacobiDN InverseJacobiDS InverseJacobiNC InverseJacobiND InverseJacobiNS InverseJacobiSC InverseJacobiSD InverseJacobiSN InverseLaplaceTransform InversePermutation InverseRadon InverseSeries InverseSurvivalFunction InverseWaveletTransform InverseWeierstrassP InverseZTransform Invisible InvisibleApplication InvisibleTimes IrreduciblePolynomialQ IsolatingInterval IsomorphicGraphQ IsotopeData Italic Item ItemBox ItemBoxOptions ItemSize ItemStyle ItoProcess JaccardDissimilarity JacobiAmplitude Jacobian JacobiCD JacobiCN JacobiCS JacobiDC JacobiDN JacobiDS JacobiNC JacobiND JacobiNS JacobiP JacobiSC JacobiSD JacobiSN JacobiSymbol JacobiZeta JankoGroupJ1 JankoGroupJ2 JankoGroupJ3 JankoGroupJ4 JarqueBeraALMTest JohnsonDistribution Join Joined JoinedCurve JoinedCurveBox JoinForm JordanDecomposition JordanModelDecomposition K KagiChart KaiserBesselWindow KaiserWindow KalmanEstimator KalmanFilter KarhunenLoeveDecomposition KaryTree KatzCentrality KCoreComponents KDistribution KelvinBei KelvinBer KelvinKei KelvinKer KendallTau KendallTauTest KernelExecute KernelMixtureDistribution KernelObject Kernels Ket Khinchin KirchhoffGraph KirchhoffMatrix KleinInvariantJ KnightTourGraph KnotData KnownUnitQ KolmogorovSmirnovTest KroneckerDelta KroneckerModelDecomposition KroneckerProduct KroneckerSymbol KuiperTest KumaraswamyDistribution Kurtosis KuwaharaFilter Label Labeled LabeledSlider LabelingFunction LabelStyle LaguerreL LambdaComponents LambertW LanczosWindow LandauDistribution Language LanguageCategory LaplaceDistribution LaplaceTransform Laplacian LaplacianFilter LaplacianGaussianFilter Large Larger Last Latitude LatitudeLongitude LatticeData LatticeReduce Launch LaunchKernels LayeredGraphPlot LayerSizeFunction LayoutInformation LCM LeafCount LeapYearQ LeastSquares LeastSquaresFilterKernel Left LeftArrow LeftArrowBar LeftArrowRightArrow LeftDownTeeVector LeftDownVector LeftDownVectorBar LeftRightArrow LeftRightVector LeftTee LeftTeeArrow LeftTeeVector LeftTriangle LeftTriangleBar LeftTriangleEqual LeftUpDownVector LeftUpTeeVector LeftUpVector LeftUpVectorBar LeftVector LeftVectorBar LegendAppearance Legended LegendFunction LegendLabel LegendLayout LegendMargins LegendMarkers LegendMarkerSize LegendreP LegendreQ LegendreType Length LengthWhile LerchPhi Less LessEqual LessEqualGreater LessFullEqual LessGreater LessLess LessSlantEqual LessTilde LetterCharacter LetterQ Level LeveneTest LeviCivitaTensor LevyDistribution Lexicographic LibraryFunction LibraryFunctionError LibraryFunctionInformation LibraryFunctionLoad LibraryFunctionUnload LibraryLoad LibraryUnload LicenseID LiftingFilterData LiftingWaveletTransform LightBlue LightBrown LightCyan Lighter LightGray LightGreen Lighting LightingAngle LightMagenta LightOrange LightPink LightPurple LightRed LightSources LightYellow Likelihood Limit LimitsPositioning LimitsPositioningTokens LindleyDistribution Line Line3DBox LinearFilter LinearFractionalTransform LinearModelFit LinearOffsetFunction LinearProgramming LinearRecurrence LinearSolve LinearSolveFunction LineBox LineBreak LinebreakAdjustments LineBreakChart LineBreakWithin LineColor LineForm LineGraph LineIndent LineIndentMaxFraction LineIntegralConvolutionPlot LineIntegralConvolutionScale LineLegend LineOpacity LineSpacing LineWrapParts LinkActivate LinkClose LinkConnect LinkConnectedQ LinkCreate LinkError LinkFlush LinkFunction LinkHost LinkInterrupt LinkLaunch LinkMode LinkObject LinkOpen LinkOptions LinkPatterns LinkProtocol LinkRead LinkReadHeld LinkReadyQ Links LinkWrite LinkWriteHeld LiouvilleLambda List Listable ListAnimate ListContourPlot ListContourPlot3D ListConvolve ListCorrelate ListCurvePathPlot ListDeconvolve ListDensityPlot Listen ListFourierSequenceTransform ListInterpolation ListLineIntegralConvolutionPlot ListLinePlot ListLogLinearPlot ListLogLogPlot ListLogPlot ListPicker ListPickerBox ListPickerBoxBackground ListPickerBoxOptions ListPlay ListPlot ListPlot3D ListPointPlot3D ListPolarPlot ListQ ListStreamDensityPlot ListStreamPlot ListSurfacePlot3D ListVectorDensityPlot ListVectorPlot ListVectorPlot3D ListZTransform Literal LiteralSearch LocalClusteringCoefficient LocalizeVariables LocationEquivalenceTest LocationTest Locator LocatorAutoCreate LocatorBox LocatorBoxOptions LocatorCentering LocatorPane LocatorPaneBox LocatorPaneBoxOptions LocatorRegion Locked Log Log10 Log2 LogBarnesG LogGamma LogGammaDistribution LogicalExpand LogIntegral LogisticDistribution LogitModelFit LogLikelihood LogLinearPlot LogLogisticDistribution LogLogPlot LogMultinormalDistribution LogNormalDistribution LogPlot LogRankTest LogSeriesDistribution LongEqual Longest LongestAscendingSequence LongestCommonSequence LongestCommonSequencePositions LongestCommonSubsequence LongestCommonSubsequencePositions LongestMatch LongForm Longitude LongLeftArrow LongLeftRightArrow LongRightArrow Loopback LoopFreeGraphQ LowerCaseQ LowerLeftArrow LowerRightArrow LowerTriangularize LowpassFilter LQEstimatorGains LQGRegulator LQOutputRegulatorGains LQRegulatorGains LUBackSubstitution LucasL LuccioSamiComponents LUDecomposition LyapunovSolve LyonsGroupLy MachineID MachineName MachineNumberQ MachinePrecision MacintoshSystemPageSetup Magenta Magnification Magnify MainSolve MaintainDynamicCaches Majority MakeBoxes MakeExpression MakeRules MangoldtLambda ManhattanDistance Manipulate Manipulator MannWhitneyTest MantissaExponent Manual Map MapAll MapAt MapIndexed MAProcess MapThread MarcumQ MardiaCombinedTest MardiaKurtosisTest MardiaSkewnessTest MarginalDistribution MarkovProcessProperties Masking MatchingDissimilarity MatchLocalNameQ MatchLocalNames MatchQ Material MathematicaNotation MathieuC MathieuCharacteristicA MathieuCharacteristicB MathieuCharacteristicExponent MathieuCPrime MathieuGroupM11 MathieuGroupM12 MathieuGroupM22 MathieuGroupM23 MathieuGroupM24 MathieuS MathieuSPrime MathMLForm MathMLText Matrices MatrixExp MatrixForm MatrixFunction MatrixLog MatrixPlot MatrixPower MatrixQ MatrixRank Max MaxBend MaxDetect MaxExtraBandwidths MaxExtraConditions MaxFeatures MaxFilter Maximize MaxIterations MaxMemoryUsed MaxMixtureKernels MaxPlotPoints MaxPoints MaxRecursion MaxStableDistribution MaxStepFraction MaxSteps MaxStepSize MaxValue MaxwellDistribution McLaughlinGroupMcL Mean MeanClusteringCoefficient MeanDegreeConnectivity MeanDeviation MeanFilter MeanGraphDistance MeanNeighborDegree MeanShift MeanShiftFilter Median MedianDeviation MedianFilter Medium MeijerG MeixnerDistribution MemberQ MemoryConstrained MemoryInUse Menu MenuAppearance MenuCommandKey MenuEvaluator MenuItem MenuPacket MenuSortingValue MenuStyle MenuView MergeDifferences Mesh MeshFunctions MeshRange MeshShading MeshStyle Message MessageDialog MessageList MessageName MessageOptions MessagePacket Messages MessagesNotebook MetaCharacters MetaInformation Method MethodOptions MexicanHatWavelet MeyerWavelet Min MinDetect MinFilter MinimalPolynomial MinimalStateSpaceModel Minimize Minors MinRecursion MinSize MinStableDistribution Minus MinusPlus MinValue Missing MissingDataMethod MittagLefflerE MixedRadix MixedRadixQuantity MixtureDistribution Mod Modal Mode Modular ModularLambda Module Modulus MoebiusMu Moment Momentary MomentConvert MomentEvaluate MomentGeneratingFunction Monday Monitor MonomialList MonomialOrder MonsterGroupM MorletWavelet MorphologicalBinarize MorphologicalBranchPoints MorphologicalComponents MorphologicalEulerNumber MorphologicalGraph MorphologicalPerimeter MorphologicalTransform Most MouseAnnotation MouseAppearance MouseAppearanceTag MouseButtons Mouseover MousePointerNote MousePosition MovingAverage MovingMedian MoyalDistribution MultiedgeStyle MultilaunchWarning MultiLetterItalics MultiLetterStyle MultilineFunction Multinomial MultinomialDistribution MultinormalDistribution MultiplicativeOrder Multiplicity Multiselection MultivariateHypergeometricDistribution MultivariatePoissonDistribution MultivariateTDistribution N NakagamiDistribution NameQ Names NamespaceBox Nand NArgMax NArgMin NBernoulliB NCache NDSolve NDSolveValue Nearest NearestFunction NeedCurrentFrontEndPackagePacket NeedCurrentFrontEndSymbolsPacket NeedlemanWunschSimilarity Needs Negative NegativeBinomialDistribution NegativeMultinomialDistribution NeighborhoodGraph Nest NestedGreaterGreater NestedLessLess NestedScriptRules NestList NestWhile NestWhileList NevilleThetaC NevilleThetaD NevilleThetaN NevilleThetaS NewPrimitiveStyle NExpectation Next NextPrime NHoldAll NHoldFirst NHoldRest NicholsGridLines NicholsPlot NIntegrate NMaximize NMaxValue NMinimize NMinValue NominalVariables NonAssociative NoncentralBetaDistribution NoncentralChiSquareDistribution NoncentralFRatioDistribution NoncentralStudentTDistribution NonCommutativeMultiply NonConstants None NonlinearModelFit NonlocalMeansFilter NonNegative NonPositive Nor NorlundB Norm Normal NormalDistribution NormalGrouping Normalize NormalizedSquaredEuclideanDistance NormalsFunction NormFunction Not NotCongruent NotCupCap NotDoubleVerticalBar Notebook NotebookApply NotebookAutoSave NotebookClose NotebookConvertSettings NotebookCreate NotebookCreateReturnObject NotebookDefault NotebookDelete NotebookDirectory NotebookDynamicExpression NotebookEvaluate NotebookEventActions NotebookFileName NotebookFind NotebookFindReturnObject NotebookGet NotebookGetLayoutInformationPacket NotebookGetMisspellingsPacket NotebookInformation NotebookInterfaceObject NotebookLocate NotebookObject NotebookOpen NotebookOpenReturnObject NotebookPath NotebookPrint NotebookPut NotebookPutReturnObject NotebookRead NotebookResetGeneratedCells Notebooks NotebookSave NotebookSaveAs NotebookSelection NotebookSetupLayoutInformationPacket NotebooksMenu NotebookWrite NotElement NotEqualTilde NotExists NotGreater NotGreaterEqual NotGreaterFullEqual NotGreaterGreater NotGreaterLess NotGreaterSlantEqual NotGreaterTilde NotHumpDownHump NotHumpEqual NotLeftTriangle NotLeftTriangleBar NotLeftTriangleEqual NotLess NotLessEqual NotLessFullEqual NotLessGreater NotLessLess NotLessSlantEqual NotLessTilde NotNestedGreaterGreater NotNestedLessLess NotPrecedes NotPrecedesEqual NotPrecedesSlantEqual NotPrecedesTilde NotReverseElement NotRightTriangle NotRightTriangleBar NotRightTriangleEqual NotSquareSubset NotSquareSubsetEqual NotSquareSuperset NotSquareSupersetEqual NotSubset NotSubsetEqual NotSucceeds NotSucceedsEqual NotSucceedsSlantEqual NotSucceedsTilde NotSuperset NotSupersetEqual NotTilde NotTildeEqual NotTildeFullEqual NotTildeTilde NotVerticalBar NProbability NProduct NProductFactors NRoots NSolve NSum NSumTerms Null NullRecords NullSpace NullWords Number NumberFieldClassNumber NumberFieldDiscriminant NumberFieldFundamentalUnits NumberFieldIntegralBasis NumberFieldNormRepresentatives NumberFieldRegulator NumberFieldRootsOfUnity NumberFieldSignature NumberForm NumberFormat NumberMarks NumberMultiplier NumberPadding NumberPoint NumberQ NumberSeparator NumberSigns NumberString Numerator NumericFunction NumericQ NuttallWindow NValues NyquistGridLines NyquistPlot O ObservabilityGramian ObservabilityMatrix ObservableDecomposition ObservableModelQ OddQ Off Offset OLEData On ONanGroupON OneIdentity Opacity Open OpenAppend Opener OpenerBox OpenerBoxOptions OpenerView OpenFunctionInspectorPacket Opening OpenRead OpenSpecialOptions OpenTemporary OpenWrite Operate OperatingSystem OptimumFlowData Optional OptionInspectorSettings OptionQ Options OptionsPacket OptionsPattern OptionValue OptionValueBox OptionValueBoxOptions Or Orange Order OrderDistribution OrderedQ Ordering Orderless OrnsteinUhlenbeckProcess Orthogonalize Out Outer OutputAutoOverwrite OutputControllabilityMatrix OutputControllableModelQ OutputForm OutputFormData OutputGrouping OutputMathEditExpression OutputNamePacket OutputResponse OutputSizeLimit OutputStream Over OverBar OverDot Overflow OverHat Overlaps Overlay OverlayBox OverlayBoxOptions Overscript OverscriptBox OverscriptBoxOptions OverTilde OverVector OwenT OwnValues PackingMethod PaddedForm Padding PadeApproximant PadLeft PadRight PageBreakAbove PageBreakBelow PageBreakWithin PageFooterLines PageFooters PageHeaderLines PageHeaders PageHeight PageRankCentrality PageWidth PairedBarChart PairedHistogram PairedSmoothHistogram PairedTTest PairedZTest PaletteNotebook PalettePath Pane PaneBox PaneBoxOptions Panel PanelBox PanelBoxOptions Paneled PaneSelector PaneSelectorBox PaneSelectorBoxOptions PaperWidth ParabolicCylinderD ParagraphIndent ParagraphSpacing ParallelArray ParallelCombine ParallelDo ParallelEvaluate Parallelization Parallelize ParallelMap ParallelNeeds ParallelProduct ParallelSubmit ParallelSum ParallelTable ParallelTry Parameter ParameterEstimator ParameterMixtureDistribution ParameterVariables ParametricFunction ParametricNDSolve ParametricNDSolveValue ParametricPlot ParametricPlot3D ParentConnect ParentDirectory ParentForm Parenthesize ParentList ParetoDistribution Part PartialCorrelationFunction PartialD ParticleData Partition PartitionsP PartitionsQ ParzenWindow PascalDistribution PassEventsDown PassEventsUp Paste PasteBoxFormInlineCells PasteButton Path PathGraph PathGraphQ Pattern PatternSequence PatternTest PauliMatrix PaulWavelet Pause PausedTime PDF PearsonChiSquareTest PearsonCorrelationTest PearsonDistribution PerformanceGoal PeriodicInterpolation Periodogram PeriodogramArray PermutationCycles PermutationCyclesQ PermutationGroup PermutationLength PermutationList PermutationListQ PermutationMax PermutationMin PermutationOrder PermutationPower PermutationProduct PermutationReplace Permutations PermutationSupport Permute PeronaMalikFilter Perpendicular PERTDistribution PetersenGraph PhaseMargins Pi Pick PIDData PIDDerivativeFilter PIDFeedforward PIDTune Piecewise PiecewiseExpand PieChart PieChart3D PillaiTrace PillaiTraceTest Pink Pivoting PixelConstrained PixelValue PixelValuePositions Placed Placeholder PlaceholderReplace Plain PlanarGraphQ Play PlayRange Plot Plot3D Plot3Matrix PlotDivision PlotJoined PlotLabel PlotLayout PlotLegends PlotMarkers PlotPoints PlotRange PlotRangeClipping PlotRangePadding PlotRegion PlotStyle Plus PlusMinus Pochhammer PodStates PodWidth Point Point3DBox PointBox PointFigureChart PointForm PointLegend PointSize PoissonConsulDistribution PoissonDistribution PoissonProcess PoissonWindow PolarAxes PolarAxesOrigin PolarGridLines PolarPlot PolarTicks PoleZeroMarkers PolyaAeppliDistribution PolyGamma Polygon Polygon3DBox Polygon3DBoxOptions PolygonBox PolygonBoxOptions PolygonHoleScale PolygonIntersections PolygonScale PolyhedronData PolyLog PolynomialExtendedGCD PolynomialForm PolynomialGCD PolynomialLCM PolynomialMod PolynomialQ PolynomialQuotient PolynomialQuotientRemainder PolynomialReduce PolynomialRemainder Polynomials PopupMenu PopupMenuBox PopupMenuBoxOptions PopupView PopupWindow Position Positive PositiveDefiniteMatrixQ PossibleZeroQ Postfix PostScript Power PowerDistribution PowerExpand PowerMod PowerModList PowerSpectralDensity PowersRepresentations PowerSymmetricPolynomial Precedence PrecedenceForm Precedes PrecedesEqual PrecedesSlantEqual PrecedesTilde Precision PrecisionGoal PreDecrement PredictionRoot PreemptProtect PreferencesPath Prefix PreIncrement Prepend PrependTo PreserveImageOptions Previous PriceGraphDistribution PrimaryPlaceholder Prime PrimeNu PrimeOmega PrimePi PrimePowerQ PrimeQ Primes PrimeZetaP PrimitiveRoot PrincipalComponents PrincipalValue Print PrintAction PrintForm PrintingCopies PrintingOptions PrintingPageRange PrintingStartingPageNumber PrintingStyleEnvironment PrintPrecision PrintTemporary Prism PrismBox PrismBoxOptions PrivateCellOptions PrivateEvaluationOptions PrivateFontOptions PrivateFrontEndOptions PrivateNotebookOptions PrivatePaths Probability ProbabilityDistribution ProbabilityPlot ProbabilityPr ProbabilityScalePlot ProbitModelFit ProcessEstimator ProcessParameterAssumptions ProcessParameterQ ProcessStateDomain ProcessTimeDomain Product ProductDistribution ProductLog ProgressIndicator ProgressIndicatorBox ProgressIndicatorBoxOptions Projection Prolog PromptForm Properties Property PropertyList PropertyValue Proportion Proportional Protect Protected ProteinData Pruning PseudoInverse Purple Put PutAppend Pyramid PyramidBox PyramidBoxOptions QBinomial QFactorial QGamma QHypergeometricPFQ QPochhammer QPolyGamma QRDecomposition QuadraticIrrationalQ Quantile QuantilePlot Quantity QuantityForm QuantityMagnitude QuantityQ QuantityUnit Quartics QuartileDeviation Quartiles QuartileSkewness QueueingNetworkProcess QueueingProcess QueueProperties Quiet Quit Quotient QuotientRemainder RadialityCentrality RadicalBox RadicalBoxOptions RadioButton RadioButtonBar RadioButtonBox RadioButtonBoxOptions Radon RamanujanTau RamanujanTauL RamanujanTauTheta RamanujanTauZ Random RandomChoice RandomComplex RandomFunction RandomGraph RandomImage RandomInteger RandomPermutation RandomPrime RandomReal RandomSample RandomSeed RandomVariate RandomWalkProcess Range RangeFilter RangeSpecification RankedMax RankedMin Raster Raster3D Raster3DBox Raster3DBoxOptions RasterArray RasterBox RasterBoxOptions Rasterize RasterSize Rational RationalFunctions Rationalize Rationals Ratios Raw RawArray RawBoxes RawData RawMedium RayleighDistribution Re Read ReadList ReadProtected Real RealBlockDiagonalForm RealDigits RealExponent Reals Reap Record RecordLists RecordSeparators Rectangle RectangleBox RectangleBoxOptions RectangleChart RectangleChart3D RecurrenceFilter RecurrenceTable RecurringDigitsForm Red Reduce RefBox ReferenceLineStyle ReferenceMarkers ReferenceMarkerStyle Refine ReflectionMatrix ReflectionTransform Refresh RefreshRate RegionBinarize RegionFunction RegionPlot RegionPlot3D RegularExpression Regularization Reinstall Release ReleaseHold ReliabilityDistribution ReliefImage ReliefPlot Remove RemoveAlphaChannel RemoveAsynchronousTask Removed RemoveInputStreamMethod RemoveOutputStreamMethod RemoveProperty RemoveScheduledTask RenameDirectory RenameFile RenderAll RenderingOptions RenewalProcess RenkoChart Repeated RepeatedNull RepeatedString Replace ReplaceAll ReplaceHeldPart ReplaceImageValue ReplaceList ReplacePart ReplacePixelValue ReplaceRepeated Resampling Rescale RescalingTransform ResetDirectory ResetMenusPacket ResetScheduledTask Residue Resolve Rest Resultant ResumePacket Return ReturnExpressionPacket ReturnInputFormPacket ReturnPacket ReturnTextPacket Reverse ReverseBiorthogonalSplineWavelet ReverseElement ReverseEquilibrium ReverseGraph ReverseUpEquilibrium RevolutionAxis RevolutionPlot3D RGBColor RiccatiSolve RiceDistribution RidgeFilter RiemannR RiemannSiegelTheta RiemannSiegelZ Riffle Right RightArrow RightArrowBar RightArrowLeftArrow RightCosetRepresentative RightDownTeeVector RightDownVector RightDownVectorBar RightTee RightTeeArrow RightTeeVector RightTriangle RightTriangleBar RightTriangleEqual RightUpDownVector RightUpTeeVector RightUpVector RightUpVectorBar RightVector RightVectorBar RiskAchievementImportance RiskReductionImportance RogersTanimotoDissimilarity Root RootApproximant RootIntervals RootLocusPlot RootMeanSquare RootOfUnityQ RootReduce Roots RootSum Rotate RotateLabel RotateLeft RotateRight RotationAction RotationBox RotationBoxOptions RotationMatrix RotationTransform Round RoundImplies RoundingRadius Row RowAlignments RowBackgrounds RowBox RowHeights RowLines RowMinHeight RowReduce RowsEqual RowSpacings RSolve RudvalisGroupRu Rule RuleCondition RuleDelayed RuleForm RulerUnits Run RunScheduledTask RunThrough RuntimeAttributes RuntimeOptions RussellRaoDissimilarity SameQ SameTest SampleDepth SampledSoundFunction SampledSoundList SampleRate SamplingPeriod SARIMAProcess SARMAProcess SatisfiabilityCount SatisfiabilityInstances SatisfiableQ Saturday Save Saveable SaveAutoDelete SaveDefinitions SawtoothWave Scale Scaled ScaleDivisions ScaledMousePosition ScaleOrigin ScalePadding ScaleRanges ScaleRangeStyle ScalingFunctions ScalingMatrix ScalingTransform Scan ScheduledTaskActiveQ ScheduledTaskData ScheduledTaskObject ScheduledTasks SchurDecomposition ScientificForm ScreenRectangle ScreenStyleEnvironment ScriptBaselineShifts ScriptLevel ScriptMinSize ScriptRules ScriptSizeMultipliers Scrollbars ScrollingOptions ScrollPosition Sec Sech SechDistribution SectionGrouping SectorChart SectorChart3D SectorOrigin SectorSpacing SeedRandom Select Selectable SelectComponents SelectedCells SelectedNotebook Selection SelectionAnimate SelectionCell SelectionCellCreateCell SelectionCellDefaultStyle SelectionCellParentStyle SelectionCreateCell SelectionDebuggerTag SelectionDuplicateCell SelectionEvaluate SelectionEvaluateCreateCell SelectionMove SelectionPlaceholder SelectionSetStyle SelectWithContents SelfLoops SelfLoopStyle SemialgebraicComponentInstances SendMail Sequence SequenceAlignment SequenceForm SequenceHold SequenceLimit Series SeriesCoefficient SeriesData SessionTime Set SetAccuracy SetAlphaChannel SetAttributes Setbacks SetBoxFormNamesPacket SetDelayed SetDirectory SetEnvironment SetEvaluationNotebook SetFileDate SetFileLoadingContext SetNotebookStatusLine SetOptions SetOptionsPacket SetPrecision SetProperty SetSelectedNotebook SetSharedFunction SetSharedVariable SetSpeechParametersPacket SetStreamPosition SetSystemOptions Setter SetterBar SetterBox SetterBoxOptions Setting SetValue Shading Shallow ShannonWavelet ShapiroWilkTest Share Sharpen ShearingMatrix ShearingTransform ShenCastanMatrix Short ShortDownArrow Shortest ShortestMatch ShortestPathFunction ShortLeftArrow ShortRightArrow ShortUpArrow Show ShowAutoStyles ShowCellBracket ShowCellLabel ShowCellTags ShowClosedCellArea ShowContents ShowControls ShowCursorTracker ShowGroupOpenCloseIcon ShowGroupOpener ShowInvisibleCharacters ShowPageBreaks ShowPredictiveInterface ShowSelection ShowShortBoxForm ShowSpecialCharacters ShowStringCharacters ShowSyntaxStyles ShrinkingDelay ShrinkWrapBoundingBox SiegelTheta SiegelTukeyTest Sign Signature SignedRankTest SignificanceLevel SignPadding SignTest SimilarityRules SimpleGraph SimpleGraphQ Simplify Sin Sinc SinghMaddalaDistribution SingleEvaluation SingleLetterItalics SingleLetterStyle SingularValueDecomposition SingularValueList SingularValuePlot SingularValues Sinh SinhIntegral SinIntegral SixJSymbol Skeleton SkeletonTransform SkellamDistribution Skewness SkewNormalDistribution Skip SliceDistribution Slider Slider2D Slider2DBox Slider2DBoxOptions SliderBox SliderBoxOptions SlideView Slot SlotSequence Small SmallCircle Smaller SmithDelayCompensator SmithWatermanSimilarity SmoothDensityHistogram SmoothHistogram SmoothHistogram3D SmoothKernelDistribution SocialMediaData Socket SokalSneathDissimilarity Solve SolveAlways SolveDelayed Sort SortBy Sound SoundAndGraphics SoundNote SoundVolume Sow Space SpaceForm Spacer Spacings Span SpanAdjustments SpanCharacterRounding SpanFromAbove SpanFromBoth SpanFromLeft SpanLineThickness SpanMaxSize SpanMinSize SpanningCharacters SpanSymmetric SparseArray SpatialGraphDistribution Speak SpeakTextPacket SpearmanRankTest SpearmanRho Spectrogram SpectrogramArray Specularity SpellingCorrection SpellingDictionaries SpellingDictionariesPath SpellingOptions SpellingSuggestionsPacket Sphere SphereBox SphericalBesselJ SphericalBesselY SphericalHankelH1 SphericalHankelH2 SphericalHarmonicY SphericalPlot3D SphericalRegion SpheroidalEigenvalue SpheroidalJoiningFactor SpheroidalPS SpheroidalPSPrime SpheroidalQS SpheroidalQSPrime SpheroidalRadialFactor SpheroidalS1 SpheroidalS1Prime SpheroidalS2 SpheroidalS2Prime Splice SplicedDistribution SplineClosed SplineDegree SplineKnots SplineWeights Split SplitBy SpokenString Sqrt SqrtBox SqrtBoxOptions Square SquaredEuclideanDistance SquareFreeQ SquareIntersection SquaresR SquareSubset SquareSubsetEqual SquareSuperset SquareSupersetEqual SquareUnion SquareWave StabilityMargins StabilityMarginsStyle StableDistribution Stack StackBegin StackComplete StackInhibit StandardDeviation StandardDeviationFilter StandardForm Standardize StandbyDistribution Star StarGraph StartAsynchronousTask StartingStepSize StartOfLine StartOfString StartScheduledTask StartupSound StateDimensions StateFeedbackGains StateOutputEstimator StateResponse StateSpaceModel StateSpaceRealization StateSpaceTransform StationaryDistribution StationaryWaveletPacketTransform StationaryWaveletTransform StatusArea StatusCentrality StepMonitor StieltjesGamma StirlingS1 StirlingS2 StopAsynchronousTask StopScheduledTask StrataVariables StratonovichProcess StreamColorFunction StreamColorFunctionScaling StreamDensityPlot StreamPlot StreamPoints StreamPosition Streams StreamScale StreamStyle String StringBreak StringByteCount StringCases StringCount StringDrop StringExpression StringForm StringFormat StringFreeQ StringInsert StringJoin StringLength StringMatchQ StringPosition StringQ StringReplace StringReplaceList StringReplacePart StringReverse StringRotateLeft StringRotateRight StringSkeleton StringSplit StringTake StringToStream StringTrim StripBoxes StripOnInput StripWrapperBoxes StrokeForm StructuralImportance StructuredArray StructuredSelection StruveH StruveL Stub StudentTDistribution Style StyleBox StyleBoxAutoDelete StyleBoxOptions StyleData StyleDefinitions StyleForm StyleKeyMapping StyleMenuListing StyleNameDialogSettings StyleNames StylePrint StyleSheetPath Subfactorial Subgraph SubMinus SubPlus SubresultantPolynomialRemainders SubresultantPolynomials Subresultants Subscript SubscriptBox SubscriptBoxOptions Subscripted Subset SubsetEqual Subsets SubStar Subsuperscript SubsuperscriptBox SubsuperscriptBoxOptions Subtract SubtractFrom SubValues Succeeds SucceedsEqual SucceedsSlantEqual SucceedsTilde SuchThat Sum SumConvergence Sunday SuperDagger SuperMinus SuperPlus Superscript SuperscriptBox SuperscriptBoxOptions Superset SupersetEqual SuperStar Surd SurdForm SurfaceColor SurfaceGraphics SurvivalDistribution SurvivalFunction SurvivalModel SurvivalModelFit SuspendPacket SuzukiDistribution SuzukiGroupSuz SwatchLegend Switch Symbol SymbolName SymletWavelet Symmetric SymmetricGroup SymmetricMatrixQ SymmetricPolynomial SymmetricReduction Symmetrize SymmetrizedArray SymmetrizedArrayRules SymmetrizedDependentComponents SymmetrizedIndependentComponents SymmetrizedReplacePart SynchronousInitialization SynchronousUpdating Syntax SyntaxForm SyntaxInformation SyntaxLength SyntaxPacket SyntaxQ SystemDialogInput SystemException SystemHelpPath SystemInformation SystemInformationData SystemOpen SystemOptions SystemsModelDelay SystemsModelDelayApproximate SystemsModelDelete SystemsModelDimensions SystemsModelExtract SystemsModelFeedbackConnect SystemsModelLabels SystemsModelOrder SystemsModelParallelConnect SystemsModelSeriesConnect SystemsModelStateFeedbackConnect SystemStub Tab TabFilling Table TableAlignments TableDepth TableDirections TableForm TableHeadings TableSpacing TableView TableViewBox TabSpacings TabView TabViewBox TabViewBoxOptions TagBox TagBoxNote TagBoxOptions TaggingRules TagSet TagSetDelayed TagStyle TagUnset Take TakeWhile Tally Tan Tanh TargetFunctions TargetUnits TautologyQ TelegraphProcess TemplateBox TemplateBoxOptions TemplateSlotSequence TemporalData Temporary TemporaryVariable TensorContract TensorDimensions TensorExpand TensorProduct TensorQ TensorRank TensorReduce TensorSymmetry TensorTranspose TensorWedge Tetrahedron TetrahedronBox TetrahedronBoxOptions TeXForm TeXSave Text Text3DBox Text3DBoxOptions TextAlignment TextBand TextBoundingBox TextBox TextCell TextClipboardType TextData TextForm TextJustification TextLine TextPacket TextParagraph TextRecognize TextRendering TextStyle Texture TextureCoordinateFunction TextureCoordinateScaling Therefore ThermometerGauge Thick Thickness Thin Thinning ThisLink ThompsonGroupTh Thread ThreeJSymbol Threshold Through Throw Thumbnail Thursday Ticks TicksStyle Tilde TildeEqual TildeFullEqual TildeTilde TimeConstrained TimeConstraint Times TimesBy TimeSeriesForecast TimeSeriesInvertibility TimeUsed TimeValue TimeZone Timing Tiny TitleGrouping TitsGroupT ToBoxes ToCharacterCode ToColor ToContinuousTimeModel ToDate ToDiscreteTimeModel ToeplitzMatrix ToExpression ToFileName Together Toggle ToggleFalse Toggler TogglerBar TogglerBox TogglerBoxOptions ToHeldExpression ToInvertibleTimeSeries TokenWords Tolerance ToLowerCase ToNumberField TooBig Tooltip TooltipBox TooltipBoxOptions TooltipDelay TooltipStyle Top TopHatTransform TopologicalSort ToRadicals ToRules ToString Total TotalHeight TotalVariationFilter TotalWidth TouchscreenAutoZoom TouchscreenControlPlacement ToUpperCase Tr Trace TraceAbove TraceAction TraceBackward TraceDepth TraceDialog TraceForward TraceInternal TraceLevel TraceOff TraceOn TraceOriginal TracePrint TraceScan TrackedSymbols TradingChart TraditionalForm TraditionalFunctionNotation TraditionalNotation TraditionalOrder TransferFunctionCancel TransferFunctionExpand TransferFunctionFactor TransferFunctionModel TransferFunctionPoles TransferFunctionTransform TransferFunctionZeros TransformationFunction TransformationFunctions TransformationMatrix TransformedDistribution TransformedField Translate TranslationTransform TransparentColor Transpose TreeForm TreeGraph TreeGraphQ TreePlot TrendStyle TriangleWave TriangularDistribution Trig TrigExpand TrigFactor TrigFactorList Trigger TrigReduce TrigToExp TrimmedMean True TrueQ TruncatedDistribution TsallisQExponentialDistribution TsallisQGaussianDistribution TTest Tube TubeBezierCurveBox TubeBezierCurveBoxOptions TubeBox TubeBSplineCurveBox TubeBSplineCurveBoxOptions Tuesday TukeyLambdaDistribution TukeyWindow Tuples TuranGraph TuringMachine Transparent UnateQ Uncompress Undefined UnderBar Underflow Underlined Underoverscript UnderoverscriptBox UnderoverscriptBoxOptions Underscript UnderscriptBox UnderscriptBoxOptions UndirectedEdge UndirectedGraph UndirectedGraphQ UndocumentedTestFEParserPacket UndocumentedTestGetSelectionPacket Unequal Unevaluated UniformDistribution UniformGraphDistribution UniformSumDistribution Uninstall Union UnionPlus Unique UnitBox UnitConvert UnitDimensions Unitize UnitRootTest UnitSimplify UnitStep UnitTriangle UnitVector Unprotect UnsameQ UnsavedVariables Unset UnsetShared UntrackedVariables Up UpArrow UpArrowBar UpArrowDownArrow Update UpdateDynamicObjects UpdateDynamicObjectsSynchronous UpdateInterval UpDownArrow UpEquilibrium UpperCaseQ UpperLeftArrow UpperRightArrow UpperTriangularize Upsample UpSet UpSetDelayed UpTee UpTeeArrow UpValues URL URLFetch URLFetchAsynchronous URLSave URLSaveAsynchronous UseGraphicsRange Using UsingFrontEnd V2Get ValidationLength Value ValueBox ValueBoxOptions ValueForm ValueQ ValuesData Variables Variance VarianceEquivalenceTest VarianceEstimatorFunction VarianceGammaDistribution VarianceTest VectorAngle VectorColorFunction VectorColorFunctionScaling VectorDensityPlot VectorGlyphData VectorPlot VectorPlot3D VectorPoints VectorQ Vectors VectorScale VectorStyle Vee Verbatim Verbose VerboseConvertToPostScriptPacket VerifyConvergence VerifySolutions VerifyTestAssumptions Version VersionNumber VertexAdd VertexCapacity VertexColors VertexComponent VertexConnectivity VertexCoordinateRules VertexCoordinates VertexCorrelationSimilarity VertexCosineSimilarity VertexCount VertexCoverQ VertexDataCoordinates VertexDegree VertexDelete VertexDiceSimilarity VertexEccentricity VertexInComponent VertexInDegree VertexIndex VertexJaccardSimilarity VertexLabeling VertexLabels VertexLabelStyle VertexList VertexNormals VertexOutComponent VertexOutDegree VertexQ VertexRenderingFunction VertexReplace VertexShape VertexShapeFunction VertexSize VertexStyle VertexTextureCoordinates VertexWeight Vertical VerticalBar VerticalForm VerticalGauge VerticalSeparator VerticalSlider VerticalTilde ViewAngle ViewCenter ViewMatrix ViewPoint ViewPointSelectorSettings ViewPort ViewRange ViewVector ViewVertical VirtualGroupData Visible VisibleCell VoigtDistribution VonMisesDistribution WaitAll WaitAsynchronousTask WaitNext WaitUntil WakebyDistribution WalleniusHypergeometricDistribution WaringYuleDistribution WatershedComponents WatsonUSquareTest WattsStrogatzGraphDistribution WaveletBestBasis WaveletFilterCoefficients WaveletImagePlot WaveletListPlot WaveletMapIndexed WaveletMatrixPlot WaveletPhi WaveletPsi WaveletScale WaveletScalogram WaveletThreshold WeaklyConnectedComponents WeaklyConnectedGraphQ WeakStationarity WeatherData WeberE Wedge Wednesday WeibullDistribution WeierstrassHalfPeriods WeierstrassInvariants WeierstrassP WeierstrassPPrime WeierstrassSigma WeierstrassZeta WeightedAdjacencyGraph WeightedAdjacencyMatrix WeightedData WeightedGraphQ Weights WelchWindow WheelGraph WhenEvent Which While White Whitespace WhitespaceCharacter WhittakerM WhittakerW WienerFilter WienerProcess WignerD WignerSemicircleDistribution WilksW WilksWTest WindowClickSelect WindowElements WindowFloating WindowFrame WindowFrameElements WindowMargins WindowMovable WindowOpacity WindowSelected WindowSize WindowStatusArea WindowTitle WindowToolbars WindowWidth With WolframAlpha WolframAlphaDate WolframAlphaQuantity WolframAlphaResult Word WordBoundary WordCharacter WordData WordSearch WordSeparators WorkingPrecision Write WriteString Wronskian XMLElement XMLObject Xnor Xor Yellow YuleDissimilarity ZernikeR ZeroSymmetric ZeroTest ZeroWidthTimes Zeta ZetaZero ZipfDistribution ZTest ZTransform $Aborted $ActivationGroupID $ActivationKey $ActivationUserRegistered $AddOnsDirectory $AssertFunction $Assumptions $AsynchronousTask $BaseDirectory $BatchInput $BatchOutput $BoxForms $ByteOrdering $Canceled $CharacterEncoding $CharacterEncodings $CommandLine $CompilationTarget $ConditionHold $ConfiguredKernels $Context $ContextPath $ControlActiveSetting $CreationDate $CurrentLink $DateStringFormat $DefaultFont $DefaultFrontEnd $DefaultImagingDevice $DefaultPath $Display $DisplayFunction $DistributedContexts $DynamicEvaluation $Echo $Epilog $ExportFormats $Failed $FinancialDataSource $FormatType $FrontEnd $FrontEndSession $GeoLocation $HistoryLength $HomeDirectory $HTTPCookies $IgnoreEOF $ImagingDevices $ImportFormats $InitialDirectory $Input $InputFileName $InputStreamMethods $Inspector $InstallationDate $InstallationDirectory $InterfaceEnvironment $IterationLimit $KernelCount $KernelID $Language $LaunchDirectory $LibraryPath $LicenseExpirationDate $LicenseID $LicenseProcesses $LicenseServer $LicenseSubprocesses $LicenseType $Line $Linked $LinkSupported $LoadedFiles $MachineAddresses $MachineDomain $MachineDomains $MachineEpsilon $MachineID $MachineName $MachinePrecision $MachineType $MaxExtraPrecision $MaxLicenseProcesses $MaxLicenseSubprocesses $MaxMachineNumber $MaxNumber $MaxPiecewiseCases $MaxPrecision $MaxRootDegree $MessageGroups $MessageList $MessagePrePrint $Messages $MinMachineNumber $MinNumber $MinorReleaseNumber $MinPrecision $ModuleNumber $NetworkLicense $NewMessage $NewSymbol $Notebooks $NumberMarks $Off $OperatingSystem $Output $OutputForms $OutputSizeLimit $OutputStreamMethods $Packages $ParentLink $ParentProcessID $PasswordFile $PatchLevelID $Path $PathnameSeparator $PerformanceGoal $PipeSupported $Post $Pre $PreferencesDirectory $PrePrint $PreRead $PrintForms $PrintLiteral $ProcessID $ProcessorCount $ProcessorType $ProductInformation $ProgramName $RandomState $RecursionLimit $ReleaseNumber $RootDirectory $ScheduledTask $ScriptCommandLine $SessionID $SetParentLink $SharedFunctions $SharedVariables $SoundDisplay $SoundDisplayFunction $SuppressInputFormHeads $SynchronousEvaluation $SyntaxHandler $System $SystemCharacterEncoding $SystemID $SystemWordLength $TemporaryDirectory $TemporaryPrefix $TextStyle $TimedOut $TimeUnit $TimeZone $TopDirectory $TraceOff $TraceOn $TracePattern $TracePostAction $TracePreAction $Urgent $UserAddOnsDirectory $UserBaseDirectory $UserDocumentsDirectory $UserName $Version $VersionNumber", | ||
| 2 | c:[{cN:"comment",b:/\(\*/,e:/\*\)/},e.ASM,e.QSM,e.CNM,{cN:"list",b:/\{/,e:/\}/,i:/:/}]}});hljs.registerLanguage("fsharp",function(e){var t={b:"<",e:">",c:[e.inherit(e.TM,{b:/'[a-zA-Z0-9_]+/})]};return{aliases:["fs"],k:"yield! return! let! do!abstract and as assert base begin class default delegate do done downcast downto elif else end exception extern false finally for fun function global if in inherit inline interface internal lazy let match member module mutable namespace new null of open or override private public rec return sig static struct then to true try type upcast use val void when while with yield",c:[{cN:"string",b:'@"',e:'"',c:[{b:'""'}]},{cN:"string",b:'"""',e:'"""'},e.C("\\(\\*","\\*\\)"),{cN:"class",bK:"type",e:"\\(|=|$",eE:!0,c:[e.UTM,t]},{cN:"annotation",b:"\\[<",e:">\\]",r:10},{cN:"attribute",b:"\\B('[A-Za-z])\\b",c:[e.BE]},e.CLCM,e.inherit(e.QSM,{i:null}),e.CNM]}});hljs.registerLanguage("verilog",function(e){return{aliases:["v"],cI:!0,k:{keyword:"always and assign begin buf bufif0 bufif1 case casex casez cmos deassign default defparam disable edge else end endcase endfunction endmodule endprimitive endspecify endtable endtask event for force forever fork function if ifnone initial inout input join macromodule module nand negedge nmos nor not notif0 notif1 or output parameter pmos posedge primitive pulldown pullup rcmos release repeat rnmos rpmos rtran rtranif0 rtranif1 specify specparam table task timescale tran tranif0 tranif1 wait while xnor xor",typename:"highz0 highz1 integer large medium pull0 pull1 real realtime reg scalared signed small strong0 strong1 supply0 supply0 supply1 supply1 time tri tri0 tri1 triand trior trireg vectored wand weak0 weak1 wire wor"},c:[e.CBCM,e.CLCM,e.QSM,{cN:"number",b:"\\b(\\d+'(b|h|o|d|B|H|O|D))?[0-9xzXZ]+",c:[e.BE],r:0},{cN:"typename",b:"\\.\\w+",r:0},{cN:"value",b:"#\\((?!parameter).+\\)"},{cN:"keyword",b:"\\+|-|\\*|/|%|<|>|=|#|`|\\!|&|\\||@|:|\\^|~|\\{|\\}",r:0}]}});hljs.registerLanguage("dos",function(e){var r=e.C(/@?rem\b/,/$/,{r:10}),t={cN:"label",b:"^\\s*[A-Za-z._?][A-Za-z0-9_$#@~.?]*(:|\\s+label)",r:0};return{aliases:["bat","cmd"],cI:!0,k:{flow:"if else goto for in do call exit not exist errorlevel defined",operator:"equ neq lss leq gtr geq",keyword:"shift cd dir echo setlocal endlocal set pause copy",stream:"prn nul lpt3 lpt2 lpt1 con com4 com3 com2 com1 aux",winutils:"ping net ipconfig taskkill xcopy ren del",built_in:"append assoc at attrib break cacls cd chcp chdir chkdsk chkntfs cls cmd color comp compact convert date dir diskcomp diskcopy doskey erase fs find findstr format ftype graftabl help keyb label md mkdir mode more move path pause print popd pushd promt rd recover rem rename replace restore rmdir shiftsort start subst time title tree type ver verify vol"},c:[{cN:"envvar",b:/%%[^ ]|%[^ ]+?%|![^ ]+?!/},{cN:"function",b:t.b,e:"goto:eof",c:[e.inherit(e.TM,{b:"([_a-zA-Z]\\w*\\.)*([_a-zA-Z]\\w*:)?[_a-zA-Z]\\w*"}),r]},{cN:"number",b:"\\b\\d+",r:0},r]}});hljs.registerLanguage("gherkin",function(e){return{aliases:["feature"],k:"Feature Background Ability Business Need Scenario Scenarios Scenario Outline Scenario Template Examples Given And Then But When",c:[{cN:"keyword",b:"\\*"},e.C("@[^@\r\n ]+","$"),{cN:"string",b:"\\|",e:"\\$"},{cN:"variable",b:"<",e:">"},e.HCM,{cN:"string",b:'"""',e:'"""'},e.QSM]}});hljs.registerLanguage("xml",function(t){var e="[A-Za-z0-9\\._:-]+",s={b:/<\?(php)?(?!\w)/,e:/\?>/,sL:"php",subLanguageMode:"continuous"},c={eW:!0,i:/</,r:0,c:[s,{cN:"attribute",b:e,r:0},{b:"=",r:0,c:[{cN:"value",c:[s],v:[{b:/"/,e:/"/},{b:/'/,e:/'/},{b:/[^\s\/>]+/}]}]}]};return{aliases:["html","xhtml","rss","atom","xsl","plist"],cI:!0,c:[{cN:"doctype",b:"<!DOCTYPE",e:">",r:10,c:[{b:"\\[",e:"\\]"}]},t.C("<!--","-->",{r:10}),{cN:"cdata",b:"<\\!\\[CDATA\\[",e:"\\]\\]>",r:10},{cN:"tag",b:"<style(?=\\s|>|$)",e:">",k:{title:"style"},c:[c],starts:{e:"</style>",rE:!0,sL:"css"}},{cN:"tag",b:"<script(?=\\s|>|$)",e:">",k:{title:"script"},c:[c],starts:{e:"</script>",rE:!0,sL:""}},s,{cN:"pi",b:/<\?\w+/,e:/\?>/,r:10},{cN:"tag",b:"</?",e:"/?>",c:[{cN:"title",b:/[^ \/><\n\t]+/,r:0},c]}]}});hljs.registerLanguage("autohotkey",function(e){var r={cN:"escape",b:"`[\\s\\S]"},c=e.C(";","$",{r:0}),n=[{cN:"built_in",b:"A_[a-zA-Z0-9]+"},{cN:"built_in",bK:"ComSpec Clipboard ClipboardAll ErrorLevel"}];return{cI:!0,k:{keyword:"Break Continue Else Gosub If Loop Return While",literal:"A true false NOT AND OR"},c:n.concat([r,e.inherit(e.QSM,{c:[r]}),c,{cN:"number",b:e.NR,r:0},{cN:"var_expand",b:"%",e:"%",i:"\\n",c:[r]},{cN:"label",c:[r],v:[{b:'^[^\\n";]+::(?!=)'},{b:'^[^\\n";]+:(?!=)',r:0}]},{b:",\\s*,",r:10}])}});hljs.registerLanguage("r",function(e){var r="([a-zA-Z]|\\.[a-zA-Z.])[a-zA-Z0-9._]*";return{c:[e.HCM,{b:r,l:r,k:{keyword:"function if in break next repeat else for return switch while try tryCatch stop warning require library attach detach source setMethod setGeneric setGroupGeneric setClass ...",literal:"NULL NA TRUE FALSE T F Inf NaN NA_integer_|10 NA_real_|10 NA_character_|10 NA_complex_|10"},r:0},{cN:"number",b:"0[xX][0-9a-fA-F]+[Li]?\\b",r:0},{cN:"number",b:"\\d+(?:[eE][+\\-]?\\d*)?L\\b",r:0},{cN:"number",b:"\\d+\\.(?!\\d)(?:i\\b)?",r:0},{cN:"number",b:"\\d+(?:\\.\\d*)?(?:[eE][+\\-]?\\d*)?i?\\b",r:0},{cN:"number",b:"\\.\\d+(?:[eE][+\\-]?\\d*)?i?\\b",r:0},{b:"`",e:"`",r:0},{cN:"string",c:[e.BE],v:[{b:'"',e:'"'},{b:"'",e:"'"}]}]}});hljs.registerLanguage("cs",function(e){var r="abstract as base bool break byte case catch char checked const continue decimal dynamic default delegate do double else enum event explicit extern false finally fixed float for foreach goto if implicit in int interface internal is lock long null when object operator out override params private protected public readonly ref sbyte sealed short sizeof stackalloc static string struct switch this true try typeof uint ulong unchecked unsafe ushort using virtual volatile void while async protected public private internal ascending descending from get group into join let orderby partial select set value var where yield",t=e.IR+"(<"+e.IR+">)?";return{aliases:["csharp"],k:r,i:/::/,c:[e.C("///","$",{rB:!0,c:[{cN:"xmlDocTag",v:[{b:"///",r:0},{b:"<!--|-->"},{b:"</?",e:">"}]}]}),e.CLCM,e.CBCM,{cN:"preprocessor",b:"#",e:"$",k:"if else elif endif define undef warning error line region endregion pragma checksum"},{cN:"string",b:'@"',e:'"',c:[{b:'""'}]},e.ASM,e.QSM,e.CNM,{bK:"class namespace interface",e:/[{;=]/,i:/[^\s:]/,c:[e.TM,e.CLCM,e.CBCM]},{bK:"new return throw await",r:0},{cN:"function",b:"("+t+"\\s+)+"+e.IR+"\\s*\\(",rB:!0,e:/[{;=]/,eE:!0,k:r,c:[{b:e.IR+"\\s*\\(",rB:!0,c:[e.TM],r:0},{cN:"params",b:/\(/,e:/\)/,k:r,r:0,c:[e.ASM,e.QSM,e.CNM,e.CBCM]},e.CLCM,e.CBCM]}]}});hljs.registerLanguage("nsis",function(e){var t={cN:"symbol",b:"\\$(ADMINTOOLS|APPDATA|CDBURN_AREA|CMDLINE|COMMONFILES32|COMMONFILES64|COMMONFILES|COOKIES|DESKTOP|DOCUMENTS|EXEDIR|EXEFILE|EXEPATH|FAVORITES|FONTS|HISTORY|HWNDPARENT|INSTDIR|INTERNET_CACHE|LANGUAGE|LOCALAPPDATA|MUSIC|NETHOOD|OUTDIR|PICTURES|PLUGINSDIR|PRINTHOOD|PROFILE|PROGRAMFILES32|PROGRAMFILES64|PROGRAMFILES|QUICKLAUNCH|RECENT|RESOURCES_LOCALIZED|RESOURCES|SENDTO|SMPROGRAMS|SMSTARTUP|STARTMENU|SYSDIR|TEMP|TEMPLATES|VIDEOS|WINDIR)"},n={cN:"constant",b:"\\$+{[a-zA-Z0-9_]+}"},i={cN:"variable",b:"\\$+[a-zA-Z0-9_]+",i:"\\(\\){}"},r={cN:"constant",b:"\\$+\\([a-zA-Z0-9_]+\\)"},o={cN:"params",b:"(ARCHIVE|FILE_ATTRIBUTE_ARCHIVE|FILE_ATTRIBUTE_NORMAL|FILE_ATTRIBUTE_OFFLINE|FILE_ATTRIBUTE_READONLY|FILE_ATTRIBUTE_SYSTEM|FILE_ATTRIBUTE_TEMPORARY|HKCR|HKCU|HKDD|HKEY_CLASSES_ROOT|HKEY_CURRENT_CONFIG|HKEY_CURRENT_USER|HKEY_DYN_DATA|HKEY_LOCAL_MACHINE|HKEY_PERFORMANCE_DATA|HKEY_USERS|HKLM|HKPD|HKU|IDABORT|IDCANCEL|IDIGNORE|IDNO|IDOK|IDRETRY|IDYES|MB_ABORTRETRYIGNORE|MB_DEFBUTTON1|MB_DEFBUTTON2|MB_DEFBUTTON3|MB_DEFBUTTON4|MB_ICONEXCLAMATION|MB_ICONINFORMATION|MB_ICONQUESTION|MB_ICONSTOP|MB_OK|MB_OKCANCEL|MB_RETRYCANCEL|MB_RIGHT|MB_RTLREADING|MB_SETFOREGROUND|MB_TOPMOST|MB_USERICON|MB_YESNO|NORMAL|OFFLINE|READONLY|SHCTX|SHELL_CONTEXT|SYSTEM|TEMPORARY)"},l={cN:"constant",b:"\\!(addincludedir|addplugindir|appendfile|cd|define|delfile|echo|else|endif|error|execute|finalize|getdllversionsystem|ifdef|ifmacrodef|ifmacrondef|ifndef|if|include|insertmacro|macroend|macro|makensis|packhdr|searchparse|searchreplace|tempfile|undef|verbose|warning)"};return{cI:!1,k:{keyword:"Abort AddBrandingImage AddSize AllowRootDirInstall AllowSkipFiles AutoCloseWindow BGFont BGGradient BrandingText BringToFront Call CallInstDLL Caption ChangeUI CheckBitmap ClearErrors CompletedText ComponentText CopyFiles CRCCheck CreateDirectory CreateFont CreateShortCut Delete DeleteINISec DeleteINIStr DeleteRegKey DeleteRegValue DetailPrint DetailsButtonText DirText DirVar DirVerify EnableWindow EnumRegKey EnumRegValue Exch Exec ExecShell ExecWait ExpandEnvStrings File FileBufSize FileClose FileErrorText FileOpen FileRead FileReadByte FileReadUTF16LE FileReadWord FileSeek FileWrite FileWriteByte FileWriteUTF16LE FileWriteWord FindClose FindFirst FindNext FindWindow FlushINI FunctionEnd GetCurInstType GetCurrentAddress GetDlgItem GetDLLVersion GetDLLVersionLocal GetErrorLevel GetFileTime GetFileTimeLocal GetFullPathName GetFunctionAddress GetInstDirError GetLabelAddress GetTempFileName Goto HideWindow Icon IfAbort IfErrors IfFileExists IfRebootFlag IfSilent InitPluginsDir InstallButtonText InstallColors InstallDir InstallDirRegKey InstProgressFlags InstType InstTypeGetText InstTypeSetText IntCmp IntCmpU IntFmt IntOp IsWindow LangString LicenseBkColor LicenseData LicenseForceSelection LicenseLangString LicenseText LoadLanguageFile LockWindow LogSet LogText ManifestDPIAware ManifestSupportedOS MessageBox MiscButtonText Name Nop OutFile Page PageCallbacks PageExEnd Pop Push Quit ReadEnvStr ReadINIStr ReadRegDWORD ReadRegStr Reboot RegDLL Rename RequestExecutionLevel ReserveFile Return RMDir SearchPath SectionEnd SectionGetFlags SectionGetInstTypes SectionGetSize SectionGetText SectionGroupEnd SectionIn SectionSetFlags SectionSetInstTypes SectionSetSize SectionSetText SendMessage SetAutoClose SetBrandingImage SetCompress SetCompressor SetCompressorDictSize SetCtlColors SetCurInstType SetDatablockOptimize SetDateSave SetDetailsPrint SetDetailsView SetErrorLevel SetErrors SetFileAttributes SetFont SetOutPath SetOverwrite SetPluginUnload SetRebootFlag SetRegView SetShellVarContext SetSilent ShowInstDetails ShowUninstDetails ShowWindow SilentInstall SilentUnInstall Sleep SpaceTexts StrCmp StrCmpS StrCpy StrLen SubCaption SubSectionEnd Unicode UninstallButtonText UninstallCaption UninstallIcon UninstallSubCaption UninstallText UninstPage UnRegDLL Var VIAddVersionKey VIFileVersion VIProductVersion WindowIcon WriteINIStr WriteRegBin WriteRegDWORD WriteRegExpandStr WriteRegStr WriteUninstaller XPStyle",literal:"admin all auto both colored current false force hide highest lastused leave listonly none normal notset off on open print show silent silentlog smooth textonly true user "},c:[e.HCM,e.CBCM,{cN:"string",b:'"',e:'"',i:"\\n",c:[{cN:"symbol",b:"\\$(\\\\(n|r|t)|\\$)"},t,n,i,r]},e.C(";","$",{r:0}),{cN:"function",bK:"Function PageEx Section SectionGroup SubSection",e:"$"},l,n,i,r,o,e.NM,{cN:"literal",b:e.IR+"::"+e.IR}]}});hljs.registerLanguage("less",function(e){var r="[\\w-]+",t="("+r+"|@{"+r+"})",a=[],c=[],n=function(e){return{cN:"string",b:"~?"+e+".*?"+e}},i=function(e,r,t){return{cN:e,b:r,r:t}},s=function(r,t,a){return e.inherit({cN:r,b:t+"\\(",e:"\\(",rB:!0,eE:!0,r:0},a)},b={b:"\\(",e:"\\)",c:c,r:0};c.push(e.CLCM,e.CBCM,n("'"),n('"'),e.CSSNM,i("hexcolor","#[0-9A-Fa-f]+\\b"),s("function","(url|data-uri)",{starts:{cN:"string",e:"[\\)\\n]",eE:!0}}),s("function",r),b,i("variable","@@?"+r,10),i("variable","@{"+r+"}"),i("built_in","~?`[^`]*?`"),{cN:"attribute",b:r+"\\s*:",e:":",rB:!0,eE:!0});var o=c.concat({b:"{",e:"}",c:a}),u={bK:"when",eW:!0,c:[{bK:"and not"}].concat(c)},C={cN:"attribute",b:t,e:":",eE:!0,c:[e.CLCM,e.CBCM],i:/\S/,starts:{e:"[;}]",rE:!0,c:c,i:"[<=$]"}},l={cN:"at_rule",b:"@(import|media|charset|font-face|(-[a-z]+-)?keyframes|supports|document|namespace|page|viewport|host)\\b",starts:{e:"[;{}]",rE:!0,c:c,r:0}},d={cN:"variable",v:[{b:"@"+r+"\\s*:",r:15},{b:"@"+r}],starts:{e:"[;}]",rE:!0,c:o}},p={v:[{b:"[\\.#:&\\[]",e:"[;{}]"},{b:t+"[^;]*{",e:"{"}],rB:!0,rE:!0,i:"[<='$\"]",c:[e.CLCM,e.CBCM,u,i("keyword","all\\b"),i("variable","@{"+r+"}"),i("tag",t+"%?",0),i("id","#"+t),i("class","\\."+t,0),i("keyword","&",0),s("pseudo",":not"),s("keyword",":extend"),i("pseudo","::?"+t),{cN:"attr_selector",b:"\\[",e:"\\]"},{b:"\\(",e:"\\)",c:o},{b:"!important"}]};return a.push(e.CLCM,e.CBCM,l,d,p,C),{cI:!0,i:"[=>'/<($\"]",c:a}});hljs.registerLanguage("pf",function(t){var o={cN:"variable",b:/\$[\w\d#@][\w\d_]*/},e={cN:"variable",b:/</,e:/>/};return{aliases:["pf.conf"],l:/[a-z0-9_<>-]+/,k:{built_in:"block match pass load anchor|5 antispoof|10 set table",keyword:"in out log quick on rdomain inet inet6 proto from port os to routeallow-opts divert-packet divert-reply divert-to flags group icmp-typeicmp6-type label once probability recieved-on rtable prio queuetos tag tagged user keep fragment for os dropaf-to|10 binat-to|10 nat-to|10 rdr-to|10 bitmask least-stats random round-robinsource-hash static-portdup-to reply-to route-toparent bandwidth default min max qlimitblock-policy debug fingerprints hostid limit loginterface optimizationreassemble ruleset-optimization basic none profile skip state-defaultsstate-policy timeoutconst counters persistno modulate synproxy state|5 floating if-bound no-sync pflow|10 sloppysource-track global rule max-src-nodes max-src-states max-src-connmax-src-conn-rate overload flushscrub|5 max-mss min-ttl no-df|10 random-id",literal:"all any no-route self urpf-failed egress|5 unknown"},c:[t.HCM,t.NM,t.QSM,o,e]}});hljs.registerLanguage("lasso",function(e){var r="[a-zA-Z_][a-zA-Z0-9_.]*",a="<\\?(lasso(script)?|=)",t="\\]|\\?>",s={literal:"true false none minimal full all void and or not bw nbw ew new cn ncn lt lte gt gte eq neq rx nrx ft",built_in:"array date decimal duration integer map pair string tag xml null boolean bytes keyword list locale queue set stack staticarray local var variable global data self inherited",keyword:"error_code error_msg error_pop error_push error_reset cache database_names database_schemanames database_tablenames define_tag define_type email_batch encode_set html_comment handle handle_error header if inline iterate ljax_target link link_currentaction link_currentgroup link_currentrecord link_detail link_firstgroup link_firstrecord link_lastgroup link_lastrecord link_nextgroup link_nextrecord link_prevgroup link_prevrecord log loop namespace_using output_none portal private protect records referer referrer repeating resultset rows search_args search_arguments select sort_args sort_arguments thread_atomic value_list while abort case else if_empty if_false if_null if_true loop_abort loop_continue loop_count params params_up return return_value run_children soap_definetag soap_lastrequest soap_lastresponse tag_name ascending average by define descending do equals frozen group handle_failure import in into join let match max min on order parent protected provide public require returnhome skip split_thread sum take thread to trait type where with yield yieldhome"},n=e.C("<!--","-->",{r:0}),o={cN:"preprocessor",b:"\\[noprocess\\]",starts:{cN:"markup",e:"\\[/noprocess\\]",rE:!0,c:[n]}},i={cN:"preprocessor",b:"\\[/noprocess|"+a},l={cN:"variable",b:"'"+r+"'"},c=[e.CLCM,{cN:"javadoc",b:"/\\*\\*!",e:"\\*/",c:[e.PWM]},e.CBCM,e.inherit(e.CNM,{b:e.CNR+"|(-?infinity|nan)\\b"}),e.inherit(e.ASM,{i:null}),e.inherit(e.QSM,{i:null}),{cN:"string",b:"`",e:"`"},{cN:"variable",v:[{b:"[#$]"+r},{b:"#",e:"\\d+",i:"\\W"}]},{cN:"tag",b:"::\\s*",e:r,i:"\\W"},{cN:"attribute",v:[{b:"-"+e.UIR,r:0},{b:"(\\.\\.\\.)"}]},{cN:"subst",v:[{b:"->\\s*",c:[l]},{b:":=|/(?!\\w)=?|[-+*%=<>&|!?\\\\]+",r:0}]},{cN:"built_in",b:"\\.\\.?\\s*",r:0,c:[l]},{cN:"class",bK:"define",rE:!0,e:"\\(|=>",c:[e.inherit(e.TM,{b:e.UIR+"(=(?!>))?"})]}];return{aliases:["ls","lassoscript"],cI:!0,l:r+"|&[lg]t;",k:s,c:[{cN:"preprocessor",b:t,r:0,starts:{cN:"markup",e:"\\[|"+a,rE:!0,r:0,c:[n]}},o,i,{cN:"preprocessor",b:"\\[no_square_brackets",starts:{e:"\\[/no_square_brackets\\]",l:r+"|&[lg]t;",k:s,c:[{cN:"preprocessor",b:t,r:0,starts:{cN:"markup",e:"\\[noprocess\\]|"+a,rE:!0,c:[n]}},o,i].concat(c)}},{cN:"preprocessor",b:"\\[",r:0},{cN:"shebang",b:"^#!.+lasso9\\b",r:10}].concat(c)}});hljs.registerLanguage("prolog",function(c){var r={cN:"atom",b:/[a-z][A-Za-z0-9_]*/,r:0},b={cN:"name",v:[{b:/[A-Z][a-zA-Z0-9_]*/},{b:/_[A-Za-z0-9_]*/}],r:0},a={b:/\(/,e:/\)/,r:0},e={b:/\[/,e:/\]/},n={cN:"comment",b:/%/,e:/$/,c:[c.PWM]},t={cN:"string",b:/`/,e:/`/,c:[c.BE]},g={cN:"string",b:/0\'(\\\'|.)/},N={cN:"string",b:/0\'\\s/},o={b:/:-/},s=[r,b,a,o,e,n,c.CBCM,c.QSM,c.ASM,t,g,N,c.CNM];return a.c=s,e.c=s,{c:s.concat([{b:/\.$/}])}});hljs.registerLanguage("oxygene",function(e){var r="abstract add and array as asc aspect assembly async begin break block by case class concat const copy constructor continue create default delegate desc distinct div do downto dynamic each else empty end ensure enum equals event except exit extension external false final finalize finalizer finally flags for forward from function future global group has if implementation implements implies in index inherited inline interface into invariants is iterator join locked locking loop matching method mod module namespace nested new nil not notify nullable of old on operator or order out override parallel params partial pinned private procedure property protected public queryable raise read readonly record reintroduce remove repeat require result reverse sealed select self sequence set shl shr skip static step soft take then to true try tuple type union unit unsafe until uses using var virtual raises volatile where while with write xor yield await mapped deprecated stdcall cdecl pascal register safecall overload library platform reference packed strict published autoreleasepool selector strong weak unretained",t=e.C("{","}",{r:0}),a=e.C("\\(\\*","\\*\\)",{r:10}),n={cN:"string",b:"'",e:"'",c:[{b:"''"}]},o={cN:"string",b:"(#\\d+)+"},i={cN:"function",bK:"function constructor destructor procedure method",e:"[:;]",k:"function constructor|10 destructor|10 procedure|10 method|10",c:[e.TM,{cN:"params",b:"\\(",e:"\\)",k:r,c:[n,o]},t,a]};return{cI:!0,k:r,i:'("|\\$[G-Zg-z]|\\/\\*|</|=>|->)',c:[t,a,e.CLCM,n,o,e.NM,i,{cN:"class",b:"=\\bclass\\b",e:"end;",k:r,c:[n,o,t,a,e.CLCM,i]}]}});hljs.registerLanguage("applescript",function(e){var t=e.inherit(e.QSM,{i:""}),r={cN:"params",b:"\\(",e:"\\)",c:["self",e.CNM,t]},o=e.C("--","$"),n=e.C("\\(\\*","\\*\\)",{c:["self",o]}),a=[o,n,e.HCM];return{aliases:["osascript"],k:{keyword:"about above after against and around as at back before beginning behind below beneath beside between but by considering contain contains continue copy div does eighth else end equal equals error every exit fifth first for fourth from front get given global if ignoring in into is it its last local me middle mod my ninth not of on onto or over prop property put ref reference repeat returning script second set seventh since sixth some tell tenth that the|0 then third through thru timeout times to transaction try until where while whose with without",constant:"AppleScript false linefeed return pi quote result space tab true",type:"alias application boolean class constant date file integer list number real record string text",command:"activate beep count delay launch log offset read round run say summarize write",property:"character characters contents day frontmost id item length month name paragraph paragraphs rest reverse running time version weekday word words year"},c:[t,e.CNM,{cN:"type",b:"\\bPOSIX file\\b"},{cN:"command",b:"\\b(clipboard info|the clipboard|info for|list (disks|folder)|mount volume|path to|(close|open for) access|(get|set) eof|current date|do shell script|get volume settings|random number|set volume|system attribute|system info|time to GMT|(load|run|store) script|scripting components|ASCII (character|number)|localized string|choose (application|color|file|file name|folder|from list|remote application|URL)|display (alert|dialog))\\b|^\\s*return\\b"},{cN:"constant",b:"\\b(text item delimiters|current application|missing value)\\b"},{cN:"keyword",b:"\\b(apart from|aside from|instead of|out of|greater than|isn't|(doesn't|does not) (equal|come before|come after|contain)|(greater|less) than( or equal)?|(starts?|ends|begins?) with|contained by|comes (before|after)|a (ref|reference))\\b"},{cN:"property",b:"\\b(POSIX path|(date|time) string|quoted form)\\b"},{cN:"function_start",bK:"on",i:"[${=;\\n]",c:[e.UTM,r]}].concat(a),i:"//|->|=>"}});hljs.registerLanguage("makefile",function(e){var a={cN:"variable",b:/\$\(/,e:/\)/,c:[e.BE]};return{aliases:["mk","mak"],c:[e.HCM,{b:/^\w+\s*\W*=/,rB:!0,r:0,starts:{cN:"constant",e:/\s*\W*=/,eE:!0,starts:{e:/$/,r:0,c:[a]}}},{cN:"title",b:/^[\w]+:\s*$/},{cN:"phony",b:/^\.PHONY:/,e:/$/,k:".PHONY",l:/[\.\w]+/},{b:/^\t+/,e:/$/,r:0,c:[e.QSM,a]}]}});hljs.registerLanguage("dust",function(e){var a="if eq ne lt lte gt gte select default math sep";return{aliases:["dst"],cI:!0,sL:"xml",subLanguageMode:"continuous",c:[{cN:"expression",b:"{",e:"}",r:0,c:[{cN:"begin-block",b:"#[a-zA-Z- .]+",k:a},{cN:"string",b:'"',e:'"'},{cN:"end-block",b:"\\/[a-zA-Z- .]+",k:a},{cN:"variable",b:"[a-zA-Z-.]+",k:a,r:0}]}]}});hljs.registerLanguage("clojure-repl",function(e){return{c:[{cN:"prompt",b:/^([\w.-]+|\s*#_)=>/,starts:{e:/$/,sL:"clojure",subLanguageMode:"continuous"}}]}});hljs.registerLanguage("dart",function(e){var t={cN:"subst",b:"\\$\\{",e:"}",k:"true false null this is new super"},r={cN:"string",v:[{b:"r'''",e:"'''"},{b:'r"""',e:'"""'},{b:"r'",e:"'",i:"\\n"},{b:'r"',e:'"',i:"\\n"},{b:"'''",e:"'''",c:[e.BE,t]},{b:'"""',e:'"""',c:[e.BE,t]},{b:"'",e:"'",i:"\\n",c:[e.BE,t]},{b:'"',e:'"',i:"\\n",c:[e.BE,t]}]};t.c=[e.CNM,r];var n={keyword:"assert break case catch class const continue default do else enum extends false final finally for if in is new null rethrow return super switch this throw true try var void while with",literal:"abstract as dynamic export external factory get implements import library operator part set static typedef",built_in:"print Comparable DateTime Duration Function Iterable Iterator List Map Match Null Object Pattern RegExp Set Stopwatch String StringBuffer StringSink Symbol Type Uri bool double int num document window querySelector querySelectorAll Element ElementList"};return{k:n,c:[r,{cN:"dartdoc",b:"/\\*\\*",e:"\\*/",sL:"markdown",subLanguageMode:"continuous"},{cN:"dartdoc",b:"///",e:"$",sL:"markdown",subLanguageMode:"continuous"},e.CLCM,e.CBCM,{cN:"class",bK:"class interface",e:"{",eE:!0,c:[{bK:"extends implements"},e.UTM]},e.CNM,{cN:"annotation",b:"@[A-Za-z]+"},{b:"=>"}]}}); \ No newline at end of file | ||
diff --git a/doc/html/js/jquery-2.1.1.min.js b/doc/html/js/jquery-2.1.1.min.js new file mode 100644 index 00000000..e5ace116 --- /dev/null +++ b/doc/html/js/jquery-2.1.1.min.js | |||
| @@ -0,0 +1,4 @@ | |||
| 1 | /*! jQuery v2.1.1 | (c) 2005, 2014 jQuery Foundation, Inc. | jquery.org/license */ | ||
| 2 | !function(a,b){"object"==typeof module&&"object"==typeof module.exports?module.exports=a.document?b(a,!0):function(a){if(!a.document)throw new Error("jQuery requires a window with a document");return b(a)}:b(a)}("undefined"!=typeof window?window:this,function(a,b){var c=[],d=c.slice,e=c.concat,f=c.push,g=c.indexOf,h={},i=h.toString,j=h.hasOwnProperty,k={},l=a.document,m="2.1.1",n=function(a,b){return new n.fn.init(a,b)},o=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,p=/^-ms-/,q=/-([\da-z])/gi,r=function(a,b){return b.toUpperCase()};n.fn=n.prototype={jquery:m,constructor:n,selector:"",length:0,toArray:function(){return d.call(this)},get:function(a){return null!=a?0>a?this[a+this.length]:this[a]:d.call(this)},pushStack:function(a){var b=n.merge(this.constructor(),a);return b.prevObject=this,b.context=this.context,b},each:function(a,b){return n.each(this,a,b)},map:function(a){return this.pushStack(n.map(this,function(b,c){return a.call(b,c,b)}))},slice:function(){return this.pushStack(d.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},eq:function(a){var b=this.length,c=+a+(0>a?b:0);return this.pushStack(c>=0&&b>c?[this[c]]:[])},end:function(){return this.prevObject||this.constructor(null)},push:f,sort:c.sort,splice:c.splice},n.extend=n.fn.extend=function(){var a,b,c,d,e,f,g=arguments[0]||{},h=1,i=arguments.length,j=!1;for("boolean"==typeof g&&(j=g,g=arguments[h]||{},h++),"object"==typeof g||n.isFunction(g)||(g={}),h===i&&(g=this,h--);i>h;h++)if(null!=(a=arguments[h]))for(b in a)c=g[b],d=a[b],g!==d&&(j&&d&&(n.isPlainObject(d)||(e=n.isArray(d)))?(e?(e=!1,f=c&&n.isArray(c)?c:[]):f=c&&n.isPlainObject(c)?c:{},g[b]=n.extend(j,f,d)):void 0!==d&&(g[b]=d));return g},n.extend({expando:"jQuery"+(m+Math.random()).replace(/\D/g,""),isReady:!0,error:function(a){throw new Error(a)},noop:function(){},isFunction:function(a){return"function"===n.type(a)},isArray:Array.isArray,isWindow:function(a){return null!=a&&a===a.window},isNumeric:function(a){return!n.isArray(a)&&a-parseFloat(a)>=0},isPlainObject:function(a){return"object"!==n.type(a)||a.nodeType||n.isWindow(a)?!1:a.constructor&&!j.call(a.constructor.prototype,"isPrototypeOf")?!1:!0},isEmptyObject:function(a){var b;for(b in a)return!1;return!0},type:function(a){return null==a?a+"":"object"==typeof a||"function"==typeof a?h[i.call(a)]||"object":typeof a},globalEval:function(a){var b,c=eval;a=n.trim(a),a&&(1===a.indexOf("use strict")?(b=l.createElement("script"),b.text=a,l.head.appendChild(b).parentNode.removeChild(b)):c(a))},camelCase:function(a){return a.replace(p,"ms-").replace(q,r)},nodeName:function(a,b){return a.nodeName&&a.nodeName.toLowerCase()===b.toLowerCase()},each:function(a,b,c){var d,e=0,f=a.length,g=s(a);if(c){if(g){for(;f>e;e++)if(d=b.apply(a[e],c),d===!1)break}else for(e in a)if(d=b.apply(a[e],c),d===!1)break}else if(g){for(;f>e;e++)if(d=b.call(a[e],e,a[e]),d===!1)break}else for(e in a)if(d=b.call(a[e],e,a[e]),d===!1)break;return a},trim:function(a){return null==a?"":(a+"").replace(o,"")},makeArray:function(a,b){var c=b||[];return null!=a&&(s(Object(a))?n.merge(c,"string"==typeof a?[a]:a):f.call(c,a)),c},inArray:function(a,b,c){return null==b?-1:g.call(b,a,c)},merge:function(a,b){for(var c=+b.length,d=0,e=a.length;c>d;d++)a[e++]=b[d];return a.length=e,a},grep:function(a,b,c){for(var d,e=[],f=0,g=a.length,h=!c;g>f;f++)d=!b(a[f],f),d!==h&&e.push(a[f]);return e},map:function(a,b,c){var d,f=0,g=a.length,h=s(a),i=[];if(h)for(;g>f;f++)d=b(a[f],f,c),null!=d&&i.push(d);else for(f in a)d=b(a[f],f,c),null!=d&&i.push(d);return e.apply([],i)},guid:1,proxy:function(a,b){var c,e,f;return"string"==typeof b&&(c=a[b],b=a,a=c),n.isFunction(a)?(e=d.call(arguments,2),f=function(){return a.apply(b||this,e.concat(d.call(arguments)))},f.guid=a.guid=a.guid||n.guid++,f):void 0},now:Date.now,support:k}),n.each("Boolean Number String Function Array Date RegExp Object Error".split(" "),function(a,b){h["[object "+b+"]"]=b.toLowerCase()});function s(a){var b=a.length,c=n.type(a);return"function"===c||n.isWindow(a)?!1:1===a.nodeType&&b?!0:"array"===c||0===b||"number"==typeof b&&b>0&&b-1 in a}var t=function(a){var b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u="sizzle"+-new Date,v=a.document,w=0,x=0,y=gb(),z=gb(),A=gb(),B=function(a,b){return a===b&&(l=!0),0},C="undefined",D=1<<31,E={}.hasOwnProperty,F=[],G=F.pop,H=F.push,I=F.push,J=F.slice,K=F.indexOf||function(a){for(var b=0,c=this.length;c>b;b++)if(this[b]===a)return b;return-1},L="checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",M="[\\x20\\t\\r\\n\\f]",N="(?:\\\\.|[\\w-]|[^\\x00-\\xa0])+",O=N.replace("w","w#"),P="\\["+M+"*("+N+")(?:"+M+"*([*^$|!~]?=)"+M+"*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|("+O+"))|)"+M+"*\\]",Q=":("+N+")(?:\\((('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|((?:\\\\.|[^\\\\()[\\]]|"+P+")*)|.*)\\)|)",R=new RegExp("^"+M+"+|((?:^|[^\\\\])(?:\\\\.)*)"+M+"+$","g"),S=new RegExp("^"+M+"*,"+M+"*"),T=new RegExp("^"+M+"*([>+~]|"+M+")"+M+"*"),U=new RegExp("="+M+"*([^\\]'\"]*?)"+M+"*\\]","g"),V=new RegExp(Q),W=new RegExp("^"+O+"$"),X={ID:new RegExp("^#("+N+")"),CLASS:new RegExp("^\\.("+N+")"),TAG:new RegExp("^("+N.replace("w","w*")+")"),ATTR:new RegExp("^"+P),PSEUDO:new RegExp("^"+Q),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+L+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/^(?:input|select|textarea|button)$/i,Z=/^h\d$/i,$=/^[^{]+\{\s*\[native \w/,_=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ab=/[+~]/,bb=/'|\\/g,cb=new RegExp("\\\\([\\da-f]{1,6}"+M+"?|("+M+")|.)","ig"),db=function(a,b,c){var d="0x"+b-65536;return d!==d||c?b:0>d?String.fromCharCode(d+65536):String.fromCharCode(d>>10|55296,1023&d|56320)};try{I.apply(F=J.call(v.childNodes),v.childNodes),F[v.childNodes.length].nodeType}catch(eb){I={apply:F.length?function(a,b){H.apply(a,J.call(b))}:function(a,b){var c=a.length,d=0;while(a[c++]=b[d++]);a.length=c-1}}}function fb(a,b,d,e){var f,h,j,k,l,o,r,s,w,x;if((b?b.ownerDocument||b:v)!==n&&m(b),b=b||n,d=d||[],!a||"string"!=typeof a)return d;if(1!==(k=b.nodeType)&&9!==k)return[];if(p&&!e){if(f=_.exec(a))if(j=f[1]){if(9===k){if(h=b.getElementById(j),!h||!h.parentNode)return d;if(h.id===j)return d.push(h),d}else if(b.ownerDocument&&(h=b.ownerDocument.getElementById(j))&&t(b,h)&&h.id===j)return d.push(h),d}else{if(f[2])return I.apply(d,b.getElementsByTagName(a)),d;if((j=f[3])&&c.getElementsByClassName&&b.getElementsByClassName)return I.apply(d,b.getElementsByClassName(j)),d}if(c.qsa&&(!q||!q.test(a))){if(s=r=u,w=b,x=9===k&&a,1===k&&"object"!==b.nodeName.toLowerCase()){o=g(a),(r=b.getAttribute("id"))?s=r.replace(bb,"\\$&"):b.setAttribute("id",s),s="[id='"+s+"'] ",l=o.length;while(l--)o[l]=s+qb(o[l]);w=ab.test(a)&&ob(b.parentNode)||b,x=o.join(",")}if(x)try{return I.apply(d,w.querySelectorAll(x)),d}catch(y){}finally{r||b.removeAttribute("id")}}}return i(a.replace(R,"$1"),b,d,e)}function gb(){var a=[];function b(c,e){return a.push(c+" ")>d.cacheLength&&delete b[a.shift()],b[c+" "]=e}return b}function hb(a){return a[u]=!0,a}function ib(a){var b=n.createElement("div");try{return!!a(b)}catch(c){return!1}finally{b.parentNode&&b.parentNode.removeChild(b),b=null}}function jb(a,b){var c=a.split("|"),e=a.length;while(e--)d.attrHandle[c[e]]=b}function kb(a,b){var c=b&&a,d=c&&1===a.nodeType&&1===b.nodeType&&(~b.sourceIndex||D)-(~a.sourceIndex||D);if(d)return d;if(c)while(c=c.nextSibling)if(c===b)return-1;return a?1:-1}function lb(a){return function(b){var c=b.nodeName.toLowerCase();return"input"===c&&b.type===a}}function mb(a){return function(b){var c=b.nodeName.toLowerCase();return("input"===c||"button"===c)&&b.type===a}}function nb(a){return hb(function(b){return b=+b,hb(function(c,d){var e,f=a([],c.length,b),g=f.length;while(g--)c[e=f[g]]&&(c[e]=!(d[e]=c[e]))})})}function ob(a){return a&&typeof a.getElementsByTagName!==C&&a}c=fb.support={},f=fb.isXML=function(a){var b=a&&(a.ownerDocument||a).documentElement;return b?"HTML"!==b.nodeName:!1},m=fb.setDocument=function(a){var b,e=a?a.ownerDocument||a:v,g=e.defaultView;return e!==n&&9===e.nodeType&&e.documentElement?(n=e,o=e.documentElement,p=!f(e),g&&g!==g.top&&(g.addEventListener?g.addEventListener("unload",function(){m()},!1):g.attachEvent&&g.attachEvent("onunload",function(){m()})),c.attributes=ib(function(a){return a.className="i",!a.getAttribute("className")}),c.getElementsByTagName=ib(function(a){return a.appendChild(e.createComment("")),!a.getElementsByTagName("*").length}),c.getElementsByClassName=$.test(e.getElementsByClassName)&&ib(function(a){return a.innerHTML="<div class='a'></div><div class='a i'></div>",a.firstChild.className="i",2===a.getElementsByClassName("i").length}),c.getById=ib(function(a){return o.appendChild(a).id=u,!e.getElementsByName||!e.getElementsByName(u).length}),c.getById?(d.find.ID=function(a,b){if(typeof b.getElementById!==C&&p){var c=b.getElementById(a);return c&&c.parentNode?[c]:[]}},d.filter.ID=function(a){var b=a.replace(cb,db);return function(a){return a.getAttribute("id")===b}}):(delete d.find.ID,d.filter.ID=function(a){var b=a.replace(cb,db);return function(a){var c=typeof a.getAttributeNode!==C&&a.getAttributeNode("id");return c&&c.value===b}}),d.find.TAG=c.getElementsByTagName?function(a,b){return typeof b.getElementsByTagName!==C?b.getElementsByTagName(a):void 0}:function(a,b){var c,d=[],e=0,f=b.getElementsByTagName(a);if("*"===a){while(c=f[e++])1===c.nodeType&&d.push(c);return d}return f},d.find.CLASS=c.getElementsByClassName&&function(a,b){return typeof b.getElementsByClassName!==C&&p?b.getElementsByClassName(a):void 0},r=[],q=[],(c.qsa=$.test(e.querySelectorAll))&&(ib(function(a){a.innerHTML="<select msallowclip=''><option selected=''></option></select>",a.querySelectorAll("[msallowclip^='']").length&&q.push("[*^$]="+M+"*(?:''|\"\")"),a.querySelectorAll("[selected]").length||q.push("\\["+M+"*(?:value|"+L+")"),a.querySelectorAll(":checked").length||q.push(":checked")}),ib(function(a){var b=e.createElement("input");b.setAttribute("type","hidden"),a.appendChild(b).setAttribute("name","D"),a.querySelectorAll("[name=d]").length&&q.push("name"+M+"*[*^$|!~]?="),a.querySelectorAll(":enabled").length||q.push(":enabled",":disabled"),a.querySelectorAll("*,:x"),q.push(",.*:")})),(c.matchesSelector=$.test(s=o.matches||o.webkitMatchesSelector||o.mozMatchesSelector||o.oMatchesSelector||o.msMatchesSelector))&&ib(function(a){c.disconnectedMatch=s.call(a,"div"),s.call(a,"[s!='']:x"),r.push("!=",Q)}),q=q.length&&new RegExp(q.join("|")),r=r.length&&new RegExp(r.join("|")),b=$.test(o.compareDocumentPosition),t=b||$.test(o.contains)?function(a,b){var c=9===a.nodeType?a.documentElement:a,d=b&&b.parentNode;return a===d||!(!d||1!==d.nodeType||!(c.contains?c.contains(d):a.compareDocumentPosition&&16&a.compareDocumentPosition(d)))}:function(a,b){if(b)while(b=b.parentNode)if(b===a)return!0;return!1},B=b?function(a,b){if(a===b)return l=!0,0;var d=!a.compareDocumentPosition-!b.compareDocumentPosition;return d?d:(d=(a.ownerDocument||a)===(b.ownerDocument||b)?a.compareDocumentPosition(b):1,1&d||!c.sortDetached&&b.compareDocumentPosition(a)===d?a===e||a.ownerDocument===v&&t(v,a)?-1:b===e||b.ownerDocument===v&&t(v,b)?1:k?K.call(k,a)-K.call(k,b):0:4&d?-1:1)}:function(a,b){if(a===b)return l=!0,0;var c,d=0,f=a.parentNode,g=b.parentNode,h=[a],i=[b];if(!f||!g)return a===e?-1:b===e?1:f?-1:g?1:k?K.call(k,a)-K.call(k,b):0;if(f===g)return kb(a,b);c=a;while(c=c.parentNode)h.unshift(c);c=b;while(c=c.parentNode)i.unshift(c);while(h[d]===i[d])d++;return d?kb(h[d],i[d]):h[d]===v?-1:i[d]===v?1:0},e):n},fb.matches=function(a,b){return fb(a,null,null,b)},fb.matchesSelector=function(a,b){if((a.ownerDocument||a)!==n&&m(a),b=b.replace(U,"='$1']"),!(!c.matchesSelector||!p||r&&r.test(b)||q&&q.test(b)))try{var d=s.call(a,b);if(d||c.disconnectedMatch||a.document&&11!==a.document.nodeType)return d}catch(e){}return fb(b,n,null,[a]).length>0},fb.contains=function(a,b){return(a.ownerDocument||a)!==n&&m(a),t(a,b)},fb.attr=function(a,b){(a.ownerDocument||a)!==n&&m(a);var e=d.attrHandle[b.toLowerCase()],f=e&&E.call(d.attrHandle,b.toLowerCase())?e(a,b,!p):void 0;return void 0!==f?f:c.attributes||!p?a.getAttribute(b):(f=a.getAttributeNode(b))&&f.specified?f.value:null},fb.error=function(a){throw new Error("Syntax error, unrecognized expression: "+a)},fb.uniqueSort=function(a){var b,d=[],e=0,f=0;if(l=!c.detectDuplicates,k=!c.sortStable&&a.slice(0),a.sort(B),l){while(b=a[f++])b===a[f]&&(e=d.push(f));while(e--)a.splice(d[e],1)}return k=null,a},e=fb.getText=function(a){var b,c="",d=0,f=a.nodeType;if(f){if(1===f||9===f||11===f){if("string"==typeof a.textContent)return a.textContent;for(a=a.firstChild;a;a=a.nextSibling)c+=e(a)}else if(3===f||4===f)return a.nodeValue}else while(b=a[d++])c+=e(b);return c},d=fb.selectors={cacheLength:50,createPseudo:hb,match:X,attrHandle:{},find:{},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(a){return a[1]=a[1].replace(cb,db),a[3]=(a[3]||a[4]||a[5]||"").replace(cb,db),"~="===a[2]&&(a[3]=" "+a[3]+" "),a.slice(0,4)},CHILD:function(a){return a[1]=a[1].toLowerCase(),"nth"===a[1].slice(0,3)?(a[3]||fb.error(a[0]),a[4]=+(a[4]?a[5]+(a[6]||1):2*("even"===a[3]||"odd"===a[3])),a[5]=+(a[7]+a[8]||"odd"===a[3])):a[3]&&fb.error(a[0]),a},PSEUDO:function(a){var b,c=!a[6]&&a[2];return X.CHILD.test(a[0])?null:(a[3]?a[2]=a[4]||a[5]||"":c&&V.test(c)&&(b=g(c,!0))&&(b=c.indexOf(")",c.length-b)-c.length)&&(a[0]=a[0].slice(0,b),a[2]=c.slice(0,b)),a.slice(0,3))}},filter:{TAG:function(a){var b=a.replace(cb,db).toLowerCase();return"*"===a?function(){return!0}:function(a){return a.nodeName&&a.nodeName.toLowerCase()===b}},CLASS:function(a){var b=y[a+" "];return b||(b=new RegExp("(^|"+M+")"+a+"("+M+"|$)"))&&y(a,function(a){return b.test("string"==typeof a.className&&a.className||typeof a.getAttribute!==C&&a.getAttribute("class")||"")})},ATTR:function(a,b,c){return function(d){var e=fb.attr(d,a);return null==e?"!="===b:b?(e+="","="===b?e===c:"!="===b?e!==c:"^="===b?c&&0===e.indexOf(c):"*="===b?c&&e.indexOf(c)>-1:"$="===b?c&&e.slice(-c.length)===c:"~="===b?(" "+e+" ").indexOf(c)>-1:"|="===b?e===c||e.slice(0,c.length+1)===c+"-":!1):!0}},CHILD:function(a,b,c,d,e){var f="nth"!==a.slice(0,3),g="last"!==a.slice(-4),h="of-type"===b;return 1===d&&0===e?function(a){return!!a.parentNode}:function(b,c,i){var j,k,l,m,n,o,p=f!==g?"nextSibling":"previousSibling",q=b.parentNode,r=h&&b.nodeName.toLowerCase(),s=!i&&!h;if(q){if(f){while(p){l=b;while(l=l[p])if(h?l.nodeName.toLowerCase()===r:1===l.nodeType)return!1;o=p="only"===a&&!o&&"nextSibling"}return!0}if(o=[g?q.firstChild:q.lastChild],g&&s){k=q[u]||(q[u]={}),j=k[a]||[],n=j[0]===w&&j[1],m=j[0]===w&&j[2],l=n&&q.childNodes[n];while(l=++n&&l&&l[p]||(m=n=0)||o.pop())if(1===l.nodeType&&++m&&l===b){k[a]=[w,n,m];break}}else if(s&&(j=(b[u]||(b[u]={}))[a])&&j[0]===w)m=j[1];else while(l=++n&&l&&l[p]||(m=n=0)||o.pop())if((h?l.nodeName.toLowerCase()===r:1===l.nodeType)&&++m&&(s&&((l[u]||(l[u]={}))[a]=[w,m]),l===b))break;return m-=e,m===d||m%d===0&&m/d>=0}}},PSEUDO:function(a,b){var c,e=d.pseudos[a]||d.setFilters[a.toLowerCase()]||fb.error("unsupported pseudo: "+a);return e[u]?e(b):e.length>1?(c=[a,a,"",b],d.setFilters.hasOwnProperty(a.toLowerCase())?hb(function(a,c){var d,f=e(a,b),g=f.length;while(g--)d=K.call(a,f[g]),a[d]=!(c[d]=f[g])}):function(a){return e(a,0,c)}):e}},pseudos:{not:hb(function(a){var b=[],c=[],d=h(a.replace(R,"$1"));return d[u]?hb(function(a,b,c,e){var f,g=d(a,null,e,[]),h=a.length;while(h--)(f=g[h])&&(a[h]=!(b[h]=f))}):function(a,e,f){return b[0]=a,d(b,null,f,c),!c.pop()}}),has:hb(function(a){return function(b){return fb(a,b).length>0}}),contains:hb(function(a){return function(b){return(b.textContent||b.innerText||e(b)).indexOf(a)>-1}}),lang:hb(function(a){return W.test(a||"")||fb.error("unsupported lang: "+a),a=a.replace(cb,db).toLowerCase(),function(b){var c;do if(c=p?b.lang:b.getAttribute("xml:lang")||b.getAttribute("lang"))return c=c.toLowerCase(),c===a||0===c.indexOf(a+"-");while((b=b.parentNode)&&1===b.nodeType);return!1}}),target:function(b){var c=a.location&&a.location.hash;return c&&c.slice(1)===b.id},root:function(a){return a===o},focus:function(a){return a===n.activeElement&&(!n.hasFocus||n.hasFocus())&&!!(a.type||a.href||~a.tabIndex)},enabled:function(a){return a.disabled===!1},disabled:function(a){return a.disabled===!0},checked:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&!!a.checked||"option"===b&&!!a.selected},selected:function(a){return a.parentNode&&a.parentNode.selectedIndex,a.selected===!0},empty:function(a){for(a=a.firstChild;a;a=a.nextSibling)if(a.nodeType<6)return!1;return!0},parent:function(a){return!d.pseudos.empty(a)},header:function(a){return Z.test(a.nodeName)},input:function(a){return Y.test(a.nodeName)},button:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&"button"===a.type||"button"===b},text:function(a){var b;return"input"===a.nodeName.toLowerCase()&&"text"===a.type&&(null==(b=a.getAttribute("type"))||"text"===b.toLowerCase())},first:nb(function(){return[0]}),last:nb(function(a,b){return[b-1]}),eq:nb(function(a,b,c){return[0>c?c+b:c]}),even:nb(function(a,b){for(var c=0;b>c;c+=2)a.push(c);return a}),odd:nb(function(a,b){for(var c=1;b>c;c+=2)a.push(c);return a}),lt:nb(function(a,b,c){for(var d=0>c?c+b:c;--d>=0;)a.push(d);return a}),gt:nb(function(a,b,c){for(var d=0>c?c+b:c;++d<b;)a.push(d);return a})}},d.pseudos.nth=d.pseudos.eq;for(b in{radio:!0,checkbox:!0,file:!0,password:!0,image:!0})d.pseudos[b]=lb(b);for(b in{submit:!0,reset:!0})d.pseudos[b]=mb(b);function pb(){}pb.prototype=d.filters=d.pseudos,d.setFilters=new pb,g=fb.tokenize=function(a,b){var c,e,f,g,h,i,j,k=z[a+" "];if(k)return b?0:k.slice(0);h=a,i=[],j=d.preFilter;while(h){(!c||(e=S.exec(h)))&&(e&&(h=h.slice(e[0].length)||h),i.push(f=[])),c=!1,(e=T.exec(h))&&(c=e.shift(),f.push({value:c,type:e[0].replace(R," ")}),h=h.slice(c.length));for(g in d.filter)!(e=X[g].exec(h))||j[g]&&!(e=j[g](e))||(c=e.shift(),f.push({value:c,type:g,matches:e}),h=h.slice(c.length));if(!c)break}return b?h.length:h?fb.error(a):z(a,i).slice(0)};function qb(a){for(var b=0,c=a.length,d="";c>b;b++)d+=a[b].value;return d}function rb(a,b,c){var d=b.dir,e=c&&"parentNode"===d,f=x++;return b.first?function(b,c,f){while(b=b[d])if(1===b.nodeType||e)return a(b,c,f)}:function(b,c,g){var h,i,j=[w,f];if(g){while(b=b[d])if((1===b.nodeType||e)&&a(b,c,g))return!0}else while(b=b[d])if(1===b.nodeType||e){if(i=b[u]||(b[u]={}),(h=i[d])&&h[0]===w&&h[1]===f)return j[2]=h[2];if(i[d]=j,j[2]=a(b,c,g))return!0}}}function sb(a){return a.length>1?function(b,c,d){var e=a.length;while(e--)if(!a[e](b,c,d))return!1;return!0}:a[0]}function tb(a,b,c){for(var d=0,e=b.length;e>d;d++)fb(a,b[d],c);return c}function ub(a,b,c,d,e){for(var f,g=[],h=0,i=a.length,j=null!=b;i>h;h++)(f=a[h])&&(!c||c(f,d,e))&&(g.push(f),j&&b.push(h));return g}function vb(a,b,c,d,e,f){return d&&!d[u]&&(d=vb(d)),e&&!e[u]&&(e=vb(e,f)),hb(function(f,g,h,i){var j,k,l,m=[],n=[],o=g.length,p=f||tb(b||"*",h.nodeType?[h]:h,[]),q=!a||!f&&b?p:ub(p,m,a,h,i),r=c?e||(f?a:o||d)?[]:g:q;if(c&&c(q,r,h,i),d){j=ub(r,n),d(j,[],h,i),k=j.length;while(k--)(l=j[k])&&(r[n[k]]=!(q[n[k]]=l))}if(f){if(e||a){if(e){j=[],k=r.length;while(k--)(l=r[k])&&j.push(q[k]=l);e(null,r=[],j,i)}k=r.length;while(k--)(l=r[k])&&(j=e?K.call(f,l):m[k])>-1&&(f[j]=!(g[j]=l))}}else r=ub(r===g?r.splice(o,r.length):r),e?e(null,g,r,i):I.apply(g,r)})}function wb(a){for(var b,c,e,f=a.length,g=d.relative[a[0].type],h=g||d.relative[" "],i=g?1:0,k=rb(function(a){return a===b},h,!0),l=rb(function(a){return K.call(b,a)>-1},h,!0),m=[function(a,c,d){return!g&&(d||c!==j)||((b=c).nodeType?k(a,c,d):l(a,c,d))}];f>i;i++)if(c=d.relative[a[i].type])m=[rb(sb(m),c)];else{if(c=d.filter[a[i].type].apply(null,a[i].matches),c[u]){for(e=++i;f>e;e++)if(d.relative[a[e].type])break;return vb(i>1&&sb(m),i>1&&qb(a.slice(0,i-1).concat({value:" "===a[i-2].type?"*":""})).replace(R,"$1"),c,e>i&&wb(a.slice(i,e)),f>e&&wb(a=a.slice(e)),f>e&&qb(a))}m.push(c)}return sb(m)}function xb(a,b){var c=b.length>0,e=a.length>0,f=function(f,g,h,i,k){var l,m,o,p=0,q="0",r=f&&[],s=[],t=j,u=f||e&&d.find.TAG("*",k),v=w+=null==t?1:Math.random()||.1,x=u.length;for(k&&(j=g!==n&&g);q!==x&&null!=(l=u[q]);q++){if(e&&l){m=0;while(o=a[m++])if(o(l,g,h)){i.push(l);break}k&&(w=v)}c&&((l=!o&&l)&&p--,f&&r.push(l))}if(p+=q,c&&q!==p){m=0;while(o=b[m++])o(r,s,g,h);if(f){if(p>0)while(q--)r[q]||s[q]||(s[q]=G.call(i));s=ub(s)}I.apply(i,s),k&&!f&&s.length>0&&p+b.length>1&&fb.uniqueSort(i)}return k&&(w=v,j=t),r};return c?hb(f):f}return h=fb.compile=function(a,b){var c,d=[],e=[],f=A[a+" "];if(!f){b||(b=g(a)),c=b.length;while(c--)f=wb(b[c]),f[u]?d.push(f):e.push(f);f=A(a,xb(e,d)),f.selector=a}return f},i=fb.select=function(a,b,e,f){var i,j,k,l,m,n="function"==typeof a&&a,o=!f&&g(a=n.selector||a);if(e=e||[],1===o.length){if(j=o[0]=o[0].slice(0),j.length>2&&"ID"===(k=j[0]).type&&c.getById&&9===b.nodeType&&p&&d.relative[j[1].type]){if(b=(d.find.ID(k.matches[0].replace(cb,db),b)||[])[0],!b)return e;n&&(b=b.parentNode),a=a.slice(j.shift().value.length)}i=X.needsContext.test(a)?0:j.length;while(i--){if(k=j[i],d.relative[l=k.type])break;if((m=d.find[l])&&(f=m(k.matches[0].replace(cb,db),ab.test(j[0].type)&&ob(b.parentNode)||b))){if(j.splice(i,1),a=f.length&&qb(j),!a)return I.apply(e,f),e;break}}}return(n||h(a,o))(f,b,!p,e,ab.test(a)&&ob(b.parentNode)||b),e},c.sortStable=u.split("").sort(B).join("")===u,c.detectDuplicates=!!l,m(),c.sortDetached=ib(function(a){return 1&a.compareDocumentPosition(n.createElement("div"))}),ib(function(a){return a.innerHTML="<a href='#'></a>","#"===a.firstChild.getAttribute("href")})||jb("type|href|height|width",function(a,b,c){return c?void 0:a.getAttribute(b,"type"===b.toLowerCase()?1:2)}),c.attributes&&ib(function(a){return a.innerHTML="<input/>",a.firstChild.setAttribute("value",""),""===a.firstChild.getAttribute("value")})||jb("value",function(a,b,c){return c||"input"!==a.nodeName.toLowerCase()?void 0:a.defaultValue}),ib(function(a){return null==a.getAttribute("disabled")})||jb(L,function(a,b,c){var d;return c?void 0:a[b]===!0?b.toLowerCase():(d=a.getAttributeNode(b))&&d.specified?d.value:null}),fb}(a);n.find=t,n.expr=t.selectors,n.expr[":"]=n.expr.pseudos,n.unique=t.uniqueSort,n.text=t.getText,n.isXMLDoc=t.isXML,n.contains=t.contains;var u=n.expr.match.needsContext,v=/^<(\w+)\s*\/?>(?:<\/\1>|)$/,w=/^.[^:#\[\.,]*$/;function x(a,b,c){if(n.isFunction(b))return n.grep(a,function(a,d){return!!b.call(a,d,a)!==c});if(b.nodeType)return n.grep(a,function(a){return a===b!==c});if("string"==typeof b){if(w.test(b))return n.filter(b,a,c);b=n.filter(b,a)}return n.grep(a,function(a){return g.call(b,a)>=0!==c})}n.filter=function(a,b,c){var d=b[0];return c&&(a=":not("+a+")"),1===b.length&&1===d.nodeType?n.find.matchesSelector(d,a)?[d]:[]:n.find.matches(a,n.grep(b,function(a){return 1===a.nodeType}))},n.fn.extend({find:function(a){var b,c=this.length,d=[],e=this;if("string"!=typeof a)return this.pushStack(n(a).filter(function(){for(b=0;c>b;b++)if(n.contains(e[b],this))return!0}));for(b=0;c>b;b++)n.find(a,e[b],d);return d=this.pushStack(c>1?n.unique(d):d),d.selector=this.selector?this.selector+" "+a:a,d},filter:function(a){return this.pushStack(x(this,a||[],!1))},not:function(a){return this.pushStack(x(this,a||[],!0))},is:function(a){return!!x(this,"string"==typeof a&&u.test(a)?n(a):a||[],!1).length}});var y,z=/^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]*))$/,A=n.fn.init=function(a,b){var c,d;if(!a)return this;if("string"==typeof a){if(c="<"===a[0]&&">"===a[a.length-1]&&a.length>=3?[null,a,null]:z.exec(a),!c||!c[1]&&b)return!b||b.jquery?(b||y).find(a):this.constructor(b).find(a);if(c[1]){if(b=b instanceof n?b[0]:b,n.merge(this,n.parseHTML(c[1],b&&b.nodeType?b.ownerDocument||b:l,!0)),v.test(c[1])&&n.isPlainObject(b))for(c in b)n.isFunction(this[c])?this[c](b[c]):this.attr(c,b[c]);return this}return d=l.getElementById(c[2]),d&&d.parentNode&&(this.length=1,this[0]=d),this.context=l,this.selector=a,this}return a.nodeType?(this.context=this[0]=a,this.length=1,this):n.isFunction(a)?"undefined"!=typeof y.ready?y.ready(a):a(n):(void 0!==a.selector&&(this.selector=a.selector,this.context=a.context),n.makeArray(a,this))};A.prototype=n.fn,y=n(l);var B=/^(?:parents|prev(?:Until|All))/,C={children:!0,contents:!0,next:!0,prev:!0};n.extend({dir:function(a,b,c){var d=[],e=void 0!==c;while((a=a[b])&&9!==a.nodeType)if(1===a.nodeType){if(e&&n(a).is(c))break;d.push(a)}return d},sibling:function(a,b){for(var c=[];a;a=a.nextSibling)1===a.nodeType&&a!==b&&c.push(a);return c}}),n.fn.extend({has:function(a){var b=n(a,this),c=b.length;return this.filter(function(){for(var a=0;c>a;a++)if(n.contains(this,b[a]))return!0})},closest:function(a,b){for(var c,d=0,e=this.length,f=[],g=u.test(a)||"string"!=typeof a?n(a,b||this.context):0;e>d;d++)for(c=this[d];c&&c!==b;c=c.parentNode)if(c.nodeType<11&&(g?g.index(c)>-1:1===c.nodeType&&n.find.matchesSelector(c,a))){f.push(c);break}return this.pushStack(f.length>1?n.unique(f):f)},index:function(a){return a?"string"==typeof a?g.call(n(a),this[0]):g.call(this,a.jquery?a[0]:a):this[0]&&this[0].parentNode?this.first().prevAll().length:-1},add:function(a,b){return this.pushStack(n.unique(n.merge(this.get(),n(a,b))))},addBack:function(a){return this.add(null==a?this.prevObject:this.prevObject.filter(a))}});function D(a,b){while((a=a[b])&&1!==a.nodeType);return a}n.each({parent:function(a){var b=a.parentNode;return b&&11!==b.nodeType?b:null},parents:function(a){return n.dir(a,"parentNode")},parentsUntil:function(a,b,c){return n.dir(a,"parentNode",c)},next:function(a){return D(a,"nextSibling")},prev:function(a){return D(a,"previousSibling")},nextAll:function(a){return n.dir(a,"nextSibling")},prevAll:function(a){return n.dir(a,"previousSibling")},nextUntil:function(a,b,c){return n.dir(a,"nextSibling",c)},prevUntil:function(a,b,c){return n.dir(a,"previousSibling",c)},siblings:function(a){return n.sibling((a.parentNode||{}).firstChild,a)},children:function(a){return n.sibling(a.firstChild)},contents:function(a){return a.contentDocument||n.merge([],a.childNodes)}},function(a,b){n.fn[a]=function(c,d){var e=n.map(this,b,c);return"Until"!==a.slice(-5)&&(d=c),d&&"string"==typeof d&&(e=n.filter(d,e)),this.length>1&&(C[a]||n.unique(e),B.test(a)&&e.reverse()),this.pushStack(e)}});var E=/\S+/g,F={};function G(a){var b=F[a]={};return n.each(a.match(E)||[],function(a,c){b[c]=!0}),b}n.Callbacks=function(a){a="string"==typeof a?F[a]||G(a):n.extend({},a);var b,c,d,e,f,g,h=[],i=!a.once&&[],j=function(l){for(b=a.memory&&l,c=!0,g=e||0,e=0,f=h.length,d=!0;h&&f>g;g++)if(h[g].apply(l[0],l[1])===!1&&a.stopOnFalse){b=!1;break}d=!1,h&&(i?i.length&&j(i.shift()):b?h=[]:k.disable())},k={add:function(){if(h){var c=h.length;!function g(b){n.each(b,function(b,c){var d=n.type(c);"function"===d?a.unique&&k.has(c)||h.push(c):c&&c.length&&"string"!==d&&g(c)})}(arguments),d?f=h.length:b&&(e=c,j(b))}return this},remove:function(){return h&&n.each(arguments,function(a,b){var c;while((c=n.inArray(b,h,c))>-1)h.splice(c,1),d&&(f>=c&&f--,g>=c&&g--)}),this},has:function(a){return a?n.inArray(a,h)>-1:!(!h||!h.length)},empty:function(){return h=[],f=0,this},disable:function(){return h=i=b=void 0,this},disabled:function(){return!h},lock:function(){return i=void 0,b||k.disable(),this},locked:function(){return!i},fireWith:function(a,b){return!h||c&&!i||(b=b||[],b=[a,b.slice?b.slice():b],d?i.push(b):j(b)),this},fire:function(){return k.fireWith(this,arguments),this},fired:function(){return!!c}};return k},n.extend({Deferred:function(a){var b=[["resolve","done",n.Callbacks("once memory"),"resolved"],["reject","fail",n.Callbacks("once memory"),"rejected"],["notify","progress",n.Callbacks("memory")]],c="pending",d={state:function(){return c},always:function(){return e.done(arguments).fail(arguments),this},then:function(){var a=arguments;return n.Deferred(function(c){n.each(b,function(b,f){var g=n.isFunction(a[b])&&a[b];e[f[1]](function(){var a=g&&g.apply(this,arguments);a&&n.isFunction(a.promise)?a.promise().done(c.resolve).fail(c.reject).progress(c.notify):c[f[0]+"With"](this===d?c.promise():this,g?[a]:arguments)})}),a=null}).promise()},promise:function(a){return null!=a?n.extend(a,d):d}},e={};return d.pipe=d.then,n.each(b,function(a,f){var g=f[2],h=f[3];d[f[1]]=g.add,h&&g.add(function(){c=h},b[1^a][2].disable,b[2][2].lock),e[f[0]]=function(){return e[f[0]+"With"](this===e?d:this,arguments),this},e[f[0]+"With"]=g.fireWith}),d.promise(e),a&&a.call(e,e),e},when:function(a){var b=0,c=d.call(arguments),e=c.length,f=1!==e||a&&n.isFunction(a.promise)?e:0,g=1===f?a:n.Deferred(),h=function(a,b,c){return function(e){b[a]=this,c[a]=arguments.length>1?d.call(arguments):e,c===i?g.notifyWith(b,c):--f||g.resolveWith(b,c)}},i,j,k;if(e>1)for(i=new Array(e),j=new Array(e),k=new Array(e);e>b;b++)c[b]&&n.isFunction(c[b].promise)?c[b].promise().done(h(b,k,c)).fail(g.reject).progress(h(b,j,i)):--f;return f||g.resolveWith(k,c),g.promise()}});var H;n.fn.ready=function(a){return n.ready.promise().done(a),this},n.extend({isReady:!1,readyWait:1,holdReady:function(a){a?n.readyWait++:n.ready(!0)},ready:function(a){(a===!0?--n.readyWait:n.isReady)||(n.isReady=!0,a!==!0&&--n.readyWait>0||(H.resolveWith(l,[n]),n.fn.triggerHandler&&(n(l).triggerHandler("ready"),n(l).off("ready"))))}});function I(){l.removeEventListener("DOMContentLoaded",I,!1),a.removeEventListener("load",I,!1),n.ready()}n.ready.promise=function(b){return H||(H=n.Deferred(),"complete"===l.readyState?setTimeout(n.ready):(l.addEventListener("DOMContentLoaded",I,!1),a.addEventListener("load",I,!1))),H.promise(b)},n.ready.promise();var J=n.access=function(a,b,c,d,e,f,g){var h=0,i=a.length,j=null==c;if("object"===n.type(c)){e=!0;for(h in c)n.access(a,b,h,c[h],!0,f,g)}else if(void 0!==d&&(e=!0,n.isFunction(d)||(g=!0),j&&(g?(b.call(a,d),b=null):(j=b,b=function(a,b,c){return j.call(n(a),c)})),b))for(;i>h;h++)b(a[h],c,g?d:d.call(a[h],h,b(a[h],c)));return e?a:j?b.call(a):i?b(a[0],c):f};n.acceptData=function(a){return 1===a.nodeType||9===a.nodeType||!+a.nodeType};function K(){Object.defineProperty(this.cache={},0,{get:function(){return{}}}),this.expando=n.expando+Math.random()}K.uid=1,K.accepts=n.acceptData,K.prototype={key:function(a){if(!K.accepts(a))return 0;var b={},c=a[this.expando];if(!c){c=K.uid++;try{b[this.expando]={value:c},Object.defineProperties(a,b)}catch(d){b[this.expando]=c,n.extend(a,b)}}return this.cache[c]||(this.cache[c]={}),c},set:function(a,b,c){var d,e=this.key(a),f=this.cache[e];if("string"==typeof b)f[b]=c;else if(n.isEmptyObject(f))n.extend(this.cache[e],b);else for(d in b)f[d]=b[d];return f},get:function(a,b){var c=this.cache[this.key(a)];return void 0===b?c:c[b]},access:function(a,b,c){var d;return void 0===b||b&&"string"==typeof b&&void 0===c?(d=this.get(a,b),void 0!==d?d:this.get(a,n.camelCase(b))):(this.set(a,b,c),void 0!==c?c:b)},remove:function(a,b){var c,d,e,f=this.key(a),g=this.cache[f];if(void 0===b)this.cache[f]={};else{n.isArray(b)?d=b.concat(b.map(n.camelCase)):(e=n.camelCase(b),b in g?d=[b,e]:(d=e,d=d in g?[d]:d.match(E)||[])),c=d.length;while(c--)delete g[d[c]]}},hasData:function(a){return!n.isEmptyObject(this.cache[a[this.expando]]||{})},discard:function(a){a[this.expando]&&delete this.cache[a[this.expando]]}};var L=new K,M=new K,N=/^(?:\{[\w\W]*\}|\[[\w\W]*\])$/,O=/([A-Z])/g;function P(a,b,c){var d;if(void 0===c&&1===a.nodeType)if(d="data-"+b.replace(O,"-$1").toLowerCase(),c=a.getAttribute(d),"string"==typeof c){try{c="true"===c?!0:"false"===c?!1:"null"===c?null:+c+""===c?+c:N.test(c)?n.parseJSON(c):c}catch(e){}M.set(a,b,c)}else c=void 0;return c}n.extend({hasData:function(a){return M.hasData(a)||L.hasData(a)},data:function(a,b,c){return M.access(a,b,c)},removeData:function(a,b){M.remove(a,b) | ||
| 3 | },_data:function(a,b,c){return L.access(a,b,c)},_removeData:function(a,b){L.remove(a,b)}}),n.fn.extend({data:function(a,b){var c,d,e,f=this[0],g=f&&f.attributes;if(void 0===a){if(this.length&&(e=M.get(f),1===f.nodeType&&!L.get(f,"hasDataAttrs"))){c=g.length;while(c--)g[c]&&(d=g[c].name,0===d.indexOf("data-")&&(d=n.camelCase(d.slice(5)),P(f,d,e[d])));L.set(f,"hasDataAttrs",!0)}return e}return"object"==typeof a?this.each(function(){M.set(this,a)}):J(this,function(b){var c,d=n.camelCase(a);if(f&&void 0===b){if(c=M.get(f,a),void 0!==c)return c;if(c=M.get(f,d),void 0!==c)return c;if(c=P(f,d,void 0),void 0!==c)return c}else this.each(function(){var c=M.get(this,d);M.set(this,d,b),-1!==a.indexOf("-")&&void 0!==c&&M.set(this,a,b)})},null,b,arguments.length>1,null,!0)},removeData:function(a){return this.each(function(){M.remove(this,a)})}}),n.extend({queue:function(a,b,c){var d;return a?(b=(b||"fx")+"queue",d=L.get(a,b),c&&(!d||n.isArray(c)?d=L.access(a,b,n.makeArray(c)):d.push(c)),d||[]):void 0},dequeue:function(a,b){b=b||"fx";var c=n.queue(a,b),d=c.length,e=c.shift(),f=n._queueHooks(a,b),g=function(){n.dequeue(a,b)};"inprogress"===e&&(e=c.shift(),d--),e&&("fx"===b&&c.unshift("inprogress"),delete f.stop,e.call(a,g,f)),!d&&f&&f.empty.fire()},_queueHooks:function(a,b){var c=b+"queueHooks";return L.get(a,c)||L.access(a,c,{empty:n.Callbacks("once memory").add(function(){L.remove(a,[b+"queue",c])})})}}),n.fn.extend({queue:function(a,b){var c=2;return"string"!=typeof a&&(b=a,a="fx",c--),arguments.length<c?n.queue(this[0],a):void 0===b?this:this.each(function(){var c=n.queue(this,a,b);n._queueHooks(this,a),"fx"===a&&"inprogress"!==c[0]&&n.dequeue(this,a)})},dequeue:function(a){return this.each(function(){n.dequeue(this,a)})},clearQueue:function(a){return this.queue(a||"fx",[])},promise:function(a,b){var c,d=1,e=n.Deferred(),f=this,g=this.length,h=function(){--d||e.resolveWith(f,[f])};"string"!=typeof a&&(b=a,a=void 0),a=a||"fx";while(g--)c=L.get(f[g],a+"queueHooks"),c&&c.empty&&(d++,c.empty.add(h));return h(),e.promise(b)}});var Q=/[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/.source,R=["Top","Right","Bottom","Left"],S=function(a,b){return a=b||a,"none"===n.css(a,"display")||!n.contains(a.ownerDocument,a)},T=/^(?:checkbox|radio)$/i;!function(){var a=l.createDocumentFragment(),b=a.appendChild(l.createElement("div")),c=l.createElement("input");c.setAttribute("type","radio"),c.setAttribute("checked","checked"),c.setAttribute("name","t"),b.appendChild(c),k.checkClone=b.cloneNode(!0).cloneNode(!0).lastChild.checked,b.innerHTML="<textarea>x</textarea>",k.noCloneChecked=!!b.cloneNode(!0).lastChild.defaultValue}();var U="undefined";k.focusinBubbles="onfocusin"in a;var V=/^key/,W=/^(?:mouse|pointer|contextmenu)|click/,X=/^(?:focusinfocus|focusoutblur)$/,Y=/^([^.]*)(?:\.(.+)|)$/;function Z(){return!0}function $(){return!1}function _(){try{return l.activeElement}catch(a){}}n.event={global:{},add:function(a,b,c,d,e){var f,g,h,i,j,k,l,m,o,p,q,r=L.get(a);if(r){c.handler&&(f=c,c=f.handler,e=f.selector),c.guid||(c.guid=n.guid++),(i=r.events)||(i=r.events={}),(g=r.handle)||(g=r.handle=function(b){return typeof n!==U&&n.event.triggered!==b.type?n.event.dispatch.apply(a,arguments):void 0}),b=(b||"").match(E)||[""],j=b.length;while(j--)h=Y.exec(b[j])||[],o=q=h[1],p=(h[2]||"").split(".").sort(),o&&(l=n.event.special[o]||{},o=(e?l.delegateType:l.bindType)||o,l=n.event.special[o]||{},k=n.extend({type:o,origType:q,data:d,handler:c,guid:c.guid,selector:e,needsContext:e&&n.expr.match.needsContext.test(e),namespace:p.join(".")},f),(m=i[o])||(m=i[o]=[],m.delegateCount=0,l.setup&&l.setup.call(a,d,p,g)!==!1||a.addEventListener&&a.addEventListener(o,g,!1)),l.add&&(l.add.call(a,k),k.handler.guid||(k.handler.guid=c.guid)),e?m.splice(m.delegateCount++,0,k):m.push(k),n.event.global[o]=!0)}},remove:function(a,b,c,d,e){var f,g,h,i,j,k,l,m,o,p,q,r=L.hasData(a)&&L.get(a);if(r&&(i=r.events)){b=(b||"").match(E)||[""],j=b.length;while(j--)if(h=Y.exec(b[j])||[],o=q=h[1],p=(h[2]||"").split(".").sort(),o){l=n.event.special[o]||{},o=(d?l.delegateType:l.bindType)||o,m=i[o]||[],h=h[2]&&new RegExp("(^|\\.)"+p.join("\\.(?:.*\\.|)")+"(\\.|$)"),g=f=m.length;while(f--)k=m[f],!e&&q!==k.origType||c&&c.guid!==k.guid||h&&!h.test(k.namespace)||d&&d!==k.selector&&("**"!==d||!k.selector)||(m.splice(f,1),k.selector&&m.delegateCount--,l.remove&&l.remove.call(a,k));g&&!m.length&&(l.teardown&&l.teardown.call(a,p,r.handle)!==!1||n.removeEvent(a,o,r.handle),delete i[o])}else for(o in i)n.event.remove(a,o+b[j],c,d,!0);n.isEmptyObject(i)&&(delete r.handle,L.remove(a,"events"))}},trigger:function(b,c,d,e){var f,g,h,i,k,m,o,p=[d||l],q=j.call(b,"type")?b.type:b,r=j.call(b,"namespace")?b.namespace.split("."):[];if(g=h=d=d||l,3!==d.nodeType&&8!==d.nodeType&&!X.test(q+n.event.triggered)&&(q.indexOf(".")>=0&&(r=q.split("."),q=r.shift(),r.sort()),k=q.indexOf(":")<0&&"on"+q,b=b[n.expando]?b:new n.Event(q,"object"==typeof b&&b),b.isTrigger=e?2:3,b.namespace=r.join("."),b.namespace_re=b.namespace?new RegExp("(^|\\.)"+r.join("\\.(?:.*\\.|)")+"(\\.|$)"):null,b.result=void 0,b.target||(b.target=d),c=null==c?[b]:n.makeArray(c,[b]),o=n.event.special[q]||{},e||!o.trigger||o.trigger.apply(d,c)!==!1)){if(!e&&!o.noBubble&&!n.isWindow(d)){for(i=o.delegateType||q,X.test(i+q)||(g=g.parentNode);g;g=g.parentNode)p.push(g),h=g;h===(d.ownerDocument||l)&&p.push(h.defaultView||h.parentWindow||a)}f=0;while((g=p[f++])&&!b.isPropagationStopped())b.type=f>1?i:o.bindType||q,m=(L.get(g,"events")||{})[b.type]&&L.get(g,"handle"),m&&m.apply(g,c),m=k&&g[k],m&&m.apply&&n.acceptData(g)&&(b.result=m.apply(g,c),b.result===!1&&b.preventDefault());return b.type=q,e||b.isDefaultPrevented()||o._default&&o._default.apply(p.pop(),c)!==!1||!n.acceptData(d)||k&&n.isFunction(d[q])&&!n.isWindow(d)&&(h=d[k],h&&(d[k]=null),n.event.triggered=q,d[q](),n.event.triggered=void 0,h&&(d[k]=h)),b.result}},dispatch:function(a){a=n.event.fix(a);var b,c,e,f,g,h=[],i=d.call(arguments),j=(L.get(this,"events")||{})[a.type]||[],k=n.event.special[a.type]||{};if(i[0]=a,a.delegateTarget=this,!k.preDispatch||k.preDispatch.call(this,a)!==!1){h=n.event.handlers.call(this,a,j),b=0;while((f=h[b++])&&!a.isPropagationStopped()){a.currentTarget=f.elem,c=0;while((g=f.handlers[c++])&&!a.isImmediatePropagationStopped())(!a.namespace_re||a.namespace_re.test(g.namespace))&&(a.handleObj=g,a.data=g.data,e=((n.event.special[g.origType]||{}).handle||g.handler).apply(f.elem,i),void 0!==e&&(a.result=e)===!1&&(a.preventDefault(),a.stopPropagation()))}return k.postDispatch&&k.postDispatch.call(this,a),a.result}},handlers:function(a,b){var c,d,e,f,g=[],h=b.delegateCount,i=a.target;if(h&&i.nodeType&&(!a.button||"click"!==a.type))for(;i!==this;i=i.parentNode||this)if(i.disabled!==!0||"click"!==a.type){for(d=[],c=0;h>c;c++)f=b[c],e=f.selector+" ",void 0===d[e]&&(d[e]=f.needsContext?n(e,this).index(i)>=0:n.find(e,this,null,[i]).length),d[e]&&d.push(f);d.length&&g.push({elem:i,handlers:d})}return h<b.length&&g.push({elem:this,handlers:b.slice(h)}),g},props:"altKey bubbles cancelable ctrlKey currentTarget eventPhase metaKey relatedTarget shiftKey target timeStamp view which".split(" "),fixHooks:{},keyHooks:{props:"char charCode key keyCode".split(" "),filter:function(a,b){return null==a.which&&(a.which=null!=b.charCode?b.charCode:b.keyCode),a}},mouseHooks:{props:"button buttons clientX clientY offsetX offsetY pageX pageY screenX screenY toElement".split(" "),filter:function(a,b){var c,d,e,f=b.button;return null==a.pageX&&null!=b.clientX&&(c=a.target.ownerDocument||l,d=c.documentElement,e=c.body,a.pageX=b.clientX+(d&&d.scrollLeft||e&&e.scrollLeft||0)-(d&&d.clientLeft||e&&e.clientLeft||0),a.pageY=b.clientY+(d&&d.scrollTop||e&&e.scrollTop||0)-(d&&d.clientTop||e&&e.clientTop||0)),a.which||void 0===f||(a.which=1&f?1:2&f?3:4&f?2:0),a}},fix:function(a){if(a[n.expando])return a;var b,c,d,e=a.type,f=a,g=this.fixHooks[e];g||(this.fixHooks[e]=g=W.test(e)?this.mouseHooks:V.test(e)?this.keyHooks:{}),d=g.props?this.props.concat(g.props):this.props,a=new n.Event(f),b=d.length;while(b--)c=d[b],a[c]=f[c];return a.target||(a.target=l),3===a.target.nodeType&&(a.target=a.target.parentNode),g.filter?g.filter(a,f):a},special:{load:{noBubble:!0},focus:{trigger:function(){return this!==_()&&this.focus?(this.focus(),!1):void 0},delegateType:"focusin"},blur:{trigger:function(){return this===_()&&this.blur?(this.blur(),!1):void 0},delegateType:"focusout"},click:{trigger:function(){return"checkbox"===this.type&&this.click&&n.nodeName(this,"input")?(this.click(),!1):void 0},_default:function(a){return n.nodeName(a.target,"a")}},beforeunload:{postDispatch:function(a){void 0!==a.result&&a.originalEvent&&(a.originalEvent.returnValue=a.result)}}},simulate:function(a,b,c,d){var e=n.extend(new n.Event,c,{type:a,isSimulated:!0,originalEvent:{}});d?n.event.trigger(e,null,b):n.event.dispatch.call(b,e),e.isDefaultPrevented()&&c.preventDefault()}},n.removeEvent=function(a,b,c){a.removeEventListener&&a.removeEventListener(b,c,!1)},n.Event=function(a,b){return this instanceof n.Event?(a&&a.type?(this.originalEvent=a,this.type=a.type,this.isDefaultPrevented=a.defaultPrevented||void 0===a.defaultPrevented&&a.returnValue===!1?Z:$):this.type=a,b&&n.extend(this,b),this.timeStamp=a&&a.timeStamp||n.now(),void(this[n.expando]=!0)):new n.Event(a,b)},n.Event.prototype={isDefaultPrevented:$,isPropagationStopped:$,isImmediatePropagationStopped:$,preventDefault:function(){var a=this.originalEvent;this.isDefaultPrevented=Z,a&&a.preventDefault&&a.preventDefault()},stopPropagation:function(){var a=this.originalEvent;this.isPropagationStopped=Z,a&&a.stopPropagation&&a.stopPropagation()},stopImmediatePropagation:function(){var a=this.originalEvent;this.isImmediatePropagationStopped=Z,a&&a.stopImmediatePropagation&&a.stopImmediatePropagation(),this.stopPropagation()}},n.each({mouseenter:"mouseover",mouseleave:"mouseout",pointerenter:"pointerover",pointerleave:"pointerout"},function(a,b){n.event.special[a]={delegateType:b,bindType:b,handle:function(a){var c,d=this,e=a.relatedTarget,f=a.handleObj;return(!e||e!==d&&!n.contains(d,e))&&(a.type=f.origType,c=f.handler.apply(this,arguments),a.type=b),c}}}),k.focusinBubbles||n.each({focus:"focusin",blur:"focusout"},function(a,b){var c=function(a){n.event.simulate(b,a.target,n.event.fix(a),!0)};n.event.special[b]={setup:function(){var d=this.ownerDocument||this,e=L.access(d,b);e||d.addEventListener(a,c,!0),L.access(d,b,(e||0)+1)},teardown:function(){var d=this.ownerDocument||this,e=L.access(d,b)-1;e?L.access(d,b,e):(d.removeEventListener(a,c,!0),L.remove(d,b))}}}),n.fn.extend({on:function(a,b,c,d,e){var f,g;if("object"==typeof a){"string"!=typeof b&&(c=c||b,b=void 0);for(g in a)this.on(g,b,c,a[g],e);return this}if(null==c&&null==d?(d=b,c=b=void 0):null==d&&("string"==typeof b?(d=c,c=void 0):(d=c,c=b,b=void 0)),d===!1)d=$;else if(!d)return this;return 1===e&&(f=d,d=function(a){return n().off(a),f.apply(this,arguments)},d.guid=f.guid||(f.guid=n.guid++)),this.each(function(){n.event.add(this,a,d,c,b)})},one:function(a,b,c,d){return this.on(a,b,c,d,1)},off:function(a,b,c){var d,e;if(a&&a.preventDefault&&a.handleObj)return d=a.handleObj,n(a.delegateTarget).off(d.namespace?d.origType+"."+d.namespace:d.origType,d.selector,d.handler),this;if("object"==typeof a){for(e in a)this.off(e,b,a[e]);return this}return(b===!1||"function"==typeof b)&&(c=b,b=void 0),c===!1&&(c=$),this.each(function(){n.event.remove(this,a,c,b)})},trigger:function(a,b){return this.each(function(){n.event.trigger(a,b,this)})},triggerHandler:function(a,b){var c=this[0];return c?n.event.trigger(a,b,c,!0):void 0}});var ab=/<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/gi,bb=/<([\w:]+)/,cb=/<|&#?\w+;/,db=/<(?:script|style|link)/i,eb=/checked\s*(?:[^=]|=\s*.checked.)/i,fb=/^$|\/(?:java|ecma)script/i,gb=/^true\/(.*)/,hb=/^\s*<!(?:\[CDATA\[|--)|(?:\]\]|--)>\s*$/g,ib={option:[1,"<select multiple='multiple'>","</select>"],thead:[1,"<table>","</table>"],col:[2,"<table><colgroup>","</colgroup></table>"],tr:[2,"<table><tbody>","</tbody></table>"],td:[3,"<table><tbody><tr>","</tr></tbody></table>"],_default:[0,"",""]};ib.optgroup=ib.option,ib.tbody=ib.tfoot=ib.colgroup=ib.caption=ib.thead,ib.th=ib.td;function jb(a,b){return n.nodeName(a,"table")&&n.nodeName(11!==b.nodeType?b:b.firstChild,"tr")?a.getElementsByTagName("tbody")[0]||a.appendChild(a.ownerDocument.createElement("tbody")):a}function kb(a){return a.type=(null!==a.getAttribute("type"))+"/"+a.type,a}function lb(a){var b=gb.exec(a.type);return b?a.type=b[1]:a.removeAttribute("type"),a}function mb(a,b){for(var c=0,d=a.length;d>c;c++)L.set(a[c],"globalEval",!b||L.get(b[c],"globalEval"))}function nb(a,b){var c,d,e,f,g,h,i,j;if(1===b.nodeType){if(L.hasData(a)&&(f=L.access(a),g=L.set(b,f),j=f.events)){delete g.handle,g.events={};for(e in j)for(c=0,d=j[e].length;d>c;c++)n.event.add(b,e,j[e][c])}M.hasData(a)&&(h=M.access(a),i=n.extend({},h),M.set(b,i))}}function ob(a,b){var c=a.getElementsByTagName?a.getElementsByTagName(b||"*"):a.querySelectorAll?a.querySelectorAll(b||"*"):[];return void 0===b||b&&n.nodeName(a,b)?n.merge([a],c):c}function pb(a,b){var c=b.nodeName.toLowerCase();"input"===c&&T.test(a.type)?b.checked=a.checked:("input"===c||"textarea"===c)&&(b.defaultValue=a.defaultValue)}n.extend({clone:function(a,b,c){var d,e,f,g,h=a.cloneNode(!0),i=n.contains(a.ownerDocument,a);if(!(k.noCloneChecked||1!==a.nodeType&&11!==a.nodeType||n.isXMLDoc(a)))for(g=ob(h),f=ob(a),d=0,e=f.length;e>d;d++)pb(f[d],g[d]);if(b)if(c)for(f=f||ob(a),g=g||ob(h),d=0,e=f.length;e>d;d++)nb(f[d],g[d]);else nb(a,h);return g=ob(h,"script"),g.length>0&&mb(g,!i&&ob(a,"script")),h},buildFragment:function(a,b,c,d){for(var e,f,g,h,i,j,k=b.createDocumentFragment(),l=[],m=0,o=a.length;o>m;m++)if(e=a[m],e||0===e)if("object"===n.type(e))n.merge(l,e.nodeType?[e]:e);else if(cb.test(e)){f=f||k.appendChild(b.createElement("div")),g=(bb.exec(e)||["",""])[1].toLowerCase(),h=ib[g]||ib._default,f.innerHTML=h[1]+e.replace(ab,"<$1></$2>")+h[2],j=h[0];while(j--)f=f.lastChild;n.merge(l,f.childNodes),f=k.firstChild,f.textContent=""}else l.push(b.createTextNode(e));k.textContent="",m=0;while(e=l[m++])if((!d||-1===n.inArray(e,d))&&(i=n.contains(e.ownerDocument,e),f=ob(k.appendChild(e),"script"),i&&mb(f),c)){j=0;while(e=f[j++])fb.test(e.type||"")&&c.push(e)}return k},cleanData:function(a){for(var b,c,d,e,f=n.event.special,g=0;void 0!==(c=a[g]);g++){if(n.acceptData(c)&&(e=c[L.expando],e&&(b=L.cache[e]))){if(b.events)for(d in b.events)f[d]?n.event.remove(c,d):n.removeEvent(c,d,b.handle);L.cache[e]&&delete L.cache[e]}delete M.cache[c[M.expando]]}}}),n.fn.extend({text:function(a){return J(this,function(a){return void 0===a?n.text(this):this.empty().each(function(){(1===this.nodeType||11===this.nodeType||9===this.nodeType)&&(this.textContent=a)})},null,a,arguments.length)},append:function(){return this.domManip(arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=jb(this,a);b.appendChild(a)}})},prepend:function(){return this.domManip(arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=jb(this,a);b.insertBefore(a,b.firstChild)}})},before:function(){return this.domManip(arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this)})},after:function(){return this.domManip(arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this.nextSibling)})},remove:function(a,b){for(var c,d=a?n.filter(a,this):this,e=0;null!=(c=d[e]);e++)b||1!==c.nodeType||n.cleanData(ob(c)),c.parentNode&&(b&&n.contains(c.ownerDocument,c)&&mb(ob(c,"script")),c.parentNode.removeChild(c));return this},empty:function(){for(var a,b=0;null!=(a=this[b]);b++)1===a.nodeType&&(n.cleanData(ob(a,!1)),a.textContent="");return this},clone:function(a,b){return a=null==a?!1:a,b=null==b?a:b,this.map(function(){return n.clone(this,a,b)})},html:function(a){return J(this,function(a){var b=this[0]||{},c=0,d=this.length;if(void 0===a&&1===b.nodeType)return b.innerHTML;if("string"==typeof a&&!db.test(a)&&!ib[(bb.exec(a)||["",""])[1].toLowerCase()]){a=a.replace(ab,"<$1></$2>");try{for(;d>c;c++)b=this[c]||{},1===b.nodeType&&(n.cleanData(ob(b,!1)),b.innerHTML=a);b=0}catch(e){}}b&&this.empty().append(a)},null,a,arguments.length)},replaceWith:function(){var a=arguments[0];return this.domManip(arguments,function(b){a=this.parentNode,n.cleanData(ob(this)),a&&a.replaceChild(b,this)}),a&&(a.length||a.nodeType)?this:this.remove()},detach:function(a){return this.remove(a,!0)},domManip:function(a,b){a=e.apply([],a);var c,d,f,g,h,i,j=0,l=this.length,m=this,o=l-1,p=a[0],q=n.isFunction(p);if(q||l>1&&"string"==typeof p&&!k.checkClone&&eb.test(p))return this.each(function(c){var d=m.eq(c);q&&(a[0]=p.call(this,c,d.html())),d.domManip(a,b)});if(l&&(c=n.buildFragment(a,this[0].ownerDocument,!1,this),d=c.firstChild,1===c.childNodes.length&&(c=d),d)){for(f=n.map(ob(c,"script"),kb),g=f.length;l>j;j++)h=c,j!==o&&(h=n.clone(h,!0,!0),g&&n.merge(f,ob(h,"script"))),b.call(this[j],h,j);if(g)for(i=f[f.length-1].ownerDocument,n.map(f,lb),j=0;g>j;j++)h=f[j],fb.test(h.type||"")&&!L.access(h,"globalEval")&&n.contains(i,h)&&(h.src?n._evalUrl&&n._evalUrl(h.src):n.globalEval(h.textContent.replace(hb,"")))}return this}}),n.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(a,b){n.fn[a]=function(a){for(var c,d=[],e=n(a),g=e.length-1,h=0;g>=h;h++)c=h===g?this:this.clone(!0),n(e[h])[b](c),f.apply(d,c.get());return this.pushStack(d)}});var qb,rb={};function sb(b,c){var d,e=n(c.createElement(b)).appendTo(c.body),f=a.getDefaultComputedStyle&&(d=a.getDefaultComputedStyle(e[0]))?d.display:n.css(e[0],"display");return e.detach(),f}function tb(a){var b=l,c=rb[a];return c||(c=sb(a,b),"none"!==c&&c||(qb=(qb||n("<iframe frameborder='0' width='0' height='0'/>")).appendTo(b.documentElement),b=qb[0].contentDocument,b.write(),b.close(),c=sb(a,b),qb.detach()),rb[a]=c),c}var ub=/^margin/,vb=new RegExp("^("+Q+")(?!px)[a-z%]+$","i"),wb=function(a){return a.ownerDocument.defaultView.getComputedStyle(a,null)};function xb(a,b,c){var d,e,f,g,h=a.style;return c=c||wb(a),c&&(g=c.getPropertyValue(b)||c[b]),c&&(""!==g||n.contains(a.ownerDocument,a)||(g=n.style(a,b)),vb.test(g)&&ub.test(b)&&(d=h.width,e=h.minWidth,f=h.maxWidth,h.minWidth=h.maxWidth=h.width=g,g=c.width,h.width=d,h.minWidth=e,h.maxWidth=f)),void 0!==g?g+"":g}function yb(a,b){return{get:function(){return a()?void delete this.get:(this.get=b).apply(this,arguments)}}}!function(){var b,c,d=l.documentElement,e=l.createElement("div"),f=l.createElement("div");if(f.style){f.style.backgroundClip="content-box",f.cloneNode(!0).style.backgroundClip="",k.clearCloneStyle="content-box"===f.style.backgroundClip,e.style.cssText="border:0;width:0;height:0;top:0;left:-9999px;margin-top:1px;position:absolute",e.appendChild(f);function g(){f.style.cssText="-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box;display:block;margin-top:1%;top:1%;border:1px;padding:1px;width:4px;position:absolute",f.innerHTML="",d.appendChild(e);var g=a.getComputedStyle(f,null);b="1%"!==g.top,c="4px"===g.width,d.removeChild(e)}a.getComputedStyle&&n.extend(k,{pixelPosition:function(){return g(),b},boxSizingReliable:function(){return null==c&&g(),c},reliableMarginRight:function(){var b,c=f.appendChild(l.createElement("div"));return c.style.cssText=f.style.cssText="-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box;display:block;margin:0;border:0;padding:0",c.style.marginRight=c.style.width="0",f.style.width="1px",d.appendChild(e),b=!parseFloat(a.getComputedStyle(c,null).marginRight),d.removeChild(e),b}})}}(),n.swap=function(a,b,c,d){var e,f,g={};for(f in b)g[f]=a.style[f],a.style[f]=b[f];e=c.apply(a,d||[]);for(f in b)a.style[f]=g[f];return e};var zb=/^(none|table(?!-c[ea]).+)/,Ab=new RegExp("^("+Q+")(.*)$","i"),Bb=new RegExp("^([+-])=("+Q+")","i"),Cb={position:"absolute",visibility:"hidden",display:"block"},Db={letterSpacing:"0",fontWeight:"400"},Eb=["Webkit","O","Moz","ms"];function Fb(a,b){if(b in a)return b;var c=b[0].toUpperCase()+b.slice(1),d=b,e=Eb.length;while(e--)if(b=Eb[e]+c,b in a)return b;return d}function Gb(a,b,c){var d=Ab.exec(b);return d?Math.max(0,d[1]-(c||0))+(d[2]||"px"):b}function Hb(a,b,c,d,e){for(var f=c===(d?"border":"content")?4:"width"===b?1:0,g=0;4>f;f+=2)"margin"===c&&(g+=n.css(a,c+R[f],!0,e)),d?("content"===c&&(g-=n.css(a,"padding"+R[f],!0,e)),"margin"!==c&&(g-=n.css(a,"border"+R[f]+"Width",!0,e))):(g+=n.css(a,"padding"+R[f],!0,e),"padding"!==c&&(g+=n.css(a,"border"+R[f]+"Width",!0,e)));return g}function Ib(a,b,c){var d=!0,e="width"===b?a.offsetWidth:a.offsetHeight,f=wb(a),g="border-box"===n.css(a,"boxSizing",!1,f);if(0>=e||null==e){if(e=xb(a,b,f),(0>e||null==e)&&(e=a.style[b]),vb.test(e))return e;d=g&&(k.boxSizingReliable()||e===a.style[b]),e=parseFloat(e)||0}return e+Hb(a,b,c||(g?"border":"content"),d,f)+"px"}function Jb(a,b){for(var c,d,e,f=[],g=0,h=a.length;h>g;g++)d=a[g],d.style&&(f[g]=L.get(d,"olddisplay"),c=d.style.display,b?(f[g]||"none"!==c||(d.style.display=""),""===d.style.display&&S(d)&&(f[g]=L.access(d,"olddisplay",tb(d.nodeName)))):(e=S(d),"none"===c&&e||L.set(d,"olddisplay",e?c:n.css(d,"display"))));for(g=0;h>g;g++)d=a[g],d.style&&(b&&"none"!==d.style.display&&""!==d.style.display||(d.style.display=b?f[g]||"":"none"));return a}n.extend({cssHooks:{opacity:{get:function(a,b){if(b){var c=xb(a,"opacity");return""===c?"1":c}}}},cssNumber:{columnCount:!0,fillOpacity:!0,flexGrow:!0,flexShrink:!0,fontWeight:!0,lineHeight:!0,opacity:!0,order:!0,orphans:!0,widows:!0,zIndex:!0,zoom:!0},cssProps:{"float":"cssFloat"},style:function(a,b,c,d){if(a&&3!==a.nodeType&&8!==a.nodeType&&a.style){var e,f,g,h=n.camelCase(b),i=a.style;return b=n.cssProps[h]||(n.cssProps[h]=Fb(i,h)),g=n.cssHooks[b]||n.cssHooks[h],void 0===c?g&&"get"in g&&void 0!==(e=g.get(a,!1,d))?e:i[b]:(f=typeof c,"string"===f&&(e=Bb.exec(c))&&(c=(e[1]+1)*e[2]+parseFloat(n.css(a,b)),f="number"),null!=c&&c===c&&("number"!==f||n.cssNumber[h]||(c+="px"),k.clearCloneStyle||""!==c||0!==b.indexOf("background")||(i[b]="inherit"),g&&"set"in g&&void 0===(c=g.set(a,c,d))||(i[b]=c)),void 0)}},css:function(a,b,c,d){var e,f,g,h=n.camelCase(b);return b=n.cssProps[h]||(n.cssProps[h]=Fb(a.style,h)),g=n.cssHooks[b]||n.cssHooks[h],g&&"get"in g&&(e=g.get(a,!0,c)),void 0===e&&(e=xb(a,b,d)),"normal"===e&&b in Db&&(e=Db[b]),""===c||c?(f=parseFloat(e),c===!0||n.isNumeric(f)?f||0:e):e}}),n.each(["height","width"],function(a,b){n.cssHooks[b]={get:function(a,c,d){return c?zb.test(n.css(a,"display"))&&0===a.offsetWidth?n.swap(a,Cb,function(){return Ib(a,b,d)}):Ib(a,b,d):void 0},set:function(a,c,d){var e=d&&wb(a);return Gb(a,c,d?Hb(a,b,d,"border-box"===n.css(a,"boxSizing",!1,e),e):0)}}}),n.cssHooks.marginRight=yb(k.reliableMarginRight,function(a,b){return b?n.swap(a,{display:"inline-block"},xb,[a,"marginRight"]):void 0}),n.each({margin:"",padding:"",border:"Width"},function(a,b){n.cssHooks[a+b]={expand:function(c){for(var d=0,e={},f="string"==typeof c?c.split(" "):[c];4>d;d++)e[a+R[d]+b]=f[d]||f[d-2]||f[0];return e}},ub.test(a)||(n.cssHooks[a+b].set=Gb)}),n.fn.extend({css:function(a,b){return J(this,function(a,b,c){var d,e,f={},g=0;if(n.isArray(b)){for(d=wb(a),e=b.length;e>g;g++)f[b[g]]=n.css(a,b[g],!1,d);return f}return void 0!==c?n.style(a,b,c):n.css(a,b)},a,b,arguments.length>1)},show:function(){return Jb(this,!0)},hide:function(){return Jb(this)},toggle:function(a){return"boolean"==typeof a?a?this.show():this.hide():this.each(function(){S(this)?n(this).show():n(this).hide()})}});function Kb(a,b,c,d,e){return new Kb.prototype.init(a,b,c,d,e)}n.Tween=Kb,Kb.prototype={constructor:Kb,init:function(a,b,c,d,e,f){this.elem=a,this.prop=c,this.easing=e||"swing",this.options=b,this.start=this.now=this.cur(),this.end=d,this.unit=f||(n.cssNumber[c]?"":"px")},cur:function(){var a=Kb.propHooks[this.prop];return a&&a.get?a.get(this):Kb.propHooks._default.get(this)},run:function(a){var b,c=Kb.propHooks[this.prop];return this.pos=b=this.options.duration?n.easing[this.easing](a,this.options.duration*a,0,1,this.options.duration):a,this.now=(this.end-this.start)*b+this.start,this.options.step&&this.options.step.call(this.elem,this.now,this),c&&c.set?c.set(this):Kb.propHooks._default.set(this),this}},Kb.prototype.init.prototype=Kb.prototype,Kb.propHooks={_default:{get:function(a){var b;return null==a.elem[a.prop]||a.elem.style&&null!=a.elem.style[a.prop]?(b=n.css(a.elem,a.prop,""),b&&"auto"!==b?b:0):a.elem[a.prop]},set:function(a){n.fx.step[a.prop]?n.fx.step[a.prop](a):a.elem.style&&(null!=a.elem.style[n.cssProps[a.prop]]||n.cssHooks[a.prop])?n.style(a.elem,a.prop,a.now+a.unit):a.elem[a.prop]=a.now}}},Kb.propHooks.scrollTop=Kb.propHooks.scrollLeft={set:function(a){a.elem.nodeType&&a.elem.parentNode&&(a.elem[a.prop]=a.now)}},n.easing={linear:function(a){return a},swing:function(a){return.5-Math.cos(a*Math.PI)/2}},n.fx=Kb.prototype.init,n.fx.step={};var Lb,Mb,Nb=/^(?:toggle|show|hide)$/,Ob=new RegExp("^(?:([+-])=|)("+Q+")([a-z%]*)$","i"),Pb=/queueHooks$/,Qb=[Vb],Rb={"*":[function(a,b){var c=this.createTween(a,b),d=c.cur(),e=Ob.exec(b),f=e&&e[3]||(n.cssNumber[a]?"":"px"),g=(n.cssNumber[a]||"px"!==f&&+d)&&Ob.exec(n.css(c.elem,a)),h=1,i=20;if(g&&g[3]!==f){f=f||g[3],e=e||[],g=+d||1;do h=h||".5",g/=h,n.style(c.elem,a,g+f);while(h!==(h=c.cur()/d)&&1!==h&&--i)}return e&&(g=c.start=+g||+d||0,c.unit=f,c.end=e[1]?g+(e[1]+1)*e[2]:+e[2]),c}]};function Sb(){return setTimeout(function(){Lb=void 0}),Lb=n.now()}function Tb(a,b){var c,d=0,e={height:a};for(b=b?1:0;4>d;d+=2-b)c=R[d],e["margin"+c]=e["padding"+c]=a;return b&&(e.opacity=e.width=a),e}function Ub(a,b,c){for(var d,e=(Rb[b]||[]).concat(Rb["*"]),f=0,g=e.length;g>f;f++)if(d=e[f].call(c,b,a))return d}function Vb(a,b,c){var d,e,f,g,h,i,j,k,l=this,m={},o=a.style,p=a.nodeType&&S(a),q=L.get(a,"fxshow");c.queue||(h=n._queueHooks(a,"fx"),null==h.unqueued&&(h.unqueued=0,i=h.empty.fire,h.empty.fire=function(){h.unqueued||i()}),h.unqueued++,l.always(function(){l.always(function(){h.unqueued--,n.queue(a,"fx").length||h.empty.fire()})})),1===a.nodeType&&("height"in b||"width"in b)&&(c.overflow=[o.overflow,o.overflowX,o.overflowY],j=n.css(a,"display"),k="none"===j?L.get(a,"olddisplay")||tb(a.nodeName):j,"inline"===k&&"none"===n.css(a,"float")&&(o.display="inline-block")),c.overflow&&(o.overflow="hidden",l.always(function(){o.overflow=c.overflow[0],o.overflowX=c.overflow[1],o.overflowY=c.overflow[2]}));for(d in b)if(e=b[d],Nb.exec(e)){if(delete b[d],f=f||"toggle"===e,e===(p?"hide":"show")){if("show"!==e||!q||void 0===q[d])continue;p=!0}m[d]=q&&q[d]||n.style(a,d)}else j=void 0;if(n.isEmptyObject(m))"inline"===("none"===j?tb(a.nodeName):j)&&(o.display=j);else{q?"hidden"in q&&(p=q.hidden):q=L.access(a,"fxshow",{}),f&&(q.hidden=!p),p?n(a).show():l.done(function(){n(a).hide()}),l.done(function(){var b;L.remove(a,"fxshow");for(b in m)n.style(a,b,m[b])});for(d in m)g=Ub(p?q[d]:0,d,l),d in q||(q[d]=g.start,p&&(g.end=g.start,g.start="width"===d||"height"===d?1:0))}}function Wb(a,b){var c,d,e,f,g;for(c in a)if(d=n.camelCase(c),e=b[d],f=a[c],n.isArray(f)&&(e=f[1],f=a[c]=f[0]),c!==d&&(a[d]=f,delete a[c]),g=n.cssHooks[d],g&&"expand"in g){f=g.expand(f),delete a[d];for(c in f)c in a||(a[c]=f[c],b[c]=e)}else b[d]=e}function Xb(a,b,c){var d,e,f=0,g=Qb.length,h=n.Deferred().always(function(){delete i.elem}),i=function(){if(e)return!1;for(var b=Lb||Sb(),c=Math.max(0,j.startTime+j.duration-b),d=c/j.duration||0,f=1-d,g=0,i=j.tweens.length;i>g;g++)j.tweens[g].run(f);return h.notifyWith(a,[j,f,c]),1>f&&i?c:(h.resolveWith(a,[j]),!1)},j=h.promise({elem:a,props:n.extend({},b),opts:n.extend(!0,{specialEasing:{}},c),originalProperties:b,originalOptions:c,startTime:Lb||Sb(),duration:c.duration,tweens:[],createTween:function(b,c){var d=n.Tween(a,j.opts,b,c,j.opts.specialEasing[b]||j.opts.easing);return j.tweens.push(d),d},stop:function(b){var c=0,d=b?j.tweens.length:0;if(e)return this;for(e=!0;d>c;c++)j.tweens[c].run(1);return b?h.resolveWith(a,[j,b]):h.rejectWith(a,[j,b]),this}}),k=j.props;for(Wb(k,j.opts.specialEasing);g>f;f++)if(d=Qb[f].call(j,a,k,j.opts))return d;return n.map(k,Ub,j),n.isFunction(j.opts.start)&&j.opts.start.call(a,j),n.fx.timer(n.extend(i,{elem:a,anim:j,queue:j.opts.queue})),j.progress(j.opts.progress).done(j.opts.done,j.opts.complete).fail(j.opts.fail).always(j.opts.always)}n.Animation=n.extend(Xb,{tweener:function(a,b){n.isFunction(a)?(b=a,a=["*"]):a=a.split(" ");for(var c,d=0,e=a.length;e>d;d++)c=a[d],Rb[c]=Rb[c]||[],Rb[c].unshift(b)},prefilter:function(a,b){b?Qb.unshift(a):Qb.push(a)}}),n.speed=function(a,b,c){var d=a&&"object"==typeof a?n.extend({},a):{complete:c||!c&&b||n.isFunction(a)&&a,duration:a,easing:c&&b||b&&!n.isFunction(b)&&b};return d.duration=n.fx.off?0:"number"==typeof d.duration?d.duration:d.duration in n.fx.speeds?n.fx.speeds[d.duration]:n.fx.speeds._default,(null==d.queue||d.queue===!0)&&(d.queue="fx"),d.old=d.complete,d.complete=function(){n.isFunction(d.old)&&d.old.call(this),d.queue&&n.dequeue(this,d.queue)},d},n.fn.extend({fadeTo:function(a,b,c,d){return this.filter(S).css("opacity",0).show().end().animate({opacity:b},a,c,d)},animate:function(a,b,c,d){var e=n.isEmptyObject(a),f=n.speed(b,c,d),g=function(){var b=Xb(this,n.extend({},a),f);(e||L.get(this,"finish"))&&b.stop(!0)};return g.finish=g,e||f.queue===!1?this.each(g):this.queue(f.queue,g)},stop:function(a,b,c){var d=function(a){var b=a.stop;delete a.stop,b(c)};return"string"!=typeof a&&(c=b,b=a,a=void 0),b&&a!==!1&&this.queue(a||"fx",[]),this.each(function(){var b=!0,e=null!=a&&a+"queueHooks",f=n.timers,g=L.get(this);if(e)g[e]&&g[e].stop&&d(g[e]);else for(e in g)g[e]&&g[e].stop&&Pb.test(e)&&d(g[e]);for(e=f.length;e--;)f[e].elem!==this||null!=a&&f[e].queue!==a||(f[e].anim.stop(c),b=!1,f.splice(e,1));(b||!c)&&n.dequeue(this,a)})},finish:function(a){return a!==!1&&(a=a||"fx"),this.each(function(){var b,c=L.get(this),d=c[a+"queue"],e=c[a+"queueHooks"],f=n.timers,g=d?d.length:0;for(c.finish=!0,n.queue(this,a,[]),e&&e.stop&&e.stop.call(this,!0),b=f.length;b--;)f[b].elem===this&&f[b].queue===a&&(f[b].anim.stop(!0),f.splice(b,1));for(b=0;g>b;b++)d[b]&&d[b].finish&&d[b].finish.call(this);delete c.finish})}}),n.each(["toggle","show","hide"],function(a,b){var c=n.fn[b];n.fn[b]=function(a,d,e){return null==a||"boolean"==typeof a?c.apply(this,arguments):this.animate(Tb(b,!0),a,d,e)}}),n.each({slideDown:Tb("show"),slideUp:Tb("hide"),slideToggle:Tb("toggle"),fadeIn:{opacity:"show"},fadeOut:{opacity:"hide"},fadeToggle:{opacity:"toggle"}},function(a,b){n.fn[a]=function(a,c,d){return this.animate(b,a,c,d)}}),n.timers=[],n.fx.tick=function(){var a,b=0,c=n.timers;for(Lb=n.now();b<c.length;b++)a=c[b],a()||c[b]!==a||c.splice(b--,1);c.length||n.fx.stop(),Lb=void 0},n.fx.timer=function(a){n.timers.push(a),a()?n.fx.start():n.timers.pop()},n.fx.interval=13,n.fx.start=function(){Mb||(Mb=setInterval(n.fx.tick,n.fx.interval))},n.fx.stop=function(){clearInterval(Mb),Mb=null},n.fx.speeds={slow:600,fast:200,_default:400},n.fn.delay=function(a,b){return a=n.fx?n.fx.speeds[a]||a:a,b=b||"fx",this.queue(b,function(b,c){var d=setTimeout(b,a);c.stop=function(){clearTimeout(d)}})},function(){var a=l.createElement("input"),b=l.createElement("select"),c=b.appendChild(l.createElement("option"));a.type="checkbox",k.checkOn=""!==a.value,k.optSelected=c.selected,b.disabled=!0,k.optDisabled=!c.disabled,a=l.createElement("input"),a.value="t",a.type="radio",k.radioValue="t"===a.value}();var Yb,Zb,$b=n.expr.attrHandle;n.fn.extend({attr:function(a,b){return J(this,n.attr,a,b,arguments.length>1)},removeAttr:function(a){return this.each(function(){n.removeAttr(this,a)})}}),n.extend({attr:function(a,b,c){var d,e,f=a.nodeType;if(a&&3!==f&&8!==f&&2!==f)return typeof a.getAttribute===U?n.prop(a,b,c):(1===f&&n.isXMLDoc(a)||(b=b.toLowerCase(),d=n.attrHooks[b]||(n.expr.match.bool.test(b)?Zb:Yb)),void 0===c?d&&"get"in d&&null!==(e=d.get(a,b))?e:(e=n.find.attr(a,b),null==e?void 0:e):null!==c?d&&"set"in d&&void 0!==(e=d.set(a,c,b))?e:(a.setAttribute(b,c+""),c):void n.removeAttr(a,b)) | ||
| 4 | },removeAttr:function(a,b){var c,d,e=0,f=b&&b.match(E);if(f&&1===a.nodeType)while(c=f[e++])d=n.propFix[c]||c,n.expr.match.bool.test(c)&&(a[d]=!1),a.removeAttribute(c)},attrHooks:{type:{set:function(a,b){if(!k.radioValue&&"radio"===b&&n.nodeName(a,"input")){var c=a.value;return a.setAttribute("type",b),c&&(a.value=c),b}}}}}),Zb={set:function(a,b,c){return b===!1?n.removeAttr(a,c):a.setAttribute(c,c),c}},n.each(n.expr.match.bool.source.match(/\w+/g),function(a,b){var c=$b[b]||n.find.attr;$b[b]=function(a,b,d){var e,f;return d||(f=$b[b],$b[b]=e,e=null!=c(a,b,d)?b.toLowerCase():null,$b[b]=f),e}});var _b=/^(?:input|select|textarea|button)$/i;n.fn.extend({prop:function(a,b){return J(this,n.prop,a,b,arguments.length>1)},removeProp:function(a){return this.each(function(){delete this[n.propFix[a]||a]})}}),n.extend({propFix:{"for":"htmlFor","class":"className"},prop:function(a,b,c){var d,e,f,g=a.nodeType;if(a&&3!==g&&8!==g&&2!==g)return f=1!==g||!n.isXMLDoc(a),f&&(b=n.propFix[b]||b,e=n.propHooks[b]),void 0!==c?e&&"set"in e&&void 0!==(d=e.set(a,c,b))?d:a[b]=c:e&&"get"in e&&null!==(d=e.get(a,b))?d:a[b]},propHooks:{tabIndex:{get:function(a){return a.hasAttribute("tabindex")||_b.test(a.nodeName)||a.href?a.tabIndex:-1}}}}),k.optSelected||(n.propHooks.selected={get:function(a){var b=a.parentNode;return b&&b.parentNode&&b.parentNode.selectedIndex,null}}),n.each(["tabIndex","readOnly","maxLength","cellSpacing","cellPadding","rowSpan","colSpan","useMap","frameBorder","contentEditable"],function(){n.propFix[this.toLowerCase()]=this});var ac=/[\t\r\n\f]/g;n.fn.extend({addClass:function(a){var b,c,d,e,f,g,h="string"==typeof a&&a,i=0,j=this.length;if(n.isFunction(a))return this.each(function(b){n(this).addClass(a.call(this,b,this.className))});if(h)for(b=(a||"").match(E)||[];j>i;i++)if(c=this[i],d=1===c.nodeType&&(c.className?(" "+c.className+" ").replace(ac," "):" ")){f=0;while(e=b[f++])d.indexOf(" "+e+" ")<0&&(d+=e+" ");g=n.trim(d),c.className!==g&&(c.className=g)}return this},removeClass:function(a){var b,c,d,e,f,g,h=0===arguments.length||"string"==typeof a&&a,i=0,j=this.length;if(n.isFunction(a))return this.each(function(b){n(this).removeClass(a.call(this,b,this.className))});if(h)for(b=(a||"").match(E)||[];j>i;i++)if(c=this[i],d=1===c.nodeType&&(c.className?(" "+c.className+" ").replace(ac," "):"")){f=0;while(e=b[f++])while(d.indexOf(" "+e+" ")>=0)d=d.replace(" "+e+" "," ");g=a?n.trim(d):"",c.className!==g&&(c.className=g)}return this},toggleClass:function(a,b){var c=typeof a;return"boolean"==typeof b&&"string"===c?b?this.addClass(a):this.removeClass(a):this.each(n.isFunction(a)?function(c){n(this).toggleClass(a.call(this,c,this.className,b),b)}:function(){if("string"===c){var b,d=0,e=n(this),f=a.match(E)||[];while(b=f[d++])e.hasClass(b)?e.removeClass(b):e.addClass(b)}else(c===U||"boolean"===c)&&(this.className&&L.set(this,"__className__",this.className),this.className=this.className||a===!1?"":L.get(this,"__className__")||"")})},hasClass:function(a){for(var b=" "+a+" ",c=0,d=this.length;d>c;c++)if(1===this[c].nodeType&&(" "+this[c].className+" ").replace(ac," ").indexOf(b)>=0)return!0;return!1}});var bc=/\r/g;n.fn.extend({val:function(a){var b,c,d,e=this[0];{if(arguments.length)return d=n.isFunction(a),this.each(function(c){var e;1===this.nodeType&&(e=d?a.call(this,c,n(this).val()):a,null==e?e="":"number"==typeof e?e+="":n.isArray(e)&&(e=n.map(e,function(a){return null==a?"":a+""})),b=n.valHooks[this.type]||n.valHooks[this.nodeName.toLowerCase()],b&&"set"in b&&void 0!==b.set(this,e,"value")||(this.value=e))});if(e)return b=n.valHooks[e.type]||n.valHooks[e.nodeName.toLowerCase()],b&&"get"in b&&void 0!==(c=b.get(e,"value"))?c:(c=e.value,"string"==typeof c?c.replace(bc,""):null==c?"":c)}}}),n.extend({valHooks:{option:{get:function(a){var b=n.find.attr(a,"value");return null!=b?b:n.trim(n.text(a))}},select:{get:function(a){for(var b,c,d=a.options,e=a.selectedIndex,f="select-one"===a.type||0>e,g=f?null:[],h=f?e+1:d.length,i=0>e?h:f?e:0;h>i;i++)if(c=d[i],!(!c.selected&&i!==e||(k.optDisabled?c.disabled:null!==c.getAttribute("disabled"))||c.parentNode.disabled&&n.nodeName(c.parentNode,"optgroup"))){if(b=n(c).val(),f)return b;g.push(b)}return g},set:function(a,b){var c,d,e=a.options,f=n.makeArray(b),g=e.length;while(g--)d=e[g],(d.selected=n.inArray(d.value,f)>=0)&&(c=!0);return c||(a.selectedIndex=-1),f}}}}),n.each(["radio","checkbox"],function(){n.valHooks[this]={set:function(a,b){return n.isArray(b)?a.checked=n.inArray(n(a).val(),b)>=0:void 0}},k.checkOn||(n.valHooks[this].get=function(a){return null===a.getAttribute("value")?"on":a.value})}),n.each("blur focus focusin focusout load resize scroll unload click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup error contextmenu".split(" "),function(a,b){n.fn[b]=function(a,c){return arguments.length>0?this.on(b,null,a,c):this.trigger(b)}}),n.fn.extend({hover:function(a,b){return this.mouseenter(a).mouseleave(b||a)},bind:function(a,b,c){return this.on(a,null,b,c)},unbind:function(a,b){return this.off(a,null,b)},delegate:function(a,b,c,d){return this.on(b,a,c,d)},undelegate:function(a,b,c){return 1===arguments.length?this.off(a,"**"):this.off(b,a||"**",c)}});var cc=n.now(),dc=/\?/;n.parseJSON=function(a){return JSON.parse(a+"")},n.parseXML=function(a){var b,c;if(!a||"string"!=typeof a)return null;try{c=new DOMParser,b=c.parseFromString(a,"text/xml")}catch(d){b=void 0}return(!b||b.getElementsByTagName("parsererror").length)&&n.error("Invalid XML: "+a),b};var ec,fc,gc=/#.*$/,hc=/([?&])_=[^&]*/,ic=/^(.*?):[ \t]*([^\r\n]*)$/gm,jc=/^(?:about|app|app-storage|.+-extension|file|res|widget):$/,kc=/^(?:GET|HEAD)$/,lc=/^\/\//,mc=/^([\w.+-]+:)(?:\/\/(?:[^\/?#]*@|)([^\/?#:]*)(?::(\d+)|)|)/,nc={},oc={},pc="*/".concat("*");try{fc=location.href}catch(qc){fc=l.createElement("a"),fc.href="",fc=fc.href}ec=mc.exec(fc.toLowerCase())||[];function rc(a){return function(b,c){"string"!=typeof b&&(c=b,b="*");var d,e=0,f=b.toLowerCase().match(E)||[];if(n.isFunction(c))while(d=f[e++])"+"===d[0]?(d=d.slice(1)||"*",(a[d]=a[d]||[]).unshift(c)):(a[d]=a[d]||[]).push(c)}}function sc(a,b,c,d){var e={},f=a===oc;function g(h){var i;return e[h]=!0,n.each(a[h]||[],function(a,h){var j=h(b,c,d);return"string"!=typeof j||f||e[j]?f?!(i=j):void 0:(b.dataTypes.unshift(j),g(j),!1)}),i}return g(b.dataTypes[0])||!e["*"]&&g("*")}function tc(a,b){var c,d,e=n.ajaxSettings.flatOptions||{};for(c in b)void 0!==b[c]&&((e[c]?a:d||(d={}))[c]=b[c]);return d&&n.extend(!0,a,d),a}function uc(a,b,c){var d,e,f,g,h=a.contents,i=a.dataTypes;while("*"===i[0])i.shift(),void 0===d&&(d=a.mimeType||b.getResponseHeader("Content-Type"));if(d)for(e in h)if(h[e]&&h[e].test(d)){i.unshift(e);break}if(i[0]in c)f=i[0];else{for(e in c){if(!i[0]||a.converters[e+" "+i[0]]){f=e;break}g||(g=e)}f=f||g}return f?(f!==i[0]&&i.unshift(f),c[f]):void 0}function vc(a,b,c,d){var e,f,g,h,i,j={},k=a.dataTypes.slice();if(k[1])for(g in a.converters)j[g.toLowerCase()]=a.converters[g];f=k.shift();while(f)if(a.responseFields[f]&&(c[a.responseFields[f]]=b),!i&&d&&a.dataFilter&&(b=a.dataFilter(b,a.dataType)),i=f,f=k.shift())if("*"===f)f=i;else if("*"!==i&&i!==f){if(g=j[i+" "+f]||j["* "+f],!g)for(e in j)if(h=e.split(" "),h[1]===f&&(g=j[i+" "+h[0]]||j["* "+h[0]])){g===!0?g=j[e]:j[e]!==!0&&(f=h[0],k.unshift(h[1]));break}if(g!==!0)if(g&&a["throws"])b=g(b);else try{b=g(b)}catch(l){return{state:"parsererror",error:g?l:"No conversion from "+i+" to "+f}}}return{state:"success",data:b}}n.extend({active:0,lastModified:{},etag:{},ajaxSettings:{url:fc,type:"GET",isLocal:jc.test(ec[1]),global:!0,processData:!0,async:!0,contentType:"application/x-www-form-urlencoded; charset=UTF-8",accepts:{"*":pc,text:"text/plain",html:"text/html",xml:"application/xml, text/xml",json:"application/json, text/javascript"},contents:{xml:/xml/,html:/html/,json:/json/},responseFields:{xml:"responseXML",text:"responseText",json:"responseJSON"},converters:{"* text":String,"text html":!0,"text json":n.parseJSON,"text xml":n.parseXML},flatOptions:{url:!0,context:!0}},ajaxSetup:function(a,b){return b?tc(tc(a,n.ajaxSettings),b):tc(n.ajaxSettings,a)},ajaxPrefilter:rc(nc),ajaxTransport:rc(oc),ajax:function(a,b){"object"==typeof a&&(b=a,a=void 0),b=b||{};var c,d,e,f,g,h,i,j,k=n.ajaxSetup({},b),l=k.context||k,m=k.context&&(l.nodeType||l.jquery)?n(l):n.event,o=n.Deferred(),p=n.Callbacks("once memory"),q=k.statusCode||{},r={},s={},t=0,u="canceled",v={readyState:0,getResponseHeader:function(a){var b;if(2===t){if(!f){f={};while(b=ic.exec(e))f[b[1].toLowerCase()]=b[2]}b=f[a.toLowerCase()]}return null==b?null:b},getAllResponseHeaders:function(){return 2===t?e:null},setRequestHeader:function(a,b){var c=a.toLowerCase();return t||(a=s[c]=s[c]||a,r[a]=b),this},overrideMimeType:function(a){return t||(k.mimeType=a),this},statusCode:function(a){var b;if(a)if(2>t)for(b in a)q[b]=[q[b],a[b]];else v.always(a[v.status]);return this},abort:function(a){var b=a||u;return c&&c.abort(b),x(0,b),this}};if(o.promise(v).complete=p.add,v.success=v.done,v.error=v.fail,k.url=((a||k.url||fc)+"").replace(gc,"").replace(lc,ec[1]+"//"),k.type=b.method||b.type||k.method||k.type,k.dataTypes=n.trim(k.dataType||"*").toLowerCase().match(E)||[""],null==k.crossDomain&&(h=mc.exec(k.url.toLowerCase()),k.crossDomain=!(!h||h[1]===ec[1]&&h[2]===ec[2]&&(h[3]||("http:"===h[1]?"80":"443"))===(ec[3]||("http:"===ec[1]?"80":"443")))),k.data&&k.processData&&"string"!=typeof k.data&&(k.data=n.param(k.data,k.traditional)),sc(nc,k,b,v),2===t)return v;i=k.global,i&&0===n.active++&&n.event.trigger("ajaxStart"),k.type=k.type.toUpperCase(),k.hasContent=!kc.test(k.type),d=k.url,k.hasContent||(k.data&&(d=k.url+=(dc.test(d)?"&":"?")+k.data,delete k.data),k.cache===!1&&(k.url=hc.test(d)?d.replace(hc,"$1_="+cc++):d+(dc.test(d)?"&":"?")+"_="+cc++)),k.ifModified&&(n.lastModified[d]&&v.setRequestHeader("If-Modified-Since",n.lastModified[d]),n.etag[d]&&v.setRequestHeader("If-None-Match",n.etag[d])),(k.data&&k.hasContent&&k.contentType!==!1||b.contentType)&&v.setRequestHeader("Content-Type",k.contentType),v.setRequestHeader("Accept",k.dataTypes[0]&&k.accepts[k.dataTypes[0]]?k.accepts[k.dataTypes[0]]+("*"!==k.dataTypes[0]?", "+pc+"; q=0.01":""):k.accepts["*"]);for(j in k.headers)v.setRequestHeader(j,k.headers[j]);if(k.beforeSend&&(k.beforeSend.call(l,v,k)===!1||2===t))return v.abort();u="abort";for(j in{success:1,error:1,complete:1})v[j](k[j]);if(c=sc(oc,k,b,v)){v.readyState=1,i&&m.trigger("ajaxSend",[v,k]),k.async&&k.timeout>0&&(g=setTimeout(function(){v.abort("timeout")},k.timeout));try{t=1,c.send(r,x)}catch(w){if(!(2>t))throw w;x(-1,w)}}else x(-1,"No Transport");function x(a,b,f,h){var j,r,s,u,w,x=b;2!==t&&(t=2,g&&clearTimeout(g),c=void 0,e=h||"",v.readyState=a>0?4:0,j=a>=200&&300>a||304===a,f&&(u=uc(k,v,f)),u=vc(k,u,v,j),j?(k.ifModified&&(w=v.getResponseHeader("Last-Modified"),w&&(n.lastModified[d]=w),w=v.getResponseHeader("etag"),w&&(n.etag[d]=w)),204===a||"HEAD"===k.type?x="nocontent":304===a?x="notmodified":(x=u.state,r=u.data,s=u.error,j=!s)):(s=x,(a||!x)&&(x="error",0>a&&(a=0))),v.status=a,v.statusText=(b||x)+"",j?o.resolveWith(l,[r,x,v]):o.rejectWith(l,[v,x,s]),v.statusCode(q),q=void 0,i&&m.trigger(j?"ajaxSuccess":"ajaxError",[v,k,j?r:s]),p.fireWith(l,[v,x]),i&&(m.trigger("ajaxComplete",[v,k]),--n.active||n.event.trigger("ajaxStop")))}return v},getJSON:function(a,b,c){return n.get(a,b,c,"json")},getScript:function(a,b){return n.get(a,void 0,b,"script")}}),n.each(["get","post"],function(a,b){n[b]=function(a,c,d,e){return n.isFunction(c)&&(e=e||d,d=c,c=void 0),n.ajax({url:a,type:b,dataType:e,data:c,success:d})}}),n.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(a,b){n.fn[b]=function(a){return this.on(b,a)}}),n._evalUrl=function(a){return n.ajax({url:a,type:"GET",dataType:"script",async:!1,global:!1,"throws":!0})},n.fn.extend({wrapAll:function(a){var b;return n.isFunction(a)?this.each(function(b){n(this).wrapAll(a.call(this,b))}):(this[0]&&(b=n(a,this[0].ownerDocument).eq(0).clone(!0),this[0].parentNode&&b.insertBefore(this[0]),b.map(function(){var a=this;while(a.firstElementChild)a=a.firstElementChild;return a}).append(this)),this)},wrapInner:function(a){return this.each(n.isFunction(a)?function(b){n(this).wrapInner(a.call(this,b))}:function(){var b=n(this),c=b.contents();c.length?c.wrapAll(a):b.append(a)})},wrap:function(a){var b=n.isFunction(a);return this.each(function(c){n(this).wrapAll(b?a.call(this,c):a)})},unwrap:function(){return this.parent().each(function(){n.nodeName(this,"body")||n(this).replaceWith(this.childNodes)}).end()}}),n.expr.filters.hidden=function(a){return a.offsetWidth<=0&&a.offsetHeight<=0},n.expr.filters.visible=function(a){return!n.expr.filters.hidden(a)};var wc=/%20/g,xc=/\[\]$/,yc=/\r?\n/g,zc=/^(?:submit|button|image|reset|file)$/i,Ac=/^(?:input|select|textarea|keygen)/i;function Bc(a,b,c,d){var e;if(n.isArray(b))n.each(b,function(b,e){c||xc.test(a)?d(a,e):Bc(a+"["+("object"==typeof e?b:"")+"]",e,c,d)});else if(c||"object"!==n.type(b))d(a,b);else for(e in b)Bc(a+"["+e+"]",b[e],c,d)}n.param=function(a,b){var c,d=[],e=function(a,b){b=n.isFunction(b)?b():null==b?"":b,d[d.length]=encodeURIComponent(a)+"="+encodeURIComponent(b)};if(void 0===b&&(b=n.ajaxSettings&&n.ajaxSettings.traditional),n.isArray(a)||a.jquery&&!n.isPlainObject(a))n.each(a,function(){e(this.name,this.value)});else for(c in a)Bc(c,a[c],b,e);return d.join("&").replace(wc,"+")},n.fn.extend({serialize:function(){return n.param(this.serializeArray())},serializeArray:function(){return this.map(function(){var a=n.prop(this,"elements");return a?n.makeArray(a):this}).filter(function(){var a=this.type;return this.name&&!n(this).is(":disabled")&&Ac.test(this.nodeName)&&!zc.test(a)&&(this.checked||!T.test(a))}).map(function(a,b){var c=n(this).val();return null==c?null:n.isArray(c)?n.map(c,function(a){return{name:b.name,value:a.replace(yc,"\r\n")}}):{name:b.name,value:c.replace(yc,"\r\n")}}).get()}}),n.ajaxSettings.xhr=function(){try{return new XMLHttpRequest}catch(a){}};var Cc=0,Dc={},Ec={0:200,1223:204},Fc=n.ajaxSettings.xhr();a.ActiveXObject&&n(a).on("unload",function(){for(var a in Dc)Dc[a]()}),k.cors=!!Fc&&"withCredentials"in Fc,k.ajax=Fc=!!Fc,n.ajaxTransport(function(a){var b;return k.cors||Fc&&!a.crossDomain?{send:function(c,d){var e,f=a.xhr(),g=++Cc;if(f.open(a.type,a.url,a.async,a.username,a.password),a.xhrFields)for(e in a.xhrFields)f[e]=a.xhrFields[e];a.mimeType&&f.overrideMimeType&&f.overrideMimeType(a.mimeType),a.crossDomain||c["X-Requested-With"]||(c["X-Requested-With"]="XMLHttpRequest");for(e in c)f.setRequestHeader(e,c[e]);b=function(a){return function(){b&&(delete Dc[g],b=f.onload=f.onerror=null,"abort"===a?f.abort():"error"===a?d(f.status,f.statusText):d(Ec[f.status]||f.status,f.statusText,"string"==typeof f.responseText?{text:f.responseText}:void 0,f.getAllResponseHeaders()))}},f.onload=b(),f.onerror=b("error"),b=Dc[g]=b("abort");try{f.send(a.hasContent&&a.data||null)}catch(h){if(b)throw h}},abort:function(){b&&b()}}:void 0}),n.ajaxSetup({accepts:{script:"text/javascript, application/javascript, application/ecmascript, application/x-ecmascript"},contents:{script:/(?:java|ecma)script/},converters:{"text script":function(a){return n.globalEval(a),a}}}),n.ajaxPrefilter("script",function(a){void 0===a.cache&&(a.cache=!1),a.crossDomain&&(a.type="GET")}),n.ajaxTransport("script",function(a){if(a.crossDomain){var b,c;return{send:function(d,e){b=n("<script>").prop({async:!0,charset:a.scriptCharset,src:a.url}).on("load error",c=function(a){b.remove(),c=null,a&&e("error"===a.type?404:200,a.type)}),l.head.appendChild(b[0])},abort:function(){c&&c()}}}});var Gc=[],Hc=/(=)\?(?=&|$)|\?\?/;n.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var a=Gc.pop()||n.expando+"_"+cc++;return this[a]=!0,a}}),n.ajaxPrefilter("json jsonp",function(b,c,d){var e,f,g,h=b.jsonp!==!1&&(Hc.test(b.url)?"url":"string"==typeof b.data&&!(b.contentType||"").indexOf("application/x-www-form-urlencoded")&&Hc.test(b.data)&&"data");return h||"jsonp"===b.dataTypes[0]?(e=b.jsonpCallback=n.isFunction(b.jsonpCallback)?b.jsonpCallback():b.jsonpCallback,h?b[h]=b[h].replace(Hc,"$1"+e):b.jsonp!==!1&&(b.url+=(dc.test(b.url)?"&":"?")+b.jsonp+"="+e),b.converters["script json"]=function(){return g||n.error(e+" was not called"),g[0]},b.dataTypes[0]="json",f=a[e],a[e]=function(){g=arguments},d.always(function(){a[e]=f,b[e]&&(b.jsonpCallback=c.jsonpCallback,Gc.push(e)),g&&n.isFunction(f)&&f(g[0]),g=f=void 0}),"script"):void 0}),n.parseHTML=function(a,b,c){if(!a||"string"!=typeof a)return null;"boolean"==typeof b&&(c=b,b=!1),b=b||l;var d=v.exec(a),e=!c&&[];return d?[b.createElement(d[1])]:(d=n.buildFragment([a],b,e),e&&e.length&&n(e).remove(),n.merge([],d.childNodes))};var Ic=n.fn.load;n.fn.load=function(a,b,c){if("string"!=typeof a&&Ic)return Ic.apply(this,arguments);var d,e,f,g=this,h=a.indexOf(" ");return h>=0&&(d=n.trim(a.slice(h)),a=a.slice(0,h)),n.isFunction(b)?(c=b,b=void 0):b&&"object"==typeof b&&(e="POST"),g.length>0&&n.ajax({url:a,type:e,dataType:"html",data:b}).done(function(a){f=arguments,g.html(d?n("<div>").append(n.parseHTML(a)).find(d):a)}).complete(c&&function(a,b){g.each(c,f||[a.responseText,b,a])}),this},n.expr.filters.animated=function(a){return n.grep(n.timers,function(b){return a===b.elem}).length};var Jc=a.document.documentElement;function Kc(a){return n.isWindow(a)?a:9===a.nodeType&&a.defaultView}n.offset={setOffset:function(a,b,c){var d,e,f,g,h,i,j,k=n.css(a,"position"),l=n(a),m={};"static"===k&&(a.style.position="relative"),h=l.offset(),f=n.css(a,"top"),i=n.css(a,"left"),j=("absolute"===k||"fixed"===k)&&(f+i).indexOf("auto")>-1,j?(d=l.position(),g=d.top,e=d.left):(g=parseFloat(f)||0,e=parseFloat(i)||0),n.isFunction(b)&&(b=b.call(a,c,h)),null!=b.top&&(m.top=b.top-h.top+g),null!=b.left&&(m.left=b.left-h.left+e),"using"in b?b.using.call(a,m):l.css(m)}},n.fn.extend({offset:function(a){if(arguments.length)return void 0===a?this:this.each(function(b){n.offset.setOffset(this,a,b)});var b,c,d=this[0],e={top:0,left:0},f=d&&d.ownerDocument;if(f)return b=f.documentElement,n.contains(b,d)?(typeof d.getBoundingClientRect!==U&&(e=d.getBoundingClientRect()),c=Kc(f),{top:e.top+c.pageYOffset-b.clientTop,left:e.left+c.pageXOffset-b.clientLeft}):e},position:function(){if(this[0]){var a,b,c=this[0],d={top:0,left:0};return"fixed"===n.css(c,"position")?b=c.getBoundingClientRect():(a=this.offsetParent(),b=this.offset(),n.nodeName(a[0],"html")||(d=a.offset()),d.top+=n.css(a[0],"borderTopWidth",!0),d.left+=n.css(a[0],"borderLeftWidth",!0)),{top:b.top-d.top-n.css(c,"marginTop",!0),left:b.left-d.left-n.css(c,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var a=this.offsetParent||Jc;while(a&&!n.nodeName(a,"html")&&"static"===n.css(a,"position"))a=a.offsetParent;return a||Jc})}}),n.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(b,c){var d="pageYOffset"===c;n.fn[b]=function(e){return J(this,function(b,e,f){var g=Kc(b);return void 0===f?g?g[c]:b[e]:void(g?g.scrollTo(d?a.pageXOffset:f,d?f:a.pageYOffset):b[e]=f)},b,e,arguments.length,null)}}),n.each(["top","left"],function(a,b){n.cssHooks[b]=yb(k.pixelPosition,function(a,c){return c?(c=xb(a,b),vb.test(c)?n(a).position()[b]+"px":c):void 0})}),n.each({Height:"height",Width:"width"},function(a,b){n.each({padding:"inner"+a,content:b,"":"outer"+a},function(c,d){n.fn[d]=function(d,e){var f=arguments.length&&(c||"boolean"!=typeof d),g=c||(d===!0||e===!0?"margin":"border");return J(this,function(b,c,d){var e;return n.isWindow(b)?b.document.documentElement["client"+a]:9===b.nodeType?(e=b.documentElement,Math.max(b.body["scroll"+a],e["scroll"+a],b.body["offset"+a],e["offset"+a],e["client"+a])):void 0===d?n.css(b,c,g):n.style(b,c,d,g)},b,f?d:void 0,f,null)}})}),n.fn.size=function(){return this.length},n.fn.andSelf=n.fn.addBack,"function"==typeof define&&define.amd&&define("jquery",[],function(){return n});var Lc=a.jQuery,Mc=a.$;return n.noConflict=function(b){return a.$===n&&(a.$=Mc),b&&a.jQuery===n&&(a.jQuery=Lc),n},typeof b===U&&(a.jQuery=a.$=n),n}); | ||
diff --git a/doc/html/js/modernizr-2.8.3.min.js b/doc/html/js/modernizr-2.8.3.min.js new file mode 100644 index 00000000..40dd2a9f --- /dev/null +++ b/doc/html/js/modernizr-2.8.3.min.js | |||
| @@ -0,0 +1 @@ | |||
| window.Modernizr=function(e,t,n){function r(e){b.cssText=e}function o(e,t){return r(S.join(e+";")+(t||""))}function a(e,t){return typeof e===t}function i(e,t){return!!~(""+e).indexOf(t)}function c(e,t){for(var r in e){var o=e[r];if(!i(o,"-")&&b[o]!==n)return"pfx"==t?o:!0}return!1}function s(e,t,r){for(var o in e){var i=t[e[o]];if(i!==n)return r===!1?e[o]:a(i,"function")?i.bind(r||t):i}return!1}function u(e,t,n){var r=e.charAt(0).toUpperCase()+e.slice(1),o=(e+" "+k.join(r+" ")+r).split(" ");return a(t,"string")||a(t,"undefined")?c(o,t):(o=(e+" "+T.join(r+" ")+r).split(" "),s(o,t,n))}function l(){p.input=function(n){for(var r=0,o=n.length;o>r;r++)j[n[r]]=!!(n[r]in E);return j.list&&(j.list=!(!t.createElement("datalist")||!e.HTMLDataListElement)),j}("autocomplete autofocus list placeholder max min multiple pattern required step".split(" ")),p.inputtypes=function(e){for(var r,o,a,i=0,c=e.length;c>i;i++)E.setAttribute("type",o=e[i]),r="text"!==E.type,r&&(E.value=x,E.style.cssText="position:absolute;visibility:hidden;",/^range$/.test(o)&&E.style.WebkitAppearance!==n?(g.appendChild(E),a=t.defaultView,r=a.getComputedStyle&&"textfield"!==a.getComputedStyle(E,null).WebkitAppearance&&0!==E.offsetHeight,g.removeChild(E)):/^(search|tel)$/.test(o)||(r=/^(url|email)$/.test(o)?E.checkValidity&&E.checkValidity()===!1:E.value!=x)),P[e[i]]=!!r;return P}("search tel url email datetime date month week time datetime-local number range color".split(" "))}var d,f,m="2.8.3",p={},h=!0,g=t.documentElement,v="modernizr",y=t.createElement(v),b=y.style,E=t.createElement("input"),x=":)",w={}.toString,S=" -webkit- -moz- -o- -ms- ".split(" "),C="Webkit Moz O ms",k=C.split(" "),T=C.toLowerCase().split(" "),N={svg:"http://www.w3.org/2000/svg"},M={},P={},j={},$=[],D=$.slice,F=function(e,n,r,o){var a,i,c,s,u=t.createElement("div"),l=t.body,d=l||t.createElement("body");if(parseInt(r,10))for(;r--;)c=t.createElement("div"),c.id=o?o[r]:v+(r+1),u.appendChild(c);return a=["­",'<style id="s',v,'">',e,"</style>"].join(""),u.id=v,(l?u:d).innerHTML+=a,d.appendChild(u),l||(d.style.background="",d.style.overflow="hidden",s=g.style.overflow,g.style.overflow="hidden",g.appendChild(d)),i=n(u,e),l?u.parentNode.removeChild(u):(d.parentNode.removeChild(d),g.style.overflow=s),!!i},z=function(t){var n=e.matchMedia||e.msMatchMedia;if(n)return n(t)&&n(t).matches||!1;var r;return F("@media "+t+" { #"+v+" { position: absolute; } }",function(t){r="absolute"==(e.getComputedStyle?getComputedStyle(t,null):t.currentStyle).position}),r},A=function(){function e(e,o){o=o||t.createElement(r[e]||"div"),e="on"+e;var i=e in o;return i||(o.setAttribute||(o=t.createElement("div")),o.setAttribute&&o.removeAttribute&&(o.setAttribute(e,""),i=a(o[e],"function"),a(o[e],"undefined")||(o[e]=n),o.removeAttribute(e))),o=null,i}var r={select:"input",change:"input",submit:"form",reset:"form",error:"img",load:"img",abort:"img"};return e}(),L={}.hasOwnProperty;f=a(L,"undefined")||a(L.call,"undefined")?function(e,t){return t in e&&a(e.constructor.prototype[t],"undefined")}:function(e,t){return L.call(e,t)},Function.prototype.bind||(Function.prototype.bind=function(e){var t=this;if("function"!=typeof t)throw new TypeError;var n=D.call(arguments,1),r=function(){if(this instanceof r){var o=function(){};o.prototype=t.prototype;var a=new o,i=t.apply(a,n.concat(D.call(arguments)));return Object(i)===i?i:a}return t.apply(e,n.concat(D.call(arguments)))};return r}),M.flexbox=function(){return u("flexWrap")},M.flexboxlegacy=function(){return u("boxDirection")},M.canvas=function(){var e=t.createElement("canvas");return!(!e.getContext||!e.getContext("2d"))},M.canvastext=function(){return!(!p.canvas||!a(t.createElement("canvas").getContext("2d").fillText,"function"))},M.webgl=function(){return!!e.WebGLRenderingContext},M.touch=function(){var n;return"ontouchstart"in e||e.DocumentTouch&&t instanceof DocumentTouch?n=!0:F(["@media (",S.join("touch-enabled),("),v,")","{#modernizr{top:9px;position:absolute}}"].join(""),function(e){n=9===e.offsetTop}),n},M.geolocation=function(){return"geolocation"in navigator},M.postmessage=function(){return!!e.postMessage},M.websqldatabase=function(){return!!e.openDatabase},M.indexedDB=function(){return!!u("indexedDB",e)},M.hashchange=function(){return A("hashchange",e)&&(t.documentMode===n||t.documentMode>7)},M.history=function(){return!(!e.history||!history.pushState)},M.draganddrop=function(){var e=t.createElement("div");return"draggable"in e||"ondragstart"in e&&"ondrop"in e},M.websockets=function(){return"WebSocket"in e||"MozWebSocket"in e},M.rgba=function(){return r("background-color:rgba(150,255,150,.5)"),i(b.backgroundColor,"rgba")},M.hsla=function(){return r("background-color:hsla(120,40%,100%,.5)"),i(b.backgroundColor,"rgba")||i(b.backgroundColor,"hsla")},M.multiplebgs=function(){return r("background:url(https://),url(https://),red url(https://)"),/(url\s*\(.*?){3}/.test(b.background)},M.backgroundsize=function(){return u("backgroundSize")},M.borderimage=function(){return u("borderImage")},M.borderradius=function(){return u("borderRadius")},M.boxshadow=function(){return u("boxShadow")},M.textshadow=function(){return""===t.createElement("div").style.textShadow},M.opacity=function(){return o("opacity:.55"),/^0.55$/.test(b.opacity)},M.cssanimations=function(){return u("animationName")},M.csscolumns=function(){return u("columnCount")},M.cssgradients=function(){var e="background-image:",t="gradient(linear,left top,right bottom,from(#9f9),to(white));",n="linear-gradient(left top,#9f9, white);";return r((e+"-webkit- ".split(" ").join(t+e)+S.join(n+e)).slice(0,-e.length)),i(b.backgroundImage,"gradient")},M.cssreflections=function(){return u("boxReflect")},M.csstransforms=function(){return!!u("transform")},M.csstransforms3d=function(){var e=!!u("perspective");return e&&"webkitPerspective"in g.style&&F("@media (transform-3d),(-webkit-transform-3d){#modernizr{left:9px;position:absolute;height:3px;}}",function(t){e=9===t.offsetLeft&&3===t.offsetHeight}),e},M.csstransitions=function(){return u("transition")},M.fontface=function(){var e;return F('@font-face {font-family:"font";src:url("https://")}',function(n,r){var o=t.getElementById("smodernizr"),a=o.sheet||o.styleSheet,i=a?a.cssRules&&a.cssRules[0]?a.cssRules[0].cssText:a.cssText||"":"";e=/src/i.test(i)&&0===i.indexOf(r.split(" ")[0])}),e},M.generatedcontent=function(){var e;return F(["#",v,"{font:0/0 a}#",v,':after{content:"',x,'";visibility:hidden;font:3px/1 a}'].join(""),function(t){e=t.offsetHeight>=3}),e},M.video=function(){var e=t.createElement("video"),n=!1;try{(n=!!e.canPlayType)&&(n=new Boolean(n),n.ogg=e.canPlayType('video/ogg; codecs="theora"').replace(/^no$/,""),n.h264=e.canPlayType('video/mp4; codecs="avc1.42E01E"').replace(/^no$/,""),n.webm=e.canPlayType('video/webm; codecs="vp8, vorbis"').replace(/^no$/,""))}catch(r){}return n},M.audio=function(){var e=t.createElement("audio"),n=!1;try{(n=!!e.canPlayType)&&(n=new Boolean(n),n.ogg=e.canPlayType('audio/ogg; codecs="vorbis"').replace(/^no$/,""),n.mp3=e.canPlayType("audio/mpeg;").replace(/^no$/,""),n.wav=e.canPlayType('audio/wav; codecs="1"').replace(/^no$/,""),n.m4a=(e.canPlayType("audio/x-m4a;")||e.canPlayType("audio/aac;")).replace(/^no$/,""))}catch(r){}return n},M.localstorage=function(){try{return localStorage.setItem(v,v),localStorage.removeItem(v),!0}catch(e){return!1}},M.sessionstorage=function(){try{return sessionStorage.setItem(v,v),sessionStorage.removeItem(v),!0}catch(e){return!1}},M.webworkers=function(){return!!e.Worker},M.applicationcache=function(){return!!e.applicationCache},M.svg=function(){return!!t.createElementNS&&!!t.createElementNS(N.svg,"svg").createSVGRect},M.inlinesvg=function(){var e=t.createElement("div");return e.innerHTML="<svg/>",(e.firstChild&&e.firstChild.namespaceURI)==N.svg},M.smil=function(){return!!t.createElementNS&&/SVGAnimate/.test(w.call(t.createElementNS(N.svg,"animate")))},M.svgclippaths=function(){return!!t.createElementNS&&/SVGClipPath/.test(w.call(t.createElementNS(N.svg,"clipPath")))};for(var H in M)f(M,H)&&(d=H.toLowerCase(),p[d]=M[H](),$.push((p[d]?"":"no-")+d));return p.input||l(),p.addTest=function(e,t){if("object"==typeof e)for(var r in e)f(e,r)&&p.addTest(r,e[r]);else{if(e=e.toLowerCase(),p[e]!==n)return p;t="function"==typeof t?t():t,"undefined"!=typeof h&&h&&(g.className+=" "+(t?"":"no-")+e),p[e]=t}return p},r(""),y=E=null,function(e,t){function n(e,t){var n=e.createElement("p"),r=e.getElementsByTagName("head")[0]||e.documentElement;return n.innerHTML="x<style>"+t+"</style>",r.insertBefore(n.lastChild,r.firstChild)}function r(){var e=y.elements;return"string"==typeof e?e.split(" "):e}function o(e){var t=v[e[h]];return t||(t={},g++,e[h]=g,v[g]=t),t}function a(e,n,r){if(n||(n=t),l)return n.createElement(e);r||(r=o(n));var a;return a=r.cache[e]?r.cache[e].cloneNode():p.test(e)?(r.cache[e]=r.createElem(e)).cloneNode():r.createElem(e),!a.canHaveChildren||m.test(e)||a.tagUrn?a:r.frag.appendChild(a)}function i(e,n){if(e||(e=t),l)return e.createDocumentFragment();n=n||o(e);for(var a=n.frag.cloneNode(),i=0,c=r(),s=c.length;s>i;i++)a.createElement(c[i]);return a}function c(e,t){t.cache||(t.cache={},t.createElem=e.createElement,t.createFrag=e.createDocumentFragment,t.frag=t.createFrag()),e.createElement=function(n){return y.shivMethods?a(n,e,t):t.createElem(n)},e.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+r().join().replace(/[\w\-]+/g,function(e){return t.createElem(e),t.frag.createElement(e),'c("'+e+'")'})+");return n}")(y,t.frag)}function s(e){e||(e=t);var r=o(e);return!y.shivCSS||u||r.hasCSS||(r.hasCSS=!!n(e,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||c(e,r),e}var u,l,d="3.7.0",f=e.html5||{},m=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,h="_html5shiv",g=0,v={};!function(){try{var e=t.createElement("a");e.innerHTML="<xyz></xyz>",u="hidden"in e,l=1==e.childNodes.length||function(){t.createElement("a");var e=t.createDocumentFragment();return"undefined"==typeof e.cloneNode||"undefined"==typeof e.createDocumentFragment||"undefined"==typeof e.createElement}()}catch(n){u=!0,l=!0}}();var y={elements:f.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output progress section summary template time video",version:d,shivCSS:f.shivCSS!==!1,supportsUnknownElements:l,shivMethods:f.shivMethods!==!1,type:"default",shivDocument:s,createElement:a,createDocumentFragment:i};e.html5=y,s(t)}(this,t),p._version=m,p._prefixes=S,p._domPrefixes=T,p._cssomPrefixes=k,p.mq=z,p.hasEvent=A,p.testProp=function(e){return c([e])},p.testAllProps=u,p.testStyles=F,p.prefixed=function(e,t,n){return t?u(e,t,n):u(e,"pfx")},g.className=g.className.replace(/(^|\s)no-js(\s|$)/,"$1$2")+(h?" js "+$.join(" "):""),p}(this,this.document); \ No newline at end of file | |||
diff --git a/doc/html/js/theme.js b/doc/html/js/theme.js new file mode 100644 index 00000000..99b146ec --- /dev/null +++ b/doc/html/js/theme.js | |||
| @@ -0,0 +1,82 @@ | |||
| 1 | $( document ).ready(function() { | ||
| 2 | // Shift nav in mobile when clicking the menu. | ||
| 3 | $(document).on('click', "[data-toggle='wy-nav-top']", function() { | ||
| 4 | $("[data-toggle='wy-nav-shift']").toggleClass("shift"); | ||
| 5 | $("[data-toggle='rst-versions']").toggleClass("shift"); | ||
| 6 | }); | ||
| 7 | |||
| 8 | // Close menu when you click a link. | ||
| 9 | $(document).on('click', ".wy-menu-vertical .current ul li a", function() { | ||
| 10 | $("[data-toggle='wy-nav-shift']").removeClass("shift"); | ||
| 11 | $("[data-toggle='rst-versions']").toggleClass("shift"); | ||
| 12 | }); | ||
| 13 | |||
| 14 | $(document).on('click', "[data-toggle='rst-current-version']", function() { | ||
| 15 | $("[data-toggle='rst-versions']").toggleClass("shift-up"); | ||
| 16 | }); | ||
| 17 | |||
| 18 | // Make tables responsive | ||
| 19 | $("table.docutils:not(.field-list)").wrap("<div class='wy-table-responsive'></div>"); | ||
| 20 | |||
| 21 | hljs.initHighlightingOnLoad(); | ||
| 22 | |||
| 23 | $('table').addClass('docutils'); | ||
| 24 | }); | ||
| 25 | |||
| 26 | window.SphinxRtdTheme = (function (jquery) { | ||
| 27 | var stickyNav = (function () { | ||
| 28 | var navBar, | ||
| 29 | win, | ||
| 30 | stickyNavCssClass = 'stickynav', | ||
| 31 | applyStickNav = function () { | ||
| 32 | if (navBar.height() <= win.height()) { | ||
| 33 | navBar.addClass(stickyNavCssClass); | ||
| 34 | } else { | ||
| 35 | navBar.removeClass(stickyNavCssClass); | ||
| 36 | } | ||
| 37 | }, | ||
| 38 | enable = function () { | ||
| 39 | applyStickNav(); | ||
| 40 | win.on('resize', applyStickNav); | ||
| 41 | }, | ||
| 42 | init = function () { | ||
| 43 | navBar = jquery('nav.wy-nav-side:first'); | ||
| 44 | win = jquery(window); | ||
| 45 | }; | ||
| 46 | jquery(init); | ||
| 47 | return { | ||
| 48 | enable : enable | ||
| 49 | }; | ||
| 50 | }()); | ||
| 51 | return { | ||
| 52 | StickyNav : stickyNav | ||
| 53 | }; | ||
| 54 | }($)); | ||
| 55 | |||
| 56 | // The code below is a copy of @seanmadsen code posted Jan 10, 2017 on issue 803. | ||
| 57 | // https://github.com/mkdocs/mkdocs/issues/803 | ||
| 58 | // This just incorporates the auto scroll into the theme itself without | ||
| 59 | // the need for additional custom.js file. | ||
| 60 | // | ||
| 61 | $(function() { | ||
| 62 | $.fn.isFullyWithinViewport = function(){ | ||
| 63 | var viewport = {}; | ||
| 64 | viewport.top = $(window).scrollTop(); | ||
| 65 | viewport.bottom = viewport.top + $(window).height(); | ||
| 66 | var bounds = {}; | ||
| 67 | bounds.top = this.offset().top; | ||
| 68 | bounds.bottom = bounds.top + this.outerHeight(); | ||
| 69 | return ( ! ( | ||
| 70 | (bounds.top <= viewport.top) || | ||
| 71 | (bounds.bottom >= viewport.bottom) | ||
| 72 | ) ); | ||
| 73 | }; | ||
| 74 | if( $('li.toctree-l1.current').length && !$('li.toctree-l1.current').isFullyWithinViewport() ) { | ||
| 75 | $('.wy-nav-side') | ||
| 76 | .scrollTop( | ||
| 77 | $('li.toctree-l1.current').offset().top - | ||
| 78 | $('.wy-nav-side').offset().top - | ||
| 79 | 60 | ||
| 80 | ); | ||
| 81 | } | ||
| 82 | }); | ||
diff --git a/doc/html/mkdocs/js/lunr.min.js b/doc/html/mkdocs/js/lunr.min.js new file mode 100644 index 00000000..b0198dff --- /dev/null +++ b/doc/html/mkdocs/js/lunr.min.js | |||
| @@ -0,0 +1,7 @@ | |||
| 1 | /** | ||
| 2 | * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 0.7.0 | ||
| 3 | * Copyright (C) 2016 Oliver Nightingale | ||
| 4 | * MIT Licensed | ||
| 5 | * @license | ||
| 6 | */ | ||
| 7 | !function(){var t=function(e){var n=new t.Index;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),e&&e.call(n,n),n};t.version="0.7.0",t.utils={},t.utils.warn=function(t){return function(e){t.console&&console.warn&&console.warn(e)}}(this),t.utils.asString=function(t){return void 0===t||null===t?"":t.toString()},t.EventEmitter=function(){this.events={}},t.EventEmitter.prototype.addListener=function(){var t=Array.prototype.slice.call(arguments),e=t.pop(),n=t;if("function"!=typeof e)throw new TypeError("last argument must be a function");n.forEach(function(t){this.hasHandler(t)||(this.events[t]=[]),this.events[t].push(e)},this)},t.EventEmitter.prototype.removeListener=function(t,e){if(this.hasHandler(t)){var n=this.events[t].indexOf(e);this.events[t].splice(n,1),this.events[t].length||delete this.events[t]}},t.EventEmitter.prototype.emit=function(t){if(this.hasHandler(t)){var e=Array.prototype.slice.call(arguments,1);this.events[t].forEach(function(t){t.apply(void 0,e)})}},t.EventEmitter.prototype.hasHandler=function(t){return t in this.events},t.tokenizer=function(e){return arguments.length&&null!=e&&void 0!=e?Array.isArray(e)?e.map(function(e){return t.utils.asString(e).toLowerCase()}):e.toString().trim().toLowerCase().split(t.tokenizer.seperator):[]},t.tokenizer.seperator=/[\s\-]+/,t.tokenizer.load=function(t){var e=this.registeredFunctions[t];if(!e)throw new Error("Cannot load un-registered function: "+t);return e},t.tokenizer.label="default",t.tokenizer.registeredFunctions={"default":t.tokenizer},t.tokenizer.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing tokenizer: "+n),e.label=n,this.registeredFunctions[n]=e},t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions={},t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(e){var i=t.Pipeline.registeredFunctions[e];if(!i)throw new Error("Cannot load un-registered function: "+e);n.add(i)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(e){t.Pipeline.warnIfFunctionNotRegistered(e),this._stack.push(e)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._stack.indexOf(e);if(-1==i)throw new Error("Cannot find existingFn");i+=1,this._stack.splice(i,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._stack.indexOf(e);if(-1==i)throw new Error("Cannot find existingFn");this._stack.splice(i,0,n)},t.Pipeline.prototype.remove=function(t){var e=this._stack.indexOf(t);-1!=e&&this._stack.splice(e,1)},t.Pipeline.prototype.run=function(t){for(var e=[],n=t.length,i=this._stack.length,r=0;n>r;r++){for(var o=t[r],s=0;i>s&&(o=this._stack[s](o,r,t),void 0!==o&&""!==o);s++);void 0!==o&&""!==o&&e.push(o)}return e},t.Pipeline.prototype.reset=function(){this._stack=[]},t.Pipeline.prototype.toJSON=function(){return this._stack.map(function(e){return t.Pipeline.warnIfFunctionNotRegistered(e),e.label})},t.Vector=function(){this._magnitude=null,this.list=void 0,this.length=0},t.Vector.Node=function(t,e,n){this.idx=t,this.val=e,this.next=n},t.Vector.prototype.insert=function(e,n){this._magnitude=void 0;var i=this.list;if(!i)return this.list=new t.Vector.Node(e,n,i),this.length++;if(e<i.idx)return this.list=new t.Vector.Node(e,n,i),this.length++;for(var r=i,o=i.next;void 0!=o;){if(e<o.idx)return r.next=new t.Vector.Node(e,n,o),this.length++;r=o,o=o.next}return r.next=new t.Vector.Node(e,n,o),this.length++},t.Vector.prototype.magnitude=function(){if(this._magnitude)return this._magnitude;for(var t,e=this.list,n=0;e;)t=e.val,n+=t*t,e=e.next;return this._magnitude=Math.sqrt(n)},t.Vector.prototype.dot=function(t){for(var e=this.list,n=t.list,i=0;e&&n;)e.idx<n.idx?e=e.next:e.idx>n.idx?n=n.next:(i+=e.val*n.val,e=e.next,n=n.next);return i},t.Vector.prototype.similarity=function(t){return this.dot(t)/(this.magnitude()*t.magnitude())},t.SortedSet=function(){this.length=0,this.elements=[]},t.SortedSet.load=function(t){var e=new this;return e.elements=t,e.length=t.length,e},t.SortedSet.prototype.add=function(){var t,e;for(t=0;t<arguments.length;t++)e=arguments[t],~this.indexOf(e)||this.elements.splice(this.locationFor(e),0,e);this.length=this.elements.length},t.SortedSet.prototype.toArray=function(){return this.elements.slice()},t.SortedSet.prototype.map=function(t,e){return this.elements.map(t,e)},t.SortedSet.prototype.forEach=function(t,e){return this.elements.forEach(t,e)},t.SortedSet.prototype.indexOf=function(t){for(var e=0,n=this.elements.length,i=n-e,r=e+Math.floor(i/2),o=this.elements[r];i>1;){if(o===t)return r;t>o&&(e=r),o>t&&(n=r),i=n-e,r=e+Math.floor(i/2),o=this.elements[r]}return o===t?r:-1},t.SortedSet.prototype.locationFor=function(t){for(var e=0,n=this.elements.length,i=n-e,r=e+Math.floor(i/2),o=this.elements[r];i>1;)t>o&&(e=r),o>t&&(n=r),i=n-e,r=e+Math.floor(i/2),o=this.elements[r];return o>t?r:t>o?r+1:void 0},t.SortedSet.prototype.intersect=function(e){for(var n=new t.SortedSet,i=0,r=0,o=this.length,s=e.length,a=this.elements,h=e.elements;;){if(i>o-1||r>s-1)break;a[i]!==h[r]?a[i]<h[r]?i++:a[i]>h[r]&&r++:(n.add(a[i]),i++,r++)}return n},t.SortedSet.prototype.clone=function(){var e=new t.SortedSet;return e.elements=this.toArray(),e.length=e.elements.length,e},t.SortedSet.prototype.union=function(t){var e,n,i;this.length>=t.length?(e=this,n=t):(e=t,n=this),i=e.clone();for(var r=0,o=n.toArray();r<o.length;r++)i.add(o[r]);return i},t.SortedSet.prototype.toJSON=function(){return this.toArray()},t.Index=function(){this._fields=[],this._ref="id",this.pipeline=new t.Pipeline,this.documentStore=new t.Store,this.tokenStore=new t.TokenStore,this.corpusTokens=new t.SortedSet,this.eventEmitter=new t.EventEmitter,this.tokenizerFn=t.tokenizer,this._idfCache={},this.on("add","remove","update",function(){this._idfCache={}}.bind(this))},t.Index.prototype.on=function(){var t=Array.prototype.slice.call(arguments);return this.eventEmitter.addListener.apply(this.eventEmitter,t)},t.Index.prototype.off=function(t,e){return this.eventEmitter.removeListener(t,e)},t.Index.load=function(e){e.version!==t.version&&t.utils.warn("version mismatch: current "+t.version+" importing "+e.version);var n=new this;return n._fields=e.fields,n._ref=e.ref,n.tokenizer=t.tokenizer.load(e.tokenizer),n.documentStore=t.Store.load(e.documentStore),n.tokenStore=t.TokenStore.load(e.tokenStore),n.corpusTokens=t.SortedSet.load(e.corpusTokens),n.pipeline=t.Pipeline.load(e.pipeline),n},t.Index.prototype.field=function(t,e){var e=e||{},n={name:t,boost:e.boost||1};return this._fields.push(n),this},t.Index.prototype.ref=function(t){return this._ref=t,this},t.Index.prototype.tokenizer=function(e){var n=e.label&&e.label in t.tokenizer.registeredFunctions;return n||t.utils.warn("Function is not a registered tokenizer. This may cause problems when serialising the index"),this.tokenizerFn=e,this},t.Index.prototype.add=function(e,n){var i={},r=new t.SortedSet,o=e[this._ref],n=void 0===n?!0:n;this._fields.forEach(function(t){var n=this.pipeline.run(this.tokenizerFn(e[t.name]));i[t.name]=n;for(var o=0;o<n.length;o++){var s=n[o];r.add(s),this.corpusTokens.add(s)}},this),this.documentStore.set(o,r);for(var s=0;s<r.length;s++){for(var a=r.elements[s],h=0,u=0;u<this._fields.length;u++){var l=this._fields[u],c=i[l.name],f=c.length;if(f){for(var d=0,p=0;f>p;p++)c[p]===a&&d++;h+=d/f*l.boost}}this.tokenStore.add(a,{ref:o,tf:h})}n&&this.eventEmitter.emit("add",e,this)},t.Index.prototype.remove=function(t,e){var n=t[this._ref],e=void 0===e?!0:e;if(this.documentStore.has(n)){var i=this.documentStore.get(n);this.documentStore.remove(n),i.forEach(function(t){this.tokenStore.remove(t,n)},this),e&&this.eventEmitter.emit("remove",t,this)}},t.Index.prototype.update=function(t,e){var e=void 0===e?!0:e;this.remove(t,!1),this.add(t,!1),e&&this.eventEmitter.emit("update",t,this)},t.Index.prototype.idf=function(t){var e="@"+t;if(Object.prototype.hasOwnProperty.call(this._idfCache,e))return this._idfCache[e];var n=this.tokenStore.count(t),i=1;return n>0&&(i=1+Math.log(this.documentStore.length/n)),this._idfCache[e]=i},t.Index.prototype.search=function(e){var n=this.pipeline.run(this.tokenizerFn(e)),i=new t.Vector,r=[],o=this._fields.reduce(function(t,e){return t+e.boost},0),s=n.some(function(t){return this.tokenStore.has(t)},this);if(!s)return[];n.forEach(function(e,n,s){var a=1/s.length*this._fields.length*o,h=this,u=this.tokenStore.expand(e).reduce(function(n,r){var o=h.corpusTokens.indexOf(r),s=h.idf(r),u=1,l=new t.SortedSet;if(r!==e){var c=Math.max(3,r.length-e.length);u=1/Math.log(c)}o>-1&&i.insert(o,a*s*u);for(var f=h.tokenStore.get(r),d=Object.keys(f),p=d.length,v=0;p>v;v++)l.add(f[d[v]].ref);return n.union(l)},new t.SortedSet);r.push(u)},this);var a=r.reduce(function(t,e){return t.intersect(e)});return a.map(function(t){return{ref:t,score:i.similarity(this.documentVector(t))}},this).sort(function(t,e){return e.score-t.score})},t.Index.prototype.documentVector=function(e){for(var n=this.documentStore.get(e),i=n.length,r=new t.Vector,o=0;i>o;o++){var s=n.elements[o],a=this.tokenStore.get(s)[e].tf,h=this.idf(s);r.insert(this.corpusTokens.indexOf(s),a*h)}return r},t.Index.prototype.toJSON=function(){return{version:t.version,fields:this._fields,ref:this._ref,tokenizer:this.tokenizerFn.label,documentStore:this.documentStore.toJSON(),tokenStore:this.tokenStore.toJSON(),corpusTokens:this.corpusTokens.toJSON(),pipeline:this.pipeline.toJSON()}},t.Index.prototype.use=function(t){var e=Array.prototype.slice.call(arguments,1);e.unshift(this),t.apply(this,e)},t.Store=function(){this.store={},this.length=0},t.Store.load=function(e){var n=new this;return n.length=e.length,n.store=Object.keys(e.store).reduce(function(n,i){return n[i]=t.SortedSet.load(e.store[i]),n},{}),n},t.Store.prototype.set=function(t,e){this.has(t)||this.length++,this.store[t]=e},t.Store.prototype.get=function(t){return this.store[t]},t.Store.prototype.has=function(t){return t in this.store},t.Store.prototype.remove=function(t){this.has(t)&&(delete this.store[t],this.length--)},t.Store.prototype.toJSON=function(){return{store:this.store,length:this.length}},t.stemmer=function(){var t={ational:"ate",tional:"tion",enci:"ence",anci:"ance",izer:"ize",bli:"ble",alli:"al",entli:"ent",eli:"e",ousli:"ous",ization:"ize",ation:"ate",ator:"ate",alism:"al",iveness:"ive",fulness:"ful",ousness:"ous",aliti:"al",iviti:"ive",biliti:"ble",logi:"log"},e={icate:"ic",ative:"",alize:"al",iciti:"ic",ical:"ic",ful:"",ness:""},n="[^aeiou]",i="[aeiouy]",r=n+"[^aeiouy]*",o=i+"[aeiou]*",s="^("+r+")?"+o+r,a="^("+r+")?"+o+r+"("+o+")?$",h="^("+r+")?"+o+r+o+r,u="^("+r+")?"+i,l=new RegExp(s),c=new RegExp(h),f=new RegExp(a),d=new RegExp(u),p=/^(.+?)(ss|i)es$/,v=/^(.+?)([^s])s$/,g=/^(.+?)eed$/,m=/^(.+?)(ed|ing)$/,y=/.$/,S=/(at|bl|iz)$/,w=new RegExp("([^aeiouylsz])\\1$"),k=new RegExp("^"+r+i+"[^aeiouwxy]$"),x=/^(.+?[^aeiou])y$/,b=/^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/,E=/^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/,F=/^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/,_=/^(.+?)(s|t)(ion)$/,z=/^(.+?)e$/,O=/ll$/,P=new RegExp("^"+r+i+"[^aeiouwxy]$"),T=function(n){var i,r,o,s,a,h,u;if(n.length<3)return n;if(o=n.substr(0,1),"y"==o&&(n=o.toUpperCase()+n.substr(1)),s=p,a=v,s.test(n)?n=n.replace(s,"$1$2"):a.test(n)&&(n=n.replace(a,"$1$2")),s=g,a=m,s.test(n)){var T=s.exec(n);s=l,s.test(T[1])&&(s=y,n=n.replace(s,""))}else if(a.test(n)){var T=a.exec(n);i=T[1],a=d,a.test(i)&&(n=i,a=S,h=w,u=k,a.test(n)?n+="e":h.test(n)?(s=y,n=n.replace(s,"")):u.test(n)&&(n+="e"))}if(s=x,s.test(n)){var T=s.exec(n);i=T[1],n=i+"i"}if(s=b,s.test(n)){var T=s.exec(n);i=T[1],r=T[2],s=l,s.test(i)&&(n=i+t[r])}if(s=E,s.test(n)){var T=s.exec(n);i=T[1],r=T[2],s=l,s.test(i)&&(n=i+e[r])}if(s=F,a=_,s.test(n)){var T=s.exec(n);i=T[1],s=c,s.test(i)&&(n=i)}else if(a.test(n)){var T=a.exec(n);i=T[1]+T[2],a=c,a.test(i)&&(n=i)}if(s=z,s.test(n)){var T=s.exec(n);i=T[1],s=c,a=f,h=P,(s.test(i)||a.test(i)&&!h.test(i))&&(n=i)}return s=O,a=c,s.test(n)&&a.test(n)&&(s=y,n=n.replace(s,"")),"y"==o&&(n=o.toLowerCase()+n.substr(1)),n};return T}(),t.Pipeline.registerFunction(t.stemmer,"stemmer"),t.generateStopWordFilter=function(t){var e=t.reduce(function(t,e){return t[e]=e,t},{});return function(t){return t&&e[t]!==t?t:void 0}},t.stopWordFilter=t.generateStopWordFilter(["a","able","about","across","after","all","almost","also","am","among","an","and","any","are","as","at","be","because","been","but","by","can","cannot","could","dear","did","do","does","either","else","ever","every","for","from","get","got","had","has","have","he","her","hers","him","his","how","however","i","if","in","into","is","it","its","just","least","let","like","likely","may","me","might","most","must","my","neither","no","nor","not","of","off","often","on","only","or","other","our","own","rather","said","say","says","she","should","since","so","some","than","that","the","their","them","then","there","these","they","this","tis","to","too","twas","us","wants","was","we","were","what","when","where","which","while","who","whom","why","will","with","would","yet","you","your"]),t.Pipeline.registerFunction(t.stopWordFilter,"stopWordFilter"),t.trimmer=function(t){return t.replace(/^\W+/,"").replace(/\W+$/,"")},t.Pipeline.registerFunction(t.trimmer,"trimmer"),t.TokenStore=function(){this.root={docs:{}},this.length=0},t.TokenStore.load=function(t){var e=new this;return e.root=t.root,e.length=t.length,e},t.TokenStore.prototype.add=function(t,e,n){var n=n||this.root,i=t.charAt(0),r=t.slice(1);return i in n||(n[i]={docs:{}}),0===r.length?(n[i].docs[e.ref]=e,void(this.length+=1)):this.add(r,e,n[i])},t.TokenStore.prototype.has=function(t){if(!t)return!1;for(var e=this.root,n=0;n<t.length;n++){if(!e[t.charAt(n)])return!1;e=e[t.charAt(n)]}return!0},t.TokenStore.prototype.getNode=function(t){if(!t)return{};for(var e=this.root,n=0;n<t.length;n++){if(!e[t.charAt(n)])return{};e=e[t.charAt(n)]}return e},t.TokenStore.prototype.get=function(t,e){return this.getNode(t,e).docs||{}},t.TokenStore.prototype.count=function(t,e){return Object.keys(this.get(t,e)).length},t.TokenStore.prototype.remove=function(t,e){if(t){for(var n=this.root,i=0;i<t.length;i++){if(!(t.charAt(i)in n))return;n=n[t.charAt(i)]}delete n.docs[e]}},t.TokenStore.prototype.expand=function(t,e){var n=this.getNode(t),i=n.docs||{},e=e||[];return Object.keys(i).length&&e.push(t),Object.keys(n).forEach(function(n){"docs"!==n&&e.concat(this.expand(t+n,e))},this),e},t.TokenStore.prototype.toJSON=function(){return{root:this.root,length:this.length}},function(t,e){"function"==typeof define&&define.amd?define(e):"object"==typeof exports?module.exports=e():t.lunr=e()}(this,function(){return t})}(); | ||
diff --git a/doc/html/mkdocs/js/mustache.min.js b/doc/html/mkdocs/js/mustache.min.js new file mode 100644 index 00000000..7fc6da86 --- /dev/null +++ b/doc/html/mkdocs/js/mustache.min.js | |||
| @@ -0,0 +1 @@ | |||
| (function(global,factory){if(typeof exports==="object"&&exports){factory(exports)}else if(typeof define==="function"&&define.amd){define(["exports"],factory)}else{factory(global.Mustache={})}})(this,function(mustache){var Object_toString=Object.prototype.toString;var isArray=Array.isArray||function(object){return Object_toString.call(object)==="[object Array]"};function isFunction(object){return typeof object==="function"}function escapeRegExp(string){return string.replace(/[\-\[\]{}()*+?.,\\\^$|#\s]/g,"\\$&")}var RegExp_test=RegExp.prototype.test;function testRegExp(re,string){return RegExp_test.call(re,string)}var nonSpaceRe=/\S/;function isWhitespace(string){return!testRegExp(nonSpaceRe,string)}var entityMap={"&":"&","<":"<",">":">",'"':""","'":"'","/":"/"};function escapeHtml(string){return String(string).replace(/[&<>"'\/]/g,function(s){return entityMap[s]})}var whiteRe=/\s*/;var spaceRe=/\s+/;var equalsRe=/\s*=/;var curlyRe=/\s*\}/;var tagRe=/#|\^|\/|>|\{|&|=|!/;function parseTemplate(template,tags){if(!template)return[];var sections=[];var tokens=[];var spaces=[];var hasTag=false;var nonSpace=false;function stripSpace(){if(hasTag&&!nonSpace){while(spaces.length)delete tokens[spaces.pop()]}else{spaces=[]}hasTag=false;nonSpace=false}var openingTagRe,closingTagRe,closingCurlyRe;function compileTags(tags){if(typeof tags==="string")tags=tags.split(spaceRe,2);if(!isArray(tags)||tags.length!==2)throw new Error("Invalid tags: "+tags);openingTagRe=new RegExp(escapeRegExp(tags[0])+"\\s*");closingTagRe=new RegExp("\\s*"+escapeRegExp(tags[1]));closingCurlyRe=new RegExp("\\s*"+escapeRegExp("}"+tags[1]))}compileTags(tags||mustache.tags);var scanner=new Scanner(template);var start,type,value,chr,token,openSection;while(!scanner.eos()){start=scanner.pos;value=scanner.scanUntil(openingTagRe);if(value){for(var i=0,valueLength=value.length;i<valueLength;++i){chr=value.charAt(i);if(isWhitespace(chr)){spaces.push(tokens.length)}else{nonSpace=true}tokens.push(["text",chr,start,start+1]);start+=1;if(chr==="\n")stripSpace()}}if(!scanner.scan(openingTagRe))break;hasTag=true;type=scanner.scan(tagRe)||"name";scanner.scan(whiteRe);if(type==="="){value=scanner.scanUntil(equalsRe);scanner.scan(equalsRe);scanner.scanUntil(closingTagRe)}else if(type==="{"){value=scanner.scanUntil(closingCurlyRe);scanner.scan(curlyRe);scanner.scanUntil(closingTagRe);type="&"}else{value=scanner.scanUntil(closingTagRe)}if(!scanner.scan(closingTagRe))throw new Error("Unclosed tag at "+scanner.pos);token=[type,value,start,scanner.pos];tokens.push(token);if(type==="#"||type==="^"){sections.push(token)}else if(type==="/"){openSection=sections.pop();if(!openSection)throw new Error('Unopened section "'+value+'" at '+start);if(openSection[1]!==value)throw new Error('Unclosed section "'+openSection[1]+'" at '+start)}else if(type==="name"||type==="{"||type==="&"){nonSpace=true}else if(type==="="){compileTags(value)}}openSection=sections.pop();if(openSection)throw new Error('Unclosed section "'+openSection[1]+'" at '+scanner.pos);return nestTokens(squashTokens(tokens))}function squashTokens(tokens){var squashedTokens=[];var token,lastToken;for(var i=0,numTokens=tokens.length;i<numTokens;++i){token=tokens[i];if(token){if(token[0]==="text"&&lastToken&&lastToken[0]==="text"){lastToken[1]+=token[1];lastToken[3]=token[3]}else{squashedTokens.push(token);lastToken=token}}}return squashedTokens}function nestTokens(tokens){var nestedTokens=[];var collector=nestedTokens;var sections=[];var token,section;for(var i=0,numTokens=tokens.length;i<numTokens;++i){token=tokens[i];switch(token[0]){case"#":case"^":collector.push(token);sections.push(token);collector=token[4]=[];break;case"/":section=sections.pop();section[5]=token[2];collector=sections.length>0?sections[sections.length-1][4]:nestedTokens;break;default:collector.push(token)}}return nestedTokens}function Scanner(string){this.string=string;this.tail=string;this.pos=0}Scanner.prototype.eos=function(){return this.tail===""};Scanner.prototype.scan=function(re){var match=this.tail.match(re);if(!match||match.index!==0)return"";var string=match[0];this.tail=this.tail.substring(string.length);this.pos+=string.length;return string};Scanner.prototype.scanUntil=function(re){var index=this.tail.search(re),match;switch(index){case-1:match=this.tail;this.tail="";break;case 0:match="";break;default:match=this.tail.substring(0,index);this.tail=this.tail.substring(index)}this.pos+=match.length;return match};function Context(view,parentContext){this.view=view;this.cache={".":this.view};this.parent=parentContext}Context.prototype.push=function(view){return new Context(view,this)};Context.prototype.lookup=function(name){var cache=this.cache;var value;if(name in cache){value=cache[name]}else{var context=this,names,index,lookupHit=false;while(context){if(name.indexOf(".")>0){value=context.view;names=name.split(".");index=0;while(value!=null&&index<names.length){if(index===names.length-1&&value!=null)lookupHit=typeof value==="object"&&value.hasOwnProperty(names[index]);value=value[names[index++]]}}else if(context.view!=null&&typeof context.view==="object"){value=context.view[name];lookupHit=context.view.hasOwnProperty(name)}if(lookupHit)break;context=context.parent}cache[name]=value}if(isFunction(value))value=value.call(this.view);return value};function Writer(){this.cache={}}Writer.prototype.clearCache=function(){this.cache={}};Writer.prototype.parse=function(template,tags){var cache=this.cache;var tokens=cache[template];if(tokens==null)tokens=cache[template]=parseTemplate(template,tags);return tokens};Writer.prototype.render=function(template,view,partials){var tokens=this.parse(template);var context=view instanceof Context?view:new Context(view);return this.renderTokens(tokens,context,partials,template)};Writer.prototype.renderTokens=function(tokens,context,partials,originalTemplate){var buffer="";var token,symbol,value;for(var i=0,numTokens=tokens.length;i<numTokens;++i){value=undefined;token=tokens[i];symbol=token[0];if(symbol==="#")value=this._renderSection(token,context,partials,originalTemplate);else if(symbol==="^")value=this._renderInverted(token,context,partials,originalTemplate);else if(symbol===">")value=this._renderPartial(token,context,partials,originalTemplate);else if(symbol==="&")value=this._unescapedValue(token,context);else if(symbol==="name")value=this._escapedValue(token,context);else if(symbol==="text")value=this._rawValue(token);if(value!==undefined)buffer+=value}return buffer};Writer.prototype._renderSection=function(token,context,partials,originalTemplate){var self=this;var buffer="";var value=context.lookup(token[1]);function subRender(template){return self.render(template,context,partials)}if(!value)return;if(isArray(value)){for(var j=0,valueLength=value.length;j<valueLength;++j){buffer+=this.renderTokens(token[4],context.push(value[j]),partials,originalTemplate)}}else if(typeof value==="object"||typeof value==="string"||typeof value==="number"){buffer+=this.renderTokens(token[4],context.push(value),partials,originalTemplate)}else if(isFunction(value)){if(typeof originalTemplate!=="string")throw new Error("Cannot use higher-order sections without the original template");value=value.call(context.view,originalTemplate.slice(token[3],token[5]),subRender);if(value!=null)buffer+=value}else{buffer+=this.renderTokens(token[4],context,partials,originalTemplate)}return buffer};Writer.prototype._renderInverted=function(token,context,partials,originalTemplate){var value=context.lookup(token[1]);if(!value||isArray(value)&&value.length===0)return this.renderTokens(token[4],context,partials,originalTemplate)};Writer.prototype._renderPartial=function(token,context,partials){if(!partials)return;var value=isFunction(partials)?partials(token[1]):partials[token[1]];if(value!=null)return this.renderTokens(this.parse(value),context,partials,value)};Writer.prototype._unescapedValue=function(token,context){var value=context.lookup(token[1]);if(value!=null)return value};Writer.prototype._escapedValue=function(token,context){var value=context.lookup(token[1]);if(value!=null)return mustache.escape(value)};Writer.prototype._rawValue=function(token){return token[1]};mustache.name="mustache.js";mustache.version="2.0.0";mustache.tags=["{{","}}"];var defaultWriter=new Writer;mustache.clearCache=function(){return defaultWriter.clearCache()};mustache.parse=function(template,tags){return defaultWriter.parse(template,tags)};mustache.render=function(template,view,partials){return defaultWriter.render(template,view,partials)};mustache.to_html=function(template,view,partials,send){var result=mustache.render(template,view,partials);if(isFunction(send)){send(result)}else{return result}};mustache.escape=escapeHtml;mustache.Scanner=Scanner;mustache.Context=Context;mustache.Writer=Writer}); \ No newline at end of file | |||
diff --git a/doc/html/mkdocs/js/require.js b/doc/html/mkdocs/js/require.js new file mode 100644 index 00000000..8638a310 --- /dev/null +++ b/doc/html/mkdocs/js/require.js | |||
| @@ -0,0 +1,36 @@ | |||
| 1 | /* | ||
| 2 | RequireJS 2.1.16 Copyright (c) 2010-2015, The Dojo Foundation All Rights Reserved. | ||
| 3 | Available via the MIT or new BSD license. | ||
| 4 | see: http://github.com/jrburke/requirejs for details | ||
| 5 | */ | ||
| 6 | var requirejs,require,define; | ||
| 7 | (function(ba){function G(b){return"[object Function]"===K.call(b)}function H(b){return"[object Array]"===K.call(b)}function v(b,c){if(b){var d;for(d=0;d<b.length&&(!b[d]||!c(b[d],d,b));d+=1);}}function T(b,c){if(b){var d;for(d=b.length-1;-1<d&&(!b[d]||!c(b[d],d,b));d-=1);}}function t(b,c){return fa.call(b,c)}function m(b,c){return t(b,c)&&b[c]}function B(b,c){for(var d in b)if(t(b,d)&&c(b[d],d))break}function U(b,c,d,e){c&&B(c,function(c,g){if(d||!t(b,g))e&&"object"===typeof c&&c&&!H(c)&&!G(c)&&!(c instanceof | ||
| 8 | RegExp)?(b[g]||(b[g]={}),U(b[g],c,d,e)):b[g]=c});return b}function u(b,c){return function(){return c.apply(b,arguments)}}function ca(b){throw b;}function da(b){if(!b)return b;var c=ba;v(b.split("."),function(b){c=c[b]});return c}function C(b,c,d,e){c=Error(c+"\nhttp://requirejs.org/docs/errors.html#"+b);c.requireType=b;c.requireModules=e;d&&(c.originalError=d);return c}function ga(b){function c(a,k,b){var f,l,c,d,e,g,i,p,k=k&&k.split("/"),h=j.map,n=h&&h["*"];if(a){a=a.split("/");l=a.length-1;j.nodeIdCompat&& | ||
| 9 | Q.test(a[l])&&(a[l]=a[l].replace(Q,""));"."===a[0].charAt(0)&&k&&(l=k.slice(0,k.length-1),a=l.concat(a));l=a;for(c=0;c<l.length;c++)if(d=l[c],"."===d)l.splice(c,1),c-=1;else if(".."===d&&!(0===c||1==c&&".."===l[2]||".."===l[c-1])&&0<c)l.splice(c-1,2),c-=2;a=a.join("/")}if(b&&h&&(k||n)){l=a.split("/");c=l.length;a:for(;0<c;c-=1){e=l.slice(0,c).join("/");if(k)for(d=k.length;0<d;d-=1)if(b=m(h,k.slice(0,d).join("/")))if(b=m(b,e)){f=b;g=c;break a}!i&&(n&&m(n,e))&&(i=m(n,e),p=c)}!f&&i&&(f=i,g=p);f&&(l.splice(0, | ||
| 10 | g,f),a=l.join("/"))}return(f=m(j.pkgs,a))?f:a}function d(a){z&&v(document.getElementsByTagName("script"),function(k){if(k.getAttribute("data-requiremodule")===a&&k.getAttribute("data-requirecontext")===i.contextName)return k.parentNode.removeChild(k),!0})}function e(a){var k=m(j.paths,a);if(k&&H(k)&&1<k.length)return k.shift(),i.require.undef(a),i.makeRequire(null,{skipMap:!0})([a]),!0}function n(a){var k,c=a?a.indexOf("!"):-1;-1<c&&(k=a.substring(0,c),a=a.substring(c+1,a.length));return[k,a]}function p(a, | ||
| 11 | k,b,f){var l,d,e=null,g=k?k.name:null,j=a,p=!0,h="";a||(p=!1,a="_@r"+(K+=1));a=n(a);e=a[0];a=a[1];e&&(e=c(e,g,f),d=m(r,e));a&&(e?h=d&&d.normalize?d.normalize(a,function(a){return c(a,g,f)}):-1===a.indexOf("!")?c(a,g,f):a:(h=c(a,g,f),a=n(h),e=a[0],h=a[1],b=!0,l=i.nameToUrl(h)));b=e&&!d&&!b?"_unnormalized"+(O+=1):"";return{prefix:e,name:h,parentMap:k,unnormalized:!!b,url:l,originalName:j,isDefine:p,id:(e?e+"!"+h:h)+b}}function s(a){var k=a.id,b=m(h,k);b||(b=h[k]=new i.Module(a));return b}function q(a, | ||
| 12 | k,b){var f=a.id,c=m(h,f);if(t(r,f)&&(!c||c.defineEmitComplete))"defined"===k&&b(r[f]);else if(c=s(a),c.error&&"error"===k)b(c.error);else c.on(k,b)}function w(a,b){var c=a.requireModules,f=!1;if(b)b(a);else if(v(c,function(b){if(b=m(h,b))b.error=a,b.events.error&&(f=!0,b.emit("error",a))}),!f)g.onError(a)}function x(){R.length&&(ha.apply(A,[A.length,0].concat(R)),R=[])}function y(a){delete h[a];delete V[a]}function F(a,b,c){var f=a.map.id;a.error?a.emit("error",a.error):(b[f]=!0,v(a.depMaps,function(f, | ||
| 13 | d){var e=f.id,g=m(h,e);g&&(!a.depMatched[d]&&!c[e])&&(m(b,e)?(a.defineDep(d,r[e]),a.check()):F(g,b,c))}),c[f]=!0)}function D(){var a,b,c=(a=1E3*j.waitSeconds)&&i.startTime+a<(new Date).getTime(),f=[],l=[],g=!1,h=!0;if(!W){W=!0;B(V,function(a){var i=a.map,j=i.id;if(a.enabled&&(i.isDefine||l.push(a),!a.error))if(!a.inited&&c)e(j)?g=b=!0:(f.push(j),d(j));else if(!a.inited&&(a.fetched&&i.isDefine)&&(g=!0,!i.prefix))return h=!1});if(c&&f.length)return a=C("timeout","Load timeout for modules: "+f,null, | ||
| 14 | f),a.contextName=i.contextName,w(a);h&&v(l,function(a){F(a,{},{})});if((!c||b)&&g)if((z||ea)&&!X)X=setTimeout(function(){X=0;D()},50);W=!1}}function E(a){t(r,a[0])||s(p(a[0],null,!0)).init(a[1],a[2])}function I(a){var a=a.currentTarget||a.srcElement,b=i.onScriptLoad;a.detachEvent&&!Y?a.detachEvent("onreadystatechange",b):a.removeEventListener("load",b,!1);b=i.onScriptError;(!a.detachEvent||Y)&&a.removeEventListener("error",b,!1);return{node:a,id:a&&a.getAttribute("data-requiremodule")}}function J(){var a; | ||
| 15 | for(x();A.length;){a=A.shift();if(null===a[0])return w(C("mismatch","Mismatched anonymous define() module: "+a[a.length-1]));E(a)}}var W,Z,i,L,X,j={waitSeconds:7,baseUrl:"./",paths:{},bundles:{},pkgs:{},shim:{},config:{}},h={},V={},$={},A=[],r={},S={},aa={},K=1,O=1;L={require:function(a){return a.require?a.require:a.require=i.makeRequire(a.map)},exports:function(a){a.usingExports=!0;if(a.map.isDefine)return a.exports?r[a.map.id]=a.exports:a.exports=r[a.map.id]={}},module:function(a){return a.module? | ||
| 16 | a.module:a.module={id:a.map.id,uri:a.map.url,config:function(){return m(j.config,a.map.id)||{}},exports:a.exports||(a.exports={})}}};Z=function(a){this.events=m($,a.id)||{};this.map=a;this.shim=m(j.shim,a.id);this.depExports=[];this.depMaps=[];this.depMatched=[];this.pluginMaps={};this.depCount=0};Z.prototype={init:function(a,b,c,f){f=f||{};if(!this.inited){this.factory=b;if(c)this.on("error",c);else this.events.error&&(c=u(this,function(a){this.emit("error",a)}));this.depMaps=a&&a.slice(0);this.errback= | ||
| 17 | c;this.inited=!0;this.ignore=f.ignore;f.enabled||this.enabled?this.enable():this.check()}},defineDep:function(a,b){this.depMatched[a]||(this.depMatched[a]=!0,this.depCount-=1,this.depExports[a]=b)},fetch:function(){if(!this.fetched){this.fetched=!0;i.startTime=(new Date).getTime();var a=this.map;if(this.shim)i.makeRequire(this.map,{enableBuildCallback:!0})(this.shim.deps||[],u(this,function(){return a.prefix?this.callPlugin():this.load()}));else return a.prefix?this.callPlugin():this.load()}},load:function(){var a= | ||
| 18 | this.map.url;S[a]||(S[a]=!0,i.load(this.map.id,a))},check:function(){if(this.enabled&&!this.enabling){var a,b,c=this.map.id;b=this.depExports;var f=this.exports,l=this.factory;if(this.inited)if(this.error)this.emit("error",this.error);else{if(!this.defining){this.defining=!0;if(1>this.depCount&&!this.defined){if(G(l)){if(this.events.error&&this.map.isDefine||g.onError!==ca)try{f=i.execCb(c,l,b,f)}catch(d){a=d}else f=i.execCb(c,l,b,f);this.map.isDefine&&void 0===f&&((b=this.module)?f=b.exports:this.usingExports&& | ||
| 19 | (f=this.exports));if(a)return a.requireMap=this.map,a.requireModules=this.map.isDefine?[this.map.id]:null,a.requireType=this.map.isDefine?"define":"require",w(this.error=a)}else f=l;this.exports=f;if(this.map.isDefine&&!this.ignore&&(r[c]=f,g.onResourceLoad))g.onResourceLoad(i,this.map,this.depMaps);y(c);this.defined=!0}this.defining=!1;this.defined&&!this.defineEmitted&&(this.defineEmitted=!0,this.emit("defined",this.exports),this.defineEmitComplete=!0)}}else this.fetch()}},callPlugin:function(){var a= | ||
| 20 | this.map,b=a.id,d=p(a.prefix);this.depMaps.push(d);q(d,"defined",u(this,function(f){var l,d;d=m(aa,this.map.id);var e=this.map.name,P=this.map.parentMap?this.map.parentMap.name:null,n=i.makeRequire(a.parentMap,{enableBuildCallback:!0});if(this.map.unnormalized){if(f.normalize&&(e=f.normalize(e,function(a){return c(a,P,!0)})||""),f=p(a.prefix+"!"+e,this.map.parentMap),q(f,"defined",u(this,function(a){this.init([],function(){return a},null,{enabled:!0,ignore:!0})})),d=m(h,f.id)){this.depMaps.push(f); | ||
| 21 | if(this.events.error)d.on("error",u(this,function(a){this.emit("error",a)}));d.enable()}}else d?(this.map.url=i.nameToUrl(d),this.load()):(l=u(this,function(a){this.init([],function(){return a},null,{enabled:!0})}),l.error=u(this,function(a){this.inited=!0;this.error=a;a.requireModules=[b];B(h,function(a){0===a.map.id.indexOf(b+"_unnormalized")&&y(a.map.id)});w(a)}),l.fromText=u(this,function(f,c){var d=a.name,e=p(d),P=M;c&&(f=c);P&&(M=!1);s(e);t(j.config,b)&&(j.config[d]=j.config[b]);try{g.exec(f)}catch(h){return w(C("fromtexteval", | ||
| 22 | "fromText eval for "+b+" failed: "+h,h,[b]))}P&&(M=!0);this.depMaps.push(e);i.completeLoad(d);n([d],l)}),f.load(a.name,n,l,j))}));i.enable(d,this);this.pluginMaps[d.id]=d},enable:function(){V[this.map.id]=this;this.enabling=this.enabled=!0;v(this.depMaps,u(this,function(a,b){var c,f;if("string"===typeof a){a=p(a,this.map.isDefine?this.map:this.map.parentMap,!1,!this.skipMap);this.depMaps[b]=a;if(c=m(L,a.id)){this.depExports[b]=c(this);return}this.depCount+=1;q(a,"defined",u(this,function(a){this.defineDep(b, | ||
| 23 | a);this.check()}));this.errback?q(a,"error",u(this,this.errback)):this.events.error&&q(a,"error",u(this,function(a){this.emit("error",a)}))}c=a.id;f=h[c];!t(L,c)&&(f&&!f.enabled)&&i.enable(a,this)}));B(this.pluginMaps,u(this,function(a){var b=m(h,a.id);b&&!b.enabled&&i.enable(a,this)}));this.enabling=!1;this.check()},on:function(a,b){var c=this.events[a];c||(c=this.events[a]=[]);c.push(b)},emit:function(a,b){v(this.events[a],function(a){a(b)});"error"===a&&delete this.events[a]}};i={config:j,contextName:b, | ||
| 24 | registry:h,defined:r,urlFetched:S,defQueue:A,Module:Z,makeModuleMap:p,nextTick:g.nextTick,onError:w,configure:function(a){a.baseUrl&&"/"!==a.baseUrl.charAt(a.baseUrl.length-1)&&(a.baseUrl+="/");var b=j.shim,c={paths:!0,bundles:!0,config:!0,map:!0};B(a,function(a,b){c[b]?(j[b]||(j[b]={}),U(j[b],a,!0,!0)):j[b]=a});a.bundles&&B(a.bundles,function(a,b){v(a,function(a){a!==b&&(aa[a]=b)})});a.shim&&(B(a.shim,function(a,c){H(a)&&(a={deps:a});if((a.exports||a.init)&&!a.exportsFn)a.exportsFn=i.makeShimExports(a); | ||
| 25 | b[c]=a}),j.shim=b);a.packages&&v(a.packages,function(a){var b,a="string"===typeof a?{name:a}:a;b=a.name;a.location&&(j.paths[b]=a.location);j.pkgs[b]=a.name+"/"+(a.main||"main").replace(ia,"").replace(Q,"")});B(h,function(a,b){!a.inited&&!a.map.unnormalized&&(a.map=p(b))});if(a.deps||a.callback)i.require(a.deps||[],a.callback)},makeShimExports:function(a){return function(){var b;a.init&&(b=a.init.apply(ba,arguments));return b||a.exports&&da(a.exports)}},makeRequire:function(a,e){function j(c,d,m){var n, | ||
| 26 | q;e.enableBuildCallback&&(d&&G(d))&&(d.__requireJsBuild=!0);if("string"===typeof c){if(G(d))return w(C("requireargs","Invalid require call"),m);if(a&&t(L,c))return L[c](h[a.id]);if(g.get)return g.get(i,c,a,j);n=p(c,a,!1,!0);n=n.id;return!t(r,n)?w(C("notloaded",'Module name "'+n+'" has not been loaded yet for context: '+b+(a?"":". Use require([])"))):r[n]}J();i.nextTick(function(){J();q=s(p(null,a));q.skipMap=e.skipMap;q.init(c,d,m,{enabled:!0});D()});return j}e=e||{};U(j,{isBrowser:z,toUrl:function(b){var d, | ||
| 27 | e=b.lastIndexOf("."),k=b.split("/")[0];if(-1!==e&&(!("."===k||".."===k)||1<e))d=b.substring(e,b.length),b=b.substring(0,e);return i.nameToUrl(c(b,a&&a.id,!0),d,!0)},defined:function(b){return t(r,p(b,a,!1,!0).id)},specified:function(b){b=p(b,a,!1,!0).id;return t(r,b)||t(h,b)}});a||(j.undef=function(b){x();var c=p(b,a,!0),e=m(h,b);d(b);delete r[b];delete S[c.url];delete $[b];T(A,function(a,c){a[0]===b&&A.splice(c,1)});e&&(e.events.defined&&($[b]=e.events),y(b))});return j},enable:function(a){m(h,a.id)&& | ||
| 28 | s(a).enable()},completeLoad:function(a){var b,c,d=m(j.shim,a)||{},g=d.exports;for(x();A.length;){c=A.shift();if(null===c[0]){c[0]=a;if(b)break;b=!0}else c[0]===a&&(b=!0);E(c)}c=m(h,a);if(!b&&!t(r,a)&&c&&!c.inited){if(j.enforceDefine&&(!g||!da(g)))return e(a)?void 0:w(C("nodefine","No define call for "+a,null,[a]));E([a,d.deps||[],d.exportsFn])}D()},nameToUrl:function(a,b,c){var d,e,h;(d=m(j.pkgs,a))&&(a=d);if(d=m(aa,a))return i.nameToUrl(d,b,c);if(g.jsExtRegExp.test(a))d=a+(b||"");else{d=j.paths; | ||
| 29 | a=a.split("/");for(e=a.length;0<e;e-=1)if(h=a.slice(0,e).join("/"),h=m(d,h)){H(h)&&(h=h[0]);a.splice(0,e,h);break}d=a.join("/");d+=b||(/^data\:|\?/.test(d)||c?"":".js");d=("/"===d.charAt(0)||d.match(/^[\w\+\.\-]+:/)?"":j.baseUrl)+d}return j.urlArgs?d+((-1===d.indexOf("?")?"?":"&")+j.urlArgs):d},load:function(a,b){g.load(i,a,b)},execCb:function(a,b,c,d){return b.apply(d,c)},onScriptLoad:function(a){if("load"===a.type||ja.test((a.currentTarget||a.srcElement).readyState))N=null,a=I(a),i.completeLoad(a.id)}, | ||
| 30 | onScriptError:function(a){var b=I(a);if(!e(b.id))return w(C("scripterror","Script error for: "+b.id,a,[b.id]))}};i.require=i.makeRequire();return i}var g,x,y,D,I,E,N,J,s,O,ka=/(\/\*([\s\S]*?)\*\/|([^:]|^)\/\/(.*)$)/mg,la=/[^.]\s*require\s*\(\s*["']([^'"\s]+)["']\s*\)/g,Q=/\.js$/,ia=/^\.\//;x=Object.prototype;var K=x.toString,fa=x.hasOwnProperty,ha=Array.prototype.splice,z=!!("undefined"!==typeof window&&"undefined"!==typeof navigator&&window.document),ea=!z&&"undefined"!==typeof importScripts,ja= | ||
| 31 | z&&"PLAYSTATION 3"===navigator.platform?/^complete$/:/^(complete|loaded)$/,Y="undefined"!==typeof opera&&"[object Opera]"===opera.toString(),F={},q={},R=[],M=!1;if("undefined"===typeof define){if("undefined"!==typeof requirejs){if(G(requirejs))return;q=requirejs;requirejs=void 0}"undefined"!==typeof require&&!G(require)&&(q=require,require=void 0);g=requirejs=function(b,c,d,e){var n,p="_";!H(b)&&"string"!==typeof b&&(n=b,H(c)?(b=c,c=d,d=e):b=[]);n&&n.context&&(p=n.context);(e=m(F,p))||(e=F[p]=g.s.newContext(p)); | ||
| 32 | n&&e.configure(n);return e.require(b,c,d)};g.config=function(b){return g(b)};g.nextTick="undefined"!==typeof setTimeout?function(b){setTimeout(b,4)}:function(b){b()};require||(require=g);g.version="2.1.16";g.jsExtRegExp=/^\/|:|\?|\.js$/;g.isBrowser=z;x=g.s={contexts:F,newContext:ga};g({});v(["toUrl","undef","defined","specified"],function(b){g[b]=function(){var c=F._;return c.require[b].apply(c,arguments)}});if(z&&(y=x.head=document.getElementsByTagName("head")[0],D=document.getElementsByTagName("base")[0]))y= | ||
| 33 | x.head=D.parentNode;g.onError=ca;g.createNode=function(b){var c=b.xhtml?document.createElementNS("http://www.w3.org/1999/xhtml","html:script"):document.createElement("script");c.type=b.scriptType||"text/javascript";c.charset="utf-8";c.async=!0;return c};g.load=function(b,c,d){var e=b&&b.config||{};if(z)return e=g.createNode(e,c,d),e.setAttribute("data-requirecontext",b.contextName),e.setAttribute("data-requiremodule",c),e.attachEvent&&!(e.attachEvent.toString&&0>e.attachEvent.toString().indexOf("[native code"))&& | ||
| 34 | !Y?(M=!0,e.attachEvent("onreadystatechange",b.onScriptLoad)):(e.addEventListener("load",b.onScriptLoad,!1),e.addEventListener("error",b.onScriptError,!1)),e.src=d,J=e,D?y.insertBefore(e,D):y.appendChild(e),J=null,e;if(ea)try{importScripts(d),b.completeLoad(c)}catch(m){b.onError(C("importscripts","importScripts failed for "+c+" at "+d,m,[c]))}};z&&!q.skipDataMain&&T(document.getElementsByTagName("script"),function(b){y||(y=b.parentNode);if(I=b.getAttribute("data-main"))return s=I,q.baseUrl||(E=s.split("/"), | ||
| 35 | s=E.pop(),O=E.length?E.join("/")+"/":"./",q.baseUrl=O),s=s.replace(Q,""),g.jsExtRegExp.test(s)&&(s=I),q.deps=q.deps?q.deps.concat(s):[s],!0});define=function(b,c,d){var e,g;"string"!==typeof b&&(d=c,c=b,b=null);H(c)||(d=c,c=null);!c&&G(d)&&(c=[],d.length&&(d.toString().replace(ka,"").replace(la,function(b,d){c.push(d)}),c=(1===d.length?["require"]:["require","exports","module"]).concat(c)));if(M){if(!(e=J))N&&"interactive"===N.readyState||T(document.getElementsByTagName("script"),function(b){if("interactive"=== | ||
| 36 | b.readyState)return N=b}),e=N;e&&(b||(b=e.getAttribute("data-requiremodule")),g=F[e.getAttribute("data-requirecontext")])}(g?g.defQueue:R).push([b,c,d])};define.amd={jQuery:!0};g.exec=function(b){return eval(b)};g(q)}})(this); | ||
diff --git a/doc/html/mkdocs/js/search-results-template.mustache b/doc/html/mkdocs/js/search-results-template.mustache new file mode 100644 index 00000000..a8b3862f --- /dev/null +++ b/doc/html/mkdocs/js/search-results-template.mustache | |||
| @@ -0,0 +1,4 @@ | |||
| 1 | <article> | ||
| 2 | <h3><a href="{{location}}">{{title}}</a></h3> | ||
| 3 | <p>{{summary}}</p> | ||
| 4 | </article> | ||
diff --git a/doc/html/mkdocs/js/search.js b/doc/html/mkdocs/js/search.js new file mode 100644 index 00000000..d5c86616 --- /dev/null +++ b/doc/html/mkdocs/js/search.js | |||
| @@ -0,0 +1,88 @@ | |||
| 1 | require([ | ||
| 2 | base_url + '/mkdocs/js/mustache.min.js', | ||
| 3 | base_url + '/mkdocs/js/lunr.min.js', | ||
| 4 | 'text!search-results-template.mustache', | ||
| 5 | 'text!../search_index.json', | ||
| 6 | ], function (Mustache, lunr, results_template, data) { | ||
| 7 | "use strict"; | ||
| 8 | |||
| 9 | function getSearchTerm() | ||
| 10 | { | ||
| 11 | var sPageURL = window.location.search.substring(1); | ||
| 12 | var sURLVariables = sPageURL.split('&'); | ||
| 13 | for (var i = 0; i < sURLVariables.length; i++) | ||
| 14 | { | ||
| 15 | var sParameterName = sURLVariables[i].split('='); | ||
| 16 | if (sParameterName[0] == 'q') | ||
| 17 | { | ||
| 18 | return decodeURIComponent(sParameterName[1].replace(/\+/g, '%20')); | ||
| 19 | } | ||
| 20 | } | ||
| 21 | } | ||
| 22 | |||
| 23 | var index = lunr(function () { | ||
| 24 | this.field('title', {boost: 10}); | ||
| 25 | this.field('text'); | ||
| 26 | this.ref('location'); | ||
| 27 | }); | ||
| 28 | |||
| 29 | data = JSON.parse(data); | ||
| 30 | var documents = {}; | ||
| 31 | |||
| 32 | for (var i=0; i < data.docs.length; i++){ | ||
| 33 | var doc = data.docs[i]; | ||
| 34 | doc.location = base_url + doc.location; | ||
| 35 | index.add(doc); | ||
| 36 | documents[doc.location] = doc; | ||
| 37 | } | ||
| 38 | |||
| 39 | var search = function(){ | ||
| 40 | |||
| 41 | var query = document.getElementById('mkdocs-search-query').value; | ||
| 42 | var search_results = document.getElementById("mkdocs-search-results"); | ||
| 43 | while (search_results.firstChild) { | ||
| 44 | search_results.removeChild(search_results.firstChild); | ||
| 45 | } | ||
| 46 | |||
| 47 | if(query === ''){ | ||
| 48 | return; | ||
| 49 | } | ||
| 50 | |||
| 51 | var results = index.search(query); | ||
| 52 | |||
| 53 | if (results.length > 0){ | ||
| 54 | for (var i=0; i < results.length; i++){ | ||
| 55 | var result = results[i]; | ||
| 56 | doc = documents[result.ref]; | ||
| 57 | doc.base_url = base_url; | ||
| 58 | doc.summary = doc.text.substring(0, 200); | ||
| 59 | var html = Mustache.to_html(results_template, doc); | ||
| 60 | search_results.insertAdjacentHTML('beforeend', html); | ||
| 61 | } | ||
| 62 | } else { | ||
| 63 | search_results.insertAdjacentHTML('beforeend', "<p>No results found</p>"); | ||
| 64 | } | ||
| 65 | |||
| 66 | if(jQuery){ | ||
| 67 | /* | ||
| 68 | * We currently only automatically hide bootstrap models. This | ||
| 69 | * requires jQuery to work. | ||
| 70 | */ | ||
| 71 | jQuery('#mkdocs_search_modal a').click(function(){ | ||
| 72 | jQuery('#mkdocs_search_modal').modal('hide'); | ||
| 73 | }); | ||
| 74 | } | ||
| 75 | |||
| 76 | }; | ||
| 77 | |||
| 78 | var search_input = document.getElementById('mkdocs-search-query'); | ||
| 79 | |||
| 80 | var term = getSearchTerm(); | ||
| 81 | if (term){ | ||
| 82 | search_input.value = term; | ||
| 83 | search(); | ||
| 84 | } | ||
| 85 | |||
| 86 | search_input.addEventListener("keyup", search); | ||
| 87 | |||
| 88 | }); | ||
diff --git a/doc/html/mkdocs/js/text.js b/doc/html/mkdocs/js/text.js new file mode 100644 index 00000000..17921b6e --- /dev/null +++ b/doc/html/mkdocs/js/text.js | |||
| @@ -0,0 +1,390 @@ | |||
| 1 | /** | ||
| 2 | * @license RequireJS text 2.0.12 Copyright (c) 2010-2014, The Dojo Foundation All Rights Reserved. | ||
| 3 | * Available via the MIT or new BSD license. | ||
| 4 | * see: http://github.com/requirejs/text for details | ||
| 5 | */ | ||
| 6 | /*jslint regexp: true */ | ||
| 7 | /*global require, XMLHttpRequest, ActiveXObject, | ||
| 8 | define, window, process, Packages, | ||
| 9 | java, location, Components, FileUtils */ | ||
| 10 | |||
| 11 | define(['module'], function (module) { | ||
| 12 | 'use strict'; | ||
| 13 | |||
| 14 | var text, fs, Cc, Ci, xpcIsWindows, | ||
| 15 | progIds = ['Msxml2.XMLHTTP', 'Microsoft.XMLHTTP', 'Msxml2.XMLHTTP.4.0'], | ||
| 16 | xmlRegExp = /^\s*<\?xml(\s)+version=[\'\"](\d)*.(\d)*[\'\"](\s)*\?>/im, | ||
| 17 | bodyRegExp = /<body[^>]*>\s*([\s\S]+)\s*<\/body>/im, | ||
| 18 | hasLocation = typeof location !== 'undefined' && location.href, | ||
| 19 | defaultProtocol = hasLocation && location.protocol && location.protocol.replace(/\:/, ''), | ||
| 20 | defaultHostName = hasLocation && location.hostname, | ||
| 21 | defaultPort = hasLocation && (location.port || undefined), | ||
| 22 | buildMap = {}, | ||
| 23 | masterConfig = (module.config && module.config()) || {}; | ||
| 24 | |||
| 25 | text = { | ||
| 26 | version: '2.0.12', | ||
| 27 | |||
| 28 | strip: function (content) { | ||
| 29 | //Strips <?xml ...?> declarations so that external SVG and XML | ||
| 30 | //documents can be added to a document without worry. Also, if the string | ||
| 31 | //is an HTML document, only the part inside the body tag is returned. | ||
| 32 | if (content) { | ||
| 33 | content = content.replace(xmlRegExp, ""); | ||
| 34 | var matches = content.match(bodyRegExp); | ||
| 35 | if (matches) { | ||
| 36 | content = matches[1]; | ||
| 37 | } | ||
| 38 | } else { | ||
| 39 | content = ""; | ||
| 40 | } | ||
| 41 | return content; | ||
| 42 | }, | ||
| 43 | |||
| 44 | jsEscape: function (content) { | ||
| 45 | return content.replace(/(['\\])/g, '\\$1') | ||
| 46 | .replace(/[\f]/g, "\\f") | ||
| 47 | .replace(/[\b]/g, "\\b") | ||
| 48 | .replace(/[\n]/g, "\\n") | ||
| 49 | .replace(/[\t]/g, "\\t") | ||
| 50 | .replace(/[\r]/g, "\\r") | ||
| 51 | .replace(/[\u2028]/g, "\\u2028") | ||
| 52 | .replace(/[\u2029]/g, "\\u2029"); | ||
| 53 | }, | ||
| 54 | |||
| 55 | createXhr: masterConfig.createXhr || function () { | ||
| 56 | //Would love to dump the ActiveX crap in here. Need IE 6 to die first. | ||
| 57 | var xhr, i, progId; | ||
| 58 | if (typeof XMLHttpRequest !== "undefined") { | ||
| 59 | return new XMLHttpRequest(); | ||
| 60 | } else if (typeof ActiveXObject !== "undefined") { | ||
| 61 | for (i = 0; i < 3; i += 1) { | ||
| 62 | progId = progIds[i]; | ||
| 63 | try { | ||
| 64 | xhr = new ActiveXObject(progId); | ||
| 65 | } catch (e) {} | ||
| 66 | |||
| 67 | if (xhr) { | ||
| 68 | progIds = [progId]; // so faster next time | ||
| 69 | break; | ||
| 70 | } | ||
| 71 | } | ||
| 72 | } | ||
| 73 | |||
| 74 | return xhr; | ||
| 75 | }, | ||
| 76 | |||
| 77 | /** | ||
| 78 | * Parses a resource name into its component parts. Resource names | ||
| 79 | * look like: module/name.ext!strip, where the !strip part is | ||
| 80 | * optional. | ||
| 81 | * @param {String} name the resource name | ||
| 82 | * @returns {Object} with properties "moduleName", "ext" and "strip" | ||
| 83 | * where strip is a boolean. | ||
| 84 | */ | ||
| 85 | parseName: function (name) { | ||
| 86 | var modName, ext, temp, | ||
| 87 | strip = false, | ||
| 88 | index = name.indexOf("."), | ||
| 89 | isRelative = name.indexOf('./') === 0 || | ||
| 90 | name.indexOf('../') === 0; | ||
| 91 | |||
| 92 | if (index !== -1 && (!isRelative || index > 1)) { | ||
| 93 | modName = name.substring(0, index); | ||
| 94 | ext = name.substring(index + 1, name.length); | ||
| 95 | } else { | ||
| 96 | modName = name; | ||
| 97 | } | ||
| 98 | |||
| 99 | temp = ext || modName; | ||
| 100 | index = temp.indexOf("!"); | ||
| 101 | if (index !== -1) { | ||
| 102 | //Pull off the strip arg. | ||
| 103 | strip = temp.substring(index + 1) === "strip"; | ||
| 104 | temp = temp.substring(0, index); | ||
| 105 | if (ext) { | ||
| 106 | ext = temp; | ||
| 107 | } else { | ||
| 108 | modName = temp; | ||
| 109 | } | ||
| 110 | } | ||
| 111 | |||
| 112 | return { | ||
| 113 | moduleName: modName, | ||
| 114 | ext: ext, | ||
| 115 | strip: strip | ||
| 116 | }; | ||
| 117 | }, | ||
| 118 | |||
| 119 | xdRegExp: /^((\w+)\:)?\/\/([^\/\\]+)/, | ||
| 120 | |||
| 121 | /** | ||
| 122 | * Is an URL on another domain. Only works for browser use, returns | ||
| 123 | * false in non-browser environments. Only used to know if an | ||
| 124 | * optimized .js version of a text resource should be loaded | ||
| 125 | * instead. | ||
| 126 | * @param {String} url | ||
| 127 | * @returns Boolean | ||
| 128 | */ | ||
| 129 | useXhr: function (url, protocol, hostname, port) { | ||
| 130 | var uProtocol, uHostName, uPort, | ||
| 131 | match = text.xdRegExp.exec(url); | ||
| 132 | if (!match) { | ||
| 133 | return true; | ||
| 134 | } | ||
| 135 | uProtocol = match[2]; | ||
| 136 | uHostName = match[3]; | ||
| 137 | |||
| 138 | uHostName = uHostName.split(':'); | ||
| 139 | uPort = uHostName[1]; | ||
| 140 | uHostName = uHostName[0]; | ||
| 141 | |||
| 142 | return (!uProtocol || uProtocol === protocol) && | ||
| 143 | (!uHostName || uHostName.toLowerCase() === hostname.toLowerCase()) && | ||
| 144 | ((!uPort && !uHostName) || uPort === port); | ||
| 145 | }, | ||
| 146 | |||
| 147 | finishLoad: function (name, strip, content, onLoad) { | ||
| 148 | content = strip ? text.strip(content) : content; | ||
| 149 | if (masterConfig.isBuild) { | ||
| 150 | buildMap[name] = content; | ||
| 151 | } | ||
| 152 | onLoad(content); | ||
| 153 | }, | ||
| 154 | |||
| 155 | load: function (name, req, onLoad, config) { | ||
| 156 | //Name has format: some.module.filext!strip | ||
| 157 | //The strip part is optional. | ||
| 158 | //if strip is present, then that means only get the string contents | ||
| 159 | //inside a body tag in an HTML string. For XML/SVG content it means | ||
| 160 | //removing the <?xml ...?> declarations so the content can be inserted | ||
| 161 | //into the current doc without problems. | ||
| 162 | |||
| 163 | // Do not bother with the work if a build and text will | ||
| 164 | // not be inlined. | ||
| 165 | if (config && config.isBuild && !config.inlineText) { | ||
| 166 | onLoad(); | ||
| 167 | return; | ||
| 168 | } | ||
| 169 | |||
| 170 | masterConfig.isBuild = config && config.isBuild; | ||
| 171 | |||
| 172 | var parsed = text.parseName(name), | ||
| 173 | nonStripName = parsed.moduleName + | ||
| 174 | (parsed.ext ? '.' + parsed.ext : ''), | ||
| 175 | url = req.toUrl(nonStripName), | ||
| 176 | useXhr = (masterConfig.useXhr) || | ||
| 177 | text.useXhr; | ||
| 178 | |||
| 179 | // Do not load if it is an empty: url | ||
| 180 | if (url.indexOf('empty:') === 0) { | ||
| 181 | onLoad(); | ||
| 182 | return; | ||
| 183 | } | ||
| 184 | |||
| 185 | //Load the text. Use XHR if possible and in a browser. | ||
| 186 | if (!hasLocation || useXhr(url, defaultProtocol, defaultHostName, defaultPort)) { | ||
| 187 | text.get(url, function (content) { | ||
| 188 | text.finishLoad(name, parsed.strip, content, onLoad); | ||
| 189 | }, function (err) { | ||
| 190 | if (onLoad.error) { | ||
| 191 | onLoad.error(err); | ||
| 192 | } | ||
| 193 | }); | ||
| 194 | } else { | ||
| 195 | //Need to fetch the resource across domains. Assume | ||
| 196 | //the resource has been optimized into a JS module. Fetch | ||
| 197 | //by the module name + extension, but do not include the | ||
| 198 | //!strip part to avoid file system issues. | ||
| 199 | req([nonStripName], function (content) { | ||
| 200 | text.finishLoad(parsed.moduleName + '.' + parsed.ext, | ||
| 201 | parsed.strip, content, onLoad); | ||
| 202 | }); | ||
| 203 | } | ||
| 204 | }, | ||
| 205 | |||
| 206 | write: function (pluginName, moduleName, write, config) { | ||
| 207 | if (buildMap.hasOwnProperty(moduleName)) { | ||
| 208 | var content = text.jsEscape(buildMap[moduleName]); | ||
| 209 | write.asModule(pluginName + "!" + moduleName, | ||
| 210 | "define(function () { return '" + | ||
| 211 | content + | ||
| 212 | "';});\n"); | ||
| 213 | } | ||
| 214 | }, | ||
| 215 | |||
| 216 | writeFile: function (pluginName, moduleName, req, write, config) { | ||
| 217 | var parsed = text.parseName(moduleName), | ||
| 218 | extPart = parsed.ext ? '.' + parsed.ext : '', | ||
| 219 | nonStripName = parsed.moduleName + extPart, | ||
| 220 | //Use a '.js' file name so that it indicates it is a | ||
| 221 | //script that can be loaded across domains. | ||
| 222 | fileName = req.toUrl(parsed.moduleName + extPart) + '.js'; | ||
| 223 | |||
| 224 | //Leverage own load() method to load plugin value, but only | ||
| 225 | //write out values that do not have the strip argument, | ||
| 226 | //to avoid any potential issues with ! in file names. | ||
| 227 | text.load(nonStripName, req, function (value) { | ||
| 228 | //Use own write() method to construct full module value. | ||
| 229 | //But need to create shell that translates writeFile's | ||
| 230 | //write() to the right interface. | ||
| 231 | var textWrite = function (contents) { | ||
| 232 | return write(fileName, contents); | ||
| 233 | }; | ||
| 234 | textWrite.asModule = function (moduleName, contents) { | ||
| 235 | return write.asModule(moduleName, fileName, contents); | ||
| 236 | }; | ||
| 237 | |||
| 238 | text.write(pluginName, nonStripName, textWrite, config); | ||
| 239 | }, config); | ||
| 240 | } | ||
| 241 | }; | ||
| 242 | |||
| 243 | if (masterConfig.env === 'node' || (!masterConfig.env && | ||
| 244 | typeof process !== "undefined" && | ||
| 245 | process.versions && | ||
| 246 | !!process.versions.node && | ||
| 247 | !process.versions['node-webkit'])) { | ||
| 248 | //Using special require.nodeRequire, something added by r.js. | ||
| 249 | fs = require.nodeRequire('fs'); | ||
| 250 | |||
| 251 | text.get = function (url, callback, errback) { | ||
| 252 | try { | ||
| 253 | var file = fs.readFileSync(url, 'utf8'); | ||
| 254 | //Remove BOM (Byte Mark Order) from utf8 files if it is there. | ||
| 255 | if (file.indexOf('\uFEFF') === 0) { | ||
| 256 | file = file.substring(1); | ||
| 257 | } | ||
| 258 | callback(file); | ||
| 259 | } catch (e) { | ||
| 260 | if (errback) { | ||
| 261 | errback(e); | ||
| 262 | } | ||
| 263 | } | ||
| 264 | }; | ||
| 265 | } else if (masterConfig.env === 'xhr' || (!masterConfig.env && | ||
| 266 | text.createXhr())) { | ||
| 267 | text.get = function (url, callback, errback, headers) { | ||
| 268 | var xhr = text.createXhr(), header; | ||
| 269 | xhr.open('GET', url, true); | ||
| 270 | |||
| 271 | //Allow plugins direct access to xhr headers | ||
| 272 | if (headers) { | ||
| 273 | for (header in headers) { | ||
| 274 | if (headers.hasOwnProperty(header)) { | ||
| 275 | xhr.setRequestHeader(header.toLowerCase(), headers[header]); | ||
| 276 | } | ||
| 277 | } | ||
| 278 | } | ||
| 279 | |||
| 280 | //Allow overrides specified in config | ||
| 281 | if (masterConfig.onXhr) { | ||
| 282 | masterConfig.onXhr(xhr, url); | ||
| 283 | } | ||
| 284 | |||
| 285 | xhr.onreadystatechange = function (evt) { | ||
| 286 | var status, err; | ||
| 287 | //Do not explicitly handle errors, those should be | ||
| 288 | //visible via console output in the browser. | ||
| 289 | if (xhr.readyState === 4) { | ||
| 290 | status = xhr.status || 0; | ||
| 291 | if (status > 399 && status < 600) { | ||
| 292 | //An http 4xx or 5xx error. Signal an error. | ||
| 293 | err = new Error(url + ' HTTP status: ' + status); | ||
| 294 | err.xhr = xhr; | ||
| 295 | if (errback) { | ||
| 296 | errback(err); | ||
| 297 | } | ||
| 298 | } else { | ||
| 299 | callback(xhr.responseText); | ||
| 300 | } | ||
| 301 | |||
| 302 | if (masterConfig.onXhrComplete) { | ||
| 303 | masterConfig.onXhrComplete(xhr, url); | ||
| 304 | } | ||
| 305 | } | ||
| 306 | }; | ||
| 307 | xhr.send(null); | ||
| 308 | }; | ||
| 309 | } else if (masterConfig.env === 'rhino' || (!masterConfig.env && | ||
| 310 | typeof Packages !== 'undefined' && typeof java !== 'undefined')) { | ||
| 311 | //Why Java, why is this so awkward? | ||
| 312 | text.get = function (url, callback) { | ||
| 313 | var stringBuffer, line, | ||
| 314 | encoding = "utf-8", | ||
| 315 | file = new java.io.File(url), | ||
| 316 | lineSeparator = java.lang.System.getProperty("line.separator"), | ||
| 317 | input = new java.io.BufferedReader(new java.io.InputStreamReader(new java.io.FileInputStream(file), encoding)), | ||
| 318 | content = ''; | ||
| 319 | try { | ||
| 320 | stringBuffer = new java.lang.StringBuffer(); | ||
| 321 | line = input.readLine(); | ||
| 322 | |||
| 323 | // Byte Order Mark (BOM) - The Unicode Standard, version 3.0, page 324 | ||
| 324 | // http://www.unicode.org/faq/utf_bom.html | ||
| 325 | |||
| 326 | // Note that when we use utf-8, the BOM should appear as "EF BB BF", but it doesn't due to this bug in the JDK: | ||
| 327 | // http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4508058 | ||
| 328 | if (line && line.length() && line.charAt(0) === 0xfeff) { | ||
| 329 | // Eat the BOM, since we've already found the encoding on this file, | ||
| 330 | // and we plan to concatenating this buffer with others; the BOM should | ||
| 331 | // only appear at the top of a file. | ||
| 332 | line = line.substring(1); | ||
| 333 | } | ||
| 334 | |||
| 335 | if (line !== null) { | ||
| 336 | stringBuffer.append(line); | ||
| 337 | } | ||
| 338 | |||
| 339 | while ((line = input.readLine()) !== null) { | ||
| 340 | stringBuffer.append(lineSeparator); | ||
| 341 | stringBuffer.append(line); | ||
| 342 | } | ||
| 343 | //Make sure we return a JavaScript string and not a Java string. | ||
| 344 | content = String(stringBuffer.toString()); //String | ||
| 345 | } finally { | ||
| 346 | input.close(); | ||
| 347 | } | ||
| 348 | callback(content); | ||
| 349 | }; | ||
| 350 | } else if (masterConfig.env === 'xpconnect' || (!masterConfig.env && | ||
| 351 | typeof Components !== 'undefined' && Components.classes && | ||
| 352 | Components.interfaces)) { | ||
| 353 | //Avert your gaze! | ||
| 354 | Cc = Components.classes; | ||
| 355 | Ci = Components.interfaces; | ||
| 356 | Components.utils['import']('resource://gre/modules/FileUtils.jsm'); | ||
| 357 | xpcIsWindows = ('@mozilla.org/windows-registry-key;1' in Cc); | ||
| 358 | |||
| 359 | text.get = function (url, callback) { | ||
| 360 | var inStream, convertStream, fileObj, | ||
| 361 | readData = {}; | ||
| 362 | |||
| 363 | if (xpcIsWindows) { | ||
| 364 | url = url.replace(/\//g, '\\'); | ||
| 365 | } | ||
| 366 | |||
| 367 | fileObj = new FileUtils.File(url); | ||
| 368 | |||
| 369 | //XPCOM, you so crazy | ||
| 370 | try { | ||
| 371 | inStream = Cc['@mozilla.org/network/file-input-stream;1'] | ||
| 372 | .createInstance(Ci.nsIFileInputStream); | ||
| 373 | inStream.init(fileObj, 1, 0, false); | ||
| 374 | |||
| 375 | convertStream = Cc['@mozilla.org/intl/converter-input-stream;1'] | ||
| 376 | .createInstance(Ci.nsIConverterInputStream); | ||
| 377 | convertStream.init(inStream, "utf-8", inStream.available(), | ||
| 378 | Ci.nsIConverterInputStream.DEFAULT_REPLACEMENT_CHARACTER); | ||
| 379 | |||
| 380 | convertStream.readString(inStream.available(), readData); | ||
| 381 | convertStream.close(); | ||
| 382 | inStream.close(); | ||
| 383 | callback(readData.value); | ||
| 384 | } catch (e) { | ||
| 385 | throw new Error((fileObj && fileObj.path || '') + ': ' + e); | ||
| 386 | } | ||
| 387 | }; | ||
| 388 | } | ||
| 389 | return text; | ||
| 390 | }); | ||
diff --git a/doc/html/mkdocs/search_index.json b/doc/html/mkdocs/search_index.json new file mode 100644 index 00000000..2222a95b --- /dev/null +++ b/doc/html/mkdocs/search_index.json | |||
| @@ -0,0 +1,1519 @@ | |||
| 1 | { | ||
| 2 | "docs": [ | ||
| 3 | { | ||
| 4 | "location": "/", | ||
| 5 | "text": "Welcome to the \nShaarli\n wiki!\n\n\nHere you can find some info on how to use, configure, tweak and solve problems with your Shaarli.\n\n\nFor general info, read the \nREADME\n.\n\n\nIf you have any questions or ideas, please join the \nchat\n (also reachable via \nIRC\n), post them in our \ngeneral discussion\n (\narchive\n) or read the current \nissues\n. If you've found a bug, please create a \nnew issue\n.\n\n\nIf you would like a feature added to Shaarli, check the issues labeled \nfeature\n, \nenhancement\n, and \nplugin\n.\n\n\nNote: This documentation is available online at https://github.com/shaarli/Shaarli/wiki, and locally in the \ndoc/\n directory of your Shaarli installation.", | ||
| 6 | "title": "Home" | ||
| 7 | }, | ||
| 8 | { | ||
| 9 | "location": "/Download-and-Installation/", | ||
| 10 | "text": "To install Shaarli, simply place the files in a directory under your webserver's Document Root (or directly at the document root). Make sure your \nserver\n is properly \nconfigured\n.\n\n\nSeveral releases are available:\n\n\n\n\nLatest release (recommended)\n\n\nDownload as an archive\n\n\nGet the latest released version from the \nreleases\n page.\n\n\nDownload our \nshaarli-full\n archive\n to include dependencies.\n\n\nThe current latest released version is \nv0.8.4\n\n\nOr in command lines:\n\n\n$ wget https://github.com/shaarli/Shaarli/releases/download/v0.8.4/shaarli-v0.8.4-full.zip\n$ unzip shaarli-v0.8.4-full.zip\n$ mv Shaarli /path/to/shaarli/\n\n\n\n\n\n\n\n\n\n\n!\n\n\nIn most cases, download Shaarli from the \nreleases\n page. Cloning using \ngit\n or downloading Github branches as zip files requires additional steps (see below).\n\n\n\n\n\n\n\n\n\n\nUsing git\n\n\nmkdir -p /path/to/shaarli && cd /path/to/shaarli/\ngit clone -b v0.8 https://github.com/shaarli/Shaarli.git .\ncomposer install --no-dev\n\n\n\n\n\n\nStable version\n\n\nThe stable version has been experienced by Shaarli users, and will receive security updates.\n\n\nDownload as an archive\n\n\nAs a .zip archive:\n\n\n$ wget https://github.com/shaarli/Shaarli/archive/stable.zip\n$ unzip stable.zip\n$ mv Shaarli-stable /path/to/shaarli/\n\n\n\n\nAs a .tar.gz archive :\n\n\n$ wget https://github.com/shaarli/Shaarli/archive/stable.tar.gz\n$ tar xvf stable.tar.gz\n$ mv Shaarli-stable /path/to/shaarli/\n\n\n\n\nClone with Git\n\n\nComposer\n is required to build a functional Shaarli installation when pulling from git.\n\n\n$ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/\n# install/update third-party dependencies\n$ cd /path/to/shaarli/\n$ composer install --no-dev\n\n\n\n\n\n\nDevelopment version (mainline)\n\n\nUse at your own risk!\n\n\nTo get the latest changes from the \nmaster\n branch:\n\n\n# clone the repository \n$ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/\n# install/update third-party dependencies\n$ cd /path/to/shaarli\n$ composer install --no-dev\n\n\n\n\n\n\nFinish Installation\n\n\nOnce Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser.\n\n\n\n\nSetup your Shaarli installation, and it's ready to use!\n\n\n\n\nUpdating Shaarli\n\n\nSee \nUpgrade and Migration", | ||
| 11 | "title": "Download and Installation" | ||
| 12 | }, | ||
| 13 | { | ||
| 14 | "location": "/Download-and-Installation/#latest-release-recommended", | ||
| 15 | "text": "", | ||
| 16 | "title": "Latest release (recommended)" | ||
| 17 | }, | ||
| 18 | { | ||
| 19 | "location": "/Download-and-Installation/#download-as-an-archive", | ||
| 20 | "text": "Get the latest released version from the releases page. Download our shaarli-full archive to include dependencies. The current latest released version is v0.8.4 Or in command lines: $ wget https://github.com/shaarli/Shaarli/releases/download/v0.8.4/shaarli-v0.8.4-full.zip\n$ unzip shaarli-v0.8.4-full.zip\n$ mv Shaarli /path/to/shaarli/ ! In most cases, download Shaarli from the releases page. Cloning using git or downloading Github branches as zip files requires additional steps (see below).", | ||
| 21 | "title": "Download as an archive" | ||
| 22 | }, | ||
| 23 | { | ||
| 24 | "location": "/Download-and-Installation/#using-git", | ||
| 25 | "text": "mkdir -p /path/to/shaarli && cd /path/to/shaarli/\ngit clone -b v0.8 https://github.com/shaarli/Shaarli.git .\ncomposer install --no-dev", | ||
| 26 | "title": "Using git" | ||
| 27 | }, | ||
| 28 | { | ||
| 29 | "location": "/Download-and-Installation/#stable-version", | ||
| 30 | "text": "The stable version has been experienced by Shaarli users, and will receive security updates.", | ||
| 31 | "title": "Stable version" | ||
| 32 | }, | ||
| 33 | { | ||
| 34 | "location": "/Download-and-Installation/#download-as-an-archive_1", | ||
| 35 | "text": "As a .zip archive: $ wget https://github.com/shaarli/Shaarli/archive/stable.zip\n$ unzip stable.zip\n$ mv Shaarli-stable /path/to/shaarli/ As a .tar.gz archive : $ wget https://github.com/shaarli/Shaarli/archive/stable.tar.gz\n$ tar xvf stable.tar.gz\n$ mv Shaarli-stable /path/to/shaarli/", | ||
| 36 | "title": "Download as an archive" | ||
| 37 | }, | ||
| 38 | { | ||
| 39 | "location": "/Download-and-Installation/#clone-with-git", | ||
| 40 | "text": "Composer is required to build a functional Shaarli installation when pulling from git. $ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/\n# install/update third-party dependencies\n$ cd /path/to/shaarli/\n$ composer install --no-dev", | ||
| 41 | "title": "Clone with Git" | ||
| 42 | }, | ||
| 43 | { | ||
| 44 | "location": "/Download-and-Installation/#development-version-mainline", | ||
| 45 | "text": "Use at your own risk! To get the latest changes from the master branch: # clone the repository \n$ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/\n# install/update third-party dependencies\n$ cd /path/to/shaarli\n$ composer install --no-dev", | ||
| 46 | "title": "Development version (mainline)" | ||
| 47 | }, | ||
| 48 | { | ||
| 49 | "location": "/Download-and-Installation/#finish-installation", | ||
| 50 | "text": "Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser. Setup your Shaarli installation, and it's ready to use!", | ||
| 51 | "title": "Finish Installation" | ||
| 52 | }, | ||
| 53 | { | ||
| 54 | "location": "/Download-and-Installation/#updating-shaarli", | ||
| 55 | "text": "See Upgrade and Migration", | ||
| 56 | "title": "Updating Shaarli" | ||
| 57 | }, | ||
| 58 | { | ||
| 59 | "location": "/Upgrade-and-migration/", | ||
| 60 | "text": "Preparation\n\n\nNote your current version\n\n\nIf anything goes wrong, it's important for us to know which version you're upgrading from.\n\nThe current version is present in the \nversion.php\n file.\n\n\nBackup your data\n\n\nShaarli stores all user data under the \ndata\n directory:\n- \ndata/config.php\n - main configuration file\n- \ndata/datastore.php\n - bookmarked links\n- \ndata/ipbans.php\n - banned IP addresses\n- \ndata/updates.txt\n - contains all automatic update to the configuration and datastore files already run\n\n\nSee \nShaarli configuration\n for more information about Shaarli resources.\n\n\nIt is recommended to backup this repository \nbefore\n starting updating/upgrading Shaarli:\n- users with SSH access: copy or archive the directory to a temporary location\n- users with FTP access: download a local copy of your Shaarli installation using your favourite client\n\n\nMigrating data from a previous installation\n\n\nAs all user data is kept under \ndata\n, this is the only directory you need to worry about when migrating to a new installation, which corresponds to the following steps:\n\n\n\n\nbackup the \ndata\n directory\n\n\ninstall or update Shaarli:\n\n\nfresh installation - see \nDownload and installation\n\n\nupdate - see the following sections\n\n\n\n\n\n\ncheck or restore the \ndata\n directory\n\n\n\n\nRecommended : Upgrading from release archives\n\n\nAll tagged revisions can be downloaded as tarballs or ZIP archives from the \nreleases\n page.\n\n\nWe recommend that you use the latest release tarball with the \n-full\n suffix. It contains the dependencies, please read \nDownload and installation\n for \ngit\n complete instructions.\n\n\nOnce downloaded, extract the archive locally and update your remote installation (e.g. via FTP) -be sure you keep the content of the \ndata\n directory!\n\n\nAfter upgrading, access your fresh Shaarli installation from a web browser; the configuration and data store will then be automatically updated, and new settings added to \ndata/config.json.php\n (see \nShaarli configuration\n for more details).\n\n\nUpgrading with Git\n\n\nUpdating a community Shaarli\n\n\nIf you have installed Shaarli from the \ncommunity Git repository\n, simply \npull new changes\n from your local clone:\n\n\n$ cd /path/to/shaarli\n$ git pull\n\nFrom github.com:shaarli/Shaarli\n * branch master -> FETCH_HEAD\nUpdating ebd67c6..521f0e6\nFast-forward\n application/Url.php | 1 +\n shaarli_version.php | 2 +-\n tests/Url/UrlTest.php | 1 +\n 3 files changed, 3 insertions(+), 1 deletion(-)\n\n\n\n\nShaarli >= \nv0.8.x\n: install/update third-party PHP dependencies using \nComposer\n:\n\n\n$ composer install --no-dev\n\nLoading composer repositories with package information\nUpdating dependencies\n - Installing shaarli/netscape-bookmark-parser (v1.0.1)\n Downloading: 100%\n\n\n\n\nMigrating and upgrading from Sebsauvage's repository\n\n\nIf you have installed Shaarli from \nSebsauvage's original Git repository\n, you can use \nGit remotes\n to update your working copy.\n\n\nThe following guide assumes that:\n- you have a basic knowledge of Git \nbranching\n and \nremote repositories\n\n- the default remote is named \norigin\n and points to Sebsauvage's repository\n- the current branch is \nmaster\n\n - if you have personal branches containing customizations, you will need to \nrebase them\n after the upgrade; beware though, a lot of changes have been made since the community fork has been created, so things are very likely to break!\n- the working copy is clean:\n - no versioned file has been locally modified\n - no untracked files are present\n\n\nStep 0: show repository information\n\n\n$ cd /path/to/shaarli\n\n$ git remote -v\norigin https://github.com/sebsauvage/Shaarli (fetch)\norigin https://github.com/sebsauvage/Shaarli (push)\n\n$ git branch -vv\n* master 029f75f [origin/master] Update README.md\n\n$ git status\nOn branch master\nYour branch is up-to-date with 'origin/master'.\nnothing to commit, working directory clean\n\n\n\n\nStep 1: update Git remotes\n\n\n$ git remote rename origin sebsauvage\n$ git remote -v\nsebsauvage https://github.com/sebsauvage/Shaarli (fetch)\nsebsauvage https://github.com/sebsauvage/Shaarli (push)\n\n$ git remote add origin https://github.com/shaarli/Shaarli\n$ git fetch origin\n\nremote: Counting objects: 3015, done.\nremote: Compressing objects: 100% (19/19), done.\nremote: Total 3015 (delta 446), reused 457 (delta 446), pack-reused 2550\nReceiving objects: 100% (3015/3015), 2.59 MiB | 918.00 KiB/s, done.\nResolving deltas: 100% (1899/1899), completed with 48 local objects.\nFrom https://github.com/shaarli/Shaarli\n * [new branch] master -> origin/master\n * [new branch] stable -> origin/stable\n[...]\n * [new tag] v0.6.4 -> v0.6.4\n * [new tag] v0.7.0 -> v0.7.0\n\n\n\n\nStep 2: use the stable community branch\n\n\n$ git checkout origin/stable -b stable\nBranch stable set up to track remote branch stable from origin.\nSwitched to a new branch 'stable'\n\n$ git branch -vv\n master 029f75f [sebsauvage/master] Update README.md\n* stable 890afc3 [origin/stable] Merge pull request #509 from ArthurHoaro/v0.6.5\n\n\n\n\nShaarli >= \nv0.8.x\n: install/update third-party PHP dependencies using \nComposer\n:\n\n\n$ composer install --no-dev\n\nLoading composer repositories with package information\nUpdating dependencies\n - Installing shaarli/netscape-bookmark-parser (v1.0.1)\n Downloading: 100%\n\n\n\n\nOptionally, you can delete information related to the legacy version:\n\n\n$ git branch -D master\nDeleted branch master (was 029f75f).\n\n$ git remote remove sebsauvage\n\n$ git remote -v\norigin https://github.com/shaarli/Shaarli (fetch)\norigin https://github.com/shaarli/Shaarli (push)\n\n$ git gc\nCounting objects: 3317, done.\nDelta compression using up to 8 threads.\nCompressing objects: 100% (1237/1237), done.\nWriting objects: 100% (3317/3317), done.\nTotal 3317 (delta 2050), reused 3301 (delta 2034)to\n\n\n\n\nStep 3: configuration\n\n\nAfter migrating, access your fresh Shaarli installation from a web browser; the configuration will then be automatically updated, and new settings added to \ndata/config.php\n (see \nShaarli configuration\n for more details).\n\n\nTroubleshooting\n\n\nIf the solutions provided here doesn't work, please open an issue specifying which version you're upgrading from and to.\n\n\nYou must specify an integer as a key\n\n\nIn \nv0.8.1\n we changed how link keys are handled (from timestamps to incremental integers).\nTake a look at \ndata/updates.txt\n content.\n\n\nupdates.txt\n contains \nupdateMethodDatastoreIds\n\n\nTry to delete it and refresh your page while being logged in.\n\n\nupdates.txt\n doesn't exists or doesn't contain \nupdateMethodDatastoreIds\n\n\n\n\nCreate \ndata/updates.txt\n if it doesn't exist.\n\n\nPaste this string in the update file \n;updateMethodRenameDashTags;\n\n\nLogin to Shaarli.\n\n\nDelete the update file.\n\n\nRefresh.", | ||
| 61 | "title": "Upgrade and migration" | ||
| 62 | }, | ||
| 63 | { | ||
| 64 | "location": "/Upgrade-and-migration/#preparation", | ||
| 65 | "text": "", | ||
| 66 | "title": "Preparation" | ||
| 67 | }, | ||
| 68 | { | ||
| 69 | "location": "/Upgrade-and-migration/#note-your-current-version", | ||
| 70 | "text": "If anything goes wrong, it's important for us to know which version you're upgrading from. \nThe current version is present in the version.php file.", | ||
| 71 | "title": "Note your current version" | ||
| 72 | }, | ||
| 73 | { | ||
| 74 | "location": "/Upgrade-and-migration/#backup-your-data", | ||
| 75 | "text": "Shaarli stores all user data under the data directory:\n- data/config.php - main configuration file\n- data/datastore.php - bookmarked links\n- data/ipbans.php - banned IP addresses\n- data/updates.txt - contains all automatic update to the configuration and datastore files already run See Shaarli configuration for more information about Shaarli resources. It is recommended to backup this repository before starting updating/upgrading Shaarli:\n- users with SSH access: copy or archive the directory to a temporary location\n- users with FTP access: download a local copy of your Shaarli installation using your favourite client", | ||
| 76 | "title": "Backup your data" | ||
| 77 | }, | ||
| 78 | { | ||
| 79 | "location": "/Upgrade-and-migration/#migrating-data-from-a-previous-installation", | ||
| 80 | "text": "As all user data is kept under data , this is the only directory you need to worry about when migrating to a new installation, which corresponds to the following steps: backup the data directory install or update Shaarli: fresh installation - see Download and installation update - see the following sections check or restore the data directory", | ||
| 81 | "title": "Migrating data from a previous installation" | ||
| 82 | }, | ||
| 83 | { | ||
| 84 | "location": "/Upgrade-and-migration/#recommended-upgrading-from-release-archives", | ||
| 85 | "text": "All tagged revisions can be downloaded as tarballs or ZIP archives from the releases page. We recommend that you use the latest release tarball with the -full suffix. It contains the dependencies, please read Download and installation for git complete instructions. Once downloaded, extract the archive locally and update your remote installation (e.g. via FTP) -be sure you keep the content of the data directory! After upgrading, access your fresh Shaarli installation from a web browser; the configuration and data store will then be automatically updated, and new settings added to data/config.json.php (see Shaarli configuration for more details).", | ||
| 86 | "title": "Recommended : Upgrading from release archives" | ||
| 87 | }, | ||
| 88 | { | ||
| 89 | "location": "/Upgrade-and-migration/#upgrading-with-git", | ||
| 90 | "text": "", | ||
| 91 | "title": "Upgrading with Git" | ||
| 92 | }, | ||
| 93 | { | ||
| 94 | "location": "/Upgrade-and-migration/#updating-a-community-shaarli", | ||
| 95 | "text": "If you have installed Shaarli from the community Git repository , simply pull new changes from your local clone: $ cd /path/to/shaarli\n$ git pull\n\nFrom github.com:shaarli/Shaarli\n * branch master -> FETCH_HEAD\nUpdating ebd67c6..521f0e6\nFast-forward\n application/Url.php | 1 +\n shaarli_version.php | 2 +-\n tests/Url/UrlTest.php | 1 +\n 3 files changed, 3 insertions(+), 1 deletion(-) Shaarli >= v0.8.x : install/update third-party PHP dependencies using Composer : $ composer install --no-dev\n\nLoading composer repositories with package information\nUpdating dependencies\n - Installing shaarli/netscape-bookmark-parser (v1.0.1)\n Downloading: 100%", | ||
| 96 | "title": "Updating a community Shaarli" | ||
| 97 | }, | ||
| 98 | { | ||
| 99 | "location": "/Upgrade-and-migration/#migrating-and-upgrading-from-sebsauvages-repository", | ||
| 100 | "text": "If you have installed Shaarli from Sebsauvage's original Git repository , you can use Git remotes to update your working copy. The following guide assumes that:\n- you have a basic knowledge of Git branching and remote repositories \n- the default remote is named origin and points to Sebsauvage's repository\n- the current branch is master \n - if you have personal branches containing customizations, you will need to rebase them after the upgrade; beware though, a lot of changes have been made since the community fork has been created, so things are very likely to break!\n- the working copy is clean:\n - no versioned file has been locally modified\n - no untracked files are present", | ||
| 101 | "title": "Migrating and upgrading from Sebsauvage's repository" | ||
| 102 | }, | ||
| 103 | { | ||
| 104 | "location": "/Upgrade-and-migration/#step-0-show-repository-information", | ||
| 105 | "text": "$ cd /path/to/shaarli\n\n$ git remote -v\norigin https://github.com/sebsauvage/Shaarli (fetch)\norigin https://github.com/sebsauvage/Shaarli (push)\n\n$ git branch -vv\n* master 029f75f [origin/master] Update README.md\n\n$ git status\nOn branch master\nYour branch is up-to-date with 'origin/master'.\nnothing to commit, working directory clean", | ||
| 106 | "title": "Step 0: show repository information" | ||
| 107 | }, | ||
| 108 | { | ||
| 109 | "location": "/Upgrade-and-migration/#step-1-update-git-remotes", | ||
| 110 | "text": "$ git remote rename origin sebsauvage\n$ git remote -v\nsebsauvage https://github.com/sebsauvage/Shaarli (fetch)\nsebsauvage https://github.com/sebsauvage/Shaarli (push)\n\n$ git remote add origin https://github.com/shaarli/Shaarli\n$ git fetch origin\n\nremote: Counting objects: 3015, done.\nremote: Compressing objects: 100% (19/19), done.\nremote: Total 3015 (delta 446), reused 457 (delta 446), pack-reused 2550\nReceiving objects: 100% (3015/3015), 2.59 MiB | 918.00 KiB/s, done.\nResolving deltas: 100% (1899/1899), completed with 48 local objects.\nFrom https://github.com/shaarli/Shaarli\n * [new branch] master -> origin/master\n * [new branch] stable -> origin/stable\n[...]\n * [new tag] v0.6.4 -> v0.6.4\n * [new tag] v0.7.0 -> v0.7.0", | ||
| 111 | "title": "Step 1: update Git remotes" | ||
| 112 | }, | ||
| 113 | { | ||
| 114 | "location": "/Upgrade-and-migration/#step-2-use-the-stable-community-branch", | ||
| 115 | "text": "$ git checkout origin/stable -b stable\nBranch stable set up to track remote branch stable from origin.\nSwitched to a new branch 'stable'\n\n$ git branch -vv\n master 029f75f [sebsauvage/master] Update README.md\n* stable 890afc3 [origin/stable] Merge pull request #509 from ArthurHoaro/v0.6.5 Shaarli >= v0.8.x : install/update third-party PHP dependencies using Composer : $ composer install --no-dev\n\nLoading composer repositories with package information\nUpdating dependencies\n - Installing shaarli/netscape-bookmark-parser (v1.0.1)\n Downloading: 100% Optionally, you can delete information related to the legacy version: $ git branch -D master\nDeleted branch master (was 029f75f).\n\n$ git remote remove sebsauvage\n\n$ git remote -v\norigin https://github.com/shaarli/Shaarli (fetch)\norigin https://github.com/shaarli/Shaarli (push)\n\n$ git gc\nCounting objects: 3317, done.\nDelta compression using up to 8 threads.\nCompressing objects: 100% (1237/1237), done.\nWriting objects: 100% (3317/3317), done.\nTotal 3317 (delta 2050), reused 3301 (delta 2034)to", | ||
| 116 | "title": "Step 2: use the stable community branch" | ||
| 117 | }, | ||
| 118 | { | ||
| 119 | "location": "/Upgrade-and-migration/#step-3-configuration", | ||
| 120 | "text": "After migrating, access your fresh Shaarli installation from a web browser; the configuration will then be automatically updated, and new settings added to data/config.php (see Shaarli configuration for more details).", | ||
| 121 | "title": "Step 3: configuration" | ||
| 122 | }, | ||
| 123 | { | ||
| 124 | "location": "/Upgrade-and-migration/#troubleshooting", | ||
| 125 | "text": "If the solutions provided here doesn't work, please open an issue specifying which version you're upgrading from and to.", | ||
| 126 | "title": "Troubleshooting" | ||
| 127 | }, | ||
| 128 | { | ||
| 129 | "location": "/Upgrade-and-migration/#you-must-specify-an-integer-as-a-key", | ||
| 130 | "text": "In v0.8.1 we changed how link keys are handled (from timestamps to incremental integers).\nTake a look at data/updates.txt content.", | ||
| 131 | "title": "You must specify an integer as a key" | ||
| 132 | }, | ||
| 133 | { | ||
| 134 | "location": "/Upgrade-and-migration/#updatestxt-contains-updatemethoddatastoreids", | ||
| 135 | "text": "Try to delete it and refresh your page while being logged in.", | ||
| 136 | "title": "updates.txt contains updateMethodDatastoreIds" | ||
| 137 | }, | ||
| 138 | { | ||
| 139 | "location": "/Upgrade-and-migration/#updatestxt-doesnt-exists-or-doesnt-contain-updatemethoddatastoreids", | ||
| 140 | "text": "Create data/updates.txt if it doesn't exist. Paste this string in the update file ;updateMethodRenameDashTags; Login to Shaarli. Delete the update file. Refresh.", | ||
| 141 | "title": "updates.txt doesn't exists or doesn't contain updateMethodDatastoreIds" | ||
| 142 | }, | ||
| 143 | { | ||
| 144 | "location": "/Server-requirements/", | ||
| 145 | "text": "PHP\n\n\nRelease information\n\n\n\n\nPHP: Supported versions\n\n\nPHP: Unsupported versions\n \n(EOL - End Of Life)\n\n\nPHP 7 Changelog\n\n\nPHP 5 Changelog\n\n\nPHP: Bugs\n\n\n\n\nSupported versions\n\n\n\n\n\n\n\n\nVersion\n\n\nStatus\n\n\nShaarli compatibility\n\n\n\n\n\n\n\n\n\n\n7.1\n\n\nSupported (v0.9.x)\n\n\n:white_check_mark:\n\n\n\n\n\n\n7.0\n\n\nSupported\n\n\n:white_check_mark:\n\n\n\n\n\n\n5.6\n\n\nSupported\n\n\n:white_check_mark:\n\n\n\n\n\n\n5.5\n\n\nEOL: 2016-07-10\n\n\n:white_check_mark:\n\n\n\n\n\n\n5.4\n\n\nEOL: 2015-09-14\n\n\n:white_check_mark: (up to Shaarli 0.8.x)\n\n\n\n\n\n\n5.3\n\n\nEOL: 2014-08-14\n\n\n:white_check_mark: (up to Shaarli 0.8.x)\n\n\n\n\n\n\n\n\nSee also:\n- \nTravis configuration\n\n\nDependency management\n\n\nStarting with Shaarli \nv0.8.x\n, \nComposer\n is used to resolve,\ndownload and install third-party PHP dependencies.\n\n\n\n\n\n\n\n\nLibrary\n\n\nRequired?\n\n\nUsage\n\n\n\n\n\n\n\n\n\n\nshaarli/netscape-bookmark-parser\n\n\nAll\n\n\nImport bookmarks from Netscape files\n\n\n\n\n\n\nerusev/parsedown\n\n\nAll\n\n\nParse MarkDown syntax for the MarkDown plugin\n\n\n\n\n\n\nslim/slim\n\n\nAll\n\n\nHandle routes and middleware for the REST API\n\n\n\n\n\n\n\n\nExtensions\n\n\n\n\n\n\n\n\nExtension\n\n\nRequired?\n\n\nUsage\n\n\n\n\n\n\n\n\n\n\nopenssl\n\n\nAll\n\n\nOpenSSL, HTTPS\n\n\n\n\n\n\nphp-mbstring\n\n\nCentOS, Fedora, RHEL, Windows\n\n\nmultibyte (Unicode) string support\n\n\n\n\n\n\nphp-gd\n\n\noptional\n\n\nthumbnail resizing\n\n\n\n\n\n\nphp-intl\n\n\noptional\n\n\nlocalized text sorting (e.g. \ne->\u00e8->f\n)\n\n\n\n\n\n\nphp-curl\n\n\noptional\n\n\nusing cURL for fetching webpages and thumbnails in a more robust way", | ||
| 146 | "title": "Server requirements" | ||
| 147 | }, | ||
| 148 | { | ||
| 149 | "location": "/Server-requirements/#php", | ||
| 150 | "text": "", | ||
| 151 | "title": "PHP" | ||
| 152 | }, | ||
| 153 | { | ||
| 154 | "location": "/Server-requirements/#release-information", | ||
| 155 | "text": "PHP: Supported versions PHP: Unsupported versions (EOL - End Of Life) PHP 7 Changelog PHP 5 Changelog PHP: Bugs", | ||
| 156 | "title": "Release information" | ||
| 157 | }, | ||
| 158 | { | ||
| 159 | "location": "/Server-requirements/#supported-versions", | ||
| 160 | "text": "Version Status Shaarli compatibility 7.1 Supported (v0.9.x) :white_check_mark: 7.0 Supported :white_check_mark: 5.6 Supported :white_check_mark: 5.5 EOL: 2016-07-10 :white_check_mark: 5.4 EOL: 2015-09-14 :white_check_mark: (up to Shaarli 0.8.x) 5.3 EOL: 2014-08-14 :white_check_mark: (up to Shaarli 0.8.x) See also:\n- Travis configuration", | ||
| 161 | "title": "Supported versions" | ||
| 162 | }, | ||
| 163 | { | ||
| 164 | "location": "/Server-requirements/#dependency-management", | ||
| 165 | "text": "Starting with Shaarli v0.8.x , Composer is used to resolve,\ndownload and install third-party PHP dependencies. Library Required? Usage shaarli/netscape-bookmark-parser All Import bookmarks from Netscape files erusev/parsedown All Parse MarkDown syntax for the MarkDown plugin slim/slim All Handle routes and middleware for the REST API", | ||
| 166 | "title": "Dependency management" | ||
| 167 | }, | ||
| 168 | { | ||
| 169 | "location": "/Server-requirements/#extensions", | ||
| 170 | "text": "Extension Required? Usage openssl All OpenSSL, HTTPS php-mbstring CentOS, Fedora, RHEL, Windows multibyte (Unicode) string support php-gd optional thumbnail resizing php-intl optional localized text sorting (e.g. e->\u00e8->f ) php-curl optional using cURL for fetching webpages and thumbnails in a more robust way", | ||
| 171 | "title": "Extensions" | ||
| 172 | }, | ||
| 173 | { | ||
| 174 | "location": "/Server-configuration/", | ||
| 175 | "text": "Example virtual host configurations for popular web servers\n\n\n\n\nApache\n\n\nNginx\n\n\n\n\nPrerequisites\n\n\nShaarli\n\n\n\n\nShaarli is installed in a directory readable/writeable by the user\n\n\nthe correct read/write permissions have been granted to the web server \nuser and/or group\n\n\nfor HTTPS / SSL:\n\n\na key pair (public, private) and a certificate have been generated\n\n\nthe appropriate server SSL extension is installed and active\n\n\n\n\nHTTPS, TLS and self-signed certificates\n\n\nRelated guides:\n\n \nHow to Create Self-Signed SSL Certificates with OpenSSL\n\n\n \nHow do I create my own Certificate Authority?\n\n* Generate a self-signed certificate (will trigger browser warnings) with apache2: \nmake-ssl-cert generate-default-snakeoil --force-overwrite\n will create \n/etc/ssl/certs/ssl-cert-snakeoil.pem\n and \n/etc/ssl/private/ssl-cert-snakeoil.key\n\n\nProxies\n\n\nIf Shaarli is served behind a proxy (i.e. there is a proxy server between clients and the web server hosting Shaarli), please refer to the proxy server documentation for proper configuration. In particular, you have to ensure that the following server variables are properly set:\n- \nX-Forwarded-Proto\n;\n- \nX-Forwarded-Host\n;\n- \nX-Forwarded-For\n.\n\n\nSee also \nproxy-related\n issues.\n\n\nApache\n\n\nMinimal\n\n\n<VirtualHost *:80>\n ServerName shaarli.my-domain.org\n DocumentRoot /absolute/path/to/shaarli/\n</VirtualHost>\n\n\n\n\nDebug - Log all the things!\n\n\nThis configuration will log both Apache and PHP errors, which may prove useful to identify server configuration errors.\n\n\nSee:\n\n \nApache/PHP - error log per VirtualHost\n (StackOverflow)\n\n \nPHP: php_value vs php_admin_value and the use of php_flag explained\n\n\n<VirtualHost *:80>\n ServerName shaarli.my-domain.org\n DocumentRoot /absolute/path/to/shaarli/\n\n LogLevel warn\n ErrorLog /var/log/apache2/shaarli-error.log\n CustomLog /var/log/apache2/shaarli-access.log combined\n\n php_flag log_errors on\n php_flag display_errors on\n php_value error_reporting 2147483647\n php_value error_log /var/log/apache2/shaarli-php-error.log\n</VirtualHost>\n\n\n\n\nStandard - Keep access and error logs\n\n\n<VirtualHost *:80>\n ServerName shaarli.my-domain.org\n DocumentRoot /absolute/path/to/shaarli/\n\n LogLevel warn\n ErrorLog /var/log/apache2/shaarli-error.log\n CustomLog /var/log/apache2/shaarli-access.log combined\n</VirtualHost>\n\n\n\n\nParanoid - Redirect HTTP (:80) to HTTPS (:443)\n\n\nSee \nServer-side TLS\n (Mozilla).\n\n\n<VirtualHost *:443>\n ServerName shaarli.my-domain.org\n DocumentRoot /absolute/path/to/shaarli/\n\n SSLEngine on\n SSLCertificateFile /absolute/path/to/the/website/certificate.pem\n SSLCertificateKeyFile /absolute/path/to/the/website/key.key\n\n <Directory /absolute/path/to/shaarli/>\n AllowOverride All\n Options Indexes FollowSymLinks MultiViews\n Order allow,deny\n allow from all\n </Directory>\n\n LogLevel warn\n ErrorLog /var/log/apache2/shaarli-error.log\n CustomLog /var/log/apache2/shaarli-access.log combined\n</VirtualHost>\n<VirtualHost *:80>\n ServerName shaarli.my-domain.org\n Redirect 301 / https://shaarli.my-domain.org\n\n LogLevel warn\n ErrorLog /var/log/apache2/shaarli-error.log\n CustomLog /var/log/apache2/shaarli-access.log combined\n</VirtualHost>\n\n\n\n\n.htaccess\n\n\nShaarli use \n.htaccess\n Apache files to deny access to files that shouldn't be directly accessed (datastore, config, etc.). You need the directive \nAllowOverride All\n in your virtual host configuration for them to work.\n\n\nWarning\n: If you use Apache 2.2 or lower, you need \nmod_version\n to be installed and enabled.\n\n\nApache module \nmod_rewrite\n \nmust\n be enabled to use the REST API. URL rewriting rules for the Slim microframework are stated in the root \n.htaccess\n file.\n\n\nLightHttpd\n\n\nNginx\n\n\nForeword\n\n\nNginx does not natively interpret PHP scripts; to this effect, we will run a \nFastCGI\n service, to which Nginx's FastCGI module will proxy all requests to PHP resources.\n\n\nRequired packages:\n- \nnginx\n\n- \nphp-fpm\n - PHP FastCGI Process Manager\n\n\nOfficial documentation:\n- \nBeginner's guide\n\n- \nngx_http_fastcgi_module\n\n- \nPitfalls\n\n\nCommunity resources:\n- \nServer-side TLS (Nginx)\n (Mozilla)\n- \nPHP configuration examples\n (Karl Blessing)\n\n\nCommon setup\n\n\nOnce Nginx and PHP-FPM are installed, we need to ensure:\n- Nginx and PHP-FPM are running using the \nsame user and group\n\n- both these user and group have\n - \nread\n permissions for Shaarli resources\n - \nexecute\n permissions for Shaarli directories \nAND\n their parent directories\n\n\nOn a production server:\n- \nuser:group\n will likely be \nhttp:http\n, \nwww:www\n or \nwww-data:www-data\n\n- files will be located under \n/var/www\n, \n/var/http\n or \n/usr/share/nginx\n\n\nOn a development server:\n- files may be located in a user's home directory\n- in this case, make sure both Nginx and PHP-FPM are running as the local user/group!\n\n\nFor all following configuration examples, this user/group pair will be used:\n- \nuser:group = john:users\n,\n\n\nwhich corresponds to the following service configuration:\n\n\n; /etc/php/php-fpm.conf\nuser = john\ngroup = users\n\n[...]\nlisten.owner = john\nlisten.group = users\n\n\n\n\n# /etc/nginx/nginx.conf\nuser john users;\n\nhttp {\n [...]\n}\n\n\n\n\n(Optional) Increase the maximum file upload size\n\n\nSome bookmark dumps generated by web browsers can be \nhuge\n due to the presence of Base64-encoded images and favicons, as well as extra verbosity when nesting links in (sub-)folders.\n\n\nTo increase upload size, you will need to modify both nginx and PHP configuration:\n\n\n# /etc/nginx/nginx.conf\n\nhttp {\n [...]\n\n client_max_body_size 10m;\n\n [...]\n}\n\n\n\n\n# /etc/php5/fpm/php.ini\n\n[...]\npost_max_size = 10M\n[...]\nupload_max_filesize = 10M\n\n\n\n\nMinimal\n\n\nWARNING: Use for development only!\n \n\n\nuser john users;\nworker_processes 1;\nevents {\n worker_connections 1024;\n}\n\nhttp {\n include mime.types;\n default_type application/octet-stream;\n keepalive_timeout 20;\n\n index index.html index.php;\n\n server {\n listen 80;\n server_name localhost;\n root /home/john/web;\n\n access_log /var/log/nginx/access.log;\n error_log /var/log/nginx/error.log;\n\n location /shaarli/ {\n try_files $uri /shaarli/index.php$is_args$args;\n access_log /var/log/nginx/shaarli.access.log;\n error_log /var/log/nginx/shaarli.error.log;\n }\n\n location ~ (index)\\.php$ {\n try_files $uri =404;\n fastcgi_split_path_info ^(.+\\.php)(/.+)$;\n fastcgi_pass unix:/var/run/php-fpm/php-fpm.sock;\n fastcgi_index index.php;\n include fastcgi.conf;\n }\n }\n}\n\n\n\n\nModular\n\n\nThe previous setup is sufficient for development purposes, but has several major caveats:\n- every content that does not match the PHP rule will be sent to client browsers:\n - dotfiles - in our case, \n.htaccess\n\n - temporary files, e.g. Vim or Emacs files: \nindex.php~\n\n- asset / static resource caching is not optimized\n- if serving several PHP sites, there will be a lot of duplication: \nlocation /shaarli/\n, \nlocation /mysite/\n, etc.\n\n\nTo solve this, we will split Nginx configuration in several parts, that will be included when needed:\n\n\n# /etc/nginx/deny.conf\nlocation ~ /\\. {\n # deny access to dotfiles\n access_log off;\n log_not_found off;\n deny all;\n}\n\nlocation ~ ~$ {\n # deny access to temp editor files, e.g. \"script.php~\"\n access_log off;\n log_not_found off;\n deny all;\n}\n\n\n\n\n# /etc/nginx/php.conf\nlocation ~ (index)\\.php$ {\n # Slim - split URL path into (script_filename, path_info)\n try_files $uri =404;\n fastcgi_split_path_info ^(.+\\.php)(/.+)$;\n\n # filter and proxy PHP requests to PHP-FPM\n fastcgi_pass unix:/var/run/php-fpm/php-fpm.sock;\n fastcgi_index index.php;\n include fastcgi.conf;\n}\n\nlocation ~ \\.php$ {\n # deny access to all other PHP scripts\n deny all;\n}\n\n\n\n\n# /etc/nginx/static_assets.conf\nlocation ~* \\.(?:ico|css|js|gif|jpe?g|png)$ {\n expires max;\n add_header Pragma public;\n add_header Cache-Control \"public, must-revalidate, proxy-revalidate\";\n}\n\n\n\n\n# /etc/nginx/nginx.conf\n[...]\n\nhttp {\n [...]\n\n root /home/john/web;\n access_log /var/log/nginx/access.log;\n error_log /var/log/nginx/error.log;\n\n server {\n # virtual host for a first domain\n listen 80;\n server_name my.first.domain.org;\n\n location /shaarli/ {\n # Slim - rewrite URLs\n try_files $uri /shaarli/index.php$is_args$args;\n\n access_log /var/log/nginx/shaarli.access.log;\n error_log /var/log/nginx/shaarli.error.log;\n }\n\n location = /shaarli/favicon.ico {\n # serve the Shaarli favicon from its custom location\n alias /var/www/shaarli/images/favicon.ico;\n }\n\n include deny.conf;\n include static_assets.conf;\n include php.conf;\n }\n\n server {\n # virtual host for a second domain\n listen 80;\n server_name second.domain.com;\n\n location /minigal/ {\n access_log /var/log/nginx/minigal.access.log;\n error_log /var/log/nginx/minigal.error.log;\n }\n\n include deny.conf;\n include static_assets.conf;\n include php.conf;\n }\n}\n\n\n\n\nRedirect HTTP to HTTPS\n\n\nAssuming you have generated a (self-signed) key and certificate, and they are located under \n/home/john/ssl/localhost.{key,crt}\n, it is pretty straightforward to set an HTTP (:80) to HTTPS (:443) redirection to force SSL/TLS usage.\n\n\n# /etc/nginx/nginx.conf\n[...]\n\nhttp {\n [...]\n\n index index.html index.php;\n\n root /home/john/web;\n access_log /var/log/nginx/access.log;\n error_log /var/log/nginx/error.log;\n\n server {\n listen 80;\n server_name localhost;\n\n return 301 https://localhost$request_uri;\n }\n\n server {\n listen 443 ssl;\n server_name localhost;\n\n ssl_certificate /home/john/ssl/localhost.crt;\n ssl_certificate_key /home/john/ssl/localhost.key;\n\n location /shaarli/ {\n # Slim - rewrite URLs\n try_files $uri /index.php$is_args$args;\n\n access_log /var/log/nginx/shaarli.access.log;\n error_log /var/log/nginx/shaarli.error.log;\n }\n\n location = /shaarli/favicon.ico {\n # serve the Shaarli favicon from its custom location\n alias /var/www/shaarli/images/favicon.ico;\n }\n\n include deny.conf;\n include static_assets.conf;\n include php.conf;\n }\n}", | ||
| 176 | "title": "Server configuration" | ||
| 177 | }, | ||
| 178 | { | ||
| 179 | "location": "/Server-configuration/#prerequisites", | ||
| 180 | "text": "", | ||
| 181 | "title": "Prerequisites" | ||
| 182 | }, | ||
| 183 | { | ||
| 184 | "location": "/Server-configuration/#shaarli", | ||
| 185 | "text": "Shaarli is installed in a directory readable/writeable by the user the correct read/write permissions have been granted to the web server user and/or group for HTTPS / SSL: a key pair (public, private) and a certificate have been generated the appropriate server SSL extension is installed and active", | ||
| 186 | "title": "Shaarli" | ||
| 187 | }, | ||
| 188 | { | ||
| 189 | "location": "/Server-configuration/#https-tls-and-self-signed-certificates", | ||
| 190 | "text": "Related guides: How to Create Self-Signed SSL Certificates with OpenSSL How do I create my own Certificate Authority? \n* Generate a self-signed certificate (will trigger browser warnings) with apache2: make-ssl-cert generate-default-snakeoil --force-overwrite will create /etc/ssl/certs/ssl-cert-snakeoil.pem and /etc/ssl/private/ssl-cert-snakeoil.key", | ||
| 191 | "title": "HTTPS, TLS and self-signed certificates" | ||
| 192 | }, | ||
| 193 | { | ||
| 194 | "location": "/Server-configuration/#proxies", | ||
| 195 | "text": "If Shaarli is served behind a proxy (i.e. there is a proxy server between clients and the web server hosting Shaarli), please refer to the proxy server documentation for proper configuration. In particular, you have to ensure that the following server variables are properly set:\n- X-Forwarded-Proto ;\n- X-Forwarded-Host ;\n- X-Forwarded-For . See also proxy-related issues.", | ||
| 196 | "title": "Proxies" | ||
| 197 | }, | ||
| 198 | { | ||
| 199 | "location": "/Server-configuration/#apache", | ||
| 200 | "text": "", | ||
| 201 | "title": "Apache" | ||
| 202 | }, | ||
| 203 | { | ||
| 204 | "location": "/Server-configuration/#minimal", | ||
| 205 | "text": "<VirtualHost *:80>\n ServerName shaarli.my-domain.org\n DocumentRoot /absolute/path/to/shaarli/\n</VirtualHost>", | ||
| 206 | "title": "Minimal" | ||
| 207 | }, | ||
| 208 | { | ||
| 209 | "location": "/Server-configuration/#debug-log-all-the-things", | ||
| 210 | "text": "This configuration will log both Apache and PHP errors, which may prove useful to identify server configuration errors. See: Apache/PHP - error log per VirtualHost (StackOverflow) PHP: php_value vs php_admin_value and the use of php_flag explained <VirtualHost *:80>\n ServerName shaarli.my-domain.org\n DocumentRoot /absolute/path/to/shaarli/\n\n LogLevel warn\n ErrorLog /var/log/apache2/shaarli-error.log\n CustomLog /var/log/apache2/shaarli-access.log combined\n\n php_flag log_errors on\n php_flag display_errors on\n php_value error_reporting 2147483647\n php_value error_log /var/log/apache2/shaarli-php-error.log\n</VirtualHost>", | ||
| 211 | "title": "Debug - Log all the things!" | ||
| 212 | }, | ||
| 213 | { | ||
| 214 | "location": "/Server-configuration/#standard-keep-access-and-error-logs", | ||
| 215 | "text": "<VirtualHost *:80>\n ServerName shaarli.my-domain.org\n DocumentRoot /absolute/path/to/shaarli/\n\n LogLevel warn\n ErrorLog /var/log/apache2/shaarli-error.log\n CustomLog /var/log/apache2/shaarli-access.log combined\n</VirtualHost>", | ||
| 216 | "title": "Standard - Keep access and error logs" | ||
| 217 | }, | ||
| 218 | { | ||
| 219 | "location": "/Server-configuration/#paranoid-redirect-http-80-to-https-443", | ||
| 220 | "text": "See Server-side TLS (Mozilla). <VirtualHost *:443>\n ServerName shaarli.my-domain.org\n DocumentRoot /absolute/path/to/shaarli/\n\n SSLEngine on\n SSLCertificateFile /absolute/path/to/the/website/certificate.pem\n SSLCertificateKeyFile /absolute/path/to/the/website/key.key\n\n <Directory /absolute/path/to/shaarli/>\n AllowOverride All\n Options Indexes FollowSymLinks MultiViews\n Order allow,deny\n allow from all\n </Directory>\n\n LogLevel warn\n ErrorLog /var/log/apache2/shaarli-error.log\n CustomLog /var/log/apache2/shaarli-access.log combined\n</VirtualHost>\n<VirtualHost *:80>\n ServerName shaarli.my-domain.org\n Redirect 301 / https://shaarli.my-domain.org\n\n LogLevel warn\n ErrorLog /var/log/apache2/shaarli-error.log\n CustomLog /var/log/apache2/shaarli-access.log combined\n</VirtualHost>", | ||
| 221 | "title": "Paranoid - Redirect HTTP (:80) to HTTPS (:443)" | ||
| 222 | }, | ||
| 223 | { | ||
| 224 | "location": "/Server-configuration/#htaccess", | ||
| 225 | "text": "Shaarli use .htaccess Apache files to deny access to files that shouldn't be directly accessed (datastore, config, etc.). You need the directive AllowOverride All in your virtual host configuration for them to work. Warning : If you use Apache 2.2 or lower, you need mod_version to be installed and enabled. Apache module mod_rewrite must be enabled to use the REST API. URL rewriting rules for the Slim microframework are stated in the root .htaccess file.", | ||
| 226 | "title": ".htaccess" | ||
| 227 | }, | ||
| 228 | { | ||
| 229 | "location": "/Server-configuration/#lighthttpd", | ||
| 230 | "text": "", | ||
| 231 | "title": "LightHttpd" | ||
| 232 | }, | ||
| 233 | { | ||
| 234 | "location": "/Server-configuration/#nginx", | ||
| 235 | "text": "", | ||
| 236 | "title": "Nginx" | ||
| 237 | }, | ||
| 238 | { | ||
| 239 | "location": "/Server-configuration/#foreword", | ||
| 240 | "text": "Nginx does not natively interpret PHP scripts; to this effect, we will run a FastCGI service, to which Nginx's FastCGI module will proxy all requests to PHP resources. Required packages:\n- nginx \n- php-fpm - PHP FastCGI Process Manager Official documentation:\n- Beginner's guide \n- ngx_http_fastcgi_module \n- Pitfalls Community resources:\n- Server-side TLS (Nginx) (Mozilla)\n- PHP configuration examples (Karl Blessing)", | ||
| 241 | "title": "Foreword" | ||
| 242 | }, | ||
| 243 | { | ||
| 244 | "location": "/Server-configuration/#common-setup", | ||
| 245 | "text": "Once Nginx and PHP-FPM are installed, we need to ensure:\n- Nginx and PHP-FPM are running using the same user and group \n- both these user and group have\n - read permissions for Shaarli resources\n - execute permissions for Shaarli directories AND their parent directories On a production server:\n- user:group will likely be http:http , www:www or www-data:www-data \n- files will be located under /var/www , /var/http or /usr/share/nginx On a development server:\n- files may be located in a user's home directory\n- in this case, make sure both Nginx and PHP-FPM are running as the local user/group! For all following configuration examples, this user/group pair will be used:\n- user:group = john:users , which corresponds to the following service configuration: ; /etc/php/php-fpm.conf\nuser = john\ngroup = users\n\n[...]\nlisten.owner = john\nlisten.group = users # /etc/nginx/nginx.conf\nuser john users;\n\nhttp {\n [...]\n}", | ||
| 246 | "title": "Common setup" | ||
| 247 | }, | ||
| 248 | { | ||
| 249 | "location": "/Server-configuration/#optional-increase-the-maximum-file-upload-size", | ||
| 250 | "text": "Some bookmark dumps generated by web browsers can be huge due to the presence of Base64-encoded images and favicons, as well as extra verbosity when nesting links in (sub-)folders. To increase upload size, you will need to modify both nginx and PHP configuration: # /etc/nginx/nginx.conf\n\nhttp {\n [...]\n\n client_max_body_size 10m;\n\n [...]\n} # /etc/php5/fpm/php.ini\n\n[...]\npost_max_size = 10M\n[...]\nupload_max_filesize = 10M", | ||
| 251 | "title": "(Optional) Increase the maximum file upload size" | ||
| 252 | }, | ||
| 253 | { | ||
| 254 | "location": "/Server-configuration/#minimal_1", | ||
| 255 | "text": "WARNING: Use for development only! user john users;\nworker_processes 1;\nevents {\n worker_connections 1024;\n}\n\nhttp {\n include mime.types;\n default_type application/octet-stream;\n keepalive_timeout 20;\n\n index index.html index.php;\n\n server {\n listen 80;\n server_name localhost;\n root /home/john/web;\n\n access_log /var/log/nginx/access.log;\n error_log /var/log/nginx/error.log;\n\n location /shaarli/ {\n try_files $uri /shaarli/index.php$is_args$args;\n access_log /var/log/nginx/shaarli.access.log;\n error_log /var/log/nginx/shaarli.error.log;\n }\n\n location ~ (index)\\.php$ {\n try_files $uri =404;\n fastcgi_split_path_info ^(.+\\.php)(/.+)$;\n fastcgi_pass unix:/var/run/php-fpm/php-fpm.sock;\n fastcgi_index index.php;\n include fastcgi.conf;\n }\n }\n}", | ||
| 256 | "title": "Minimal" | ||
| 257 | }, | ||
| 258 | { | ||
| 259 | "location": "/Server-configuration/#modular", | ||
| 260 | "text": "The previous setup is sufficient for development purposes, but has several major caveats:\n- every content that does not match the PHP rule will be sent to client browsers:\n - dotfiles - in our case, .htaccess \n - temporary files, e.g. Vim or Emacs files: index.php~ \n- asset / static resource caching is not optimized\n- if serving several PHP sites, there will be a lot of duplication: location /shaarli/ , location /mysite/ , etc. To solve this, we will split Nginx configuration in several parts, that will be included when needed: # /etc/nginx/deny.conf\nlocation ~ /\\. {\n # deny access to dotfiles\n access_log off;\n log_not_found off;\n deny all;\n}\n\nlocation ~ ~$ {\n # deny access to temp editor files, e.g. \"script.php~\"\n access_log off;\n log_not_found off;\n deny all;\n} # /etc/nginx/php.conf\nlocation ~ (index)\\.php$ {\n # Slim - split URL path into (script_filename, path_info)\n try_files $uri =404;\n fastcgi_split_path_info ^(.+\\.php)(/.+)$;\n\n # filter and proxy PHP requests to PHP-FPM\n fastcgi_pass unix:/var/run/php-fpm/php-fpm.sock;\n fastcgi_index index.php;\n include fastcgi.conf;\n}\n\nlocation ~ \\.php$ {\n # deny access to all other PHP scripts\n deny all;\n} # /etc/nginx/static_assets.conf\nlocation ~* \\.(?:ico|css|js|gif|jpe?g|png)$ {\n expires max;\n add_header Pragma public;\n add_header Cache-Control \"public, must-revalidate, proxy-revalidate\";\n} # /etc/nginx/nginx.conf\n[...]\n\nhttp {\n [...]\n\n root /home/john/web;\n access_log /var/log/nginx/access.log;\n error_log /var/log/nginx/error.log;\n\n server {\n # virtual host for a first domain\n listen 80;\n server_name my.first.domain.org;\n\n location /shaarli/ {\n # Slim - rewrite URLs\n try_files $uri /shaarli/index.php$is_args$args;\n\n access_log /var/log/nginx/shaarli.access.log;\n error_log /var/log/nginx/shaarli.error.log;\n }\n\n location = /shaarli/favicon.ico {\n # serve the Shaarli favicon from its custom location\n alias /var/www/shaarli/images/favicon.ico;\n }\n\n include deny.conf;\n include static_assets.conf;\n include php.conf;\n }\n\n server {\n # virtual host for a second domain\n listen 80;\n server_name second.domain.com;\n\n location /minigal/ {\n access_log /var/log/nginx/minigal.access.log;\n error_log /var/log/nginx/minigal.error.log;\n }\n\n include deny.conf;\n include static_assets.conf;\n include php.conf;\n }\n}", | ||
| 261 | "title": "Modular" | ||
| 262 | }, | ||
| 263 | { | ||
| 264 | "location": "/Server-configuration/#redirect-http-to-https", | ||
| 265 | "text": "Assuming you have generated a (self-signed) key and certificate, and they are located under /home/john/ssl/localhost.{key,crt} , it is pretty straightforward to set an HTTP (:80) to HTTPS (:443) redirection to force SSL/TLS usage. # /etc/nginx/nginx.conf\n[...]\n\nhttp {\n [...]\n\n index index.html index.php;\n\n root /home/john/web;\n access_log /var/log/nginx/access.log;\n error_log /var/log/nginx/error.log;\n\n server {\n listen 80;\n server_name localhost;\n\n return 301 https://localhost$request_uri;\n }\n\n server {\n listen 443 ssl;\n server_name localhost;\n\n ssl_certificate /home/john/ssl/localhost.crt;\n ssl_certificate_key /home/john/ssl/localhost.key;\n\n location /shaarli/ {\n # Slim - rewrite URLs\n try_files $uri /index.php$is_args$args;\n\n access_log /var/log/nginx/shaarli.access.log;\n error_log /var/log/nginx/shaarli.error.log;\n }\n\n location = /shaarli/favicon.ico {\n # serve the Shaarli favicon from its custom location\n alias /var/www/shaarli/images/favicon.ico;\n }\n\n include deny.conf;\n include static_assets.conf;\n include php.conf;\n }\n}", | ||
| 266 | "title": "Redirect HTTP to HTTPS" | ||
| 267 | }, | ||
| 268 | { | ||
| 269 | "location": "/Server-security/", | ||
| 270 | "text": "php.ini\n\n\nPHP settings are defined in:\n- a main configuration file, usually found under \n/etc/php5/php.ini\n; some distributions provide different configuration environments, e.g.\n - \n/etc/php5/php.ini\n - used when running console scripts\n - \n/etc/php5/apache2/php.ini\n - used when a client requests PHP resources from Apache\n - \n/etc/php5/php-fpm.conf\n - used when PHP requests are proxied to PHP-FPM\n- additional configuration files/entries, depending on the installed/enabled extensions:\n - \n/etc/php/conf.d/xdebug.ini\n\n\nLocate .ini files\n\n\nConsole environment\n\n\n$ php --ini\nConfiguration File (php.ini) Path: /etc/php\nLoaded Configuration File: /etc/php/php.ini\nScan for additional .ini files in: /etc/php/conf.d\nAdditional .ini files parsed: /etc/php/conf.d/xdebug.ini\n\n\n\n\nServer environment\n\n\n\n\ncreate a \nphpinfo.php\n script located in a path supported by the web server, e.g.\n\n\nApache (with user dirs enabled): \n/home/myself/public_html/phpinfo.php\n\n\n/var/www/test/phpinfo.php\n\n\n\n\n\n\nmake sure the script is readable by the web server user/group (usually, \nwww\n, \nwww-data\n or \nhttpd\n)\n\n\naccess the script from a web browser\n\n\nlook at the \nLoaded Configuration File\n and \nScan this dir for additional .ini files\n entries\n\n\n\n\n<?php phpinfo(); ?>\n\n\n\n\nfail2ban\n\n\nfail2ban\n is an intrusion prevention framework that reads server (Apache, SSH, etc.) and uses \niptables\n profiles to block brute-force attempts:\n- \nOfficial website\n\n- \nSource code\n\n\nRead Shaarli logs to ban IPs\n\n\nExample configuration:\n- allow 3 login attempts per IP address\n- after 3 failures, permanently ban the corresponding IP adddress\n\n\n/etc/fail2ban/jail.local\n\n\n[shaarli-auth]\nenabled = true\nport = https,http\nfilter = shaarli-auth\nlogpath = /var/www/path/to/shaarli/data/log.txt\nmaxretry = 3\nbantime = -1\n\n\n\n\n/etc/fail2ban/filter.d/shaarli-auth.conf\n\n\n[INCLUDES]\nbefore = common.conf\n[Definition]\nfailregex = \\s-\\s<HOST>\\s-\\sLogin failed for user.*$\nignoreregex = \n\n\n\n\nRobots - Restricting search engines and web crawler traffic\n\n\nCreating a \nrobots.txt\n with the following contents at the root of your Shaarli installation will prevent \nhonest\n web crawlers from indexing each and every link and Daily page from a Shaarli instance, thus getting rid of a certain amount of unsollicited network traffic.\n\n\nUser-agent: *\nDisallow: /\n\n\n\n\nSee:\n- http://www.robotstxt.org/\n- http://www.robotstxt.org/robotstxt.html\n- http://www.robotstxt.org/meta.html", | ||
| 271 | "title": "Server security" | ||
| 272 | }, | ||
| 273 | { | ||
| 274 | "location": "/Server-security/#phpini", | ||
| 275 | "text": "PHP settings are defined in:\n- a main configuration file, usually found under /etc/php5/php.ini ; some distributions provide different configuration environments, e.g.\n - /etc/php5/php.ini - used when running console scripts\n - /etc/php5/apache2/php.ini - used when a client requests PHP resources from Apache\n - /etc/php5/php-fpm.conf - used when PHP requests are proxied to PHP-FPM\n- additional configuration files/entries, depending on the installed/enabled extensions:\n - /etc/php/conf.d/xdebug.ini", | ||
| 276 | "title": "php.ini" | ||
| 277 | }, | ||
| 278 | { | ||
| 279 | "location": "/Server-security/#locate-ini-files", | ||
| 280 | "text": "", | ||
| 281 | "title": "Locate .ini files" | ||
| 282 | }, | ||
| 283 | { | ||
| 284 | "location": "/Server-security/#console-environment", | ||
| 285 | "text": "$ php --ini\nConfiguration File (php.ini) Path: /etc/php\nLoaded Configuration File: /etc/php/php.ini\nScan for additional .ini files in: /etc/php/conf.d\nAdditional .ini files parsed: /etc/php/conf.d/xdebug.ini", | ||
| 286 | "title": "Console environment" | ||
| 287 | }, | ||
| 288 | { | ||
| 289 | "location": "/Server-security/#server-environment", | ||
| 290 | "text": "create a phpinfo.php script located in a path supported by the web server, e.g. Apache (with user dirs enabled): /home/myself/public_html/phpinfo.php /var/www/test/phpinfo.php make sure the script is readable by the web server user/group (usually, www , www-data or httpd ) access the script from a web browser look at the Loaded Configuration File and Scan this dir for additional .ini files entries <?php phpinfo(); ?>", | ||
| 291 | "title": "Server environment" | ||
| 292 | }, | ||
| 293 | { | ||
| 294 | "location": "/Server-security/#fail2ban", | ||
| 295 | "text": "fail2ban is an intrusion prevention framework that reads server (Apache, SSH, etc.) and uses iptables profiles to block brute-force attempts:\n- Official website \n- Source code", | ||
| 296 | "title": "fail2ban" | ||
| 297 | }, | ||
| 298 | { | ||
| 299 | "location": "/Server-security/#read-shaarli-logs-to-ban-ips", | ||
| 300 | "text": "Example configuration:\n- allow 3 login attempts per IP address\n- after 3 failures, permanently ban the corresponding IP adddress /etc/fail2ban/jail.local [shaarli-auth]\nenabled = true\nport = https,http\nfilter = shaarli-auth\nlogpath = /var/www/path/to/shaarli/data/log.txt\nmaxretry = 3\nbantime = -1 /etc/fail2ban/filter.d/shaarli-auth.conf [INCLUDES]\nbefore = common.conf\n[Definition]\nfailregex = \\s-\\s<HOST>\\s-\\sLogin failed for user.*$\nignoreregex =", | ||
| 301 | "title": "Read Shaarli logs to ban IPs" | ||
| 302 | }, | ||
| 303 | { | ||
| 304 | "location": "/Server-security/#robots-restricting-search-engines-and-web-crawler-traffic", | ||
| 305 | "text": "Creating a robots.txt with the following contents at the root of your Shaarli installation will prevent honest web crawlers from indexing each and every link and Daily page from a Shaarli instance, thus getting rid of a certain amount of unsollicited network traffic. User-agent: *\nDisallow: / See:\n- http://www.robotstxt.org/\n- http://www.robotstxt.org/robotstxt.html\n- http://www.robotstxt.org/meta.html", | ||
| 306 | "title": "Robots - Restricting search engines and web crawler traffic" | ||
| 307 | }, | ||
| 308 | { | ||
| 309 | "location": "/Shaarli-configuration/", | ||
| 310 | "text": "Foreword\n\n\nDo not edit configuration options in index.php! Your changes would be lost.\n \n\n\nOnce your Shaarli instance is installed, the file \ndata/config.json.php\n is generated:\n\n it contains all settings in JSON format, and can be edited to customize values\n\n it defines which \nplugins\n are enabled\n\n\n its values override those defined in \nindex.php\n\n\n it is wrap in a PHP comment to prevent anyone accessing it, regardless of server configuration\n\n\nFile and directory permissions\n\n\nThe server process running Shaarli must have:\n- \nread\n access to the following resources:\n - PHP scripts: \nindex.php\n, \napplication/*.php\n, \nplugins/*.php\n\n - 3rd party PHP and Javascript libraries: \ninc/*.php\n, \ninc/*.js\n\n - static assets:\n - CSS stylesheets: \ninc/*.css\n\n - \nimages/*\n\n - RainTPL templates: \ntpl/*.html\n\n- \nread\n, \nwrite\n and \nexecution\n access to the following directories:\n - \ncache\n - thumbnail cache\n - \ndata\n - link data store, configuration options\n - \npagecache\n - Atom/RSS feed cache\n - \ntmp\n - RainTPL page cache\n\n\nOn a Linux distribution:\n- the web server user will likely be \nwww\n or \nhttp\n (for Apache2)\n- it will be a member of a group of the same name: \nwww:www\n, \nhttp:http\n\n- to give it access to Shaarli, either:\n - unzip Shaarli in the default web server location (usually \n/var/www/\n) and set the web server user as the owner\n - put users in the same group as the web server, and set the appropriate access rights\n- if you have a domain / subdomain to serve Shaarli, \nconfigure the server\n accordingly\n\n\nConfiguration\n\n\nIn \ndata/config.json.php\n.\n\n\nSee also \nPlugin System\n.\n\n\nCredentials\n\n\n\n\nYou shouldn't edit those.\n\n\n\n\nlogin\n: Login username.\n\n\nhash\n: Generated password hash.\n\n\nsalt\n: Password salt.\n\n\nGeneral\n\n\ntitle\n: Shaarli's instance title.\n\n\nheader_link\n: Link to the homepage.\n\n\nlinks_per_page\n: Number of shaares displayed per page.\n\n\ntimezone\n: See \nthe list of supported timezones\n.\n\n\nenabled_plugins\n: List of enabled plugins.\n\n\nSecurity\n\n\nsession_protection_disabled\n: Disable session cookie hijacking protection (not recommended). \nIt might be useful if your IP adress often changes.\n\n\nban_after\n: Failed login attempts before being IP banned.\n\n\nban_duration\n: IP ban duration in seconds.\n\n\nopen_shaarli\n: Anyone can add a new link while logged out if enabled.\n\n\ntrusted_proxies\n: List of trusted IP which won't be banned after failed login attemps. Useful if Shaarli is behind a reverse proxy.\n\n\nallowed_protocols\n: List of allowed protocols in shaare URLs or markdown-rendered descriptions. Useful if you want to store \njavascript:\n links (bookmarklets) in Shaarli (default: \n[\"ftp\", \"ftps\", \"magnet\"]\n).\n\n\nResources\n\n\ndata_dir\n: Data directory.\n\n\ndatastore\n: Shaarli's links database file path.\n\n\nhistory\n: Shaarli's operation history file path.\n\nupdates\n: File path for the ran updates file.\n\n\nlog\n: Log file path.\n\n\nupdate_check\n: Last update check file path.\n\n\nraintpl_tpl\n: Templates directory.\n\n\nraintpl_tmp\n: Template engine cache directory.\n\n\nthumbnails_cache\n: Thumbnails cache directory.\n\n\npage_cache\n: Shaarli's internal cache directory.\n\n\nban_file\n: Banned IP file path.\n\n\nUpdates\n\n\ncheck_updates\n: Enable or disable update check to the git repository.\n\n\ncheck_updates_branch\n: Git branch used to check updates (e.g. \nstable\n or \nmaster\n).\n\n\ncheck_updates_interval\n: Look for new version every N seconds (default: every day).\n\n\nPrivacy\n\n\ndefault_private_links\n: Check the private checkbox by default for every new link.\n\n\nhide_public_links\n: All links are hidden while logged out.\n\n\nhide_timestamps\n: Timestamps are hidden.\n\n\nFeed\n\n\nrss_permalinks\n: Enable this to redirect RSS links to Shaarli's permalinks instead of shaared URL.\n\n\nshow_atom\n: Display ATOM feed button.\n\n\nThumbnail\n\n\nenable_thumbnails\n: Enable or disable thumbnail display.\n\n\nenable_localcache\n: Enable or disable local cache.\n\n\nRedirector\n\n\nurl\n: Redirector URL, such as \nanonym.to\n.\n\n\nencode_url\n: Enable this if the redirector needs encoded URL to work properly.\n\n\nConfiguration file example\n\n\n<?php /*\n{\n \"credentials\": {\n \"login\": \"<login>\",\n \"hash\": \"<password hash>\",\n \"salt\": \"<password salt>\"\n },\n \"security\": {\n \"ban_after\": 4,\n \"session_protection_disabled\": false,\n \"ban_duration\": 1800,\n \"trusted_proxies\": [\n \"1.2.3.4\",\n \"5.6.7.8\"\n ],\n \"allowed_protocols\": [\n \"ftp\",\n \"ftps\",\n \"magnet\"\n ]\n },\n \"resources\": {\n \"data_dir\": \"data\",\n \"config\": \"data\\/config.php\",\n \"datastore\": \"data\\/datastore.php\",\n \"ban_file\": \"data\\/ipbans.php\",\n \"updates\": \"data\\/updates.txt\",\n \"log\": \"data\\/log.txt\",\n \"update_check\": \"data\\/lastupdatecheck.txt\",\n \"raintpl_tmp\": \"tmp\\/\",\n \"raintpl_tpl\": \"tpl\\/\",\n \"thumbnails_cache\": \"cache\",\n \"page_cache\": \"pagecache\"\n },\n \"general\": {\n \"check_updates\": true,\n \"rss_permalinks\": true,\n \"links_per_page\": 20,\n \"default_private_links\": true,\n \"enable_thumbnails\": true,\n \"enable_localcache\": true,\n \"check_updates_branch\": \"stable\",\n \"check_updates_interval\": 86400,\n \"enabled_plugins\": [\n \"markdown\",\n \"wallabag\",\n \"archiveorg\"\n ],\n \"timezone\": \"Europe\\/Paris\",\n \"title\": \"My Shaarli\",\n \"header_link\": \"?\"\n },\n \"extras\": {\n \"show_atom\": false,\n \"hide_public_links\": false,\n \"hide_timestamps\": false,\n \"open_shaarli\": false,\n \"redirector\": \"http://anonym.to/?\",\n \"redirector_encode_url\": false\n },\n \"general\": {\n \"header_link\": \"?\",\n \"links_per_page\": 20,\n \"enabled_plugins\": [\n \"markdown\",\n \"wallabag\"\n ],\n \"timezone\": \"Europe\\/Paris\",\n \"title\": \"My Shaarli\"\n },\n \"updates\": {\n \"check_updates\": true,\n \"check_updates_branch\": \"stable\",\n \"check_updates_interval\": 86400\n },\n \"feed\": {\n \"rss_permalinks\": true,\n \"show_atom\": false\n },\n \"privacy\": {\n \"default_private_links\": true,\n \"hide_public_links\": false,\n \"hide_timestamps\": false\n },\n \"thumbnail\": {\n \"enable_thumbnails\": true,\n \"enable_localcache\": true\n },\n \"redirector\": {\n \"url\": \"http://anonym.to/?\",\n \"encode_url\": false\n },\n \"plugins\": {\n \"WALLABAG_URL\": \"http://demo.wallabag.org\",\n \"WALLABAG_VERSION\": \"1\"\n }\n} ?>\n\n\n\n\nAdditional configuration\n\n\nThe playvideos plugin may require that you adapt your server's \n\nContent Security Policy\n \nconfiguration to work properly.", | ||
| 311 | "title": "Shaarli configuration" | ||
| 312 | }, | ||
| 313 | { | ||
| 314 | "location": "/Shaarli-configuration/#foreword", | ||
| 315 | "text": "Do not edit configuration options in index.php! Your changes would be lost. Once your Shaarli instance is installed, the file data/config.json.php is generated: it contains all settings in JSON format, and can be edited to customize values it defines which plugins are enabled its values override those defined in index.php it is wrap in a PHP comment to prevent anyone accessing it, regardless of server configuration", | ||
| 316 | "title": "Foreword" | ||
| 317 | }, | ||
| 318 | { | ||
| 319 | "location": "/Shaarli-configuration/#file-and-directory-permissions", | ||
| 320 | "text": "The server process running Shaarli must have:\n- read access to the following resources:\n - PHP scripts: index.php , application/*.php , plugins/*.php \n - 3rd party PHP and Javascript libraries: inc/*.php , inc/*.js \n - static assets:\n - CSS stylesheets: inc/*.css \n - images/* \n - RainTPL templates: tpl/*.html \n- read , write and execution access to the following directories:\n - cache - thumbnail cache\n - data - link data store, configuration options\n - pagecache - Atom/RSS feed cache\n - tmp - RainTPL page cache On a Linux distribution:\n- the web server user will likely be www or http (for Apache2)\n- it will be a member of a group of the same name: www:www , http:http \n- to give it access to Shaarli, either:\n - unzip Shaarli in the default web server location (usually /var/www/ ) and set the web server user as the owner\n - put users in the same group as the web server, and set the appropriate access rights\n- if you have a domain / subdomain to serve Shaarli, configure the server accordingly", | ||
| 321 | "title": "File and directory permissions" | ||
| 322 | }, | ||
| 323 | { | ||
| 324 | "location": "/Shaarli-configuration/#configuration", | ||
| 325 | "text": "In data/config.json.php . See also Plugin System .", | ||
| 326 | "title": "Configuration" | ||
| 327 | }, | ||
| 328 | { | ||
| 329 | "location": "/Shaarli-configuration/#credentials", | ||
| 330 | "text": "You shouldn't edit those. login : Login username. hash : Generated password hash. salt : Password salt.", | ||
| 331 | "title": "Credentials" | ||
| 332 | }, | ||
| 333 | { | ||
| 334 | "location": "/Shaarli-configuration/#general", | ||
| 335 | "text": "title : Shaarli's instance title. header_link : Link to the homepage. links_per_page : Number of shaares displayed per page. timezone : See the list of supported timezones . enabled_plugins : List of enabled plugins.", | ||
| 336 | "title": "General" | ||
| 337 | }, | ||
| 338 | { | ||
| 339 | "location": "/Shaarli-configuration/#security", | ||
| 340 | "text": "session_protection_disabled : Disable session cookie hijacking protection (not recommended). \nIt might be useful if your IP adress often changes. ban_after : Failed login attempts before being IP banned. ban_duration : IP ban duration in seconds. open_shaarli : Anyone can add a new link while logged out if enabled. trusted_proxies : List of trusted IP which won't be banned after failed login attemps. Useful if Shaarli is behind a reverse proxy. allowed_protocols : List of allowed protocols in shaare URLs or markdown-rendered descriptions. Useful if you want to store javascript: links (bookmarklets) in Shaarli (default: [\"ftp\", \"ftps\", \"magnet\"] ).", | ||
| 341 | "title": "Security" | ||
| 342 | }, | ||
| 343 | { | ||
| 344 | "location": "/Shaarli-configuration/#resources", | ||
| 345 | "text": "data_dir : Data directory. datastore : Shaarli's links database file path. history : Shaarli's operation history file path. updates : File path for the ran updates file. log : Log file path. update_check : Last update check file path. raintpl_tpl : Templates directory. raintpl_tmp : Template engine cache directory. thumbnails_cache : Thumbnails cache directory. page_cache : Shaarli's internal cache directory. ban_file : Banned IP file path.", | ||
| 346 | "title": "Resources" | ||
| 347 | }, | ||
| 348 | { | ||
| 349 | "location": "/Shaarli-configuration/#updates", | ||
| 350 | "text": "check_updates : Enable or disable update check to the git repository. check_updates_branch : Git branch used to check updates (e.g. stable or master ). check_updates_interval : Look for new version every N seconds (default: every day).", | ||
| 351 | "title": "Updates" | ||
| 352 | }, | ||
| 353 | { | ||
| 354 | "location": "/Shaarli-configuration/#privacy", | ||
| 355 | "text": "default_private_links : Check the private checkbox by default for every new link. hide_public_links : All links are hidden while logged out. hide_timestamps : Timestamps are hidden.", | ||
| 356 | "title": "Privacy" | ||
| 357 | }, | ||
| 358 | { | ||
| 359 | "location": "/Shaarli-configuration/#feed", | ||
| 360 | "text": "rss_permalinks : Enable this to redirect RSS links to Shaarli's permalinks instead of shaared URL. show_atom : Display ATOM feed button.", | ||
| 361 | "title": "Feed" | ||
| 362 | }, | ||
| 363 | { | ||
| 364 | "location": "/Shaarli-configuration/#thumbnail", | ||
| 365 | "text": "enable_thumbnails : Enable or disable thumbnail display. enable_localcache : Enable or disable local cache.", | ||
| 366 | "title": "Thumbnail" | ||
| 367 | }, | ||
| 368 | { | ||
| 369 | "location": "/Shaarli-configuration/#redirector", | ||
| 370 | "text": "url : Redirector URL, such as anonym.to . encode_url : Enable this if the redirector needs encoded URL to work properly.", | ||
| 371 | "title": "Redirector" | ||
| 372 | }, | ||
| 373 | { | ||
| 374 | "location": "/Shaarli-configuration/#configuration-file-example", | ||
| 375 | "text": "<?php /*\n{\n \"credentials\": {\n \"login\": \"<login>\",\n \"hash\": \"<password hash>\",\n \"salt\": \"<password salt>\"\n },\n \"security\": {\n \"ban_after\": 4,\n \"session_protection_disabled\": false,\n \"ban_duration\": 1800,\n \"trusted_proxies\": [\n \"1.2.3.4\",\n \"5.6.7.8\"\n ],\n \"allowed_protocols\": [\n \"ftp\",\n \"ftps\",\n \"magnet\"\n ]\n },\n \"resources\": {\n \"data_dir\": \"data\",\n \"config\": \"data\\/config.php\",\n \"datastore\": \"data\\/datastore.php\",\n \"ban_file\": \"data\\/ipbans.php\",\n \"updates\": \"data\\/updates.txt\",\n \"log\": \"data\\/log.txt\",\n \"update_check\": \"data\\/lastupdatecheck.txt\",\n \"raintpl_tmp\": \"tmp\\/\",\n \"raintpl_tpl\": \"tpl\\/\",\n \"thumbnails_cache\": \"cache\",\n \"page_cache\": \"pagecache\"\n },\n \"general\": {\n \"check_updates\": true,\n \"rss_permalinks\": true,\n \"links_per_page\": 20,\n \"default_private_links\": true,\n \"enable_thumbnails\": true,\n \"enable_localcache\": true,\n \"check_updates_branch\": \"stable\",\n \"check_updates_interval\": 86400,\n \"enabled_plugins\": [\n \"markdown\",\n \"wallabag\",\n \"archiveorg\"\n ],\n \"timezone\": \"Europe\\/Paris\",\n \"title\": \"My Shaarli\",\n \"header_link\": \"?\"\n },\n \"extras\": {\n \"show_atom\": false,\n \"hide_public_links\": false,\n \"hide_timestamps\": false,\n \"open_shaarli\": false,\n \"redirector\": \"http://anonym.to/?\",\n \"redirector_encode_url\": false\n },\n \"general\": {\n \"header_link\": \"?\",\n \"links_per_page\": 20,\n \"enabled_plugins\": [\n \"markdown\",\n \"wallabag\"\n ],\n \"timezone\": \"Europe\\/Paris\",\n \"title\": \"My Shaarli\"\n },\n \"updates\": {\n \"check_updates\": true,\n \"check_updates_branch\": \"stable\",\n \"check_updates_interval\": 86400\n },\n \"feed\": {\n \"rss_permalinks\": true,\n \"show_atom\": false\n },\n \"privacy\": {\n \"default_private_links\": true,\n \"hide_public_links\": false,\n \"hide_timestamps\": false\n },\n \"thumbnail\": {\n \"enable_thumbnails\": true,\n \"enable_localcache\": true\n },\n \"redirector\": {\n \"url\": \"http://anonym.to/?\",\n \"encode_url\": false\n },\n \"plugins\": {\n \"WALLABAG_URL\": \"http://demo.wallabag.org\",\n \"WALLABAG_VERSION\": \"1\"\n }\n} ?>", | ||
| 376 | "title": "Configuration file example" | ||
| 377 | }, | ||
| 378 | { | ||
| 379 | "location": "/Shaarli-configuration/#additional-configuration", | ||
| 380 | "text": "The playvideos plugin may require that you adapt your server's Content Security Policy \nconfiguration to work properly.", | ||
| 381 | "title": "Additional configuration" | ||
| 382 | }, | ||
| 383 | { | ||
| 384 | "location": "/Plugins/", | ||
| 385 | "text": "Plugin installation\n\n\nThere is a bunch of plugins shipped with Shaarli, where there is nothing to do to install them.\n\n\nIf you want to install a third party plugin:\n\n\n\n\nDownload it.\n\n\nPut it in the \nplugins\n directory in Shaarli's installation folder.\n\n\nMake sure you put it correctly:\n\n\n\n\n| index.php\n| plugins/\n|---| custom_plugin/\n| |---| custom_plugin.php\n| |---| ...\n\n\n\n\n\n\n\nMake sure your webserver can read and write the files in your plugin folder.\n\n\n\n\nPlugin configuration\n\n\nIn Shaarli's administration page (\nTools\n link), go to \nPlugin administration\n.\n\n\nHere you can enable and disable all plugins available, and configure them.\n\n\n\n\nPlugin order\n\n\nIn the plugin administration page, you can move enabled plugins to the top or bottom of the list. The first plugins in the list will be processed first.\n\n\nThis is important in case plugins are depending on each other. Read plugins README details for more information.\n\n\nUse case\n: The (non existent) plugin \nshaares_footer\n adds a footer to every shaare in Markdown syntax. It needs to be processed \nbefore\n (higher in the list) the Markdown plugin. Otherwise its syntax won't be translated in HTML.\n\n\nFile mode\n\n\nEnabled plugin are stored in your \nconfig.php\n parameters file, under the \narray\n:\n\n\n$GLOBALS['config']['ENABLED_PLUGINS']\n\n\n\n\nYou can edit them manually here.\nExample:\n\n\n$GLOBALS['config']['ENABLED_PLUGINS'] = array(\n 'qrcode', \n 'archiveorg',\n 'wallabag',\n 'markdown',\n);\n\n\n\n\nPlugin usage\n\n\nOfficial plugins\n\n\nUsage of each plugin is documented in it's README file:\n\n\n\n\naddlink-toolbar\n: Adds the addlink input on the linklist page\n\n\narchiveorg\n: For each link, add an Archive.org icon\n\n\nmarkdown\n: Render shaare description with Markdown syntax.\n\n\nplayvideos\n: Add a button in the toolbar allowing to watch all videos.\n\n\nqrcode\n: For each link, add a QRCode icon.\n\n\nwallabag\n: For each link, add a Wallabag icon to save it in your instance.\n\n\n\n\nThird party plugins\n\n\nSee \nCommunity & related software", | ||
| 386 | "title": "Plugins" | ||
| 387 | }, | ||
| 388 | { | ||
| 389 | "location": "/Plugins/#plugin-installation", | ||
| 390 | "text": "There is a bunch of plugins shipped with Shaarli, where there is nothing to do to install them. If you want to install a third party plugin: Download it. Put it in the plugins directory in Shaarli's installation folder. Make sure you put it correctly: | index.php\n| plugins/\n|---| custom_plugin/\n| |---| custom_plugin.php\n| |---| ... Make sure your webserver can read and write the files in your plugin folder.", | ||
| 391 | "title": "Plugin installation" | ||
| 392 | }, | ||
| 393 | { | ||
| 394 | "location": "/Plugins/#plugin-configuration", | ||
| 395 | "text": "In Shaarli's administration page ( Tools link), go to Plugin administration . Here you can enable and disable all plugins available, and configure them.", | ||
| 396 | "title": "Plugin configuration" | ||
| 397 | }, | ||
| 398 | { | ||
| 399 | "location": "/Plugins/#plugin-order", | ||
| 400 | "text": "In the plugin administration page, you can move enabled plugins to the top or bottom of the list. The first plugins in the list will be processed first. This is important in case plugins are depending on each other. Read plugins README details for more information. Use case : The (non existent) plugin shaares_footer adds a footer to every shaare in Markdown syntax. It needs to be processed before (higher in the list) the Markdown plugin. Otherwise its syntax won't be translated in HTML.", | ||
| 401 | "title": "Plugin order" | ||
| 402 | }, | ||
| 403 | { | ||
| 404 | "location": "/Plugins/#file-mode", | ||
| 405 | "text": "Enabled plugin are stored in your config.php parameters file, under the array : $GLOBALS['config']['ENABLED_PLUGINS'] You can edit them manually here.\nExample: $GLOBALS['config']['ENABLED_PLUGINS'] = array(\n 'qrcode', \n 'archiveorg',\n 'wallabag',\n 'markdown',\n);", | ||
| 406 | "title": "File mode" | ||
| 407 | }, | ||
| 408 | { | ||
| 409 | "location": "/Plugins/#plugin-usage", | ||
| 410 | "text": "", | ||
| 411 | "title": "Plugin usage" | ||
| 412 | }, | ||
| 413 | { | ||
| 414 | "location": "/Plugins/#official-plugins", | ||
| 415 | "text": "Usage of each plugin is documented in it's README file: addlink-toolbar : Adds the addlink input on the linklist page archiveorg : For each link, add an Archive.org icon markdown : Render shaare description with Markdown syntax. playvideos : Add a button in the toolbar allowing to watch all videos. qrcode : For each link, add a QRCode icon. wallabag : For each link, add a Wallabag icon to save it in your instance.", | ||
| 416 | "title": "Official plugins" | ||
| 417 | }, | ||
| 418 | { | ||
| 419 | "location": "/Plugins/#third-party-plugins", | ||
| 420 | "text": "See Community & related software", | ||
| 421 | "title": "Third party plugins" | ||
| 422 | }, | ||
| 423 | { | ||
| 424 | "location": "/Docker-101/", | ||
| 425 | "text": "Basics\n\n\nInstall \nDocker\n, by following the instructions relevant\nto your OS / distribution, and start the service.\n\n\nSearch an image on \nDockerHub\n\n\n$ docker search debian\n\nNAME DESCRIPTION STARS OFFICIAL AUTOMATED\nubuntu Ubuntu is a Debian-based Linux operating s... 2065 [OK]\ndebian Debian is a Linux distribution that's comp... 603 [OK]\ngoogle/debian 47 [OK]\n\n\n\n\nShow available tags for a repository\n\n\n$ curl https://index.docker.io/v1/repositories/debian/tags | python -m json.tool\n\n% Total % Received % Xferd Average Speed Time Time Time Current\nDload Upload Total Spent Left Speed\n100 1283 0 1283 0 0 433 0 --:--:-- 0:00:02 --:--:-- 433\n\n\n\n\nSample output:\n\n\n[\n {\n \"layer\": \"85a02782\",\n \"name\": \"stretch\"\n },\n {\n \"layer\": \"59abecbc\",\n \"name\": \"testing\"\n },\n {\n \"layer\": \"bf0fd686\",\n \"name\": \"unstable\"\n },\n {\n \"layer\": \"60c52dbe\",\n \"name\": \"wheezy\"\n },\n {\n \"layer\": \"c5b806fe\",\n \"name\": \"wheezy-backports\"\n }\n]\n\n\n\n\n\nPull an image from DockerHub\n\n\n$ docker pull repository[:tag]\n\n$ docker pull debian:wheezy\nwheezy: Pulling from debian\n4c8cbfd2973e: Pull complete\n60c52dbe9d91: Pull complete\nDigest: sha256:c584131da2ac1948aa3e66468a4424b6aea2f33acba7cec0b631bdb56254c4fe\nStatus: Downloaded newer image for debian:wheezy", | ||
| 426 | "title": "Docker 101" | ||
| 427 | }, | ||
| 428 | { | ||
| 429 | "location": "/Docker-101/#basics", | ||
| 430 | "text": "Install Docker , by following the instructions relevant\nto your OS / distribution, and start the service.", | ||
| 431 | "title": "Basics" | ||
| 432 | }, | ||
| 433 | { | ||
| 434 | "location": "/Docker-101/#search-an-image-on-dockerhub", | ||
| 435 | "text": "$ docker search debian\n\nNAME DESCRIPTION STARS OFFICIAL AUTOMATED\nubuntu Ubuntu is a Debian-based Linux operating s... 2065 [OK]\ndebian Debian is a Linux distribution that's comp... 603 [OK]\ngoogle/debian 47 [OK]", | ||
| 436 | "title": "Search an image on DockerHub" | ||
| 437 | }, | ||
| 438 | { | ||
| 439 | "location": "/Docker-101/#show-available-tags-for-a-repository", | ||
| 440 | "text": "$ curl https://index.docker.io/v1/repositories/debian/tags | python -m json.tool\n\n% Total % Received % Xferd Average Speed Time Time Time Current\nDload Upload Total Spent Left Speed\n100 1283 0 1283 0 0 433 0 --:--:-- 0:00:02 --:--:-- 433 Sample output: [\n {\n \"layer\": \"85a02782\",\n \"name\": \"stretch\"\n },\n {\n \"layer\": \"59abecbc\",\n \"name\": \"testing\"\n },\n {\n \"layer\": \"bf0fd686\",\n \"name\": \"unstable\"\n },\n {\n \"layer\": \"60c52dbe\",\n \"name\": \"wheezy\"\n },\n {\n \"layer\": \"c5b806fe\",\n \"name\": \"wheezy-backports\"\n }\n]", | ||
| 441 | "title": "Show available tags for a repository" | ||
| 442 | }, | ||
| 443 | { | ||
| 444 | "location": "/Docker-101/#pull-an-image-from-dockerhub", | ||
| 445 | "text": "$ docker pull repository[:tag]\n\n$ docker pull debian:wheezy\nwheezy: Pulling from debian\n4c8cbfd2973e: Pull complete\n60c52dbe9d91: Pull complete\nDigest: sha256:c584131da2ac1948aa3e66468a4424b6aea2f33acba7cec0b631bdb56254c4fe\nStatus: Downloaded newer image for debian:wheezy", | ||
| 446 | "title": "Pull an image from DockerHub" | ||
| 447 | }, | ||
| 448 | { | ||
| 449 | "location": "/Shaarli-images/", | ||
| 450 | "text": "Get and run a Shaarli image\n\n\nDockerHub repository\n\n\nThe images can be found in the \nshaarli/shaarli\n\nrepository.\n\n\nAvailable image tags\n\n\n\n\nlatest\n: master branch (tarball release)\n\n\nstable\n: stable branch (tarball release)\n\n\ndev\n: master branch (Git clone)\n\n\n\n\nAll images rely on:\n- \nDebian 8 Jessie\n\n- \nPHP5-FPM\n\n- \nNginx\n\n\nDownload from DockerHub\n\n\n$ docker pull shaarli/shaarli\nlatest: Pulling from shaarli/shaarli\n32716d9fcddb: Pull complete\n84899d045435: Pull complete\n4b6ad7444763: Pull complete\ne0345ef7a3e0: Pull complete\n5c1dd344094f: Pull complete\n6422305a200b: Pull complete\n7d63f861dbef: Pull complete\n3eb97210645c: Pull complete\n869319d746ff: Already exists\n869319d746ff: Pulling fs layer\n902b87aaaec9: Already exists\nDigest: sha256:f836b4627b958b3f83f59c332f22f02fcd495ace3056f2be2c4912bd8704cc98\nStatus: Downloaded newer image for shaarli/shaarli:latest\n\n\n\n\nCreate and start a new container from the image\n\n\n# map the host's :8000 port to the container's :80 port\n$ docker create -p 8000:80 shaarli/shaarli\nd40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101\n\n# launch the container in the background\n$ docker start d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101\nd40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101\n\n# list active containers\n$ docker ps\nCONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES\nd40b7af693d6 shaarli/shaarli /usr/bin/supervisor 15 seconds ago Up 4 seconds 0.0.0.0:8000->80/tcp backstabbing_galileo\n\n\n\n\nStop and destroy a container\n\n\n$ docker stop backstabbing_galileo # those docker guys are really rude to physicists!\nbackstabbing_galileo\n\n# check the container is stopped\n$ docker ps\nCONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES\n\n# list ALL containers\n$ docker ps -a\nCONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES\nd40b7af693d6 shaarli/shaarli /usr/bin/supervisor 5 minutes ago Exited (0) 48 seconds ago backstabbing_galileo\n\n# destroy the container\n$ docker rm backstabbing_galileo # let's put an end to these barbarian practices\nbackstabbing_galileo\n\n$ docker ps -a\nCONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES", | ||
| 451 | "title": "Shaarli images" | ||
| 452 | }, | ||
| 453 | { | ||
| 454 | "location": "/Shaarli-images/#get-and-run-a-shaarli-image", | ||
| 455 | "text": "", | ||
| 456 | "title": "Get and run a Shaarli image" | ||
| 457 | }, | ||
| 458 | { | ||
| 459 | "location": "/Shaarli-images/#dockerhub-repository", | ||
| 460 | "text": "The images can be found in the shaarli/shaarli \nrepository.", | ||
| 461 | "title": "DockerHub repository" | ||
| 462 | }, | ||
| 463 | { | ||
| 464 | "location": "/Shaarli-images/#available-image-tags", | ||
| 465 | "text": "latest : master branch (tarball release) stable : stable branch (tarball release) dev : master branch (Git clone) All images rely on:\n- Debian 8 Jessie \n- PHP5-FPM \n- Nginx", | ||
| 466 | "title": "Available image tags" | ||
| 467 | }, | ||
| 468 | { | ||
| 469 | "location": "/Shaarli-images/#download-from-dockerhub", | ||
| 470 | "text": "$ docker pull shaarli/shaarli\nlatest: Pulling from shaarli/shaarli\n32716d9fcddb: Pull complete\n84899d045435: Pull complete\n4b6ad7444763: Pull complete\ne0345ef7a3e0: Pull complete\n5c1dd344094f: Pull complete\n6422305a200b: Pull complete\n7d63f861dbef: Pull complete\n3eb97210645c: Pull complete\n869319d746ff: Already exists\n869319d746ff: Pulling fs layer\n902b87aaaec9: Already exists\nDigest: sha256:f836b4627b958b3f83f59c332f22f02fcd495ace3056f2be2c4912bd8704cc98\nStatus: Downloaded newer image for shaarli/shaarli:latest", | ||
| 471 | "title": "Download from DockerHub" | ||
| 472 | }, | ||
| 473 | { | ||
| 474 | "location": "/Shaarli-images/#create-and-start-a-new-container-from-the-image", | ||
| 475 | "text": "# map the host's :8000 port to the container's :80 port\n$ docker create -p 8000:80 shaarli/shaarli\nd40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101\n\n# launch the container in the background\n$ docker start d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101\nd40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101\n\n# list active containers\n$ docker ps\nCONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES\nd40b7af693d6 shaarli/shaarli /usr/bin/supervisor 15 seconds ago Up 4 seconds 0.0.0.0:8000->80/tcp backstabbing_galileo", | ||
| 476 | "title": "Create and start a new container from the image" | ||
| 477 | }, | ||
| 478 | { | ||
| 479 | "location": "/Shaarli-images/#stop-and-destroy-a-container", | ||
| 480 | "text": "$ docker stop backstabbing_galileo # those docker guys are really rude to physicists!\nbackstabbing_galileo\n\n# check the container is stopped\n$ docker ps\nCONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES\n\n# list ALL containers\n$ docker ps -a\nCONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES\nd40b7af693d6 shaarli/shaarli /usr/bin/supervisor 5 minutes ago Exited (0) 48 seconds ago backstabbing_galileo\n\n# destroy the container\n$ docker rm backstabbing_galileo # let's put an end to these barbarian practices\nbackstabbing_galileo\n\n$ docker ps -a\nCONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES", | ||
| 481 | "title": "Stop and destroy a container" | ||
| 482 | }, | ||
| 483 | { | ||
| 484 | "location": "/Reverse-proxy-configuration/", | ||
| 485 | "text": "TODO, see https://github.com/shaarli/Shaarli/issues/888\n\n\nHAProxy\n\n\nNginx", | ||
| 486 | "title": "Reverse proxy configuration" | ||
| 487 | }, | ||
| 488 | { | ||
| 489 | "location": "/Reverse-proxy-configuration/#haproxy", | ||
| 490 | "text": "", | ||
| 491 | "title": "HAProxy" | ||
| 492 | }, | ||
| 493 | { | ||
| 494 | "location": "/Reverse-proxy-configuration/#nginx", | ||
| 495 | "text": "", | ||
| 496 | "title": "Nginx" | ||
| 497 | }, | ||
| 498 | { | ||
| 499 | "location": "/Docker-resources/", | ||
| 500 | "text": "Docker\n\n\n\n\nInteractive Docker training portal\n on \nKatakoda\n\n\nWhere are Docker images stored?\n\n\nDockerfile reference\n\n\nDockerfile best practices\n\n\nVolumes\n\n\n\n\nDockerHub\n\n\n\n\nRepositories\n\n\nTeams and organizations\n\n\nGitHub automated build\n\n\n\n\nService management\n\n\n\n\nUsing supervisord\n\n\nNginx in the foreground\n\n\nsupervisord", | ||
| 501 | "title": "Docker resources" | ||
| 502 | }, | ||
| 503 | { | ||
| 504 | "location": "/Docker-resources/#docker", | ||
| 505 | "text": "Interactive Docker training portal on Katakoda Where are Docker images stored? Dockerfile reference Dockerfile best practices Volumes", | ||
| 506 | "title": "Docker" | ||
| 507 | }, | ||
| 508 | { | ||
| 509 | "location": "/Docker-resources/#dockerhub", | ||
| 510 | "text": "Repositories Teams and organizations GitHub automated build", | ||
| 511 | "title": "DockerHub" | ||
| 512 | }, | ||
| 513 | { | ||
| 514 | "location": "/Docker-resources/#service-management", | ||
| 515 | "text": "Using supervisord Nginx in the foreground supervisord", | ||
| 516 | "title": "Service management" | ||
| 517 | }, | ||
| 518 | { | ||
| 519 | "location": "/Features/", | ||
| 520 | "text": "Main features\n\n\nShaarli is intended:\n * to share, comment and save interesting links and news\n * to bookmark useful/frequent personal links (as private links) and share them between computers\n * as a minimal blog/microblog/writing platform (no character limit)\n * as a read-it-later list (for example items tagged \nreadlater\n)\n * to draft and save articles/ideas\n * to keep code snippets\n * to keep notes and documentation\n * as a shared clipboard between machines\n * as a todo list\n * to store playlists (e.g. with the \nmusic\n or \nvideo\n tags)\n * to keep extracts/comments from webpages that may disappear\n * to keep track of ongoing discussions (for example items tagged \ndiscussion\n)\n * \nto feed RSS aggregators\n (planets) with specific tags\n * to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...)\n\n\nUsing Shaarli as a blog, notepad, pastebin...\n\n\n\n\nGo to your Shaarli setup and log in\n\n\nClick the \nAdd Link\n button\n\n\nTo share text only, do not enter any URL in the corresponding input field and click \nAdd Link\n\n\nPick a title and enter your article, or note, in the description field; add a few tags; optionally check \nPrivate\n then click \nSave\n\n\nVoil\u00e0! Your article is now published (privately if you selected that option) and accessible using its permalink.", | ||
| 521 | "title": "Features" | ||
| 522 | }, | ||
| 523 | { | ||
| 524 | "location": "/Features/#main-features", | ||
| 525 | "text": "Shaarli is intended:\n * to share, comment and save interesting links and news\n * to bookmark useful/frequent personal links (as private links) and share them between computers\n * as a minimal blog/microblog/writing platform (no character limit)\n * as a read-it-later list (for example items tagged readlater )\n * to draft and save articles/ideas\n * to keep code snippets\n * to keep notes and documentation\n * as a shared clipboard between machines\n * as a todo list\n * to store playlists (e.g. with the music or video tags)\n * to keep extracts/comments from webpages that may disappear\n * to keep track of ongoing discussions (for example items tagged discussion )\n * to feed RSS aggregators (planets) with specific tags\n * to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...)", | ||
| 526 | "title": "Main features" | ||
| 527 | }, | ||
| 528 | { | ||
| 529 | "location": "/Features/#using-shaarli-as-a-blog-notepad-pastebin", | ||
| 530 | "text": "Go to your Shaarli setup and log in Click the Add Link button To share text only, do not enter any URL in the corresponding input field and click Add Link Pick a title and enter your article, or note, in the description field; add a few tags; optionally check Private then click Save Voil\u00e0! Your article is now published (privately if you selected that option) and accessible using its permalink.", | ||
| 531 | "title": "Using Shaarli as a blog, notepad, pastebin..." | ||
| 532 | }, | ||
| 533 | { | ||
| 534 | "location": "/Bookmarklet/", | ||
| 535 | "text": "Add the sharing button (\nbookmarklet\n) to your browser\n\n\n\n\nOpen your Shaarli and \nLogin\n\n\nClick the \nTools\n button in the top bar\n\n\nDrag the \n\u271aShaare link\n button\n, and drop it to your browser's bookmarks bar.\n\n\n\n\nThis bookmarklet button is compatible with Firefox, Opera, Chrome and Safari. Under Opera, you can't drag'n drop the button: You have to right-click on it and add a bookmark to your personal toolbar.\n\n\n\n\nShare links using the \nbookmarklet\n\n\n\n\nWhen you are visiting a webpage you would like to share with Shaarli, click the \nbookmarklet\n you just added.\n\n\nA window opens.\n\n\nYou can freely edit title, description, tags... to find it later using the text search or tag filtering.\n\n\nYou will be able to edit this link later using the \n edit button.\n\n\nYou can also check the \u201cPrivate\u201d box so that the link is saved but only visible to you. \n\n\nClick \nSave\n.\nVoil\u00e0! Your link is now shared.\n\n\n\n\nTroubleshooting: The bookmarklet doesn't work with a few website (e.g. Github.com)\n\n\nWebsites which enforce Content Security Policy (CSP), such as github.com, disallow usage of bookmarklets. Unfortunatly, there is nothing Shaarli can do about it.\n\n\nSee \n#196\n.\n\n\nThere is an open bug for both Firefox and Chromium:\n\n\n\n\nhttps://bugzilla.mozilla.org/show_bug.cgi?id=866522\n\n\nhttps://code.google.com/p/chromium/issues/detail?id=233903", | ||
| 536 | "title": "Bookmarklet" | ||
| 537 | }, | ||
| 538 | { | ||
| 539 | "location": "/Bookmarklet/#add-the-sharing-button-bookmarklet-to-your-browser", | ||
| 540 | "text": "Open your Shaarli and Login Click the Tools button in the top bar Drag the \u271aShaare link button , and drop it to your browser's bookmarks bar. This bookmarklet button is compatible with Firefox, Opera, Chrome and Safari. Under Opera, you can't drag'n drop the button: You have to right-click on it and add a bookmark to your personal toolbar.", | ||
| 541 | "title": "Add the sharing button (bookmarklet) to your browser" | ||
| 542 | }, | ||
| 543 | { | ||
| 544 | "location": "/Bookmarklet/#share-links-using-the-bookmarklet", | ||
| 545 | "text": "When you are visiting a webpage you would like to share with Shaarli, click the bookmarklet you just added. A window opens. You can freely edit title, description, tags... to find it later using the text search or tag filtering. You will be able to edit this link later using the edit button. You can also check the \u201cPrivate\u201d box so that the link is saved but only visible to you. Click Save . Voil\u00e0! Your link is now shared.", | ||
| 546 | "title": "Share links using the bookmarklet" | ||
| 547 | }, | ||
| 548 | { | ||
| 549 | "location": "/Bookmarklet/#troubleshooting-the-bookmarklet-doesnt-work-with-a-few-website-eg-githubcom", | ||
| 550 | "text": "Websites which enforce Content Security Policy (CSP), such as github.com, disallow usage of bookmarklets. Unfortunatly, there is nothing Shaarli can do about it. See #196 . There is an open bug for both Firefox and Chromium: https://bugzilla.mozilla.org/show_bug.cgi?id=866522 https://code.google.com/p/chromium/issues/detail?id=233903", | ||
| 551 | "title": "Troubleshooting: The bookmarklet doesn't work with a few website (e.g. Github.com)" | ||
| 552 | }, | ||
| 553 | { | ||
| 554 | "location": "/Browsing-and-searching/", | ||
| 555 | "text": "Plain text search\n\n\nUse the \nSearch text\n field to search in \nany\n of the fields of all links (Title, URL, Description...)\n\n\nExclude text/tags:\n Use the \n-\n operator before a word or tag (example \n-uninteresting\n) to prevent entries containing (or tagged) \nuninteresting\n from showing up in the search results.\n\n\nExact text search:\n Use double-quotes (example \n\"exact search\"\n) to search for the exact expression.\n\n\nBoth exclude patterns and exact searches can be combined with normal searches (example \n\"exact search\" term otherterm -notthis \"very exact\" stuff -notagain\n)\n\n\nTags search\n\n\nUse the \nFilter by tags\n field to restrict displayed links to entries tagged with one or multiple tags (use space to separate tags). \n\n\nHidden tags:\n Tags starting with a dot \n.\n (example \n.secret\n) are private. They can only be seen and searched when logged in.\n\n\nAlternatively you can use the \nTag cloud\n to discover all tags and click on any of them to display related links.\n\n\nTo search for links that are not tagged, enter \n\"\"\n in the tag search field.\n\n\nFiltering RSS feeds/Picture wall\n\n\nRSS feeds can also be restricted to only return items matching a text/tag search: see \nRSS feeds\n.", | ||
| 556 | "title": "Browsing and searching" | ||
| 557 | }, | ||
| 558 | { | ||
| 559 | "location": "/Browsing-and-searching/#plain-text-search", | ||
| 560 | "text": "Use the Search text field to search in any of the fields of all links (Title, URL, Description...) Exclude text/tags: Use the - operator before a word or tag (example -uninteresting ) to prevent entries containing (or tagged) uninteresting from showing up in the search results. Exact text search: Use double-quotes (example \"exact search\" ) to search for the exact expression. Both exclude patterns and exact searches can be combined with normal searches (example \"exact search\" term otherterm -notthis \"very exact\" stuff -notagain )", | ||
| 561 | "title": "Plain text search" | ||
| 562 | }, | ||
| 563 | { | ||
| 564 | "location": "/Browsing-and-searching/#tags-search", | ||
| 565 | "text": "Use the Filter by tags field to restrict displayed links to entries tagged with one or multiple tags (use space to separate tags). Hidden tags: Tags starting with a dot . (example .secret ) are private. They can only be seen and searched when logged in. Alternatively you can use the Tag cloud to discover all tags and click on any of them to display related links. To search for links that are not tagged, enter \"\" in the tag search field.", | ||
| 566 | "title": "Tags search" | ||
| 567 | }, | ||
| 568 | { | ||
| 569 | "location": "/Browsing-and-searching/#filtering-rss-feedspicture-wall", | ||
| 570 | "text": "RSS feeds can also be restricted to only return items matching a text/tag search: see RSS feeds .", | ||
| 571 | "title": "Filtering RSS feeds/Picture wall" | ||
| 572 | }, | ||
| 573 | { | ||
| 574 | "location": "/Firefox-share/", | ||
| 575 | "text": "Add Shaarli as a sharing service to Firefox\n\n\n\n\nOpen your Shaarli and \nLogin\n\n\nClick the \nTools\n button in the top bar\n\n\nClick the \n\u271aAdd to Firefox social\n button and accept the activation.\n\n\n\n\nSharing links using Firefox share\n\n\n\n\nAdd the sharing service as described above\n\n\nWhen you are visiting a webpage you would like to share with Shaarli, click the Firefox \nShare\n button \nimages/firefoxshare.png\n\n\nYou can edit your link before and after saving, just like the bookmarklet above.\n\n\n\n\n\n\n\n\n\n\n\uf06a\n\n\nYour Shaarli instance must be hosted on an HTTPS (SSL/TLS secure connection) enabled server for Firefox Share to work. Firefox Share will not work over plain HTTP connections.", | ||
| 576 | "title": "Firefox share" | ||
| 577 | }, | ||
| 578 | { | ||
| 579 | "location": "/Firefox-share/#add-shaarli-as-a-sharing-service-to-firefox", | ||
| 580 | "text": "Open your Shaarli and Login Click the Tools button in the top bar Click the \u271aAdd to Firefox social button and accept the activation.", | ||
| 581 | "title": "Add Shaarli as a sharing service to Firefox" | ||
| 582 | }, | ||
| 583 | { | ||
| 584 | "location": "/Firefox-share/#sharing-links-using-firefox-share", | ||
| 585 | "text": "Add the sharing service as described above When you are visiting a webpage you would like to share with Shaarli, click the Firefox Share button images/firefoxshare.png You can edit your link before and after saving, just like the bookmarklet above. \uf06a Your Shaarli instance must be hosted on an HTTPS (SSL/TLS secure connection) enabled server for Firefox Share to work. Firefox Share will not work over plain HTTP connections.", | ||
| 586 | "title": "Sharing links using Firefox share" | ||
| 587 | }, | ||
| 588 | { | ||
| 589 | "location": "/RSS-feeds/", | ||
| 590 | "text": "Feeds options\n\n\nFeeds are available in ATOM with \n?do=atom\n and RSS with \ndo=RSS\n.\n\n\nOptions:\n- You can use \npermalinks\n in the feed URL to get permalink to Shaares instead of direct link to shaared URL.\n - E.G. \nhttps://my.shaarli.domain/?do=atom&permalinks\n.\n- You can use \nnb\n parameter in the feed URL to specify the number of Shaares you want in a feed (default if not specified: \n50\n). The keyword \nall\n is available if you want everything.\n - \nhttps://my.shaarli.domain/?do=atom&permalinks&nb=42\n\n - \nhttps://my.shaarli.domain/?do=atom&permalinks&nb=all\n\n\nRSS Feeds or Picture Wall for a specific search/tag\n\n\nIt is possible to filter RSS/ATOM feeds and Picture Wall on a Shaarli to \nonly display results of a specific search, or for a specific tag\n.\n\n\nFor example, if you want to subscribe only to links tagged \nphotography\n:\n- Go to the desired Shaarli instance.\n- Search for the \nphotography\n tag in the \nFilter by tag\n box. Links tagged \nphotography\n are displayed.\n- Click on the \nRSS Feed\n button.\n- You are presented with an RSS feed showing only these links. Subscribe to it to receive only updates with this tag.\n- The same method \nalso works for a full-text search\n (\nSearch\n box) \nand for the Picture Wall\n (want to only see pictures about \nnature\n?)\n- You can also build the URLs manually: \n - \nhttps://my.shaarli.domain/?do=rss&searchtags=nature\n\n - \nhttps://my.shaarli.domain/links/?do=picwall&searchterm=poney", | ||
| 591 | "title": "RSS feeds" | ||
| 592 | }, | ||
| 593 | { | ||
| 594 | "location": "/RSS-feeds/#feeds-options", | ||
| 595 | "text": "Feeds are available in ATOM with ?do=atom and RSS with do=RSS . Options:\n- You can use permalinks in the feed URL to get permalink to Shaares instead of direct link to shaared URL.\n - E.G. https://my.shaarli.domain/?do=atom&permalinks .\n- You can use nb parameter in the feed URL to specify the number of Shaares you want in a feed (default if not specified: 50 ). The keyword all is available if you want everything.\n - https://my.shaarli.domain/?do=atom&permalinks&nb=42 \n - https://my.shaarli.domain/?do=atom&permalinks&nb=all", | ||
| 596 | "title": "Feeds options" | ||
| 597 | }, | ||
| 598 | { | ||
| 599 | "location": "/RSS-feeds/#rss-feeds-or-picture-wall-for-a-specific-searchtag", | ||
| 600 | "text": "It is possible to filter RSS/ATOM feeds and Picture Wall on a Shaarli to only display results of a specific search, or for a specific tag . For example, if you want to subscribe only to links tagged photography :\n- Go to the desired Shaarli instance.\n- Search for the photography tag in the Filter by tag box. Links tagged photography are displayed.\n- Click on the RSS Feed button.\n- You are presented with an RSS feed showing only these links. Subscribe to it to receive only updates with this tag.\n- The same method also works for a full-text search ( Search box) and for the Picture Wall (want to only see pictures about nature ?)\n- You can also build the URLs manually: \n - https://my.shaarli.domain/?do=rss&searchtags=nature \n - https://my.shaarli.domain/links/?do=picwall&searchterm=poney", | ||
| 601 | "title": "RSS Feeds or Picture Wall for a specific search/tag" | ||
| 602 | }, | ||
| 603 | { | ||
| 604 | "location": "/REST-API/", | ||
| 605 | "text": "Usage\n\n\nSee the \nREST API documentation\n.\n\n\nAuthentication\n\n\nAll requests to Shaarli's API must include a JWT token to verify their authenticity.\n\n\nThis token has to be included as an HTTP header called \nAuthentication: Bearer <jwt token>\n.\n\n\nJWT resources :\n\n\n\n\njwt.io\n (including a list of client per language).\n\n\nRFC : https://tools.ietf.org/html/rfc7519\n\n\nhttps://float-middle.com/json-web-tokens-jwt-vs-sessions/\n\n\nHackerNews thread: https://news.ycombinator.com/item?id=11929267\n\n\n\n\nShaarli JWT Token\n\n\nJWT tokens are composed by three parts, separated by a dot \n.\n and encoded in base64:\n\n\n[header].[payload].[signature]\n\n\n\n\nHeader\n\n\nShaarli only allow one hash algorithm, so the header will always be the same:\n\n\n{\n \"typ\": \"JWT\",\n \"alg\": \"HS512\"\n}\n\n\n\n\nEncoded in base64, it gives:\n\n\newogICAgICAgICJ0eXAiOiAiSldUIiwKICAgICAgICAiYWxnIjogIkhTNTEyIgogICAgfQ==\n\n\n\n\nPayload\n\n\nValidity duration\n\n\nTo avoid infinite token validity, JWT tokens must include their creation date in UNIX timestamp format (timezone independant - UTC) under the key \niat\n (issued at). This token will be accepted during 9 minutes.\n\n\n{\n \"iat\": 1468663519\n}\n\n\n\n\nSee \nRFC reference\n.\n\n\nSignature\n\n\nThe signature authenticate the token validity. It contains the base64 of the header and the body, separated by a dot \n.\n, hashed in SHA512 with the API secret available in Shaarli administration page.\n\n\nSignature example with PHP:\n\n\n$content = base64_encode($header) . '.' . base64_encode($payload);\n$signature = hash_hmac('sha512', $content, $secret);\n\n\n\n\nComplete example\n\n\nPHP\n\n\nfunction generateToken($secret) {\n $header = base64_encode('{\n \"typ\": \"JWT\",\n \"alg\": \"HS512\"\n }');\n $payload = base64_encode('{\n \"iat\": '. time() .'\n }');\n $signature = hash_hmac('sha512', $header .'.'. $payload , $secret);\n return $header .'.'. $payload .'.'. $signature;\n}\n\n$secret = 'mysecret';\n$token = generateToken($secret);\necho $token;\n\n\n\n\n\n\newogICAgICAgICJ0eXAiOiAiSldUIiwKICAgICAgICAiYWxnIjogIkhTNTEyIgogICAgfQ==.ewogICAgICAgICJpYXQiOiAxNDY4NjY3MDQ3CiAgICB9.1d2c54fa947daf594fdbf7591796195652c8bc63bffad7f6a6db2a41c313f495a542cbfb595acade79e83f3810d709b4251d7b940bbc10b531a6e6134af63a68\n\n\n\n\n$options = [\n 'http' => [\n 'method' => 'GET',\n 'jwt' => $token,\n ],\n];\n$context = stream_context_create($options);\nfile_get_contents($apiEndpoint, false, $context);", | ||
| 606 | "title": "REST API" | ||
| 607 | }, | ||
| 608 | { | ||
| 609 | "location": "/REST-API/#usage", | ||
| 610 | "text": "See the REST API documentation .", | ||
| 611 | "title": "Usage" | ||
| 612 | }, | ||
| 613 | { | ||
| 614 | "location": "/REST-API/#authentication", | ||
| 615 | "text": "All requests to Shaarli's API must include a JWT token to verify their authenticity. This token has to be included as an HTTP header called Authentication: Bearer <jwt token> . JWT resources : jwt.io (including a list of client per language). RFC : https://tools.ietf.org/html/rfc7519 https://float-middle.com/json-web-tokens-jwt-vs-sessions/ HackerNews thread: https://news.ycombinator.com/item?id=11929267", | ||
| 616 | "title": "Authentication" | ||
| 617 | }, | ||
| 618 | { | ||
| 619 | "location": "/REST-API/#shaarli-jwt-token", | ||
| 620 | "text": "JWT tokens are composed by three parts, separated by a dot . and encoded in base64: [header].[payload].[signature]", | ||
| 621 | "title": "Shaarli JWT Token" | ||
| 622 | }, | ||
| 623 | { | ||
| 624 | "location": "/REST-API/#header", | ||
| 625 | "text": "Shaarli only allow one hash algorithm, so the header will always be the same: {\n \"typ\": \"JWT\",\n \"alg\": \"HS512\"\n} Encoded in base64, it gives: ewogICAgICAgICJ0eXAiOiAiSldUIiwKICAgICAgICAiYWxnIjogIkhTNTEyIgogICAgfQ==", | ||
| 626 | "title": "Header" | ||
| 627 | }, | ||
| 628 | { | ||
| 629 | "location": "/REST-API/#payload", | ||
| 630 | "text": "Validity duration To avoid infinite token validity, JWT tokens must include their creation date in UNIX timestamp format (timezone independant - UTC) under the key iat (issued at). This token will be accepted during 9 minutes. {\n \"iat\": 1468663519\n} See RFC reference .", | ||
| 631 | "title": "Payload" | ||
| 632 | }, | ||
| 633 | { | ||
| 634 | "location": "/REST-API/#signature", | ||
| 635 | "text": "The signature authenticate the token validity. It contains the base64 of the header and the body, separated by a dot . , hashed in SHA512 with the API secret available in Shaarli administration page. Signature example with PHP: $content = base64_encode($header) . '.' . base64_encode($payload);\n$signature = hash_hmac('sha512', $content, $secret);", | ||
| 636 | "title": "Signature" | ||
| 637 | }, | ||
| 638 | { | ||
| 639 | "location": "/REST-API/#complete-example", | ||
| 640 | "text": "", | ||
| 641 | "title": "Complete example" | ||
| 642 | }, | ||
| 643 | { | ||
| 644 | "location": "/REST-API/#php", | ||
| 645 | "text": "function generateToken($secret) {\n $header = base64_encode('{\n \"typ\": \"JWT\",\n \"alg\": \"HS512\"\n }');\n $payload = base64_encode('{\n \"iat\": '. time() .'\n }');\n $signature = hash_hmac('sha512', $header .'.'. $payload , $secret);\n return $header .'.'. $payload .'.'. $signature;\n}\n\n$secret = 'mysecret';\n$token = generateToken($secret);\necho $token; ewogICAgICAgICJ0eXAiOiAiSldUIiwKICAgICAgICAiYWxnIjogIkhTNTEyIgogICAgfQ==.ewogICAgICAgICJpYXQiOiAxNDY4NjY3MDQ3CiAgICB9.1d2c54fa947daf594fdbf7591796195652c8bc63bffad7f6a6db2a41c313f495a542cbfb595acade79e83f3810d709b4251d7b940bbc10b531a6e6134af63a68 $options = [\n 'http' => [\n 'method' => 'GET',\n 'jwt' => $token,\n ],\n];\n$context = stream_context_create($options);\nfile_get_contents($apiEndpoint, false, $context);", | ||
| 646 | "title": "PHP" | ||
| 647 | }, | ||
| 648 | { | ||
| 649 | "location": "/Backup,-restore,-import-and-export/", | ||
| 650 | "text": "Backup and restore the datastore file\n\n\nExport links as...\n\n\nImport links from...\n\n\nImport Shaarli links to Firefox\n\n\n\n\n\n\nBackup and restore the datastore file\n\n\nBackup the file \ndata/datastore.php\n (by FTP or SSH). Restore by putting the file back in place.\n\n\nExample command:\n\n\nrsync -avzP my.server.com:/var/www/shaarli/data/datastore.php datastore-$(date +%Y-%m-%d_%H%M).php\n\n\n\n\nExport links as...\n\n\nTo export links as an HTML file, under \nTools > Export\n, choose:\n- \nExport all\n to export both public and private links\n- \nExport public\n to export public links only\n- \nExport private\n to export private links only\n\n\nRestore by using the \nImport\n feature.\n* This can be done using the \nshaarchiver\n tool.\n\n\nExample command: \n\n\n./export-bookmarks.py --url=https://my.server.com/shaarli --username=myusername --password=mysupersecretpassword --download-dir=./ --type=all\n\n\n\n\nImport links from...\n\n\nDiigo\n\n\nIf you export your bookmark from Diigo, make sure you use the Delicious export, not the Netscape export. (Their Netscape export is broken, and they don't seem to be interested in fixing it.)\n\n\nMister Wong\n\n\nSee \nthis issue\n for import tweaks.\n\n\nSemanticScuttle\n\n\nTo correctly import the tags from a \nSemanticScuttle\n HTML export, edit the HTML file before importing and replace all occurences of \ntags=\n (lowercase) to \nTAGS=\n (uppercase).\n\n\nScuttle\n\n\nShaarli cannot import data directly from \nScuttle\n. However, you can use this third party tool: https://github.com/q2apro/scuttle-to-shaarli to export the Scuttle database to the Netscape HTML format compatible with the Shaarli importer.\n\n\nImport Shaarli links to Firefox\n\n\n\n\nExport your Shaarli links as described above.\n\n\nFor compatibility reasons, check \nPrepend note permalinks with this Shaarli instance's URL (useful to import bookmarks in a web browser)\n\n\nIn Firefox, open the bookmark manager (not the sidebar! \nBookmarks menu > Show all bookmarks\n or \nCtrl+Shift+B\n)\n\n\nSelect \nImport and Backup > Import bookmarks in HTML format\n\n\n\n\nYour bookmarks will be imported in Firefox, ready to use, with tags and descriptions retained. \"Self\" (notes) shaares will still point to the Shaarli instance you exported them from, but the note text can be viewed directly in the bookmark properties inside your browser. Depending on the number of bookmarks, the import can take some time.\n\n\nYou may be interested in these Firefox addons to manage links imported from Shaarli\n\n\n\n\nBookmark Deduplicator\n - provides an easy way to deduplicate your bookmarks\n\n\nTagSieve\n - browse your bookmarks by their tags", | ||
| 651 | "title": "Backup, restore, import and export" | ||
| 652 | }, | ||
| 653 | { | ||
| 654 | "location": "/Backup,-restore,-import-and-export/#backup-and-restore-the-datastore-file", | ||
| 655 | "text": "Backup the file data/datastore.php (by FTP or SSH). Restore by putting the file back in place. Example command: rsync -avzP my.server.com:/var/www/shaarli/data/datastore.php datastore-$(date +%Y-%m-%d_%H%M).php", | ||
| 656 | "title": "Backup and restore the datastore file" | ||
| 657 | }, | ||
| 658 | { | ||
| 659 | "location": "/Backup,-restore,-import-and-export/#export-links-as", | ||
| 660 | "text": "To export links as an HTML file, under Tools > Export , choose:\n- Export all to export both public and private links\n- Export public to export public links only\n- Export private to export private links only Restore by using the Import feature.\n* This can be done using the shaarchiver tool. Example command: ./export-bookmarks.py --url=https://my.server.com/shaarli --username=myusername --password=mysupersecretpassword --download-dir=./ --type=all", | ||
| 661 | "title": "Export links as..." | ||
| 662 | }, | ||
| 663 | { | ||
| 664 | "location": "/Backup,-restore,-import-and-export/#import-links-from", | ||
| 665 | "text": "", | ||
| 666 | "title": "Import links from..." | ||
| 667 | }, | ||
| 668 | { | ||
| 669 | "location": "/Backup,-restore,-import-and-export/#diigo", | ||
| 670 | "text": "If you export your bookmark from Diigo, make sure you use the Delicious export, not the Netscape export. (Their Netscape export is broken, and they don't seem to be interested in fixing it.)", | ||
| 671 | "title": "Diigo" | ||
| 672 | }, | ||
| 673 | { | ||
| 674 | "location": "/Backup,-restore,-import-and-export/#mister-wong", | ||
| 675 | "text": "See this issue for import tweaks.", | ||
| 676 | "title": "Mister Wong" | ||
| 677 | }, | ||
| 678 | { | ||
| 679 | "location": "/Backup,-restore,-import-and-export/#semanticscuttle", | ||
| 680 | "text": "To correctly import the tags from a SemanticScuttle HTML export, edit the HTML file before importing and replace all occurences of tags= (lowercase) to TAGS= (uppercase).", | ||
| 681 | "title": "SemanticScuttle" | ||
| 682 | }, | ||
| 683 | { | ||
| 684 | "location": "/Backup,-restore,-import-and-export/#scuttle", | ||
| 685 | "text": "Shaarli cannot import data directly from Scuttle . However, you can use this third party tool: https://github.com/q2apro/scuttle-to-shaarli to export the Scuttle database to the Netscape HTML format compatible with the Shaarli importer.", | ||
| 686 | "title": "Scuttle" | ||
| 687 | }, | ||
| 688 | { | ||
| 689 | "location": "/Backup,-restore,-import-and-export/#import-shaarli-links-to-firefox", | ||
| 690 | "text": "Export your Shaarli links as described above. For compatibility reasons, check Prepend note permalinks with this Shaarli instance's URL (useful to import bookmarks in a web browser) In Firefox, open the bookmark manager (not the sidebar! Bookmarks menu > Show all bookmarks or Ctrl+Shift+B ) Select Import and Backup > Import bookmarks in HTML format Your bookmarks will be imported in Firefox, ready to use, with tags and descriptions retained. \"Self\" (notes) shaares will still point to the Shaarli instance you exported them from, but the note text can be viewed directly in the bookmark properties inside your browser. Depending on the number of bookmarks, the import can take some time. You may be interested in these Firefox addons to manage links imported from Shaarli Bookmark Deduplicator - provides an easy way to deduplicate your bookmarks TagSieve - browse your bookmarks by their tags", | ||
| 691 | "title": "Import Shaarli links to Firefox" | ||
| 692 | }, | ||
| 693 | { | ||
| 694 | "location": "/Copy-an-existing-installation-over-SSH-and-serve-it-locally/", | ||
| 695 | "text": "Example bash script:\n\n\n#!/bin/bash\n#Description: Copy a Shaarli installation over SSH/SCP, serve it locally with php-cli\n#Will create a local-shaarli/ directory when you run it, backup your Shaarli there, and serve it locally.\n#Will NOT download linked pages. It's just a directly usable backup/copy/mirror of your Shaarli\n#Requires: ssh, scp and a working SSH access to the server where your Shaarli is installed\n#Usage: ./local-shaarli.sh\n#Author: nodiscc (nodiscc@gmail.com)\n#License: MIT (http://opensource.org/licenses/MIT)\nset -o errexit\nset -o nounset\n\n##### CONFIG #################\n#The port used by php's local server\nphp_local_port=7431\n\n#Name of the SSH server and path where Shaarli is installed\n#TODO: pass these as command-line arguments\nremotehost=\"my.ssh.server\"\nremote_shaarli_dir=\"/var/www/shaarli\"\n\n\n###### FUNCTIONS #############\n_main() {\n _CBSyncShaarli\n _CBServeShaarli\n}\n\n_CBSyncShaarli() {\n remote_temp_dir=$(ssh $remotehost mktemp -d)\n remote_ssh_user=$(ssh $remotehost whoami)\n ssh -t \"$remotehost\" sudo cp -r \"$remote_shaarli_dir\" \"$remote_temp_dir\"\n ssh -t \"$remotehost\" sudo chown -R \"$remote_ssh_user\":\"$remote_ssh_user\" \"$remote_temp_dir\"\n scp -rq \"$remotehost\":\"$remote_temp_dir\" local-shaarli\n ssh \"$remotehost\" rm -r \"$remote_temp_dir\"\n}\n\n_CBServeShaarli() {\n #TODO: allow serving a previously downloaded Shaarli\n #TODO: ask before overwriting local copy, if it exists\n cd local-shaarli/\n php -S localhost:${php_local_port}\n echo \"Please go to http://localhost:${php_local_port}\"\n}\n\n\n##### MAIN #################\n\n_main\n\n\n\n\nThis outputs:\n\n\n$ ./local-shaarli.sh\nPHP 5.6.0RC4 Development Server started at Mon Sep 1 21:56:19 2014\nListening on http://localhost:7431\nDocument root is /home/user/local-shaarli/shaarli\nPress Ctrl-C to quit.\n\n[Mon Sep 1 21:56:27 2014] ::1:57868 [200]: /\n[Mon Sep 1 21:56:27 2014] ::1:57869 [200]: /index.html\n[Mon Sep 1 21:56:37 2014] ::1:57881 [200]: /...", | ||
| 696 | "title": "Copy an existing installation over SSH and serve it locally" | ||
| 697 | }, | ||
| 698 | { | ||
| 699 | "location": "/Create-and-serve-multiple-Shaarlis-(farm)/", | ||
| 700 | "text": "Example bash script (creates multiple shaarli instances and generates an HTML index of them)\n\n\n#!/bin/bash\nset -o errexit\nset -o nounset\n\n#config\nshaarli_base_dir='/var/www/shaarli'\naccounts='bob john whatever username'\nshaarli_repo_url='https://github.com/shaarli/Shaarli'\nref=\"master\"\n\n#clone multiple shaarli instances\nif [ ! -d \"$shaarli_base_dir\" ]; then mkdir \"$shaarli_base_dir\"; fi\n\nfor account in $accounts; do\n if [ -d \"$shaarli_base_dir/$account\" ];\n then echo \"[info] account $account already exists, skipping\";\n else echo \"[info] creating new account $account ...\"; git clone --quiet \"$shaarli_repo_url\" -b \"$ref\" \"$shaarli_base_dir/$account\"; fi\ndone\n\n#generate html index of shaarlis\nhtmlhead='<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01//EN\" \"http://www.w3.org/TR/html4/strict.dtd\">\n<!-- Minimal html template thanks to http://www.sitepoint.com/a-minimal-html-document/ -->\n<html lang=\"en\">\n <head>\n <meta http-equiv=\"content-type\" content=\"text/html; charset=utf-8\">\n <title>My Shaarli farm</title>\n <style>body {font-family: \"Open Sans\"}</style>\n </head>\n <body>\n <div>\n <h1>My Shaarli farm</h1>\n <ul style=\"list-style-type: none;\">'\n\naccountlinks=''\n\nhtmlfooter='\n </ul>\n </div>\n </body>\n</html>' \n\n\n\nfor account in $accounts; do accountlinks=\"$accountlinks\\n<li><a href=\\\"$account\\\">$account</a></li>\"; done\nif [ -d \"$shaarli_base_dir/index.html\" ]; then echo \"[removing old index.html]\"; rm \"$shaarli_base_dir/index.html\" ]; fi\necho \"[info] generating new index of shaarlis\"\necho -e \"$htmlhead $accountlinks $htmlfooter\" > \"$shaarli_base_dir/index.html\"\necho '[info] done.'\necho \"[info] list of accounts: $accounts\"\necho \"[info] contents of $shaarli_base_dir:\"\ntree -a -L 1 \"$shaarli_base_dir\"\n\n\n\n\nThis script just serves as an example. More precise or complex (applying custom configuration, etc) automation is possible using configuration management software like \nAnsible", | ||
| 701 | "title": "Create and serve multiple Shaarlis (farm)" | ||
| 702 | }, | ||
| 703 | { | ||
| 704 | "location": "/Download-CSS-styles-from-an-OPML-list/", | ||
| 705 | "text": "Download CSS styles for shaarlis listed in an opml file\n\n\nExample php script:\n\n\n<!---- ?php -->\n<!---- Copyright (c) 2014 Nicolas Delsaux (https://github.com/Riduidel) -->\n<!---- License: zlib (http://www.gzip.org/zlib/zlib_license.html) -->\n\n/**\n * Source: https://github.com/Riduidel\n * Download css styles for shaarlis listed in an opml file\n */\ndefine(\"SHAARLI_RSS_OPML\", \"https://www.ecirtam.net/shaarlirss/custom/people.opml\");\n\ndefine(\"THEMES_TEMP_FOLDER\", \"new_themes\");\n\nif(!file_exists(THEMES_TEMP_FOLDER)) {\n mkdir(THEMES_TEMP_FOLDER);\n}\n\nfunction siteUrl($pathInSite) {\n $indexPos = strpos($pathInSite, \"index.php\");\n if(!$indexPos) {\n return $pathInSite;\n } else {\n return substr($pathInSite, 0, $indexPos);\n }\n}\n\nfunction createShaarliHashFromOPMLL($opmlFile) {\n $result = array();\n $opml = file_get_contents($opmlFile);\n $opmlXml = simplexml_load_string($opml);\n $outlineElements = $opmlXml->xpath(\"body/outline\");\n foreach($outlineElements as $site) {\n $siteUrl = siteUrl((string) $site['htmlUrl']);\n $result[$siteUrl]=((string) $site['text']);\n }\n return $result;\n}\n\nfunction getSiteFolder($url) {\n $domain = parse_url($url, PHP_URL_HOST);\n return THEMES_TEMP_FOLDER.\"/\".str_replace(\".\", \"_\", $domain);\n}\n\nfunction get_http_response_code($theURL) {\n $headers = get_headers($theURL);\n return substr($headers[0], 9, 3);\n}\n\n/**\n * This makes the code PHP-5 only (particularly the call to \"get_headers\")\n */\nfunction copyUserStyleFrom($url, $name, $knownStyles) {\n $userStyle = $url.\"inc/user.css\";\n if(in_array($url, $knownStyles)) {\n // TODO add log message\n } else {\n $statusCode = get_http_response_code($userStyle);\n if(intval($statusCode)<300) {\n $styleSheet = file_get_contents($userStyle);\n $siteFolder = getSiteFolder($url);\n if(!file_exists($siteFolder)) {\n mkdir($siteFolder);\n }\n if(!file_exists($siteFolder.'/user.css')) {\n // Copy stylesheet\n file_put_contents($siteFolder.'/user.css', $styleSheet);\n }\n if(!file_exists($siteFolder.'/README.md')) {\n // Then write a readme.md file\n file_put_contents($siteFolder.'/README.md', \n \"User style from \".$name.\"\\n\"\n .\"=============================\"\n .\"\\n\\n\"\n .\"This stylesheet was downloaded from \".$userStyle.\" on \".date(DATE_RFC822)\n );\n }\n if(!file_exists($siteFolder.'/config.ini')) {\n // Write a config file containing useful informations\n file_put_contents($siteFolder.'/config.ini', \n \"site_url=\".$url.\"\\n\"\n .\"site_name=\".$name.\"\\n\"\n );\n }\n if(!file_exists($siteFolder.'/home.png')) {\n // And finally copy generated thumbnail\n $homeThumb = $siteFolder.'/home.png';\n file_put_contents($siteFolder.'/home.png', file_get_contents(getThumbnailUrl($url)));\n }\n echo 'Theme have been downloaded from <a href=\"'.$url.'\">'.$url.'</a> into '.$siteFolder\n .'. It looks like <img src=\"'.$homeThumb.'\"><br/>';\n }\n }\n}\n\nfunction getThumbnailUrl($url) {\n return 'http://api.webthumbnail.org/?url='.$url;\n}\n\nfunction copyUserStylesFrom($urlToNames, $knownStyles) {\n foreach($urlToNames as $url => $name) {\n copyUserStyleFrom($url, $name, $knownStyles);\n }\n}\n\n/**\n * Reading directory list, courtesy of http://www.laughing-buddha.net/php/dirlist/\n * @param directory the directory we want to list files of\n * @return a simple array containing the list of absolute file paths. Notice that current file (\".\") and parent one(\"..\")\n * are not listed here\n */\nfunction getDirectoryList ($directory) {\n $realPath = realpath($directory);\n // create an array to hold directory list\n $results = array();\n // create a handler for the directory\n $handler = opendir($directory);\n // open directory and walk through the filenames\n while ($file = readdir($handler)) {\n // if file isn't this directory or its parent, add it to the results\n if ($file != \".\" && $file != \"..\") {\n $results[] = realpath($realPath . \"/\" . $file);\n }\n }\n // tidy up: close the handler\n closedir($handler);\n // done!\n return $results;\n}\n\n/**\n * Start in themes folder and look in all subfolders for config.ini files. \n * These config.ini files allow us not to download styles again and again\n */\nfunction findKnownStyles() {\n $result = array();\n $subFolders = getDirectoryList(\"themes\");\n foreach($subFolders as $folder) {\n $configFile = $folder.\"/config.ini\";\n if(file_exists($configFile)) {\n $iniParameters = parse_ini_file($configFile);\n array_push($result, $iniParameters['site_url']);\n }\n }\n return $result;\n}\n\n$knownStyles = findKnownStyles();\ncopyUserStylesFrom(createShaarliHashFromOPMLL(SHAARLI_RSS_OPML), $knownStyles);\n\n<!--- ? ---->", | ||
| 706 | "title": "Download CSS styles from an OPML list" | ||
| 707 | }, | ||
| 708 | { | ||
| 709 | "location": "/Download-CSS-styles-from-an-OPML-list/#download-css-styles-for-shaarlis-listed-in-an-opml-file", | ||
| 710 | "text": "Example php script: <!---- ?php -->\n<!---- Copyright (c) 2014 Nicolas Delsaux (https://github.com/Riduidel) -->\n<!---- License: zlib (http://www.gzip.org/zlib/zlib_license.html) -->\n\n/**\n * Source: https://github.com/Riduidel\n * Download css styles for shaarlis listed in an opml file\n */\ndefine(\"SHAARLI_RSS_OPML\", \"https://www.ecirtam.net/shaarlirss/custom/people.opml\");\n\ndefine(\"THEMES_TEMP_FOLDER\", \"new_themes\");\n\nif(!file_exists(THEMES_TEMP_FOLDER)) {\n mkdir(THEMES_TEMP_FOLDER);\n}\n\nfunction siteUrl($pathInSite) {\n $indexPos = strpos($pathInSite, \"index.php\");\n if(!$indexPos) {\n return $pathInSite;\n } else {\n return substr($pathInSite, 0, $indexPos);\n }\n}\n\nfunction createShaarliHashFromOPMLL($opmlFile) {\n $result = array();\n $opml = file_get_contents($opmlFile);\n $opmlXml = simplexml_load_string($opml);\n $outlineElements = $opmlXml->xpath(\"body/outline\");\n foreach($outlineElements as $site) {\n $siteUrl = siteUrl((string) $site['htmlUrl']);\n $result[$siteUrl]=((string) $site['text']);\n }\n return $result;\n}\n\nfunction getSiteFolder($url) {\n $domain = parse_url($url, PHP_URL_HOST);\n return THEMES_TEMP_FOLDER.\"/\".str_replace(\".\", \"_\", $domain);\n}\n\nfunction get_http_response_code($theURL) {\n $headers = get_headers($theURL);\n return substr($headers[0], 9, 3);\n}\n\n/**\n * This makes the code PHP-5 only (particularly the call to \"get_headers\")\n */\nfunction copyUserStyleFrom($url, $name, $knownStyles) {\n $userStyle = $url.\"inc/user.css\";\n if(in_array($url, $knownStyles)) {\n // TODO add log message\n } else {\n $statusCode = get_http_response_code($userStyle);\n if(intval($statusCode)<300) {\n $styleSheet = file_get_contents($userStyle);\n $siteFolder = getSiteFolder($url);\n if(!file_exists($siteFolder)) {\n mkdir($siteFolder);\n }\n if(!file_exists($siteFolder.'/user.css')) {\n // Copy stylesheet\n file_put_contents($siteFolder.'/user.css', $styleSheet);\n }\n if(!file_exists($siteFolder.'/README.md')) {\n // Then write a readme.md file\n file_put_contents($siteFolder.'/README.md', \n \"User style from \".$name.\"\\n\"\n .\"=============================\"\n .\"\\n\\n\"\n .\"This stylesheet was downloaded from \".$userStyle.\" on \".date(DATE_RFC822)\n );\n }\n if(!file_exists($siteFolder.'/config.ini')) {\n // Write a config file containing useful informations\n file_put_contents($siteFolder.'/config.ini', \n \"site_url=\".$url.\"\\n\"\n .\"site_name=\".$name.\"\\n\"\n );\n }\n if(!file_exists($siteFolder.'/home.png')) {\n // And finally copy generated thumbnail\n $homeThumb = $siteFolder.'/home.png';\n file_put_contents($siteFolder.'/home.png', file_get_contents(getThumbnailUrl($url)));\n }\n echo 'Theme have been downloaded from <a href=\"'.$url.'\">'.$url.'</a> into '.$siteFolder\n .'. It looks like <img src=\"'.$homeThumb.'\"><br/>';\n }\n }\n}\n\nfunction getThumbnailUrl($url) {\n return 'http://api.webthumbnail.org/?url='.$url;\n}\n\nfunction copyUserStylesFrom($urlToNames, $knownStyles) {\n foreach($urlToNames as $url => $name) {\n copyUserStyleFrom($url, $name, $knownStyles);\n }\n}\n\n/**\n * Reading directory list, courtesy of http://www.laughing-buddha.net/php/dirlist/\n * @param directory the directory we want to list files of\n * @return a simple array containing the list of absolute file paths. Notice that current file (\".\") and parent one(\"..\")\n * are not listed here\n */\nfunction getDirectoryList ($directory) {\n $realPath = realpath($directory);\n // create an array to hold directory list\n $results = array();\n // create a handler for the directory\n $handler = opendir($directory);\n // open directory and walk through the filenames\n while ($file = readdir($handler)) {\n // if file isn't this directory or its parent, add it to the results\n if ($file != \".\" && $file != \"..\") {\n $results[] = realpath($realPath . \"/\" . $file);\n }\n }\n // tidy up: close the handler\n closedir($handler);\n // done!\n return $results;\n}\n\n/**\n * Start in themes folder and look in all subfolders for config.ini files. \n * These config.ini files allow us not to download styles again and again\n */\nfunction findKnownStyles() {\n $result = array();\n $subFolders = getDirectoryList(\"themes\");\n foreach($subFolders as $folder) {\n $configFile = $folder.\"/config.ini\";\n if(file_exists($configFile)) {\n $iniParameters = parse_ini_file($configFile);\n array_push($result, $iniParameters['site_url']);\n }\n }\n return $result;\n}\n\n$knownStyles = findKnownStyles();\ncopyUserStylesFrom(createShaarliHashFromOPMLL(SHAARLI_RSS_OPML), $knownStyles);\n\n<!--- ? ---->", | ||
| 711 | "title": "Download CSS styles for shaarlis listed in an opml file" | ||
| 712 | }, | ||
| 713 | { | ||
| 714 | "location": "/Datastore-hacks/", | ||
| 715 | "text": "Decode datastore content\n\n\nTo display the array representing the data saved in \ndata/datastore.php\n, use the following snippet:\n\n\n$data = \"tZNdb9MwFIb... <Commented content inside datastore.php>\";\n$out = unserialize(gzinflate(base64_decode($data)));\necho \"<pre>\"; // Pretty printing is love, pretty printing is life\nprint_r($out);\necho \"</pre>\";\nexit;\n\n\n\n\nThis will output the internal representation of the datastore, \"unobfuscated\" (if this can really be considered obfuscation).\n\n\nAlternatively, you can transform to JSON format (and pretty-print if you have \njq\n installed):\n\n\nphp -r 'print(json_encode(unserialize(gzinflate(base64_decode(preg_replace(\"!.*/\\* (.+) \\*/.*!\", \"$1\", file_get_contents(\"data/datastore.php\")))))));' | jq .\n\n\n\n\nChanging the timestamp for a link\n\n\n\n\nLook for \n<input type=\"hidden\" name=\"lf_linkdate\" value=\"{$link.linkdate}\">\n in \ntpl/editlink.tpl\n (line 14)\n\n\nReplace \ntype=\"hidden\"\n with \ntype=\"text\"\n from this line\n\n\nA new date/time field becomes available in the edit/new link dialog.\n\n\nYou can set the timestamp manually by entering it in the format \nYYYMMDD_HHMMS\n.", | ||
| 716 | "title": "Datastore hacks" | ||
| 717 | }, | ||
| 718 | { | ||
| 719 | "location": "/Datastore-hacks/#decode-datastore-content", | ||
| 720 | "text": "To display the array representing the data saved in data/datastore.php , use the following snippet: $data = \"tZNdb9MwFIb... <Commented content inside datastore.php>\";\n$out = unserialize(gzinflate(base64_decode($data)));\necho \"<pre>\"; // Pretty printing is love, pretty printing is life\nprint_r($out);\necho \"</pre>\";\nexit; This will output the internal representation of the datastore, \"unobfuscated\" (if this can really be considered obfuscation). Alternatively, you can transform to JSON format (and pretty-print if you have jq installed): php -r 'print(json_encode(unserialize(gzinflate(base64_decode(preg_replace(\"!.*/\\* (.+) \\*/.*!\", \"$1\", file_get_contents(\"data/datastore.php\")))))));' | jq .", | ||
| 721 | "title": "Decode datastore content" | ||
| 722 | }, | ||
| 723 | { | ||
| 724 | "location": "/Datastore-hacks/#changing-the-timestamp-for-a-link", | ||
| 725 | "text": "Look for <input type=\"hidden\" name=\"lf_linkdate\" value=\"{$link.linkdate}\"> in tpl/editlink.tpl (line 14) Replace type=\"hidden\" with type=\"text\" from this line A new date/time field becomes available in the edit/new link dialog. You can set the timestamp manually by entering it in the format YYYMMDD_HHMMS .", | ||
| 726 | "title": "Changing the timestamp for a link" | ||
| 727 | }, | ||
| 728 | { | ||
| 729 | "location": "/Troubleshooting/", | ||
| 730 | "text": "Troubleshooting\n\n\nBrowser\n\n\nRedirection issues (HTTP Referer)\n\n\nDepending on its configuration and installed plugins, the browser may remove or alter (spoof) HTTP referers, thus preventing Shaarli from properly redirecting between pages.\n\n\nSee:\n- \nHTTP referer\n (Wikipedia)\n- \nImprove online privacy by controlling referrer information\n\n- \nBetter security, privacy and anonymity in Firefox\n\n\nFirefox HTTP Referer options\n\n\nHTTP settings are available by browsing \nabout:config\n, here are the available settings and their values.\n\n\nnetwork.http.sendRefererHeader\n - determines when to send the Referer HTTP header\n- 0: Never send the referring URL\n - not recommended, may break some sites\n- 1: Send only on clicked links\n- 2 (default): Send for links and images\n\n\nnetwork.http.referer.XOriginPolicy\n - Cross-domain origin policy\n- 0 (default): Always send\n- 1: Send if base domains match\n- 2: Send if hosts match\n\n\nnetwork.http.referer.spoofSource\n - Referer spoofing (~faking)\n- false (default): real referer\n- true: spoof referer (use target URI as referer)\n - known to break some functionality in Shaarli\n\n\nnetwork.http.referer.trimmingPolicy\n - trim the URI not to send a full Referer\n- 0 (default): send full URI\n- 1: scheme+host+port+path\n- 2: scheme+host+port\n\n\nFirefox, localhost and redirections\n\n\nlocalhost\n is not a proper Fully Qualified Domain Name (FQDN); if Firefox has been set up to spoof referers, or only accept requests from the same base domain/host, Shaarli redirections will not work properly.\n\n\nTo solve this, assign a local domain to your host, e.g.\n\n\n127.0.0.1 localhost desktop localhost.lan\n::1 localhost desktop localhost.lan\n\n\n\n\nand browse Shaarli at http://localhost.lan/.\n\n\nRelated threads:\n- \nWhat is localhost.localdomain for?\n\n- \nStop returning to the first page after editing a bookmark from another page\n\n\nLogin\n\n\nI forgot my password!\n\n\nDelete the file \ndata/config.php\n and display the page again. You will be asked for a new login/password.\n\n\nI'm locked out - Login bruteforce protection\n\n\nLogin form is protected against brute force attacks: 4 failed logins will ban the IP address from login for 30 minutes. Banned IPs can still browse links.\n\n\nTo remove the current IP bans, delete the file \ndata/ipbans.php\n\n\nList of all login attempts\n\n\nThe file \ndata/log.txt\n shows all logins (successful or failed) and bans/lifted bans.\nSearch for \nfailed\n in this file to look for unauthorized login attempts.\n\n\nHosting problems\n\n\nOld PHP versions\n\n\n\n\nOn \nfree.fr\n : free.fr now support php 5.6.x(\nlink\n)and so support now the tag autocompletion but you have to do the following : At the root of your webspace create a \nsessions\n directory and a \n.htaccess\n file containing:\n\n\n\n\n<IfDefine Free>\nphp56 1\n</IfDefine>\n\n\n\n\n\n\nIf you have an error such as: \nParse error: syntax error, unexpected '=', expecting '(' in /links/index.php on line xxx\n, it means that your host is using php4, not php5. Shaarli requires php 5.1. Try changing the file extension to \n.php5\n\n\nOn \n1and1\n : If you add the link from the page (and not from the bookmarklet), Shaarli will no be able to get the title of the page. You will have to enter it manually. (Because they have disabled the ability to download a file through HTTP).\n\n\nIf you have the error \nWarning: file_get_contents() [function.file-get-contents]: URL file-access is disabled in the server configuration in /\u2026/index.php on line xxx\n, it means that your host has disabled the ability to fetch a file by HTTP in the php config (Typically in 1and1 hosting). Bad host. Change host. Or comment the following lines:\n\n\n\n\n//list($status,$headers,$data) = getHTTP($url,4); // Short timeout to keep the application responsive.\n// FIXME: Decode charset according to charset specified in either 1) HTTP response headers or 2) <head> in html \n//if (strpos($status,'200 OK')) $title=html_extract_title($data);\n\n\n\n\n\n\nOn hosts which forbid outgoing HTTP requests (such as free.fr), some thumbnails will not work.\n\n\nOn \nlost-oasis\n, RSS doesn't work correctly, because of this message at the begining of the RSS/ATOM feed : \n<? // tout ce qui est charge ici (generalement des includes et require) est charge en permanence. ?>\n. To fix this, remove this message from \nphp-include/prepend.php\n\n\n\n\nDates are not properly formatted\n\n\nShaarli tries to sniff the language of the browser (using HTTP_ACCEPT_LANGUAGE headers) and choose a date format accordingly. But Shaarli can only use the date formats (and more generaly speaking, the locales) provided by the webserver. So even if you have a browser in French, you may end up with dates in US format (it's the case on sebsauvage.net :-( )\n\n\nProblems on CentOS servers\n\n\nOn \nCentOS\n/RedHat derivatives, you may need to install the \nphp-mbstring\n package.\n\n\nMy session expires! I can't stay logged in\n\n\nThis can be caused by several things:\n\n\n\n\nYour php installation may not have a proper directory setup for session files. (eg. on Free.fr you need to create a \nsession\n directory on the root of your website.) You may need to create the session directory of set it up.\n\n\nMost hosts regularly clean the temporary and session directories. Your host may be cleaning those directories too aggressively (eg.OVH hosts), forcing an expire of the session. You may want to set the session directory in your web root. (eg. Create the \nsessions\n subdirectory and add \nini_set('session.save_path', $_SERVER['DOCUMENT_ROOT'].'/../sessions');\n. Make sure this directory is not browsable !)\n\n\nIf your IP address changes during surfing, Shaarli will force expire your session for security reasons (to prevent session cookie hijacking). This can happen when surfing from WiFi or 3G (you may have switched WiFi/3G access point), or in some corporate/university proxies which use load balancing (and may have proxies with several external IP addresses).\n\n\nSome browser addons may interfer with HTTP headers (ipfuck/ipflood/GreaseMonkey\u2026). Try disabling those.\n\n\nYou may be using OperaTurbo or OperaMini, which use their own proxies which may change from time to time.\n\n\nIf you have another application on the same webserver where Shaarli is installed, these application may forcefully expire php sessions.\n\n\n\n\nSessions do not seem to work correctly on your server\n\n\nFollow the instructions in the error message. Make sure you are accessing shaarli via a direct IP address or a proper hostname. If you have \nno dots\n in the hostname (e.g. \nlocalhost\n or \nhttp://my-webserver/shaarli/\n), some browsers will not store cookies at all (this respects the \nHTTP cookie specification\n).\n\n\npubsubhubbub support\n\n\nDownload \npublisher.php\n at the root of your Shaarli installation and set \n$GLOBALS['config']['PUBSUBHUB_URL']\n in your \nconfig.php", | ||
| 731 | "title": "Troubleshooting" | ||
| 732 | }, | ||
| 733 | { | ||
| 734 | "location": "/Troubleshooting/#troubleshooting", | ||
| 735 | "text": "", | ||
| 736 | "title": "Troubleshooting" | ||
| 737 | }, | ||
| 738 | { | ||
| 739 | "location": "/Troubleshooting/#browser", | ||
| 740 | "text": "", | ||
| 741 | "title": "Browser" | ||
| 742 | }, | ||
| 743 | { | ||
| 744 | "location": "/Troubleshooting/#redirection-issues-http-referer", | ||
| 745 | "text": "Depending on its configuration and installed plugins, the browser may remove or alter (spoof) HTTP referers, thus preventing Shaarli from properly redirecting between pages. See:\n- HTTP referer (Wikipedia)\n- Improve online privacy by controlling referrer information \n- Better security, privacy and anonymity in Firefox", | ||
| 746 | "title": "Redirection issues (HTTP Referer)" | ||
| 747 | }, | ||
| 748 | { | ||
| 749 | "location": "/Troubleshooting/#firefox-http-referer-options", | ||
| 750 | "text": "HTTP settings are available by browsing about:config , here are the available settings and their values. network.http.sendRefererHeader - determines when to send the Referer HTTP header\n- 0: Never send the referring URL\n - not recommended, may break some sites\n- 1: Send only on clicked links\n- 2 (default): Send for links and images network.http.referer.XOriginPolicy - Cross-domain origin policy\n- 0 (default): Always send\n- 1: Send if base domains match\n- 2: Send if hosts match network.http.referer.spoofSource - Referer spoofing (~faking)\n- false (default): real referer\n- true: spoof referer (use target URI as referer)\n - known to break some functionality in Shaarli network.http.referer.trimmingPolicy - trim the URI not to send a full Referer\n- 0 (default): send full URI\n- 1: scheme+host+port+path\n- 2: scheme+host+port", | ||
| 751 | "title": "Firefox HTTP Referer options" | ||
| 752 | }, | ||
| 753 | { | ||
| 754 | "location": "/Troubleshooting/#firefox-localhost-and-redirections", | ||
| 755 | "text": "localhost is not a proper Fully Qualified Domain Name (FQDN); if Firefox has been set up to spoof referers, or only accept requests from the same base domain/host, Shaarli redirections will not work properly. To solve this, assign a local domain to your host, e.g. 127.0.0.1 localhost desktop localhost.lan\n::1 localhost desktop localhost.lan and browse Shaarli at http://localhost.lan/. Related threads:\n- What is localhost.localdomain for? \n- Stop returning to the first page after editing a bookmark from another page", | ||
| 756 | "title": "Firefox, localhost and redirections" | ||
| 757 | }, | ||
| 758 | { | ||
| 759 | "location": "/Troubleshooting/#login", | ||
| 760 | "text": "", | ||
| 761 | "title": "Login" | ||
| 762 | }, | ||
| 763 | { | ||
| 764 | "location": "/Troubleshooting/#i-forgot-my-password", | ||
| 765 | "text": "Delete the file data/config.php and display the page again. You will be asked for a new login/password.", | ||
| 766 | "title": "I forgot my password!" | ||
| 767 | }, | ||
| 768 | { | ||
| 769 | "location": "/Troubleshooting/#im-locked-out-login-bruteforce-protection", | ||
| 770 | "text": "Login form is protected against brute force attacks: 4 failed logins will ban the IP address from login for 30 minutes. Banned IPs can still browse links. To remove the current IP bans, delete the file data/ipbans.php", | ||
| 771 | "title": "I'm locked out - Login bruteforce protection" | ||
| 772 | }, | ||
| 773 | { | ||
| 774 | "location": "/Troubleshooting/#list-of-all-login-attempts", | ||
| 775 | "text": "The file data/log.txt shows all logins (successful or failed) and bans/lifted bans.\nSearch for failed in this file to look for unauthorized login attempts.", | ||
| 776 | "title": "List of all login attempts" | ||
| 777 | }, | ||
| 778 | { | ||
| 779 | "location": "/Troubleshooting/#hosting-problems", | ||
| 780 | "text": "", | ||
| 781 | "title": "Hosting problems" | ||
| 782 | }, | ||
| 783 | { | ||
| 784 | "location": "/Troubleshooting/#old-php-versions", | ||
| 785 | "text": "On free.fr : free.fr now support php 5.6.x( link )and so support now the tag autocompletion but you have to do the following : At the root of your webspace create a sessions directory and a .htaccess file containing: <IfDefine Free>\nphp56 1\n</IfDefine> If you have an error such as: Parse error: syntax error, unexpected '=', expecting '(' in /links/index.php on line xxx , it means that your host is using php4, not php5. Shaarli requires php 5.1. Try changing the file extension to .php5 On 1and1 : If you add the link from the page (and not from the bookmarklet), Shaarli will no be able to get the title of the page. You will have to enter it manually. (Because they have disabled the ability to download a file through HTTP). If you have the error Warning: file_get_contents() [function.file-get-contents]: URL file-access is disabled in the server configuration in /\u2026/index.php on line xxx , it means that your host has disabled the ability to fetch a file by HTTP in the php config (Typically in 1and1 hosting). Bad host. Change host. Or comment the following lines: //list($status,$headers,$data) = getHTTP($url,4); // Short timeout to keep the application responsive.\n// FIXME: Decode charset according to charset specified in either 1) HTTP response headers or 2) <head> in html \n//if (strpos($status,'200 OK')) $title=html_extract_title($data); On hosts which forbid outgoing HTTP requests (such as free.fr), some thumbnails will not work. On lost-oasis , RSS doesn't work correctly, because of this message at the begining of the RSS/ATOM feed : <? // tout ce qui est charge ici (generalement des includes et require) est charge en permanence. ?> . To fix this, remove this message from php-include/prepend.php", | ||
| 786 | "title": "Old PHP versions" | ||
| 787 | }, | ||
| 788 | { | ||
| 789 | "location": "/Troubleshooting/#dates-are-not-properly-formatted", | ||
| 790 | "text": "Shaarli tries to sniff the language of the browser (using HTTP_ACCEPT_LANGUAGE headers) and choose a date format accordingly. But Shaarli can only use the date formats (and more generaly speaking, the locales) provided by the webserver. So even if you have a browser in French, you may end up with dates in US format (it's the case on sebsauvage.net :-( )", | ||
| 791 | "title": "Dates are not properly formatted" | ||
| 792 | }, | ||
| 793 | { | ||
| 794 | "location": "/Troubleshooting/#problems-on-centos-servers", | ||
| 795 | "text": "On CentOS /RedHat derivatives, you may need to install the php-mbstring package.", | ||
| 796 | "title": "Problems on CentOS servers" | ||
| 797 | }, | ||
| 798 | { | ||
| 799 | "location": "/Troubleshooting/#my-session-expires-i-cant-stay-logged-in", | ||
| 800 | "text": "This can be caused by several things: Your php installation may not have a proper directory setup for session files. (eg. on Free.fr you need to create a session directory on the root of your website.) You may need to create the session directory of set it up. Most hosts regularly clean the temporary and session directories. Your host may be cleaning those directories too aggressively (eg.OVH hosts), forcing an expire of the session. You may want to set the session directory in your web root. (eg. Create the sessions subdirectory and add ini_set('session.save_path', $_SERVER['DOCUMENT_ROOT'].'/../sessions'); . Make sure this directory is not browsable !) If your IP address changes during surfing, Shaarli will force expire your session for security reasons (to prevent session cookie hijacking). This can happen when surfing from WiFi or 3G (you may have switched WiFi/3G access point), or in some corporate/university proxies which use load balancing (and may have proxies with several external IP addresses). Some browser addons may interfer with HTTP headers (ipfuck/ipflood/GreaseMonkey\u2026). Try disabling those. You may be using OperaTurbo or OperaMini, which use their own proxies which may change from time to time. If you have another application on the same webserver where Shaarli is installed, these application may forcefully expire php sessions.", | ||
| 801 | "title": "My session expires! I can't stay logged in" | ||
| 802 | }, | ||
| 803 | { | ||
| 804 | "location": "/Troubleshooting/#sessions-do-not-seem-to-work-correctly-on-your-server", | ||
| 805 | "text": "Follow the instructions in the error message. Make sure you are accessing shaarli via a direct IP address or a proper hostname. If you have no dots in the hostname (e.g. localhost or http://my-webserver/shaarli/ ), some browsers will not store cookies at all (this respects the HTTP cookie specification ).", | ||
| 806 | "title": "Sessions do not seem to work correctly on your server" | ||
| 807 | }, | ||
| 808 | { | ||
| 809 | "location": "/Troubleshooting/#pubsubhubbub-support", | ||
| 810 | "text": "Download publisher.php at the root of your Shaarli installation and set $GLOBALS['config']['PUBSUBHUB_URL'] in your config.php", | ||
| 811 | "title": "pubsubhubbub support" | ||
| 812 | }, | ||
| 813 | { | ||
| 814 | "location": "/Development-guidelines/", | ||
| 815 | "text": "Development guidelines\n\n\nPlease have a look at the following pages:\n- \nContributing to Shaarli\n\n- \nStatic analysis\n - patches should try to stick to the \nPHP Standard Recommendations\n (PSR), especially:\n - \nPSR-1\n - Basic Coding Standard\n - \nPSR-2\n - Coding Style Guide\n- \nUnit tests\n\n- \nGnuPG signature\n for tags/releases", | ||
| 816 | "title": "Development guidelines" | ||
| 817 | }, | ||
| 818 | { | ||
| 819 | "location": "/Development-guidelines/#development-guidelines", | ||
| 820 | "text": "Please have a look at the following pages:\n- Contributing to Shaarli \n- Static analysis - patches should try to stick to the PHP Standard Recommendations (PSR), especially:\n - PSR-1 - Basic Coding Standard\n - PSR-2 - Coding Style Guide\n- Unit tests \n- GnuPG signature for tags/releases", | ||
| 821 | "title": "Development guidelines" | ||
| 822 | }, | ||
| 823 | { | ||
| 824 | "location": "/Continuous-integration-tools/", | ||
| 825 | "text": "Local development\n\n\nA \nMakefile\n is available to perform project-related operations:\n- Documentation - generate a local HTML copy of the GitHub wiki\n- \nStatic analysis\n - check that the code is compliant to PHP conventions\n- \nUnit tests\n - ensure there are no regressions introduced by new commits\n\n\nAutomatic builds\n\n\nTravis CI\n is a Continuous Integration build server, that runs a build:\n- each time a commit is merged to the mainline (\nmaster\n branch)\n- each time a Pull Request is submitted or updated\n\n\nA build is composed of several jobs: one for each supported PHP version (see \nServer requirements\n).\n\n\nEach build job:\n- updates Composer\n- installs 3rd-party test dependencies with Composer\n- runs \nUnit tests\n\n\nAfter all jobs have finished, Travis returns the results to GitHub:\n- a status icon represents the result for the \nmaster\n branch: \n\n- Pull Requests are updated with the Travis result\n - Green: all tests have passed\n - Red: some tests failed\n - Orange: tests are pending", | ||
| 826 | "title": "Continuous integration tools" | ||
| 827 | }, | ||
| 828 | { | ||
| 829 | "location": "/Continuous-integration-tools/#local-development", | ||
| 830 | "text": "A Makefile is available to perform project-related operations:\n- Documentation - generate a local HTML copy of the GitHub wiki\n- Static analysis - check that the code is compliant to PHP conventions\n- Unit tests - ensure there are no regressions introduced by new commits", | ||
| 831 | "title": "Local development" | ||
| 832 | }, | ||
| 833 | { | ||
| 834 | "location": "/Continuous-integration-tools/#automatic-builds", | ||
| 835 | "text": "Travis CI is a Continuous Integration build server, that runs a build:\n- each time a commit is merged to the mainline ( master branch)\n- each time a Pull Request is submitted or updated A build is composed of several jobs: one for each supported PHP version (see Server requirements ). Each build job:\n- updates Composer\n- installs 3rd-party test dependencies with Composer\n- runs Unit tests After all jobs have finished, Travis returns the results to GitHub:\n- a status icon represents the result for the master branch: \n- Pull Requests are updated with the Travis result\n - Green: all tests have passed\n - Red: some tests failed\n - Orange: tests are pending", | ||
| 836 | "title": "Automatic builds" | ||
| 837 | }, | ||
| 838 | { | ||
| 839 | "location": "/GnuPG-signature/", | ||
| 840 | "text": "Introduction\n\n\nPGP and GPG\n\n\nGnu Privacy Guard\n (GnuPG) is an Open Source implementation of the \nPretty Good \nPrivacy\n (OpenPGP) specification. Its main purposes are digital authentication, \nsignature and encryption.\n\n\nIt is often used by the \nFLOSS\n community to verify:\n- Linux package signatures: Debian \nSecureApt\n, ArchLinux \nMaster \nKeys\n\n- \nSCM\n releases & maintainer identity\n\n\nTrust\n\n\nTo quote Phil Pennock (the author of the \nSKS\n key server - http://sks.spodhuis.org/):\n\n\n\n\nYou MUST understand that presence of data in the keyserver (pools) in no way connotes trust. Anyone can generate a key, with any name or email address, and upload it. All security and trust comes from evaluating security at the \u201cobject level\u201d, via PGP Web-Of-Trust signatures. This keyserver makes it possible to retrieve keys, looking them up via various indices, but the collection of keys in this public pool is KNOWN to contain malicious and fraudulent keys. It is the common expectation of server operators that users understand this and use software which, like all known common OpenPGP implementations, evaluates trust accordingly. This expectation is so common that it is not normally explicitly stated.\n\n\n\n\nTrust can be gained by having your key signed by other people (and signing their key back, too :) ), for instance during \nkey signing parties\n, see:\n- \nThe Keysigning party HOWTO\n\n- \nWeb of trust\n\n\nGenerate a GPG key\n\n\n\n\nGenerating a GPG key for Git tagging\n (StackOverflow)\n\n\nGenerating a GPG key\n (GitHub)\n\n\n\n\ngpg - provide identity information\n\n\n$ gpg --gen-key\n\ngpg (GnuPG) 2.1.6; Copyright (C) 2015 Free Software Foundation, Inc.\nThis is free software: you are free to change and redistribute it.\nThere is NO WARRANTY, to the extent permitted by law.\n\nNote: Use \"gpg2 --full-gen-key\" for a full featured key generation dialog.\n\nGnuPG needs to construct a user ID to identify your key.\n\nReal name: Marvin the Paranoid Android\nEmail address: marvin@h2g2.net\nYou selected this USER-ID:\n \"Marvin the Paranoid Android <marvin@h2g2.net>\"\n\nChange (N)ame, (E)mail, or (O)kay/(Q)uit? o\nWe need to generate a lot of random bytes. It is a good idea to perform\nsome other action (type on the keyboard, move the mouse, utilize the\ndisks) during the prime generation; this gives the random number\ngenerator a better chance to gain enough entropy.\n\n\n\n\ngpg - entropy interlude\n\n\nAt this point, you will:\n- be prompted for a secure password to protect your key (the input method will depend on your Desktop Environment and configuration)\n- be asked to use your machine's input devices (mouse, keyboard, etc.) to generate random entropy; this step \nmay take some time\n \n\n\ngpg - key creation confirmation\n\n\ngpg: key A9D53A3E marked as ultimately trusted\npublic and secret key created and signed.\n\ngpg: checking the trustdb\ngpg: 3 marginal(s) needed, 1 complete(s) needed, PGP trust model\ngpg: depth: 0 valid: 2 signed: 0 trust: 0-, 0q, 0n, 0m, 0f, 2u\npub rsa2048/A9D53A3E 2015-07-31\n Key fingerprint = AF2A 5381 E54B 2FD2 14C4 A9A3 0E35 ACA4 A9D5 3A3E\nuid [ultimate] Marvin the Paranoid Android <marvin@h2g2.net>\nsub rsa2048/8C0EACF1 2015-07-31\n\n\n\n\ngpg - submit your public key to a PGP server (Optional)\n\n\n$ gpg --keyserver pgp.mit.edu --send-keys A9D53A3E\ngpg: sending key A9D53A3E to hkp server pgp.mit.edu\n\n\n\n\nCreate and push a GPG-signed tag\n\n\nSee \nRelease Shaarli\n.", | ||
| 841 | "title": "GnuPG signature" | ||
| 842 | }, | ||
| 843 | { | ||
| 844 | "location": "/GnuPG-signature/#introduction", | ||
| 845 | "text": "", | ||
| 846 | "title": "Introduction" | ||
| 847 | }, | ||
| 848 | { | ||
| 849 | "location": "/GnuPG-signature/#pgp-and-gpg", | ||
| 850 | "text": "Gnu Privacy Guard (GnuPG) is an Open Source implementation of the Pretty Good \nPrivacy (OpenPGP) specification. Its main purposes are digital authentication, \nsignature and encryption. It is often used by the FLOSS community to verify:\n- Linux package signatures: Debian SecureApt , ArchLinux Master \nKeys \n- SCM releases & maintainer identity", | ||
| 851 | "title": "PGP and GPG" | ||
| 852 | }, | ||
| 853 | { | ||
| 854 | "location": "/GnuPG-signature/#trust", | ||
| 855 | "text": "To quote Phil Pennock (the author of the SKS key server - http://sks.spodhuis.org/): You MUST understand that presence of data in the keyserver (pools) in no way connotes trust. Anyone can generate a key, with any name or email address, and upload it. All security and trust comes from evaluating security at the \u201cobject level\u201d, via PGP Web-Of-Trust signatures. This keyserver makes it possible to retrieve keys, looking them up via various indices, but the collection of keys in this public pool is KNOWN to contain malicious and fraudulent keys. It is the common expectation of server operators that users understand this and use software which, like all known common OpenPGP implementations, evaluates trust accordingly. This expectation is so common that it is not normally explicitly stated. Trust can be gained by having your key signed by other people (and signing their key back, too :) ), for instance during key signing parties , see:\n- The Keysigning party HOWTO \n- Web of trust", | ||
| 856 | "title": "Trust" | ||
| 857 | }, | ||
| 858 | { | ||
| 859 | "location": "/GnuPG-signature/#generate-a-gpg-key", | ||
| 860 | "text": "Generating a GPG key for Git tagging (StackOverflow) Generating a GPG key (GitHub)", | ||
| 861 | "title": "Generate a GPG key" | ||
| 862 | }, | ||
| 863 | { | ||
| 864 | "location": "/GnuPG-signature/#gpg-provide-identity-information", | ||
| 865 | "text": "$ gpg --gen-key\n\ngpg (GnuPG) 2.1.6; Copyright (C) 2015 Free Software Foundation, Inc.\nThis is free software: you are free to change and redistribute it.\nThere is NO WARRANTY, to the extent permitted by law.\n\nNote: Use \"gpg2 --full-gen-key\" for a full featured key generation dialog.\n\nGnuPG needs to construct a user ID to identify your key.\n\nReal name: Marvin the Paranoid Android\nEmail address: marvin@h2g2.net\nYou selected this USER-ID:\n \"Marvin the Paranoid Android <marvin@h2g2.net>\"\n\nChange (N)ame, (E)mail, or (O)kay/(Q)uit? o\nWe need to generate a lot of random bytes. It is a good idea to perform\nsome other action (type on the keyboard, move the mouse, utilize the\ndisks) during the prime generation; this gives the random number\ngenerator a better chance to gain enough entropy.", | ||
| 866 | "title": "gpg - provide identity information" | ||
| 867 | }, | ||
| 868 | { | ||
| 869 | "location": "/GnuPG-signature/#gpg-entropy-interlude", | ||
| 870 | "text": "At this point, you will:\n- be prompted for a secure password to protect your key (the input method will depend on your Desktop Environment and configuration)\n- be asked to use your machine's input devices (mouse, keyboard, etc.) to generate random entropy; this step may take some time", | ||
| 871 | "title": "gpg - entropy interlude" | ||
| 872 | }, | ||
| 873 | { | ||
| 874 | "location": "/GnuPG-signature/#gpg-key-creation-confirmation", | ||
| 875 | "text": "gpg: key A9D53A3E marked as ultimately trusted\npublic and secret key created and signed.\n\ngpg: checking the trustdb\ngpg: 3 marginal(s) needed, 1 complete(s) needed, PGP trust model\ngpg: depth: 0 valid: 2 signed: 0 trust: 0-, 0q, 0n, 0m, 0f, 2u\npub rsa2048/A9D53A3E 2015-07-31\n Key fingerprint = AF2A 5381 E54B 2FD2 14C4 A9A3 0E35 ACA4 A9D5 3A3E\nuid [ultimate] Marvin the Paranoid Android <marvin@h2g2.net>\nsub rsa2048/8C0EACF1 2015-07-31", | ||
| 876 | "title": "gpg - key creation confirmation" | ||
| 877 | }, | ||
| 878 | { | ||
| 879 | "location": "/GnuPG-signature/#gpg-submit-your-public-key-to-a-pgp-server-optional", | ||
| 880 | "text": "$ gpg --keyserver pgp.mit.edu --send-keys A9D53A3E\ngpg: sending key A9D53A3E to hkp server pgp.mit.edu", | ||
| 881 | "title": "gpg - submit your public key to a PGP server (Optional)" | ||
| 882 | }, | ||
| 883 | { | ||
| 884 | "location": "/GnuPG-signature/#create-and-push-a-gpg-signed-tag", | ||
| 885 | "text": "See Release Shaarli .", | ||
| 886 | "title": "Create and push a GPG-signed tag" | ||
| 887 | }, | ||
| 888 | { | ||
| 889 | "location": "/Coding-guidelines/", | ||
| 890 | "text": "WIP\n\n\nThis topic is currently being discussed here:\n- \nFix coding style (static analysis)\n (#95)\n- \nContinuous Integration tools & features\n (#130)", | ||
| 891 | "title": "Coding guidelines" | ||
| 892 | }, | ||
| 893 | { | ||
| 894 | "location": "/Coding-guidelines/#wip", | ||
| 895 | "text": "This topic is currently being discussed here:\n- Fix coding style (static analysis) (#95)\n- Continuous Integration tools & features (#130)", | ||
| 896 | "title": "WIP" | ||
| 897 | }, | ||
| 898 | { | ||
| 899 | "location": "/Directory-structure/", | ||
| 900 | "text": "Here is the directory structure of Shaarli and the purpose of the different files:\n\n\n index.php # Main program\n application/ # Shaarli classes\n \u251c\u2500\u2500 LinkDB.php\n \u2514\u2500\u2500 Utils.php\n tests/ # Shaarli unitary & functional tests\n \u251c\u2500\u2500 LinkDBTest.php\n \u251c\u2500\u2500 utils # utilities to ease testing\n \u2502 \u2514\u2500\u2500 ReferenceLinkDB.php\n \u2514\u2500\u2500 UtilsTest.php\n COPYING # Shaarli license\n inc/ # static assets and 3rd party libraries\n \u251c\u2500\u2500 awesomplete.* # tags autocompletion library\n \u251c\u2500\u2500 blazy.* # picture wall lazy image loading library\n \u251c\u2500\u2500 shaarli.css, reset.css # Shaarli stylesheet.\n \u251c\u2500\u2500 qr.* # qr code generation library\n \u2514\u2500\u2500rain.tpl.class.php # RainTPL templating library\n tpl/ # RainTPL templates for Shaarli. They are used to build the pages.\n images/ # Images and icons used in Shaarli\n data/ # data storage: bookmark database, configuration, logs, banlist\u2026\n \u251c\u2500\u2500 config.php # Shaarli configuration (login, password, timezone, title\u2026)\n \u251c\u2500\u2500 datastore.php # Your link database (compressed).\n \u251c\u2500\u2500 ipban.php # IP address ban system data\n \u251c\u2500\u2500 lastupdatecheck.txt # Update check timestamp file\n \u2514\u2500\u2500log.txt # login/IPban log.\n cache/ # thumbnails cache\n # This directory is automatically created. You can erase it anytime you want.\n tmp/ # Temporary directory for compiled RainTPL templates.\n # This directory is automatically created. You can erase it anytime you want.", | ||
| 901 | "title": "Directory structure" | ||
| 902 | }, | ||
| 903 | { | ||
| 904 | "location": "/3rd-party-libraries/", | ||
| 905 | "text": "CSS\n\n\n\n\nYahoo UI \nCSS Reset\n\n\nresets default CSS properties for all HTML elements (overriding browsers' default values)\n\n\nensures custom CSS stylessheets will provide the same results on all browsers\n\n\n\n\n\n\n\n\nJavascript\n\n\n\n\nAwesomeplete\n (\nGitHub\n) - autocompletion in input forms\n\n\nbLazy\n (\nGitHub\n) - lazy loading for thumbnails\n\n\nqr.js\n (\nGitHub\n) - QR code generation\n\n\n\n\nPHP\n\n\n\n\nshaarli/netscape-bookmark-parser\n - Netscape bookmark parser\n\n\nRainTPL\n - HTML templating for PHP", | ||
| 906 | "title": "3rd party libraries" | ||
| 907 | }, | ||
| 908 | { | ||
| 909 | "location": "/3rd-party-libraries/#css", | ||
| 910 | "text": "Yahoo UI CSS Reset resets default CSS properties for all HTML elements (overriding browsers' default values) ensures custom CSS stylessheets will provide the same results on all browsers", | ||
| 911 | "title": "CSS" | ||
| 912 | }, | ||
| 913 | { | ||
| 914 | "location": "/3rd-party-libraries/#javascript", | ||
| 915 | "text": "Awesomeplete ( GitHub ) - autocompletion in input forms bLazy ( GitHub ) - lazy loading for thumbnails qr.js ( GitHub ) - QR code generation", | ||
| 916 | "title": "Javascript" | ||
| 917 | }, | ||
| 918 | { | ||
| 919 | "location": "/3rd-party-libraries/#php", | ||
| 920 | "text": "shaarli/netscape-bookmark-parser - Netscape bookmark parser RainTPL - HTML templating for PHP", | ||
| 921 | "title": "PHP" | ||
| 922 | }, | ||
| 923 | { | ||
| 924 | "location": "/Plugin-System/", | ||
| 925 | "text": "I am a developer.\n Developer API.\n\n\nI am a template designer.\n Guide for template designer.\n\n\nDeveloper API\n\n\nWhat can I do with plugins?\n\n\nThe plugin system let you:\n\n\n\n\ninsert content into specific places across templates.\n\n\nalter data before templates rendering.\n\n\nalter data before saving new links.\n\n\n\n\nHow can I create a plugin for Shaarli?\n\n\nFirst, chose a plugin name, such as \ndemo_plugin\n.\n\n\nUnder \nplugin\n folder, create a folder named with your plugin name. Then create a \n.php file in that folder.\n\n\nYou should have the following tree view:\n\n\n| index.php\n| plugins/\n|---| demo_plugin/\n| |---| demo_plugin.php\n\n\n\n\nPlugin initialization\n\n\nAt the beginning of Shaarli execution, all enabled plugins are loaded. At this point, the plugin system looks for an \ninit()\n function to execute and run it if it exists. This function must be named this way, and takes the \nConfigManager\n as parameter.\n\n\n<plugin_name>_init($conf)\n\n\n\nThis function can be used to create initial data, load default settings, etc. But also to set \nplugin errors\n. If the initialization function returns an array of strings, they will be understand as errors, and displayed in the header to logged in users.\n\n\nUnderstanding hooks\n\n\nA plugin is a set of functions. Each function will be triggered by the plugin system at certain point in Shaarli execution.\n\n\nThese functions need to be named with this pattern:\n\n\nhook_<plugin_name>_<hook_name>($data, $conf)\n\n\n\n\nParameters:\n\n\n\n\ndata: see \n$data section\n\n\nconf: the \nConfigManager\n instance.\n\n\n\n\nFor exemple, if my plugin want to add data to the header, this function is needed:\n\n\nhook_demo_plugin_render_header\n\n\n\nIf this function is declared, and the plugin enabled, it will be called every time Shaarli is rendering the header.\n\n\nPlugin's data\n\n\nParameters\n\n\nEvery hook function has a \n$data\n parameter. Its content differs for each hooks.\n\n\nThis parameter needs to be returned every time\n, otherwise data is lost.\n\n\nreturn $data;\n\n\n\nFilling templates placeholder\n\n\nTemplate placeholders are displayed in template in specific places.\n\n\nRainTPL displays every element contained in the placeholder's array. These element can be added by plugins.\n\n\nFor example, let's add a value in the placeholder \ntop_placeholder\n which is displayed at the top of my page:\n\n\n$data['top_placeholder'][] = 'My content';\n# OR\narray_push($data['top_placeholder'], 'My', 'content');\n\nreturn $data;\n\n\n\n\nData manipulation\n\n\nWhen a page is displayed, every variable send to the template engine is passed to plugins before that in \n$data\n.\n\n\nThe data contained by this array can be altered before template rendering.\n\n\nFor exemple, in linklist, it is possible to alter every title:\n\n\n// mind the reference if you want $data to be altered\nforeach ($data['links'] as &$value) {\n // String reverse every title.\n $value['title'] = strrev($value['title']);\n}\n\nreturn $data;\n\n\n\n\nMetadata\n\n\nEvery plugin needs a \n<plugin_name>.meta\n file, which is in fact an \n.ini\n file (\nKEY=\"VALUE\"\n), to be listed in plugin administration.\n\n\nEach file contain two keys:\n\n\n\n\ndescription\n: plugin description\n\n\nparameters\n: user parameter names, separated by a \n;\n.\n\n\nparameter.<PARAMETER_NAME>\n: add a text description the specified parameter.\n\n\n\n\n\n\nNote: In PHP, \nparse_ini_file()\n seems to want strings to be between by quotes \n\"\n in the ini file.\n\n\n\n\nIt's not working!\n\n\nUse \ndemo_plugin\n as a functional example. It covers most of the plugin system features.\n\n\nIf it's still not working, please \nopen an issue\n.\n\n\nHooks\n\n\n\n\n\n\n\n\nHooks\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nrender_header\n\n\nAllow plugin to add content in page headers.\n\n\n\n\n\n\nrender_includes\n\n\nAllow plugin to include their own CSS files.\n\n\n\n\n\n\nrender_footer\n\n\nAllow plugin to add content in page footer and include their own JS files.\n\n\n\n\n\n\nrender_linklist\n\n\nIt allows to add content at the begining and end of the page, after every link displayed and to alter link data.\n\n\n\n\n\n\nrender_editlink\n\n\nAllow to add fields in the form, or display elements.\n\n\n\n\n\n\nrender_tools\n\n\nAllow to add content at the end of the page.\n\n\n\n\n\n\nrender_picwall\n\n\nAllow to add content at the top and bottom of the page.\n\n\n\n\n\n\nrender_tagcloud\n\n\nAllow to add content at the top and bottom of the page, and after all tags.\n\n\n\n\n\n\nrender_taglist\n\n\nAllow to add content at the top and bottom of the page, and after all tags.\n\n\n\n\n\n\nrender_daily\n\n\nAllow to add content at the top and bottom of the page, the bottom of each link and to alter data.\n\n\n\n\n\n\nrender_feed\n\n\nAllow to do add tags in RSS and ATOM feeds.\n\n\n\n\n\n\nsave_link\n\n\nAllow to alter the link being saved in the datastore.\n\n\n\n\n\n\ndelete_link\n\n\nAllow to do an action before a link is deleted from the datastore.\n\n\n\n\n\n\n\n\nrender_header\n\n\nTriggered on every page.\n\n\nAllow plugin to add content in page headers.\n\n\nData\n\n\n$data\n is an array containing:\n\n\n\n\n_PAGE_\n: current target page (eg: \nlinklist\n, \npicwall\n, etc.).\n\n\n_LOGGEDIN_\n: true if user is logged in, false otherwise.\n\n\n\n\nTemplate placeholders\n\n\nItems can be displayed in templates by adding an entry in \n$data['<placeholder>']\n array.\n\n\nList of placeholders:\n\n\n\n\nbuttons_toolbar\n: after the list of buttons in the header.\n\n\n\n\n\n\n\n\nfields_toolbar\n: after search fields in the header.\n\n\n\n\n\n\nNote: This will only be called in linklist.\n\n\n\n\n\n\nrender_includes\n\n\nTriggered on every page.\n\n\nAllow plugin to include their own CSS files.\n\n\nData\n\n\n$data\n is an array containing:\n\n\n\n\n_PAGE_\n: current target page (eg: \nlinklist\n, \npicwall\n, etc.).\n\n\n_LOGGEDIN_\n: true if user is logged in, false otherwise.\n\n\n\n\nTemplate placeholders\n\n\nItems can be displayed in templates by adding an entry in \n$data['<placeholder>']\n array.\n\n\nList of placeholders:\n\n\n\n\ncss_files\n: called after loading default CSS.\n\n\n\n\n\n\nNote: only add the path of the CSS file. E.g: \nplugins/demo_plugin/custom_demo.css\n.\n\n\n\n\nrender_footer\n\n\nTriggered on every page.\n\n\nAllow plugin to add content in page footer and include their own JS files.\n\n\nData\n\n\n$data\n is an array containing:\n\n\n\n\n_PAGE_\n: current target page (eg: \nlinklist\n, \npicwall\n, etc.).\n\n\n_LOGGEDIN_\n: true if user is logged in, false otherwise.\n\n\n\n\nTemplate placeholders\n\n\nItems can be displayed in templates by adding an entry in \n$data['<placeholder>']\n array.\n\n\nList of placeholders:\n\n\n\n\ntext\n: called after the end of the footer text.\n\n\nendofpage\n: called at the end of the page.\n\n\n\n\n\n\n\n\njs_files\n: called at the end of the page, to include custom JS scripts.\n\n\n\n\n\n\nNote: only add the path of the JS file. E.g: \nplugins/demo_plugin/custom_demo.js\n.\n\n\n\n\nrender_linklist\n\n\nTriggered when \nlinklist\n is displayed (list of links, permalink, search, tag filtered, etc.).\n\n\nIt allows to add content at the begining and end of the page, after every link displayed and to alter link data.\n\n\nData\n\n\n$data\n is an array containing:\n\n\n\n\n_LOGGEDIN_\n: true if user is logged in, false otherwise.\n\n\nAll templates data, including links.\n\n\n\n\nTemplate placeholders\n\n\nItems can be displayed in templates by adding an entry in \n$data['<placeholder>']\n array.\n\n\nList of placeholders:\n\n\n\n\naction_plugin\n: next to the button \"private only\" at the top and bottom of the page.\n\n\n\n\n\n\n\n\nlink_plugin\n: for every link, between permalink and link URL.\n\n\n\n\n\n\n\n\nplugin_start_zone\n: before displaying the template content.\n\n\n\n\n\n\n\n\nplugin_end_zone\n: after displaying the template content.\n\n\n\n\n\n\nrender_editlink\n\n\nTriggered when the link edition form is displayed.\n\n\nAllow to add fields in the form, or display elements.\n\n\nData\n\n\n$data\n is an array containing:\n\n\n\n\nAll templates data.\n\n\n\n\nTemplate placeholders\n\n\nItems can be displayed in templates by adding an entry in \n$data['<placeholder>']\n array.\n\n\nList of placeholders:\n\n\n\n\nedit_link_plugin\n: after tags field.\n\n\n\n\n\n\nrender_tools\n\n\nTriggered when the \"tools\" page is displayed.\n\n\nAllow to add content at the end of the page.\n\n\nData\n\n\n$data\n is an array containing:\n\n\n\n\nAll templates data.\n\n\n\n\nTemplate placeholders\n\n\nItems can be displayed in templates by adding an entry in \n$data['<placeholder>']\n array.\n\n\nList of placeholders:\n\n\n\n\ntools_plugin\n: at the end of the page.\n\n\n\n\n\n\nrender_picwall\n\n\nTriggered when picwall is displayed.\n\n\nAllow to add content at the top and bottom of the page.\n\n\nData\n\n\n$data\n is an array containing:\n\n\n\n\n_LOGGEDIN_\n: true if user is logged in, false otherwise.\n\n\nAll templates data.\n\n\n\n\nTemplate placeholders\n\n\nItems can be displayed in templates by adding an entry in \n$data['<placeholder>']\n array.\n\n\nList of placeholders:\n\n\n\n\n\n\nplugin_start_zone\n: before displaying the template content.\n\n\n\n\n\n\nplugin_end_zone\n: after displaying the template content.\n\n\n\n\n\n\n\n\nrender_tagcloud\n\n\nTriggered when tagcloud is displayed.\n\n\nAllow to add content at the top and bottom of the page.\n\n\nData\n\n\n$data\n is an array containing:\n\n\n\n\n_LOGGEDIN_\n: true if user is logged in, false otherwise.\n\n\nAll templates data.\n\n\n\n\nTemplate placeholders\n\n\nItems can be displayed in templates by adding an entry in \n$data['<placeholder>']\n array.\n\n\nList of placeholders:\n\n\n\n\n\n\nplugin_start_zone\n: before displaying the template content.\n\n\n\n\n\n\nplugin_end_zone\n: after displaying the template content.\n\n\n\n\n\n\nFor each tag, the following placeholder can be used:\n\n\n\n\ntag_plugin\n: after each tag\n\n\n\n\n\n\nrender_taglist\n\n\nTriggered when taglist is displayed.\n\n\nAllow to add content at the top and bottom of the page.\n\n\nData\n\n\n$data\n is an array containing:\n\n\n\n\n_LOGGEDIN_\n: true if user is logged in, false otherwise.\n\n\nAll templates data.\n\n\n\n\nTemplate placeholders\n\n\nItems can be displayed in templates by adding an entry in \n$data['<placeholder>']\n array.\n\n\nList of placeholders:\n\n\n\n\n\n\nplugin_start_zone\n: before displaying the template content.\n\n\n\n\n\n\nplugin_end_zone\n: after displaying the template content.\n\n\n\n\n\n\nFor each tag, the following placeholder can be used:\n\n\n\n\ntag_plugin\n: after each tag\n\n\n\n\nrender_daily\n\n\nTriggered when tagcloud is displayed.\n\n\nAllow to add content at the top and bottom of the page, the bottom of each link and to alter data.\n\n\nData\n\n\n$data\n is an array containing:\n\n\n\n\n_LOGGEDIN_\n: true if user is logged in, false otherwise.\n\n\nAll templates data, including links.\n\n\n\n\nTemplate placeholders\n\n\nItems can be displayed in templates by adding an entry in \n$data['<placeholder>']\n array.\n\n\nList of placeholders:\n\n\n\n\nlink_plugin\n: used at bottom of each link.\n\n\n\n\n\n\n\n\n\n\nplugin_start_zone\n: before displaying the template content.\n\n\n\n\n\n\nplugin_end_zone\n: after displaying the template content.\n\n\n\n\n\n\nrender_feed\n\n\nTriggered when the ATOM or RSS feed is displayed.\n\n\nAllow to add tags in the feed, either in the header or for each items. Items (links) can also be altered before being rendered.\n\n\nData\n\n\n$data\n is an array containing:\n\n\n\n\n_LOGGEDIN_\n: true if user is logged in, false otherwise.\n\n\n_PAGE_\n: containing either \nrss\n or \natom\n.\n\n\nAll templates data, including links.\n\n\n\n\nTemplate placeholders\n\n\nTags can be added in feeds by adding an entry in \n$data['<placeholder>']\n array.\n\n\nList of placeholders:\n\n\n\n\nfeed_plugins_header\n: used as a header tag in the feed.\n\n\n\n\nFor each links:\n\n\n\n\nfeed_plugins\n: additional tag for every link entry.\n\n\n\n\nsave_link\n\n\nTriggered when a link is save (new link or edit).\n\n\nAllow to alter the link being saved in the datastore.\n\n\nData\n\n\n$data\n is an array containing the link being saved:\n\n\n\n\nid\n\n\ntitle\n\n\nurl\n\n\nshorturl\n\n\ndescription\n\n\nprivate\n\n\ntags\n\n\ncreated\n\n\nupdated\n\n\n\n\ndelete_link\n\n\nTriggered when a link is deleted.\n\n\nAllow to execute any action before the link is actually removed from the datastore\n\n\nData\n\n\n$data\n is an array containing the link being saved:\n\n\n\n\nid\n\n\ntitle\n\n\nurl\n\n\nshorturl\n\n\ndescription\n\n\nprivate\n\n\ntags\n\n\ncreated\n\n\nupdated\n\n\n\n\nGuide for template designer\n\n\nPlugin administration\n\n\nYour theme must include a plugin administration page: \npluginsadmin.html\n.\n\n\n\n\nNote: repo's template link needs to be added when the PR is merged.\n\n\n\n\nUse the default one as an example.\n\n\nAside from classic RainTPL loops, plugins order is handle by JavaScript. You can just include \nplugin_admin.js\n, only if:\n\n\n\n\nyou're using a table.\n\n\nyou call orderUp() and orderUp() onclick on arrows.\n\n\nyou add data-line and data-order to your rows.\n\n\n\n\nOtherwise, you can use your own JS as long as this field is send by the form:\n\n\n\n\nPlaceholder system\n\n\nIn order to make plugins work with every custom themes, you need to add variable placeholder in your templates. \n\n\nIt's a RainTPL loop like this:\n\n\n{loop=\"$plugin_variable\"}\n {$value}\n{/loop}\n\n\n\nYou should enable \ndemo_plugin\n for testing purpose, since it uses every placeholder available.\n\n\nList of placeholders\n\n\npage.header.html\n\n\nAt the end of the menu:\n\n\n{loop=\"$plugins_header.buttons_toolbar\"}\n {$value}\n{/loop}\n\n\n\nAt the end of file, before clearing floating blocks:\n\n\n{if=\"!empty($plugin_errors) && isLoggedIn()\"}\n <ul class=\"errors\">\n {loop=\"plugin_errors\"}\n <li>{$value}</li>\n {/loop}\n </ul>\n{/if}\n\n\n\nincludes.html\n\n\nAt the end of the file:\n\n\n{loop=\"$plugins_includes.css_files\"}\n<link type=\"text/css\" rel=\"stylesheet\" href=\"{$value}#\"/>\n{/loop}\n\n\n\n\npage.footer.html\n\n\nAt the end of your footer notes:\n\n\n{loop=\"$plugins_footer.text\"}\n {$value}\n{/loop}\n\n\n\n\nAt the end of file:\n\n\n{loop=\"$plugins_footer.js_files\"}\n <script src=\"{$value}#\"></script>\n{/loop}\n\n\n\n\nlinklist.html\n\n\nAfter search fields:\n\n\n{loop=\"$plugins_header.fields_toolbar\"}\n {$value}\n{/loop}\n\n\n\n\nBefore displaying the link list (after paging):\n\n\n{loop=\"$plugin_start_zone\"}\n {$value}\n{/loop}\n\n\n\n\nFor every links (icons):\n\n\n{loop=\"$value.link_plugin\"}\n <span>{$value}</span>\n{/loop}\n\n\n\n\nBefore end paging:\n\n\n{loop=\"$plugin_end_zone\"}\n {$value}\n{/loop}\n\n\n\n\nlinklist.paging.html\n\n\nAfter the \"private only\" icon:\n\n\n{loop=\"$action_plugin\"}\n {$value}\n{/loop}\n\n\n\n\neditlink.html\n\n\nAfter tags field:\n\n\n{loop=\"$edit_link_plugin\"}\n {$value}\n{/loop}\n\n\n\n\ntools.html\n\n\nAfter the last tool:\n\n\n{loop=\"$tools_plugin\"}\n {$value}\n{/loop}\n\n\n\n\npicwall.html\n\n\nTop:\n\n\n<div id=\"plugin_zone_start_picwall\" class=\"plugin_zone\">\n {loop=\"$plugin_start_zone\"}\n {$value}\n {/loop}\n</div>\n\n\n\n\nBottom:\n\n\n<div id=\"plugin_zone_end_picwall\" class=\"plugin_zone\">\n {loop=\"$plugin_end_zone\"}\n {$value}\n {/loop}\n</div>\n\n\n\n\ntagcloud.html\n\n\nTop:\n\n\n <div id=\"plugin_zone_start_tagcloud\" class=\"plugin_zone\">\n {loop=\"$plugin_start_zone\"}\n {$value}\n {/loop}\n </div>\n\n\n\n\nBottom:\n\n\n <div id=\"plugin_zone_end_tagcloud\" class=\"plugin_zone\">\n {loop=\"$plugin_end_zone\"}\n {$value}\n {/loop}\n </div>\n\n\n\n\ndaily.html\n\n\nTop:\n\n\n<div id=\"plugin_zone_start_picwall\" class=\"plugin_zone\">\n {loop=\"$plugin_start_zone\"}\n {$value}\n {/loop}\n</div>\n\n\n\n\nAfter every link:\n\n\n<div class=\"dailyEntryFooter\">\n {loop=\"$link.link_plugin\"}\n {$value}\n {/loop}\n</div>\n\n\n\n\nBottom:\n\n\n<div id=\"plugin_zone_end_picwall\" class=\"plugin_zone\">\n {loop=\"$plugin_end_zone\"}\n {$value}\n {/loop}\n</div>\n\n\n\n\nfeed.atom.xml\n and \nfeed.rss.xml\n:\n\n\nIn headers tags section:\n\n\n{loop=\"$feed_plugins_header\"}\n {$value}\n{/loop}\n\n\n\n\nAfter each entry:\n\n\n{loop=\"$value.feed_plugins\"}\n {$value}\n{/loop}", | ||
| 926 | "title": "Plugin System" | ||
| 927 | }, | ||
| 928 | { | ||
| 929 | "location": "/Plugin-System/#developer-api", | ||
| 930 | "text": "", | ||
| 931 | "title": "Developer API" | ||
| 932 | }, | ||
| 933 | { | ||
| 934 | "location": "/Plugin-System/#what-can-i-do-with-plugins", | ||
| 935 | "text": "The plugin system let you: insert content into specific places across templates. alter data before templates rendering. alter data before saving new links.", | ||
| 936 | "title": "What can I do with plugins?" | ||
| 937 | }, | ||
| 938 | { | ||
| 939 | "location": "/Plugin-System/#how-can-i-create-a-plugin-for-shaarli", | ||
| 940 | "text": "First, chose a plugin name, such as demo_plugin . Under plugin folder, create a folder named with your plugin name. Then create a .php file in that folder. You should have the following tree view: | index.php\n| plugins/\n|---| demo_plugin/\n| |---| demo_plugin.php", | ||
| 941 | "title": "How can I create a plugin for Shaarli?" | ||
| 942 | }, | ||
| 943 | { | ||
| 944 | "location": "/Plugin-System/#plugin-initialization", | ||
| 945 | "text": "At the beginning of Shaarli execution, all enabled plugins are loaded. At this point, the plugin system looks for an init() function to execute and run it if it exists. This function must be named this way, and takes the ConfigManager as parameter. <plugin_name>_init($conf) This function can be used to create initial data, load default settings, etc. But also to set plugin errors . If the initialization function returns an array of strings, they will be understand as errors, and displayed in the header to logged in users.", | ||
| 946 | "title": "Plugin initialization" | ||
| 947 | }, | ||
| 948 | { | ||
| 949 | "location": "/Plugin-System/#understanding-hooks", | ||
| 950 | "text": "A plugin is a set of functions. Each function will be triggered by the plugin system at certain point in Shaarli execution. These functions need to be named with this pattern: hook_<plugin_name>_<hook_name>($data, $conf) Parameters: data: see $data section conf: the ConfigManager instance. For exemple, if my plugin want to add data to the header, this function is needed: hook_demo_plugin_render_header If this function is declared, and the plugin enabled, it will be called every time Shaarli is rendering the header.", | ||
| 951 | "title": "Understanding hooks" | ||
| 952 | }, | ||
| 953 | { | ||
| 954 | "location": "/Plugin-System/#plugins-data", | ||
| 955 | "text": "", | ||
| 956 | "title": "Plugin's data" | ||
| 957 | }, | ||
| 958 | { | ||
| 959 | "location": "/Plugin-System/#parameters", | ||
| 960 | "text": "Every hook function has a $data parameter. Its content differs for each hooks. This parameter needs to be returned every time , otherwise data is lost. return $data;", | ||
| 961 | "title": "Parameters" | ||
| 962 | }, | ||
| 963 | { | ||
| 964 | "location": "/Plugin-System/#filling-templates-placeholder", | ||
| 965 | "text": "Template placeholders are displayed in template in specific places. RainTPL displays every element contained in the placeholder's array. These element can be added by plugins. For example, let's add a value in the placeholder top_placeholder which is displayed at the top of my page: $data['top_placeholder'][] = 'My content';\n# OR\narray_push($data['top_placeholder'], 'My', 'content');\n\nreturn $data;", | ||
| 966 | "title": "Filling templates placeholder" | ||
| 967 | }, | ||
| 968 | { | ||
| 969 | "location": "/Plugin-System/#data-manipulation", | ||
| 970 | "text": "When a page is displayed, every variable send to the template engine is passed to plugins before that in $data . The data contained by this array can be altered before template rendering. For exemple, in linklist, it is possible to alter every title: // mind the reference if you want $data to be altered\nforeach ($data['links'] as &$value) {\n // String reverse every title.\n $value['title'] = strrev($value['title']);\n}\n\nreturn $data;", | ||
| 971 | "title": "Data manipulation" | ||
| 972 | }, | ||
| 973 | { | ||
| 974 | "location": "/Plugin-System/#metadata", | ||
| 975 | "text": "Every plugin needs a <plugin_name>.meta file, which is in fact an .ini file ( KEY=\"VALUE\" ), to be listed in plugin administration. Each file contain two keys: description : plugin description parameters : user parameter names, separated by a ; . parameter.<PARAMETER_NAME> : add a text description the specified parameter. Note: In PHP, parse_ini_file() seems to want strings to be between by quotes \" in the ini file.", | ||
| 976 | "title": "Metadata" | ||
| 977 | }, | ||
| 978 | { | ||
| 979 | "location": "/Plugin-System/#its-not-working", | ||
| 980 | "text": "Use demo_plugin as a functional example. It covers most of the plugin system features. If it's still not working, please open an issue .", | ||
| 981 | "title": "It's not working!" | ||
| 982 | }, | ||
| 983 | { | ||
| 984 | "location": "/Plugin-System/#hooks", | ||
| 985 | "text": "Hooks Description render_header Allow plugin to add content in page headers. render_includes Allow plugin to include their own CSS files. render_footer Allow plugin to add content in page footer and include their own JS files. render_linklist It allows to add content at the begining and end of the page, after every link displayed and to alter link data. render_editlink Allow to add fields in the form, or display elements. render_tools Allow to add content at the end of the page. render_picwall Allow to add content at the top and bottom of the page. render_tagcloud Allow to add content at the top and bottom of the page, and after all tags. render_taglist Allow to add content at the top and bottom of the page, and after all tags. render_daily Allow to add content at the top and bottom of the page, the bottom of each link and to alter data. render_feed Allow to do add tags in RSS and ATOM feeds. save_link Allow to alter the link being saved in the datastore. delete_link Allow to do an action before a link is deleted from the datastore.", | ||
| 986 | "title": "Hooks" | ||
| 987 | }, | ||
| 988 | { | ||
| 989 | "location": "/Plugin-System/#render_header", | ||
| 990 | "text": "Triggered on every page. Allow plugin to add content in page headers.", | ||
| 991 | "title": "render_header" | ||
| 992 | }, | ||
| 993 | { | ||
| 994 | "location": "/Plugin-System/#data", | ||
| 995 | "text": "$data is an array containing: _PAGE_ : current target page (eg: linklist , picwall , etc.). _LOGGEDIN_ : true if user is logged in, false otherwise.", | ||
| 996 | "title": "Data" | ||
| 997 | }, | ||
| 998 | { | ||
| 999 | "location": "/Plugin-System/#template-placeholders", | ||
| 1000 | "text": "Items can be displayed in templates by adding an entry in $data['<placeholder>'] array. List of placeholders: buttons_toolbar : after the list of buttons in the header. fields_toolbar : after search fields in the header. Note: This will only be called in linklist.", | ||
| 1001 | "title": "Template placeholders" | ||
| 1002 | }, | ||
| 1003 | { | ||
| 1004 | "location": "/Plugin-System/#render_includes", | ||
| 1005 | "text": "Triggered on every page. Allow plugin to include their own CSS files.", | ||
| 1006 | "title": "render_includes" | ||
| 1007 | }, | ||
| 1008 | { | ||
| 1009 | "location": "/Plugin-System/#data_1", | ||
| 1010 | "text": "$data is an array containing: _PAGE_ : current target page (eg: linklist , picwall , etc.). _LOGGEDIN_ : true if user is logged in, false otherwise.", | ||
| 1011 | "title": "Data" | ||
| 1012 | }, | ||
| 1013 | { | ||
| 1014 | "location": "/Plugin-System/#template-placeholders_1", | ||
| 1015 | "text": "Items can be displayed in templates by adding an entry in $data['<placeholder>'] array. List of placeholders: css_files : called after loading default CSS. Note: only add the path of the CSS file. E.g: plugins/demo_plugin/custom_demo.css .", | ||
| 1016 | "title": "Template placeholders" | ||
| 1017 | }, | ||
| 1018 | { | ||
| 1019 | "location": "/Plugin-System/#render_footer", | ||
| 1020 | "text": "Triggered on every page. Allow plugin to add content in page footer and include their own JS files.", | ||
| 1021 | "title": "render_footer" | ||
| 1022 | }, | ||
| 1023 | { | ||
| 1024 | "location": "/Plugin-System/#data_2", | ||
| 1025 | "text": "$data is an array containing: _PAGE_ : current target page (eg: linklist , picwall , etc.). _LOGGEDIN_ : true if user is logged in, false otherwise.", | ||
| 1026 | "title": "Data" | ||
| 1027 | }, | ||
| 1028 | { | ||
| 1029 | "location": "/Plugin-System/#template-placeholders_2", | ||
| 1030 | "text": "Items can be displayed in templates by adding an entry in $data['<placeholder>'] array. List of placeholders: text : called after the end of the footer text. endofpage : called at the end of the page. js_files : called at the end of the page, to include custom JS scripts. Note: only add the path of the JS file. E.g: plugins/demo_plugin/custom_demo.js .", | ||
| 1031 | "title": "Template placeholders" | ||
| 1032 | }, | ||
| 1033 | { | ||
| 1034 | "location": "/Plugin-System/#render_linklist", | ||
| 1035 | "text": "Triggered when linklist is displayed (list of links, permalink, search, tag filtered, etc.). It allows to add content at the begining and end of the page, after every link displayed and to alter link data.", | ||
| 1036 | "title": "render_linklist" | ||
| 1037 | }, | ||
| 1038 | { | ||
| 1039 | "location": "/Plugin-System/#data_3", | ||
| 1040 | "text": "$data is an array containing: _LOGGEDIN_ : true if user is logged in, false otherwise. All templates data, including links.", | ||
| 1041 | "title": "Data" | ||
| 1042 | }, | ||
| 1043 | { | ||
| 1044 | "location": "/Plugin-System/#template-placeholders_3", | ||
| 1045 | "text": "Items can be displayed in templates by adding an entry in $data['<placeholder>'] array. List of placeholders: action_plugin : next to the button \"private only\" at the top and bottom of the page. link_plugin : for every link, between permalink and link URL. plugin_start_zone : before displaying the template content. plugin_end_zone : after displaying the template content.", | ||
| 1046 | "title": "Template placeholders" | ||
| 1047 | }, | ||
| 1048 | { | ||
| 1049 | "location": "/Plugin-System/#render_editlink", | ||
| 1050 | "text": "Triggered when the link edition form is displayed. Allow to add fields in the form, or display elements.", | ||
| 1051 | "title": "render_editlink" | ||
| 1052 | }, | ||
| 1053 | { | ||
| 1054 | "location": "/Plugin-System/#data_4", | ||
| 1055 | "text": "$data is an array containing: All templates data.", | ||
| 1056 | "title": "Data" | ||
| 1057 | }, | ||
| 1058 | { | ||
| 1059 | "location": "/Plugin-System/#template-placeholders_4", | ||
| 1060 | "text": "Items can be displayed in templates by adding an entry in $data['<placeholder>'] array. List of placeholders: edit_link_plugin : after tags field.", | ||
| 1061 | "title": "Template placeholders" | ||
| 1062 | }, | ||
| 1063 | { | ||
| 1064 | "location": "/Plugin-System/#render_tools", | ||
| 1065 | "text": "Triggered when the \"tools\" page is displayed. Allow to add content at the end of the page.", | ||
| 1066 | "title": "render_tools" | ||
| 1067 | }, | ||
| 1068 | { | ||
| 1069 | "location": "/Plugin-System/#data_5", | ||
| 1070 | "text": "$data is an array containing: All templates data.", | ||
| 1071 | "title": "Data" | ||
| 1072 | }, | ||
| 1073 | { | ||
| 1074 | "location": "/Plugin-System/#template-placeholders_5", | ||
| 1075 | "text": "Items can be displayed in templates by adding an entry in $data['<placeholder>'] array. List of placeholders: tools_plugin : at the end of the page.", | ||
| 1076 | "title": "Template placeholders" | ||
| 1077 | }, | ||
| 1078 | { | ||
| 1079 | "location": "/Plugin-System/#render_picwall", | ||
| 1080 | "text": "Triggered when picwall is displayed. Allow to add content at the top and bottom of the page.", | ||
| 1081 | "title": "render_picwall" | ||
| 1082 | }, | ||
| 1083 | { | ||
| 1084 | "location": "/Plugin-System/#data_6", | ||
| 1085 | "text": "$data is an array containing: _LOGGEDIN_ : true if user is logged in, false otherwise. All templates data.", | ||
| 1086 | "title": "Data" | ||
| 1087 | }, | ||
| 1088 | { | ||
| 1089 | "location": "/Plugin-System/#template-placeholders_6", | ||
| 1090 | "text": "Items can be displayed in templates by adding an entry in $data['<placeholder>'] array. List of placeholders: plugin_start_zone : before displaying the template content. plugin_end_zone : after displaying the template content.", | ||
| 1091 | "title": "Template placeholders" | ||
| 1092 | }, | ||
| 1093 | { | ||
| 1094 | "location": "/Plugin-System/#render_tagcloud", | ||
| 1095 | "text": "Triggered when tagcloud is displayed. Allow to add content at the top and bottom of the page.", | ||
| 1096 | "title": "render_tagcloud" | ||
| 1097 | }, | ||
| 1098 | { | ||
| 1099 | "location": "/Plugin-System/#data_7", | ||
| 1100 | "text": "$data is an array containing: _LOGGEDIN_ : true if user is logged in, false otherwise. All templates data.", | ||
| 1101 | "title": "Data" | ||
| 1102 | }, | ||
| 1103 | { | ||
| 1104 | "location": "/Plugin-System/#template-placeholders_7", | ||
| 1105 | "text": "Items can be displayed in templates by adding an entry in $data['<placeholder>'] array. List of placeholders: plugin_start_zone : before displaying the template content. plugin_end_zone : after displaying the template content. For each tag, the following placeholder can be used: tag_plugin : after each tag", | ||
| 1106 | "title": "Template placeholders" | ||
| 1107 | }, | ||
| 1108 | { | ||
| 1109 | "location": "/Plugin-System/#render_taglist", | ||
| 1110 | "text": "Triggered when taglist is displayed. Allow to add content at the top and bottom of the page.", | ||
| 1111 | "title": "render_taglist" | ||
| 1112 | }, | ||
| 1113 | { | ||
| 1114 | "location": "/Plugin-System/#data_8", | ||
| 1115 | "text": "$data is an array containing: _LOGGEDIN_ : true if user is logged in, false otherwise. All templates data.", | ||
| 1116 | "title": "Data" | ||
| 1117 | }, | ||
| 1118 | { | ||
| 1119 | "location": "/Plugin-System/#template-placeholders_8", | ||
| 1120 | "text": "Items can be displayed in templates by adding an entry in $data['<placeholder>'] array. List of placeholders: plugin_start_zone : before displaying the template content. plugin_end_zone : after displaying the template content. For each tag, the following placeholder can be used: tag_plugin : after each tag", | ||
| 1121 | "title": "Template placeholders" | ||
| 1122 | }, | ||
| 1123 | { | ||
| 1124 | "location": "/Plugin-System/#render_daily", | ||
| 1125 | "text": "Triggered when tagcloud is displayed. Allow to add content at the top and bottom of the page, the bottom of each link and to alter data.", | ||
| 1126 | "title": "render_daily" | ||
| 1127 | }, | ||
| 1128 | { | ||
| 1129 | "location": "/Plugin-System/#data_9", | ||
| 1130 | "text": "$data is an array containing: _LOGGEDIN_ : true if user is logged in, false otherwise. All templates data, including links.", | ||
| 1131 | "title": "Data" | ||
| 1132 | }, | ||
| 1133 | { | ||
| 1134 | "location": "/Plugin-System/#template-placeholders_9", | ||
| 1135 | "text": "Items can be displayed in templates by adding an entry in $data['<placeholder>'] array. List of placeholders: link_plugin : used at bottom of each link. plugin_start_zone : before displaying the template content. plugin_end_zone : after displaying the template content.", | ||
| 1136 | "title": "Template placeholders" | ||
| 1137 | }, | ||
| 1138 | { | ||
| 1139 | "location": "/Plugin-System/#render_feed", | ||
| 1140 | "text": "Triggered when the ATOM or RSS feed is displayed. Allow to add tags in the feed, either in the header or for each items. Items (links) can also be altered before being rendered.", | ||
| 1141 | "title": "render_feed" | ||
| 1142 | }, | ||
| 1143 | { | ||
| 1144 | "location": "/Plugin-System/#data_10", | ||
| 1145 | "text": "$data is an array containing: _LOGGEDIN_ : true if user is logged in, false otherwise. _PAGE_ : containing either rss or atom . All templates data, including links.", | ||
| 1146 | "title": "Data" | ||
| 1147 | }, | ||
| 1148 | { | ||
| 1149 | "location": "/Plugin-System/#template-placeholders_10", | ||
| 1150 | "text": "Tags can be added in feeds by adding an entry in $data['<placeholder>'] array. List of placeholders: feed_plugins_header : used as a header tag in the feed. For each links: feed_plugins : additional tag for every link entry.", | ||
| 1151 | "title": "Template placeholders" | ||
| 1152 | }, | ||
| 1153 | { | ||
| 1154 | "location": "/Plugin-System/#save_link", | ||
| 1155 | "text": "Triggered when a link is save (new link or edit). Allow to alter the link being saved in the datastore.", | ||
| 1156 | "title": "save_link" | ||
| 1157 | }, | ||
| 1158 | { | ||
| 1159 | "location": "/Plugin-System/#data_11", | ||
| 1160 | "text": "$data is an array containing the link being saved: id title url shorturl description private tags created updated", | ||
| 1161 | "title": "Data" | ||
| 1162 | }, | ||
| 1163 | { | ||
| 1164 | "location": "/Plugin-System/#delete_link", | ||
| 1165 | "text": "Triggered when a link is deleted. Allow to execute any action before the link is actually removed from the datastore", | ||
| 1166 | "title": "delete_link" | ||
| 1167 | }, | ||
| 1168 | { | ||
| 1169 | "location": "/Plugin-System/#data_12", | ||
| 1170 | "text": "$data is an array containing the link being saved: id title url shorturl description private tags created updated", | ||
| 1171 | "title": "Data" | ||
| 1172 | }, | ||
| 1173 | { | ||
| 1174 | "location": "/Plugin-System/#guide-for-template-designer", | ||
| 1175 | "text": "", | ||
| 1176 | "title": "Guide for template designer" | ||
| 1177 | }, | ||
| 1178 | { | ||
| 1179 | "location": "/Plugin-System/#plugin-administration", | ||
| 1180 | "text": "Your theme must include a plugin administration page: pluginsadmin.html . Note: repo's template link needs to be added when the PR is merged. Use the default one as an example. Aside from classic RainTPL loops, plugins order is handle by JavaScript. You can just include plugin_admin.js , only if: you're using a table. you call orderUp() and orderUp() onclick on arrows. you add data-line and data-order to your rows. Otherwise, you can use your own JS as long as this field is send by the form:", | ||
| 1181 | "title": "Plugin administration" | ||
| 1182 | }, | ||
| 1183 | { | ||
| 1184 | "location": "/Plugin-System/#placeholder-system", | ||
| 1185 | "text": "In order to make plugins work with every custom themes, you need to add variable placeholder in your templates. It's a RainTPL loop like this: {loop=\"$plugin_variable\"}\n {$value}\n{/loop} You should enable demo_plugin for testing purpose, since it uses every placeholder available.", | ||
| 1186 | "title": "Placeholder system" | ||
| 1187 | }, | ||
| 1188 | { | ||
| 1189 | "location": "/Plugin-System/#list-of-placeholders", | ||
| 1190 | "text": "page.header.html At the end of the menu: {loop=\"$plugins_header.buttons_toolbar\"}\n {$value}\n{/loop} At the end of file, before clearing floating blocks: {if=\"!empty($plugin_errors) && isLoggedIn()\"}\n <ul class=\"errors\">\n {loop=\"plugin_errors\"}\n <li>{$value}</li>\n {/loop}\n </ul>\n{/if} includes.html At the end of the file: {loop=\"$plugins_includes.css_files\"}\n<link type=\"text/css\" rel=\"stylesheet\" href=\"{$value}#\"/>\n{/loop} page.footer.html At the end of your footer notes: {loop=\"$plugins_footer.text\"}\n {$value}\n{/loop} At the end of file: {loop=\"$plugins_footer.js_files\"}\n <script src=\"{$value}#\"></script>\n{/loop} linklist.html After search fields: {loop=\"$plugins_header.fields_toolbar\"}\n {$value}\n{/loop} Before displaying the link list (after paging): {loop=\"$plugin_start_zone\"}\n {$value}\n{/loop} For every links (icons): {loop=\"$value.link_plugin\"}\n <span>{$value}</span>\n{/loop} Before end paging: {loop=\"$plugin_end_zone\"}\n {$value}\n{/loop} linklist.paging.html After the \"private only\" icon: {loop=\"$action_plugin\"}\n {$value}\n{/loop} editlink.html After tags field: {loop=\"$edit_link_plugin\"}\n {$value}\n{/loop} tools.html After the last tool: {loop=\"$tools_plugin\"}\n {$value}\n{/loop} picwall.html Top: <div id=\"plugin_zone_start_picwall\" class=\"plugin_zone\">\n {loop=\"$plugin_start_zone\"}\n {$value}\n {/loop}\n</div> Bottom: <div id=\"plugin_zone_end_picwall\" class=\"plugin_zone\">\n {loop=\"$plugin_end_zone\"}\n {$value}\n {/loop}\n</div> tagcloud.html Top: <div id=\"plugin_zone_start_tagcloud\" class=\"plugin_zone\">\n {loop=\"$plugin_start_zone\"}\n {$value}\n {/loop}\n </div> Bottom: <div id=\"plugin_zone_end_tagcloud\" class=\"plugin_zone\">\n {loop=\"$plugin_end_zone\"}\n {$value}\n {/loop}\n </div> daily.html Top: <div id=\"plugin_zone_start_picwall\" class=\"plugin_zone\">\n {loop=\"$plugin_start_zone\"}\n {$value}\n {/loop}\n</div> After every link: <div class=\"dailyEntryFooter\">\n {loop=\"$link.link_plugin\"}\n {$value}\n {/loop}\n</div> Bottom: <div id=\"plugin_zone_end_picwall\" class=\"plugin_zone\">\n {loop=\"$plugin_end_zone\"}\n {$value}\n {/loop}\n</div> feed.atom.xml and feed.rss.xml : In headers tags section: {loop=\"$feed_plugins_header\"}\n {$value}\n{/loop} After each entry: {loop=\"$value.feed_plugins\"}\n {$value}\n{/loop}", | ||
| 1191 | "title": "List of placeholders" | ||
| 1192 | }, | ||
| 1193 | { | ||
| 1194 | "location": "/Release-Shaarli/", | ||
| 1195 | "text": "See \nGit - Maintaining a project - Tagging your \nreleases\n.\n\n\nPrerequisites\n\n\nThis guide assumes that you have:\n- a GPG key matching your GitHub authentication credentials\n - i.e., the email address identified by the GPG key is the same as the one in your \n~/.gitconfig\n \n- a GitHub fork of Shaarli\n- a local clone of your Shaarli fork, with the following remotes:\n - \norigin\n pointing to your GitHub fork\n - \nupstream\n pointing to the main Shaarli repository\n- maintainer permissions on the main Shaarli repository, to:\n - push the signed tag\n - create a new release\n- \nComposer\n and \nPandoc\n need to be installed\n\n\nGitHub release draft and \nCHANGELOG.md\n\n\nSee http://keepachangelog.com/en/0.3.0/ for changelog formatting.\n\n\nGitHub release draft\n\n\nGitHub allows drafting the release note for the upcoming release, from the \nReleases\n page. This way, the release note can be drafted while contributions are merged to \nmaster\n.\n\n\nCHANGELOG.md\n\n\nThis file should contain the same information as the release note draft for the upcoming version.\n\n\nUpdate it to:\n- add new entries (additions, fixes, etc.)\n- mark the current version as released by setting its date and link\n- add a new section for the future unreleased version\n\n\n$ cd /path/to/shaarli\n\n$ nano CHANGELOG.md\n\n[...]\n## vA.B.C - UNRELEASED\nTBA\n\n## [vX.Y.Z](https://github.com/shaarli/Shaarli/releases/tag/vX.Y.Z) - YYYY-MM-DD\n[...]\n\n\n\n\nIncrement the version code, updated docs, create and push a signed tag\n\n\nGenerate documentation\n\n\n$ cd /path/to/shaarli\n\n# create a new branch\n$ git fetch upstream\n$ git checkout upstream/master -b v0.5.0\n\n# rebuild the documentation from the wiki\n$ make htmldoc\n\n# commit the changes\n$ git add doc\n$ git commit -s -m \"Generate documentation for v0.5.0\"\n\n# push the commit on your GitHub fork\n$ git push origin v0.5.0\n\n\n\n\nCreate and merge a Pull Request\n\n\nThis one is pretty straightforward ;-)\n\n\nBump Shaarli version to v0.x branch\n\n\n$ git checkout master\n$ git fetch upstream\n$ git pull upstream master\n\n# IF the branch doesn't exists\n$ git checkout -b v0.5\n# OR if the branch already exists\n$ git checkout v0.5\n$ git rebase upstream/master\n\n# Bump shaarli version from dev to 0.5.0, **without the `v`**\n$ vim shaarli_version.php\n$ git add shaarli_version\n$ git commit -s -m \"Bump Shaarli version to v0.5.0\"\n$ git push upstream v0.5\n\n\n\n\nCreate and push a signed tag\n\n\n# update your local copy\n$ git checkout v0.5\n$ git fetch upstream\n$ git pull upstream v0.5\n\n# create a signed tag\n$ git tag -s -m \"Release v0.5.0\" v0.5.0\n\n# push it to \"upstream\"\n$ git push --tags upstream\n\n\n\n\nVerify a signed tag\n\n\nv0.5.0\n is the first GPG-signed tag pushed on the Community Shaarli.\n\n\nLet's have a look at its signature!\n\n\n$ cd /path/to/shaarli\n$ git fetch upstream\n\n# get the SHA1 reference of the tag\n$ git show-ref tags/v0.5.0\nf7762cf803f03f5caf4b8078359a63783d0090c1 refs/tags/v0.5.0\n\n# verify the tag signature information\n$ git verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1\ngpg: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F\ngpg: Good signature from \"VirtualTam <virtualtam@flibidi.net>\" [ultimate]\n\n\n\n\nPublish the GitHub release\n\n\nUpdate release badges\n\n\nUpdate \nREADME.md\n so version badges display and point to the newly released Shaarli version(s), in the \nmaster\n branch.\n\n\nCreate a GitHub release from a Git tag\n\n\nFrom the previously drafted release:\n- edit the release notes (if needed)\n- specify the appropriate Git tag\n- publish the release\n- profit!\n\n\nGenerate and upload all-in-one release archives\n\n\nUsers with a shared hosting may have:\n- no SSH access\n- no possibility to install PHP packages or server extensions\n- no possibility to run scripts\n\n\nTo ease Shaarli installations, it is possible to generate and upload additional release archives,\nthat will contain Shaarli code plus all required third-party libraries.\n\n\nFrom the \nv0.5\n branch:\n\n\n$ make release_archive\n\n\n\n\nThis will create the following archives:\n- \nshaarli-vX.Y.Z-full.tar\n\n- \nshaarli-vX.Y.Z-full.zip\n\n\nThe archives need to be manually uploaded on the previously created GitHub release.\n\n\nUpdate \nstable\n and \nlatest\n branches\n\n\n$ git checkout latest\n# latest release\n$ git merge v0.5.0\n# fix eventual conflicts\n$ make test\n$ git push upstream latest\n$ git checkout stable\n# latest previous major\n$ git merge v0.4.5 \n# fix eventual conflicts\n$ make test\n$ git push upstream stable", | ||
| 1196 | "title": "Release Shaarli" | ||
| 1197 | }, | ||
| 1198 | { | ||
| 1199 | "location": "/Release-Shaarli/#prerequisites", | ||
| 1200 | "text": "This guide assumes that you have:\n- a GPG key matching your GitHub authentication credentials\n - i.e., the email address identified by the GPG key is the same as the one in your ~/.gitconfig \n- a GitHub fork of Shaarli\n- a local clone of your Shaarli fork, with the following remotes:\n - origin pointing to your GitHub fork\n - upstream pointing to the main Shaarli repository\n- maintainer permissions on the main Shaarli repository, to:\n - push the signed tag\n - create a new release\n- Composer and Pandoc need to be installed", | ||
| 1201 | "title": "Prerequisites" | ||
| 1202 | }, | ||
| 1203 | { | ||
| 1204 | "location": "/Release-Shaarli/#github-release-draft-and-changelogmd", | ||
| 1205 | "text": "See http://keepachangelog.com/en/0.3.0/ for changelog formatting.", | ||
| 1206 | "title": "GitHub release draft and CHANGELOG.md" | ||
| 1207 | }, | ||
| 1208 | { | ||
| 1209 | "location": "/Release-Shaarli/#github-release-draft", | ||
| 1210 | "text": "GitHub allows drafting the release note for the upcoming release, from the Releases page. This way, the release note can be drafted while contributions are merged to master .", | ||
| 1211 | "title": "GitHub release draft" | ||
| 1212 | }, | ||
| 1213 | { | ||
| 1214 | "location": "/Release-Shaarli/#changelogmd", | ||
| 1215 | "text": "This file should contain the same information as the release note draft for the upcoming version. Update it to:\n- add new entries (additions, fixes, etc.)\n- mark the current version as released by setting its date and link\n- add a new section for the future unreleased version $ cd /path/to/shaarli\n\n$ nano CHANGELOG.md\n\n[...]\n## vA.B.C - UNRELEASED\nTBA\n\n## [vX.Y.Z](https://github.com/shaarli/Shaarli/releases/tag/vX.Y.Z) - YYYY-MM-DD\n[...]", | ||
| 1216 | "title": "CHANGELOG.md" | ||
| 1217 | }, | ||
| 1218 | { | ||
| 1219 | "location": "/Release-Shaarli/#increment-the-version-code-updated-docs-create-and-push-a-signed-tag", | ||
| 1220 | "text": "", | ||
| 1221 | "title": "Increment the version code, updated docs, create and push a signed tag" | ||
| 1222 | }, | ||
| 1223 | { | ||
| 1224 | "location": "/Release-Shaarli/#generate-documentation", | ||
| 1225 | "text": "$ cd /path/to/shaarli\n\n# create a new branch\n$ git fetch upstream\n$ git checkout upstream/master -b v0.5.0\n\n# rebuild the documentation from the wiki\n$ make htmldoc\n\n# commit the changes\n$ git add doc\n$ git commit -s -m \"Generate documentation for v0.5.0\"\n\n# push the commit on your GitHub fork\n$ git push origin v0.5.0", | ||
| 1226 | "title": "Generate documentation" | ||
| 1227 | }, | ||
| 1228 | { | ||
| 1229 | "location": "/Release-Shaarli/#create-and-merge-a-pull-request", | ||
| 1230 | "text": "This one is pretty straightforward ;-)", | ||
| 1231 | "title": "Create and merge a Pull Request" | ||
| 1232 | }, | ||
| 1233 | { | ||
| 1234 | "location": "/Release-Shaarli/#bump-shaarli-version-to-v0x-branch", | ||
| 1235 | "text": "$ git checkout master\n$ git fetch upstream\n$ git pull upstream master\n\n# IF the branch doesn't exists\n$ git checkout -b v0.5\n# OR if the branch already exists\n$ git checkout v0.5\n$ git rebase upstream/master\n\n# Bump shaarli version from dev to 0.5.0, **without the `v`**\n$ vim shaarli_version.php\n$ git add shaarli_version\n$ git commit -s -m \"Bump Shaarli version to v0.5.0\"\n$ git push upstream v0.5", | ||
| 1236 | "title": "Bump Shaarli version to v0.x branch" | ||
| 1237 | }, | ||
| 1238 | { | ||
| 1239 | "location": "/Release-Shaarli/#create-and-push-a-signed-tag", | ||
| 1240 | "text": "# update your local copy\n$ git checkout v0.5\n$ git fetch upstream\n$ git pull upstream v0.5\n\n# create a signed tag\n$ git tag -s -m \"Release v0.5.0\" v0.5.0\n\n# push it to \"upstream\"\n$ git push --tags upstream", | ||
| 1241 | "title": "Create and push a signed tag" | ||
| 1242 | }, | ||
| 1243 | { | ||
| 1244 | "location": "/Release-Shaarli/#verify-a-signed-tag", | ||
| 1245 | "text": "v0.5.0 is the first GPG-signed tag pushed on the Community Shaarli. Let's have a look at its signature! $ cd /path/to/shaarli\n$ git fetch upstream\n\n# get the SHA1 reference of the tag\n$ git show-ref tags/v0.5.0\nf7762cf803f03f5caf4b8078359a63783d0090c1 refs/tags/v0.5.0\n\n# verify the tag signature information\n$ git verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1\ngpg: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F\ngpg: Good signature from \"VirtualTam <virtualtam@flibidi.net>\" [ultimate]", | ||
| 1246 | "title": "Verify a signed tag" | ||
| 1247 | }, | ||
| 1248 | { | ||
| 1249 | "location": "/Release-Shaarli/#publish-the-github-release", | ||
| 1250 | "text": "", | ||
| 1251 | "title": "Publish the GitHub release" | ||
| 1252 | }, | ||
| 1253 | { | ||
| 1254 | "location": "/Release-Shaarli/#update-release-badges", | ||
| 1255 | "text": "Update README.md so version badges display and point to the newly released Shaarli version(s), in the master branch.", | ||
| 1256 | "title": "Update release badges" | ||
| 1257 | }, | ||
| 1258 | { | ||
| 1259 | "location": "/Release-Shaarli/#create-a-github-release-from-a-git-tag", | ||
| 1260 | "text": "From the previously drafted release:\n- edit the release notes (if needed)\n- specify the appropriate Git tag\n- publish the release\n- profit!", | ||
| 1261 | "title": "Create a GitHub release from a Git tag" | ||
| 1262 | }, | ||
| 1263 | { | ||
| 1264 | "location": "/Release-Shaarli/#generate-and-upload-all-in-one-release-archives", | ||
| 1265 | "text": "Users with a shared hosting may have:\n- no SSH access\n- no possibility to install PHP packages or server extensions\n- no possibility to run scripts To ease Shaarli installations, it is possible to generate and upload additional release archives,\nthat will contain Shaarli code plus all required third-party libraries. From the v0.5 branch: $ make release_archive This will create the following archives:\n- shaarli-vX.Y.Z-full.tar \n- shaarli-vX.Y.Z-full.zip The archives need to be manually uploaded on the previously created GitHub release.", | ||
| 1266 | "title": "Generate and upload all-in-one release archives" | ||
| 1267 | }, | ||
| 1268 | { | ||
| 1269 | "location": "/Release-Shaarli/#update-stable-and-latest-branches", | ||
| 1270 | "text": "$ git checkout latest\n# latest release\n$ git merge v0.5.0\n# fix eventual conflicts\n$ make test\n$ git push upstream latest\n$ git checkout stable\n# latest previous major\n$ git merge v0.4.5 \n# fix eventual conflicts\n$ make test\n$ git push upstream stable", | ||
| 1271 | "title": "Update stable and latest branches" | ||
| 1272 | }, | ||
| 1273 | { | ||
| 1274 | "location": "/Versioning-and-Branches/", | ||
| 1275 | "text": "WORK IN PROGRESS\n\n\nIt's important to understand how Shaarli branches work, especially if you're maintaining a 3rd party tools for Shaarli (theme, plugin, etc.), to be sure stay compatible.\n\n\nmaster\n branch\n\n\nThe \nmaster\n branch is the development branch. Any new change MUST go through this branch using Pull Requests.\n\n\nRemarks:\n\n\n\n\nThis branch shouldn't be used for production as it isn't necessary stable.\n\n\n3rd party aren't required to be compatible with the latest changes.\n\n\nOfficial plugins, themes and libraries (contained within Shaarli organization repos) must be compatible with the master branch.\n\n\nThe version in this branch is always \ndev\n.\n\n\n\n\nv0.x\n branch\n\n\nThis \nv0.x\n branch, points to the latest \nv0.x.y\n release.\n\n\nExplanation:\n\n\nWhen a new version is released, it might contains a major bug which isn't detected right away. For example, a new PHP version is released, containing backward compatibility issue which doesn't work with Shaarli.\n\n\nIn this case, the issue is fixed in the \nmaster\n branch, and the fix is backported the to the \nv0.x\n branch. Then a new release is made from the \nv0.x\n branch.\n\n\nThis workflow allow us to fix any major bug detected, without having to release bleeding edge feature too soon.\n\n\nlatest\n branch\n\n\nThis branch point the latest release. It recommended to use it to get the latest tested changes.\n\n\nstable\n branch\n\n\nThe \nstable\n branch doesn't contain any major bug, and is one major digit version behind the latest release.\n\n\nFor example, the current latest release is \nv0.8.3\n, the stable branch is an alias to the latest \nv0.7.x\n release. When the \nv0.9.0\n version will be released, the stable will move to the latest \nv0.8.x\n release.\n\n\nRemarks:\n\n\n\n\nShaarli release pace isn't fast, and the stable branch might be a few months behind the latest release.\n\n\n\n\nReleases\n\n\nReleases are always made from the latest \nv0.x\n branch.\n\n\nNote that for every release, we manually generate a tarball which contains all Shaarli dependencies, making Shaarli's installation only one step.\n\n\nAdvices on 3rd party git repos workflow\n\n\nVersioning\n\n\nAny time a new Shaarli release is published, you should publish a new release of your repo if the changes affected you since the latest release (take a look at the \nchangelog\n (\nDraft\n means not released yet) and the commit log (like \ntpl\n folder\n for themes)). You can either:\n\n\n\n\nuse the Shaarli version number, with your repo version. For example, if Shaarli \nv0.8.3\n is released, publish a \nv0.8.3-1\n release, where \nv0.8.3\n states Shaarli compatibility and \n-1\n is your own version digit for the current Shaarli version.\n\n\nuse your own versioning scheme, and state Shaarli compatibility in the release description.\n\n\n\n\nUsing this, any user will be able to pick the release matching his own Shaarli version.\n\n\nMajor bugfix backport releases\n\n\nTo be able to support backported fixes, it recommended to use our workflow:\n\n\n# In master, fix the major bug\ngit commit -m \"Katastrophe\"\ngit push origin master\n# Get your commit hash\ngit log --format=\"%H\" -n 1\n# Create a new branch from your latest release, let's say v0.8.2-1 (the tag name)\ngit checkout -b katastrophe v0.8.2-1\n# Backport the fix commit to your brand new branch\ngit cherry-pick <fix commit hash>\ngit push origin katastrophe\n# Then you just have to make a new release from the `katastrophe` branch tagged `v0.8.3-1`", | ||
| 1276 | "title": "Versioning and Branches" | ||
| 1277 | }, | ||
| 1278 | { | ||
| 1279 | "location": "/Versioning-and-Branches/#master-branch", | ||
| 1280 | "text": "The master branch is the development branch. Any new change MUST go through this branch using Pull Requests. Remarks: This branch shouldn't be used for production as it isn't necessary stable. 3rd party aren't required to be compatible with the latest changes. Official plugins, themes and libraries (contained within Shaarli organization repos) must be compatible with the master branch. The version in this branch is always dev .", | ||
| 1281 | "title": "master branch" | ||
| 1282 | }, | ||
| 1283 | { | ||
| 1284 | "location": "/Versioning-and-Branches/#v0x-branch", | ||
| 1285 | "text": "This v0.x branch, points to the latest v0.x.y release. Explanation: When a new version is released, it might contains a major bug which isn't detected right away. For example, a new PHP version is released, containing backward compatibility issue which doesn't work with Shaarli. In this case, the issue is fixed in the master branch, and the fix is backported the to the v0.x branch. Then a new release is made from the v0.x branch. This workflow allow us to fix any major bug detected, without having to release bleeding edge feature too soon.", | ||
| 1286 | "title": "v0.x branch" | ||
| 1287 | }, | ||
| 1288 | { | ||
| 1289 | "location": "/Versioning-and-Branches/#latest-branch", | ||
| 1290 | "text": "This branch point the latest release. It recommended to use it to get the latest tested changes.", | ||
| 1291 | "title": "latest branch" | ||
| 1292 | }, | ||
| 1293 | { | ||
| 1294 | "location": "/Versioning-and-Branches/#stable-branch", | ||
| 1295 | "text": "The stable branch doesn't contain any major bug, and is one major digit version behind the latest release. For example, the current latest release is v0.8.3 , the stable branch is an alias to the latest v0.7.x release. When the v0.9.0 version will be released, the stable will move to the latest v0.8.x release. Remarks: Shaarli release pace isn't fast, and the stable branch might be a few months behind the latest release.", | ||
| 1296 | "title": "stable branch" | ||
| 1297 | }, | ||
| 1298 | { | ||
| 1299 | "location": "/Versioning-and-Branches/#releases", | ||
| 1300 | "text": "Releases are always made from the latest v0.x branch. Note that for every release, we manually generate a tarball which contains all Shaarli dependencies, making Shaarli's installation only one step.", | ||
| 1301 | "title": "Releases" | ||
| 1302 | }, | ||
| 1303 | { | ||
| 1304 | "location": "/Versioning-and-Branches/#advices-on-3rd-party-git-repos-workflow", | ||
| 1305 | "text": "", | ||
| 1306 | "title": "Advices on 3rd party git repos workflow" | ||
| 1307 | }, | ||
| 1308 | { | ||
| 1309 | "location": "/Versioning-and-Branches/#versioning", | ||
| 1310 | "text": "Any time a new Shaarli release is published, you should publish a new release of your repo if the changes affected you since the latest release (take a look at the changelog ( Draft means not released yet) and the commit log (like tpl folder for themes)). You can either: use the Shaarli version number, with your repo version. For example, if Shaarli v0.8.3 is released, publish a v0.8.3-1 release, where v0.8.3 states Shaarli compatibility and -1 is your own version digit for the current Shaarli version. use your own versioning scheme, and state Shaarli compatibility in the release description. Using this, any user will be able to pick the release matching his own Shaarli version.", | ||
| 1311 | "title": "Versioning" | ||
| 1312 | }, | ||
| 1313 | { | ||
| 1314 | "location": "/Versioning-and-Branches/#major-bugfix-backport-releases", | ||
| 1315 | "text": "To be able to support backported fixes, it recommended to use our workflow: # In master, fix the major bug\ngit commit -m \"Katastrophe\"\ngit push origin master\n# Get your commit hash\ngit log --format=\"%H\" -n 1\n# Create a new branch from your latest release, let's say v0.8.2-1 (the tag name)\ngit checkout -b katastrophe v0.8.2-1\n# Backport the fix commit to your brand new branch\ngit cherry-pick <fix commit hash>\ngit push origin katastrophe\n# Then you just have to make a new release from the `katastrophe` branch tagged `v0.8.3-1`", | ||
| 1316 | "title": "Major bugfix backport releases" | ||
| 1317 | }, | ||
| 1318 | { | ||
| 1319 | "location": "/Security/", | ||
| 1320 | "text": "Client browser\n\n\n\n\nShaarli relies on \nHTTP_REFERER\n for some functions (like redirects and clicking on tags). If you have disabled or masqueraded \nHTTP_REFERER\n in your browser, some features of Shaarli may not work\n\n\n\n\nPHP\n\n\n\n\nmagic_quotes\n is an horrible option of PHP which is often activated on servers. No serious developer should rely on this horror to secure their code against SQL injections. You should disable it (and Shaarli expects this option to be disabled). Nevertheless, I have added code to cope with \nmagic_quotes\n on, so you should not be bothered even on crappy hosts.\n\n\n\n\nServer and sessions\n\n\n\n\nDirectories are protected using \n.htaccess\n files\n\n\nForms are protected against XSRF (Cross-site requests forgery):\n\n\nForms which act on data (save,delete\u2026) contain a token generated by the server.\n\n\nAny posted form which does not contain a valid token is rejected.\n\n\nAny token can only be used once.\n\n\nTokens are attached to the session and cannot be reused in another session.\n\n\nSessions automatically expire after 60 minutes.\n\n\nSessions are protected against hijacking: the session ID cannot be used from a different IP address.\n\n\n\n\nShaarli datastore and configuration\n\n\n\n\nThe password is salted, hashed and stored in the data subdirectory, in a PHP file, and protected by htaccess. Even if the webserver does not support htaccess, the hash is not readable by URL. Even if the .php file is stolen, the password cannot deduced from the hash. The salt prevents rainbow-tables attacks.\n\n\nLinks are stored as an associative array which is serialized, compressed (with deflate), base64-encoded and saved as a comment in a \n.php\n file.\n\n\nEven if the server does not support \n.htaccess\n files, the data file will still not be readable by URL.\n\n\nThe database looks like this:\n\n\n\n\n<?php /* zP1ZjxxJtiYIvvevEPJ2lDOaLrZv7o...\n...ka7gaco/Z+TFXM2i7BlfMf8qxpaSSYfKlvqv/x8= */ ?>\n\n\n\n\n\n\nSmall hashes are used to make a link to an entry in Shaarli. They are unique. In fact, the date of the items (eg. \n20110923_150523\n) is hashed with CRC32, then converted to base64 and some characters are replaced. They are always 6 characters longs and use only \nA-Z a-z 0-9 - _\n and \n@\n.", | ||
| 1321 | "title": "Security" | ||
| 1322 | }, | ||
| 1323 | { | ||
| 1324 | "location": "/Security/#client-browser", | ||
| 1325 | "text": "Shaarli relies on HTTP_REFERER for some functions (like redirects and clicking on tags). If you have disabled or masqueraded HTTP_REFERER in your browser, some features of Shaarli may not work", | ||
| 1326 | "title": "Client browser" | ||
| 1327 | }, | ||
| 1328 | { | ||
| 1329 | "location": "/Security/#php", | ||
| 1330 | "text": "magic_quotes is an horrible option of PHP which is often activated on servers. No serious developer should rely on this horror to secure their code against SQL injections. You should disable it (and Shaarli expects this option to be disabled). Nevertheless, I have added code to cope with magic_quotes on, so you should not be bothered even on crappy hosts.", | ||
| 1331 | "title": "PHP" | ||
| 1332 | }, | ||
| 1333 | { | ||
| 1334 | "location": "/Security/#server-and-sessions", | ||
| 1335 | "text": "Directories are protected using .htaccess files Forms are protected against XSRF (Cross-site requests forgery): Forms which act on data (save,delete\u2026) contain a token generated by the server. Any posted form which does not contain a valid token is rejected. Any token can only be used once. Tokens are attached to the session and cannot be reused in another session. Sessions automatically expire after 60 minutes. Sessions are protected against hijacking: the session ID cannot be used from a different IP address.", | ||
| 1336 | "title": "Server and sessions" | ||
| 1337 | }, | ||
| 1338 | { | ||
| 1339 | "location": "/Security/#shaarli-datastore-and-configuration", | ||
| 1340 | "text": "The password is salted, hashed and stored in the data subdirectory, in a PHP file, and protected by htaccess. Even if the webserver does not support htaccess, the hash is not readable by URL. Even if the .php file is stolen, the password cannot deduced from the hash. The salt prevents rainbow-tables attacks. Links are stored as an associative array which is serialized, compressed (with deflate), base64-encoded and saved as a comment in a .php file. Even if the server does not support .htaccess files, the data file will still not be readable by URL. The database looks like this: <?php /* zP1ZjxxJtiYIvvevEPJ2lDOaLrZv7o...\n...ka7gaco/Z+TFXM2i7BlfMf8qxpaSSYfKlvqv/x8= */ ?> Small hashes are used to make a link to an entry in Shaarli. They are unique. In fact, the date of the items (eg. 20110923_150523 ) is hashed with CRC32, then converted to base64 and some characters are replaced. They are always 6 characters longs and use only A-Z a-z 0-9 - _ and @ .", | ||
| 1341 | "title": "Shaarli datastore and configuration" | ||
| 1342 | }, | ||
| 1343 | { | ||
| 1344 | "location": "/Static-analysis/", | ||
| 1345 | "text": "WIP\n\n\nThis topic is currently being discussed here:\n- \nFix coding style (static analysis)\n (#95)\n- \nContinuous Integration tools & features\n (#130)\n\n\nUsage\n\n\nStatic analysis tools can be installed with Composer, and used through Shaarli's \nMakefile\n.\n\n\nFor an overview of the available features, see:\n- \nCode quality: Makefile to run static code checkers\n (#124)\n- \nRun PHPCS against different coding standards\n (#276)", | ||
| 1346 | "title": "Static analysis" | ||
| 1347 | }, | ||
| 1348 | { | ||
| 1349 | "location": "/Static-analysis/#wip", | ||
| 1350 | "text": "This topic is currently being discussed here:\n- Fix coding style (static analysis) (#95)\n- Continuous Integration tools & features (#130)", | ||
| 1351 | "title": "WIP" | ||
| 1352 | }, | ||
| 1353 | { | ||
| 1354 | "location": "/Static-analysis/#usage", | ||
| 1355 | "text": "Static analysis tools can be installed with Composer, and used through Shaarli's Makefile . For an overview of the available features, see:\n- Code quality: Makefile to run static code checkers (#124)\n- Run PHPCS against different coding standards (#276)", | ||
| 1356 | "title": "Usage" | ||
| 1357 | }, | ||
| 1358 | { | ||
| 1359 | "location": "/Theming/", | ||
| 1360 | "text": "Foreword\n\n\nThere are two ways of customizing how Shaarli looks:\n\n\n\n\nby using a custom CSS to override Shaarli's CSS\n\n\nby using a full theme that provides its own RainTPL templates, CSS and Javascript resources\n\n\n\n\nCustom CSS\n\n\nShaarli's appearance can be modified by adding CSS rules to:\n- Shaarli < \nv0.9.0\n: \ninc/user.css\n\n- Shaarli >= \nv0.9.0\n: \ndata/user.css\n\n\nThis file allows overriding rules defined in the template CSS files (only add changed rules), or define a whole new theme.\n\n\nNote\n: Do not edit \ntpl/default/css/shaarli.css\n! Your changes would be overridden when updating Shaarli.\n\n\nSee also \nDownload CSS styles from an OPML list\n\n\nThemes\n\n\nWARNING - This feature is currently being worked on and will be improved in the next releases. Experimental.\n\n\nInstallation:\n- find a theme you'd like to install\n- copy or clone the theme folder under \ntpl/<a_sweet_theme>\n\n- enable the theme:\n - Shaarli < \nv0.9.0\n: edit \ndata/config.json.php\n and set the value of \nraintpl_tpl\n to the new theme name:\n \n\"raintpl_tpl\": \"tpl\\/my-template\\/\"\n\n - Shaarli >= \nv0.9.0\n: select the theme through the \nTools\n page\n\n\nCommunity CSS & themes\n\n\nCustom CSS\n\n\n\n\nmrjovanovic/serious-theme-shaarli\n - A serious theme for Shaarli\n\n\nshaarli/shaarli-themes\n\n\n\n\nThemes\n\n\n\n\nAkibaTech/Shaarli Superhero Theme\n - A template/theme for Shaarli\n\n\nalexisju/albinomouse-template\n - A full template for Shaarli\n\n\nArthurHoaro/shaarli-launch\n - Customizable Shaarli theme\n\n\ndhoko/ShaarliTemplate\n - A template/theme for Shaarli\n\n\nkalvn/shaarli-blocks\n - A template/theme for Shaarli\n\n\nkalvn/Shaarli-Material\n - A theme (template) based on Google's Material Design for Shaarli, the superfast delicious clone\n\n\nManufacturaInd/shaarli-2004licious-theme\n - A template/theme as a humble homage to the early looks of the del.icio.us site\n\n\n\n\nShaarli forks\n\n\n\n\nmisterair/Limonade\n - A fork of (legacy) Shaarli with a new template\n\n\nvivienhaese/shaarlitheme\n - A Shaarli fork meant to be run in an openshift instance\n\n\n\n\nExample installation: AlbinoMouse theme\n\n\nWith the following configuration:\n- Apache 2 / PHP 5.6\n- user sites are enabled, e.g. \n/home/user/public_html/somedir\n is served as \nhttp://localhost/~user/somedir\n\n- \nhttp\n is the name of the Apache user\n\n\n$ cd ~/public_html\n\n# clone repositories\n$ git clone https://github.com/shaarli/Shaarli.git shaarli\n$ pushd shaarli/tpl\n$ git clone https://github.com/alexisju/albinomouse-template.git\n$ popd\n\n# set access rights for Apache\n$ chgrp -R http shaarli\n$ chmod g+rwx shaarli shaarli/cache shaarli/data shaarli/pagecache shaarli/tmp\n\n\n\n\nGet config written:\n- go to the freshly installed site\n- fill the install form\n- log in to Shaarli\n\n\nEdit Shaarli's \nconfiguration|Shaarli configuration\n:\n\n\n# the file should be owned by Apache, thus not writeable => sudo\n$ sudo sed -i s=tpl=tpl/albinomouse-template=g shaarli/data/config.php", | ||
| 1361 | "title": "Theming" | ||
| 1362 | }, | ||
| 1363 | { | ||
| 1364 | "location": "/Theming/#foreword", | ||
| 1365 | "text": "There are two ways of customizing how Shaarli looks: by using a custom CSS to override Shaarli's CSS by using a full theme that provides its own RainTPL templates, CSS and Javascript resources", | ||
| 1366 | "title": "Foreword" | ||
| 1367 | }, | ||
| 1368 | { | ||
| 1369 | "location": "/Theming/#custom-css", | ||
| 1370 | "text": "Shaarli's appearance can be modified by adding CSS rules to:\n- Shaarli < v0.9.0 : inc/user.css \n- Shaarli >= v0.9.0 : data/user.css This file allows overriding rules defined in the template CSS files (only add changed rules), or define a whole new theme. Note : Do not edit tpl/default/css/shaarli.css ! Your changes would be overridden when updating Shaarli. See also Download CSS styles from an OPML list", | ||
| 1371 | "title": "Custom CSS" | ||
| 1372 | }, | ||
| 1373 | { | ||
| 1374 | "location": "/Theming/#themes", | ||
| 1375 | "text": "WARNING - This feature is currently being worked on and will be improved in the next releases. Experimental. Installation:\n- find a theme you'd like to install\n- copy or clone the theme folder under tpl/<a_sweet_theme> \n- enable the theme:\n - Shaarli < v0.9.0 : edit data/config.json.php and set the value of raintpl_tpl to the new theme name:\n \"raintpl_tpl\": \"tpl\\/my-template\\/\" \n - Shaarli >= v0.9.0 : select the theme through the Tools page", | ||
| 1376 | "title": "Themes" | ||
| 1377 | }, | ||
| 1378 | { | ||
| 1379 | "location": "/Theming/#community-css-themes", | ||
| 1380 | "text": "", | ||
| 1381 | "title": "Community CSS & themes" | ||
| 1382 | }, | ||
| 1383 | { | ||
| 1384 | "location": "/Theming/#custom-css_1", | ||
| 1385 | "text": "mrjovanovic/serious-theme-shaarli - A serious theme for Shaarli shaarli/shaarli-themes", | ||
| 1386 | "title": "Custom CSS" | ||
| 1387 | }, | ||
| 1388 | { | ||
| 1389 | "location": "/Theming/#themes_1", | ||
| 1390 | "text": "AkibaTech/Shaarli Superhero Theme - A template/theme for Shaarli alexisju/albinomouse-template - A full template for Shaarli ArthurHoaro/shaarli-launch - Customizable Shaarli theme dhoko/ShaarliTemplate - A template/theme for Shaarli kalvn/shaarli-blocks - A template/theme for Shaarli kalvn/Shaarli-Material - A theme (template) based on Google's Material Design for Shaarli, the superfast delicious clone ManufacturaInd/shaarli-2004licious-theme - A template/theme as a humble homage to the early looks of the del.icio.us site", | ||
| 1391 | "title": "Themes" | ||
| 1392 | }, | ||
| 1393 | { | ||
| 1394 | "location": "/Theming/#shaarli-forks", | ||
| 1395 | "text": "misterair/Limonade - A fork of (legacy) Shaarli with a new template vivienhaese/shaarlitheme - A Shaarli fork meant to be run in an openshift instance", | ||
| 1396 | "title": "Shaarli forks" | ||
| 1397 | }, | ||
| 1398 | { | ||
| 1399 | "location": "/Theming/#example-installation-albinomouse-theme", | ||
| 1400 | "text": "With the following configuration:\n- Apache 2 / PHP 5.6\n- user sites are enabled, e.g. /home/user/public_html/somedir is served as http://localhost/~user/somedir \n- http is the name of the Apache user $ cd ~/public_html\n\n# clone repositories\n$ git clone https://github.com/shaarli/Shaarli.git shaarli\n$ pushd shaarli/tpl\n$ git clone https://github.com/alexisju/albinomouse-template.git\n$ popd\n\n# set access rights for Apache\n$ chgrp -R http shaarli\n$ chmod g+rwx shaarli shaarli/cache shaarli/data shaarli/pagecache shaarli/tmp Get config written:\n- go to the freshly installed site\n- fill the install form\n- log in to Shaarli Edit Shaarli's configuration|Shaarli configuration : # the file should be owned by Apache, thus not writeable => sudo\n$ sudo sed -i s=tpl=tpl/albinomouse-template=g shaarli/data/config.php", | ||
| 1401 | "title": "Example installation: AlbinoMouse theme" | ||
| 1402 | }, | ||
| 1403 | { | ||
| 1404 | "location": "/Unit-tests/", | ||
| 1405 | "text": "Setup your environment for tests\n\n\nThe framework used is \nPHPUnit\n; it can be installed with \nComposer\n, which is a dependency management tool.\n\n\nRegarding Composer, you can either use:\n\n a system-wide version, e.g. installed through your distro's package manager\n\n a local version, downloadable \nhere\n\n\nSample usage\n\n\n# system-wide version\n$ composer install\n$ composer update\n\n# local version\n$ php composer.phar self-update\n$ php composer.phar install\n$ php composer.phar update\n\n\n\n\nInstall Shaarli dev dependencies\n\n\n$ cd /path/to/shaarli\n$ composer update\n\n\n\n\nInstall and enable Xdebug to generate PHPUnit coverage reports\n\n\nFor Debian-based distros:\n\n\n$ aptitude install php5-xdebug\n\n\n\n\nFor ArchLinux:\n\n\n$ pacman -S xdebug\n\n\n\n\nThen add the following line to \n/etc/php/php.ini\n:\n\n\nzend_extension=xdebug.so\n\n\n\n\nRun unit tests\n\n\nSuccessful test suite:\n\n\n$ make test\n\n-------\nPHPUNIT\n-------\nPHPUnit 4.6.9 by Sebastian Bergmann and contributors.\n\nConfiguration read from /home/virtualtam/public_html/shaarli/phpunit.xml\n\n....................................\n\nTime: 759 ms, Memory: 8.25Mb\n\nOK (36 tests, 65 assertions)\n\n\n\n\nTest suite with failures and errors:\n\n\n$ make test\n-------\nPHPUNIT\n-------\nPHPUnit 4.6.9 by Sebastian Bergmann and contributors.\n\nConfiguration read from /home/virtualtam/public_html/shaarli/phpunit.xml\n\nE..FF...............................\n\nTime: 802 ms, Memory: 8.25Mb\n\nThere was 1 error:\n\n1) LinkDBTest::testConstructLoggedIn\nMissing argument 2 for LinkDB::__construct(), called in /home/virtualtam/public_html/shaarli/tests/Link\\\nDBTest.php on line 79 and defined\n\n/home/virtualtam/public_html/shaarli/application/LinkDB.php:58\n/home/virtualtam/public_html/shaarli/tests/LinkDBTest.php:79\n\n--\n\nThere were 2 failures:\n\n1) LinkDBTest::testCheckDBNew\nFailed asserting that two strings are equal.\n--- Expected\n+++ Actual\n@@ @@\n-'e3edea8ea7bb50be4bcb404df53fbb4546a7156e'\n+'85eab0c610d4f68025f6ed6e6b6b5fabd4b55834'\n\n/home/virtualtam/public_html/shaarli/tests/LinkDBTest.php:121\n\n2) LinkDBTest::testCheckDBLoad\nFailed asserting that two strings are equal.\n--- Expected\n+++ Actual\n@@ @@\n-'e3edea8ea7bb50be4bcb404df53fbb4546a7156e'\n+'85eab0c610d4f68025f6ed6e6b6b5fabd4b55834'\n\n/home/virtualtam/public_html/shaarli/tests/LinkDBTest.php:133\n\nFAILURES!\nTests: 36, Assertions: 63, Errors: 1, Failures: 2.\n\n\n\n\nTest results and coverage\n\n\nBy default, PHPUnit will run all suitable tests found under the \ntests\n directory.\n\n\nEach test has 3 possible outcomes:\n\n \n.\n - success\n\n \nF\n - failure: the test was run but its results are invalid\n * the code does not behave as expected\n * dependencies to external elements: globals, session, cache...\n* \nE\n - error: something went wrong and the tested code has crashed\n * typos in the code, or in the test code\n * dependencies to missing external elements\n\n\nIf Xdebug has been installed and activated, two coverage reports will be generated:\n\n a summary in the console\n\n a detailed HTML report with metrics for tested code\n * to open it in a web browser: \nfirefox coverage/index.html &\n\n\nExecuting specific tests\n\n\nAdd a \n@group\n annotation in a test class or method comment:\n\n\n/**\n * Netscape bookmark import\n * @group WIP\n */\nclass BookmarkImportTest extends PHPUnit_Framework_TestCase\n{\n [...]\n}\n\n\n\n\nTo run all tests annotated with \n@group WIP\n:\n\n\n$ vendor/bin/phpunit --group WIP tests/", | ||
| 1406 | "title": "Unit tests" | ||
| 1407 | }, | ||
| 1408 | { | ||
| 1409 | "location": "/Unit-tests/#setup-your-environment-for-tests", | ||
| 1410 | "text": "The framework used is PHPUnit ; it can be installed with Composer , which is a dependency management tool. Regarding Composer, you can either use: a system-wide version, e.g. installed through your distro's package manager a local version, downloadable here", | ||
| 1411 | "title": "Setup your environment for tests" | ||
| 1412 | }, | ||
| 1413 | { | ||
| 1414 | "location": "/Unit-tests/#sample-usage", | ||
| 1415 | "text": "# system-wide version\n$ composer install\n$ composer update\n\n# local version\n$ php composer.phar self-update\n$ php composer.phar install\n$ php composer.phar update", | ||
| 1416 | "title": "Sample usage" | ||
| 1417 | }, | ||
| 1418 | { | ||
| 1419 | "location": "/Unit-tests/#install-shaarli-dev-dependencies", | ||
| 1420 | "text": "$ cd /path/to/shaarli\n$ composer update", | ||
| 1421 | "title": "Install Shaarli dev dependencies" | ||
| 1422 | }, | ||
| 1423 | { | ||
| 1424 | "location": "/Unit-tests/#install-and-enable-xdebug-to-generate-phpunit-coverage-reports", | ||
| 1425 | "text": "For Debian-based distros: $ aptitude install php5-xdebug For ArchLinux: $ pacman -S xdebug Then add the following line to /etc/php/php.ini : zend_extension=xdebug.so", | ||
| 1426 | "title": "Install and enable Xdebug to generate PHPUnit coverage reports" | ||
| 1427 | }, | ||
| 1428 | { | ||
| 1429 | "location": "/Unit-tests/#run-unit-tests", | ||
| 1430 | "text": "Successful test suite: $ make test\n\n-------\nPHPUNIT\n-------\nPHPUnit 4.6.9 by Sebastian Bergmann and contributors.\n\nConfiguration read from /home/virtualtam/public_html/shaarli/phpunit.xml\n\n....................................\n\nTime: 759 ms, Memory: 8.25Mb\n\nOK (36 tests, 65 assertions) Test suite with failures and errors: $ make test\n-------\nPHPUNIT\n-------\nPHPUnit 4.6.9 by Sebastian Bergmann and contributors.\n\nConfiguration read from /home/virtualtam/public_html/shaarli/phpunit.xml\n\nE..FF...............................\n\nTime: 802 ms, Memory: 8.25Mb\n\nThere was 1 error:\n\n1) LinkDBTest::testConstructLoggedIn\nMissing argument 2 for LinkDB::__construct(), called in /home/virtualtam/public_html/shaarli/tests/Link\\\nDBTest.php on line 79 and defined\n\n/home/virtualtam/public_html/shaarli/application/LinkDB.php:58\n/home/virtualtam/public_html/shaarli/tests/LinkDBTest.php:79\n\n--\n\nThere were 2 failures:\n\n1) LinkDBTest::testCheckDBNew\nFailed asserting that two strings are equal.\n--- Expected\n+++ Actual\n@@ @@\n-'e3edea8ea7bb50be4bcb404df53fbb4546a7156e'\n+'85eab0c610d4f68025f6ed6e6b6b5fabd4b55834'\n\n/home/virtualtam/public_html/shaarli/tests/LinkDBTest.php:121\n\n2) LinkDBTest::testCheckDBLoad\nFailed asserting that two strings are equal.\n--- Expected\n+++ Actual\n@@ @@\n-'e3edea8ea7bb50be4bcb404df53fbb4546a7156e'\n+'85eab0c610d4f68025f6ed6e6b6b5fabd4b55834'\n\n/home/virtualtam/public_html/shaarli/tests/LinkDBTest.php:133\n\nFAILURES!\nTests: 36, Assertions: 63, Errors: 1, Failures: 2.", | ||
| 1431 | "title": "Run unit tests" | ||
| 1432 | }, | ||
| 1433 | { | ||
| 1434 | "location": "/Unit-tests/#test-results-and-coverage", | ||
| 1435 | "text": "By default, PHPUnit will run all suitable tests found under the tests directory. Each test has 3 possible outcomes: . - success F - failure: the test was run but its results are invalid\n * the code does not behave as expected\n * dependencies to external elements: globals, session, cache...\n* E - error: something went wrong and the tested code has crashed\n * typos in the code, or in the test code\n * dependencies to missing external elements If Xdebug has been installed and activated, two coverage reports will be generated: a summary in the console a detailed HTML report with metrics for tested code\n * to open it in a web browser: firefox coverage/index.html &", | ||
| 1436 | "title": "Test results and coverage" | ||
| 1437 | }, | ||
| 1438 | { | ||
| 1439 | "location": "/Unit-tests/#executing-specific-tests", | ||
| 1440 | "text": "Add a @group annotation in a test class or method comment: /**\n * Netscape bookmark import\n * @group WIP\n */\nclass BookmarkImportTest extends PHPUnit_Framework_TestCase\n{\n [...]\n} To run all tests annotated with @group WIP : $ vendor/bin/phpunit --group WIP tests/", | ||
| 1441 | "title": "Executing specific tests" | ||
| 1442 | }, | ||
| 1443 | { | ||
| 1444 | "location": "/FAQ/", | ||
| 1445 | "text": "Why did you create Shaarli ?\n\n\nI was a StumbleUpon user. Then I got fed up with they big toolbar. I switched to delicious, which was lighter, faster and more beautiful. Until Yahoo bought it. Then the export API broke all the time, delicious became slow and was ditched by Yahoo. I switched to Diigo, which is not bad, but does too much. And Diigo is sslllooooowww and their Firefox extension a bit buggy. And\u2026 oh\u2026 \ntheir Firefox addon sends to Diigo every single URL you visit\n (Don't believe me ? Use \nTamper Data\n and open any page).\n\n\nEnough is enough. Saving simple links should not be a complicated heavy thing. I ditched them all and wrote my own: Shaarli. It's simple, but it does the job and does it well. And my data is not hosted on a foreign server, but on my server.\n\n\nWhy use Shaarli and not Delicious/Diigo ?\n\n\nWith Shaarli:\n\n\n\n\nThe data is yours: It's hosted on your server.\n\n\nNever fear of having your data locked-in.\n\n\nNever fear to have your data sold to third party.\n\n\nYour private links are not hosted on a third party server.\n\n\nYou are not tracked by browser addons (like Diigo does)\n\n\nYou can change the look and feel of the pages if you want.\n\n\nYou can change the behaviour of the program.\n\n\nIt's magnitude faster than most bookmarking services.\n\n\n\n\nWhat does Shaarli mean?\n\n\nShaarli is for shaaring your links.\n\n\nMy Shaarli is broken!\n\n\nFirst of all, ensure that both the \nweb server\n and \nShaarli\n are correctly configured, and that your installation is \nsupported\n.\n\n\nIf everything looks right but the issue(s) remain(s), please:\n- take a look at the \ntroubleshooting\n section\n- come \nchat with us\n on Gitter, we'll be happy to help ;-)\n- browse active \nissues\n and \nPull Requests\n\n - if you find one that is related to the issue, feel free to comment and provide additional details (host/Shaarli setup)\n - else, \nopen a new issue\n, and provide information about the problem:\n - \nwhat happens?\n - display glitches, invalid data, security flaws...\n - \nwhat is your configuration?\n - OS, server version, activated extensions, web browser...\n - \nis it reproducible?\n\n\nWhy not use a real database? Files are slow!\n\n\nDoes browsing \nthis page\n feel slow? Try browsing older pages, too.\n\n\nIt's not slow at all, is it? And don't forget the database contains more than 16000 links, and it's on a shared host, with 32000 visitors/day for my website alone. And it's still damn fast. Why?\n\n\nThe data file is only 3.7 Mb. It's read 99% of the time, and is probably already in the operation system disk cache. So generating a page involves no I/O at all most of the time.", | ||
| 1446 | "title": "FAQ" | ||
| 1447 | }, | ||
| 1448 | { | ||
| 1449 | "location": "/FAQ/#why-did-you-create-shaarli", | ||
| 1450 | "text": "I was a StumbleUpon user. Then I got fed up with they big toolbar. I switched to delicious, which was lighter, faster and more beautiful. Until Yahoo bought it. Then the export API broke all the time, delicious became slow and was ditched by Yahoo. I switched to Diigo, which is not bad, but does too much. And Diigo is sslllooooowww and their Firefox extension a bit buggy. And\u2026 oh\u2026 their Firefox addon sends to Diigo every single URL you visit (Don't believe me ? Use Tamper Data and open any page). Enough is enough. Saving simple links should not be a complicated heavy thing. I ditched them all and wrote my own: Shaarli. It's simple, but it does the job and does it well. And my data is not hosted on a foreign server, but on my server.", | ||
| 1451 | "title": "Why did you create Shaarli ?" | ||
| 1452 | }, | ||
| 1453 | { | ||
| 1454 | "location": "/FAQ/#why-use-shaarli-and-not-deliciousdiigo", | ||
| 1455 | "text": "With Shaarli: The data is yours: It's hosted on your server. Never fear of having your data locked-in. Never fear to have your data sold to third party. Your private links are not hosted on a third party server. You are not tracked by browser addons (like Diigo does) You can change the look and feel of the pages if you want. You can change the behaviour of the program. It's magnitude faster than most bookmarking services.", | ||
| 1456 | "title": "Why use Shaarli and not Delicious/Diigo ?" | ||
| 1457 | }, | ||
| 1458 | { | ||
| 1459 | "location": "/FAQ/#what-does-shaarli-mean", | ||
| 1460 | "text": "Shaarli is for shaaring your links.", | ||
| 1461 | "title": "What does Shaarli mean?" | ||
| 1462 | }, | ||
| 1463 | { | ||
| 1464 | "location": "/FAQ/#my-shaarli-is-broken", | ||
| 1465 | "text": "First of all, ensure that both the web server and Shaarli are correctly configured, and that your installation is supported . If everything looks right but the issue(s) remain(s), please:\n- take a look at the troubleshooting section\n- come chat with us on Gitter, we'll be happy to help ;-)\n- browse active issues and Pull Requests \n - if you find one that is related to the issue, feel free to comment and provide additional details (host/Shaarli setup)\n - else, open a new issue , and provide information about the problem:\n - what happens? - display glitches, invalid data, security flaws...\n - what is your configuration? - OS, server version, activated extensions, web browser...\n - is it reproducible?", | ||
| 1466 | "title": "My Shaarli is broken!" | ||
| 1467 | }, | ||
| 1468 | { | ||
| 1469 | "location": "/FAQ/#why-not-use-a-real-database-files-are-slow", | ||
| 1470 | "text": "Does browsing this page feel slow? Try browsing older pages, too. It's not slow at all, is it? And don't forget the database contains more than 16000 links, and it's on a shared host, with 32000 visitors/day for my website alone. And it's still damn fast. Why? The data file is only 3.7 Mb. It's read 99% of the time, and is probably already in the operation system disk cache. So generating a page involves no I/O at all most of the time.", | ||
| 1471 | "title": "Why not use a real database? Files are slow!" | ||
| 1472 | }, | ||
| 1473 | { | ||
| 1474 | "location": "/Community-&-Related-software/", | ||
| 1475 | "text": "Unofficial but related work on Shaarli. If you maintain one of these, please get in touch with us to help us find a way to adapt your work to our fork.\n\n\nTODO: contact repos owners to see if they'd like to standardize their work with the community fork.\n\n\nCommunity\n\n\n\n\nLiens en vrac de sebsauvage\n - the original Shaarli\n\n\nA large list of Shaarlis\n\n\nA list of working Shaarli aggregators\n\n\nA list of some known Shaarlis\n\n\nAdieu Delicious, Diigo et StumbleUpon. Salut Shaarli ! - sebsauvage.net\n (fr) \n16/09/2011 - the original post about Shaarli\n\n\nOriginal ideas/fixme/TODO page\n\n\nOriginal discussion page\n (fr)\n\n\nOriginal revisions history\n\n\nShaarli.fr/my\n - Unofficial, unsupported (old fork) hosted Shaarlis provider, courtesy of \nDMeloni\n\n\n\n\nArticles and social media discussions\n\n\n\n\n2016-09-22 - Hacker News - https://news.ycombinator.com/item?id=12552176\n\n\n2015-08-15 - Reddit - \nQuestion about migrating from WordPress to Shaarli.\n\n\n2015-06-22 - Hacker News - https://news.ycombinator.com/item?id=9755366\n\n\n2015-05-12 - Reddit - \nshaarli - Self hosted Bookmarking / Delicious (PHP, MySQL)\n\n\n\n\nThird party plugins\n\n\n\n\nautosave\n by \n@kalvn\n: Automatically saves data when editing a link to avoid any loss in case of crash or unexpected shutdown.\n\n\nCode Coloration\n by \n@ArthurHoaro\n: client side code syntax highlighter.\n\n\nDisqus\n by \n@kalvn\n: Adds Disqus comment system to your Shaarli.\n\n\nemojione\n by \n@NerosTie\n: Add colorful emojis to your Shaarli.\n\n\ngoogle analytics\n by \n@ericjuden\n: Adds Google Analytics tracking support\n\n\nlaunch\n - Launch Plugin is a plugin designed to enhance and customize Launch Theme for Shaarli.\n\n\nrelated\n by \n@ilesinge\n - Show related links based on the number of identical tags.\n\n\nsocial\n by \n@alexisju\n: share links to social networks.\n\n\nshaarli2twitter\n by \n@ArthurHoaro\n - Automatically tweet your shared links from Shaarli\n\n\n\n\nThemes\n\n\nSee \nTheming\n for the list of community-contributed themes, and an installation guide.\n\n\nServer apps\n\n\n\n\nshaarchiver\n - Archive your Shaarli bookmarks and their content\n\n\nshaarli-river\n - An aggregator for shaarlis with many features \n\n\nShaarlo\n - An aggregator for shaarlis with many features (a very popular running instance among french shaarliers: \nshaarli.fr\n)\n\n\nShaarlimages\n - An image-oriented aggregator for Shaarlis\n\n\nmknexen/shaarli-api\n - A REST API for Shaarli\n\n\nSelf dead link\n - Detect dead links on shaarli. This version use the database of shaarli. \nAnother version\n, can be used for other shaarli instances (but is more resource consuming).\n\n\nBookmark Archiver\n - Save an archived copy of all websites starred using browser bookmarks/Shaarli/Delicious/Instapaper/Unmark.it/Pocket/Pinboard. Outputs browseable html. \n\n\n\n\nMobile Apps\n\n\n\n\nShaarliOS\n iOS share extension - see \n#308\n for some promo codes,\n\n\nShaarli for Android\n - Android application that adds Shaarli as a sharing provider\n\n\nShaarlier for Android\n - Android application to simply add links directly into your Shaarli\n\n\n\n\nIntegration with other platforms\n\n\n\n\ntt-rss-shaarli\n - \nTiny-Tiny RSS\n plugin that adds support for sharing articles with Shaarli\n\n\noctopress-shaarli\n - Octopress plugin to retrieve Shaarli links on the sidebar\n\n\nScuttle to Shaarli\n - Import bookmarks from Scuttle\n\n\n\n\nAlternatives to Shaarli\n\n\nSee the \nbookmarks & link sharing\n section on \nawesome-selfhosted\n.", | ||
| 1476 | "title": "Community & Related software" | ||
| 1477 | }, | ||
| 1478 | { | ||
| 1479 | "location": "/Community-&-Related-software/#community", | ||
| 1480 | "text": "Liens en vrac de sebsauvage - the original Shaarli A large list of Shaarlis A list of working Shaarli aggregators A list of some known Shaarlis Adieu Delicious, Diigo et StumbleUpon. Salut Shaarli ! - sebsauvage.net (fr) 16/09/2011 - the original post about Shaarli Original ideas/fixme/TODO page Original discussion page (fr) Original revisions history Shaarli.fr/my - Unofficial, unsupported (old fork) hosted Shaarlis provider, courtesy of DMeloni", | ||
| 1481 | "title": "Community" | ||
| 1482 | }, | ||
| 1483 | { | ||
| 1484 | "location": "/Community-&-Related-software/#articles-and-social-media-discussions", | ||
| 1485 | "text": "2016-09-22 - Hacker News - https://news.ycombinator.com/item?id=12552176 2015-08-15 - Reddit - Question about migrating from WordPress to Shaarli. 2015-06-22 - Hacker News - https://news.ycombinator.com/item?id=9755366 2015-05-12 - Reddit - shaarli - Self hosted Bookmarking / Delicious (PHP, MySQL)", | ||
| 1486 | "title": "Articles and social media discussions" | ||
| 1487 | }, | ||
| 1488 | { | ||
| 1489 | "location": "/Community-&-Related-software/#third-party-plugins", | ||
| 1490 | "text": "autosave by @kalvn : Automatically saves data when editing a link to avoid any loss in case of crash or unexpected shutdown. Code Coloration by @ArthurHoaro : client side code syntax highlighter. Disqus by @kalvn : Adds Disqus comment system to your Shaarli. emojione by @NerosTie : Add colorful emojis to your Shaarli. google analytics by @ericjuden : Adds Google Analytics tracking support launch - Launch Plugin is a plugin designed to enhance and customize Launch Theme for Shaarli. related by @ilesinge - Show related links based on the number of identical tags. social by @alexisju : share links to social networks. shaarli2twitter by @ArthurHoaro - Automatically tweet your shared links from Shaarli", | ||
| 1491 | "title": "Third party plugins" | ||
| 1492 | }, | ||
| 1493 | { | ||
| 1494 | "location": "/Community-&-Related-software/#themes", | ||
| 1495 | "text": "See Theming for the list of community-contributed themes, and an installation guide.", | ||
| 1496 | "title": "Themes" | ||
| 1497 | }, | ||
| 1498 | { | ||
| 1499 | "location": "/Community-&-Related-software/#server-apps", | ||
| 1500 | "text": "shaarchiver - Archive your Shaarli bookmarks and their content shaarli-river - An aggregator for shaarlis with many features Shaarlo - An aggregator for shaarlis with many features (a very popular running instance among french shaarliers: shaarli.fr ) Shaarlimages - An image-oriented aggregator for Shaarlis mknexen/shaarli-api - A REST API for Shaarli Self dead link - Detect dead links on shaarli. This version use the database of shaarli. Another version , can be used for other shaarli instances (but is more resource consuming). Bookmark Archiver - Save an archived copy of all websites starred using browser bookmarks/Shaarli/Delicious/Instapaper/Unmark.it/Pocket/Pinboard. Outputs browseable html.", | ||
| 1501 | "title": "Server apps" | ||
| 1502 | }, | ||
| 1503 | { | ||
| 1504 | "location": "/Community-&-Related-software/#mobile-apps", | ||
| 1505 | "text": "ShaarliOS iOS share extension - see #308 for some promo codes, Shaarli for Android - Android application that adds Shaarli as a sharing provider Shaarlier for Android - Android application to simply add links directly into your Shaarli", | ||
| 1506 | "title": "Mobile Apps" | ||
| 1507 | }, | ||
| 1508 | { | ||
| 1509 | "location": "/Community-&-Related-software/#integration-with-other-platforms", | ||
| 1510 | "text": "tt-rss-shaarli - Tiny-Tiny RSS plugin that adds support for sharing articles with Shaarli octopress-shaarli - Octopress plugin to retrieve Shaarli links on the sidebar Scuttle to Shaarli - Import bookmarks from Scuttle", | ||
| 1511 | "title": "Integration with other platforms" | ||
| 1512 | }, | ||
| 1513 | { | ||
| 1514 | "location": "/Community-&-Related-software/#alternatives-to-shaarli", | ||
| 1515 | "text": "See the bookmarks & link sharing section on awesome-selfhosted .", | ||
| 1516 | "title": "Alternatives to Shaarli" | ||
| 1517 | } | ||
| 1518 | ] | ||
| 1519 | } \ No newline at end of file | ||
diff --git a/doc/html/search.html b/doc/html/search.html new file mode 100644 index 00000000..b492b8bd --- /dev/null +++ b/doc/html/search.html | |||
| @@ -0,0 +1,324 @@ | |||
| 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>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 src="./js/jquery-2.1.1.min.js"></script> | ||
| 20 | <script src="./js/modernizr-2.8.3.min.js"></script> | ||
| 21 | <script type="text/javascript" src="./js/highlight.pack.js"></script> | ||
| 22 | <script>var base_url = '.';</script> | ||
| 23 | <script data-main="./mkdocs/js/search.js" src="./mkdocs/js/require.js"></script> | ||
| 24 | |||
| 25 | |||
| 26 | </head> | ||
| 27 | |||
| 28 | <body class="wy-body-for-nav" role="document"> | ||
| 29 | |||
| 30 | <div class="wy-grid-for-nav"> | ||
| 31 | |||
| 32 | |||
| 33 | <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> | ||
| 34 | <div class="wy-side-nav-search"> | ||
| 35 | <a href="." class="icon icon-home"> Shaarli Documentation</a> | ||
| 36 | <div role="search"> | ||
| 37 | <form id ="rtd-search-form" class="wy-form" action="./search.html" method="get"> | ||
| 38 | <input type="text" name="q" placeholder="Search docs" /> | ||
| 39 | </form> | ||
| 40 | </div> | ||
| 41 | </div> | ||
| 42 | |||
| 43 | <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> | ||
| 44 | <ul class="current"> | ||
| 45 | |||
| 46 | |||
| 47 | <li class="toctree-l1"> | ||
| 48 | |||
| 49 | <a class="" href=".">Home</a> | ||
| 50 | </li> | ||
| 51 | |||
| 52 | <li class="toctree-l1"> | ||
| 53 | |||
| 54 | <span class="caption-text">Setup</span> | ||
| 55 | <ul class="subnav"> | ||
| 56 | <li class=""> | ||
| 57 | |||
| 58 | <a class="" href="Download-and-Installation/">Download and Installation</a> | ||
| 59 | </li> | ||
| 60 | <li class=""> | ||
| 61 | |||
| 62 | <a class="" href="Upgrade-and-migration/">Upgrade and migration</a> | ||
| 63 | </li> | ||
| 64 | <li class=""> | ||
| 65 | |||
| 66 | <a class="" href="Server-requirements/">Server requirements</a> | ||
| 67 | </li> | ||
| 68 | <li class=""> | ||
| 69 | |||
| 70 | <a class="" href="Server-configuration/">Server configuration</a> | ||
| 71 | </li> | ||
| 72 | <li class=""> | ||
| 73 | |||
| 74 | <a class="" href="Server-security/">Server security</a> | ||
| 75 | </li> | ||
| 76 | <li class=""> | ||
| 77 | |||
| 78 | <a class="" href="Shaarli-configuration/">Shaarli configuration</a> | ||
| 79 | </li> | ||
| 80 | <li class=""> | ||
| 81 | |||
| 82 | <a class="" href="Plugins/">Plugins</a> | ||
| 83 | </li> | ||
| 84 | </ul> | ||
| 85 | </li> | ||
| 86 | |||
| 87 | <li class="toctree-l1"> | ||
| 88 | |||
| 89 | <span class="caption-text">Docker</span> | ||
| 90 | <ul class="subnav"> | ||
| 91 | <li class=""> | ||
| 92 | |||
| 93 | <a class="" href="Docker-101/">Docker 101</a> | ||
| 94 | </li> | ||
| 95 | <li class=""> | ||
| 96 | |||
| 97 | <a class="" href="Shaarli-images/">Shaarli images</a> | ||
| 98 | </li> | ||
| 99 | <li class=""> | ||
| 100 | |||
| 101 | <a class="" href="Reverse-proxy-configuration/">Reverse proxy configuration</a> | ||
| 102 | </li> | ||
| 103 | <li class=""> | ||
| 104 | |||
| 105 | <a class="" href="Docker-resources/">Docker resources</a> | ||
| 106 | </li> | ||
| 107 | </ul> | ||
| 108 | </li> | ||
| 109 | |||
| 110 | <li class="toctree-l1"> | ||
| 111 | |||
| 112 | <span class="caption-text">Usage</span> | ||
| 113 | <ul class="subnav"> | ||
| 114 | <li class=""> | ||
| 115 | |||
| 116 | <a class="" href="Features/">Features</a> | ||
| 117 | </li> | ||
| 118 | <li class=""> | ||
| 119 | |||
| 120 | <a class="" href="Bookmarklet/">Bookmarklet</a> | ||
| 121 | </li> | ||
| 122 | <li class=""> | ||
| 123 | |||
| 124 | <a class="" href="Browsing-and-searching/">Browsing and searching</a> | ||
| 125 | </li> | ||
| 126 | <li class=""> | ||
| 127 | |||
| 128 | <a class="" href="Firefox-share/">Firefox share</a> | ||
| 129 | </li> | ||
| 130 | <li class=""> | ||
| 131 | |||
| 132 | <a class="" href="RSS-feeds/">RSS feeds</a> | ||
| 133 | </li> | ||
| 134 | <li class=""> | ||
| 135 | |||
| 136 | <a class="" href="REST-API/">REST API</a> | ||
| 137 | </li> | ||
| 138 | </ul> | ||
| 139 | </li> | ||
| 140 | |||
| 141 | <li class="toctree-l1"> | ||
| 142 | |||
| 143 | <span class="caption-text">How To</span> | ||
| 144 | <ul class="subnav"> | ||
| 145 | <li class=""> | ||
| 146 | |||
| 147 | <a class="" href="Backup,-restore,-import-and-export/">Backup, restore, import and export</a> | ||
| 148 | </li> | ||
| 149 | <li class=""> | ||
| 150 | |||
| 151 | <a class="" href="Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
| 152 | </li> | ||
| 153 | <li class=""> | ||
| 154 | |||
| 155 | <a class="" href="Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
| 156 | </li> | ||
| 157 | <li class=""> | ||
| 158 | |||
| 159 | <a class="" href="Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
| 160 | </li> | ||
| 161 | <li class=""> | ||
| 162 | |||
| 163 | <a class="" href="Datastore-hacks/">Datastore hacks</a> | ||
| 164 | </li> | ||
| 165 | </ul> | ||
| 166 | </li> | ||
| 167 | |||
| 168 | <li class="toctree-l1"> | ||
| 169 | |||
| 170 | <a class="" href="Troubleshooting/">Troubleshooting</a> | ||
| 171 | </li> | ||
| 172 | |||
| 173 | <li class="toctree-l1"> | ||
| 174 | |||
| 175 | <span class="caption-text">Development</span> | ||
| 176 | <ul class="subnav"> | ||
| 177 | <li class=""> | ||
| 178 | |||
| 179 | <a class="" href="Development-guidelines/">Development guidelines</a> | ||
| 180 | </li> | ||
| 181 | <li class=""> | ||
| 182 | |||
| 183 | <a class="" href="Continuous-integration-tools/">Continuous integration tools</a> | ||
| 184 | </li> | ||
| 185 | <li class=""> | ||
| 186 | |||
| 187 | <a class="" href="GnuPG-signature/">GnuPG signature</a> | ||
| 188 | </li> | ||
| 189 | <li class=""> | ||
| 190 | |||
| 191 | <a class="" href="Coding-guidelines/">Coding guidelines</a> | ||
| 192 | </li> | ||
| 193 | <li class=""> | ||
| 194 | |||
| 195 | <a class="" href="Directory-structure/">Directory structure</a> | ||
| 196 | </li> | ||
| 197 | <li class=""> | ||
| 198 | |||
| 199 | <a class="" href="3rd-party-libraries/">3rd party libraries</a> | ||
| 200 | </li> | ||
| 201 | <li class=""> | ||
| 202 | |||
| 203 | <a class="" href="Plugin-System/">Plugin System</a> | ||
| 204 | </li> | ||
| 205 | <li class=""> | ||
| 206 | |||
| 207 | <a class="" href="Release-Shaarli/">Release Shaarli</a> | ||
| 208 | </li> | ||
| 209 | <li class=""> | ||
| 210 | |||
| 211 | <a class="" href="Versioning-and-Branches/">Versioning and Branches</a> | ||
| 212 | </li> | ||
| 213 | <li class=""> | ||
| 214 | |||
| 215 | <a class="" href="Security/">Security</a> | ||
| 216 | </li> | ||
| 217 | <li class=""> | ||
| 218 | |||
| 219 | <a class="" href="Static-analysis/">Static analysis</a> | ||
| 220 | </li> | ||
| 221 | <li class=""> | ||
| 222 | |||
| 223 | <a class="" href="Theming/">Theming</a> | ||
| 224 | </li> | ||
| 225 | <li class=""> | ||
| 226 | |||
| 227 | <a class="" href="Unit-tests/">Unit tests</a> | ||
| 228 | </li> | ||
| 229 | </ul> | ||
| 230 | </li> | ||
| 231 | |||
| 232 | <li class="toctree-l1"> | ||
| 233 | |||
| 234 | <span class="caption-text">About</span> | ||
| 235 | <ul class="subnav"> | ||
| 236 | <li class=""> | ||
| 237 | |||
| 238 | <a class="" href="FAQ/">FAQ</a> | ||
| 239 | </li> | ||
| 240 | <li class=""> | ||
| 241 | |||
| 242 | <a class="" href="Community-&-Related-software/">Community & Related software</a> | ||
| 243 | </li> | ||
| 244 | </ul> | ||
| 245 | </li> | ||
| 246 | |||
| 247 | </ul> | ||
| 248 | </div> | ||
| 249 | | ||
| 250 | </nav> | ||
| 251 | |||
| 252 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| 253 | |||
| 254 | |||
| 255 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| 256 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| 257 | <a href=".">Shaarli Documentation</a> | ||
| 258 | </nav> | ||
| 259 | |||
| 260 | |||
| 261 | <div class="wy-nav-content"> | ||
| 262 | <div class="rst-content"> | ||
| 263 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| 264 | <ul class="wy-breadcrumbs"> | ||
| 265 | <li><a href=".">Docs</a> »</li> | ||
| 266 | |||
| 267 | |||
| 268 | <li class="wy-breadcrumbs-aside"> | ||
| 269 | |||
| 270 | </li> | ||
| 271 | </ul> | ||
| 272 | <hr/> | ||
| 273 | </div> | ||
| 274 | <div role="main"> | ||
| 275 | <div class="section"> | ||
| 276 | |||
| 277 | |||
| 278 | <h1 id="search">Search Results</h1> | ||
| 279 | |||
| 280 | <form id="content_search" action="search.html"> | ||
| 281 | <span role="status" aria-live="polite" class="ui-helper-hidden-accessible"></span> | ||
| 282 | <input name="q" id="mkdocs-search-query" type="text" class="search_input search-query ui-autocomplete-input" placeholder="Search the Docs" autocomplete="off" autofocus> | ||
| 283 | </form> | ||
| 284 | |||
| 285 | <div id="mkdocs-search-results" class="search-results"> | ||
| 286 | Searching... | ||
| 287 | </div> | ||
| 288 | |||
| 289 | |||
| 290 | </div> | ||
| 291 | </div> | ||
| 292 | <footer> | ||
| 293 | |||
| 294 | |||
| 295 | <hr/> | ||
| 296 | |||
| 297 | <div role="contentinfo"> | ||
| 298 | <!-- Copyright etc --> | ||
| 299 | |||
| 300 | </div> | ||
| 301 | |||
| 302 | 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>. | ||
| 303 | </footer> | ||
| 304 | |||
| 305 | </div> | ||
| 306 | </div> | ||
| 307 | |||
| 308 | </section> | ||
| 309 | |||
| 310 | </div> | ||
| 311 | |||
| 312 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
| 313 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| 314 | |||
| 315 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
| 316 | |||
| 317 | |||
| 318 | |||
| 319 | </span> | ||
| 320 | </div> | ||
| 321 | <script src="./js/theme.js"></script> | ||
| 322 | |||
| 323 | </body> | ||
| 324 | </html> | ||
diff --git a/doc/html/sitemap.xml b/doc/html/sitemap.xml new file mode 100644 index 00000000..534f02b5 --- /dev/null +++ b/doc/html/sitemap.xml | |||
| @@ -0,0 +1,266 @@ | |||
| 1 | <?xml version="1.0" encoding="UTF-8"?> | ||
| 2 | <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"> | ||
| 3 | |||
| 4 | |||
| 5 | <url> | ||
| 6 | <loc>/</loc> | ||
| 7 | <lastmod>2017-06-18</lastmod> | ||
| 8 | <changefreq>daily</changefreq> | ||
| 9 | </url> | ||
| 10 | |||
| 11 | |||
| 12 | |||
| 13 | |||
| 14 | <url> | ||
| 15 | <loc>/Download-and-Installation/</loc> | ||
| 16 | <lastmod>2017-06-18</lastmod> | ||
| 17 | <changefreq>daily</changefreq> | ||
| 18 | </url> | ||
| 19 | |||
| 20 | <url> | ||
| 21 | <loc>/Upgrade-and-migration/</loc> | ||
| 22 | <lastmod>2017-06-18</lastmod> | ||
| 23 | <changefreq>daily</changefreq> | ||
| 24 | </url> | ||
| 25 | |||
| 26 | <url> | ||
| 27 | <loc>/Server-requirements/</loc> | ||
| 28 | <lastmod>2017-06-18</lastmod> | ||
| 29 | <changefreq>daily</changefreq> | ||
| 30 | </url> | ||
| 31 | |||
| 32 | <url> | ||
| 33 | <loc>/Server-configuration/</loc> | ||
| 34 | <lastmod>2017-06-18</lastmod> | ||
| 35 | <changefreq>daily</changefreq> | ||
| 36 | </url> | ||
| 37 | |||
| 38 | <url> | ||
| 39 | <loc>/Server-security/</loc> | ||
| 40 | <lastmod>2017-06-18</lastmod> | ||
| 41 | <changefreq>daily</changefreq> | ||
| 42 | </url> | ||
| 43 | |||
| 44 | <url> | ||
| 45 | <loc>/Shaarli-configuration/</loc> | ||
| 46 | <lastmod>2017-06-18</lastmod> | ||
| 47 | <changefreq>daily</changefreq> | ||
| 48 | </url> | ||
| 49 | |||
| 50 | <url> | ||
| 51 | <loc>/Plugins/</loc> | ||
| 52 | <lastmod>2017-06-18</lastmod> | ||
| 53 | <changefreq>daily</changefreq> | ||
| 54 | </url> | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | <url> | ||
| 61 | <loc>/Docker-101/</loc> | ||
| 62 | <lastmod>2017-06-18</lastmod> | ||
| 63 | <changefreq>daily</changefreq> | ||
| 64 | </url> | ||
| 65 | |||
| 66 | <url> | ||
| 67 | <loc>/Shaarli-images/</loc> | ||
| 68 | <lastmod>2017-06-18</lastmod> | ||
| 69 | <changefreq>daily</changefreq> | ||
| 70 | </url> | ||
| 71 | |||
| 72 | <url> | ||
| 73 | <loc>/Reverse-proxy-configuration/</loc> | ||
| 74 | <lastmod>2017-06-18</lastmod> | ||
| 75 | <changefreq>daily</changefreq> | ||
| 76 | </url> | ||
| 77 | |||
| 78 | <url> | ||
| 79 | <loc>/Docker-resources/</loc> | ||
| 80 | <lastmod>2017-06-18</lastmod> | ||
| 81 | <changefreq>daily</changefreq> | ||
| 82 | </url> | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | <url> | ||
| 89 | <loc>/Features/</loc> | ||
| 90 | <lastmod>2017-06-18</lastmod> | ||
| 91 | <changefreq>daily</changefreq> | ||
| 92 | </url> | ||
| 93 | |||
| 94 | <url> | ||
| 95 | <loc>/Bookmarklet/</loc> | ||
| 96 | <lastmod>2017-06-18</lastmod> | ||
| 97 | <changefreq>daily</changefreq> | ||
| 98 | </url> | ||
| 99 | |||
| 100 | <url> | ||
| 101 | <loc>/Browsing-and-searching/</loc> | ||
| 102 | <lastmod>2017-06-18</lastmod> | ||
| 103 | <changefreq>daily</changefreq> | ||
| 104 | </url> | ||
| 105 | |||
| 106 | <url> | ||
| 107 | <loc>/Firefox-share/</loc> | ||
| 108 | <lastmod>2017-06-18</lastmod> | ||
| 109 | <changefreq>daily</changefreq> | ||
| 110 | </url> | ||
| 111 | |||
| 112 | <url> | ||
| 113 | <loc>/RSS-feeds/</loc> | ||
| 114 | <lastmod>2017-06-18</lastmod> | ||
| 115 | <changefreq>daily</changefreq> | ||
| 116 | </url> | ||
| 117 | |||
| 118 | <url> | ||
| 119 | <loc>/REST-API/</loc> | ||
| 120 | <lastmod>2017-06-18</lastmod> | ||
| 121 | <changefreq>daily</changefreq> | ||
| 122 | </url> | ||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | <url> | ||
| 129 | <loc>/Backup,-restore,-import-and-export/</loc> | ||
| 130 | <lastmod>2017-06-18</lastmod> | ||
| 131 | <changefreq>daily</changefreq> | ||
| 132 | </url> | ||
| 133 | |||
| 134 | <url> | ||
| 135 | <loc>/Copy-an-existing-installation-over-SSH-and-serve-it-locally/</loc> | ||
| 136 | <lastmod>2017-06-18</lastmod> | ||
| 137 | <changefreq>daily</changefreq> | ||
| 138 | </url> | ||
| 139 | |||
| 140 | <url> | ||
| 141 | <loc>/Create-and-serve-multiple-Shaarlis-(farm)/</loc> | ||
| 142 | <lastmod>2017-06-18</lastmod> | ||
| 143 | <changefreq>daily</changefreq> | ||
| 144 | </url> | ||
| 145 | |||
| 146 | <url> | ||
| 147 | <loc>/Download-CSS-styles-from-an-OPML-list/</loc> | ||
| 148 | <lastmod>2017-06-18</lastmod> | ||
| 149 | <changefreq>daily</changefreq> | ||
| 150 | </url> | ||
| 151 | |||
| 152 | <url> | ||
| 153 | <loc>/Datastore-hacks/</loc> | ||
| 154 | <lastmod>2017-06-18</lastmod> | ||
| 155 | <changefreq>daily</changefreq> | ||
| 156 | </url> | ||
| 157 | |||
| 158 | |||
| 159 | |||
| 160 | |||
| 161 | <url> | ||
| 162 | <loc>/Troubleshooting/</loc> | ||
| 163 | <lastmod>2017-06-18</lastmod> | ||
| 164 | <changefreq>daily</changefreq> | ||
| 165 | </url> | ||
| 166 | |||
| 167 | |||
| 168 | |||
| 169 | |||
| 170 | <url> | ||
| 171 | <loc>/Development-guidelines/</loc> | ||
| 172 | <lastmod>2017-06-18</lastmod> | ||
| 173 | <changefreq>daily</changefreq> | ||
| 174 | </url> | ||
| 175 | |||
| 176 | <url> | ||
| 177 | <loc>/Continuous-integration-tools/</loc> | ||
| 178 | <lastmod>2017-06-18</lastmod> | ||
| 179 | <changefreq>daily</changefreq> | ||
| 180 | </url> | ||
| 181 | |||
| 182 | <url> | ||
| 183 | <loc>/GnuPG-signature/</loc> | ||
| 184 | <lastmod>2017-06-18</lastmod> | ||
| 185 | <changefreq>daily</changefreq> | ||
| 186 | </url> | ||
| 187 | |||
| 188 | <url> | ||
| 189 | <loc>/Coding-guidelines/</loc> | ||
| 190 | <lastmod>2017-06-18</lastmod> | ||
| 191 | <changefreq>daily</changefreq> | ||
| 192 | </url> | ||
| 193 | |||
| 194 | <url> | ||
| 195 | <loc>/Directory-structure/</loc> | ||
| 196 | <lastmod>2017-06-18</lastmod> | ||
| 197 | <changefreq>daily</changefreq> | ||
| 198 | </url> | ||
| 199 | |||
| 200 | <url> | ||
| 201 | <loc>/3rd-party-libraries/</loc> | ||
| 202 | <lastmod>2017-06-18</lastmod> | ||
| 203 | <changefreq>daily</changefreq> | ||
| 204 | </url> | ||
| 205 | |||
| 206 | <url> | ||
| 207 | <loc>/Plugin-System/</loc> | ||
| 208 | <lastmod>2017-06-18</lastmod> | ||
| 209 | <changefreq>daily</changefreq> | ||
| 210 | </url> | ||
| 211 | |||
| 212 | <url> | ||
| 213 | <loc>/Release-Shaarli/</loc> | ||
| 214 | <lastmod>2017-06-18</lastmod> | ||
| 215 | <changefreq>daily</changefreq> | ||
| 216 | </url> | ||
| 217 | |||
| 218 | <url> | ||
| 219 | <loc>/Versioning-and-Branches/</loc> | ||
| 220 | <lastmod>2017-06-18</lastmod> | ||
| 221 | <changefreq>daily</changefreq> | ||
| 222 | </url> | ||
| 223 | |||
| 224 | <url> | ||
| 225 | <loc>/Security/</loc> | ||
| 226 | <lastmod>2017-06-18</lastmod> | ||
| 227 | <changefreq>daily</changefreq> | ||
| 228 | </url> | ||
| 229 | |||
| 230 | <url> | ||
| 231 | <loc>/Static-analysis/</loc> | ||
| 232 | <lastmod>2017-06-18</lastmod> | ||
| 233 | <changefreq>daily</changefreq> | ||
| 234 | </url> | ||
| 235 | |||
| 236 | <url> | ||
| 237 | <loc>/Theming/</loc> | ||
| 238 | <lastmod>2017-06-18</lastmod> | ||
| 239 | <changefreq>daily</changefreq> | ||
| 240 | </url> | ||
| 241 | |||
| 242 | <url> | ||
| 243 | <loc>/Unit-tests/</loc> | ||
| 244 | <lastmod>2017-06-18</lastmod> | ||
| 245 | <changefreq>daily</changefreq> | ||
| 246 | </url> | ||
| 247 | |||
| 248 | |||
| 249 | |||
| 250 | |||
| 251 | |||
| 252 | <url> | ||
| 253 | <loc>/FAQ/</loc> | ||
| 254 | <lastmod>2017-06-18</lastmod> | ||
| 255 | <changefreq>daily</changefreq> | ||
| 256 | </url> | ||
| 257 | |||
| 258 | <url> | ||
| 259 | <loc>/Community-&-Related-software/</loc> | ||
| 260 | <lastmod>2017-06-18</lastmod> | ||
| 261 | <changefreq>daily</changefreq> | ||
| 262 | </url> | ||
| 263 | |||
| 264 | |||
| 265 | |||
| 266 | </urlset> \ No newline at end of file | ||
diff --git a/doc/3rd-party-libraries.md b/doc/md/3rd-party-libraries.md index e6370549..ebab7a46 100644 --- a/doc/3rd-party-libraries.md +++ b/doc/md/3rd-party-libraries.md | |||
| @@ -1,14 +1,13 @@ | |||
| 1 | #3rd party libraries | ||
| 2 | ## CSS | 1 | ## CSS |
| 3 | - Yahoo UI [CSS Reset](http://yuilibrary.com/yui/docs/cssreset/)[](.html) | 2 | - Yahoo UI [CSS Reset](http://yuilibrary.com/yui/docs/cssreset/) |
| 4 | - resets default CSS properties for all HTML elements (overriding browsers' default values) | 3 | - resets default CSS properties for all HTML elements (overriding browsers' default values) |
| 5 | - ensures custom CSS stylessheets will provide the same results on all browsers | 4 | - ensures custom CSS stylessheets will provide the same results on all browsers |
| 6 | 5 | ||
| 7 | ## Javascript | 6 | ## Javascript |
| 8 | - [Awesomeplete](https://leaverou.github.io/awesomplete/) ([GitHub](https://github.com/LeaVerou/awesomplete)) - autocompletion in input forms[](.html) | 7 | - [Awesomeplete](https://leaverou.github.io/awesomplete/) ([GitHub](https://github.com/LeaVerou/awesomplete)) - autocompletion in input forms |
| 9 | - [bLazy](http://dinbror.dk/blazy/) ([GitHub](https://github.com/dinbror/blazy)) - lazy loading for thumbnails[](.html) | 8 | - [bLazy](http://dinbror.dk/blazy/) ([GitHub](https://github.com/dinbror/blazy)) - lazy loading for thumbnails |
| 10 | - [qr.js](http://neocotic.com/qr.js/) ([GitHub](https://github.com/neocotic/qr.js)) - QR code generation[](.html) | 9 | - [qr.js](http://neocotic.com/qr.js/) ([GitHub](https://github.com/neocotic/qr.js)) - QR code generation |
| 11 | 10 | ||
| 12 | ## PHP | 11 | ## PHP |
| 13 | - [shaarli/netscape-bookmark-parser](https://github.com/shaarli/netscape-bookmark-parser) - Netscape bookmark parser[](.html) | 12 | - [shaarli/netscape-bookmark-parser](https://github.com/shaarli/netscape-bookmark-parser) - Netscape bookmark parser |
| 14 | - [RainTPL](https://github.com/rainphp/raintpl) - HTML templating for PHP[](.html) | 13 | - [RainTPL](https://github.com/rainphp/raintpl) - HTML templating for PHP |
diff --git a/doc/Backup,-restore,-import-and-export.md b/doc/md/Backup,-restore,-import-and-export.md index 9f5598ef..d3252226 100644 --- a/doc/Backup,-restore,-import-and-export.md +++ b/doc/md/Backup,-restore,-import-and-export.md | |||
| @@ -1,9 +1,8 @@ | |||
| 1 | #Backup, restore, import and export | ||
| 2 | * [Backup and restore the datastore file](#backup-and-restore-the-datastore-file)[](.html) | ||
| 3 | * [Export links as...](#export-links-as)[](.html) | ||
| 4 | * [Import links from...](#import-links-from)[](.html) | ||
| 5 | * [Import Shaarli links to Firefox](#import-shaarli-links-to-firefox)[](.html) | ||
| 6 | 1 | ||
| 2 | * [Backup and restore the datastore file](#backup-and-restore-the-datastore-file) | ||
| 3 | * [Export links as...](#export-links-as) | ||
| 4 | * [Import links from...](#import-links-from) | ||
| 5 | * [Import Shaarli links to Firefox](#import-shaarli-links-to-firefox) | ||
| 7 | 6 | ||
| 8 | ---------------------- | 7 | ---------------------- |
| 9 | 8 | ||
| @@ -24,7 +23,7 @@ To export links as an HTML file, under _Tools > Export_, choose: | |||
| 24 | - _Export private_ to export private links only | 23 | - _Export private_ to export private links only |
| 25 | 24 | ||
| 26 | Restore by using the `Import` feature. | 25 | Restore by using the `Import` feature. |
| 27 | * This can be done using the [shaarchiver](https://github.com/nodiscc/shaarchiver) tool.[](.html) | 26 | * This can be done using the [shaarchiver](https://github.com/nodiscc/shaarchiver) tool. |
| 28 | 27 | ||
| 29 | Example command: | 28 | Example command: |
| 30 | ```bash | 29 | ```bash |
| @@ -33,23 +32,21 @@ Example command: | |||
| 33 | 32 | ||
| 34 | ## Import links from... | 33 | ## Import links from... |
| 35 | 34 | ||
| 36 | |||
| 37 | ### Diigo | 35 | ### Diigo |
| 38 | 36 | ||
| 39 | If you export your bookmark from Diigo, make sure you use the Delicious export, not the Netscape export. (Their Netscape export is broken, and they don't seem to be interested in fixing it.) | 37 | If you export your bookmark from Diigo, make sure you use the Delicious export, not the Netscape export. (Their Netscape export is broken, and they don't seem to be interested in fixing it.) |
| 40 | 38 | ||
| 41 | |||
| 42 | ### Mister Wong | 39 | ### Mister Wong |
| 43 | 40 | ||
| 44 | See [this issue](https://github.com/sebsauvage/Shaarli/issues/146) for import tweaks.[](.html) | 41 | See [this issue](https://github.com/sebsauvage/Shaarli/issues/146) for import tweaks. |
| 45 | 42 | ||
| 46 | ### SemanticScuttle | 43 | ### SemanticScuttle |
| 47 | 44 | ||
| 48 | To correctly import the tags from a [SemanticScuttle](http://semanticscuttle.sourceforge.net/) HTML export, edit the HTML file before importing and replace all occurences of `tags=` (lowercase) to `TAGS=` (uppercase).[](.html) | 45 | To correctly import the tags from a [SemanticScuttle](http://semanticscuttle.sourceforge.net/) HTML export, edit the HTML file before importing and replace all occurences of `tags=` (lowercase) to `TAGS=` (uppercase). |
| 49 | 46 | ||
| 50 | ### Scuttle | 47 | ### Scuttle |
| 51 | 48 | ||
| 52 | Shaarli cannot import data directly from [Scuttle](https://github.com/scronide/scuttle). However, you can use this third party tool: https://github.com/q2apro/scuttle-to-shaarli to export the Scuttle database to the Netscape HTML format compatible with the Shaarli importer.[](.html) | 49 | Shaarli cannot import data directly from [Scuttle](https://github.com/scronide/scuttle). However, you can use this third party tool: https://github.com/q2apro/scuttle-to-shaarli to export the Scuttle database to the Netscape HTML format compatible with the Shaarli importer. |
| 53 | 50 | ||
| 54 | ## Import Shaarli links to Firefox | 51 | ## Import Shaarli links to Firefox |
| 55 | 52 | ||
| @@ -62,5 +59,5 @@ Your bookmarks will be imported in Firefox, ready to use, with tags and descript | |||
| 62 | 59 | ||
| 63 | You may be interested in these Firefox addons to manage links imported from Shaarli | 60 | You may be interested in these Firefox addons to manage links imported from Shaarli |
| 64 | 61 | ||
| 65 | * [Bookmark Deduplicator](https://addons.mozilla.org/en-US/firefox/addon/bookmark-deduplicator/) - provides an easy way to deduplicate your bookmarks[](.html) | 62 | * [Bookmark Deduplicator](https://addons.mozilla.org/en-US/firefox/addon/bookmark-deduplicator/) - provides an easy way to deduplicate your bookmarks |
| 66 | * [TagSieve](https://addons.mozilla.org/en-US/firefox/addon/tagsieve/) - browse your bookmarks by their tags[](.html) | 63 | * [TagSieve](https://addons.mozilla.org/en-US/firefox/addon/tagsieve/) - browse your bookmarks by their tags |
diff --git a/doc/Sharing-button.md b/doc/md/Bookmarklet.md index e4388863..265ced44 100644 --- a/doc/Sharing-button.md +++ b/doc/md/Bookmarklet.md | |||
| @@ -1,4 +1,3 @@ | |||
| 1 | #Sharing button | ||
| 2 | ### Add the sharing button (_bookmarklet_) to your browser | 1 | ### Add the sharing button (_bookmarklet_) to your browser |
| 3 | 2 | ||
| 4 | * Open your Shaarli and `Login` | 3 | * Open your Shaarli and `Login` |
| @@ -7,14 +6,14 @@ | |||
| 7 | 6 | ||
| 8 | _This bookmarklet button is compatible with Firefox, Opera, Chrome and Safari. Under Opera, you can't drag'n drop the button: You have to right-click on it and add a bookmark to your personal toolbar._ | 7 | _This bookmarklet button is compatible with Firefox, Opera, Chrome and Safari. Under Opera, you can't drag'n drop the button: You have to right-click on it and add a bookmark to your personal toolbar._ |
| 9 | 8 | ||
| 10 | .html) | 9 |  |
| 11 | 10 | ||
| 12 | ### Share links using the _bookmarklet_ | 11 | ### Share links using the _bookmarklet_ |
| 13 | 12 | ||
| 14 | * When you are visiting a webpage you would like to share with Shaarli, click the _bookmarklet_ you just added. | 13 | * When you are visiting a webpage you would like to share with Shaarli, click the _bookmarklet_ you just added. |
| 15 | * A window opens. | 14 | * A window opens. |
| 16 | * You can freely edit title, description, tags... to find it later using the text search or tag filtering. | 15 | * You can freely edit title, description, tags... to find it later using the text search or tag filtering. |
| 17 | * You will be able to edit this link later using the -edit-button..html) | 16 | * You will be able to edit this link later using the  edit button. |
| 18 | * You can also check the “Private” box so that the link is saved but only visible to you. | 17 | * You can also check the “Private” box so that the link is saved but only visible to you. |
| 19 | * Click `Save`.**Voilà! Your link is now shared.** | 18 | * Click `Save`.**Voilà! Your link is now shared.** |
| 20 | 19 | ||
| @@ -22,7 +21,7 @@ _This bookmarklet button is compatible with Firefox, Opera, Chrome and Safari. U | |||
| 22 | 21 | ||
| 23 | Websites which enforce Content Security Policy (CSP), such as github.com, disallow usage of bookmarklets. Unfortunatly, there is nothing Shaarli can do about it. | 22 | Websites which enforce Content Security Policy (CSP), such as github.com, disallow usage of bookmarklets. Unfortunatly, there is nothing Shaarli can do about it. |
| 24 | 23 | ||
| 25 | See [#196](https://github.com/shaarli/Shaarli#196).[](.html) | 24 | See [#196](https://github.com/shaarli/Shaarli#196). |
| 26 | 25 | ||
| 27 | There is an open bug for both Firefox and Chromium: | 26 | There is an open bug for both Firefox and Chromium: |
| 28 | 27 | ||
diff --git a/doc/Browsing-and-searching.md b/doc/md/Browsing-and-searching.md index 854b6b60..ad62c2f0 100644 --- a/doc/Browsing-and-searching.md +++ b/doc/md/Browsing-and-searching.md | |||
| @@ -1,8 +1,3 @@ | |||
| 1 | #Browsing and searching | ||
| 2 | # Browsing and Searching | ||
| 3 | |||
| 4 | .html) | ||
| 5 | |||
| 6 | ## Plain text search | 1 | ## Plain text search |
| 7 | 2 | ||
| 8 | Use the `Search text` field to search in _any_ of the fields of all links (Title, URL, Description...) | 3 | Use the `Search text` field to search in _any_ of the fields of all links (Title, URL, Description...) |
| @@ -25,4 +20,4 @@ To search for links that are not tagged, enter `""` in the tag search field. | |||
| 25 | 20 | ||
| 26 | ## Filtering RSS feeds/Picture wall | 21 | ## Filtering RSS feeds/Picture wall |
| 27 | 22 | ||
| 28 | RSS feeds can also be restricted to only return items matching a text/tag search: see [RSS feeds](RSS-feeds.html). | 23 | RSS feeds can also be restricted to only return items matching a text/tag search: see [[RSS feeds]]. |
diff --git a/doc/Coding-guidelines.md b/doc/md/Coding-guidelines.md index 1fb28a5b..da47c498 100644 --- a/doc/Coding-guidelines.md +++ b/doc/md/Coding-guidelines.md | |||
| @@ -1,5 +1,5 @@ | |||
| 1 | #Coding guidelines | ||
| 2 | ## WIP | 1 | ## WIP |
| 2 | |||
| 3 | This topic is currently being discussed here: | 3 | This topic is currently being discussed here: |
| 4 | - [Fix coding style (static analysis)](https://github.com/shaarli/Shaarli/issues/95) (#95)[](.html) | 4 | - [Fix coding style (static analysis)](https://github.com/shaarli/Shaarli/issues/95) (#95) |
| 5 | - [Continuous Integration tools & features](https://github.com/shaarli/Shaarli/issues/130) (#130)[](.html) | 5 | - [Continuous Integration tools & features](https://github.com/shaarli/Shaarli/issues/130) (#130) |
diff --git a/doc/Community-&-Related-software.md b/doc/md/Community-&-Related-software.md index 52123a1e..6ff7ed45 100644 --- a/doc/Community-&-Related-software.md +++ b/doc/md/Community-&-Related-software.md | |||
| @@ -1,61 +1,60 @@ | |||
| 1 | #Community & Related software | ||
| 2 | _Unofficial but related work on Shaarli. If you maintain one of these, please get in touch with us to help us find a way to adapt your work to our fork._ | 1 | _Unofficial but related work on Shaarli. If you maintain one of these, please get in touch with us to help us find a way to adapt your work to our fork._ |
| 3 | 2 | ||
| 4 | _TODO: contact repos owners to see if they'd like to standardize their work with the community fork._ | 3 | _TODO: contact repos owners to see if they'd like to standardize their work with the community fork._ |
| 5 | 4 | ||
| 6 | ## Community | 5 | ## Community |
| 7 | - [Liens en vrac de sebsauvage](http://sebsauvage.net/links/) - the original Shaarli[](.html) | 6 | - [Liens en vrac de sebsauvage](http://sebsauvage.net/links/) - the original Shaarli |
| 8 | - [A large list of Shaarlis](http://porneia.free.fr/pub/links/ou-est-shaarli.html)[](.html) | 7 | - [A large list of Shaarlis](http://porneia.free.fr/pub/links/ou-est-shaarli.html) |
| 9 | - [A list of working Shaarli aggregators](https://raw.githubusercontent.com/Oros42/find_shaarlis/master/annuaires.json)[](.html) | 8 | - [A list of working Shaarli aggregators](https://raw.githubusercontent.com/Oros42/find_shaarlis/master/annuaires.json) |
| 10 | - [A list of some known Shaarlis](https://github.com/Oros42/shaarlis_list)[](.html) | 9 | - [A list of some known Shaarlis](https://github.com/Oros42/shaarlis_list) |
| 11 | - [Adieu Delicious, Diigo et StumbleUpon. Salut Shaarli ! - sebsauvage.net](http://sebsauvage.net/rhaa/index.php?2011/09/16/09/29/58-adieu-delicious-diigo-et-stumbleupon-salut-shaarli-) (fr) _16/09/2011 - the original post about Shaarli_[](.html) | 10 | - [Adieu Delicious, Diigo et StumbleUpon. Salut Shaarli ! - sebsauvage.net](http://sebsauvage.net/rhaa/index.php?2011/09/16/09/29/58-adieu-delicious-diigo-et-stumbleupon-salut-shaarli-) (fr) _16/09/2011 - the original post about Shaarli_ |
| 12 | - [Original ideas/fixme/TODO page](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:ideas)[](.html) | 11 | - [Original ideas/fixme/TODO page](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:ideas) |
| 13 | - [Original discussion page](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:discussion) (fr)[](.html) | 12 | - [Original discussion page](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:discussion) (fr) |
| 14 | - [Original revisions history](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:history)[](.html) | 13 | - [Original revisions history](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:history) |
| 15 | - [Shaarli.fr/my](https://www.shaarli.fr/my.php) - Unofficial, unsupported (old fork) hosted Shaarlis provider, courtesy of [DMeloni](https://github.com/DMeloni)[](.html) | 14 | - [Shaarli.fr/my](https://www.shaarli.fr/my.php) - Unofficial, unsupported (old fork) hosted Shaarlis provider, courtesy of [DMeloni](https://github.com/DMeloni) |
| 16 | 15 | ||
| 17 | ### Articles and social media discussions | 16 | ### Articles and social media discussions |
| 18 | - 2016-09-22 - Hacker News - https://news.ycombinator.com/item?id=12552176 | 17 | - 2016-09-22 - Hacker News - https://news.ycombinator.com/item?id=12552176 |
| 19 | - 2015-08-15 - Reddit - [Question about migrating from WordPress to Shaarli.](https://www.reddit.com/r/selfhosted/comments/3h3zwh/question_about_migrating_from_wordpress_to_shaarli/)[](.html) | 18 | - 2015-08-15 - Reddit - [Question about migrating from WordPress to Shaarli.](https://www.reddit.com/r/selfhosted/comments/3h3zwh/question_about_migrating_from_wordpress_to_shaarli/) |
| 20 | - 2015-06-22 - Hacker News - https://news.ycombinator.com/item?id=9755366 | 19 | - 2015-06-22 - Hacker News - https://news.ycombinator.com/item?id=9755366 |
| 21 | - 2015-05-12 - Reddit - [shaarli - Self hosted Bookmarking / Delicious (PHP, MySQL)](https://www.reddit.com/r/selfhosted/comments/35pkkc/shaarli_self_hosted_bookmarking_delicious_php/)[](.html) | 20 | - 2015-05-12 - Reddit - [shaarli - Self hosted Bookmarking / Delicious (PHP, MySQL)](https://www.reddit.com/r/selfhosted/comments/35pkkc/shaarli_self_hosted_bookmarking_delicious_php/) |
| 22 | 21 | ||
| 23 | ### Third party plugins | 22 | ### Third party plugins |
| 24 | 23 | ||
| 25 | 24 | ||
| 26 | * [autosave](https://github.com/kalvn/shaarli-plugin-autosave) by [@kalvn](https://github.com/kalvn): Automatically saves data when editing a link to avoid any loss in case of crash or unexpected shutdown.[](.html) | 25 | * [autosave](https://github.com/kalvn/shaarli-plugin-autosave) by [@kalvn](https://github.com/kalvn): Automatically saves data when editing a link to avoid any loss in case of crash or unexpected shutdown. |
| 27 | * [Code Coloration](https://github.com/ArthurHoaro/code-coloration) by [@ArthurHoaro](https://github.com/ArthurHoaro): client side code syntax highlighter.[](.html) | 26 | * [Code Coloration](https://github.com/ArthurHoaro/code-coloration) by [@ArthurHoaro](https://github.com/ArthurHoaro): client side code syntax highlighter. |
| 28 | * [Disqus](https://github.com/kalvn/shaarli-plugin-disqus) by [@kalvn](https://github.com/kalvn): Adds Disqus comment system to your Shaarli.[](.html) | 27 | * [Disqus](https://github.com/kalvn/shaarli-plugin-disqus) by [@kalvn](https://github.com/kalvn): Adds Disqus comment system to your Shaarli. |
| 29 | * [emojione](https://github.com/NerosTie/emojione) by [@NerosTie](https://github.com/NerosTie): Add colorful emojis to your Shaarli.[](.html) | 28 | * [emojione](https://github.com/NerosTie/emojione) by [@NerosTie](https://github.com/NerosTie): Add colorful emojis to your Shaarli. |
| 30 | * [google analytics](https://github.com/ericjuden/Shaarli-Google-Analytics-Plugin) by [@ericjuden](http://github.com/ericjuden): Adds Google Analytics tracking support[](.html) | 29 | * [google analytics](https://github.com/ericjuden/Shaarli-Google-Analytics-Plugin) by [@ericjuden](http://github.com/ericjuden): Adds Google Analytics tracking support |
| 31 | * [launch](https://github.com/ArthurHoaro/launch-plugin) - Launch Plugin is a plugin designed to enhance and customize Launch Theme for Shaarli.[](.html) | 30 | * [launch](https://github.com/ArthurHoaro/launch-plugin) - Launch Plugin is a plugin designed to enhance and customize Launch Theme for Shaarli. |
| 32 | * [social](https://github.com/alexisju/social) by [@alexisju](https://github.com/alexisju): share links to social networks.[](.html) | 31 | * [related](https://github.com/ilesinge/shaarli-related) by [@ilesinge](https://github.com/ilesinge) - Show related links based on the number of identical tags. |
| 33 | * [shaarli2twitter](https://github.com/ArthurHoaro/shaarli2twitter) by [@ArthurHoaro](https://github.com/ArthurHoaro) - Automatically tweet your shared links from Shaarli[](.html) | 32 | * [social](https://github.com/alexisju/social) by [@alexisju](https://github.com/alexisju): share links to social networks. |
| 33 | * [shaarli2twitter](https://github.com/ArthurHoaro/shaarli2twitter) by [@ArthurHoaro](https://github.com/ArthurHoaro) - Automatically tweet your shared links from Shaarli | ||
| 34 | 34 | ||
| 35 | 35 | ||
| 36 | ### Themes | 36 | ### Themes |
| 37 | See [Theming](Theming.html) for the list of community-contributed themes, and an installation guide. | 37 | See [[Theming]] for the list of community-contributed themes, and an installation guide. |
| 38 | 38 | ||
| 39 | ### Server apps | 39 | ### Server apps |
| 40 | - [shaarchiver](https://github.com/nodiscc/shaarchiver) - Archive your Shaarli bookmarks and their content[](.html) | 40 | - [shaarchiver](https://github.com/nodiscc/shaarchiver) - Archive your Shaarli bookmarks and their content |
| 41 | - [shaarli-river](https://github.com/mknexen/shaarli-river) - An aggregator for shaarlis with many features [](.html) | 41 | - [shaarli-river](https://github.com/mknexen/shaarli-river) - An aggregator for shaarlis with many features |
| 42 | - [Shaarlo](https://github.com/DMeloni/shaarlo) - An aggregator for shaarlis with many features (a very popular running instance among french shaarliers: [shaarli.fr](http://shaarli.fr/))[](.html) | 42 | - [Shaarlo](https://github.com/DMeloni/shaarlo) - An aggregator for shaarlis with many features (a very popular running instance among french shaarliers: [shaarli.fr](http://shaarli.fr/)) |
| 43 | - [Shaarlimages](https://github.com/BoboTiG/shaarlimages) - An image-oriented aggregator for Shaarlis[](.html) | 43 | - [Shaarlimages](https://github.com/BoboTiG/shaarlimages) - An image-oriented aggregator for Shaarlis |
| 44 | - [mknexen/shaarli-api](https://github.com/mknexen/shaarli-api) - A REST API for Shaarli[](.html) | 44 | - [mknexen/shaarli-api](https://github.com/mknexen/shaarli-api) - A REST API for Shaarli |
| 45 | - [Self dead link](https://github.com/qwertygc/shaarli-dev-code/blob/master/self-dead-link.php) - Detect dead links on shaarli. This version use the database of shaarli. [Another version](https://github.com/qwertygc/shaarli-dev-code/blob/master/dead-link.php), can be used for other shaarli instances (but is more resource consuming).[](.html) | 45 | - [Self dead link](https://github.com/qwertygc/shaarli-dev-code/blob/master/self-dead-link.php) - Detect dead links on shaarli. This version use the database of shaarli. [Another version](https://github.com/qwertygc/shaarli-dev-code/blob/master/dead-link.php), can be used for other shaarli instances (but is more resource consuming). |
| 46 | - [Bookmark Archiver](https://github.com/pirate/bookmark-archiver) - Save an archived copy of all websites starred using browser bookmarks/Shaarli/Delicious/Instapaper/Unmark.it/Pocket/Pinboard. Outputs browseable html. | ||
| 46 | 47 | ||
| 47 | ### Mobile Apps | 48 | ### Mobile Apps |
| 48 | - [Shaarli💫](http://app.mro.name/Shaarli💫) iOS share extension - see [#308](https://github.com/shaarli/Shaarli/issues/308#issuecomment-184592070) for some promo codes,[](.html) | 49 | - [ShaarliOS](https://github.com/mro/ShaarliOS) iOS share extension - see [#308](https://github.com/shaarli/Shaarli/issues/308#issuecomment-184592070) for some promo codes, |
| 49 | - [Shaarli for Android](http://sebsauvage.net/links/?ZAyDzg) - Android application that adds Shaarli as a sharing provider[](.html) | 50 | - [Shaarli for Android](http://sebsauvage.net/links/?ZAyDzg) - Android application that adds Shaarli as a sharing provider |
| 50 | - [Shaarlier for Android](https://github.com/dimtion/Shaarlier) - Android application to simply add links directly into your Shaarli[](.html) | 51 | - [Shaarlier for Android](https://github.com/dimtion/Shaarlier) - Android application to simply add links directly into your Shaarli |
| 51 | 52 | ||
| 52 | ## Integration with other platforms | 53 | ## Integration with other platforms |
| 53 | - [tt-rss-shaarli](https://github.com/jcsaaddupuy/tt-rss-shaarli) - [TinyTiny RSS](http://tt-rss.org/) plugin that adds support for sharing articles with Shaarli[](.html) | 54 | - [tt-rss-shaarli](https://github.com/jcsaaddupuy/tt-rss-shaarli) - [Tiny-Tiny RSS](http://tt-rss.org/) plugin that adds support for sharing articles with Shaarli |
| 54 | - [octopress-shaarli](https://github.com/ahmet2mir/octopress-shaarli) - Octopress plugin to retrieve Shaarli links on the sidebar[](.html) | 55 | - [octopress-shaarli](https://github.com/ahmet2mir/octopress-shaarli) - Octopress plugin to retrieve Shaarli links on the sidebar |
| 55 | - [Scuttle to Shaarli](https://github.com/q2apro/scuttle-to-shaarli) - Import bookmarks from Scuttle[](.html) | 56 | - [Scuttle to Shaarli](https://github.com/q2apro/scuttle-to-shaarli) - Import bookmarks from Scuttle |
| 56 | 57 | ||
| 57 | ## Alternatives to Shaarli | 58 | ## Alternatives to Shaarli |
| 58 | - [Shaarli alternatives](http://alternativeto.net/software/shaarli/) (alternativeto.net)[](.html) | 59 | |
| 59 | - [Bookie](https://github.com/bookieio/bookie) - Another self-hostable, free bookmark sharing software, written in Python[](.html) | 60 | See the [bookmarks & link sharing](https://github.com/Kickball/awesome-selfhosted/#bookmarks--link-sharing) section on [awesome-selfhosted](https://github.com/Kickball/awesome-selfhosted/). |
| 60 | - [Unmark](https://github.com/plainmade/unmark) - An open source todo app for bookmarks ([Homepage](https://unmark.it/))[](.html) | ||
| 61 | - [Wordpress bookmarks](https://wordpress.org/plugins/wp-bookmarks/)[](.html) | ||
diff --git a/doc/md/Continuous-integration-tools.md b/doc/md/Continuous-integration-tools.md new file mode 100644 index 00000000..30dc474d --- /dev/null +++ b/doc/md/Continuous-integration-tools.md | |||
| @@ -0,0 +1,24 @@ | |||
| 1 | ## Local development | ||
| 2 | A [`Makefile`](https://github.com/shaarli/Shaarli/blob/master/Makefile) is available to perform project-related operations: | ||
| 3 | - Documentation - generate a local HTML copy of the GitHub wiki | ||
| 4 | - [[Static analysis]] - check that the code is compliant to PHP conventions | ||
| 5 | - [[Unit tests]] - ensure there are no regressions introduced by new commits | ||
| 6 | |||
| 7 | ## Automatic builds | ||
| 8 | [Travis CI](http://docs.travis-ci.com/) is a Continuous Integration build server, that runs a build: | ||
| 9 | - each time a commit is merged to the mainline (`master` branch) | ||
| 10 | - each time a Pull Request is submitted or updated | ||
| 11 | |||
| 12 | A build is composed of several jobs: one for each supported PHP version (see [[Server requirements]]). | ||
| 13 | |||
| 14 | Each build job: | ||
| 15 | - updates Composer | ||
| 16 | - installs 3rd-party test dependencies with Composer | ||
| 17 | - runs [[Unit tests]] | ||
| 18 | |||
| 19 | After all jobs have finished, Travis returns the results to GitHub: | ||
| 20 | - a status icon represents the result for the `master` branch: [](https://travis-ci.org/shaarli/Shaarli) | ||
| 21 | - Pull Requests are updated with the Travis result | ||
| 22 | - Green: all tests have passed | ||
| 23 | - Red: some tests failed | ||
| 24 | - Orange: tests are pending | ||
diff --git a/doc/Copy-an-existing-installation-over-SSH-and-serve-it-locally.md b/doc/md/Copy-an-existing-installation-over-SSH-and-serve-it-locally.md index 88d191da..7583c9ea 100644 --- a/doc/Copy-an-existing-installation-over-SSH-and-serve-it-locally.md +++ b/doc/md/Copy-an-existing-installation-over-SSH-and-serve-it-locally.md | |||
| @@ -1,4 +1,3 @@ | |||
| 1 | #Copy an existing installation over SSH and serve it locally | ||
| 2 | Example bash script: | 1 | Example bash script: |
| 3 | 2 | ||
| 4 | ```bash | 3 | ```bash |
| @@ -61,7 +60,7 @@ Listening on http://localhost:7431 | |||
| 61 | Document root is /home/user/local-shaarli/shaarli | 60 | Document root is /home/user/local-shaarli/shaarli |
| 62 | Press Ctrl-C to quit. | 61 | Press Ctrl-C to quit. |
| 63 | 62 | ||
| 64 | [Mon Sep 1 21:56:27 2014] ::1:57868 [200]: /[](.html) | 63 | [Mon Sep 1 21:56:27 2014] ::1:57868 [200]: / |
| 65 | [Mon Sep 1 21:56:27 2014] ::1:57869 [200]: /index.html[](.html) | 64 | [Mon Sep 1 21:56:27 2014] ::1:57869 [200]: /index.html |
| 66 | [Mon Sep 1 21:56:37 2014] ::1:57881 [200]: /...[](.html) | 65 | [Mon Sep 1 21:56:37 2014] ::1:57881 [200]: /... |
| 67 | ``` | 66 | ``` |
diff --git a/doc/Create-and-serve-multiple-Shaarlis-(farm).md b/doc/md/Create-and-serve-multiple-Shaarlis-(farm).md index a71f6520..d0d812a3 100644 --- a/doc/Create-and-serve-multiple-Shaarlis-(farm).md +++ b/doc/md/Create-and-serve-multiple-Shaarlis-(farm).md | |||
| @@ -1,4 +1,3 @@ | |||
| 1 | #Create and serve multiple Shaarlis (farm) | ||
| 2 | Example bash script (creates multiple shaarli instances and generates an HTML index of them) | 1 | Example bash script (creates multiple shaarli instances and generates an HTML index of them) |
| 3 | 2 | ||
| 4 | ```bash | 3 | ```bash |
| @@ -13,12 +12,12 @@ shaarli_repo_url='https://github.com/shaarli/Shaarli' | |||
| 13 | ref="master" | 12 | ref="master" |
| 14 | 13 | ||
| 15 | #clone multiple shaarli instances | 14 | #clone multiple shaarli instances |
| 16 | if [ ! -d "$shaarli_base_dir" ]; then mkdir "$shaarli_base_dir"; fi[](.html) | 15 | if [ ! -d "$shaarli_base_dir" ]; then mkdir "$shaarli_base_dir"; fi |
| 17 | 16 | ||
| 18 | for account in $accounts; do | 17 | for account in $accounts; do |
| 19 | if [ -d "$shaarli_base_dir/$account" ];[](.html) | 18 | if [ -d "$shaarli_base_dir/$account" ]; |
| 20 | then echo "[info] account $account already exists, skipping";[](.html) | 19 | then echo "[info] account $account already exists, skipping"; |
| 21 | else echo "[info] creating new account $account ..."; git clone --quiet "$shaarli_repo_url" -b "$ref" "$shaarli_base_dir/$account"; fi[](.html) | 20 | else echo "[info] creating new account $account ..."; git clone --quiet "$shaarli_repo_url" -b "$ref" "$shaarli_base_dir/$account"; fi |
| 22 | done | 21 | done |
| 23 | 22 | ||
| 24 | #generate html index of shaarlis | 23 | #generate html index of shaarlis |
| @@ -46,13 +45,13 @@ htmlfooter=' | |||
| 46 | 45 | ||
| 47 | 46 | ||
| 48 | for account in $accounts; do accountlinks="$accountlinks\n<li><a href=\"$account\">$account</a></li>"; done | 47 | for account in $accounts; do accountlinks="$accountlinks\n<li><a href=\"$account\">$account</a></li>"; done |
| 49 | if [ -d "$shaarli_base_dir/index.html" ]; then echo "[removing old index.html]"; rm "$shaarli_base_dir/index.html" ]; fi[](.html) | 48 | if [ -d "$shaarli_base_dir/index.html" ]; then echo "[removing old index.html]"; rm "$shaarli_base_dir/index.html" ]; fi |
| 50 | echo "[info] generating new index of shaarlis"[](.html) | 49 | echo "[info] generating new index of shaarlis" |
| 51 | echo -e "$htmlhead $accountlinks $htmlfooter" > "$shaarli_base_dir/index.html" | 50 | echo -e "$htmlhead $accountlinks $htmlfooter" > "$shaarli_base_dir/index.html" |
| 52 | echo '[info] done.'[](.html) | 51 | echo '[info] done.' |
| 53 | echo "[info] list of accounts: $accounts"[](.html) | 52 | echo "[info] list of accounts: $accounts" |
| 54 | echo "[info] contents of $shaarli_base_dir:"[](.html) | 53 | echo "[info] contents of $shaarli_base_dir:" |
| 55 | tree -a -L 1 "$shaarli_base_dir" | 54 | tree -a -L 1 "$shaarli_base_dir" |
| 56 | ``` | 55 | ``` |
| 57 | 56 | ||
| 58 | This script just serves as an example. More precise or complex (applying custom configuration, etc) automation is possible using configuration management software like [Ansible](https://www.ansible.com/)[](.html) | 57 | This script just serves as an example. More precise or complex (applying custom configuration, etc) automation is possible using configuration management software like [Ansible](https://www.ansible.com/) \ No newline at end of file |
diff --git a/doc/Datastore-hacks.md b/doc/md/Datastore-hacks.md index ef6f6d50..78baa005 100644 --- a/doc/Datastore-hacks.md +++ b/doc/md/Datastore-hacks.md | |||
| @@ -1,5 +1,5 @@ | |||
| 1 | #Datastore hacks | ||
| 2 | ### Decode datastore content | 1 | ### Decode datastore content |
| 2 | |||
| 3 | To display the array representing the data saved in `data/datastore.php`, use the following snippet: | 3 | To display the array representing the data saved in `data/datastore.php`, use the following snippet: |
| 4 | 4 | ||
| 5 | ```php | 5 | ```php |
| @@ -18,6 +18,7 @@ php -r 'print(json_encode(unserialize(gzinflate(base64_decode(preg_replace("!.*/ | |||
| 18 | ``` | 18 | ``` |
| 19 | 19 | ||
| 20 | ### Changing the timestamp for a link | 20 | ### Changing the timestamp for a link |
| 21 | |||
| 21 | * Look for `<input type="hidden" name="lf_linkdate" value="{$link.linkdate}">` in `tpl/editlink.tpl` (line 14) | 22 | * Look for `<input type="hidden" name="lf_linkdate" value="{$link.linkdate}">` in `tpl/editlink.tpl` (line 14) |
| 22 | * Replace `type="hidden"` with `type="text"` from this line | 23 | * Replace `type="hidden"` with `type="text"` from this line |
| 23 | * A new date/time field becomes available in the edit/new link dialog. | 24 | * A new date/time field becomes available in the edit/new link dialog. |
diff --git a/doc/md/Development-guidelines.md b/doc/md/Development-guidelines.md new file mode 100644 index 00000000..1480ec89 --- /dev/null +++ b/doc/md/Development-guidelines.md | |||
| @@ -0,0 +1,9 @@ | |||
| 1 | ## Development guidelines | ||
| 2 | |||
| 3 | Please have a look at the following pages: | ||
| 4 | - [Contributing to Shaarli](https://github.com/shaarli/Shaarli/tree/master/CONTRIBUTING.md) | ||
| 5 | - [[Static analysis]] - patches should try to stick to the [PHP Standard Recommendations](http://www.php-fig.org/psr/) (PSR), especially: | ||
| 6 | - [PSR-1](http://www.php-fig.org/psr/psr-1/) - Basic Coding Standard | ||
| 7 | - [PSR-2](http://www.php-fig.org/psr/psr-2/) - Coding Style Guide | ||
| 8 | - [[Unit tests]] | ||
| 9 | - [[GnuPG signature]] for tags/releases | ||
diff --git a/doc/Directory-structure.md b/doc/md/Directory-structure.md index 3a1c4309..eb50965b 100644 --- a/doc/Directory-structure.md +++ b/doc/md/Directory-structure.md | |||
| @@ -1,4 +1,5 @@ | |||
| 1 | #Directory structure | 1 | TODO: This page is out of date |
| 2 | |||
| 2 | Here is the directory structure of Shaarli and the purpose of the different files: | 3 | Here is the directory structure of Shaarli and the purpose of the different files: |
| 3 | 4 | ||
| 4 | ```bash | 5 | ```bash |
diff --git a/doc/md/Docker-101.md b/doc/md/Docker-101.md new file mode 100644 index 00000000..b02dd149 --- /dev/null +++ b/doc/md/Docker-101.md | |||
| @@ -0,0 +1,62 @@ | |||
| 1 | ## Basics | ||
| 2 | Install [Docker](https://www.docker.com/), by following the instructions relevant | ||
| 3 | to your OS / distribution, and start the service. | ||
| 4 | |||
| 5 | ### Search an image on [DockerHub](https://hub.docker.com/) | ||
| 6 | |||
| 7 | ```bash | ||
| 8 | $ docker search debian | ||
| 9 | |||
| 10 | NAME DESCRIPTION STARS OFFICIAL AUTOMATED | ||
| 11 | ubuntu Ubuntu is a Debian-based Linux operating s... 2065 [OK] | ||
| 12 | debian Debian is a Linux distribution that's comp... 603 [OK] | ||
| 13 | google/debian 47 [OK] | ||
| 14 | ``` | ||
| 15 | |||
| 16 | ### Show available tags for a repository | ||
| 17 | ```bash | ||
| 18 | $ curl https://index.docker.io/v1/repositories/debian/tags | python -m json.tool | ||
| 19 | |||
| 20 | % Total % Received % Xferd Average Speed Time Time Time Current | ||
| 21 | Dload Upload Total Spent Left Speed | ||
| 22 | 100 1283 0 1283 0 0 433 0 --:--:-- 0:00:02 --:--:-- 433 | ||
| 23 | ``` | ||
| 24 | |||
| 25 | Sample output: | ||
| 26 | ```json | ||
| 27 | [ | ||
| 28 | { | ||
| 29 | "layer": "85a02782", | ||
| 30 | "name": "stretch" | ||
| 31 | }, | ||
| 32 | { | ||
| 33 | "layer": "59abecbc", | ||
| 34 | "name": "testing" | ||
| 35 | }, | ||
| 36 | { | ||
| 37 | "layer": "bf0fd686", | ||
| 38 | "name": "unstable" | ||
| 39 | }, | ||
| 40 | { | ||
| 41 | "layer": "60c52dbe", | ||
| 42 | "name": "wheezy" | ||
| 43 | }, | ||
| 44 | { | ||
| 45 | "layer": "c5b806fe", | ||
| 46 | "name": "wheezy-backports" | ||
| 47 | } | ||
| 48 | ] | ||
| 49 | |||
| 50 | ``` | ||
| 51 | |||
| 52 | ### Pull an image from DockerHub | ||
| 53 | ```bash | ||
| 54 | $ docker pull repository[:tag] | ||
| 55 | |||
| 56 | $ docker pull debian:wheezy | ||
| 57 | wheezy: Pulling from debian | ||
| 58 | 4c8cbfd2973e: Pull complete | ||
| 59 | 60c52dbe9d91: Pull complete | ||
| 60 | Digest: sha256:c584131da2ac1948aa3e66468a4424b6aea2f33acba7cec0b631bdb56254c4fe | ||
| 61 | Status: Downloaded newer image for debian:wheezy | ||
| 62 | ``` | ||
diff --git a/doc/md/Docker-resources.md b/doc/md/Docker-resources.md new file mode 100644 index 00000000..082d4a46 --- /dev/null +++ b/doc/md/Docker-resources.md | |||
| @@ -0,0 +1,19 @@ | |||
| 1 | ### Docker | ||
| 2 | |||
| 3 | - [Interactive Docker training portal](https://www.katacoda.com/courses/docker/) on [Katakoda](https://www.katacoda.com/) | ||
| 4 | - [Where are Docker images stored?](http://blog.thoward37.me/articles/where-are-docker-images-stored/) | ||
| 5 | - [Dockerfile reference](https://docs.docker.com/reference/builder/) | ||
| 6 | - [Dockerfile best practices](https://docs.docker.com/articles/dockerfile_best-practices/) | ||
| 7 | - [Volumes](https://docs.docker.com/userguide/dockervolumes/) | ||
| 8 | |||
| 9 | ### DockerHub | ||
| 10 | |||
| 11 | - [Repositories](https://docs.docker.com/userguide/dockerrepos/) | ||
| 12 | - [Teams and organizations](https://docs.docker.com/docker-hub/orgs/) | ||
| 13 | - [GitHub automated build](https://docs.docker.com/docker-hub/github/) | ||
| 14 | |||
| 15 | ### Service management | ||
| 16 | |||
| 17 | - [Using supervisord](https://docs.docker.com/articles/using_supervisord/) | ||
| 18 | - [Nginx in the foreground](http://nginx.org/en/docs/ngx_core_module.html#daemon) | ||
| 19 | - [supervisord](http://supervisord.org/) | ||
diff --git a/doc/Download-CSS-styles-from-an-OPML-list.md b/doc/md/Download-CSS-styles-from-an-OPML-list.md index eb66f955..26b7fb3e 100644 --- a/doc/Download-CSS-styles-from-an-OPML-list.md +++ b/doc/md/Download-CSS-styles-from-an-OPML-list.md | |||
| @@ -1,4 +1,3 @@ | |||
| 1 | #Download CSS styles from an OPML list | ||
| 2 | ###Download CSS styles for shaarlis listed in an opml file | 1 | ###Download CSS styles for shaarlis listed in an opml file |
| 3 | Example php script: | 2 | Example php script: |
| 4 | 3 | ||
| @@ -34,8 +33,8 @@ function createShaarliHashFromOPMLL($opmlFile) { | |||
| 34 | $opmlXml = simplexml_load_string($opml); | 33 | $opmlXml = simplexml_load_string($opml); |
| 35 | $outlineElements = $opmlXml->xpath("body/outline"); | 34 | $outlineElements = $opmlXml->xpath("body/outline"); |
| 36 | foreach($outlineElements as $site) { | 35 | foreach($outlineElements as $site) { |
| 37 | $siteUrl = siteUrl((string) $site['htmlUrl']);[](.html) | 36 | $siteUrl = siteUrl((string) $site['htmlUrl']); |
| 38 | $result[$siteUrl]=((string) $site['text']);[](.html) | 37 | $result[$siteUrl]=((string) $site['text']); |
| 39 | } | 38 | } |
| 40 | return $result; | 39 | return $result; |
| 41 | } | 40 | } |
| @@ -47,7 +46,7 @@ function getSiteFolder($url) { | |||
| 47 | 46 | ||
| 48 | function get_http_response_code($theURL) { | 47 | function get_http_response_code($theURL) { |
| 49 | $headers = get_headers($theURL); | 48 | $headers = get_headers($theURL); |
| 50 | return substr($headers[0], 9, 3);[](.html) | 49 | return substr($headers[0], 9, 3); |
| 51 | } | 50 | } |
| 52 | 51 | ||
| 53 | /** | 52 | /** |
| @@ -122,7 +121,7 @@ function getDirectoryList ($directory) { | |||
| 122 | while ($file = readdir($handler)) { | 121 | while ($file = readdir($handler)) { |
| 123 | // if file isn't this directory or its parent, add it to the results | 122 | // if file isn't this directory or its parent, add it to the results |
| 124 | if ($file != "." && $file != "..") { | 123 | if ($file != "." && $file != "..") { |
| 125 | $results[ = realpath($realPath . "/" . $file);](-=-realpath($realPath-.-"/"-.-$file);.html) | 124 | $results[] = realpath($realPath . "/" . $file); |
| 126 | } | 125 | } |
| 127 | } | 126 | } |
| 128 | // tidy up: close the handler | 127 | // tidy up: close the handler |
| @@ -142,7 +141,7 @@ function findKnownStyles() { | |||
| 142 | $configFile = $folder."/config.ini"; | 141 | $configFile = $folder."/config.ini"; |
| 143 | if(file_exists($configFile)) { | 142 | if(file_exists($configFile)) { |
| 144 | $iniParameters = parse_ini_file($configFile); | 143 | $iniParameters = parse_ini_file($configFile); |
| 145 | array_push($result, $iniParameters['site_url']);[](.html) | 144 | array_push($result, $iniParameters['site_url']); |
| 146 | } | 145 | } |
| 147 | } | 146 | } |
| 148 | return $result; | 147 | return $result; |
| @@ -152,4 +151,4 @@ $knownStyles = findKnownStyles(); | |||
| 152 | copyUserStylesFrom(createShaarliHashFromOPMLL(SHAARLI_RSS_OPML), $knownStyles); | 151 | copyUserStylesFrom(createShaarliHashFromOPMLL(SHAARLI_RSS_OPML), $knownStyles); |
| 153 | 152 | ||
| 154 | <!--- ? ----> | 153 | <!--- ? ----> |
| 155 | ``` | 154 | ``` \ No newline at end of file |
diff --git a/doc/Download-and-Installation.md b/doc/md/Download-and-Installation.md index 970144a5..7880aef4 100644 --- a/doc/Download-and-Installation.md +++ b/doc/md/Download-and-Installation.md | |||
| @@ -1,7 +1,4 @@ | |||
| 1 | #Download and Installation | 1 | To install Shaarli, simply place the files in a directory under your webserver's Document Root (or directly at the document root). Make sure your [server](Server-requirements) is properly [configured](Server-configuration). |
| 2 | # Get Shaarli! | ||
| 3 | |||
| 4 | To install Shaarli, simply place the files in a directory under your webserver's Document Root (or directly at the document root). Make sure your [server](Server-requirements) is properly [configured](Server-configuration).[](.html) | ||
| 5 | 2 | ||
| 6 | Several releases are available: | 3 | Several releases are available: |
| 7 | 4 | ||
| @@ -9,7 +6,7 @@ Several releases are available: | |||
| 9 | 6 | ||
| 10 | ## Latest release (recommended) | 7 | ## Latest release (recommended) |
| 11 | ### Download as an archive | 8 | ### Download as an archive |
| 12 | Get the latest released version from the [releases](https://github.com/shaarli/Shaarli/releases) page.[](.html) | 9 | Get the latest released version from the [releases](https://github.com/shaarli/Shaarli/releases) page. |
| 13 | 10 | ||
| 14 | **Download our *shaarli-full* archive** to include dependencies. | 11 | **Download our *shaarli-full* archive** to include dependencies. |
| 15 | 12 | ||
| @@ -23,7 +20,7 @@ $ unzip shaarli-v0.8.4-full.zip | |||
| 23 | $ mv Shaarli /path/to/shaarli/ | 20 | $ mv Shaarli /path/to/shaarli/ |
| 24 | ``` | 21 | ``` |
| 25 | 22 | ||
| 26 | | ! |In most cases, download Shaarli from the [releases](https://github.com/shaarli/Shaarli/releases) page. Cloning using `git` or downloading Github branches as zip files requires additional steps (see below).|[](.html) | 23 | | ! |In most cases, download Shaarli from the [releases](https://github.com/shaarli/Shaarli/releases) page. Cloning using `git` or downloading Github branches as zip files requires additional steps (see below).| |
| 27 | |-----|--------------------------| | 24 | |-----|--------------------------| |
| 28 | 25 | ||
| 29 | ### Using git | 26 | ### Using git |
| @@ -60,7 +57,7 @@ $ mv Shaarli-stable /path/to/shaarli/ | |||
| 60 | 57 | ||
| 61 | ### Clone with Git | 58 | ### Clone with Git |
| 62 | 59 | ||
| 63 | [Composer](https://getcomposer.org/) is required to build a functional Shaarli installation when pulling from git.[](.html) | 60 | [Composer](https://getcomposer.org/) is required to build a functional Shaarli installation when pulling from git. |
| 64 | 61 | ||
| 65 | ```bash | 62 | ```bash |
| 66 | $ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/ | 63 | $ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/ |
| @@ -91,7 +88,7 @@ $ composer install --no-dev | |||
| 91 | 88 | ||
| 92 | Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser. | 89 | Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser. |
| 93 | 90 | ||
| 94 | [](.html) | 91 |  |
| 95 | 92 | ||
| 96 | Setup your Shaarli installation, and it's ready to use! | 93 | Setup your Shaarli installation, and it's ready to use! |
| 97 | 94 | ||
| @@ -99,4 +96,4 @@ Setup your Shaarli installation, and it's ready to use! | |||
| 99 | 96 | ||
| 100 | ## Updating Shaarli | 97 | ## Updating Shaarli |
| 101 | 98 | ||
| 102 | See [Upgrade and Migration](Upgrade-and-migration)[](.html) | 99 | See [Upgrade and Migration](Upgrade-and-migration) |
diff --git a/doc/Example-patch---add-new-via-field-for-links.md b/doc/md/Example-patch---add-new-via-field-for-links.md index 883adf40..d84ef25a 100644 --- a/doc/Example-patch---add-new-via-field-for-links.md +++ b/doc/md/Example-patch---add-new-via-field-for-links.md | |||
| @@ -1,4 +1,3 @@ | |||
| 1 | #Example patch add new via field for links | ||
| 2 | Example patch to add a new field ("via") for links, an input field to set the "via" property from the "edit link" dialog, and display the "via" field in the link list display. **Untested, use at your own risk** | 1 | Example patch to add a new field ("via") for links, an input field to set the "via" property from the "edit link" dialog, and display the "via" field in the link list display. **Untested, use at your own risk** |
| 3 | 2 | ||
| 4 | Thanks to @Knah-Tsaeb in https://github.com/sebsauvage/Shaarli/pull/158 | 3 | Thanks to @Knah-Tsaeb in https://github.com/sebsauvage/Shaarli/pull/158 |
| @@ -7,7 +6,7 @@ Thanks to @Knah-Tsaeb in https://github.com/sebsauvage/Shaarli/pull/158 | |||
| 7 | From e0f363c18e8fe67990ed2bb1a08652e24e70bbcb Mon Sep 17 00:00:00 2001 | 6 | From e0f363c18e8fe67990ed2bb1a08652e24e70bbcb Mon Sep 17 00:00:00 2001 |
| 8 | From: Knah Tsaeb <knah-tsaeb@knah-tsaeb.org> | 7 | From: Knah Tsaeb <knah-tsaeb@knah-tsaeb.org> |
| 9 | Date: Fri, 11 Oct 2013 15:18:37 +0200 | 8 | Date: Fri, 11 Oct 2013 15:18:37 +0200 |
| 10 | Subject: [PATCH] Add a "via"/origin property for links, add new input in "edit link" dialog[](.html) | 9 | Subject: [PATCH] Add a "via"/origin property for links, add new input in "edit link" dialog |
| 11 | Thanks to: | 10 | Thanks to: |
| 12 | * https://github.com/Knah-Tsaeb/Shaarli/commit/040eb18ec8cdabd5ea855e108f81f97fbf0478c4 | 11 | * https://github.com/Knah-Tsaeb/Shaarli/commit/040eb18ec8cdabd5ea855e108f81f97fbf0478c4 |
| 13 | * https://github.com/Knah-Tsaeb/Shaarli/commit/4123658eae44d7564d1128ce52ddd5689efee813 | 12 | * https://github.com/Knah-Tsaeb/Shaarli/commit/4123658eae44d7564d1128ce52ddd5689efee813 |
| @@ -23,27 +22,27 @@ diff --git a/index.php b/index.php | |||
| 23 | index 6fae2f8..53f798e 100644 | 22 | index 6fae2f8..53f798e 100644 |
| 24 | --- a/index.php | 23 | --- a/index.php |
| 25 | +++ b/index.php | 24 | +++ b/index.php |
| 26 | @@ -436,6 +436,12 @@ if (isset($_POST['login']))[](.html) | 25 | @@ -436,6 +436,12 @@ if (isset($_POST['login'])) |
| 27 | // ------------------------------------------------------------------------------------------ | 26 | // ------------------------------------------------------------------------------------------ |
| 28 | // Misc utility functions: | 27 | // Misc utility functions: |
| 29 | 28 | ||
| 30 | +// Try to get just domain for @via | 29 | +// Try to get just domain for @via |
| 31 | +function getJustDomain($url){ | 30 | +function getJustDomain($url){ |
| 32 | + $parts = parse_url($url); | 31 | + $parts = parse_url($url); |
| 33 | + return trim($parts['host']);[](.html) | 32 | + return trim($parts['host']); |
| 34 | + } | 33 | + } |
| 35 | + | 34 | + |
| 36 | // Returns the server URL (including port and http/https), without path. | 35 | // Returns the server URL (including port and http/https), without path. |
| 37 | // e.g. "http://myserver.com:8080" | 36 | // e.g. "http://myserver.com:8080" |
| 38 | // You can append $_SERVER['SCRIPT_NAME'] to get the current script URL.[](.html) | 37 | // You can append $_SERVER['SCRIPT_NAME'] to get the current script URL. |
| 39 | @@ -799,7 +805,8 @@ class linkdb implements Iterator, Countable, ArrayAccess | 38 | @@ -799,7 +805,8 @@ class linkdb implements Iterator, Countable, ArrayAccess |
| 40 | $found= (strpos(strtolower($l['title']),$s)!==false)[](.html) | 39 | $found= (strpos(strtolower($l['title']),$s)!==false) |
| 41 | || (strpos(strtolower($l['description']),$s)!==false)[](.html) | 40 | || (strpos(strtolower($l['description']),$s)!==false) |
| 42 | || (strpos(strtolower($l['url']),$s)!==false)[](.html) | 41 | || (strpos(strtolower($l['url']),$s)!==false) |
| 43 | - || (strpos(strtolower($l['tags']),$s)!==false);[](.html) | 42 | - || (strpos(strtolower($l['tags']),$s)!==false); |
| 44 | + || (strpos(strtolower($l['tags']),$s)!==false)[](.html) | 43 | + || (strpos(strtolower($l['tags']),$s)!==false) |
| 45 | + || (!empty($l['via']) && (strpos(strtolower($l['via']),$s)!==false));[](.html) | 44 | + || (!empty($l['via']) && (strpos(strtolower($l['via']),$s)!==false)); |
| 46 | if ($found) $filtered[$l['linkdate'[ = $l;](-=-$l;.html) | 45 | if ($found) $filtered[$l['linkdate']] = $l; |
| 47 | } | 46 | } |
| 48 | krsort($filtered); | 47 | krsort($filtered); |
| 49 | @@ -814,7 +821,7 @@ class linkdb implements Iterator, Countable, ArrayAccess | 48 | @@ -814,7 +821,7 @@ class linkdb implements Iterator, Countable, ArrayAccess |
| @@ -53,74 +52,74 @@ index 6fae2f8..53f798e 100644 | |||
| 53 | - foreach($this->links as $l) | 52 | - foreach($this->links as $l) |
| 54 | + foreach($this-> links as $l) | 53 | + foreach($this-> links as $l) |
| 55 | { | 54 | { |
| 56 | $linktags = explode(' ',($casesensitive?$l['tags']:strtolower($l['tags'])));[](.html) | 55 | $linktags = explode(' ',($casesensitive?$l['tags']:strtolower($l['tags']))); |
| 57 | if (count(array_intersect($linktags,$searchtags)) == count($searchtags)) | 56 | if (count(array_intersect($linktags,$searchtags)) == count($searchtags)) |
| 58 | @@ -905,7 +912,7 @@ function showRSS() | 57 | @@ -905,7 +912,7 @@ function showRSS() |
| 59 | else $linksToDisplay = $LINKSDB; | 58 | else $linksToDisplay = $LINKSDB; |
| 60 | $nblinksToDisplay = 50; // Number of links to display. | 59 | $nblinksToDisplay = 50; // Number of links to display. |
| 61 | if (!empty($_GET['nb'])) // In URL, you can specificy the number of links. Example: nb=200 or nb=all for all links.[](.html) | 60 | if (!empty($_GET['nb'])) // In URL, you can specificy the number of links. Example: nb=200 or nb=all for all links. |
| 62 | - { | 61 | - { |
| 63 | + { | 62 | + { |
| 64 | $nblinksToDisplay = $_GET['nb']=='all' ? count($linksToDisplay) : max($_GET['nb']+0,1) ;[](.html) | 63 | $nblinksToDisplay = $_GET['nb']=='all' ? count($linksToDisplay) : max($_GET['nb']+0,1) ; |
| 65 | } | 64 | } |
| 66 | 65 | ||
| 67 | @@ -944,7 +951,12 @@ function showRSS() | 66 | @@ -944,7 +951,12 @@ function showRSS() |
| 68 | // If user wants permalinks first, put the final link in description | 67 | // If user wants permalinks first, put the final link in description |
| 69 | if ($usepermalinks===true) $descriptionlink = '(<a href="'.$absurl.'">Link</a>)'; | 68 | if ($usepermalinks===true) $descriptionlink = '(<a href="'.$absurl.'">Link</a>)'; |
| 70 | if (strlen($link['description'])>0) $descriptionlink = '<br>'.$descriptionlink;[](.html) | 69 | if (strlen($link['description'])>0) $descriptionlink = '<br>'.$descriptionlink; |
| 71 | - echo '<description><![CDATA['.nl2br(keepMultipleSpaces(text2clickable(htmlspecialchars($link['description'])))).$descriptionlink.'[></description>'."\n</item>\n";](></description>'."\n</item>\n";.html) | 70 | - echo '<description><![CDATA['.nl2br(keepMultipleSpaces(text2clickable(htmlspecialchars($link['description'])))).$descriptionlink.']]></description>'."\n</item>\n"; |
| 72 | + if(!empty($link['via'])){[](.html) | 71 | + if(!empty($link['via'])){ |
| 73 | + $via = '<br>Origine => <a href="'.htmlspecialchars($link['via']).'">'.htmlspecialchars(getJustDomain($link['via'])).'</a>';[](.html) | 72 | + $via = '<br>Origine => <a href="'.htmlspecialchars($link['via']).'">'.htmlspecialchars(getJustDomain($link['via'])).'</a>'; |
| 74 | + } else { | 73 | + } else { |
| 75 | + $via = ''; | 74 | + $via = ''; |
| 76 | + } | 75 | + } |
| 77 | + echo '<description><![CDATA['.nl2br(keepMultipleSpaces(text2clickable(htmlspecialchars($link['description'])))).$via.$descriptionlink.'[></description>'."\n</item>\n";](></description>'."\n</item>\n";.html) | 76 | + echo '<description><![CDATA['.nl2br(keepMultipleSpaces(text2clickable(htmlspecialchars($link['description'])))).$via.$descriptionlink.']]></description>'."\n</item>\n"; |
| 78 | $i++; | 77 | $i++; |
| 79 | } | 78 | } |
| 80 | echo '</channel></rss><!-- Cached version of '.htmlspecialchars(pageUrl()).' -->'; | 79 | echo '</channel></rss><!-- Cached version of '.htmlspecialchars(pageUrl()).' -->'; |
| 81 | @@ -980,7 +992,7 @@ function showATOM() | 80 | @@ -980,7 +992,7 @@ function showATOM() |
| 82 | else $linksToDisplay = $LINKSDB; | 81 | else $linksToDisplay = $LINKSDB; |
| 83 | $nblinksToDisplay = 50; // Number of links to display. | 82 | $nblinksToDisplay = 50; // Number of links to display. |
| 84 | if (!empty($_GET['nb'])) // In URL, you can specificy the number of links. Example: nb=200 or nb=all for all links.[](.html) | 83 | if (!empty($_GET['nb'])) // In URL, you can specificy the number of links. Example: nb=200 or nb=all for all links. |
| 85 | - { | 84 | - { |
| 86 | + { | 85 | + { |
| 87 | $nblinksToDisplay = $_GET['nb']=='all' ? count($linksToDisplay) : max($_GET['nb']+0,1) ;[](.html) | 86 | $nblinksToDisplay = $_GET['nb']=='all' ? count($linksToDisplay) : max($_GET['nb']+0,1) ; |
| 88 | } | 87 | } |
| 89 | 88 | ||
| 90 | @@ -1006,11 +1018,16 @@ function showATOM() | 89 | @@ -1006,11 +1018,16 @@ function showATOM() |
| 91 | 90 | ||
| 92 | // Add permalink in description | 91 | // Add permalink in description |
| 93 | $descriptionlink = htmlspecialchars('(<a href="'.$guid.'">Permalink</a>)'); | 92 | $descriptionlink = htmlspecialchars('(<a href="'.$guid.'">Permalink</a>)'); |
| 94 | + if(isset($link['via']) && !empty($link['via'])){[](.html) | 93 | + if(isset($link['via']) && !empty($link['via'])){ |
| 95 | + $via = htmlspecialchars('</br> Origine => <a href="'.$link['via'].'">'.getJustDomain($link['via']).'</a>');[](.html) | 94 | + $via = htmlspecialchars('</br> Origine => <a href="'.$link['via'].'">'.getJustDomain($link['via']).'</a>'); |
| 96 | + } else { | 95 | + } else { |
| 97 | + $via = ''; | 96 | + $via = ''; |
| 98 | + } | 97 | + } |
| 99 | // If user wants permalinks first, put the final link in description | 98 | // If user wants permalinks first, put the final link in description |
| 100 | if ($usepermalinks===true) $descriptionlink = htmlspecialchars('(<a href="'.$absurl.'">Link</a>)'); | 99 | if ($usepermalinks===true) $descriptionlink = htmlspecialchars('(<a href="'.$absurl.'">Link</a>)'); |
| 101 | if (strlen($link['description'])>0) $descriptionlink = '<br>'.$descriptionlink;[](.html) | 100 | if (strlen($link['description'])>0) $descriptionlink = '<br>'.$descriptionlink; |
| 102 | 101 | ||
| 103 | - $entries.='<content type="html">'.htmlspecialchars(nl2br(keepMultipleSpaces(text2clickable(htmlspecialchars($link['description']))))).$descriptionlink."</content>\n";[](.html) | 102 | - $entries.='<content type="html">'.htmlspecialchars(nl2br(keepMultipleSpaces(text2clickable(htmlspecialchars($link['description']))))).$descriptionlink."</content>\n"; |
| 104 | + $entries.='<content type="html">'.htmlspecialchars(nl2br(keepMultipleSpaces(text2clickable(htmlspecialchars($link['description']))))).$descriptionlink.$via."</content>\n";[](.html) | 103 | + $entries.='<content type="html">'.htmlspecialchars(nl2br(keepMultipleSpaces(text2clickable(htmlspecialchars($link['description']))))).$descriptionlink.$via."</content>\n"; |
| 105 | if ($link['tags']!='') // Adding tags to each ATOM entry (as mentioned in ATOM specification)[](.html) | 104 | if ($link['tags']!='') // Adding tags to each ATOM entry (as mentioned in ATOM specification) |
| 106 | { | 105 | { |
| 107 | foreach(explode(' ',$link['tags']) as $tag)[](.html) | 106 | foreach(explode(' ',$link['tags']) as $tag) |
| 108 | @@ -1478,7 +1495,7 @@ function renderPage() | 107 | @@ -1478,7 +1495,7 @@ function renderPage() |
| 109 | if (!startsWith($url,'http:') && !startsWith($url,'https:') && !startsWith($url,'ftp:') && !startsWith($url,'magnet:') && !startsWith($url,'?')) | 108 | if (!startsWith($url,'http:') && !startsWith($url,'https:') && !startsWith($url,'ftp:') && !startsWith($url,'magnet:') && !startsWith($url,'?')) |
| 110 | $url = 'http://'.$url; | 109 | $url = 'http://'.$url; |
| 111 | $link = array('title'=>trim($_POST['lf_title']),'url'=>$url,'description'=>trim($_POST['lf_description']),'private'=>(isset($_POST['lf_private']) ? 1 : 0),[](.html) | 110 | $link = array('title'=>trim($_POST['lf_title']),'url'=>$url,'description'=>trim($_POST['lf_description']),'private'=>(isset($_POST['lf_private']) ? 1 : 0), |
| 112 | - 'linkdate'=>$linkdate,'tags'=>str_replace(',',' ',$tags)); | 111 | - 'linkdate'=>$linkdate,'tags'=>str_replace(',',' ',$tags)); |
| 113 | + 'linkdate'=>$linkdate,'tags'=>str_replace(',',' ',$tags), 'via'=>trim($_POST['lf_via']));[](.html) | 112 | + 'linkdate'=>$linkdate,'tags'=>str_replace(',',' ',$tags), 'via'=>trim($_POST['lf_via'])); |
| 114 | if ($link['title']=='') $link['title']=$link['url']; // If title is empty, use the URL as title.[](.html) | 113 | if ($link['title']=='') $link['title']=$link['url']; // If title is empty, use the URL as title. |
| 115 | $LINKSDB[$linkdate] = $link;[](.html) | 114 | $LINKSDB[$linkdate] = $link; |
| 116 | $LINKSDB->savedb(); // Save to disk. | 115 | $LINKSDB->savedb(); // Save to disk. |
| 117 | @@ -1556,7 +1573,8 @@ function renderPage() | 116 | @@ -1556,7 +1573,8 @@ function renderPage() |
| 118 | $title = (empty($_GET['title']) ? '' : $_GET['title'] ); // Get title if it was provided in URL (by the bookmarklet).[](.html) | 117 | $title = (empty($_GET['title']) ? '' : $_GET['title'] ); // Get title if it was provided in URL (by the bookmarklet). |
| 119 | $description = (empty($_GET['description']) ? '' : $_GET['description']); // Get description if it was provided in URL (by the bookmarklet). [Bronco added that][](.html) | 118 | $description = (empty($_GET['description']) ? '' : $_GET['description']); // Get description if it was provided in URL (by the bookmarklet). [Bronco added that] |
| 120 | $tags = (empty($_GET['tags']) ? '' : $_GET['tags'] ); // Get tags if it was provided in URL[](.html) | 119 | $tags = (empty($_GET['tags']) ? '' : $_GET['tags'] ); // Get tags if it was provided in URL |
| 121 | - $private = (!empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0); // Get private if it was provided in URL [](.html) | 120 | - $private = (!empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0); // Get private if it was provided in URL |
| 122 | + $via = (empty($_GET['via']) ? '' : $_GET['via'] );[](.html) | 121 | + $via = (empty($_GET['via']) ? '' : $_GET['via'] ); |
| 123 | + $private = (!empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0); // Get private if it was provided in URL[](.html) | 122 | + $private = (!empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0); // Get private if it was provided in URL |
| 124 | if (($url!='') && parse_url($url,PHP_URL_SCHEME)=='') $url = 'http://'.$url; | 123 | if (($url!='') && parse_url($url,PHP_URL_SCHEME)=='') $url = 'http://'.$url; |
| 125 | // If this is an HTTP link, we try go get the page to extract the title (otherwise we will to straight to the edit form.) | 124 | // If this is an HTTP link, we try go get the page to extract the title (otherwise we will to straight to the edit form.) |
| 126 | if (empty($title) && parse_url($url,PHP_URL_SCHEME)=='http') | 125 | if (empty($title) && parse_url($url,PHP_URL_SCHEME)=='http') |
| @@ -131,10 +130,10 @@ index 6fae2f8..53f798e 100644 | |||
| 131 | - | 130 | - |
| 132 | + | 131 | + |
| 133 | // If found, extract encoding. | 132 | // If found, extract encoding. |
| 134 | if (!empty($meta[0]))[](.html) | 133 | if (!empty($meta[0])) |
| 135 | { | 134 | { |
| 136 | @@ -1577,7 +1595,7 @@ function renderPage() | 135 | @@ -1577,7 +1595,7 @@ function renderPage() |
| 137 | $html_charset = (!empty($enc[1])) ? strtolower($enc[1]) : 'utf-8';[](.html) | 136 | $html_charset = (!empty($enc[1])) ? strtolower($enc[1]) : 'utf-8'; |
| 138 | } | 137 | } |
| 139 | else { $html_charset = 'utf-8'; } | 138 | else { $html_charset = 'utf-8'; } |
| 140 | - | 139 | - |
| @@ -152,13 +151,13 @@ index 6fae2f8..53f798e 100644 | |||
| 152 | 151 | ||
| 153 | $PAGE = new pageBuilder; | 152 | $PAGE = new pageBuilder; |
| 154 | @@ -1842,6 +1860,9 @@ function buildLinkList($PAGE,$LINKSDB) | 153 | @@ -1842,6 +1860,9 @@ function buildLinkList($PAGE,$LINKSDB) |
| 155 | $taglist = explode(' ',$link['tags']);[](.html) | 154 | $taglist = explode(' ',$link['tags']); |
| 156 | uasort($taglist, 'strcasecmp'); | 155 | uasort($taglist, 'strcasecmp'); |
| 157 | $link['taglist']=$taglist;[](.html) | 156 | $link['taglist']=$taglist; |
| 158 | + if(!empty($link['via'])){[](.html) | 157 | + if(!empty($link['via'])){ |
| 159 | + $link['via']=htmlspecialchars($link['via']);[](.html) | 158 | + $link['via']=htmlspecialchars($link['via']); |
| 160 | + } | 159 | + } |
| 161 | $linkDisp[$keys[$i[ = $link;](-=-$link;.html) | 160 | $linkDisp[$keys[$i]] = $link; |
| 162 | $i++; | 161 | $i++; |
| 163 | } | 162 | } |
| 164 | diff --git a/tpl/editlink.html b/tpl/editlink.html | 163 | diff --git a/tpl/editlink.html b/tpl/editlink.html |
| @@ -170,7 +169,7 @@ index 4a2c30c..14d4f9c 100644 | |||
| 170 | <i>Description</i><br><textarea name="lf_description" rows="4" cols="25" style="width:100%">{$link.description|htmlspecialchars}</textarea><br> | 169 | <i>Description</i><br><textarea name="lf_description" rows="4" cols="25" style="width:100%">{$link.description|htmlspecialchars}</textarea><br> |
| 171 | <i>Tags</i><br><input type="text" id="lf_tags" name="lf_tags" value="{$link.tags|htmlspecialchars}" style="width:100%"><br> | 170 | <i>Tags</i><br><input type="text" id="lf_tags" name="lf_tags" value="{$link.tags|htmlspecialchars}" style="width:100%"><br> |
| 172 | + <i>Origine</i><br><input type="text" name="lf_via" value="{$link.via|htmlspecialchars}" style="width:100%"><br> | 171 | + <i>Origine</i><br><input type="text" name="lf_via" value="{$link.via|htmlspecialchars}" style="width:100%"><br> |
| 173 | {if condition="($link_is_new && $GLOBALS['privateLinkByDefault']==true) || $link.private == true"}[](.html) | 172 | {if condition="($link_is_new && $GLOBALS['privateLinkByDefault']==true) || $link.private == true"} |
| 174 | <input type="checkbox" checked="checked" name="lf_private" id="lf_private"> | 173 | <input type="checkbox" checked="checked" name="lf_private" id="lf_private"> |
| 175 | <label for="lf_private"><i>Private</i></label><br> | 174 | <label for="lf_private"><i>Private</i></label><br> |
| 176 | diff --git a/tpl/linklist.html b/tpl/linklist.html | 175 | diff --git a/tpl/linklist.html b/tpl/linklist.html |
| @@ -182,9 +181,9 @@ index ddc38cb..0a8475f 100644 | |||
| 182 | <br> | 181 | <br> |
| 183 | {if="$value.description"}<div class="linkdescription"{if condition="$search_type=='permalink'"} style="max-height:none !important;"{/if}>{$value.description}</div>{/if} | 182 | {if="$value.description"}<div class="linkdescription"{if condition="$search_type=='permalink'"} style="max-height:none !important;"{/if}>{$value.description}</div>{/if} |
| 184 | + {if condition="isset($value.via) && !empty($value.via)"}<div><a href="{$value.via}">Origine => {$value.via|getJustDomain}</a></div>{/if} | 183 | + {if condition="isset($value.via) && !empty($value.via)"}<div><a href="{$value.via}">Origine => {$value.via|getJustDomain}</a></div>{/if} |
| 185 | {if="!$GLOBALS['config'['HIDE_TIMESTAMPS'] || isLoggedIn()"}]('HIDE_TIMESTAMPS']-||-isLoggedIn()"}.html) | 184 | {if="!$GLOBALS['config']['HIDE_TIMESTAMPS'] || isLoggedIn()"} |
| 186 | <span class="linkdate" title="Permalink"><a href="?{$value.linkdate|smallHash}">{$value.localdate|htmlspecialchars} - permalink</a> - </span> | 185 | <span class="linkdate" title="Permalink"><a href="?{$value.linkdate|smallHash}">{$value.localdate|htmlspecialchars} - permalink</a> - </span> |
| 187 | {else} | 186 | {else} |
| 188 | -- | 187 | -- |
| 189 | 2.1.1 | 188 | 2.1.1 |
| 190 | ``` | 189 | ``` \ No newline at end of file |
diff --git a/doc/FAQ.md b/doc/md/FAQ.md index 4c69763f..151dcef5 100644 --- a/doc/FAQ.md +++ b/doc/md/FAQ.md | |||
| @@ -1,7 +1,6 @@ | |||
| 1 | #FAQ | ||
| 2 | ### Why did you create Shaarli ? | 1 | ### Why did you create Shaarli ? |
| 3 | 2 | ||
| 4 | I was a StumbleUpon user. Then I got fed up with they big toolbar. I switched to delicious, which was lighter, faster and more beautiful. Until Yahoo bought it. Then the export API broke all the time, delicious became slow and was ditched by Yahoo. I switched to Diigo, which is not bad, but does too much. And Diigo is sslllooooowww and their Firefox extension a bit buggy. And… oh… **their Firefox addon sends to Diigo every single URL you visit** (Don't believe me ? Use [Tamper Data](https://addons.mozilla.org/en-US/firefox/addon/tamper-data/) and open any page).[](.html) | 3 | I was a StumbleUpon user. Then I got fed up with they big toolbar. I switched to delicious, which was lighter, faster and more beautiful. Until Yahoo bought it. Then the export API broke all the time, delicious became slow and was ditched by Yahoo. I switched to Diigo, which is not bad, but does too much. And Diigo is sslllooooowww and their Firefox extension a bit buggy. And… oh… **their Firefox addon sends to Diigo every single URL you visit** (Don't believe me ? Use [Tamper Data](https://addons.mozilla.org/en-US/firefox/addon/tamper-data/) and open any page). |
| 5 | 4 | ||
| 6 | Enough is enough. Saving simple links should not be a complicated heavy thing. I ditched them all and wrote my own: Shaarli. It's simple, but it does the job and does it well. And my data is not hosted on a foreign server, but on my server. | 5 | Enough is enough. Saving simple links should not be a complicated heavy thing. I ditched them all and wrote my own: Shaarli. It's simple, but it does the job and does it well. And my data is not hosted on a foreign server, but on my server. |
| 7 | 6 | ||
| @@ -23,21 +22,21 @@ With Shaarli: | |||
| 23 | Shaarli is for shaaring your links. | 22 | Shaarli is for shaaring your links. |
| 24 | 23 | ||
| 25 | ### My Shaarli is broken! | 24 | ### My Shaarli is broken! |
| 26 | First of all, ensure that both the [web server](Server-configuration) and [Shaarli](Shaarli-configuration) are correctly configured, and that your installation is [supported](Server-requirements).[](.html) | 25 | First of all, ensure that both the [web server](Server-configuration) and [Shaarli](Shaarli-configuration) are correctly configured, and that your installation is [supported](Server-requirements). |
| 27 | 26 | ||
| 28 | If everything looks right but the issue(s) remain(s), please: | 27 | If everything looks right but the issue(s) remain(s), please: |
| 29 | - take a look at the [troubleshooting](Troubleshooting) section[](.html) | 28 | - take a look at the [troubleshooting](Troubleshooting) section |
| 30 | - come [chat with us](https://gitter.im/shaarli/Shaarli) on Gitter, we'll be happy to help ;-)[](.html) | 29 | - come [chat with us](https://gitter.im/shaarli/Shaarli) on Gitter, we'll be happy to help ;-) |
| 31 | - browse active [issues](https://github.com/shaarli/Shaarli/issues) and [Pull Requests](https://github.com/shaarli/Shaarli/pulls)[](.html) | 30 | - browse active [issues](https://github.com/shaarli/Shaarli/issues) and [Pull Requests](https://github.com/shaarli/Shaarli/pulls) |
| 32 | - if you find one that is related to the issue, feel free to comment and provide additional details (host/Shaarli setup) | 31 | - if you find one that is related to the issue, feel free to comment and provide additional details (host/Shaarli setup) |
| 33 | - else, [open a new issue](https://github.com/shaarli/Shaarli/issues/new), and provide information about the problem:[](.html) | 32 | - else, [open a new issue](https://github.com/shaarli/Shaarli/issues/new), and provide information about the problem: |
| 34 | - _what happens?_ - display glitches, invalid data, security flaws... | 33 | - _what happens?_ - display glitches, invalid data, security flaws... |
| 35 | - _what is your configuration?_ - OS, server version, activated extensions, web browser... | 34 | - _what is your configuration?_ - OS, server version, activated extensions, web browser... |
| 36 | - _is it reproducible?_ | 35 | - _is it reproducible?_ |
| 37 | 36 | ||
| 38 | ### Why not use a real database? Files are slow! | 37 | ### Why not use a real database? Files are slow! |
| 39 | 38 | ||
| 40 | Does browsing [this page](http://sebsauvage.net/links/) feel slow? Try browsing older pages, too.[](.html) | 39 | Does browsing [this page](http://sebsauvage.net/links/) feel slow? Try browsing older pages, too. |
| 41 | 40 | ||
| 42 | It's not slow at all, is it? And don't forget the database contains more than 16000 links, and it's on a shared host, with 32000 visitors/day for my website alone. And it's still damn fast. Why? | 41 | It's not slow at all, is it? And don't forget the database contains more than 16000 links, and it's on a shared host, with 32000 visitors/day for my website alone. And it's still damn fast. Why? |
| 43 | 42 | ||
diff --git a/doc/Usage.md b/doc/md/Features.md index 30ad1466..116b1c9c 100644 --- a/doc/Usage.md +++ b/doc/md/Features.md | |||
| @@ -1,4 +1,3 @@ | |||
| 1 | #Usage | ||
| 2 | ### Main features | 1 | ### Main features |
| 3 | Shaarli is intended: | 2 | Shaarli is intended: |
| 4 | * to share, comment and save interesting links and news | 3 | * to share, comment and save interesting links and news |
| @@ -13,7 +12,7 @@ Shaarli is intended: | |||
| 13 | * to store playlists (e.g. with the `music` or `video` tags) | 12 | * to store playlists (e.g. with the `music` or `video` tags) |
| 14 | * to keep extracts/comments from webpages that may disappear | 13 | * to keep extracts/comments from webpages that may disappear |
| 15 | * to keep track of ongoing discussions (for example items tagged `discussion`) | 14 | * to keep track of ongoing discussions (for example items tagged `discussion`) |
| 16 | * [to feed RSS aggregators](http://shaarli.chassegnouf.net/?9Efeiw) (planets) with specific tags[](.html) | 15 | * [to feed RSS aggregators](http://shaarli.chassegnouf.net/?9Efeiw) (planets) with specific tags |
| 17 | * to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...) | 16 | * to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...) |
| 18 | 17 | ||
| 19 | ### Using Shaarli as a blog, notepad, pastebin... | 18 | ### Using Shaarli as a blog, notepad, pastebin... |
diff --git a/doc/Firefox-share.md b/doc/md/Firefox-share.md index 58adc58f..9ba57b04 100644 --- a/doc/Firefox-share.md +++ b/doc/md/Firefox-share.md | |||
| @@ -1,4 +1,3 @@ | |||
| 1 | #Firefox share | ||
| 2 | ### Add Shaarli as a sharing service to Firefox | 1 | ### Add Shaarli as a sharing service to Firefox |
| 3 | 2 | ||
| 4 | * Open your Shaarli and `Login` | 3 | * Open your Shaarli and `Login` |
| @@ -9,7 +8,7 @@ | |||
| 9 | ### Sharing links using Firefox share | 8 | ### Sharing links using Firefox share |
| 10 | 9 | ||
| 11 | * Add the sharing service as described above | 10 | * Add the sharing service as described above |
| 12 | * When you are visiting a webpage you would like to share with Shaarli, click the Firefox _Share_ button [images/firefoxshare.png](images/firefoxshare.png.html) | 11 | * When you are visiting a webpage you would like to share with Shaarli, click the Firefox _Share_ button [[images/firefoxshare.png]] |
| 13 | * You can edit your link before and after saving, just like the bookmarklet above. | 12 | * You can edit your link before and after saving, just like the bookmarklet above. |
| 14 | 13 | ||
| 15 | | | Your Shaarli instance must be hosted on an HTTPS (SSL/TLS secure connection) enabled server for Firefox Share to work. Firefox Share will not work over plain HTTP connections. | | 14 | | | Your Shaarli instance must be hosted on an HTTPS (SSL/TLS secure connection) enabled server for Firefox Share to work. Firefox Share will not work over plain HTTP connections. | |
diff --git a/doc/GnuPG-signature.md b/doc/md/GnuPG-signature.md index b0028d55..1fb3b42f 100644 --- a/doc/GnuPG-signature.md +++ b/doc/md/GnuPG-signature.md | |||
| @@ -1,27 +1,26 @@ | |||
| 1 | #GnuPG signature | ||
| 2 | ## Introduction | 1 | ## Introduction |
| 3 | ### PGP and GPG | 2 | ### PGP and GPG |
| 4 | [Gnu Privacy Guard](https://gnupg.org/) (GnuPG) is an Open Source implementation of the [Pretty Good [](.html) | 3 | [Gnu Privacy Guard](https://gnupg.org/) (GnuPG) is an Open Source implementation of the [Pretty Good |
| 5 | Privacy](https://en.wikipedia.org/wiki/Pretty_Good_Privacy#OpenPGP) (OpenPGP) specification. Its main purposes are digital authentication, | 4 | Privacy](https://en.wikipedia.org/wiki/Pretty_Good_Privacy#OpenPGP) (OpenPGP) specification. Its main purposes are digital authentication, |
| 6 | signature and encryption. | 5 | signature and encryption. |
| 7 | 6 | ||
| 8 | It is often used by the [FLOSS](https://en.wikipedia.org/wiki/Free_and_open-source_software) community to verify:[](.html) | 7 | It is often used by the [FLOSS](https://en.wikipedia.org/wiki/Free_and_open-source_software) community to verify: |
| 9 | - Linux package signatures: Debian [SecureApt](https://wiki.debian.org/SecureApt), ArchLinux [Master [](.html) | 8 | - Linux package signatures: Debian [SecureApt](https://wiki.debian.org/SecureApt), ArchLinux [Master |
| 10 | Keys](https://www.archlinux.org/master-keys/) | 9 | Keys](https://www.archlinux.org/master-keys/) |
| 11 | - [SCM](https://en.wikipedia.org/wiki/Revision_control) releases & maintainer identity[](.html) | 10 | - [SCM](https://en.wikipedia.org/wiki/Revision_control) releases & maintainer identity |
| 12 | 11 | ||
| 13 | ### Trust | 12 | ### Trust |
| 14 | To quote Phil Pennock (the author of the [SKS](https://bitbucket.org/skskeyserver/sks-keyserver/wiki/Home) key server - http://sks.spodhuis.org/):[](.html) | 13 | To quote Phil Pennock (the author of the [SKS](https://bitbucket.org/skskeyserver/sks-keyserver/wiki/Home) key server - http://sks.spodhuis.org/): |
| 15 | 14 | ||
| 16 | > You MUST understand that presence of data in the keyserver (pools) in no way connotes trust. Anyone can generate a key, with any name or email address, and upload it. All security and trust comes from evaluating security at the “object level”, via PGP Web-Of-Trust signatures. This keyserver makes it possible to retrieve keys, looking them up via various indices, but the collection of keys in this public pool is KNOWN to contain malicious and fraudulent keys. It is the common expectation of server operators that users understand this and use software which, like all known common OpenPGP implementations, evaluates trust accordingly. This expectation is so common that it is not normally explicitly stated. | 15 | > You MUST understand that presence of data in the keyserver (pools) in no way connotes trust. Anyone can generate a key, with any name or email address, and upload it. All security and trust comes from evaluating security at the “object level”, via PGP Web-Of-Trust signatures. This keyserver makes it possible to retrieve keys, looking them up via various indices, but the collection of keys in this public pool is KNOWN to contain malicious and fraudulent keys. It is the common expectation of server operators that users understand this and use software which, like all known common OpenPGP implementations, evaluates trust accordingly. This expectation is so common that it is not normally explicitly stated. |
| 17 | 16 | ||
| 18 | Trust can be gained by having your key signed by other people (and signing their key back, too :) ), for instance during [key signing parties](https://en.wikipedia.org/wiki/Key_signing_party), see:[](.html) | 17 | Trust can be gained by having your key signed by other people (and signing their key back, too :) ), for instance during [key signing parties](https://en.wikipedia.org/wiki/Key_signing_party), see: |
| 19 | - [The Keysigning party HOWTO](http://www.cryptnet.net/fdp/crypto/keysigning_party/en/keysigning_party.html)[](.html) | 18 | - [The Keysigning party HOWTO](http://www.cryptnet.net/fdp/crypto/keysigning_party/en/keysigning_party.html) |
| 20 | - [Web of trust](https://en.wikipedia.org/wiki/Web_of_trust)[](.html) | 19 | - [Web of trust](https://en.wikipedia.org/wiki/Web_of_trust) |
| 21 | 20 | ||
| 22 | ## Generate a GPG key | 21 | ## Generate a GPG key |
| 23 | - [Generating a GPG key for Git tagging](http://stackoverflow.com/a/16725717) (StackOverflow)[](.html) | 22 | - [Generating a GPG key for Git tagging](http://stackoverflow.com/a/16725717) (StackOverflow) |
| 24 | - [Generating a GPG key](https://help.github.com/articles/generating-a-gpg-key/) (GitHub)[](.html) | 23 | - [Generating a GPG key](https://help.github.com/articles/generating-a-gpg-key/) (GitHub) |
| 25 | 24 | ||
| 26 | ### gpg - provide identity information | 25 | ### gpg - provide identity information |
| 27 | ```bash | 26 | ```bash |
| @@ -62,7 +61,7 @@ gpg: 3 marginal(s) needed, 1 complete(s) needed, PGP trust model | |||
| 62 | gpg: depth: 0 valid: 2 signed: 0 trust: 0-, 0q, 0n, 0m, 0f, 2u | 61 | gpg: depth: 0 valid: 2 signed: 0 trust: 0-, 0q, 0n, 0m, 0f, 2u |
| 63 | pub rsa2048/A9D53A3E 2015-07-31 | 62 | pub rsa2048/A9D53A3E 2015-07-31 |
| 64 | Key fingerprint = AF2A 5381 E54B 2FD2 14C4 A9A3 0E35 ACA4 A9D5 3A3E | 63 | Key fingerprint = AF2A 5381 E54B 2FD2 14C4 A9A3 0E35 ACA4 A9D5 3A3E |
| 65 | uid [ultimate] Marvin the Paranoid Android <marvin@h2g2.net>[](.html) | 64 | uid [ultimate] Marvin the Paranoid Android <marvin@h2g2.net> |
| 66 | sub rsa2048/8C0EACF1 2015-07-31 | 65 | sub rsa2048/8C0EACF1 2015-07-31 |
| 67 | ``` | 66 | ``` |
| 68 | 67 | ||
| @@ -74,4 +73,4 @@ gpg: sending key A9D53A3E to hkp server pgp.mit.edu | |||
| 74 | 73 | ||
| 75 | ## Create and push a GPG-signed tag | 74 | ## Create and push a GPG-signed tag |
| 76 | 75 | ||
| 77 | See [Release Shaarli](Release-Shaarli.html). | 76 | See [[Release Shaarli]]. |
diff --git a/doc/Plugin-System.md b/doc/md/Plugin-System.md index addd792d..d55ffe7e 100644 --- a/doc/Plugin-System.md +++ b/doc/md/Plugin-System.md | |||
| @@ -1,7 +1,6 @@ | |||
| 1 | #Plugin System | 1 | [**I am a developer.** Developer API.](#developer-api) |
| 2 | [**I am a developer.** Developer API.](#developer-api)[](.html) | ||
| 3 | 2 | ||
| 4 | [**I am a template designer.** Guide for template designer.](#guide-for-template-designer)[](.html) | 3 | [**I am a template designer.** Guide for template designer.](#guide-for-template-designer) |
| 5 | 4 | ||
| 6 | ## Developer API | 5 | ## Developer API |
| 7 | 6 | ||
| @@ -48,7 +47,7 @@ hook_<plugin_name>_<hook_name>($data, $conf) | |||
| 48 | 47 | ||
| 49 | Parameters: | 48 | Parameters: |
| 50 | 49 | ||
| 51 | - data: see [$data section](https://github.com/shaarli/Shaarli/wiki/Plugin-System#plugins-data)[](.html) | 50 | - data: see [$data section](https://github.com/shaarli/Shaarli/wiki/Plugin-System#plugins-data) |
| 52 | - conf: the `ConfigManager` instance. | 51 | - conf: the `ConfigManager` instance. |
| 53 | 52 | ||
| 54 | For exemple, if my plugin want to add data to the header, this function is needed: | 53 | For exemple, if my plugin want to add data to the header, this function is needed: |
| @@ -76,9 +75,9 @@ RainTPL displays every element contained in the placeholder's array. These eleme | |||
| 76 | For example, let's add a value in the placeholder `top_placeholder` which is displayed at the top of my page: | 75 | For example, let's add a value in the placeholder `top_placeholder` which is displayed at the top of my page: |
| 77 | 76 | ||
| 78 | ```php | 77 | ```php |
| 79 | $data['top_placeholder'[] = 'My content';](]-=-'My-content';.html) | 78 | $data['top_placeholder'][] = 'My content'; |
| 80 | # OR | 79 | # OR |
| 81 | array_push($data['top_placeholder'], 'My', 'content');[](.html) | 80 | array_push($data['top_placeholder'], 'My', 'content'); |
| 82 | 81 | ||
| 83 | return $data; | 82 | return $data; |
| 84 | ``` | 83 | ``` |
| @@ -93,9 +92,9 @@ For exemple, in linklist, it is possible to alter every title: | |||
| 93 | 92 | ||
| 94 | ```php | 93 | ```php |
| 95 | // mind the reference if you want $data to be altered | 94 | // mind the reference if you want $data to be altered |
| 96 | foreach ($data['links'] as &$value) {[](.html) | 95 | foreach ($data['links'] as &$value) { |
| 97 | // String reverse every title. | 96 | // String reverse every title. |
| 98 | $value['title'] = strrev($value['title']);[](.html) | 97 | $value['title'] = strrev($value['title']); |
| 99 | } | 98 | } |
| 100 | 99 | ||
| 101 | return $data; | 100 | return $data; |
| @@ -117,25 +116,25 @@ Each file contain two keys: | |||
| 117 | 116 | ||
| 118 | Use `demo_plugin` as a functional example. It covers most of the plugin system features. | 117 | Use `demo_plugin` as a functional example. It covers most of the plugin system features. |
| 119 | 118 | ||
| 120 | If it's still not working, please [open an issue](https://github.com/shaarli/Shaarli/issues/new).[](.html) | 119 | If it's still not working, please [open an issue](https://github.com/shaarli/Shaarli/issues/new). |
| 121 | 120 | ||
| 122 | ### Hooks | 121 | ### Hooks |
| 123 | 122 | ||
| 124 | | Hooks | Description | | 123 | | Hooks | Description | |
| 125 | | ------------- |:-------------:| | 124 | | ------------- |:-------------:| |
| 126 | | [render_header](#render_header) | Allow plugin to add content in page headers. |[](.html) | 125 | | [render_header](#render_header) | Allow plugin to add content in page headers. | |
| 127 | | [render_includes](#render_includes) | Allow plugin to include their own CSS files. |[](.html) | 126 | | [render_includes](#render_includes) | Allow plugin to include their own CSS files. | |
| 128 | | [render_footer](#render_footer) | Allow plugin to add content in page footer and include their own JS files. | [](.html) | 127 | | [render_footer](#render_footer) | Allow plugin to add content in page footer and include their own JS files. | |
| 129 | | [render_linklist](#render_linklist) | It allows to add content at the begining and end of the page, after every link displayed and to alter link data. |[](.html) | 128 | | [render_linklist](#render_linklist) | It allows to add content at the begining and end of the page, after every link displayed and to alter link data. | |
| 130 | | [render_editlink](#render_editlink) | Allow to add fields in the form, or display elements. |[](.html) | 129 | | [render_editlink](#render_editlink) | Allow to add fields in the form, or display elements. | |
| 131 | | [render_tools](#render_tools) | Allow to add content at the end of the page. |[](.html) | 130 | | [render_tools](#render_tools) | Allow to add content at the end of the page. | |
| 132 | | [render_picwall](#render_picwall) | Allow to add content at the top and bottom of the page. |[](.html) | 131 | | [render_picwall](#render_picwall) | Allow to add content at the top and bottom of the page. | |
| 133 | | [render_tagcloud](#render_tagcloud) | Allow to add content at the top and bottom of the page, and after all tags. |[](.html) | 132 | | [render_tagcloud](#render_tagcloud) | Allow to add content at the top and bottom of the page, and after all tags. | |
| 134 | | [render_taglist](#render_taglist) | Allow to add content at the top and bottom of the page, and after all tags. |[](.html) | 133 | | [render_taglist](#render_taglist) | Allow to add content at the top and bottom of the page, and after all tags. | |
| 135 | | [render_daily](#render_daily) | Allow to add content at the top and bottom of the page, the bottom of each link and to alter data. |[](.html) | 134 | | [render_daily](#render_daily) | Allow to add content at the top and bottom of the page, the bottom of each link and to alter data. | |
| 136 | | [render_feed](#render_feed) | Allow to do add tags in RSS and ATOM feeds. |[](.html) | 135 | | [render_feed](#render_feed) | Allow to do add tags in RSS and ATOM feeds. | |
| 137 | | [save_link](#save_link) | Allow to alter the link being saved in the datastore. |[](.html) | 136 | | [save_link](#save_link) | Allow to alter the link being saved in the datastore. | |
| 138 | | [delete_link](#delete_link) | Allow to do an action before a link is deleted from the datastore. |[](.html) | 137 | | [delete_link](#delete_link) | Allow to do an action before a link is deleted from the datastore. | |
| 139 | 138 | ||
| 140 | 139 | ||
| 141 | 140 | ||
| @@ -154,19 +153,19 @@ Allow plugin to add content in page headers. | |||
| 154 | 153 | ||
| 155 | ##### Template placeholders | 154 | ##### Template placeholders |
| 156 | 155 | ||
| 157 | Items can be displayed in templates by adding an entry in `$data['<placeholder>']` array.[](.html) | 156 | Items can be displayed in templates by adding an entry in `$data['<placeholder>']` array. |
| 158 | 157 | ||
| 159 | List of placeholders: | 158 | List of placeholders: |
| 160 | 159 | ||
| 161 | * `buttons_toolbar`: after the list of buttons in the header. | 160 | * `buttons_toolbar`: after the list of buttons in the header. |
| 162 | 161 | ||
| 163 | [](.html) | 162 |  |
| 164 | 163 | ||
| 165 | * `fields_toolbar`: after search fields in the header. | 164 | * `fields_toolbar`: after search fields in the header. |
| 166 | 165 | ||
| 167 | > Note: This will only be called in linklist. | 166 | > Note: This will only be called in linklist. |
| 168 | 167 | ||
| 169 | [](.html) | 168 |  |
| 170 | 169 | ||
| 171 | #### render_includes | 170 | #### render_includes |
| 172 | 171 | ||
| @@ -183,7 +182,7 @@ Allow plugin to include their own CSS files. | |||
| 183 | 182 | ||
| 184 | ##### Template placeholders | 183 | ##### Template placeholders |
| 185 | 184 | ||
| 186 | Items can be displayed in templates by adding an entry in `$data['<placeholder>']` array.[](.html) | 185 | Items can be displayed in templates by adding an entry in `$data['<placeholder>']` array. |
| 187 | 186 | ||
| 188 | List of placeholders: | 187 | List of placeholders: |
| 189 | 188 | ||
| @@ -206,14 +205,14 @@ Allow plugin to add content in page footer and include their own JS files. | |||
| 206 | 205 | ||
| 207 | ##### Template placeholders | 206 | ##### Template placeholders |
| 208 | 207 | ||
| 209 | Items can be displayed in templates by adding an entry in `$data['<placeholder>']` array.[](.html) | 208 | Items can be displayed in templates by adding an entry in `$data['<placeholder>']` array. |
| 210 | 209 | ||
| 211 | List of placeholders: | 210 | List of placeholders: |
| 212 | 211 | ||
| 213 | * `text`: called after the end of the footer text. | 212 | * `text`: called after the end of the footer text. |
| 214 | * `endofpage`: called at the end of the page. | 213 | * `endofpage`: called at the end of the page. |
| 215 | 214 | ||
| 216 | [](.html) | 215 |  |
| 217 | 216 | ||
| 218 | * `js_files`: called at the end of the page, to include custom JS scripts. | 217 | * `js_files`: called at the end of the page, to include custom JS scripts. |
| 219 | 218 | ||
| @@ -234,25 +233,25 @@ It allows to add content at the begining and end of the page, after every link d | |||
| 234 | 233 | ||
| 235 | ##### Template placeholders | 234 | ##### Template placeholders |
| 236 | 235 | ||
| 237 | Items can be displayed in templates by adding an entry in `$data['<placeholder>']` array.[](.html) | 236 | Items can be displayed in templates by adding an entry in `$data['<placeholder>']` array. |
| 238 | 237 | ||
| 239 | List of placeholders: | 238 | List of placeholders: |
| 240 | 239 | ||
| 241 | * `action_plugin`: next to the button "private only" at the top and bottom of the page. | 240 | * `action_plugin`: next to the button "private only" at the top and bottom of the page. |
| 242 | 241 | ||
| 243 | [](.html) | 242 |  |
| 244 | 243 | ||
| 245 | * `link_plugin`: for every link, between permalink and link URL. | 244 | * `link_plugin`: for every link, between permalink and link URL. |
| 246 | 245 | ||
| 247 | [](.html) | 246 |  |
| 248 | 247 | ||
| 249 | * `plugin_start_zone`: before displaying the template content. | 248 | * `plugin_start_zone`: before displaying the template content. |
| 250 | 249 | ||
| 251 | [](.html) | 250 |  |
| 252 | 251 | ||
| 253 | * `plugin_end_zone`: after displaying the template content. | 252 | * `plugin_end_zone`: after displaying the template content. |
| 254 | 253 | ||
| 255 | [](.html) | 254 |  |
| 256 | 255 | ||
| 257 | #### render_editlink | 256 | #### render_editlink |
| 258 | 257 | ||
| @@ -268,13 +267,13 @@ Allow to add fields in the form, or display elements. | |||
| 268 | 267 | ||
| 269 | ##### Template placeholders | 268 | ##### Template placeholders |
| 270 | 269 | ||
| 271 | Items can be displayed in templates by adding an entry in `$data['<placeholder>']` array.[](.html) | 270 | Items can be displayed in templates by adding an entry in `$data['<placeholder>']` array. |
| 272 | 271 | ||
| 273 | List of placeholders: | 272 | List of placeholders: |
| 274 | 273 | ||
| 275 | * `edit_link_plugin`: after tags field. | 274 | * `edit_link_plugin`: after tags field. |
| 276 | 275 | ||
| 277 | [](.html) | 276 |  |
| 278 | 277 | ||
| 279 | #### render_tools | 278 | #### render_tools |
| 280 | 279 | ||
| @@ -290,13 +289,13 @@ Allow to add content at the end of the page. | |||
| 290 | 289 | ||
| 291 | ##### Template placeholders | 290 | ##### Template placeholders |
| 292 | 291 | ||
| 293 | Items can be displayed in templates by adding an entry in `$data['<placeholder>']` array.[](.html) | 292 | Items can be displayed in templates by adding an entry in `$data['<placeholder>']` array. |
| 294 | 293 | ||
| 295 | List of placeholders: | 294 | List of placeholders: |
| 296 | 295 | ||
| 297 | * `tools_plugin`: at the end of the page. | 296 | * `tools_plugin`: at the end of the page. |
| 298 | 297 | ||
| 299 | [](.html) | 298 |  |
| 300 | 299 | ||
| 301 | #### render_picwall | 300 | #### render_picwall |
| 302 | 301 | ||
| @@ -313,7 +312,7 @@ Allow to add content at the top and bottom of the page. | |||
| 313 | 312 | ||
| 314 | ##### Template placeholders | 313 | ##### Template placeholders |
| 315 | 314 | ||
| 316 | Items can be displayed in templates by adding an entry in `$data['<placeholder>']` array.[](.html) | 315 | Items can be displayed in templates by adding an entry in `$data['<placeholder>']` array. |
| 317 | 316 | ||
| 318 | List of placeholders: | 317 | List of placeholders: |
| 319 | 318 | ||
| @@ -321,7 +320,7 @@ List of placeholders: | |||
| 321 | 320 | ||
| 322 | * `plugin_end_zone`: after displaying the template content. | 321 | * `plugin_end_zone`: after displaying the template content. |
| 323 | 322 | ||
| 324 | [](.html) | 323 |  |
| 325 | 324 | ||
| 326 | #### render_tagcloud | 325 | #### render_tagcloud |
| 327 | 326 | ||
| @@ -338,7 +337,7 @@ Allow to add content at the top and bottom of the page. | |||
| 338 | 337 | ||
| 339 | ##### Template placeholders | 338 | ##### Template placeholders |
| 340 | 339 | ||
| 341 | Items can be displayed in templates by adding an entry in `$data['<placeholder>']` array.[](.html) | 340 | Items can be displayed in templates by adding an entry in `$data['<placeholder>']` array. |
| 342 | 341 | ||
| 343 | List of placeholders: | 342 | List of placeholders: |
| 344 | 343 | ||
| @@ -350,7 +349,7 @@ For each tag, the following placeholder can be used: | |||
| 350 | 349 | ||
| 351 | * `tag_plugin`: after each tag | 350 | * `tag_plugin`: after each tag |
| 352 | 351 | ||
| 353 | [](.html) | 352 |  |
| 354 | 353 | ||
| 355 | 354 | ||
| 356 | #### render_taglist | 355 | #### render_taglist |
| @@ -368,7 +367,7 @@ Allow to add content at the top and bottom of the page. | |||
| 368 | 367 | ||
| 369 | ##### Template placeholders | 368 | ##### Template placeholders |
| 370 | 369 | ||
| 371 | Items can be displayed in templates by adding an entry in `$data['<placeholder>']` array.[](.html) | 370 | Items can be displayed in templates by adding an entry in `$data['<placeholder>']` array. |
| 372 | 371 | ||
| 373 | List of placeholders: | 372 | List of placeholders: |
| 374 | 373 | ||
| @@ -395,13 +394,13 @@ Allow to add content at the top and bottom of the page, the bottom of each link | |||
| 395 | 394 | ||
| 396 | ##### Template placeholders | 395 | ##### Template placeholders |
| 397 | 396 | ||
| 398 | Items can be displayed in templates by adding an entry in `$data['<placeholder>']` array.[](.html) | 397 | Items can be displayed in templates by adding an entry in `$data['<placeholder>']` array. |
| 399 | 398 | ||
| 400 | List of placeholders: | 399 | List of placeholders: |
| 401 | 400 | ||
| 402 | * `link_plugin`: used at bottom of each link. | 401 | * `link_plugin`: used at bottom of each link. |
| 403 | 402 | ||
| 404 | [](.html) | 403 |  |
| 405 | 404 | ||
| 406 | * `plugin_start_zone`: before displaying the template content. | 405 | * `plugin_start_zone`: before displaying the template content. |
| 407 | 406 | ||
| @@ -423,7 +422,7 @@ Allow to add tags in the feed, either in the header or for each items. Items (li | |||
| 423 | 422 | ||
| 424 | ##### Template placeholders | 423 | ##### Template placeholders |
| 425 | 424 | ||
| 426 | Tags can be added in feeds by adding an entry in `$data['<placeholder>']` array.[](.html) | 425 | Tags can be added in feeds by adding an entry in `$data['<placeholder>']` array. |
| 427 | 426 | ||
| 428 | List of placeholders: | 427 | List of placeholders: |
| 429 | 428 | ||
diff --git a/doc/Plugins.md b/doc/md/Plugins.md index e3192a60..b52b8090 100644 --- a/doc/Plugins.md +++ b/doc/md/Plugins.md | |||
| @@ -1,4 +1,3 @@ | |||
| 1 | #Plugins | ||
| 2 | ## Plugin installation | 1 | ## Plugin installation |
| 3 | 2 | ||
| 4 | There is a bunch of plugins shipped with Shaarli, where there is nothing to do to install them. | 3 | There is a bunch of plugins shipped with Shaarli, where there is nothing to do to install them. |
| @@ -26,7 +25,7 @@ In Shaarli's administration page (`Tools` link), go to `Plugin administration`. | |||
| 26 | 25 | ||
| 27 | Here you can enable and disable all plugins available, and configure them. | 26 | Here you can enable and disable all plugins available, and configure them. |
| 28 | 27 | ||
| 29 | [](.html) | 28 |  |
| 30 | 29 | ||
| 31 | ## Plugin order | 30 | ## Plugin order |
| 32 | 31 | ||
| @@ -41,14 +40,14 @@ This is important in case plugins are depending on each other. Read plugins READ | |||
| 41 | Enabled plugin are stored in your `config.php` parameters file, under the `array`: | 40 | Enabled plugin are stored in your `config.php` parameters file, under the `array`: |
| 42 | 41 | ||
| 43 | ```php | 42 | ```php |
| 44 | $GLOBALS['config'['ENABLED_PLUGINS']]('ENABLED_PLUGINS'].html) | 43 | $GLOBALS['config']['ENABLED_PLUGINS'] |
| 45 | ``` | 44 | ``` |
| 46 | 45 | ||
| 47 | You can edit them manually here. | 46 | You can edit them manually here. |
| 48 | Example: | 47 | Example: |
| 49 | 48 | ||
| 50 | ```php | 49 | ```php |
| 51 | $GLOBALS['config'['ENABLED_PLUGINS'] = array(]('ENABLED_PLUGINS']-=-array(.html) | 50 | $GLOBALS['config']['ENABLED_PLUGINS'] = array( |
| 52 | 'qrcode', | 51 | 'qrcode', |
| 53 | 'archiveorg', | 52 | 'archiveorg', |
| 54 | 'wallabag', | 53 | 'wallabag', |
| @@ -64,13 +63,13 @@ Usage of each plugin is documented in it's README file: | |||
| 64 | 63 | ||
| 65 | * `addlink-toolbar`: Adds the addlink input on the linklist page | 64 | * `addlink-toolbar`: Adds the addlink input on the linklist page |
| 66 | * `archiveorg`: For each link, add an Archive.org icon | 65 | * `archiveorg`: For each link, add an Archive.org icon |
| 67 | * [`markdown`](https://github.com/shaarli/Shaarli/blob/master/plugins/markdown/README.md): Render shaare description with Markdown syntax.[](.html) | 66 | * [`markdown`](https://github.com/shaarli/Shaarli/blob/master/plugins/markdown/README.md): Render shaare description with Markdown syntax. |
| 68 | * [`playvideos`](https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md): Add a button in the toolbar allowing to watch all videos.[](.html) | 67 | * [`playvideos`](https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md): Add a button in the toolbar allowing to watch all videos. |
| 69 | * `qrcode`: For each link, add a QRCode icon. | 68 | * `qrcode`: For each link, add a QRCode icon. |
| 70 | * [`wallabag`](https://github.com/shaarli/Shaarli/blob/master/plugins/wallabag/README.md): For each link, add a Wallabag icon to save it in your instance.[](.html) | 69 | * [`wallabag`](https://github.com/shaarli/Shaarli/blob/master/plugins/wallabag/README.md): For each link, add a Wallabag icon to save it in your instance. |
| 71 | 70 | ||
| 72 | 71 | ||
| 73 | 72 | ||
| 74 | #### Third party plugins | 73 | #### Third party plugins |
| 75 | 74 | ||
| 76 | See [Community & related software](https://github.com/shaarli/Shaarli/wiki/Community-%26-Related-software#third-party-plugins)[](.html) | 75 | See [Community & related software](https://github.com/shaarli/Shaarli/wiki/Community-%26-Related-software#third-party-plugins) |
diff --git a/doc/md/REST-API.md b/doc/md/REST-API.md new file mode 100644 index 00000000..8f3f7303 --- /dev/null +++ b/doc/md/REST-API.md | |||
| @@ -0,0 +1,104 @@ | |||
| 1 | ## Usage | ||
| 2 | |||
| 3 | See the [REST API documentation](http://shaarli.github.io/api-documentation/). | ||
| 4 | |||
| 5 | ## Authentication | ||
| 6 | |||
| 7 | All requests to Shaarli's API must include a JWT token to verify their authenticity. | ||
| 8 | |||
| 9 | This token has to be included as an HTTP header called `Authentication: Bearer <jwt token>`. | ||
| 10 | |||
| 11 | JWT resources : | ||
| 12 | |||
| 13 | * [jwt.io](https://jwt.io) (including a list of client per language). | ||
| 14 | * RFC : https://tools.ietf.org/html/rfc7519 | ||
| 15 | * https://float-middle.com/json-web-tokens-jwt-vs-sessions/ | ||
| 16 | * HackerNews thread: https://news.ycombinator.com/item?id=11929267 | ||
| 17 | |||
| 18 | |||
| 19 | ### Shaarli JWT Token | ||
| 20 | |||
| 21 | JWT tokens are composed by three parts, separated by a dot `.` and encoded in base64: | ||
| 22 | |||
| 23 | ``` | ||
| 24 | [header].[payload].[signature] | ||
| 25 | ``` | ||
| 26 | |||
| 27 | #### Header | ||
| 28 | |||
| 29 | Shaarli only allow one hash algorithm, so the header will always be the same: | ||
| 30 | |||
| 31 | ```json | ||
| 32 | { | ||
| 33 | "typ": "JWT", | ||
| 34 | "alg": "HS512" | ||
| 35 | } | ||
| 36 | ``` | ||
| 37 | |||
| 38 | Encoded in base64, it gives: | ||
| 39 | |||
| 40 | ``` | ||
| 41 | ewogICAgICAgICJ0eXAiOiAiSldUIiwKICAgICAgICAiYWxnIjogIkhTNTEyIgogICAgfQ== | ||
| 42 | ``` | ||
| 43 | |||
| 44 | #### Payload | ||
| 45 | |||
| 46 | **Validity duration** | ||
| 47 | |||
| 48 | To avoid infinite token validity, JWT tokens must include their creation date in UNIX timestamp format (timezone independant - UTC) under the key `iat` (issued at). This token will be accepted during 9 minutes. | ||
| 49 | |||
| 50 | ```json | ||
| 51 | { | ||
| 52 | "iat": 1468663519 | ||
| 53 | } | ||
| 54 | ``` | ||
| 55 | |||
| 56 | See [RFC reference](https://tools.ietf.org/html/rfc7519#section-4.1.6). | ||
| 57 | |||
| 58 | |||
| 59 | #### Signature | ||
| 60 | |||
| 61 | The signature authenticate the token validity. It contains the base64 of the header and the body, separated by a dot `.`, hashed in SHA512 with the API secret available in Shaarli administration page. | ||
| 62 | |||
| 63 | Signature example with PHP: | ||
| 64 | |||
| 65 | ```php | ||
| 66 | $content = base64_encode($header) . '.' . base64_encode($payload); | ||
| 67 | $signature = hash_hmac('sha512', $content, $secret); | ||
| 68 | ``` | ||
| 69 | |||
| 70 | |||
| 71 | ### Complete example | ||
| 72 | |||
| 73 | #### PHP | ||
| 74 | |||
| 75 | ```php | ||
| 76 | function generateToken($secret) { | ||
| 77 | $header = base64_encode('{ | ||
| 78 | "typ": "JWT", | ||
| 79 | "alg": "HS512" | ||
| 80 | }'); | ||
| 81 | $payload = base64_encode('{ | ||
| 82 | "iat": '. time() .' | ||
| 83 | }'); | ||
| 84 | $signature = hash_hmac('sha512', $header .'.'. $payload , $secret); | ||
| 85 | return $header .'.'. $payload .'.'. $signature; | ||
| 86 | } | ||
| 87 | |||
| 88 | $secret = 'mysecret'; | ||
| 89 | $token = generateToken($secret); | ||
| 90 | echo $token; | ||
| 91 | ``` | ||
| 92 | |||
| 93 | > `ewogICAgICAgICJ0eXAiOiAiSldUIiwKICAgICAgICAiYWxnIjogIkhTNTEyIgogICAgfQ==.ewogICAgICAgICJpYXQiOiAxNDY4NjY3MDQ3CiAgICB9.1d2c54fa947daf594fdbf7591796195652c8bc63bffad7f6a6db2a41c313f495a542cbfb595acade79e83f3810d709b4251d7b940bbc10b531a6e6134af63a68` | ||
| 94 | |||
| 95 | ```php | ||
| 96 | $options = [ | ||
| 97 | 'http' => [ | ||
| 98 | 'method' => 'GET', | ||
| 99 | 'jwt' => $token, | ||
| 100 | ], | ||
| 101 | ]; | ||
| 102 | $context = stream_context_create($options); | ||
| 103 | file_get_contents($apiEndpoint, false, $context); | ||
| 104 | ``` | ||
diff --git a/doc/RSS-feeds.md b/doc/md/RSS-feeds.md index 757bed9a..9d718172 100644 --- a/doc/RSS-feeds.md +++ b/doc/md/RSS-feeds.md | |||
| @@ -1,4 +1,3 @@ | |||
| 1 | #RSS feeds | ||
| 2 | ### Feeds options | 1 | ### Feeds options |
| 3 | 2 | ||
| 4 | Feeds are available in ATOM with `?do=atom` and RSS with `do=RSS`. | 3 | Feeds are available in ATOM with `?do=atom` and RSS with `do=RSS`. |
| @@ -24,4 +23,4 @@ For example, if you want to subscribe only to links tagged `photography`: | |||
| 24 | - `https://my.shaarli.domain/?do=rss&searchtags=nature` | 23 | - `https://my.shaarli.domain/?do=rss&searchtags=nature` |
| 25 | - `https://my.shaarli.domain/links/?do=picwall&searchterm=poney` | 24 | - `https://my.shaarli.domain/links/?do=picwall&searchterm=poney` |
| 26 | 25 | ||
| 27 | -!.html)(images/rss-filter-2.png) | 26 |   |
diff --git a/doc/Release-Shaarli.md b/doc/md/Release-Shaarli.md index ced58853..cce5e209 100644 --- a/doc/Release-Shaarli.md +++ b/doc/md/Release-Shaarli.md | |||
| @@ -1,5 +1,4 @@ | |||
| 1 | #Release Shaarli | 1 | See [Git - Maintaining a project - Tagging your |
| 2 | See [Git - Maintaining a project - Tagging your [](.html) | ||
| 3 | releases](http://git-scm.com/book/en/v2/Distributed-Git-Maintaining-a-Project#Tagging-Your-Releases). | 2 | releases](http://git-scm.com/book/en/v2/Distributed-Git-Maintaining-a-Project#Tagging-Your-Releases). |
| 4 | 3 | ||
| 5 | ## Prerequisites | 4 | ## Prerequisites |
| @@ -13,13 +12,13 @@ This guide assumes that you have: | |||
| 13 | - maintainer permissions on the main Shaarli repository, to: | 12 | - maintainer permissions on the main Shaarli repository, to: |
| 14 | - push the signed tag | 13 | - push the signed tag |
| 15 | - create a new release | 14 | - create a new release |
| 16 | - [Composer](https://getcomposer.org/) and [Pandoc](http://pandoc.org/) need to be installed[](.html) | 15 | - [Composer](https://getcomposer.org/) and [Pandoc](http://pandoc.org/) need to be installed |
| 17 | 16 | ||
| 18 | ## GitHub release draft and `CHANGELOG.md` | 17 | ## GitHub release draft and `CHANGELOG.md` |
| 19 | See http://keepachangelog.com/en/0.3.0/ for changelog formatting. | 18 | See http://keepachangelog.com/en/0.3.0/ for changelog formatting. |
| 20 | 19 | ||
| 21 | ### GitHub release draft | 20 | ### GitHub release draft |
| 22 | GitHub allows drafting the release note for the upcoming release, from the [Releases](https://github.com/shaarli/Shaarli/releases) page. This way, the release note can be drafted while contributions are merged to `master`.[](.html) | 21 | GitHub allows drafting the release note for the upcoming release, from the [Releases](https://github.com/shaarli/Shaarli/releases) page. This way, the release note can be drafted while contributions are merged to `master`. |
| 23 | 22 | ||
| 24 | ### `CHANGELOG.md` | 23 | ### `CHANGELOG.md` |
| 25 | This file should contain the same information as the release note draft for the upcoming version. | 24 | This file should contain the same information as the release note draft for the upcoming version. |
| @@ -34,17 +33,17 @@ $ cd /path/to/shaarli | |||
| 34 | 33 | ||
| 35 | $ nano CHANGELOG.md | 34 | $ nano CHANGELOG.md |
| 36 | 35 | ||
| 37 | [...][](.html) | 36 | [...] |
| 38 | ## vA.B.C - UNRELEASED | 37 | ## vA.B.C - UNRELEASED |
| 39 | TBA | 38 | TBA |
| 40 | 39 | ||
| 41 | ## [vX.Y.Z](https://github.com/shaarli/Shaarli/releases/tag/vX.Y.Z) - YYYY-MM-DD[](.html) | 40 | ## [vX.Y.Z](https://github.com/shaarli/Shaarli/releases/tag/vX.Y.Z) - YYYY-MM-DD |
| 42 | [...][](.html) | 41 | [...] |
| 43 | ``` | 42 | ``` |
| 44 | 43 | ||
| 45 | 44 | ||
| 46 | ## Increment the version code, create and push a signed tag | 45 | ## Increment the version code, updated docs, create and push a signed tag |
| 47 | ### Bump Shaarli's version | 46 | ### Generate documentation |
| 48 | ```bash | 47 | ```bash |
| 49 | $ cd /path/to/shaarli | 48 | $ cd /path/to/shaarli |
| 50 | 49 | ||
| @@ -52,15 +51,12 @@ $ cd /path/to/shaarli | |||
| 52 | $ git fetch upstream | 51 | $ git fetch upstream |
| 53 | $ git checkout upstream/master -b v0.5.0 | 52 | $ git checkout upstream/master -b v0.5.0 |
| 54 | 53 | ||
| 55 | # bump the version number | ||
| 56 | $ vim index.php shaarli_version.php | ||
| 57 | |||
| 58 | # rebuild the documentation from the wiki | 54 | # rebuild the documentation from the wiki |
| 59 | $ make htmldoc | 55 | $ make htmldoc |
| 60 | 56 | ||
| 61 | # commit the changes | 57 | # commit the changes |
| 62 | $ git add index.php shaarli_version.php doc | 58 | $ git add doc |
| 63 | $ git commit -s -m "Bump version to v0.5.0" | 59 | $ git commit -s -m "Generate documentation for v0.5.0" |
| 64 | 60 | ||
| 65 | # push the commit on your GitHub fork | 61 | # push the commit on your GitHub fork |
| 66 | $ git push origin v0.5.0 | 62 | $ git push origin v0.5.0 |
| @@ -69,12 +65,32 @@ $ git push origin v0.5.0 | |||
| 69 | ### Create and merge a Pull Request | 65 | ### Create and merge a Pull Request |
| 70 | This one is pretty straightforward ;-) | 66 | This one is pretty straightforward ;-) |
| 71 | 67 | ||
| 68 | ### Bump Shaarli version to v0.x branch | ||
| 69 | |||
| 70 | ``` | ||
| 71 | $ git checkout master | ||
| 72 | $ git fetch upstream | ||
| 73 | $ git pull upstream master | ||
| 74 | |||
| 75 | # IF the branch doesn't exists | ||
| 76 | $ git checkout -b v0.5 | ||
| 77 | # OR if the branch already exists | ||
| 78 | $ git checkout v0.5 | ||
| 79 | $ git rebase upstream/master | ||
| 80 | |||
| 81 | # Bump shaarli version from dev to 0.5.0, **without the `v`** | ||
| 82 | $ vim shaarli_version.php | ||
| 83 | $ git add shaarli_version | ||
| 84 | $ git commit -s -m "Bump Shaarli version to v0.5.0" | ||
| 85 | $ git push upstream v0.5 | ||
| 86 | ``` | ||
| 87 | |||
| 72 | ### Create and push a signed tag | 88 | ### Create and push a signed tag |
| 73 | ```bash | 89 | ```bash |
| 74 | # update your local copy | 90 | # update your local copy |
| 75 | $ git checkout master | 91 | $ git checkout v0.5 |
| 76 | $ git fetch upstream | 92 | $ git fetch upstream |
| 77 | $ git pull upstream master | 93 | $ git pull upstream v0.5 |
| 78 | 94 | ||
| 79 | # create a signed tag | 95 | # create a signed tag |
| 80 | $ git tag -s -m "Release v0.5.0" v0.5.0 | 96 | $ git tag -s -m "Release v0.5.0" v0.5.0 |
| @@ -84,7 +100,7 @@ $ git push --tags upstream | |||
| 84 | ``` | 100 | ``` |
| 85 | 101 | ||
| 86 | ### Verify a signed tag | 102 | ### Verify a signed tag |
| 87 | [`v0.5.0`](https://github.com/shaarli/Shaarli/releases/tag/v0.5.0) is the first GPG-signed tag pushed on the Community Shaarli.[](.html) | 103 | [`v0.5.0`](https://github.com/shaarli/Shaarli/releases/tag/v0.5.0) is the first GPG-signed tag pushed on the Community Shaarli. |
| 88 | 104 | ||
| 89 | Let's have a look at its signature! | 105 | Let's have a look at its signature! |
| 90 | 106 | ||
| @@ -99,12 +115,12 @@ f7762cf803f03f5caf4b8078359a63783d0090c1 refs/tags/v0.5.0 | |||
| 99 | # verify the tag signature information | 115 | # verify the tag signature information |
| 100 | $ git verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1 | 116 | $ git verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1 |
| 101 | gpg: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F | 117 | gpg: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F |
| 102 | gpg: Good signature from "VirtualTam <virtualtam@flibidi.net>" [ultimate][](.html) | 118 | gpg: Good signature from "VirtualTam <virtualtam@flibidi.net>" [ultimate] |
| 103 | ``` | 119 | ``` |
| 104 | 120 | ||
| 105 | ## Publish the GitHub release | 121 | ## Publish the GitHub release |
| 106 | ### Update release badges | 122 | ### Update release badges |
| 107 | Update `README.md` so version badges display and point to the newly released Shaarli version(s). | 123 | Update `README.md` so version badges display and point to the newly released Shaarli version(s), in the `master` branch. |
| 108 | 124 | ||
| 109 | ### Create a GitHub release from a Git tag | 125 | ### Create a GitHub release from a Git tag |
| 110 | From the previously drafted release: | 126 | From the previously drafted release: |
| @@ -120,7 +136,9 @@ Users with a shared hosting may have: | |||
| 120 | - no possibility to run scripts | 136 | - no possibility to run scripts |
| 121 | 137 | ||
| 122 | To ease Shaarli installations, it is possible to generate and upload additional release archives, | 138 | To ease Shaarli installations, it is possible to generate and upload additional release archives, |
| 123 | that will contain Shaarli code plus all required third-party libraries: | 139 | that will contain Shaarli code plus all required third-party libraries. |
| 140 | |||
| 141 | **From the `v0.5` branch:** | ||
| 124 | 142 | ||
| 125 | ```bash | 143 | ```bash |
| 126 | $ make release_archive | 144 | $ make release_archive |
| @@ -131,3 +149,20 @@ This will create the following archives: | |||
| 131 | - `shaarli-vX.Y.Z-full.zip` | 149 | - `shaarli-vX.Y.Z-full.zip` |
| 132 | 150 | ||
| 133 | The archives need to be manually uploaded on the previously created GitHub release. | 151 | The archives need to be manually uploaded on the previously created GitHub release. |
| 152 | |||
| 153 | ### Update `stable` and `latest` branches | ||
| 154 | |||
| 155 | ``` | ||
| 156 | $ git checkout latest | ||
| 157 | # latest release | ||
| 158 | $ git merge v0.5.0 | ||
| 159 | # fix eventual conflicts | ||
| 160 | $ make test | ||
| 161 | $ git push upstream latest | ||
| 162 | $ git checkout stable | ||
| 163 | # latest previous major | ||
| 164 | $ git merge v0.4.5 | ||
| 165 | # fix eventual conflicts | ||
| 166 | $ make test | ||
| 167 | $ git push upstream stable | ||
| 168 | ``` | ||
diff --git a/doc/md/Reverse-proxy-configuration.md b/doc/md/Reverse-proxy-configuration.md new file mode 100644 index 00000000..91ffecff --- /dev/null +++ b/doc/md/Reverse-proxy-configuration.md | |||
| @@ -0,0 +1,6 @@ | |||
| 1 | |||
| 2 | TODO, see https://github.com/shaarli/Shaarli/issues/888 | ||
| 3 | |||
| 4 | ## HAProxy | ||
| 5 | |||
| 6 | ## Nginx | ||
diff --git a/doc/Security.md b/doc/md/Security.md index 7947460c..aec37fa0 100644 --- a/doc/Security.md +++ b/doc/md/Security.md | |||
| @@ -1,4 +1,3 @@ | |||
| 1 | #Security | ||
| 2 | ## Client browser | 1 | ## Client browser |
| 3 | * Shaarli relies on `HTTP_REFERER` for some functions (like redirects and clicking on tags). If you have disabled or masqueraded `HTTP_REFERER` in your browser, some features of Shaarli may not work | 2 | * Shaarli relies on `HTTP_REFERER` for some functions (like redirects and clicking on tags). If you have disabled or masqueraded `HTTP_REFERER` in your browser, some features of Shaarli may not work |
| 4 | 3 | ||
diff --git a/doc/Server-configuration.md b/doc/md/Server-configuration.md index 81cc1a72..23fdbc8b 100644 --- a/doc/Server-configuration.md +++ b/doc/md/Server-configuration.md | |||
| @@ -1,8 +1,7 @@ | |||
| 1 | #Server configuration | ||
| 2 | *Example virtual host configurations for popular web servers* | 1 | *Example virtual host configurations for popular web servers* |
| 3 | 2 | ||
| 4 | - [Apache](#apache)[](.html) | 3 | - [Apache](#apache) |
| 5 | - [Nginx](#nginx)[](.html) | 4 | - [Nginx](#nginx) |
| 6 | 5 | ||
| 7 | ## Prerequisites | 6 | ## Prerequisites |
| 8 | ### Shaarli | 7 | ### Shaarli |
| @@ -14,8 +13,8 @@ | |||
| 14 | 13 | ||
| 15 | ### HTTPS, TLS and self-signed certificates | 14 | ### HTTPS, TLS and self-signed certificates |
| 16 | Related guides: | 15 | Related guides: |
| 17 | * [How to Create Self-Signed SSL Certificates with OpenSSL](http://www.xenocafe.com/tutorials/linux/centos/openssl/self_signed_certificates/index.php)[](.html) | 16 | * [How to Create Self-Signed SSL Certificates with OpenSSL](http://www.xenocafe.com/tutorials/linux/centos/openssl/self_signed_certificates/index.php) |
| 18 | * [How do I create my own Certificate Authority?](https://workaround.org/certificate-authority)[](.html) | 17 | * [How do I create my own Certificate Authority?](https://workaround.org/certificate-authority) |
| 19 | * Generate a self-signed certificate (will trigger browser warnings) with apache2: `make-ssl-cert generate-default-snakeoil --force-overwrite` will create `/etc/ssl/certs/ssl-cert-snakeoil.pem` and `/etc/ssl/private/ssl-cert-snakeoil.key` | 18 | * Generate a self-signed certificate (will trigger browser warnings) with apache2: `make-ssl-cert generate-default-snakeoil --force-overwrite` will create `/etc/ssl/certs/ssl-cert-snakeoil.pem` and `/etc/ssl/private/ssl-cert-snakeoil.key` |
| 20 | 19 | ||
| 21 | ### Proxies | 20 | ### Proxies |
| @@ -24,7 +23,7 @@ If Shaarli is served behind a proxy (i.e. there is a proxy server between client | |||
| 24 | - `X-Forwarded-Host`; | 23 | - `X-Forwarded-Host`; |
| 25 | - `X-Forwarded-For`. | 24 | - `X-Forwarded-For`. |
| 26 | 25 | ||
| 27 | See also [proxy-related](https://github.com/shaarli/Shaarli/issues?utf8=%E2%9C%93&q=label%3Aproxy+) issues.[](.html) | 26 | See also [proxy-related](https://github.com/shaarli/Shaarli/issues?utf8=%E2%9C%93&q=label%3Aproxy+) issues. |
| 28 | 27 | ||
| 29 | ## Apache | 28 | ## Apache |
| 30 | ### Minimal | 29 | ### Minimal |
| @@ -38,8 +37,8 @@ See also [proxy-related](https://github.com/shaarli/Shaarli/issues?utf8=%E2%9C%9 | |||
| 38 | This configuration will log both Apache and PHP errors, which may prove useful to identify server configuration errors. | 37 | This configuration will log both Apache and PHP errors, which may prove useful to identify server configuration errors. |
| 39 | 38 | ||
| 40 | See: | 39 | See: |
| 41 | * [Apache/PHP - error log per VirtualHost](http://stackoverflow.com/q/176) (StackOverflow)[](.html) | 40 | * [Apache/PHP - error log per VirtualHost](http://stackoverflow.com/q/176) (StackOverflow) |
| 42 | * [PHP: php_value vs php_admin_value and the use of php_flag explained](https://ma.ttias.be/php-php_value-vs-php_admin_value-and-the-use-of-php_flag-explained/)[](.html) | 41 | * [PHP: php_value vs php_admin_value and the use of php_flag explained](https://ma.ttias.be/php-php_value-vs-php_admin_value-and-the-use-of-php_flag-explained/) |
| 43 | 42 | ||
| 44 | ```apache | 43 | ```apache |
| 45 | <VirtualHost *:80> | 44 | <VirtualHost *:80> |
| @@ -70,7 +69,7 @@ See: | |||
| 70 | ``` | 69 | ``` |
| 71 | 70 | ||
| 72 | ### Paranoid - Redirect HTTP (:80) to HTTPS (:443) | 71 | ### Paranoid - Redirect HTTP (:80) to HTTPS (:443) |
| 73 | See [Server-side TLS](https://wiki.mozilla.org/Security/Server_Side_TLS#Apache) (Mozilla).[](.html) | 72 | See [Server-side TLS](https://wiki.mozilla.org/Security/Server_Side_TLS#Apache) (Mozilla). |
| 74 | 73 | ||
| 75 | ```apache | 74 | ```apache |
| 76 | <VirtualHost *:443> | 75 | <VirtualHost *:443> |
| @@ -106,7 +105,7 @@ See [Server-side TLS](https://wiki.mozilla.org/Security/Server_Side_TLS#Apache) | |||
| 106 | 105 | ||
| 107 | Shaarli use `.htaccess` Apache files to deny access to files that shouldn't be directly accessed (datastore, config, etc.). You need the directive `AllowOverride All` in your virtual host configuration for them to work. | 106 | Shaarli use `.htaccess` Apache files to deny access to files that shouldn't be directly accessed (datastore, config, etc.). You need the directive `AllowOverride All` in your virtual host configuration for them to work. |
| 108 | 107 | ||
| 109 | **Warning**: If you use Apache 2.2 or lower, you need [mod_version](https://httpd.apache.org/docs/current/mod/mod_version.html) to be installed and enabled.[](.html) | 108 | **Warning**: If you use Apache 2.2 or lower, you need [mod_version](https://httpd.apache.org/docs/current/mod/mod_version.html) to be installed and enabled. |
| 110 | 109 | ||
| 111 | Apache module `mod_rewrite` **must** be enabled to use the REST API. URL rewriting rules for the Slim microframework are stated in the root `.htaccess` file. | 110 | Apache module `mod_rewrite` **must** be enabled to use the REST API. URL rewriting rules for the Slim microframework are stated in the root `.htaccess` file. |
| 112 | 111 | ||
| @@ -114,20 +113,20 @@ Apache module `mod_rewrite` **must** be enabled to use the REST API. URL rewriti | |||
| 114 | 113 | ||
| 115 | ## Nginx | 114 | ## Nginx |
| 116 | ### Foreword | 115 | ### Foreword |
| 117 | Nginx does not natively interpret PHP scripts; to this effect, we will run a [FastCGI](https://en.wikipedia.org/wiki/FastCGI) service, to which Nginx's FastCGI module will proxy all requests to PHP resources.[](.html) | 116 | Nginx does not natively interpret PHP scripts; to this effect, we will run a [FastCGI](https://en.wikipedia.org/wiki/FastCGI) service, to which Nginx's FastCGI module will proxy all requests to PHP resources. |
| 118 | 117 | ||
| 119 | Required packages: | 118 | Required packages: |
| 120 | - [nginx](http://nginx.org)[](.html) | 119 | - [nginx](http://nginx.org) |
| 121 | - [php-fpm](http://php-fpm.org) - PHP FastCGI Process Manager[](.html) | 120 | - [php-fpm](http://php-fpm.org) - PHP FastCGI Process Manager |
| 122 | 121 | ||
| 123 | Official documentation: | 122 | Official documentation: |
| 124 | - [Beginner's guide](http://nginx.org/en/docs/beginners_guide.html)[](.html) | 123 | - [Beginner's guide](http://nginx.org/en/docs/beginners_guide.html) |
| 125 | - [ngx_http_fastcgi_module](http://nginx.org/en/docs/http/ngx_http_fastcgi_module.html)[](.html) | 124 | - [ngx_http_fastcgi_module](http://nginx.org/en/docs/http/ngx_http_fastcgi_module.html) |
| 126 | - [Pitfalls](http://wiki.nginx.org/Pitfalls)[](.html) | 125 | - [Pitfalls](http://wiki.nginx.org/Pitfalls) |
| 127 | 126 | ||
| 128 | Community resources: | 127 | Community resources: |
| 129 | - [Server-side TLS (Nginx)](https://wiki.mozilla.org/Security/Server_Side_TLS#Nginx) (Mozilla)[](.html) | 128 | - [Server-side TLS (Nginx)](https://wiki.mozilla.org/Security/Server_Side_TLS#Nginx) (Mozilla) |
| 130 | - [PHP configuration examples](http://kbeezie.com/nginx-configuration-examples/) (Karl Blessing)[](.html) | 129 | - [PHP configuration examples](http://kbeezie.com/nginx-configuration-examples/) (Karl Blessing) |
| 131 | 130 | ||
| 132 | ### Common setup | 131 | ### Common setup |
| 133 | Once Nginx and PHP-FPM are installed, we need to ensure: | 132 | Once Nginx and PHP-FPM are installed, we need to ensure: |
| @@ -154,7 +153,7 @@ which corresponds to the following service configuration: | |||
| 154 | user = john | 153 | user = john |
| 155 | group = users | 154 | group = users |
| 156 | 155 | ||
| 157 | [...][](.html) | 156 | [...] |
| 158 | listen.owner = john | 157 | listen.owner = john |
| 159 | listen.group = users | 158 | listen.group = users |
| 160 | ``` | 159 | ``` |
| @@ -164,7 +163,7 @@ listen.group = users | |||
| 164 | user john users; | 163 | user john users; |
| 165 | 164 | ||
| 166 | http { | 165 | http { |
| 167 | [...][](.html) | 166 | [...] |
| 168 | } | 167 | } |
| 169 | ``` | 168 | ``` |
| 170 | 169 | ||
| @@ -177,20 +176,20 @@ To increase upload size, you will need to modify both nginx and PHP configuratio | |||
| 177 | # /etc/nginx/nginx.conf | 176 | # /etc/nginx/nginx.conf |
| 178 | 177 | ||
| 179 | http { | 178 | http { |
| 180 | [...][](.html) | 179 | [...] |
| 181 | 180 | ||
| 182 | client_max_body_size 10m; | 181 | client_max_body_size 10m; |
| 183 | 182 | ||
| 184 | [...][](.html) | 183 | [...] |
| 185 | } | 184 | } |
| 186 | ``` | 185 | ``` |
| 187 | 186 | ||
| 188 | ```ini | 187 | ```ini |
| 189 | # /etc/php5/fpm/php.ini | 188 | # /etc/php5/fpm/php.ini |
| 190 | 189 | ||
| 191 | [...][](.html) | 190 | [...] |
| 192 | post_max_size = 10M | 191 | post_max_size = 10M |
| 193 | [...][](.html) | 192 | [...] |
| 194 | upload_max_filesize = 10M | 193 | upload_max_filesize = 10M |
| 195 | ``` | 194 | ``` |
| 196 | 195 | ||
| @@ -293,10 +292,10 @@ location ~* \.(?:ico|css|js|gif|jpe?g|png)$ { | |||
| 293 | 292 | ||
| 294 | ```nginx | 293 | ```nginx |
| 295 | # /etc/nginx/nginx.conf | 294 | # /etc/nginx/nginx.conf |
| 296 | [...][](.html) | 295 | [...] |
| 297 | 296 | ||
| 298 | http { | 297 | http { |
| 299 | [...][](.html) | 298 | [...] |
| 300 | 299 | ||
| 301 | root /home/john/web; | 300 | root /home/john/web; |
| 302 | access_log /var/log/nginx/access.log; | 301 | access_log /var/log/nginx/access.log; |
| @@ -347,10 +346,10 @@ Assuming you have generated a (self-signed) key and certificate, and they are lo | |||
| 347 | 346 | ||
| 348 | ```nginx | 347 | ```nginx |
| 349 | # /etc/nginx/nginx.conf | 348 | # /etc/nginx/nginx.conf |
| 350 | [...][](.html) | 349 | [...] |
| 351 | 350 | ||
| 352 | http { | 351 | http { |
| 353 | [...][](.html) | 352 | [...] |
| 354 | 353 | ||
| 355 | index index.html index.php; | 354 | index index.html index.php; |
| 356 | 355 | ||
diff --git a/doc/Server-requirements.md b/doc/md/Server-requirements.md index 07e70ab3..b6bbd66a 100644 --- a/doc/Server-requirements.md +++ b/doc/md/Server-requirements.md | |||
| @@ -1,11 +1,11 @@ | |||
| 1 | #Server requirements | ||
| 2 | ## PHP | 1 | ## PHP |
| 2 | |||
| 3 | ### Release information | 3 | ### Release information |
| 4 | - [PHP: Supported versions](http://php.net/supported-versions.php)[](.html) | 4 | - [PHP: Supported versions](http://php.net/supported-versions.php) |
| 5 | - [PHP: Unsupported versions](http://php.net/eol.php) _(EOL - End Of Life)_[](.html) | 5 | - [PHP: Unsupported versions](http://php.net/eol.php) _(EOL - End Of Life)_ |
| 6 | - [PHP 7 Changelog](http://php.net/ChangeLog-7.php)[](.html) | 6 | - [PHP 7 Changelog](http://php.net/ChangeLog-7.php) |
| 7 | - [PHP 5 Changelog](http://php.net/ChangeLog-5.php)[](.html) | 7 | - [PHP 5 Changelog](http://php.net/ChangeLog-5.php) |
| 8 | - [PHP: Bugs](https://bugs.php.net/)[](.html) | 8 | - [PHP: Bugs](https://bugs.php.net/) |
| 9 | 9 | ||
| 10 | ### Supported versions | 10 | ### Supported versions |
| 11 | Version | Status | Shaarli compatibility | 11 | Version | Status | Shaarli compatibility |
| @@ -18,23 +18,23 @@ Version | Status | Shaarli compatibility | |||
| 18 | 5.3 | EOL: 2014-08-14 | :white_check_mark: (up to Shaarli 0.8.x) | 18 | 5.3 | EOL: 2014-08-14 | :white_check_mark: (up to Shaarli 0.8.x) |
| 19 | 19 | ||
| 20 | See also: | 20 | See also: |
| 21 | - [Travis configuration](https://github.com/shaarli/Shaarli/blob/master/.travis.yml)[](.html) | 21 | - [Travis configuration](https://github.com/shaarli/Shaarli/blob/master/.travis.yml) |
| 22 | 22 | ||
| 23 | ### Dependency management | 23 | ### Dependency management |
| 24 | Starting with Shaarli `v0.8.x`, [Composer](https://getcomposer.org/) is used to resolve,[](.html) | 24 | Starting with Shaarli `v0.8.x`, [Composer](https://getcomposer.org/) is used to resolve, |
| 25 | download and install third-party PHP dependencies. | 25 | download and install third-party PHP dependencies. |
| 26 | 26 | ||
| 27 | Library | Required? | Usage | 27 | Library | Required? | Usage |
| 28 | ---|:---:|--- | 28 | ---|:---:|--- |
| 29 | [`shaarli/netscape-bookmark-parser`](https://packagist.org/packages/shaarli/netscape-bookmark-parser) | All | Import bookmarks from Netscape files[](.html) | 29 | [`shaarli/netscape-bookmark-parser`](https://packagist.org/packages/shaarli/netscape-bookmark-parser) | All | Import bookmarks from Netscape files |
| 30 | [`erusev/parsedown`](https://packagist.org/packages/erusev/parsedown) | All | Parse MarkDown syntax for the MarkDown plugin[](.html) | 30 | [`erusev/parsedown`](https://packagist.org/packages/erusev/parsedown) | All | Parse MarkDown syntax for the MarkDown plugin |
| 31 | [`slim/slim`](https://packagist.org/packages/slim/slim) | All | Handle routes and middleware for the REST API[](.html) | 31 | [`slim/slim`](https://packagist.org/packages/slim/slim) | All | Handle routes and middleware for the REST API |
| 32 | 32 | ||
| 33 | ### Extensions | 33 | ### Extensions |
| 34 | Extension | Required? | Usage | 34 | Extension | Required? | Usage |
| 35 | ---|:---:|--- | 35 | ---|:---:|--- |
| 36 | [`openssl`](http://php.net/manual/en/book.openssl.php) | All | OpenSSL, HTTPS[](.html) | 36 | [`openssl`](http://php.net/manual/en/book.openssl.php) | All | OpenSSL, HTTPS |
| 37 | [`php-mbstring`](http://php.net/manual/en/book.mbstring.php) | CentOS, Fedora, RHEL, Windows | multibyte (Unicode) string support[](.html) | 37 | [`php-mbstring`](http://php.net/manual/en/book.mbstring.php) | CentOS, Fedora, RHEL, Windows | multibyte (Unicode) string support |
| 38 | [`php-gd`](http://php.net/manual/en/book.image.php) | optional | thumbnail resizing[](.html) | 38 | [`php-gd`](http://php.net/manual/en/book.image.php) | optional | thumbnail resizing |
| 39 | [`php-intl`](http://php.net/manual/en/book.intl.php) | optional | localized text sorting (e.g. `e->è->f`)[](.html) | 39 | [`php-intl`](http://php.net/manual/en/book.intl.php) | optional | localized text sorting (e.g. `e->è->f`) |
| 40 | [`php-curl`](http://php.net/manual/en/book.curl.php) | optional | using cURL for fetching webpages and thumbnails in a more robust way[](.html) | 40 | [`php-curl`](http://php.net/manual/en/book.curl.php) | optional | using cURL for fetching webpages and thumbnails in a more robust way |
diff --git a/doc/Server-security.md b/doc/md/Server-security.md index 50549a21..8df36f46 100644 --- a/doc/Server-security.md +++ b/doc/md/Server-security.md | |||
| @@ -1,4 +1,3 @@ | |||
| 1 | #Server security | ||
| 2 | ## php.ini | 1 | ## php.ini |
| 3 | PHP settings are defined in: | 2 | PHP settings are defined in: |
| 4 | - a main configuration file, usually found under `/etc/php5/php.ini`; some distributions provide different configuration environments, e.g. | 3 | - a main configuration file, usually found under `/etc/php5/php.ini`; some distributions provide different configuration environments, e.g. |
| @@ -31,8 +30,8 @@ Additional .ini files parsed: /etc/php/conf.d/xdebug.ini | |||
| 31 | 30 | ||
| 32 | ## fail2ban | 31 | ## fail2ban |
| 33 | `fail2ban` is an intrusion prevention framework that reads server (Apache, SSH, etc.) and uses `iptables` profiles to block brute-force attempts: | 32 | `fail2ban` is an intrusion prevention framework that reads server (Apache, SSH, etc.) and uses `iptables` profiles to block brute-force attempts: |
| 34 | - [Official website](http://www.fail2ban.org/wiki/index.php/Main_Page)[](.html) | 33 | - [Official website](http://www.fail2ban.org/wiki/index.php/Main_Page) |
| 35 | - [Source code](https://github.com/fail2ban/fail2ban)[](.html) | 34 | - [Source code](https://github.com/fail2ban/fail2ban) |
| 36 | 35 | ||
| 37 | ### Read Shaarli logs to ban IPs | 36 | ### Read Shaarli logs to ban IPs |
| 38 | Example configuration: | 37 | Example configuration: |
| @@ -41,7 +40,7 @@ Example configuration: | |||
| 41 | 40 | ||
| 42 | `/etc/fail2ban/jail.local` | 41 | `/etc/fail2ban/jail.local` |
| 43 | ```ini | 42 | ```ini |
| 44 | [shaarli-auth][](.html) | 43 | [shaarli-auth] |
| 45 | enabled = true | 44 | enabled = true |
| 46 | port = https,http | 45 | port = https,http |
| 47 | filter = shaarli-auth | 46 | filter = shaarli-auth |
| @@ -52,9 +51,9 @@ bantime = -1 | |||
| 52 | 51 | ||
| 53 | `/etc/fail2ban/filter.d/shaarli-auth.conf` | 52 | `/etc/fail2ban/filter.d/shaarli-auth.conf` |
| 54 | ```ini | 53 | ```ini |
| 55 | [INCLUDES][](.html) | 54 | [INCLUDES] |
| 56 | before = common.conf | 55 | before = common.conf |
| 57 | [Definition][](.html) | 56 | [Definition] |
| 58 | failregex = \s-\s<HOST>\s-\sLogin failed for user.*$ | 57 | failregex = \s-\s<HOST>\s-\sLogin failed for user.*$ |
| 59 | ignoreregex = | 58 | ignoreregex = |
| 60 | ``` | 59 | ``` |
diff --git a/doc/Shaarli-configuration.md b/doc/md/Shaarli-configuration.md index 25647cb7..933f5245 100644 --- a/doc/Shaarli-configuration.md +++ b/doc/md/Shaarli-configuration.md | |||
| @@ -1,13 +1,10 @@ | |||
| 1 | #Shaarli configuration | ||
| 2 | # Shaarli configuration | ||
| 3 | |||
| 4 | ## Foreword | 1 | ## Foreword |
| 5 | 2 | ||
| 6 | **Do not edit configuration options in index.php! Your changes would be lost.** | 3 | **Do not edit configuration options in index.php! Your changes would be lost.** |
| 7 | 4 | ||
| 8 | Once your Shaarli instance is installed, the file `data/config.json.php` is generated: | 5 | Once your Shaarli instance is installed, the file `data/config.json.php` is generated: |
| 9 | * it contains all settings in JSON format, and can be edited to customize values | 6 | * it contains all settings in JSON format, and can be edited to customize values |
| 10 | * it defines which [plugins](Plugin-System) are enabled[(.html)]((.html).html) | 7 | * it defines which [plugins](Plugin-System) are enabled[](.html) |
| 11 | * its values override those defined in `index.php` | 8 | * its values override those defined in `index.php` |
| 12 | * it is wrap in a PHP comment to prevent anyone accessing it, regardless of server configuration | 9 | * it is wrap in a PHP comment to prevent anyone accessing it, regardless of server configuration |
| 13 | 10 | ||
| @@ -33,13 +30,13 @@ On a Linux distribution: | |||
| 33 | - to give it access to Shaarli, either: | 30 | - to give it access to Shaarli, either: |
| 34 | - unzip Shaarli in the default web server location (usually `/var/www/`) and set the web server user as the owner | 31 | - unzip Shaarli in the default web server location (usually `/var/www/`) and set the web server user as the owner |
| 35 | - put users in the same group as the web server, and set the appropriate access rights | 32 | - put users in the same group as the web server, and set the appropriate access rights |
| 36 | - if you have a domain / subdomain to serve Shaarli, [configure the server](Server-configuration) accordingly[(.html)]((.html).html) | 33 | - if you have a domain / subdomain to serve Shaarli, [configure the server](Server-configuration) accordingly[](.html) |
| 37 | 34 | ||
| 38 | ## Configuration | 35 | ## Configuration |
| 39 | 36 | ||
| 40 | In `data/config.json.php`. | 37 | In `data/config.json.php`. |
| 41 | 38 | ||
| 42 | See also [Plugin System](Plugin-System.html).[](.html) | 39 | See also [Plugin System](Plugin-System.html). |
| 43 | 40 | ||
| 44 | ### Credentials | 41 | ### Credentials |
| 45 | 42 | ||
| @@ -54,7 +51,7 @@ See also [Plugin System](Plugin-System.html).[](.html) | |||
| 54 | **title**: Shaarli's instance title. | 51 | **title**: Shaarli's instance title. |
| 55 | **header_link**: Link to the homepage. | 52 | **header_link**: Link to the homepage. |
| 56 | **links_per_page**: Number of shaares displayed per page. | 53 | **links_per_page**: Number of shaares displayed per page. |
| 57 | **timezone**: See [the list of supported timezones](http://php.net/manual/en/timezones.php). [](.html) | 54 | **timezone**: See [the list of supported timezones](http://php.net/manual/en/timezones.php). |
| 58 | **enabled_plugins**: List of enabled plugins. | 55 | **enabled_plugins**: List of enabled plugins. |
| 59 | 56 | ||
| 60 | ### Security | 57 | ### Security |
| @@ -64,7 +61,8 @@ It might be useful if your IP adress often changes. | |||
| 64 | **ban_after**: Failed login attempts before being IP banned. | 61 | **ban_after**: Failed login attempts before being IP banned. |
| 65 | **ban_duration**: IP ban duration in seconds. | 62 | **ban_duration**: IP ban duration in seconds. |
| 66 | **open_shaarli**: Anyone can add a new link while logged out if enabled. | 63 | **open_shaarli**: Anyone can add a new link while logged out if enabled. |
| 67 | **trusted_proxies**: List of trusted IP which won't be banned after failed login attemps. Useful if Shaarli is behind a reverse proxy. | 64 | **trusted_proxies**: List of trusted IP which won't be banned after failed login attemps. Useful if Shaarli is behind a reverse proxy. |
| 65 | **allowed_protocols**: List of allowed protocols in shaare URLs or markdown-rendered descriptions. Useful if you want to store `javascript:` links (bookmarklets) in Shaarli (default: `["ftp", "ftps", "magnet"]`). | ||
| 68 | 66 | ||
| 69 | ### Resources | 67 | ### Resources |
| 70 | 68 | ||
| @@ -121,9 +119,14 @@ It might be useful if your IP adress often changes. | |||
| 121 | "ban_after": 4, | 119 | "ban_after": 4, |
| 122 | "session_protection_disabled": false, | 120 | "session_protection_disabled": false, |
| 123 | "ban_duration": 1800, | 121 | "ban_duration": 1800, |
| 124 | "trusted_proxies": [[](.html) | 122 | "trusted_proxies": [ |
| 125 | "1.2.3.4", | 123 | "1.2.3.4", |
| 126 | "5.6.7.8" | 124 | "5.6.7.8" |
| 125 | ], | ||
| 126 | "allowed_protocols": [ | ||
| 127 | "ftp", | ||
| 128 | "ftps", | ||
| 129 | "magnet" | ||
| 127 | ] | 130 | ] |
| 128 | }, | 131 | }, |
| 129 | "resources": { | 132 | "resources": { |
| @@ -148,7 +151,7 @@ It might be useful if your IP adress often changes. | |||
| 148 | "enable_localcache": true, | 151 | "enable_localcache": true, |
| 149 | "check_updates_branch": "stable", | 152 | "check_updates_branch": "stable", |
| 150 | "check_updates_interval": 86400, | 153 | "check_updates_interval": 86400, |
| 151 | "enabled_plugins": [[](.html) | 154 | "enabled_plugins": [ |
| 152 | "markdown", | 155 | "markdown", |
| 153 | "wallabag", | 156 | "wallabag", |
| 154 | "archiveorg" | 157 | "archiveorg" |
| @@ -168,7 +171,7 @@ It might be useful if your IP adress often changes. | |||
| 168 | "general": { | 171 | "general": { |
| 169 | "header_link": "?", | 172 | "header_link": "?", |
| 170 | "links_per_page": 20, | 173 | "links_per_page": 20, |
| 171 | "enabled_plugins": [[](.html) | 174 | "enabled_plugins": [ |
| 172 | "markdown", | 175 | "markdown", |
| 173 | "wallabag" | 176 | "wallabag" |
| 174 | ], | 177 | ], |
| @@ -207,6 +210,6 @@ It might be useful if your IP adress often changes. | |||
| 207 | ## Additional configuration | 210 | ## Additional configuration |
| 208 | 211 | ||
| 209 | The playvideos plugin may require that you adapt your server's | 212 | The playvideos plugin may require that you adapt your server's |
| 210 | [Content Security Policy](https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md#troubleshooting) [](.html) | 213 | [Content Security Policy](https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md#troubleshooting) |
| 211 | configuration to work properly.[(.html)]((.html).html) | 214 | configuration to work properly.[](.html) |
| 212 | 215 | ||
diff --git a/doc/md/Shaarli-images.md b/doc/md/Shaarli-images.md new file mode 100644 index 00000000..25f6cfdd --- /dev/null +++ b/doc/md/Shaarli-images.md | |||
| @@ -0,0 +1,72 @@ | |||
| 1 | ## Get and run a Shaarli image | ||
| 2 | |||
| 3 | ### DockerHub repository | ||
| 4 | The images can be found in the [`shaarli/shaarli`](https://hub.docker.com/r/shaarli/shaarli/) | ||
| 5 | repository. | ||
| 6 | |||
| 7 | ### Available image tags | ||
| 8 | - `latest`: master branch (tarball release) | ||
| 9 | - `stable`: stable branch (tarball release) | ||
| 10 | - `dev`: master branch (Git clone) | ||
| 11 | |||
| 12 | All images rely on: | ||
| 13 | - [Debian 8 Jessie](https://hub.docker.com/_/debian/) | ||
| 14 | - [PHP5-FPM](http://php-fpm.org/) | ||
| 15 | - [Nginx](http://nginx.org/) | ||
| 16 | |||
| 17 | ### Download from DockerHub | ||
| 18 | ```bash | ||
| 19 | $ docker pull shaarli/shaarli | ||
| 20 | latest: Pulling from shaarli/shaarli | ||
| 21 | 32716d9fcddb: Pull complete | ||
| 22 | 84899d045435: Pull complete | ||
| 23 | 4b6ad7444763: Pull complete | ||
| 24 | e0345ef7a3e0: Pull complete | ||
| 25 | 5c1dd344094f: Pull complete | ||
| 26 | 6422305a200b: Pull complete | ||
| 27 | 7d63f861dbef: Pull complete | ||
| 28 | 3eb97210645c: Pull complete | ||
| 29 | 869319d746ff: Already exists | ||
| 30 | 869319d746ff: Pulling fs layer | ||
| 31 | 902b87aaaec9: Already exists | ||
| 32 | Digest: sha256:f836b4627b958b3f83f59c332f22f02fcd495ace3056f2be2c4912bd8704cc98 | ||
| 33 | Status: Downloaded newer image for shaarli/shaarli:latest | ||
| 34 | ``` | ||
| 35 | |||
| 36 | ### Create and start a new container from the image | ||
| 37 | ```bash | ||
| 38 | # map the host's :8000 port to the container's :80 port | ||
| 39 | $ docker create -p 8000:80 shaarli/shaarli | ||
| 40 | d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101 | ||
| 41 | |||
| 42 | # launch the container in the background | ||
| 43 | $ docker start d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101 | ||
| 44 | d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101 | ||
| 45 | |||
| 46 | # list active containers | ||
| 47 | $ docker ps | ||
| 48 | CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES | ||
| 49 | d40b7af693d6 shaarli/shaarli /usr/bin/supervisor 15 seconds ago Up 4 seconds 0.0.0.0:8000->80/tcp backstabbing_galileo | ||
| 50 | ``` | ||
| 51 | |||
| 52 | ### Stop and destroy a container | ||
| 53 | ```bash | ||
| 54 | $ docker stop backstabbing_galileo # those docker guys are really rude to physicists! | ||
| 55 | backstabbing_galileo | ||
| 56 | |||
| 57 | # check the container is stopped | ||
| 58 | $ docker ps | ||
| 59 | CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES | ||
| 60 | |||
| 61 | # list ALL containers | ||
| 62 | $ docker ps -a | ||
| 63 | CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES | ||
| 64 | d40b7af693d6 shaarli/shaarli /usr/bin/supervisor 5 minutes ago Exited (0) 48 seconds ago backstabbing_galileo | ||
| 65 | |||
| 66 | # destroy the container | ||
| 67 | $ docker rm backstabbing_galileo # let's put an end to these barbarian practices | ||
| 68 | backstabbing_galileo | ||
| 69 | |||
| 70 | $ docker ps -a | ||
| 71 | CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES | ||
| 72 | ``` | ||
diff --git a/doc/Static-analysis.md b/doc/md/Static-analysis.md index 5781e055..ee4f5978 100644 --- a/doc/Static-analysis.md +++ b/doc/md/Static-analysis.md | |||
| @@ -1,12 +1,11 @@ | |||
| 1 | #Static analysis | ||
| 2 | ## WIP | 1 | ## WIP |
| 3 | This topic is currently being discussed here: | 2 | This topic is currently being discussed here: |
| 4 | - [Fix coding style (static analysis)](https://github.com/shaarli/Shaarli/issues/95) (#95)[](.html) | 3 | - [Fix coding style (static analysis)](https://github.com/shaarli/Shaarli/issues/95) (#95) |
| 5 | - [Continuous Integration tools & features](https://github.com/shaarli/Shaarli/issues/130) (#130)[](.html) | 4 | - [Continuous Integration tools & features](https://github.com/shaarli/Shaarli/issues/130) (#130) |
| 6 | 5 | ||
| 7 | ### Usage | 6 | ### Usage |
| 8 | Static analysis tools can be installed with Composer, and used through Shaarli's [Makefile](https://github.com/shaarli/Shaarli/blob/master/Makefile).[](.html) | 7 | Static analysis tools can be installed with Composer, and used through Shaarli's [Makefile](https://github.com/shaarli/Shaarli/blob/master/Makefile). |
| 9 | 8 | ||
| 10 | For an overview of the available features, see: | 9 | For an overview of the available features, see: |
| 11 | - [Code quality: Makefile to run static code checkers](https://github.com/shaarli/Shaarli/pull/124) (#124)[](.html) | 10 | - [Code quality: Makefile to run static code checkers](https://github.com/shaarli/Shaarli/pull/124) (#124) |
| 12 | - [Run PHPCS against different coding standards](https://github.com/shaarli/Shaarli/pull/276) (#276)[](.html) | 11 | - [Run PHPCS against different coding standards](https://github.com/shaarli/Shaarli/pull/276) (#276) |
diff --git a/doc/Theming.md b/doc/md/Theming.md index 23877e5d..ae68db38 100644 --- a/doc/Theming.md +++ b/doc/md/Theming.md | |||
| @@ -1,11 +1,12 @@ | |||
| 1 | #Theming | ||
| 2 | ## Foreword | 1 | ## Foreword |
| 2 | |||
| 3 | There are two ways of customizing how Shaarli looks: | 3 | There are two ways of customizing how Shaarli looks: |
| 4 | 4 | ||
| 5 | 1. by using a custom CSS to override Shaarli's CSS | 5 | 1. by using a custom CSS to override Shaarli's CSS |
| 6 | 2. by using a full theme that provides its own RainTPL templates, CSS and Javascript resources | 6 | 2. by using a full theme that provides its own RainTPL templates, CSS and Javascript resources |
| 7 | 7 | ||
| 8 | ## Custom CSS | 8 | ## Custom CSS |
| 9 | |||
| 9 | Shaarli's appearance can be modified by adding CSS rules to: | 10 | Shaarli's appearance can be modified by adding CSS rules to: |
| 10 | - Shaarli < `v0.9.0`: `inc/user.css` | 11 | - Shaarli < `v0.9.0`: `inc/user.css` |
| 11 | - Shaarli >= `v0.9.0`: `data/user.css` | 12 | - Shaarli >= `v0.9.0`: `data/user.css` |
| @@ -14,9 +15,10 @@ This file allows overriding rules defined in the template CSS files (only add ch | |||
| 14 | 15 | ||
| 15 | **Note**: Do not edit `tpl/default/css/shaarli.css`! Your changes would be overridden when updating Shaarli. | 16 | **Note**: Do not edit `tpl/default/css/shaarli.css`! Your changes would be overridden when updating Shaarli. |
| 16 | 17 | ||
| 17 | See also [Download CSS styles from an OPML list](Download-CSS-styles-from-an-OPML-list.html) | 18 | See also [[Download CSS styles from an OPML list]] |
| 18 | 19 | ||
| 19 | ## Themes | 20 | ## Themes |
| 21 | |||
| 20 | _WARNING - This feature is currently being worked on and will be improved in the next releases. Experimental._ | 22 | _WARNING - This feature is currently being worked on and will be improved in the next releases. Experimental._ |
| 21 | 23 | ||
| 22 | Installation: | 24 | Installation: |
| @@ -28,24 +30,29 @@ Installation: | |||
| 28 | - Shaarli >= `v0.9.0`: select the theme through the _Tools_ page | 30 | - Shaarli >= `v0.9.0`: select the theme through the _Tools_ page |
| 29 | 31 | ||
| 30 | ## Community CSS & themes | 32 | ## Community CSS & themes |
| 33 | |||
| 31 | ### Custom CSS | 34 | ### Custom CSS |
| 32 | - [mrjovanovic/serious-theme-shaarli](https://github.com/mrjovanovic/serious-theme-shaarli) - A serious theme for Shaarli[](.html) | 35 | |
| 33 | - [shaarli/shaarli-themes](https://github.com/shaarli/shaarli-themes)[](.html) | 36 | - [mrjovanovic/serious-theme-shaarli](https://github.com/mrjovanovic/serious-theme-shaarli) - A serious theme for Shaarli |
| 37 | - [shaarli/shaarli-themes](https://github.com/shaarli/shaarli-themes) | ||
| 34 | 38 | ||
| 35 | ### Themes | 39 | ### Themes |
| 36 | - [AkibaTech/Shaarli Superhero Theme](https://github.com/AkibaTech/Shaarli---SuperHero-Theme) - A template/theme for Shaarli[](.html) | 40 | |
| 37 | - [alexisju/albinomouse-template](https://github.com/alexisju/albinomouse-template) - A full template for Shaarli[](.html) | 41 | - [AkibaTech/Shaarli Superhero Theme](https://github.com/AkibaTech/Shaarli---SuperHero-Theme) - A template/theme for Shaarli |
| 38 | - [ArthurHoaro/shaarli-launch](https://github.com/ArthurHoaro/shaarli-launch) - Customizable Shaarli theme[](.html) | 42 | - [alexisju/albinomouse-template](https://github.com/alexisju/albinomouse-template) - A full template for Shaarli |
| 39 | - [dhoko/ShaarliTemplate](https://github.com/dhoko/ShaarliTemplate) - A template/theme for Shaarli[](.html) | 43 | - [ArthurHoaro/shaarli-launch](https://github.com/ArthurHoaro/shaarli-launch) - Customizable Shaarli theme |
| 40 | - [kalvn/shaarli-blocks](https://github.com/kalvn/shaarli-blocks) - A template/theme for Shaarli[](.html) | 44 | - [dhoko/ShaarliTemplate](https://github.com/dhoko/ShaarliTemplate) - A template/theme for Shaarli |
| 41 | - [kalvn/Shaarli-Material](https://github.com/kalvn/Shaarli-Material) - A theme (template) based on Google's Material Design for Shaarli, the superfast delicious clone[](.html) | 45 | - [kalvn/shaarli-blocks](https://github.com/kalvn/shaarli-blocks) - A template/theme for Shaarli |
| 42 | - [ManufacturaInd/shaarli-2004licious-theme](https://github.com/ManufacturaInd/shaarli-2004licious-theme) - A template/theme as a humble homage to the early looks of the del.icio.us site[](.html) | 46 | - [kalvn/Shaarli-Material](https://github.com/kalvn/Shaarli-Material) - A theme (template) based on Google's Material Design for Shaarli, the superfast delicious clone |
| 47 | - [ManufacturaInd/shaarli-2004licious-theme](https://github.com/ManufacturaInd/shaarli-2004licious-theme) - A template/theme as a humble homage to the early looks of the del.icio.us site | ||
| 43 | 48 | ||
| 44 | ### Shaarli forks | 49 | ### Shaarli forks |
| 45 | - [misterair/Limonade](https://github.com/misterair/limonade) - A fork of (legacy) Shaarli with a new template[](.html) | 50 | |
| 46 | - [vivienhaese/shaarlitheme](https://github.com/vivienhaese/shaarlitheme) - A Shaarli fork meant to be run in an openshift instance[](.html) | 51 | - [misterair/Limonade](https://github.com/misterair/limonade) - A fork of (legacy) Shaarli with a new template |
| 52 | - [vivienhaese/shaarlitheme](https://github.com/vivienhaese/shaarlitheme) - A Shaarli fork meant to be run in an openshift instance | ||
| 47 | 53 | ||
| 48 | ## Example installation: AlbinoMouse theme | 54 | ## Example installation: AlbinoMouse theme |
| 55 | |||
| 49 | With the following configuration: | 56 | With the following configuration: |
| 50 | - Apache 2 / PHP 5.6 | 57 | - Apache 2 / PHP 5.6 |
| 51 | - user sites are enabled, e.g. `/home/user/public_html/somedir` is served as `http://localhost/~user/somedir` | 58 | - user sites are enabled, e.g. `/home/user/public_html/somedir` is served as `http://localhost/~user/somedir` |
| @@ -70,7 +77,7 @@ Get config written: | |||
| 70 | - fill the install form | 77 | - fill the install form |
| 71 | - log in to Shaarli | 78 | - log in to Shaarli |
| 72 | 79 | ||
| 73 | Edit Shaarli's [configuration|Shaarli configuration](configuration|Shaarli-configuration.html): | 80 | Edit Shaarli's [[configuration|Shaarli configuration]]: |
| 74 | ```bash | 81 | ```bash |
| 75 | # the file should be owned by Apache, thus not writeable => sudo | 82 | # the file should be owned by Apache, thus not writeable => sudo |
| 76 | $ sudo sed -i s=tpl=tpl/albinomouse-template=g shaarli/data/config.php | 83 | $ sudo sed -i s=tpl=tpl/albinomouse-template=g shaarli/data/config.php |
diff --git a/doc/Troubleshooting.md b/doc/md/Troubleshooting.md index 8e30fce5..13005526 100644 --- a/doc/Troubleshooting.md +++ b/doc/md/Troubleshooting.md | |||
| @@ -1,14 +1,18 @@ | |||
| 1 | #Troubleshooting | 1 | # Troubleshooting |
| 2 | |||
| 2 | ## Browser | 3 | ## Browser |
| 4 | |||
| 3 | ### Redirection issues (HTTP Referer) | 5 | ### Redirection issues (HTTP Referer) |
| 6 | |||
| 4 | Depending on its configuration and installed plugins, the browser may remove or alter (spoof) HTTP referers, thus preventing Shaarli from properly redirecting between pages. | 7 | Depending on its configuration and installed plugins, the browser may remove or alter (spoof) HTTP referers, thus preventing Shaarli from properly redirecting between pages. |
| 5 | 8 | ||
| 6 | See: | 9 | See: |
| 7 | - [HTTP referer](https://en.wikipedia.org/wiki/HTTP_referer) (Wikipedia)[](.html) | 10 | - [HTTP referer](https://en.wikipedia.org/wiki/HTTP_referer) (Wikipedia) |
| 8 | - [Improve online privacy by controlling referrer information](http://www.ghacks.net/2015/01/22/improve-online-privacy-by-controlling-referrer-information/)[](.html) | 11 | - [Improve online privacy by controlling referrer information](http://www.ghacks.net/2015/01/22/improve-online-privacy-by-controlling-referrer-information/) |
| 9 | - [Better security, privacy and anonymity in Firefox](http://b.agilob.net/better-security-privacy-and-anonymity-in-firefox/)[](.html) | 12 | - [Better security, privacy and anonymity in Firefox](http://b.agilob.net/better-security-privacy-and-anonymity-in-firefox/) |
| 10 | 13 | ||
| 11 | ### Firefox HTTP Referer options | 14 | ### Firefox HTTP Referer options |
| 15 | |||
| 12 | HTTP settings are available by browsing `about:config`, here are the available settings and their values. | 16 | HTTP settings are available by browsing `about:config`, here are the available settings and their values. |
| 13 | 17 | ||
| 14 | `network.http.sendRefererHeader` - determines when to send the Referer HTTP header | 18 | `network.http.sendRefererHeader` - determines when to send the Referer HTTP header |
| @@ -33,6 +37,7 @@ HTTP settings are available by browsing `about:config`, here are the available s | |||
| 33 | - 2: scheme+host+port | 37 | - 2: scheme+host+port |
| 34 | 38 | ||
| 35 | ### Firefox, localhost and redirections | 39 | ### Firefox, localhost and redirections |
| 40 | |||
| 36 | `localhost` is not a proper Fully Qualified Domain Name (FQDN); if Firefox has been set up to spoof referers, or only accept requests from the same base domain/host, Shaarli redirections will not work properly. | 41 | `localhost` is not a proper Fully Qualified Domain Name (FQDN); if Firefox has been set up to spoof referers, or only accept requests from the same base domain/host, Shaarli redirections will not work properly. |
| 37 | 42 | ||
| 38 | To solve this, assign a local domain to your host, e.g. | 43 | To solve this, assign a local domain to your host, e.g. |
| @@ -44,25 +49,31 @@ To solve this, assign a local domain to your host, e.g. | |||
| 44 | and browse Shaarli at http://localhost.lan/. | 49 | and browse Shaarli at http://localhost.lan/. |
| 45 | 50 | ||
| 46 | Related threads: | 51 | Related threads: |
| 47 | - [What is localhost.localdomain for?](https://bbs.archlinux.org/viewtopic.php?id=156064)[](.html) | 52 | - [What is localhost.localdomain for?](https://bbs.archlinux.org/viewtopic.php?id=156064) |
| 48 | - [Stop returning to the first page after editing a bookmark from another page](https://github.com/shaarli/Shaarli/issues/311)[](.html) | 53 | - [Stop returning to the first page after editing a bookmark from another page](https://github.com/shaarli/Shaarli/issues/311) |
| 49 | 54 | ||
| 50 | ## Login | 55 | ## Login |
| 56 | |||
| 51 | ### I forgot my password! | 57 | ### I forgot my password! |
| 58 | |||
| 52 | Delete the file `data/config.php` and display the page again. You will be asked for a new login/password. | 59 | Delete the file `data/config.php` and display the page again. You will be asked for a new login/password. |
| 53 | 60 | ||
| 54 | ### I'm locked out - Login bruteforce protection | 61 | ### I'm locked out - Login bruteforce protection |
| 62 | |||
| 55 | Login form is protected against brute force attacks: 4 failed logins will ban the IP address from login for 30 minutes. Banned IPs can still browse links. | 63 | Login form is protected against brute force attacks: 4 failed logins will ban the IP address from login for 30 minutes. Banned IPs can still browse links. |
| 56 | 64 | ||
| 57 | To remove the current IP bans, delete the file `data/ipbans.php` | 65 | To remove the current IP bans, delete the file `data/ipbans.php` |
| 58 | 66 | ||
| 59 | ### List of all login attempts | 67 | ### List of all login attempts |
| 68 | |||
| 60 | The file `data/log.txt` shows all logins (successful or failed) and bans/lifted bans. | 69 | The file `data/log.txt` shows all logins (successful or failed) and bans/lifted bans. |
| 61 | Search for `failed` in this file to look for unauthorized login attempts. | 70 | Search for `failed` in this file to look for unauthorized login attempts. |
| 62 | 71 | ||
| 63 | ## Hosting problems | 72 | ## Hosting problems |
| 73 | |||
| 64 | ### Old PHP versions | 74 | ### Old PHP versions |
| 65 | * On **free.fr** : free.fr now support php 5.6.x([link](http://les.pages.perso.chez.free.fr/migrations/php5v6.io))and so support now the tag autocompletion but you have to do the following : At the root of your webspace create a `sessions` directory and a `.htaccess` file containing:[](.html) | 75 | |
| 76 | * On **free.fr** : free.fr now support php 5.6.x([link](http://les.pages.perso.chez.free.fr/migrations/php5v6.io))and so support now the tag autocompletion but you have to do the following : At the root of your webspace create a `sessions` directory and a `.htaccess` file containing: | ||
| 66 | 77 | ||
| 67 | ```ini | 78 | ```ini |
| 68 | <IfDefine Free> | 79 | <IfDefine Free> |
| @@ -72,7 +83,7 @@ php56 1 | |||
| 72 | 83 | ||
| 73 | * If you have an error such as: `Parse error: syntax error, unexpected '=', expecting '(' in /links/index.php on line xxx`, it means that your host is using php4, not php5. Shaarli requires php 5.1. Try changing the file extension to `.php5` | 84 | * If you have an error such as: `Parse error: syntax error, unexpected '=', expecting '(' in /links/index.php on line xxx`, it means that your host is using php4, not php5. Shaarli requires php 5.1. Try changing the file extension to `.php5` |
| 74 | * On **1and1** : If you add the link from the page (and not from the bookmarklet), Shaarli will no be able to get the title of the page. You will have to enter it manually. (Because they have disabled the ability to download a file through HTTP). | 85 | * On **1and1** : If you add the link from the page (and not from the bookmarklet), Shaarli will no be able to get the title of the page. You will have to enter it manually. (Because they have disabled the ability to download a file through HTTP). |
| 75 | * If you have the error `Warning: file_get_contents() [function.file-get-contents]: URL file-access is disabled in the server configuration in /…/index.php on line xxx`, it means that your host has disabled the ability to fetch a file by HTTP in the php config (Typically in 1and1 hosting). Bad host. Change host. Or comment the following lines:[](.html) | 86 | * If you have the error `Warning: file_get_contents() [function.file-get-contents]: URL file-access is disabled in the server configuration in /…/index.php on line xxx`, it means that your host has disabled the ability to fetch a file by HTTP in the php config (Typically in 1and1 hosting). Bad host. Change host. Or comment the following lines: |
| 76 | 87 | ||
| 77 | ```php | 88 | ```php |
| 78 | //list($status,$headers,$data) = getHTTP($url,4); // Short timeout to keep the application responsive. | 89 | //list($status,$headers,$data) = getHTTP($url,4); // Short timeout to keep the application responsive. |
| @@ -84,24 +95,29 @@ php56 1 | |||
| 84 | * On **lost-oasis**, RSS doesn't work correctly, because of this message at the begining of the RSS/ATOM feed : `<? // tout ce qui est charge ici (generalement des includes et require) est charge en permanence. ?>`. To fix this, remove this message from `php-include/prepend.php` | 95 | * On **lost-oasis**, RSS doesn't work correctly, because of this message at the begining of the RSS/ATOM feed : `<? // tout ce qui est charge ici (generalement des includes et require) est charge en permanence. ?>`. To fix this, remove this message from `php-include/prepend.php` |
| 85 | 96 | ||
| 86 | ### Dates are not properly formatted | 97 | ### Dates are not properly formatted |
| 98 | |||
| 87 | Shaarli tries to sniff the language of the browser (using HTTP_ACCEPT_LANGUAGE headers) and choose a date format accordingly. But Shaarli can only use the date formats (and more generaly speaking, the locales) provided by the webserver. So even if you have a browser in French, you may end up with dates in US format (it's the case on sebsauvage.net :-( ) | 99 | Shaarli tries to sniff the language of the browser (using HTTP_ACCEPT_LANGUAGE headers) and choose a date format accordingly. But Shaarli can only use the date formats (and more generaly speaking, the locales) provided by the webserver. So even if you have a browser in French, you may end up with dates in US format (it's the case on sebsauvage.net :-( ) |
| 88 | 100 | ||
| 89 | ### Problems on CentOS servers | 101 | ### Problems on CentOS servers |
| 102 | |||
| 90 | On **CentOS**/RedHat derivatives, you may need to install the `php-mbstring` package. | 103 | On **CentOS**/RedHat derivatives, you may need to install the `php-mbstring` package. |
| 91 | 104 | ||
| 92 | 105 | ||
| 93 | ### My session expires! I can't stay logged in | 106 | ### My session expires! I can't stay logged in |
| 107 | |||
| 94 | This can be caused by several things: | 108 | This can be caused by several things: |
| 95 | 109 | ||
| 96 | * Your php installation may not have a proper directory setup for session files. (eg. on Free.fr you need to create a `session` directory on the root of your website.) You may need to create the session directory of set it up. | 110 | * Your php installation may not have a proper directory setup for session files. (eg. on Free.fr you need to create a `session` directory on the root of your website.) You may need to create the session directory of set it up. |
| 97 | * Most hosts regularly clean the temporary and session directories. Your host may be cleaning those directories too aggressively (eg.OVH hosts), forcing an expire of the session. You may want to set the session directory in your web root. (eg. Create the `sessions` subdirectory and add `ini_set('session.save_path', $_SERVER['DOCUMENT_ROOT'].'/../sessions');`. Make sure this directory is not browsable !)[](.html) | 111 | * Most hosts regularly clean the temporary and session directories. Your host may be cleaning those directories too aggressively (eg.OVH hosts), forcing an expire of the session. You may want to set the session directory in your web root. (eg. Create the `sessions` subdirectory and add `ini_set('session.save_path', $_SERVER['DOCUMENT_ROOT'].'/../sessions');`. Make sure this directory is not browsable !) |
| 98 | * If your IP address changes during surfing, Shaarli will force expire your session for security reasons (to prevent session cookie hijacking). This can happen when surfing from WiFi or 3G (you may have switched WiFi/3G access point), or in some corporate/university proxies which use load balancing (and may have proxies with several external IP addresses). | 112 | * If your IP address changes during surfing, Shaarli will force expire your session for security reasons (to prevent session cookie hijacking). This can happen when surfing from WiFi or 3G (you may have switched WiFi/3G access point), or in some corporate/university proxies which use load balancing (and may have proxies with several external IP addresses). |
| 99 | * Some browser addons may interfer with HTTP headers (ipfuck/ipflood/GreaseMonkey…). Try disabling those. | 113 | * Some browser addons may interfer with HTTP headers (ipfuck/ipflood/GreaseMonkey…). Try disabling those. |
| 100 | * You may be using OperaTurbo or OperaMini, which use their own proxies which may change from time to time. | 114 | * You may be using OperaTurbo or OperaMini, which use their own proxies which may change from time to time. |
| 101 | * If you have another application on the same webserver where Shaarli is installed, these application may forcefully expire php sessions. | 115 | * If you have another application on the same webserver where Shaarli is installed, these application may forcefully expire php sessions. |
| 102 | 116 | ||
| 103 | ## Sessions do not seem to work correctly on your server | 117 | ## Sessions do not seem to work correctly on your server |
| 104 | Follow the instructions in the error message. Make sure you are accessing shaarli via a direct IP address or a proper hostname. If you have **no dots** in the hostname (e.g. `localhost` or `http://my-webserver/shaarli/`), some browsers will not store cookies at all (this respects the [HTTP cookie specification](http://curl.haxx.se/rfc/cookie_spec.html)).[](.html) | 118 | |
| 119 | Follow the instructions in the error message. Make sure you are accessing shaarli via a direct IP address or a proper hostname. If you have **no dots** in the hostname (e.g. `localhost` or `http://my-webserver/shaarli/`), some browsers will not store cookies at all (this respects the [HTTP cookie specification](http://curl.haxx.se/rfc/cookie_spec.html)). | ||
| 105 | 120 | ||
| 106 | ### pubsubhubbub support | 121 | ### pubsubhubbub support |
| 107 | Download [publisher.php](https://pubsubhubbub.googlecode.com/git/publisher_clients/php/library/publisher.php) at the root of your Shaarli installation and set `$GLOBALS['config'['PUBSUBHUB_URL']` in your `config.php`]('PUBSUBHUB_URL']`-in-your-`config.php`.html) | 122 | |
| 123 | Download [publisher.php](https://pubsubhubbub.googlecode.com/git/publisher_clients/php/library/publisher.php) at the root of your Shaarli installation and set `$GLOBALS['config']['PUBSUBHUB_URL']` in your `config.php` | ||
diff --git a/doc/Unit-tests.md b/doc/md/Unit-tests.md index 0942ad38..19838721 100644 --- a/doc/Unit-tests.md +++ b/doc/md/Unit-tests.md | |||
| @@ -1,13 +1,13 @@ | |||
| 1 | #Unit tests | ||
| 2 | |||
| 3 | ### Setup your environment for tests | 1 | ### Setup your environment for tests |
| 4 | The framework used is [PHPUnit](https://phpunit.de/); it can be installed with [Composer](https://getcomposer.org/), which is a dependency management tool.[](.html) | 2 | |
| 3 | The framework used is [PHPUnit](https://phpunit.de/); it can be installed with [Composer](https://getcomposer.org/), which is a dependency management tool. | ||
| 5 | 4 | ||
| 6 | Regarding Composer, you can either use: | 5 | Regarding Composer, you can either use: |
| 7 | * a system-wide version, e.g. installed through your distro's package manager | 6 | * a system-wide version, e.g. installed through your distro's package manager |
| 8 | * a local version, downloadable [here](https://getcomposer.org/download/)[](.html) | 7 | * a local version, downloadable [here](https://getcomposer.org/download/) |
| 9 | 8 | ||
| 10 | #### Sample usage | 9 | #### Sample usage |
| 10 | |||
| 11 | ```bash | 11 | ```bash |
| 12 | # system-wide version | 12 | # system-wide version |
| 13 | $ composer install | 13 | $ composer install |
| @@ -20,12 +20,14 @@ $ php composer.phar update | |||
| 20 | ``` | 20 | ``` |
| 21 | 21 | ||
| 22 | #### Install Shaarli dev dependencies | 22 | #### Install Shaarli dev dependencies |
| 23 | |||
| 23 | ```bash | 24 | ```bash |
| 24 | $ cd /path/to/shaarli | 25 | $ cd /path/to/shaarli |
| 25 | $ composer update | 26 | $ composer update |
| 26 | ``` | 27 | ``` |
| 27 | 28 | ||
| 28 | #### Install and enable Xdebug to generate PHPUnit coverage reports | 29 | #### Install and enable Xdebug to generate PHPUnit coverage reports |
| 30 | |||
| 29 | For Debian-based distros: | 31 | For Debian-based distros: |
| 30 | ```bash | 32 | ```bash |
| 31 | $ aptitude install php5-xdebug | 33 | $ aptitude install php5-xdebug |
| @@ -41,6 +43,7 @@ zend_extension=xdebug.so | |||
| 41 | ``` | 43 | ``` |
| 42 | 44 | ||
| 43 | #### Run unit tests | 45 | #### Run unit tests |
| 46 | |||
| 44 | Successful test suite: | 47 | Successful test suite: |
| 45 | ```bash | 48 | ```bash |
| 46 | $ make test | 49 | $ make test |
| @@ -111,6 +114,7 @@ Tests: 36, Assertions: 63, Errors: 1, Failures: 2. | |||
| 111 | ``` | 114 | ``` |
| 112 | 115 | ||
| 113 | #### Test results and coverage | 116 | #### Test results and coverage |
| 117 | |||
| 114 | By default, PHPUnit will run all suitable tests found under the `tests` directory. | 118 | By default, PHPUnit will run all suitable tests found under the `tests` directory. |
| 115 | 119 | ||
| 116 | Each test has 3 possible outcomes: | 120 | Each test has 3 possible outcomes: |
| @@ -128,7 +132,8 @@ If Xdebug has been installed and activated, two coverage reports will be generat | |||
| 128 | * to open it in a web browser: `firefox coverage/index.html &` | 132 | * to open it in a web browser: `firefox coverage/index.html &` |
| 129 | 133 | ||
| 130 | ### Executing specific tests | 134 | ### Executing specific tests |
| 131 | Add a [`@group`](https://phpunit.de/manual/current/en/appendixes.annotations.html#appendixes.annotations.group) annotation in a test class or method comment:[](.html) | 135 | |
| 136 | Add a [`@group`](https://phpunit.de/manual/current/en/appendixes.annotations.html#appendixes.annotations.group) annotation in a test class or method comment: | ||
| 132 | 137 | ||
| 133 | ```php | 138 | ```php |
| 134 | /** | 139 | /** |
| @@ -137,7 +142,7 @@ Add a [`@group`](https://phpunit.de/manual/current/en/appendixes.annotations.htm | |||
| 137 | */ | 142 | */ |
| 138 | class BookmarkImportTest extends PHPUnit_Framework_TestCase | 143 | class BookmarkImportTest extends PHPUnit_Framework_TestCase |
| 139 | { | 144 | { |
| 140 | [...][](.html) | 145 | [...] |
| 141 | } | 146 | } |
| 142 | ``` | 147 | ``` |
| 143 | 148 | ||
diff --git a/doc/Upgrade-and-migration.md b/doc/md/Upgrade-and-migration.md index d36eb862..7348891f 100644 --- a/doc/Upgrade-and-migration.md +++ b/doc/md/Upgrade-and-migration.md | |||
| @@ -1,5 +1,5 @@ | |||
| 1 | #Upgrade and migration | ||
| 2 | ## Preparation | 1 | ## Preparation |
| 2 | |||
| 3 | ### Note your current version | 3 | ### Note your current version |
| 4 | 4 | ||
| 5 | If anything goes wrong, it's important for us to know which version you're upgrading from. | 5 | If anything goes wrong, it's important for us to know which version you're upgrading from. |
| @@ -13,33 +13,37 @@ Shaarli stores all user data under the `data` directory: | |||
| 13 | - `data/ipbans.php` - banned IP addresses | 13 | - `data/ipbans.php` - banned IP addresses |
| 14 | - `data/updates.txt` - contains all automatic update to the configuration and datastore files already run | 14 | - `data/updates.txt` - contains all automatic update to the configuration and datastore files already run |
| 15 | 15 | ||
| 16 | See [Shaarli configuration](Shaarli-configuration.html) for more information about Shaarli resources. | 16 | See [[Shaarli configuration]] for more information about Shaarli resources. |
| 17 | 17 | ||
| 18 | It is recommended to backup this repository _before_ starting updating/upgrading Shaarli: | 18 | It is recommended to backup this repository _before_ starting updating/upgrading Shaarli: |
| 19 | - users with SSH access: copy or archive the directory to a temporary location | 19 | - users with SSH access: copy or archive the directory to a temporary location |
| 20 | - users with FTP access: download a local copy of your Shaarli installation using your favourite client | 20 | - users with FTP access: download a local copy of your Shaarli installation using your favourite client |
| 21 | 21 | ||
| 22 | ### Migrating data from a previous installation | 22 | ### Migrating data from a previous installation |
| 23 | |||
| 23 | As all user data is kept under `data`, this is the only directory you need to worry about when migrating to a new installation, which corresponds to the following steps: | 24 | As all user data is kept under `data`, this is the only directory you need to worry about when migrating to a new installation, which corresponds to the following steps: |
| 24 | 25 | ||
| 25 | - backup the `data` directory | 26 | - backup the `data` directory |
| 26 | - install or update Shaarli: | 27 | - install or update Shaarli: |
| 27 | - fresh installation - see [Download and installation](Download-and-installation.html) | 28 | - fresh installation - see [[Download and installation]] |
| 28 | - update - see the following sections | 29 | - update - see the following sections |
| 29 | - check or restore the `data` directory | 30 | - check or restore the `data` directory |
| 30 | 31 | ||
| 31 | ## Recommended : Upgrading from release archives | 32 | ## Recommended : Upgrading from release archives |
| 32 | All tagged revisions can be downloaded as tarballs or ZIP archives from the [releases](https://github.com/shaarli/Shaarli/releases) page.[](.html) | ||
| 33 | 33 | ||
| 34 | We recommend that you use the latest release tarball with the `-full` suffix. It contains the dependencies, please read [Download and installation](Download-and-installation.html) for `git` complete instructions. | 34 | All tagged revisions can be downloaded as tarballs or ZIP archives from the [releases](https://github.com/shaarli/Shaarli/releases) page. |
| 35 | |||
| 36 | We recommend that you use the latest release tarball with the `-full` suffix. It contains the dependencies, please read [[Download and installation]] for `git` complete instructions. | ||
| 35 | 37 | ||
| 36 | Once downloaded, extract the archive locally and update your remote installation (e.g. via FTP) -be sure you keep the content of the `data` directory! | 38 | Once downloaded, extract the archive locally and update your remote installation (e.g. via FTP) -be sure you keep the content of the `data` directory! |
| 37 | 39 | ||
| 38 | After upgrading, access your fresh Shaarli installation from a web browser; the configuration and data store will then be automatically updated, and new settings added to `data/config.json.php` (see [Shaarli configuration](Shaarli-configuration.html) for more details). | 40 | After upgrading, access your fresh Shaarli installation from a web browser; the configuration and data store will then be automatically updated, and new settings added to `data/config.json.php` (see [[Shaarli configuration]] for more details). |
| 39 | 41 | ||
| 40 | ## Upgrading with Git | 42 | ## Upgrading with Git |
| 43 | |||
| 41 | ### Updating a community Shaarli | 44 | ### Updating a community Shaarli |
| 42 | If you have installed Shaarli from the [community Git repository](Download#clone-with-git-recommended), simply [pull new changes](https://www.git-scm.com/docs/git-pull) from your local clone:[](.html) | 45 | |
| 46 | If you have installed Shaarli from the [community Git repository](Download#clone-with-git-recommended), simply [pull new changes](https://www.git-scm.com/docs/git-pull) from your local clone: | ||
| 43 | 47 | ||
| 44 | ```bash | 48 | ```bash |
| 45 | $ cd /path/to/shaarli | 49 | $ cd /path/to/shaarli |
| @@ -55,7 +59,7 @@ Fast-forward | |||
| 55 | 3 files changed, 3 insertions(+), 1 deletion(-) | 59 | 3 files changed, 3 insertions(+), 1 deletion(-) |
| 56 | ``` | 60 | ``` |
| 57 | 61 | ||
| 58 | Shaarli >= `v0.8.x`: install/update third-party PHP dependencies using [Composer](https://getcomposer.org/):[](.html) | 62 | Shaarli >= `v0.8.x`: install/update third-party PHP dependencies using [Composer](https://getcomposer.org/): |
| 59 | 63 | ||
| 60 | ```bash | 64 | ```bash |
| 61 | $ composer install --no-dev | 65 | $ composer install --no-dev |
| @@ -67,18 +71,20 @@ Updating dependencies | |||
| 67 | ``` | 71 | ``` |
| 68 | 72 | ||
| 69 | ### Migrating and upgrading from Sebsauvage's repository | 73 | ### Migrating and upgrading from Sebsauvage's repository |
| 70 | If you have installed Shaarli from [Sebsauvage's original Git repository](https://github.com/sebsauvage/Shaarli), you can use [Git remotes](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes) to update your working copy.[](.html) | 74 | |
| 75 | If you have installed Shaarli from [Sebsauvage's original Git repository](https://github.com/sebsauvage/Shaarli), you can use [Git remotes](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes) to update your working copy. | ||
| 71 | 76 | ||
| 72 | The following guide assumes that: | 77 | The following guide assumes that: |
| 73 | - you have a basic knowledge of Git [branching](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell) and [remote repositories](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes)[](.html) | 78 | - you have a basic knowledge of Git [branching](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell) and [remote repositories](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes) |
| 74 | - the default remote is named `origin` and points to Sebsauvage's repository | 79 | - the default remote is named `origin` and points to Sebsauvage's repository |
| 75 | - the current branch is `master` | 80 | - the current branch is `master` |
| 76 | - if you have personal branches containing customizations, you will need to [rebase them](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) after the upgrade; beware though, a lot of changes have been made since the community fork has been created, so things are very likely to break | 81 | - if you have personal branches containing customizations, you will need to [rebase them](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) after the upgrade; beware though, a lot of changes have been made since the community fork has been created, so things are very likely to break! |
| 77 | - the working copy is clean: | 82 | - the working copy is clean: |
| 78 | - no versioned file has been locally modified | 83 | - no versioned file has been locally modified |
| 79 | - no untracked files are present | 84 | - no untracked files are present |
| 80 | 85 | ||
| 81 | #### Step 0: show repository information | 86 | #### Step 0: show repository information |
| 87 | |||
| 82 | ```bash | 88 | ```bash |
| 83 | $ cd /path/to/shaarli | 89 | $ cd /path/to/shaarli |
| 84 | 90 | ||
| @@ -87,7 +93,7 @@ origin https://github.com/sebsauvage/Shaarli (fetch) | |||
| 87 | origin https://github.com/sebsauvage/Shaarli (push) | 93 | origin https://github.com/sebsauvage/Shaarli (push) |
| 88 | 94 | ||
| 89 | $ git branch -vv | 95 | $ git branch -vv |
| 90 | * master 029f75f [origin/master] Update README.md[](.html) | 96 | * master 029f75f [origin/master] Update README.md |
| 91 | 97 | ||
| 92 | $ git status | 98 | $ git status |
| 93 | On branch master | 99 | On branch master |
| @@ -96,6 +102,7 @@ nothing to commit, working directory clean | |||
| 96 | ``` | 102 | ``` |
| 97 | 103 | ||
| 98 | #### Step 1: update Git remotes | 104 | #### Step 1: update Git remotes |
| 105 | |||
| 99 | ``` | 106 | ``` |
| 100 | $ git remote rename origin sebsauvage | 107 | $ git remote rename origin sebsauvage |
| 101 | $ git remote -v | 108 | $ git remote -v |
| @@ -111,11 +118,11 @@ remote: Total 3015 (delta 446), reused 457 (delta 446), pack-reused 2550 | |||
| 111 | Receiving objects: 100% (3015/3015), 2.59 MiB | 918.00 KiB/s, done. | 118 | Receiving objects: 100% (3015/3015), 2.59 MiB | 918.00 KiB/s, done. |
| 112 | Resolving deltas: 100% (1899/1899), completed with 48 local objects. | 119 | Resolving deltas: 100% (1899/1899), completed with 48 local objects. |
| 113 | From https://github.com/shaarli/Shaarli | 120 | From https://github.com/shaarli/Shaarli |
| 114 | * [new branch] master -> origin/master[](.html) | 121 | * [new branch] master -> origin/master |
| 115 | * [new branch] stable -> origin/stable[](.html) | 122 | * [new branch] stable -> origin/stable |
| 116 | [...][](.html) | 123 | [...] |
| 117 | * [new tag] v0.6.4 -> v0.6.4[](.html) | 124 | * [new tag] v0.6.4 -> v0.6.4 |
| 118 | * [new tag] v0.7.0 -> v0.7.0[](.html) | 125 | * [new tag] v0.7.0 -> v0.7.0 |
| 119 | ``` | 126 | ``` |
| 120 | 127 | ||
| 121 | #### Step 2: use the stable community branch | 128 | #### Step 2: use the stable community branch |
| @@ -126,11 +133,11 @@ Branch stable set up to track remote branch stable from origin. | |||
| 126 | Switched to a new branch 'stable' | 133 | Switched to a new branch 'stable' |
| 127 | 134 | ||
| 128 | $ git branch -vv | 135 | $ git branch -vv |
| 129 | master 029f75f [sebsauvage/master] Update README.md[](.html) | 136 | master 029f75f [sebsauvage/master] Update README.md |
| 130 | * stable 890afc3 [origin/stable] Merge pull request #509 from ArthurHoaro/v0.6.5[](.html) | 137 | * stable 890afc3 [origin/stable] Merge pull request #509 from ArthurHoaro/v0.6.5 |
| 131 | ``` | 138 | ``` |
| 132 | 139 | ||
| 133 | Shaarli >= `v0.8.x`: install/update third-party PHP dependencies using [Composer](https://getcomposer.org/):[](.html) | 140 | Shaarli >= `v0.8.x`: install/update third-party PHP dependencies using [Composer](https://getcomposer.org/): |
| 134 | 141 | ||
| 135 | ```bash | 142 | ```bash |
| 136 | $ composer install --no-dev | 143 | $ composer install --no-dev |
| @@ -162,7 +169,8 @@ Total 3317 (delta 2050), reused 3301 (delta 2034)to | |||
| 162 | ``` | 169 | ``` |
| 163 | 170 | ||
| 164 | #### Step 3: configuration | 171 | #### Step 3: configuration |
| 165 | After migrating, access your fresh Shaarli installation from a web browser; the configuration will then be automatically updated, and new settings added to `data/config.php` (see [Shaarli configuration](Shaarli-configuration.html) for more details). | 172 | |
| 173 | After migrating, access your fresh Shaarli installation from a web browser; the configuration will then be automatically updated, and new settings added to `data/config.php` (see [[Shaarli configuration]] for more details). | ||
| 166 | 174 | ||
| 167 | ## Troubleshooting | 175 | ## Troubleshooting |
| 168 | 176 | ||
diff --git a/doc/md/Versioning-and-Branches.md b/doc/md/Versioning-and-Branches.md new file mode 100644 index 00000000..e1d998e0 --- /dev/null +++ b/doc/md/Versioning-and-Branches.md | |||
| @@ -0,0 +1,75 @@ | |||
| 1 | **WORK IN PROGRESS** | ||
| 2 | |||
| 3 | It's important to understand how Shaarli branches work, especially if you're maintaining a 3rd party tools for Shaarli (theme, plugin, etc.), to be sure stay compatible. | ||
| 4 | |||
| 5 | ## `master` branch | ||
| 6 | |||
| 7 | The `master` branch is the development branch. Any new change MUST go through this branch using Pull Requests. | ||
| 8 | |||
| 9 | Remarks: | ||
| 10 | |||
| 11 | * This branch shouldn't be used for production as it isn't necessary stable. | ||
| 12 | * 3rd party aren't required to be compatible with the latest changes. | ||
| 13 | * Official plugins, themes and libraries (contained within Shaarli organization repos) must be compatible with the master branch. | ||
| 14 | * The version in this branch is always `dev`. | ||
| 15 | |||
| 16 | ## `v0.x` branch | ||
| 17 | |||
| 18 | This `v0.x` branch, points to the latest `v0.x.y` release. | ||
| 19 | |||
| 20 | Explanation: | ||
| 21 | |||
| 22 | When a new version is released, it might contains a major bug which isn't detected right away. For example, a new PHP version is released, containing backward compatibility issue which doesn't work with Shaarli. | ||
| 23 | |||
| 24 | In this case, the issue is fixed in the `master` branch, and the fix is backported the to the `v0.x` branch. Then a new release is made from the `v0.x` branch. | ||
| 25 | |||
| 26 | This workflow allow us to fix any major bug detected, without having to release bleeding edge feature too soon. | ||
| 27 | |||
| 28 | ## `latest` branch | ||
| 29 | |||
| 30 | This branch point the latest release. It recommended to use it to get the latest tested changes. | ||
| 31 | |||
| 32 | ## `stable` branch | ||
| 33 | |||
| 34 | The `stable` branch doesn't contain any major bug, and is one major digit version behind the latest release. | ||
| 35 | |||
| 36 | For example, the current latest release is `v0.8.3`, the stable branch is an alias to the latest `v0.7.x` release. When the `v0.9.0` version will be released, the stable will move to the latest `v0.8.x` release. | ||
| 37 | |||
| 38 | Remarks: | ||
| 39 | |||
| 40 | * Shaarli release pace isn't fast, and the stable branch might be a few months behind the latest release. | ||
| 41 | |||
| 42 | ## Releases | ||
| 43 | |||
| 44 | Releases are always made from the latest `v0.x` branch. | ||
| 45 | |||
| 46 | Note that for every release, we manually generate a tarball which contains all Shaarli dependencies, making Shaarli's installation only one step. | ||
| 47 | |||
| 48 | ## Advices on 3rd party git repos workflow | ||
| 49 | |||
| 50 | ### Versioning | ||
| 51 | |||
| 52 | Any time a new Shaarli release is published, you should publish a new release of your repo if the changes affected you since the latest release (take a look at the [changelog](https://github.com/shaarli/Shaarli/releases) (*Draft* means not released yet) and the commit log (like [`tpl` folder](https://github.com/shaarli/Shaarli/commits/master/tpl/default) for themes)). You can either: | ||
| 53 | |||
| 54 | - use the Shaarli version number, with your repo version. For example, if Shaarli `v0.8.3` is released, publish a `v0.8.3-1` release, where `v0.8.3` states Shaarli compatibility and `-1` is your own version digit for the current Shaarli version. | ||
| 55 | - use your own versioning scheme, and state Shaarli compatibility in the release description. | ||
| 56 | |||
| 57 | Using this, any user will be able to pick the release matching his own Shaarli version. | ||
| 58 | |||
| 59 | ### Major bugfix backport releases | ||
| 60 | |||
| 61 | To be able to support backported fixes, it recommended to use our workflow: | ||
| 62 | |||
| 63 | ```bash | ||
| 64 | # In master, fix the major bug | ||
| 65 | git commit -m "Katastrophe" | ||
| 66 | git push origin master | ||
| 67 | # Get your commit hash | ||
| 68 | git log --format="%H" -n 1 | ||
| 69 | # Create a new branch from your latest release, let's say v0.8.2-1 (the tag name) | ||
| 70 | git checkout -b katastrophe v0.8.2-1 | ||
| 71 | # Backport the fix commit to your brand new branch | ||
| 72 | git cherry-pick <fix commit hash> | ||
| 73 | git push origin katastrophe | ||
| 74 | # Then you just have to make a new release from the `katastrophe` branch tagged `v0.8.3-1` | ||
| 75 | ``` | ||
diff --git a/doc/_Footer.md b/doc/md/_Footer.md index 50fa4f56..648b1298 100644 --- a/doc/_Footer.md +++ b/doc/md/_Footer.md | |||
| @@ -1,2 +1 @@ | |||
| 1 | #_Footer | _Shaarli, the personal, minimalist, super-fast, database-free bookmarking service_ \ No newline at end of file | |
| 2 | _Shaarli, the personal, minimalist, super-fast, database-free bookmarking service_ | ||
diff --git a/doc/md/_Sidebar.md b/doc/md/_Sidebar.md new file mode 100644 index 00000000..fe0e4229 --- /dev/null +++ b/doc/md/_Sidebar.md | |||
| @@ -0,0 +1,45 @@ | |||
| 1 | - [[Home]] | ||
| 2 | - Setup | ||
| 3 | - [[Download and Installation]] | ||
| 4 | - [[Upgrade and migration]] | ||
| 5 | - [[Server requirements]] | ||
| 6 | - [[Server configuration]] | ||
| 7 | - [[Server security]] | ||
| 8 | - [[Shaarli configuration]] | ||
| 9 | - [[Plugins]] | ||
| 10 | - Docker | ||
| 11 | - [[Docker 101]] | ||
| 12 | - [[Shaarli images]] | ||
| 13 | - [[Reverse proxy configuration]] | ||
| 14 | - [[Docker resources]] | ||
| 15 | - Usage | ||
| 16 | - [[Features]] | ||
| 17 | - [[Bookmarklet]] | ||
| 18 | - [[Browsing and Searching]] | ||
| 19 | - [[Firefox share]] | ||
| 20 | - [[RSS feeds]] | ||
| 21 | - [[REST API]] | ||
| 22 | - How To | ||
| 23 | - [[Backup, restore, import and export]] | ||
| 24 | - [[Copy an existing installation over SSH and serve it locally]] | ||
| 25 | - [[Create and serve multiple Shaarlis (farm)]] | ||
| 26 | - [[Download CSS styles from an OPML list]] | ||
| 27 | - [[Datastore hacks]] | ||
| 28 | - [[Troubleshooting]] | ||
| 29 | - Development: | ||
| 30 | - [[Development guidelines]] | ||
| 31 | - [[Continuous integration tools]] | ||
| 32 | - [[GnuPG signature]] | ||
| 33 | - [[Coding guidelines]] | ||
| 34 | - [[Directory structure]] | ||
| 35 | - [[3rd party libraries]] | ||
| 36 | - [[Plugin System]] | ||
| 37 | - [[Release Shaarli]] | ||
| 38 | - [[Versioning and Branches]] | ||
| 39 | - [[Security]] | ||
| 40 | - [[Static analysis]] | ||
| 41 | - [[Theming]] | ||
| 42 | - [[Unit tests]] | ||
| 43 | - About | ||
| 44 | - [[FAQ]] | ||
| 45 | - [[Community & Related software]] | ||
diff --git a/doc/md/config.json b/doc/md/config.json new file mode 100644 index 00000000..cc4de307 --- /dev/null +++ b/doc/md/config.json | |||
| @@ -0,0 +1,6 @@ | |||
| 1 | { | ||
| 2 | "useSideMenu": true, | ||
| 3 | "lineBreaks": "gfm", | ||
| 4 | "additionalFooterText": "", | ||
| 5 | "title": "Shaarli documentation" | ||
| 6 | } \ No newline at end of file | ||
diff --git a/doc/md/github-markdown.css b/doc/md/github-markdown.css new file mode 100644 index 00000000..581350ae --- /dev/null +++ b/doc/md/github-markdown.css | |||
| @@ -0,0 +1,287 @@ | |||
| 1 | #local-sidebar { | ||
| 2 | width: 230px; | ||
| 3 | float: right; | ||
| 4 | position: relative; | ||
| 5 | z-index: 4; | ||
| 6 | background-color: #fff; | ||
| 7 | border: 1px solid #e2e2e2; | ||
| 8 | border-radius: 3px; | ||
| 9 | } | ||
| 10 | |||
| 11 | body { | ||
| 12 | font-family: Helvetica, arial, sans-serif; | ||
| 13 | font-size: 14px; | ||
| 14 | line-height: 1.6; | ||
| 15 | padding-top: 10px; | ||
| 16 | padding-bottom: 10px; | ||
| 17 | background-color: white; | ||
| 18 | padding: 10px 20%; } | ||
| 19 | |||
| 20 | body > *:first-child { | ||
| 21 | margin-top: 0 !important; } | ||
| 22 | body > *:last-child { | ||
| 23 | margin-bottom: 0 !important; } | ||
| 24 | |||
| 25 | a { | ||
| 26 | color: #4183C4; } | ||
| 27 | a.absent { | ||
| 28 | color: #cc0000; } | ||
| 29 | a.anchor { | ||
| 30 | display: block; | ||
| 31 | padding-left: 30px; | ||
| 32 | margin-left: -30px; | ||
| 33 | cursor: pointer; | ||
| 34 | position: absolute; | ||
| 35 | top: 0; | ||
| 36 | left: 0; | ||
| 37 | bottom: 0; } | ||
| 38 | |||
| 39 | h1, h2, h3, h4, h5, h6 { | ||
| 40 | margin: 20px 0 10px; | ||
| 41 | padding: 0; | ||
| 42 | font-weight: bold; | ||
| 43 | -webkit-font-smoothing: antialiased; | ||
| 44 | cursor: text; | ||
| 45 | position: relative; } | ||
| 46 | |||
| 47 | h1:hover a.anchor, h2:hover a.anchor, h3:hover a.anchor, h4:hover a.anchor, h5:hover a.anchor, h6:hover a.anchor { | ||
| 48 | background: url("../../images/modules/styleguide/para.png") no-repeat 10px center; | ||
| 49 | text-decoration: none; } | ||
| 50 | |||
| 51 | h1 tt, h1 code { | ||
| 52 | font-size: inherit; } | ||
| 53 | |||
| 54 | h2 tt, h2 code { | ||
| 55 | font-size: inherit; } | ||
| 56 | |||
| 57 | h3 tt, h3 code { | ||
| 58 | font-size: inherit; } | ||
| 59 | |||
| 60 | h4 tt, h4 code { | ||
| 61 | font-size: inherit; } | ||
| 62 | |||
| 63 | h5 tt, h5 code { | ||
| 64 | font-size: inherit; } | ||
| 65 | |||
| 66 | h6 tt, h6 code { | ||
| 67 | font-size: inherit; } | ||
| 68 | |||
| 69 | h1 { | ||
| 70 | font-size: 28px; | ||
| 71 | color: black; } | ||
| 72 | |||
| 73 | h2 { | ||
| 74 | font-size: 24px; | ||
| 75 | border-bottom: 1px solid #cccccc; | ||
| 76 | color: black; } | ||
| 77 | |||
| 78 | h3 { | ||
| 79 | font-size: 18px; } | ||
| 80 | |||
| 81 | h4 { | ||
| 82 | font-size: 16px; } | ||
| 83 | |||
| 84 | h5 { | ||
| 85 | font-size: 14px; } | ||
| 86 | |||
| 87 | h6 { | ||
| 88 | color: #777777; | ||
| 89 | font-size: 14px; } | ||
| 90 | |||
| 91 | p, blockquote, ol, dl, table, pre { | ||
| 92 | margin: 15px 0; } | ||
| 93 | |||
| 94 | hr { | ||
| 95 | background: transparent url("../../images/modules/pulls/dirty-shade.png") repeat-x 0 0; | ||
| 96 | border: 0 none; | ||
| 97 | color: #cccccc; | ||
| 98 | height: 4px; | ||
| 99 | padding: 0; } | ||
| 100 | |||
| 101 | body > h2:first-child { | ||
| 102 | margin-top: 0; | ||
| 103 | padding-top: 0; } | ||
| 104 | body > h1:first-child { | ||
| 105 | margin-top: 0; | ||
| 106 | padding-top: 0; } | ||
| 107 | body > h1:first-child + h2 { | ||
| 108 | margin-top: 0; | ||
| 109 | padding-top: 0; } | ||
| 110 | body > h3:first-child, body > h4:first-child, body > h5:first-child, body > h6:first-child { | ||
| 111 | margin-top: 0; | ||
| 112 | padding-top: 0; } | ||
| 113 | |||
| 114 | a:first-child h1, a:first-child h2, a:first-child h3, a:first-child h4, a:first-child h5, a:first-child h6 { | ||
| 115 | margin-top: 0; | ||
| 116 | padding-top: 0; } | ||
| 117 | |||
| 118 | h1 p, h2 p, h3 p, h4 p, h5 p, h6 p { | ||
| 119 | margin-top: 0; } | ||
| 120 | |||
| 121 | li p.first { | ||
| 122 | display: inline-block; } | ||
| 123 | |||
| 124 | ul, ol { | ||
| 125 | padding-left: 30px; } | ||
| 126 | |||
| 127 | ul :first-child, ol :first-child { | ||
| 128 | margin-top: 0; } | ||
| 129 | |||
| 130 | ul :last-child, ol :last-child { | ||
| 131 | margin-bottom: 0; } | ||
| 132 | |||
| 133 | dl { | ||
| 134 | padding: 0; } | ||
| 135 | dl dt { | ||
| 136 | font-size: 14px; | ||
| 137 | font-weight: bold; | ||
| 138 | font-style: italic; | ||
| 139 | padding: 0; | ||
| 140 | margin: 15px 0 5px; } | ||
| 141 | dl dt:first-child { | ||
| 142 | padding: 0; } | ||
| 143 | dl dt > :first-child { | ||
| 144 | margin-top: 0; } | ||
| 145 | dl dt > :last-child { | ||
| 146 | margin-bottom: 0; } | ||
| 147 | dl dd { | ||
| 148 | margin: 0 0 15px; | ||
| 149 | padding: 0 15px; } | ||
| 150 | dl dd > :first-child { | ||
| 151 | margin-top: 0; } | ||
| 152 | dl dd > :last-child { | ||
| 153 | margin-bottom: 0; } | ||
| 154 | |||
| 155 | blockquote { | ||
| 156 | border-left: 4px solid #dddddd; | ||
| 157 | padding: 0 15px; | ||
| 158 | color: #777777; } | ||
| 159 | blockquote > :first-child { | ||
| 160 | margin-top: 0; } | ||
| 161 | blockquote > :last-child { | ||
| 162 | margin-bottom: 0; } | ||
| 163 | |||
| 164 | table { | ||
| 165 | padding: 0; } | ||
| 166 | table tr { | ||
| 167 | border-top: 1px solid #cccccc; | ||
| 168 | background-color: white; | ||
| 169 | margin: 0; | ||
| 170 | padding: 0; } | ||
| 171 | table tr:nth-child(2n) { | ||
| 172 | background-color: #f8f8f8; } | ||
| 173 | table tr th { | ||
| 174 | font-weight: bold; | ||
| 175 | border: 1px solid #cccccc; | ||
| 176 | text-align: left; | ||
| 177 | margin: 0; | ||
| 178 | padding: 6px 13px; } | ||
| 179 | table tr td { | ||
| 180 | border: 1px solid #cccccc; | ||
| 181 | text-align: left; | ||
| 182 | margin: 0; | ||
| 183 | padding: 6px 13px; } | ||
| 184 | table tr th :first-child, table tr td :first-child { | ||
| 185 | margin-top: 0; } | ||
| 186 | table tr th :last-child, table tr td :last-child { | ||
| 187 | margin-bottom: 0; } | ||
| 188 | |||
| 189 | img { | ||
| 190 | max-width: 100%; } | ||
| 191 | |||
| 192 | span.frame { | ||
| 193 | display: block; | ||
| 194 | overflow: hidden; } | ||
| 195 | span.frame > span { | ||
| 196 | border: 1px solid #dddddd; | ||
| 197 | display: block; | ||
| 198 | float: left; | ||
| 199 | overflow: hidden; | ||
| 200 | margin: 13px 0 0; | ||
| 201 | padding: 7px; | ||
| 202 | width: auto; } | ||
| 203 | span.frame span img { | ||
| 204 | display: block; | ||
| 205 | float: left; } | ||
| 206 | span.frame span span { | ||
| 207 | clear: both; | ||
| 208 | color: #333333; | ||
| 209 | display: block; | ||
| 210 | padding: 5px 0 0; } | ||
| 211 | span.align-center { | ||
| 212 | display: block; | ||
| 213 | overflow: hidden; | ||
| 214 | clear: both; } | ||
| 215 | span.align-center > span { | ||
| 216 | display: block; | ||
| 217 | overflow: hidden; | ||
| 218 | margin: 13px auto 0; | ||
| 219 | text-align: center; } | ||
| 220 | span.align-center span img { | ||
| 221 | margin: 0 auto; | ||
| 222 | text-align: center; } | ||
| 223 | span.align-right { | ||
| 224 | display: block; | ||
| 225 | overflow: hidden; | ||
| 226 | clear: both; } | ||
| 227 | span.align-right > span { | ||
| 228 | display: block; | ||
| 229 | overflow: hidden; | ||
| 230 | margin: 13px 0 0; | ||
| 231 | text-align: right; } | ||
| 232 | span.align-right span img { | ||
| 233 | margin: 0; | ||
| 234 | text-align: right; } | ||
| 235 | span.float-left { | ||
| 236 | display: block; | ||
| 237 | margin-right: 13px; | ||
| 238 | overflow: hidden; | ||
| 239 | float: left; } | ||
| 240 | span.float-left span { | ||
| 241 | margin: 13px 0 0; } | ||
| 242 | span.float-right { | ||
| 243 | display: block; | ||
| 244 | margin-left: 13px; | ||
| 245 | overflow: hidden; | ||
| 246 | float: right; } | ||
| 247 | span.float-right > span { | ||
| 248 | display: block; | ||
| 249 | overflow: hidden; | ||
| 250 | margin: 13px auto 0; | ||
| 251 | text-align: right; } | ||
| 252 | |||
| 253 | code, tt { | ||
| 254 | margin: 0 2px; | ||
| 255 | padding: 0 5px; | ||
| 256 | white-space: nowrap; | ||
| 257 | border: 1px solid #eaeaea; | ||
| 258 | background-color: #f8f8f8; | ||
| 259 | border-radius: 3px; } | ||
| 260 | |||
| 261 | pre code { | ||
| 262 | margin: 0; | ||
| 263 | padding: 0; | ||
| 264 | white-space: pre; | ||
| 265 | border: none; | ||
| 266 | background: transparent; } | ||
| 267 | |||
| 268 | .highlight pre { | ||
| 269 | background-color: #f8f8f8; | ||
| 270 | border: 1px solid #cccccc; | ||
| 271 | font-size: 13px; | ||
| 272 | line-height: 19px; | ||
| 273 | overflow: auto; | ||
| 274 | padding: 6px 10px; | ||
| 275 | border-radius: 3px; } | ||
| 276 | |||
| 277 | pre { | ||
| 278 | background-color: #f8f8f8; | ||
| 279 | border: 1px solid #cccccc; | ||
| 280 | font-size: 13px; | ||
| 281 | line-height: 19px; | ||
| 282 | overflow: auto; | ||
| 283 | padding: 6px 10px; | ||
| 284 | border-radius: 3px; } | ||
| 285 | pre code, pre tt { | ||
| 286 | background-color: transparent; | ||
| 287 | border: none; } | ||
diff --git a/doc/md/images/bookmarklet.png b/doc/md/images/bookmarklet.png new file mode 100644 index 00000000..0262578e --- /dev/null +++ b/doc/md/images/bookmarklet.png | |||
| Binary files differ | |||
diff --git a/doc/md/images/doc-logo.png b/doc/md/images/doc-logo.png new file mode 100644 index 00000000..3d8d1787 --- /dev/null +++ b/doc/md/images/doc-logo.png | |||
| Binary files differ | |||
diff --git a/doc/md/images/doc-logo.svg b/doc/md/images/doc-logo.svg new file mode 100644 index 00000000..37fc6658 --- /dev/null +++ b/doc/md/images/doc-logo.svg | |||
| @@ -0,0 +1,522 @@ | |||
| 1 | <?xml version="1.0" encoding="UTF-8" standalone="no"?> | ||
| 2 | <svg | ||
| 3 | xmlns:dc="http://purl.org/dc/elements/1.1/" | ||
| 4 | xmlns:cc="http://creativecommons.org/ns#" | ||
| 5 | xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" | ||
| 6 | xmlns:svg="http://www.w3.org/2000/svg" | ||
| 7 | xmlns="http://www.w3.org/2000/svg" | ||
| 8 | xmlns:xlink="http://www.w3.org/1999/xlink" | ||
| 9 | width="600" | ||
| 10 | height="240" | ||
| 11 | id="svg2" | ||
| 12 | version="1.1"> | ||
| 13 | <title | ||
| 14 | id="title6384">Shaarli Logo</title> | ||
| 15 | <defs | ||
| 16 | id="defs4"> | ||
| 17 | <linearGradient | ||
| 18 | id="linearGradient4405"> | ||
| 19 | <stop | ||
| 20 | style="stop-color:#000000;stop-opacity:1;" | ||
| 21 | offset="0" | ||
| 22 | id="stop4407" /> | ||
| 23 | <stop | ||
| 24 | style="stop-color:#ffffff;stop-opacity:1;" | ||
| 25 | offset="1" | ||
| 26 | id="stop4409" /> | ||
| 27 | </linearGradient> | ||
| 28 | <linearGradient | ||
| 29 | id="linearGradient3780"> | ||
| 30 | <stop | ||
| 31 | style="stop-color:#8aea00;stop-opacity:1;" | ||
| 32 | offset="0" | ||
| 33 | id="stop3782" /> | ||
| 34 | <stop | ||
| 35 | style="stop-color:#ebff36;stop-opacity:1;" | ||
| 36 | offset="1" | ||
| 37 | id="stop3784" /> | ||
| 38 | </linearGradient> | ||
| 39 | <linearGradient | ||
| 40 | id="linearGradient4333-6-7"> | ||
| 41 | <stop | ||
| 42 | style="stop-color:#ffffff;stop-opacity:1;" | ||
| 43 | offset="0" | ||
| 44 | id="stop4335-0-4" /> | ||
| 45 | <stop | ||
| 46 | style="stop-color:#e1e1e1;stop-opacity:1;" | ||
| 47 | offset="1" | ||
| 48 | id="stop4337-49-0" /> | ||
| 49 | </linearGradient> | ||
| 50 | <linearGradient | ||
| 51 | xlink:href="#linearGradient4333-6-7" | ||
| 52 | id="linearGradient4435" | ||
| 53 | gradientUnits="userSpaceOnUse" | ||
| 54 | gradientTransform="translate(-606.51586,-487.01655)" | ||
| 55 | x1="845.7998" | ||
| 56 | y1="637.30005" | ||
| 57 | x2="845.7998" | ||
| 58 | y2="509.84348" /> | ||
| 59 | <linearGradient | ||
| 60 | xlink:href="#linearGradient3780" | ||
| 61 | id="linearGradient4437" | ||
| 62 | gradientUnits="userSpaceOnUse" | ||
| 63 | gradientTransform="translate(-1434.0326,365.55395)" | ||
| 64 | x1="1984.2427" | ||
| 65 | y1="-348.63434" | ||
| 66 | x2="1984.2427" | ||
| 67 | y2="-293.69879" /> | ||
| 68 | <linearGradient | ||
| 69 | xlink:href="#linearGradient4333-6-7" | ||
| 70 | id="linearGradient4439" | ||
| 71 | gradientUnits="userSpaceOnUse" | ||
| 72 | gradientTransform="translate(-699.19746,-487.01655)" | ||
| 73 | x1="845.7998" | ||
| 74 | y1="637.30005" | ||
| 75 | x2="845.7998" | ||
| 76 | y2="509.84348" /> | ||
| 77 | <linearGradient | ||
| 78 | xlink:href="#linearGradient4333-6-7" | ||
| 79 | id="linearGradient4441" | ||
| 80 | gradientUnits="userSpaceOnUse" | ||
| 81 | gradientTransform="translate(-699.87915,-487.01655)" | ||
| 82 | x1="845.7998" | ||
| 83 | y1="637.30005" | ||
| 84 | x2="845.7998" | ||
| 85 | y2="509.84348" /> | ||
| 86 | <linearGradient | ||
| 87 | xlink:href="#linearGradient4333-6-7" | ||
| 88 | id="linearGradient4443" | ||
| 89 | gradientUnits="userSpaceOnUse" | ||
| 90 | gradientTransform="translate(-703.2869,-487.01655)" | ||
| 91 | x1="845.7998" | ||
| 92 | y1="637.30005" | ||
| 93 | x2="845.7998" | ||
| 94 | y2="509.84348" /> | ||
| 95 | <linearGradient | ||
| 96 | xlink:href="#linearGradient4333-6-7" | ||
| 97 | id="linearGradient4445" | ||
| 98 | gradientUnits="userSpaceOnUse" | ||
| 99 | gradientTransform="translate(-701.24225,-487.01655)" | ||
| 100 | x1="845.7998" | ||
| 101 | y1="637.30005" | ||
| 102 | x2="845.7998" | ||
| 103 | y2="509.84348" /> | ||
| 104 | <linearGradient | ||
| 105 | xlink:href="#linearGradient4333-6-7" | ||
| 106 | id="linearGradient4447" | ||
| 107 | gradientUnits="userSpaceOnUse" | ||
| 108 | gradientTransform="translate(-699.1976,-487.01655)" | ||
| 109 | x1="845.7998" | ||
| 110 | y1="637.30005" | ||
| 111 | x2="845.7998" | ||
| 112 | y2="509.84348" /> | ||
| 113 | <linearGradient | ||
| 114 | xlink:href="#linearGradient4333-6-7" | ||
| 115 | id="linearGradient4449" | ||
| 116 | gradientUnits="userSpaceOnUse" | ||
| 117 | gradientTransform="translate(-701.24225,-487.01655)" | ||
| 118 | x1="845.7998" | ||
| 119 | y1="637.30005" | ||
| 120 | x2="845.7998" | ||
| 121 | y2="509.84348" /> | ||
| 122 | <linearGradient | ||
| 123 | xlink:href="#linearGradient4333-6-7" | ||
| 124 | id="linearGradient4451" | ||
| 125 | gradientUnits="userSpaceOnUse" | ||
| 126 | gradientTransform="translate(-701.24225,-487.01655)" | ||
| 127 | x1="845.7998" | ||
| 128 | y1="637.30005" | ||
| 129 | x2="845.7998" | ||
| 130 | y2="509.84348" /> | ||
| 131 | <linearGradient | ||
| 132 | xlink:href="#linearGradient4333-6-7" | ||
| 133 | id="linearGradient4453" | ||
| 134 | gradientUnits="userSpaceOnUse" | ||
| 135 | gradientTransform="translate(-701.24225,-487.01655)" | ||
| 136 | x1="845.7998" | ||
| 137 | y1="637.30005" | ||
| 138 | x2="845.7998" | ||
| 139 | y2="509.84348" /> | ||
| 140 | <linearGradient | ||
| 141 | y2="509.84348" | ||
| 142 | x2="845.7998" | ||
| 143 | y1="637.30005" | ||
| 144 | x1="845.7998" | ||
| 145 | gradientTransform="translate(-701.24225,-487.01655)" | ||
| 146 | gradientUnits="userSpaceOnUse" | ||
| 147 | id="linearGradient6071" | ||
| 148 | xlink:href="#linearGradient4333-6-7" /> | ||
| 149 | <linearGradient | ||
| 150 | y2="509.84348" | ||
| 151 | x2="845.7998" | ||
| 152 | y1="637.30005" | ||
| 153 | x1="845.7998" | ||
| 154 | gradientTransform="translate(-701.24225,-487.01655)" | ||
| 155 | gradientUnits="userSpaceOnUse" | ||
| 156 | id="linearGradient6073" | ||
| 157 | xlink:href="#linearGradient4333-6-7" /> | ||
| 158 | <linearGradient | ||
| 159 | y2="509.84348" | ||
| 160 | x2="845.7998" | ||
| 161 | y1="637.30005" | ||
| 162 | x1="845.7998" | ||
| 163 | gradientTransform="translate(-701.24225,-487.01655)" | ||
| 164 | gradientUnits="userSpaceOnUse" | ||
| 165 | id="linearGradient6075" | ||
| 166 | xlink:href="#linearGradient4333-6-7" /> | ||
| 167 | <linearGradient | ||
| 168 | y2="509.84348" | ||
| 169 | x2="845.7998" | ||
| 170 | y1="637.30005" | ||
| 171 | x1="845.7998" | ||
| 172 | gradientTransform="translate(-699.1976,-487.01655)" | ||
| 173 | gradientUnits="userSpaceOnUse" | ||
| 174 | id="linearGradient6077" | ||
| 175 | xlink:href="#linearGradient4333-6-7" /> | ||
| 176 | <linearGradient | ||
| 177 | y2="509.84348" | ||
| 178 | x2="845.7998" | ||
| 179 | y1="637.30005" | ||
| 180 | x1="845.7998" | ||
| 181 | gradientTransform="translate(-701.24225,-487.01655)" | ||
| 182 | gradientUnits="userSpaceOnUse" | ||
| 183 | id="linearGradient6079" | ||
| 184 | xlink:href="#linearGradient4333-6-7" /> | ||
| 185 | <linearGradient | ||
| 186 | y2="509.84348" | ||
| 187 | x2="845.7998" | ||
| 188 | y1="637.30005" | ||
| 189 | x1="845.7998" | ||
| 190 | gradientTransform="translate(-703.2869,-487.01655)" | ||
| 191 | gradientUnits="userSpaceOnUse" | ||
| 192 | id="linearGradient6081" | ||
| 193 | xlink:href="#linearGradient4333-6-7" /> | ||
| 194 | <linearGradient | ||
| 195 | y2="509.84348" | ||
| 196 | x2="845.7998" | ||
| 197 | y1="637.30005" | ||
| 198 | x1="845.7998" | ||
| 199 | gradientTransform="translate(-699.87915,-487.01655)" | ||
| 200 | gradientUnits="userSpaceOnUse" | ||
| 201 | id="linearGradient6083" | ||
| 202 | xlink:href="#linearGradient4333-6-7" /> | ||
| 203 | <linearGradient | ||
| 204 | y2="509.84348" | ||
| 205 | x2="845.7998" | ||
| 206 | y1="637.30005" | ||
| 207 | x1="845.7998" | ||
| 208 | gradientTransform="translate(-699.19746,-487.01655)" | ||
| 209 | gradientUnits="userSpaceOnUse" | ||
| 210 | id="linearGradient6085" | ||
| 211 | xlink:href="#linearGradient4333-6-7" /> | ||
| 212 | <linearGradient | ||
| 213 | y2="-293.69879" | ||
| 214 | x2="1984.2427" | ||
| 215 | y1="-348.63434" | ||
| 216 | x1="1984.2427" | ||
| 217 | gradientTransform="translate(-1434.0326,365.55395)" | ||
| 218 | gradientUnits="userSpaceOnUse" | ||
| 219 | id="linearGradient6087" | ||
| 220 | xlink:href="#linearGradient3780" /> | ||
| 221 | <linearGradient | ||
| 222 | y2="509.84348" | ||
| 223 | x2="845.7998" | ||
| 224 | y1="637.30005" | ||
| 225 | x1="845.7998" | ||
| 226 | gradientTransform="translate(-606.51586,-487.01655)" | ||
| 227 | gradientUnits="userSpaceOnUse" | ||
| 228 | id="linearGradient6089" | ||
| 229 | xlink:href="#linearGradient4333-6-7" /> | ||
| 230 | <linearGradient | ||
| 231 | y2="-5.3252554" | ||
| 232 | x2="1795.8763" | ||
| 233 | y1="-116.8399" | ||
| 234 | x1="1795.8763" | ||
| 235 | gradientTransform="translate(-1431.3064,219.11539)" | ||
| 236 | gradientUnits="userSpaceOnUse" | ||
| 237 | id="linearGradient6095" | ||
| 238 | xlink:href="#linearGradient4405" /> | ||
| 239 | <mask | ||
| 240 | id="mask6091" | ||
| 241 | maskUnits="userSpaceOnUse"> | ||
| 242 | <rect | ||
| 243 | y="11.978719" | ||
| 244 | x="8.1208458" | ||
| 245 | height="153.34807" | ||
| 246 | width="582.72266" | ||
| 247 | id="rect6093" | ||
| 248 | style="color:#000000;fill:url(#linearGradient6095);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0" /> | ||
| 249 | </mask> | ||
| 250 | </defs> | ||
| 251 | <metadata | ||
| 252 | id="metadata7"> | ||
| 253 | <rdf:RDF> | ||
| 254 | <cc:Work | ||
| 255 | rdf:about=""> | ||
| 256 | <dc:format>image/svg+xml</dc:format> | ||
| 257 | <dc:type | ||
| 258 | rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> | ||
| 259 | <dc:title>Shaarli Logo</dc:title> | ||
| 260 | <dc:creator> | ||
| 261 | <cc:Agent> | ||
| 262 | <dc:title>http://blog.idleman.fr/</dc:title> | ||
| 263 | </cc:Agent> | ||
| 264 | </dc:creator> | ||
| 265 | <dc:date>2012-08-29 22:36:01+02:00</dc:date> | ||
| 266 | <dc:publisher> | ||
| 267 | <cc:Agent> | ||
| 268 | <dc:title>http://sebsauvage.net/</dc:title> | ||
| 269 | </cc:Agent> | ||
| 270 | </dc:publisher> | ||
| 271 | <dc:subject> | ||
| 272 | <rdf:Bag> | ||
| 273 | <rdf:li>Shaarli</rdf:li> | ||
| 274 | <rdf:li>Logo</rdf:li> | ||
| 275 | </rdf:Bag> | ||
| 276 | </dc:subject> | ||
| 277 | <dc:contributor> | ||
| 278 | <cc:Agent> | ||
| 279 | <dc:title>http://thatguynamedandy.com/, | ||
| 280 | http://mro.name/me</dc:title> | ||
| 281 | </cc:Agent> | ||
| 282 | </dc:contributor> | ||
| 283 | <cc:license | ||
| 284 | rdf:resource="http://www.opensource.org/licenses/zlib-license.php" /> | ||
| 285 | <dc:source>http://sebsauvage.net/files/shaarli_logo.zip</dc:source> | ||
| 286 | <dc:relation>http://sebsauvage.net/wiki/doku.php?id=php:shaarli:discussion#comment_09a1e91bc0abc7db6d186a6abf429877</dc:relation> | ||
| 287 | </cc:Work> | ||
| 288 | </rdf:RDF> | ||
| 289 | </metadata> | ||
| 290 | <g | ||
| 291 | style="display:inline" | ||
| 292 | id="layer9"> | ||
| 293 | <g | ||
| 294 | id="g6232"> | ||
| 295 | <g | ||
| 296 | style="display:inline" | ||
| 297 | id="g5987" | ||
| 298 | transform="matrix(1,0,0,-1,0,323.7441)" | ||
| 299 | mask="url(#mask6091)"> | ||
| 300 | <path | ||
| 301 | style="color:#000000;fill:#484848;fill-opacity:1;fill-rule:nonzero;stroke:#484848;stroke-width:38;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" | ||
| 302 | d="m 549.36434,78.11349 c -9.4946,1.99352 -9.7027,14.03504 -9.8352,21.77668 0.1121,11.0831 -0.2095,22.9628 4.1417,33.27264 2.0054,4.85047 9.7812,4.74809 10.3195,-1.06753 4.7624,-15.20498 4.7481,-32.01281 1.4946,-47.50541 -0.983,-2.75668 -3.069,-6.35036 -6.1206,-6.47638 z" | ||
| 303 | id="path5989" /> | ||
| 304 | <path | ||
| 305 | style="color:#000000;fill:#484848;fill-opacity:1;fill-rule:nonzero;stroke:#484848;stroke-width:38;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" | ||
| 306 | d="m 499.48944,47.6175 c -6.4927,-0.34021 -9.3439,6.60543 -8.1121,12.16941 -0.5858,24.07597 -0.3292,48.31194 0.034,72.30837 1.7508,6.96484 14.895,8.48808 15.0166,-0.0712 1.2169,-13.27189 -0.274,-26.75029 0.6639,-40.10232 0.7817,-11.41478 -0.5568,-23.24296 -0.6994,-34.37618 1.5849,-5.10643 -0.4706,-11.12871 -6.9034,-9.92811 z" | ||
| 307 | id="path5991" /> | ||
| 308 | <path | ||
| 309 | style="color:#000000;fill:#484848;fill-opacity:1;fill-rule:nonzero;stroke:#484848;stroke-width:38;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" | ||
| 310 | d="m 132.42293,35.23407 c -7.6945,2.17125 -5.9206,12.79289 -6.2273,19.00216 1.6106,23.24538 0.8475,46.57408 2.1706,69.81693 0.068,7.09423 3.2021,16.90233 11.8853,16.22657 7.5709,-1.76417 5.7778,-11.8325 5.6557,-17.71589 -0.047,-7.84014 -4.5559,-19.23884 3.9165,-24.30949 7.6405,-5.37547 19.848,0.64078 18.6463,10.39069 -0.3251,8.83089 -2.0837,22.16882 7.8287,26.47493 6.4024,2.92649 10.6176,-5.21693 9.3943,-10.71096 -0.3749,-13.55442 1.2727,-30.22607 -10.711,-39.6768 -7.9735,-4.05845 -18.9828,-5.54515 -26.8307,-0.21351 -1.0372,2.42576 -6.9951,6.95054 -6.4053,1.24546 -1.6949,-15.3749 2.056,-31.45755 -2.3485,-46.40228 -1.2024,-2.63946 -4.0324,-4.45898 -6.9746,-4.12781 z" | ||
| 311 | id="path5993" /> | ||
| 312 | <path | ||
| 313 | style="color:#000000;fill:#484848;fill-opacity:1;fill-rule:nonzero;stroke:#484848;stroke-width:38;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" | ||
| 314 | d="m 442.14024,64.05759 c -10.165,-0.2579 -20.6562,1.86137 -28.1474,9.18081 -2.8958,2.05591 -1.2663,-4.94966 -4.8395,-5.01742 -5.4074,-2.93338 -11.5829,2.98762 -9.5367,8.75381 0.099,20.06919 -1.977,40.97889 3.8787,60.387 3.1796,4.95849 13.7562,4.09337 12.7037,-2.9891 1.546,-15.53942 -2.968,-32.10549 3.167,-46.86488 4.3319,-8.66318 18.41,-14.13659 25.3718,-5.90704 3.521,6.12624 -0.9752,16.78774 6.8323,20.31879 7.6504,1.3481 9.6041,-9.08157 8.825,-14.7676 -1.6539,-6.72434 -2.1565,-14.5353 -6.6544,-19.99852 -3.1376,-2.78799 -7.564,-3.22067 -11.6005,-3.09585 z" | ||
| 315 | id="path5995" /> | ||
| 316 | <path | ||
| 317 | style="color:#000000;fill:url(#linearGradient6071);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22" | ||
| 318 | d="m 442.38294,54.04595 c -0.1827,-0.005 -0.3789,0.0345 -0.5625,0.0312 -8.6942,-0.15632 -18.301,1.16995 -26.7813,5.96876 -0.368,-0.21564 -0.7676,-0.37654 -1.1562,-0.5625 l 0.031,-0.0625 c -0.2019,-0.10958 -0.4204,-0.1194 -0.625,-0.21875 -0.5569,-0.23563 -1.1103,-0.37966 -1.6874,-0.53125 -6.0741,-2.10894 -12.7994,-0.4336 -16.8438,3.34375 -3.8577,3.60298 -6.0063,9.29062 -5.1562,15.125 0.085,19.31578 -2.292,41.23535 4.3124,63.12499 l 0.4063,1.3125 0.75,1.1875 c 4.4521,6.94297 11.5862,8.53059 18,7.46875 3.2069,-0.53092 6.701,-1.89897 9.5,-5.03125 2.2725,-2.54317 3.5121,-6.27514 3.5937,-9.84375 0,-0.0435 0,-0.0816 0,-0.125 1.7478,-17.81793 -1.8544,-32.72457 2.2813,-43.375 0.6976,-1.23208 3.1856,-3.39065 5.4063,-4.03125 1.1119,-0.32077 1.7363,-0.44325 2.1874,-0.40625 0.051,0.8996 0.2789,2.71568 0.5313,6.0625 0.1821,2.41445 0.4732,5.42185 2.0313,8.8125 1.558,3.39065 4.8419,6.94014 8.8437,8.75 l 1.1563,0.5 1.2187,0.21875 c 4.1545,0.73208 8.9361,-0.28467 12.2187,-2.59375 3.2827,-2.30908 5.1358,-5.31163 6.3126,-8.0625 2.3534,-5.50175 2.5912,-10.54096 1.9374,-15.3125 l -0.062,-0.53125 -0.125,-0.5 c -1.3372,-5.43656 -1.418,-15.17693 -8.6563,-23.96874 l -0.4687,-0.59375 -0.5938,-0.53125 c -6.0316,-5.35952 -13.0425,-5.71213 -18,-5.59376 l 0,-0.0312 z m -20.9688,14.62501 c 0.3103,0.61975 0.1924,0.76755 0.063,0.28125 -0.016,-0.0599 -0.046,-0.21107 -0.063,-0.28125 z m -11.8437,14.15624 c 0.271,0.10418 0.5347,0.22752 0.8125,0.3125 l -0.125,0.21875 -0.125,0.3125 c -0.2313,0.55649 -0.3535,1.10135 -0.5625,1.65625 0.01,-0.84699 -0.01,-1.64903 0,-2.5 z" | ||
| 319 | id="path5997" /> | ||
| 320 | <path | ||
| 321 | style="color:#000000;fill:#484848;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:38" | ||
| 322 | d="m 334.93614,43.42895 -1.125,0.0625 c -11.4541,0.68757 -31.1299,2.13948 -42.5313,20.5 l -0.6875,1.15625 -0.5312,1.21875 c -4.0155,9.09454 -1.1737,19.34928 5,25.5 -7.1006,9.03999 -10.5361,20.69833 -9.25,32.65625 -0.7932,13.71238 8.5163,26.58972 21.5624,30.34375 l -0.031,0.0625 c 14.5936,5.02387 28.3345,3.89176 40,1.875 1.1383,0.61027 2.377,1.24208 3.8438,1.84375 3.1932,1.30991 7.6804,2.60895 13.1874,1.96875 5.5071,-0.6402 11.3463,-3.71585 15.0626,-7.53125 l 0.6562,-0.6875 0.5938,-0.75 c 7.375,-9.27994 7.6766,-20.19393 7.1874,-26.8125 -0.4891,-6.61857 -1.0653,-10.99648 -1.0312,-11.375 l 0.125,-1.46875 -0.094,-1.5 c -0.9045,-13.69999 -0.4438,-31.50909 -8.6874,-49.71875 -0.8869,-3.14352 -2.6183,-4.60975 -5,-6.625 -14.193,-12.04738 -29.8012,-10.22761 -37.125,-10.65625 z m -5,69.25 c -0.6975,0.25422 -0.096,-0.059 3.5937,0.375 3.1757,0.3735 8.4922,1.29071 15.3437,0.34375 -0.042,1.60674 -0.047,3.10046 0.031,4.46875 l -1.2187,0.25 c -9.4296,1.92946 -17.7526,2.70557 -24.0626,1.71875 0.3089,-2.61777 2.5558,-6.11412 4.2813,-6.53125 l 1.0313,-0.25 1,-0.375 z" | ||
| 323 | id="path5999" /> | ||
| 324 | <path | ||
| 325 | id="path6001" | ||
| 326 | d="m 242.86794,62.94328 c -9.8451,0.59098 -21.9234,2.57343 -27.5069,11.56498 -1.5225,3.44827 2.5155,7.16458 5.8003,4.55483 11.6876,-3.18405 25.8772,-8.64334 36.9368,-1.03196 3.4255,4.6575 3.2712,13.73214 -2.1351,16.8315 -8.1137,1.83399 -16.456,-2.50178 -24.589,0.4626 -12.7407,3.08001 -20.924,16.83116 -18.6463,29.53519 -1.221,6.03853 2.7535,11.58045 8.7182,12.59694 12.2603,4.22059 25.7141,2.25842 37.9688,-0.24909 3.9671,2.72001 9.7011,7.85911 14.3406,3.09585 6.2596,-7.87653 1.273,-19.02318 2.088,-28.06851 -0.9577,-14.50429 -1.0481,-29.91302 -7.0343,-43.1362 -7.0905,-6.01862 -17.2216,-5.6458 -25.9411,-6.15613 z" | ||
| 327 | style="color:#000000;fill:#484848;fill-opacity:1;fill-rule:nonzero;stroke:#484848;stroke-width:38;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" /> | ||
| 328 | <path | ||
| 329 | style="color:#000000;fill:url(#linearGradient6073);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22" | ||
| 330 | d="m 132.71733,24.19589 c -0.5004,0.0152 -1.0205,0.0363 -1.5312,0.0937 l -0.9063,0.0937 -0.8437,0.25 c -4.2861,1.20943 -8.1936,4.24904 -10.375,7.56249 -2.1816,3.31346 -2.9841,6.56659 -3.4063,9.375 -0.8444,5.61682 -0.3823,10.37282 -0.4687,12.125 l -0.031,0.65625 0.062,0.625 c 1.548,22.34205 0.8033,45.46456 2.125,69.1875 5e-4,0.0505 0.031,0.10568 0.031,0.15625 0.01,0.1151 -0.01,0.22862 0,0.34375 l 0.031,0 c 0.099,4.98929 0.9665,10.43113 4.125,15.90625 3.2605,5.65198 11.0145,11.32149 19.5625,10.65625 l 0.8438,-0.0625 0.8124,-0.1875 c 4.2384,-0.98762 8.3269,-3.79564 10.625,-7.09375 2.1728,-3.63384 4.3342,-6.89183 5.1872,-10.22818 3.8402,7.13335 5.9507,8.04619 13.1566,11.44693 l 0,0.0312 c 0.059,0.0269 0.1281,0.0362 0.1875,0.0625 3.7423,1.65403 8.4312,1.97661 12.2813,0.65625 3.91101,-1.34132 6.71761,-3.90092 8.59371,-6.5 3.336,-4.62154 4.6441,-9.64143 3.9063,-15.25 -0.1718,-6.20746 0.2238,-14.23226 -1.1563,-22.8125 -1.3801,-8.58024 -5.0962,-18.36284 -13.75001,-25.1875 l -0.8437,-0.6875 -0.9688,-0.5 c -7.7653,-3.95251 -17.7087,-6.355 -27.4062,-4.09375 0.4086,-10.28331 1.089,-21.96033 -2.625,-34.5625 l -0.2188,-0.75 -0.3125,-0.71875 c -2.9167,-6.40275 -9.181,-10.82231 -16.6875,-10.59374 z m 6.0625,53.99999 c 0,0.0101 0.05,0.0315 0.062,0.0625 l -0.6245,1.46875 c 0.3311,-0.86163 0.5542,-1.56647 0.5625,-1.53125 z m 36.0625,48.28125 c 0.012,-0.004 0.019,0.005 0.031,0 l 0.063,0.3125 c -0.043,-0.19086 -0.061,-0.25465 -0.094,-0.3125 z" | ||
| 331 | id="path6003" /> | ||
| 332 | <path | ||
| 333 | style="fill:#484848;fill-opacity:1;stroke:none" | ||
| 334 | id="path6005" | ||
| 335 | d="m 133.3461,36.09636 c -1.692,0.49428 -2.8155,1.39846 -3.625,2.625 -0.8214,1.24442 -1.3243,2.85069 -1.5938,4.625 -0.5342,3.51732 -0.1953,7.61208 -0.3438,10.8125 0,0.0285 0,0.0654 0,0.0937 1.6063,23.27388 0.8692,46.5905 2.1876,69.75 a 0.88388823,0.88388823 0 0 1 0,0.0625 c 0.033,3.4213 0.83,7.53419 2.5937,10.59375 1.7438,3.02495 4.2922,5.00636 8.2187,4.75 0.011,-7.3e-4 0.02,7.7e-4 0.031,0 1.6857,-0.39978 2.7542,-1.19719 3.5313,-2.3125 0.7819,-1.12237 1.2391,-2.59827 1.4687,-4.25 0.4593,-3.30346 2e-4,-7.22907 -0.062,-10.25 a 0.88388823,0.88388823 0 0 1 0,-0.0312 c -0.023,-3.75401 -1.179,-8.58343 -1.25,-13.1875 -0.071,-4.59014 1.0512,-9.12033 5.5625,-11.84375 0.012,-0.008 0.019,-0.023 0.031,-0.0312 8.2411,-5.75335 21.2001,0.72746 19.9687,11.1875 0,0.011 0,0.0202 0,0.0312 -4e-4,0.01 4e-4,0.0216 0,0.0312 -0.1662,4.44678 -0.6416,9.92071 0.094,14.71875 0.7386,4.81878 2.5857,8.83105 7.2188,10.84375 a 0.88388823,0.88388823 0 0 1 0.031,0 c 1.4264,0.65196 2.625,0.67804 3.6876,0.3125 1.0625,-0.36554 2.0152,-1.15367 2.7812,-2.21875 1.532,-2.13016 2.2012,-5.36524 1.6562,-7.8125 a 0.88388823,0.88388823 0 0 1 0,-0.15625 c -0.1887,-6.82351 0.1073,-14.35845 -1,-21.28125 -1.1026,-6.89383 -3.5864,-13.13587 -9.3124,-17.6875 -7.7294,-3.90433 -18.3437,-5.25802 -25.7813,-0.25 -0.7734,1.48479 -2.3237,3.00623 -4,3.78125 -0.9043,0.41808 -1.982,0.65336 -2.875,0.0312 -0.8519,-0.59346 -1.0866,-1.72753 -0.9687,-3.1875 0.01,-0.0705 -0.01,-0.11538 0,-0.1875 -1.6634,-15.48034 1.9617,-31.38045 -2.2813,-45.9375 -1.0363,-2.2749 -3.4784,-3.85945 -5.9687,-3.625 z" /> | ||
| 336 | <path | ||
| 337 | style="color:#000000;fill:url(#linearGradient6075);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22" | ||
| 338 | d="m 500.00794,37.6397 c -0.47,-0.0246 -0.9099,0.13839 -1.375,0.15625 -0.3182,0.036 -0.6564,-0.0583 -0.9688,0 l 0,0.0937 c -5.9486,0.59666 -11.3199,4.27914 -13.8124,8.625 -2.5191,4.39212 -3.1643,9.07388 -2.4688,13.75001 -0.5691,24.07161 -0.3288,48.17845 0.031,71.96874 l 0.031,1.1875 0.2813,1.125 c 2.2758,9.05358 10.1204,12.94327 17.2812,13.3125 3.5804,0.18461 7.6057,-0.50128 11.25,-3.21875 3.4431,-2.56742 5.753,-7.21537 6.0625,-11.6875 l 0.062,0 c 0.024,-0.26477 0.01,-0.51719 0.031,-0.78125 1.2169,-14.32127 -0.1813,-27.63851 0.6563,-39.5625 0.8412,-12.28307 -0.4559,-23.97948 -0.6563,-34.18749 0.9168,-4.19732 0.7514,-8.64033 -1.75,-13.09376 -2.5398,-4.52202 -8.6787,-7.57722 -14.4374,-7.5625 -0.073,1.9e-4 -0.1457,-0.001 -0.2188,0 l 0,-0.125 z m -0.4375,10.46875 1.5625,8.375 c -0.089,0.0884 -0.5399,0.26586 -0.9688,0.50001 -0.4433,-0.17558 -0.588,-0.31717 -1.125,-0.59376 l 0.5313,-8.28125 z m 1.625,8.6875 0.125,0.65626 c 0,-5.2e-4 -0.146,-0.0578 -0.1563,-0.0625 0.013,-0.26164 0.01,-0.41632 0.031,-0.59376 z" | ||
| 339 | id="path6007" /> | ||
| 340 | <path | ||
| 341 | style="fill:#484848;fill-opacity:1;stroke:none" | ||
| 342 | d="m 499.48944,47.6175 c -6.4927,-0.34021 -9.3439,6.60543 -8.1121,12.16941 -0.5858,24.07597 -0.3292,48.31194 0.034,72.30837 1.7508,6.96484 14.895,8.48808 15.0166,-0.0712 1.2169,-13.27189 -0.274,-26.75029 0.6639,-40.10232 0.7817,-11.41478 -0.5568,-23.24296 -0.6994,-34.37618 1.5849,-5.10643 -0.4706,-11.12871 -6.9034,-9.92811 z" | ||
| 343 | id="path6009" /> | ||
| 344 | <path | ||
| 345 | style="fill:#000000;fill-opacity:1;stroke:none" | ||
| 346 | d="m 544.51954,53.6313 c -7.5784,-0.46784 -10.6755,10.08558 -4.626,14.19825 6.4831,5.13984 16.9776,-2.57743 12.9884,-10.24836 -1.4384,-3.20261 -5.1136,-4.25984 -8.3624,-3.94989 z" | ||
| 347 | id="path6011" /> | ||
| 348 | <path | ||
| 349 | style="fill:#484848;fill-opacity:1;stroke:#484848;stroke-width:38;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" | ||
| 350 | d="m 66.312222,57.93009 c -17.370703,0.62829 -30.0641,20.09681 -26.023403,36.39781 2.1928,10.05075 13.8541,12.09708 22.635103,11.4922 7.1377,-0.5151 17.6041,2.45346 16.7319,11.49222 -1.8676,6.29718 -10.9897,4.97438 -16.0667,5.21679 -7.019003,0.3042 -14.551803,-2.83467 -21.309203,-1.0251 -5.546297,3.71601 -0.7698,11.63178 4.4362,13.09902 11.6204,3.85396 24.776703,2.98561 36.677203,0.52396 8.494404,-1.78465 13.976704,-9.66183 14.007304,-18.12905 0.5362,-8.45978 -0.1252,-18.85777 -9.082,-22.63511 -7.833304,-4.5437 -17.524404,-2.59996 -25.744004,-4.64578 -6.504303,-3.75215 -4.590203,-15.08325 3.2137,-15.54417 8.376,-2.645 16.5844,3.54335 24.730904,1.74653 6.8027,-2.75685 5.6777,-13.26551 -1.2924,-15.19486 C 82.177322,57.19274 73.972122,57.9802 66.312222,57.93009 Z" | ||
| 351 | id="path6013" /> | ||
| 352 | <path | ||
| 353 | style="color:#000000;fill:url(#linearGradient6077);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22" | ||
| 354 | d="m 66.146122,46.92095 -0.2187,0.0312 c -25.268203,0.91394 -41.9786,26.29641 -36.375,49.71875 0,0.01 0,0.0214 0,0.0312 0.023,0.0937 0.039,0.18758 0.062,0.28125 l 0.062,0 c 1.4158,6.03031 5.2241,10.72981 9.5937,13.9375 l -1.5937,0.4375 -1.5313,1 c -3.4934,2.34058 -6.2461,6.40677 -7.0312,10.4375 -0.7852,4.03073 0.016,7.64447 1.2812,10.53125 2.4625,5.61698 6.4364,9.72109 12.843797,11.6875 l 0,0.0312 c 0.1235,0.0409 0.2514,0.0537 0.375,0.0937 0.044,0.0142 0.081,0.0484 0.125,0.0625 14.2876,4.59699 29.052403,3.33987 41.875007,0.6875 l 0.031,0 c 13.703,-2.87897 22.354804,-15.23519 22.687504,-28.1875 l 0.031,0 c 0.01,-0.1043 -0.01,-0.23849 0,-0.34375 0,-0.10511 0.031,-0.20733 0.031,-0.3125 l -0.031,0 c 0.275,-4.68022 0.3633,-10.21921 -1.4063,-16.21875 -1.6128,-5.46789 -5.6186,-11.40935 -11.718704,-15.03125 C 110.28983,79.05558 108.57813,56.15757 93.550926,50.6395 83.076822,45.62854 73.121622,46.96476 66.394622,46.92075 l -0.25,0 z M 49.927419,124.0772 c 0.4736,0.11312 0.7429,0.17483 0.6875,0.1875 -0.1379,-0.0437 -0.3009,-0.0484 -0.4375,-0.0937 l -0.25,-0.0937 z" | ||
| 355 | id="path6015" /> | ||
| 356 | <path | ||
| 357 | style="fill:#484848;fill-opacity:1;stroke:none" | ||
| 358 | id="path6017" | ||
| 359 | d="M 67.047,59.37761 C 50.7565,60.01346 38.6203,78.63489 42.422,93.97136 a 1.4420115,1.4420115 0 0 1 0,0.0312 c 0.9874,4.52574 3.9833,7.14275 7.9688,8.71875 3.9854,1.576 8.921,1.948 13.1562,1.65625 3.8182,-0.27555 8.4163,0.35581 12.1562,2.34375 3.74,1.98794 6.6157,5.6345 6.125,10.71875 a 1.4420115,1.4420115 0 0 1 -0.062,0.28125 c -0.5618,1.89409 -1.746,3.32797 -3.1876,4.25 -1.4415,0.92203 -3.0867,1.39395 -4.7812,1.65625 -3.3889,0.5246 -7.0334,0.23046 -9.4062,0.34375 -7.4077,0.32104 -14.726,-2.60314 -20.7813,-1.09375 -0.9228,0.69289 -1.3969,1.4625 -1.5625,2.3125 -0.1806,0.92739 -0.017,2.01851 0.4688,3.125 0.9708,2.21298 3.281,4.32492 5.3437,4.90625 a 1.4420115,1.4420115 0 0 1 0.062,0 c 11.2515,3.73156 24.1465,2.93253 35.9062,0.5 7.7821,-1.63499 12.8466,-8.87337 12.875,-16.71875 a 1.4420115,1.4420115 0 0 1 0,-0.0937 c 0.2634,-4.15469 0.2008,-8.71518 -0.9374,-12.5625 -1.1383,-3.84732 -3.227,-6.9152 -7.2813,-8.625 a 1.4420115,1.4420115 0 0 1 -0.1563,-0.0937 c -7.233,-4.1955 -16.6908,-2.33856 -25.375,-4.5 a 1.4420115,1.4420115 0 0 1 -0.375,-0.15625 c -7.593,-4.38022 -5.364,-17.27483 3.5,-18.15625 l 0,-0.0312 c 0.1153,-0.0364 0.2288,-0.0291 0.3438,-0.0625 4.5012,-1.3064 8.8395,-0.37995 12.875,0.59375 4.0804,0.98454 7.88,1.92841 11.4688,1.1875 5.4755,-2.31046 4.4951,-10.8333 -1.1876,-12.40625 a 1.4420115,1.4420115 0 0 1 -0.2812,-0.0937 c -6.5535,-3.28332 -14.4405,-2.57842 -22.1875,-2.625 -0.021,-1.3e-4 -0.042,1.4e-4 -0.062,0 z" /> | ||
| 360 | <path | ||
| 361 | style="color:#000000;fill:url(#linearGradient6079);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22" | ||
| 362 | d="m 334.91414,52.45217 -0.5624,0.0312 c -10.692,0.64182 -26.7608,2.35866 -35.4063,16.28126 l -0.375,0.59375 -0.2813,0.625 c -2.6168,5.92672 -0.4865,12.63582 3.8126,16.24999 2.47,2.0766 6.1544,2.97511 9.8124,2.75 -12.1731,7.16212 -18.9579,21.29295 -17.0937,35.5 -0.9321,10.0329 5.7963,19.42583 15.4375,21.90625 l 0,0.0312 c 13.5839,4.67628 27.0449,3.11875 38.7812,0.90625 1.4491,0.98507 3.2876,2.06677 5.5626,3 2.2748,0.93323 5.2583,1.74964 8.75,1.34375 3.4915,-0.40589 7.1195,-2.30283 9.625,-4.875 l 0.375,-0.34375 0.3124,-0.40625 c 5.3642,-6.74967 5.6479,-14.75709 5.2188,-20.5625 -0.4291,-5.80541 -1.211,-10.50221 -1,-12.84375 l 0.062,-0.78125 -0.062,-0.75 c -0.9297,-14.08097 -0.732,-30.77734 -7.9062,-46.62499 -0.4593,-1.65783 -1.3753,-2.43205 -2.625,-3.4999 -10.8288,-9.19166 -23.8588,-8.03267 -31.8438,-8.50001 l -0.5938,-0.0312 z m 22.0626,47.46875 c 0.2983,4.01025 0.663,7.89337 0.9374,12.09375 -0.3619,6.15055 0.7536,11.18085 1.0313,14.9375 0.091,1.23358 -3e-4,1.89681 -0.031,2.71875 -0.7261,-0.49389 -0.8804,-0.56988 -1.7812,-1.1875 l -3.5,-2.40625 -4.1562,0.84375 c -11.8502,2.42474 -23.4896,3.77093 -32.7188,0.59375 l -0.75,-0.25 -0.8125,-0.15625 c -0.7563,-0.12889 -0.7437,-0.008 -0.5937,-0.75 l 0.375,-1.875 -0.3438,-1.875 c -1.3223,-7.37497 4.0726,-16.31882 11.1562,-18.03125 l 0.5626,-0.15625 0.5312,-0.1875 c 1.5591,-0.56829 3.7957,-0.58273 7.6875,-0.125 3.8918,0.45773 9.2275,1.48444 15.6563,0.0312 l 1.4687,-0.34375 1.3125,-0.75 c 1.5458,-0.8862 2.8481,-1.95265 3.9688,-3.125 z" | ||
| 363 | id="path6019" /> | ||
| 364 | <path | ||
| 365 | style="fill:#484848;fill-opacity:1;stroke:none" | ||
| 366 | id="path6021" | ||
| 367 | d="m 442.8461,65.50261 c -9.9417,-0.25223 -20.0112,1.83054 -27.125,8.78125 a 1.4249747,1.4249747 0 0 1 -0.1876,0.125 c -0.4923,0.34955 -1.0141,0.64308 -1.6874,0.65625 -0.6734,0.0132 -1.3402,-0.39879 -1.6876,-0.8125 -0.6947,-0.82743 -0.7686,-1.5945 -0.9687,-2.34375 -0.2001,-0.74925 -0.4246,-1.47139 -0.6563,-1.84375 -0.2316,-0.37236 -0.2624,-0.39819 -0.6874,-0.40625 a 1.4249747,1.4249747 0 0 1 -0.6563,-0.1875 c -2.1511,-1.16691 -4.3134,-0.58174 -5.9063,0.90625 -1.5928,1.48799 -2.4145,3.81205 -1.5937,6.125 a 1.4249747,1.4249747 0 0 1 0.094,0.46875 c 0.099,20.08519 -1.9054,40.73856 3.75,59.71875 1.2377,1.74956 4.0539,2.66609 6.4063,2.28125 1.2075,-0.19755 2.2216,-0.71247 2.8437,-1.40625 0.6222,-0.69378 0.9615,-1.54589 0.75,-2.96875 a 1.4249747,1.4249747 0 0 1 0,-0.375 c 1.5091,-15.16756 -3.1254,-31.94343 3.25,-47.28125 a 1.4249747,1.4249747 0 0 1 0.031,-0.0625 c 2.3884,-4.77662 7.2847,-8.50018 12.5937,-10.03125 5.3091,-1.53107 11.2689,-0.75156 15.1563,3.84375 a 1.4249747,1.4249747 0 0 1 0.1563,0.1875 c 2.0694,3.60071 1.6918,8.0153 1.9687,11.75 0.1385,1.86735 0.4194,3.54061 1.0313,4.875 0.5916,1.2904 1.4751,2.25734 3.0312,3 1.4606,0.20734 2.5297,-0.051 3.4375,-0.6875 0.9587,-0.67214 1.771,-1.81376 2.375,-3.21875 1.2079,-2.80999 1.508,-6.6831 1.1563,-9.25 -1.6601,-6.82503 -2.269,-14.23556 -6.2813,-19.1875 -2.6943,-2.32961 -6.6692,-2.77567 -10.5313,-2.65625 a 1.4249747,1.4249747 0 0 1 -0.062,0 z" /> | ||
| 368 | <path | ||
| 369 | style="color:#000000;fill:url(#linearGradient6081);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22" | ||
| 370 | d="m 548.52594,68.07721 -1.2187,0.25 c -8.6956,1.82574 -14.1425,9.53796 -15.9688,15.68749 -1.8263,6.14954 -1.7462,11.84707 -1.8125,15.71875 l 0,0.125 0,0.125 c 0.1092,10.79916 -0.5536,24.0134 4.9063,37 0.01,0.0225 0.022,0.0401 0.031,0.0625 2.7726,6.62078 9.3817,9.9621 15.5625,9.5625 5.6001,-0.36206 11.8353,-5.2195 13.5,-11.53125 5.3924,-17.21633 5.3013,-35.62075 1.75,-52.53125 l -0.1563,-0.6875 -0.2187,-0.62499 c -0.7814,-2.19128 -1.853,-4.62969 -3.9375,-7.1875 -2.0845,-2.55781 -5.8401,-5.71667 -11.1875,-5.9375 l -1.25,-0.0312 z" | ||
| 371 | id="path6023" /> | ||
| 372 | <path | ||
| 373 | style="fill:#484848;fill-opacity:1;stroke:none" | ||
| 374 | id="path6025" | ||
| 375 | d="m 550.1139,78.59636 c -4.5226,0.97522 -6.7823,4.26272 -8,8.375 -1.2232,4.13111 -1.3087,9.03503 -1.375,12.90625 0.1123,11.09592 -0.2043,22.90976 4.0938,33.09375 0.9213,2.22841 3.1731,3.32073 5.25,3.1875 2.0769,-0.13323 3.906,-1.39 4.1562,-4.09375 a 0.46475483,0.46475483 0 0 1 0.031,-0.0937 c 4.7332,-15.11164 4.7084,-31.85462 1.4687,-47.28125 -0.4788,-1.32581 -1.2248,-2.85305 -2.1874,-4.03125 -0.9629,-1.17844 -2.1146,-1.98485 -3.4376,-2.0625 z" /> | ||
| 376 | <path | ||
| 377 | style="color:#000000;fill:url(#linearGradient6083);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22" | ||
| 378 | d="m 242.87094,52.92092 -0.5938,0.0312 c -10.6919,0.64192 -26.7607,2.35873 -35.4062,16.28131 l -0.375,0.59375 -0.2813,0.65625 c -2.6168,5.92671 -0.4864,12.60456 3.8125,16.21874 2.4771,2.0825 6.1757,2.98309 9.8438,2.75 -12.176,7.14722 -18.9659,21.26849 -17.125,35.46875 -0.9665,10.0609 5.7999,19.48906 15.4687,21.96875 l -0.031,0.0312 c 13.5891,4.67806 27.073,3.12012 38.8125,0.90625 1.4445,0.97996 3.2715,2.07302 5.5313,3 2.2749,0.93323 5.2585,1.71839 8.75,1.3125 3.4915,-0.40589 7.1509,-2.27156 9.6562,-4.84375 l 0.3438,-0.375 0.3125,-0.40625 c 5.3641,-6.74969 5.6478,-14.72585 5.2187,-20.53125 -0.4291,-5.8054 -1.2109,-10.50221 -1,-12.84375 l 0.062,-0.78125 -0.062,-0.78125 c -0.9297,-14.081 -0.7006,-30.74608 -7.875,-46.59374 l -0.9375,-2.0625 -1.7187,-1.4375 c -10.8287,-9.19167 -23.8276,-8.06392 -31.8125,-8.53126 l -0.5938,-0.0312 z m 22.0312,47.5 c 0.2974,4.00059 0.6637,7.87292 0.9375,12.0625 -0.3619,6.15055 0.7536,11.2121 1.0313,14.96875 0.091,1.22812 0,1.86766 -0.031,2.6875 -0.7261,-0.49388 -0.8805,-0.56989 -1.7813,-1.1875 l -3.5,-2.40625 -4.1562,0.875 c -11.8502,2.42475 -23.4582,3.77094 -32.6875,0.59375 l -0.7813,-0.28125 -0.8125,-0.125 c -0.7563,-0.12888 -0.7437,-0.0396 -0.5938,-0.78125 l 0.375,-1.84375 -0.3437,-1.875 c -1.3223,-7.37494 4.0726,-16.35008 11.1562,-18.0625 l 0.5625,-0.125 0.5313,-0.1875 c 1.5591,-0.56828 3.7957,-0.58273 7.6875,-0.125 3.8918,0.45773 9.2275,1.45313 15.6562,0 l 1.4688,-0.3125 1.3125,-0.75 c 1.5458,-0.8862 2.8482,-1.95265 3.9687,-3.125 z" | ||
| 379 | id="path6027" /> | ||
| 380 | <path | ||
| 381 | style="fill:#484848;fill-opacity:1;stroke:#484848;stroke-width:3;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" | ||
| 382 | id="path6029" | ||
| 383 | d="m 243.6361,64.63031 c -9.6363,0.58398 -20.9336,2.59484 -26.0312,10.625 -0.4035,0.99026 -0.045,1.9107 0.6562,2.5 0.717,0.60234 1.4896,0.85243 2.5626,0 a 1.684398,1.684398 0 0 1 0.625,-0.3125 c 5.775,-1.5733 12.3167,-3.78461 18.9374,-4.625 6.6208,-0.84039 13.4444,-0.25925 19.4063,3.84375 a 1.684398,1.684398 0 0 1 0.375,0.375 c 2.0281,2.75755 2.9112,6.50666 2.5937,10.125 -0.3174,3.61834 -1.9072,7.25777 -5.2187,9.15625 a 1.684398,1.684398 0 0 1 -0.4687,0.1875 c -4.4561,1.00721 -8.7953,0.29068 -12.875,-0.1875 -4.0798,-0.47818 -7.8868,-0.73461 -11.5313,0.59375 a 1.684398,1.684398 0 0 1 -0.1563,0.0312 c -11.7884,2.8498 -19.5228,15.78804 -17.4062,27.59375 a 1.684398,1.684398 0 0 1 0,0.65625 c -1.0407,5.14641 2.2557,9.72666 7.3438,10.59375 a 1.684398,1.684398 0 0 1 0.2812,0.0625 c 11.7498,4.04484 24.8758,2.18109 37.0625,-0.3125 a 1.684398,1.684398 0 0 1 1.2813,0.28125 c 2.0816,1.42722 4.4575,3.29235 6.625,4.1875 1.0837,0.44757 2.0633,0.63094 2.9374,0.53125 0.8627,-0.0984 1.6764,-0.44585 2.5938,-1.375 0.01,-0.0118 0.022,-0.0195 0.031,-0.0312 2.6608,-3.43997 2.9705,-7.61463 2.625,-12.3125 -0.3431,-4.66636 -1.3766,-9.66321 -1,-14.46875 -0.9524,-14.4251 -1.1073,-29.45823 -6.7187,-42.15625 -6.4124,-5.22259 -15.7954,-5.06556 -24.4687,-5.5625 -0.021,-10e-4 -0.042,0.001 -0.063,0 z" /> | ||
| 384 | <path | ||
| 385 | style="color:#000000;fill:url(#linearGradient6085);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22" | ||
| 386 | id="path6031" | ||
| 387 | d="m 252.9376,106.30395 c -3.4993,0.0307 -6.9607,-0.0581 -10.375,0.0312 -4.1004,0.36044 -9.0376,1.69024 -12.625,4.09375 -3.614,2.42133 -5.8704,5.68864 -5.2813,10.4375 0.4935,4.61527 3.5645,7.56447 7.6876,9.21875 4.123,1.65428 9.2633,1.8209 13.1562,0.65625 a 1.3611835,1.3611835 0 0 1 0.1562,-0.0312 c 2.8688,-0.49834 6.5939,-1.2529 9.2813,-2.71875 1.3437,-0.73292 2.3836,-1.63683 3.0313,-2.6875 0.6476,-1.05067 0.9604,-2.26047 0.6874,-3.96875 a 1.3611835,1.3611835 0 0 1 0,-0.28125 c 0.1564,-2.76724 0.3451,-6.68524 -0.375,-9.71875 -0.36,-1.51676 -0.9264,-2.77474 -1.75,-3.625 -0.8176,-0.8442 -1.8698,-1.36151 -3.5624,-1.40625 -0.012,-3.2e-4 -0.019,2.7e-4 -0.031,0 z" /> | ||
| 388 | <path | ||
| 389 | style="color:#000000;fill:#305f00;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:10" | ||
| 390 | d="m 550.24144,11.97714 c -4.7431,8e-5 -9.3884,1.94508 -12.1562,5.65625 -2.3938,3.20927 -3.2655,7.28209 -3.5,11.84374 -5.2417,0.10768 -9.658,0.71067 -13.2813,2.53125 -3.7519,1.88519 -6.5576,5.75636 -6.9063,9.9375 l -0.062,0 c -0.013,0.1027 0.011,0.20947 0,0.3125 0,0.043 -0.03,0.0819 -0.031,0.125 l 0.031,0 c -0.383,3.94189 0.8037,8.08581 3.625,10.84375 1.7434,1.70445 3.9242,2.79035 6.3124,3.59375 l -0.875,2.4375 -0.062,0.125 -0.031,0.125 c -1.0239,3.32791 -0.9882,7.09444 0.8437,10.15625 1.8322,3.06181 4.9132,4.85334 8.3438,5.90625 l 0.7188,0.21875 0.75,0 2.2812,0 c 4.1038,5e-5 8.0184,-1.11288 11.1562,-3.5 1.388,-1.05587 2.5677,-2.38102 3.5938,-3.8125 2.738,2.5559 6.0541,4.80834 10,6.78125 l 0.5,0.25 0.5312,0.15625 c 3.235,0.79227 6.3972,0.95306 9.4063,-0.1875 2.9956,-1.13542 5.3523,-3.78973 6.4375,-6.71875 l 0.031,0 0,-0.0312 c 1.3188,-3.58119 1.0754,-7.65809 -0.4687,-11.1875 -0.3593,-0.82136 -0.9637,-1.56048 -1.4375,-2.34375 0.7988,-0.35352 1.5774,-0.75006 2.3125,-1.28125 3.1456,-2.2731 4.4669,-6.43958 4.1563,-10.25 l 0.031,0 c 0,-0.12851 -0.061,-0.24691 -0.062,-0.375 -0.017,-0.15367 0.023,-0.31671 0,-0.46875 l -0.062,0 c -0.2506,-3.85862 -2.6242,-7.47641 -5.875,-9.5625 -3.1968,-2.05143 -7.2278,-3.19745 -12.0625,-4.03124 -0.5947,-4.02941 -1.4462,-7.64148 -3.125,-10.53125 -2.2702,-3.9078 -6.5646,-6.71865 -11.0625,-6.71875 z m 18.3125,50.62499 c 0.2654,0.97712 0.2969,1.7705 -0.031,2.65625 l 0,0.0312 c -0.3181,0.86918 -0.3036,0.72198 -0.625,0.84375 -0.2585,0.098 -1.2073,0.14918 -2.5624,-0.0625 0.3313,-0.1475 0.7366,-0.14338 1.0312,-0.34375 l 0.4375,-0.28125 0.375,-0.40625 c 0.5814,-0.62017 0.9776,-1.55372 1.375,-2.4375 z" | ||
| 391 | id="path6033" /> | ||
| 392 | <g | ||
| 393 | id="text6035" | ||
| 394 | style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:165.01513672px;line-height:125%;font-family:'comic andy';-inkscape-font-specification:'comic andy';letter-spacing:0px;word-spacing:0px;fill:url(#linearGradient4437);fill-opacity:1;stroke:none"> | ||
| 395 | <path | ||
| 396 | id="path98" | ||
| 397 | style="fill:url(#linearGradient6087);fill-opacity:1" | ||
| 398 | d="m 550.24549,16.984496 q 8.54083,0 9.83001,16.920498 l 2.33664,0 q 15.22844,2.33664 15.0673,9.668855 1.28918,8.621397 -11.03861,7.976806 9.42713,8.299101 6.7682,15.470169 -2.09492,5.72074 -9.99116,3.786969 -8.70197,-4.350985 -12.32779,-9.991151 l -1.5309,0 q -3.3841,9.991151 -13.13353,9.991151 l -2.25606,0 q -8.13796,-2.497788 -5.88189,-9.830003 l 2.82008,-7.815659 -0.80574,0 q -11.92492,-1.692049 -10.79688,-10.555167 0.32229,-8.137954 16.35648,-8.218527 4.43155,-0.483443 3.70639,-2.820083 0,-14.583858 10.87746,-14.583858 z m -4.5927,16.034186 -0.16115,4.512133 q -0.24172,3.384099 -2.17549,3.384099 l -12.73066,0.725164 q -2.98123,0.08057 -2.98123,2.417214 0,2.256067 3.22295,2.417214 11.19976,-0.564016 10.47459,1.530902 l -2.25606,4.834428 q -5.72074,8.621396 -2.82009,10.152299 3.86754,2.33664 10.95804,-12.08607 1.69205,-1.530902 2.82008,0 4.99558,5.317871 8.21853,8.70197 3.30353,3.3841 5.31787,2.014345 2.41721,-2.578361 -1.28918,-5.559592 -3.62582,-3.061804 -8.2991,-8.379675 -0.48344,-1.772623 0.24172,-1.772623 15.79246,1.047459 15.14787,-2.014345 0.48345,-3.3841 -13.69754,-3.3841 -2.17549,0.402869 -3.54525,-1.047459 l 0,-7.896232 q 0,-6.607052 -3.14238,-6.526478 -3.3841,-0.805738 -3.30352,7.976806 z" /> | ||
| 399 | </g> | ||
| 400 | <path | ||
| 401 | d="m 335.7911,64.63031 c -9.6363,0.58398 -20.9336,2.59484 -26.0312,10.625 -0.4035,0.99026 -0.045,1.9107 0.6562,2.5 0.717,0.60234 1.4896,0.85243 2.5626,0 a 1.684398,1.684398 0 0 1 0.625,-0.3125 c 5.775,-1.5733 12.3167,-3.78461 18.9374,-4.625 6.6208,-0.84039 13.4444,-0.25925 19.4063,3.84375 a 1.684398,1.684398 0 0 1 0.375,0.375 c 2.0281,2.75755 2.9112,6.50666 2.5937,10.125 -0.3174,3.61834 -1.9072,7.25777 -5.2187,9.15625 a 1.684398,1.684398 0 0 1 -0.4687,0.1875 c -4.4561,1.00721 -8.7953,0.29068 -12.875,-0.1875 -4.0798,-0.47818 -7.8868,-0.73461 -11.5313,0.59375 a 1.684398,1.684398 0 0 1 -0.1563,0.0312 c -11.7884,2.8498 -19.5228,15.78804 -17.4062,27.59375 a 1.684398,1.684398 0 0 1 0,0.65625 c -1.0407,5.14641 2.2557,9.72666 7.3438,10.59375 a 1.684398,1.684398 0 0 1 0.2812,0.0625 c 11.7498,4.04484 24.8758,2.18109 37.0625,-0.3125 a 1.684398,1.684398 0 0 1 1.2813,0.28125 c 2.0816,1.42722 4.4575,3.29235 6.625,4.1875 1.0837,0.44757 2.0633,0.63094 2.9374,0.53125 0.8627,-0.0984 1.6764,-0.44585 2.5938,-1.375 0.01,-0.0118 0.022,-0.0195 0.031,-0.0312 2.6608,-3.43997 2.9705,-7.61463 2.625,-12.3125 -0.3431,-4.66636 -1.3766,-9.66321 -1,-14.46875 -0.9524,-14.4251 -1.1073,-29.45823 -6.7187,-42.15625 -6.4124,-5.22259 -15.7954,-5.06556 -24.4687,-5.5625 -0.021,-10e-4 -0.042,0.001 -0.063,0 z" | ||
| 402 | id="path6039" | ||
| 403 | style="fill:#484848;fill-opacity:1;stroke:#484848;stroke-width:3;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" /> | ||
| 404 | <path | ||
| 405 | d="m 345.6192,106.30395 c -3.4993,0.0307 -6.9607,-0.0581 -10.375,0.0312 -4.1004,0.36044 -9.0376,1.69024 -12.625,4.09375 -3.614,2.42133 -5.8704,5.68864 -5.2813,10.4375 0.4935,4.61527 3.5645,7.56447 7.6876,9.21875 4.123,1.65428 9.2633,1.8209 13.1562,0.65625 a 1.3611835,1.3611835 0 0 1 0.1562,-0.0312 c 2.8688,-0.49834 6.5939,-1.2529 9.2813,-2.71875 1.3437,-0.73292 2.3836,-1.63683 3.0313,-2.6875 0.6476,-1.05067 0.9604,-2.26047 0.6874,-3.96875 a 1.3611835,1.3611835 0 0 1 0,-0.28125 c 0.1564,-2.76724 0.3451,-6.68524 -0.375,-9.71875 -0.36,-1.51676 -0.9264,-2.77474 -1.75,-3.625 -0.8176,-0.8442 -1.8698,-1.36151 -3.5624,-1.40625 -0.012,-3.2e-4 -0.019,2.7e-4 -0.031,0 z" | ||
| 406 | id="path6041" | ||
| 407 | style="color:#000000;fill:url(#linearGradient6089);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22" /> | ||
| 408 | </g> | ||
| 409 | <g | ||
| 410 | id="g5958"> | ||
| 411 | <path | ||
| 412 | id="path4188" | ||
| 413 | d="m 549.36434,78.11349 c -9.4946,1.99352 -9.7027,14.03504 -9.8352,21.77668 0.1121,11.0831 -0.2095,22.9628 4.1417,33.27264 2.0054,4.85047 9.7812,4.74809 10.3195,-1.06753 4.7624,-15.20498 4.7481,-32.01281 1.4946,-47.50541 -0.983,-2.75668 -3.069,-6.35036 -6.1206,-6.47638 z" | ||
| 414 | style="color:#000000;fill:#484848;fill-opacity:1;fill-rule:nonzero;stroke:#484848;stroke-width:38;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" /> | ||
| 415 | <path | ||
| 416 | id="path4190" | ||
| 417 | d="m 499.48944,47.6175 c -6.4927,-0.34021 -9.3439,6.60543 -8.1121,12.16941 -0.5858,24.07597 -0.3292,48.31194 0.034,72.30837 1.7508,6.96484 14.895,8.48808 15.0166,-0.0712 1.2169,-13.27189 -0.274,-26.75029 0.6639,-40.10232 0.7817,-11.41478 -0.5568,-23.24296 -0.6994,-34.37618 1.5849,-5.10643 -0.4706,-11.12871 -6.9034,-9.92811 z" | ||
| 418 | style="color:#000000;fill:#484848;fill-opacity:1;fill-rule:nonzero;stroke:#484848;stroke-width:38;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" /> | ||
| 419 | <path | ||
| 420 | id="path4192" | ||
| 421 | d="m 132.42293,35.23407 c -7.6945,2.17125 -5.9206,12.79289 -6.2273,19.00216 1.6106,23.24538 0.8475,46.57408 2.1706,69.81693 0.068,7.09423 3.2021,16.90233 11.8853,16.22657 7.5709,-1.76417 5.7778,-11.8325 5.6557,-17.71589 -0.047,-7.84014 -4.5559,-19.23884 3.9165,-24.30949 7.6405,-5.37547 19.848,0.64078 18.6463,10.39069 -0.3251,8.83089 -2.0837,22.16882 7.8287,26.47493 6.4024,2.92649 10.6176,-5.21693 9.3943,-10.71096 -0.3749,-13.55442 1.2727,-30.22607 -10.711,-39.6768 -7.9735,-4.05845 -18.9828,-5.54515 -26.8307,-0.21351 -1.0372,2.42576 -6.9951,6.95054 -6.4053,1.24546 -1.6949,-15.3749 2.056,-31.45755 -2.3485,-46.40228 -1.2024,-2.63946 -4.0324,-4.45898 -6.9746,-4.12781 z" | ||
| 422 | style="color:#000000;fill:#484848;fill-opacity:1;fill-rule:nonzero;stroke:#484848;stroke-width:38;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" /> | ||
| 423 | <path | ||
| 424 | id="path4194" | ||
| 425 | d="m 442.14024,64.05759 c -10.165,-0.2579 -20.6562,1.86137 -28.1474,9.18081 -2.8958,2.05591 -1.2663,-4.94966 -4.8395,-5.01742 -5.4074,-2.93338 -11.5829,2.98762 -9.5367,8.75381 0.099,20.06919 -1.977,40.97889 3.8787,60.387 3.1796,4.95849 13.7562,4.09337 12.7037,-2.9891 1.546,-15.53942 -2.968,-32.10549 3.167,-46.86488 4.3319,-8.66318 18.41,-14.13659 25.3718,-5.90704 3.521,6.12624 -0.9752,16.78774 6.8323,20.31879 7.6504,1.3481 9.6041,-9.08157 8.825,-14.7676 -1.6539,-6.72434 -2.1565,-14.5353 -6.6544,-19.99852 -3.1376,-2.78799 -7.564,-3.22067 -11.6005,-3.09585 z" | ||
| 426 | style="color:#000000;fill:#484848;fill-opacity:1;fill-rule:nonzero;stroke:#484848;stroke-width:38;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" /> | ||
| 427 | <path | ||
| 428 | id="path4196" | ||
| 429 | d="m 442.38294,54.04595 c -0.1827,-0.005 -0.3789,0.0345 -0.5625,0.0312 -8.6942,-0.15632 -18.301,1.16995 -26.7813,5.96876 -0.368,-0.21564 -0.7676,-0.37654 -1.1562,-0.5625 l 0.031,-0.0625 c -0.2019,-0.10958 -0.4204,-0.1194 -0.625,-0.21875 -0.5569,-0.23563 -1.1103,-0.37966 -1.6874,-0.53125 -6.0741,-2.10894 -12.7994,-0.4336 -16.8438,3.34375 -3.8577,3.60298 -6.0063,9.29062 -5.1562,15.125 0.085,19.31578 -2.292,41.23535 4.3124,63.12499 l 0.4063,1.3125 0.75,1.1875 c 4.4521,6.94297 11.5862,8.53059 18,7.46875 3.2069,-0.53092 6.701,-1.89897 9.5,-5.03125 2.2725,-2.54317 3.5121,-6.27514 3.5937,-9.84375 0,-0.0435 0,-0.0816 0,-0.125 1.7478,-17.81793 -1.8544,-32.72457 2.2813,-43.375 0.6976,-1.23208 3.1856,-3.39065 5.4063,-4.03125 1.1119,-0.32077 1.7363,-0.44325 2.1874,-0.40625 0.051,0.8996 0.2789,2.71568 0.5313,6.0625 0.1821,2.41445 0.4732,5.42185 2.0313,8.8125 1.558,3.39065 4.8419,6.94014 8.8437,8.75 l 1.1563,0.5 1.2187,0.21875 c 4.1545,0.73208 8.9361,-0.28467 12.2187,-2.59375 3.2827,-2.30908 5.1358,-5.31163 6.3126,-8.0625 2.3534,-5.50175 2.5912,-10.54096 1.9374,-15.3125 l -0.062,-0.53125 -0.125,-0.5 c -1.3372,-5.43656 -1.418,-15.17693 -8.6563,-23.96874 l -0.4687,-0.59375 -0.5938,-0.53125 c -6.0316,-5.35952 -13.0425,-5.71213 -18,-5.59376 l 0,-0.0312 z m -20.9688,14.62501 c 0.3103,0.61975 0.1924,0.76755 0.063,0.28125 -0.016,-0.0599 -0.046,-0.21107 -0.063,-0.28125 z m -11.8437,14.15624 c 0.271,0.10418 0.5347,0.22752 0.8125,0.3125 l -0.125,0.21875 -0.125,0.3125 c -0.2313,0.55649 -0.3535,1.10135 -0.5625,1.65625 0.01,-0.84699 -0.01,-1.64903 0,-2.5 z" | ||
| 430 | style="color:#000000;fill:url(#linearGradient4453);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22" /> | ||
| 431 | <path | ||
| 432 | id="path4198" | ||
| 433 | d="m 334.93614,43.42895 -1.125,0.0625 c -11.4541,0.68757 -31.1299,2.13948 -42.5313,20.5 l -0.6875,1.15625 -0.5312,1.21875 c -4.0155,9.09454 -1.1737,19.34928 5,25.5 -7.1006,9.03999 -10.5361,20.69833 -9.25,32.65625 -0.7932,13.71238 8.5163,26.58972 21.5624,30.34375 l -0.031,0.0625 c 14.5936,5.02387 28.3345,3.89176 40,1.875 1.1383,0.61027 2.377,1.24208 3.8438,1.84375 3.1932,1.30991 7.6804,2.60895 13.1874,1.96875 5.5071,-0.6402 11.3463,-3.71585 15.0626,-7.53125 l 0.6562,-0.6875 0.5938,-0.75 c 7.375,-9.27994 7.6766,-20.19393 7.1874,-26.8125 -0.4891,-6.61857 -1.0653,-10.99648 -1.0312,-11.375 l 0.125,-1.46875 -0.094,-1.5 c -0.9045,-13.69999 -0.4438,-31.50909 -8.6874,-49.71875 -0.8869,-3.14352 -2.6183,-4.60975 -5,-6.625 -14.193,-12.04738 -29.8012,-10.22761 -37.125,-10.65625 z m -5,69.25 c -0.6975,0.25422 -0.096,-0.059 3.5937,0.375 3.1757,0.3735 8.4922,1.29071 15.3437,0.34375 -0.042,1.60674 -0.047,3.10046 0.031,4.46875 l -1.2187,0.25 c -9.4296,1.92946 -17.7526,2.70557 -24.0626,1.71875 0.3089,-2.61777 2.5558,-6.11412 4.2813,-6.53125 l 1.0313,-0.25 1,-0.375 z" | ||
| 434 | style="color:#000000;fill:#484848;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:38" /> | ||
| 435 | <path | ||
| 436 | style="color:#000000;fill:#484848;fill-opacity:1;fill-rule:nonzero;stroke:#484848;stroke-width:38;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" | ||
| 437 | d="m 242.86794,62.94328 c -9.8451,0.59098 -21.9234,2.57343 -27.5069,11.56498 -1.5225,3.44827 2.5155,7.16458 5.8003,4.55483 11.6876,-3.18405 25.8772,-8.64334 36.9368,-1.03196 3.4255,4.6575 3.2712,13.73214 -2.1351,16.8315 -8.1137,1.83399 -16.456,-2.50178 -24.589,0.4626 -12.7407,3.08001 -20.924,16.83116 -18.6463,29.53519 -1.221,6.03853 2.7535,11.58045 8.7182,12.59694 12.2603,4.22059 25.7141,2.25842 37.9688,-0.24909 3.9671,2.72001 9.7011,7.85911 14.3406,3.09585 6.2596,-7.87653 1.273,-19.02318 2.088,-28.06851 -0.9577,-14.50429 -1.0481,-29.91302 -7.0343,-43.1362 -7.0905,-6.01862 -17.2216,-5.6458 -25.9411,-6.15613 z" | ||
| 438 | id="path4200" /> | ||
| 439 | <path | ||
| 440 | id="path4202" | ||
| 441 | d="m 132.71733,24.19589 c -0.5004,0.0152 -1.0205,0.0363 -1.5312,0.0937 l -0.9063,0.0937 -0.8437,0.25 c -4.2861,1.20943 -8.1936,4.24904 -10.375,7.56249 -2.1816,3.31346 -2.9841,6.56659 -3.4063,9.375 -0.8444,5.61682 -0.3823,10.37282 -0.4687,12.125 l -0.031,0.65625 0.062,0.625 c 1.548,22.34205 0.8033,45.46456 2.125,69.1875 5e-4,0.0505 0.031,0.10568 0.031,0.15625 0.01,0.1151 -0.01,0.22862 0,0.34375 l 0.031,0 c 0.099,4.98929 0.9665,10.43113 4.125,15.90625 3.2605,5.65198 11.0145,11.32149 19.5625,10.65625 l 0.8438,-0.0625 0.8124,-0.1875 c 4.2384,-0.98762 8.3269,-3.79564 10.625,-7.09375 2.1728,-3.63384 4.3342,-6.89183 5.1872,-10.22818 3.8402,7.13335 5.9507,8.04619 13.1566,11.44693 l 0,0.0312 c 0.059,0.0269 0.1281,0.0362 0.1875,0.0625 3.7423,1.65403 8.4312,1.97661 12.2813,0.65625 3.91101,-1.34132 6.71761,-3.90092 8.59371,-6.5 3.336,-4.62154 4.6441,-9.64143 3.9063,-15.25 -0.1718,-6.20746 0.2238,-14.23226 -1.1563,-22.8125 -1.3801,-8.58024 -5.0962,-18.36284 -13.75001,-25.1875 l -0.8437,-0.6875 -0.9688,-0.5 c -7.7653,-3.95251 -17.7087,-6.355 -27.4062,-4.09375 0.4086,-10.28331 1.089,-21.96033 -2.625,-34.5625 l -0.2188,-0.75 -0.3125,-0.71875 c -2.9167,-6.40275 -9.181,-10.82231 -16.6875,-10.59374 z m 6.0625,53.99999 c 0,0.0101 0.05,0.0315 0.062,0.0625 l -0.6245,1.46875 c 0.3311,-0.86163 0.5542,-1.56647 0.5625,-1.53125 z m 36.0625,48.28125 c 0.012,-0.004 0.019,0.005 0.031,0 l 0.063,0.3125 c -0.043,-0.19086 -0.061,-0.25465 -0.094,-0.3125 z" | ||
| 442 | style="color:#000000;fill:url(#linearGradient4451);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22" /> | ||
| 443 | <path | ||
| 444 | d="m 133.3461,36.09636 c -1.692,0.49428 -2.8155,1.39846 -3.625,2.625 -0.8214,1.24442 -1.3243,2.85069 -1.5938,4.625 -0.5342,3.51732 -0.1953,7.61208 -0.3438,10.8125 0,0.0285 0,0.0654 0,0.0937 1.6063,23.27388 0.8692,46.5905 2.1876,69.75 a 0.88388823,0.88388823 0 0 1 0,0.0625 c 0.033,3.4213 0.83,7.53419 2.5937,10.59375 1.7438,3.02495 4.2922,5.00636 8.2187,4.75 0.011,-7.3e-4 0.02,7.7e-4 0.031,0 1.6857,-0.39978 2.7542,-1.19719 3.5313,-2.3125 0.7819,-1.12237 1.2391,-2.59827 1.4687,-4.25 0.4593,-3.30346 2e-4,-7.22907 -0.062,-10.25 a 0.88388823,0.88388823 0 0 1 0,-0.0312 c -0.023,-3.75401 -1.179,-8.58343 -1.25,-13.1875 -0.071,-4.59014 1.0512,-9.12033 5.5625,-11.84375 0.012,-0.008 0.019,-0.023 0.031,-0.0312 8.2411,-5.75335 21.2001,0.72746 19.9687,11.1875 0,0.011 0,0.0202 0,0.0312 -4e-4,0.01 4e-4,0.0216 0,0.0312 -0.1662,4.44678 -0.6416,9.92071 0.094,14.71875 0.7386,4.81878 2.5857,8.83105 7.2188,10.84375 a 0.88388823,0.88388823 0 0 1 0.031,0 c 1.4264,0.65196 2.625,0.67804 3.6876,0.3125 1.0625,-0.36554 2.0152,-1.15367 2.7812,-2.21875 1.532,-2.13016 2.2012,-5.36524 1.6562,-7.8125 a 0.88388823,0.88388823 0 0 1 0,-0.15625 c -0.1887,-6.82351 0.1073,-14.35845 -1,-21.28125 -1.1026,-6.89383 -3.5864,-13.13587 -9.3124,-17.6875 -7.7294,-3.90433 -18.3437,-5.25802 -25.7813,-0.25 -0.7734,1.48479 -2.3237,3.00623 -4,3.78125 -0.9043,0.41808 -1.982,0.65336 -2.875,0.0312 -0.8519,-0.59346 -1.0866,-1.72753 -0.9687,-3.1875 0.01,-0.0705 -0.01,-0.11538 0,-0.1875 -1.6634,-15.48034 1.9617,-31.38045 -2.2813,-45.9375 -1.0363,-2.2749 -3.4784,-3.85945 -5.9687,-3.625 z" | ||
| 445 | id="path4440" | ||
| 446 | style="fill:#484848;fill-opacity:1;stroke:none" /> | ||
| 447 | <path | ||
| 448 | id="path4206" | ||
| 449 | d="m 500.00794,37.6397 c -0.47,-0.0246 -0.9099,0.13839 -1.375,0.15625 -0.3182,0.036 -0.6564,-0.0583 -0.9688,0 l 0,0.0937 c -5.9486,0.59666 -11.3199,4.27914 -13.8124,8.625 -2.5191,4.39212 -3.1643,9.07388 -2.4688,13.75001 -0.5691,24.07161 -0.3288,48.17845 0.031,71.96874 l 0.031,1.1875 0.2813,1.125 c 2.2758,9.05358 10.1204,12.94327 17.2812,13.3125 3.5804,0.18461 7.6057,-0.50128 11.25,-3.21875 3.4431,-2.56742 5.753,-7.21537 6.0625,-11.6875 l 0.062,0 c 0.024,-0.26477 0.01,-0.51719 0.031,-0.78125 1.2169,-14.32127 -0.1813,-27.63851 0.6563,-39.5625 0.8412,-12.28307 -0.4559,-23.97948 -0.6563,-34.18749 0.9168,-4.19732 0.7514,-8.64033 -1.75,-13.09376 -2.5398,-4.52202 -8.6787,-7.57722 -14.4374,-7.5625 -0.073,1.9e-4 -0.1457,-0.001 -0.2188,0 l 0,-0.125 z m -0.4375,10.46875 1.5625,8.375 c -0.089,0.0884 -0.5399,0.26586 -0.9688,0.50001 -0.4433,-0.17558 -0.588,-0.31717 -1.125,-0.59376 l 0.5313,-8.28125 z m 1.625,8.6875 0.125,0.65626 c 0,-5.2e-4 -0.146,-0.0578 -0.1563,-0.0625 0.013,-0.26164 0.01,-0.41632 0.031,-0.59376 z" | ||
| 450 | style="color:#000000;fill:url(#linearGradient4449);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22" /> | ||
| 451 | <path | ||
| 452 | id="path4208" | ||
| 453 | d="m 499.48944,47.6175 c -6.4927,-0.34021 -9.3439,6.60543 -8.1121,12.16941 -0.5858,24.07597 -0.3292,48.31194 0.034,72.30837 1.7508,6.96484 14.895,8.48808 15.0166,-0.0712 1.2169,-13.27189 -0.274,-26.75029 0.6639,-40.10232 0.7817,-11.41478 -0.5568,-23.24296 -0.6994,-34.37618 1.5849,-5.10643 -0.4706,-11.12871 -6.9034,-9.92811 z" | ||
| 454 | style="fill:#484848;fill-opacity:1;stroke:none" /> | ||
| 455 | <path | ||
| 456 | id="path4210" | ||
| 457 | d="m 544.51954,53.6313 c -7.5784,-0.46784 -10.6755,10.08558 -4.626,14.19825 6.4831,5.13984 16.9776,-2.57743 12.9884,-10.24836 -1.4384,-3.20261 -5.1136,-4.25984 -8.3624,-3.94989 z" | ||
| 458 | style="fill:#000000;fill-opacity:1;stroke:none" /> | ||
| 459 | <path | ||
| 460 | id="path4212" | ||
| 461 | d="m 66.312222,57.93009 c -17.370703,0.62829 -30.0641,20.09681 -26.023403,36.39781 2.1928,10.05075 13.8541,12.09708 22.635103,11.4922 7.1377,-0.5151 17.6041,2.45346 16.7319,11.49222 -1.8676,6.29718 -10.9897,4.97438 -16.0667,5.21679 -7.019003,0.3042 -14.551803,-2.83467 -21.309203,-1.0251 -5.546297,3.71601 -0.7698,11.63178 4.4362,13.09902 11.6204,3.85396 24.776703,2.98561 36.677203,0.52396 8.494404,-1.78465 13.976704,-9.66183 14.007304,-18.12905 0.5362,-8.45978 -0.1252,-18.85777 -9.082,-22.63511 -7.833304,-4.5437 -17.524404,-2.59996 -25.744004,-4.64578 -6.504303,-3.75215 -4.590203,-15.08325 3.2137,-15.54417 8.376,-2.645 16.5844,3.54335 24.730904,1.74653 6.8027,-2.75685 5.6777,-13.26551 -1.2924,-15.19486 C 82.177322,57.19274 73.972122,57.9802 66.312222,57.93009 Z" | ||
| 462 | style="fill:#484848;fill-opacity:1;stroke:#484848;stroke-width:38;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" /> | ||
| 463 | <path | ||
| 464 | id="path4214" | ||
| 465 | d="m 66.146122,46.92095 -0.2187,0.0312 c -25.268203,0.91394 -41.9786,26.29641 -36.375,49.71875 0,0.01 0,0.0214 0,0.0312 0.023,0.0937 0.039,0.18758 0.062,0.28125 l 0.062,0 c 1.4158,6.03031 5.2241,10.72981 9.5937,13.9375 l -1.5937,0.4375 -1.5313,1 c -3.4934,2.34058 -6.2461,6.40677 -7.0312,10.4375 -0.7852,4.03073 0.016,7.64447 1.2812,10.53125 2.4625,5.61698 6.4364,9.72109 12.843797,11.6875 l 0,0.0312 c 0.1235,0.0409 0.2514,0.0537 0.375,0.0937 0.044,0.0142 0.081,0.0484 0.125,0.0625 14.2876,4.59699 29.052403,3.33987 41.875007,0.6875 l 0.031,0 c 13.703,-2.87897 22.354804,-15.23519 22.687504,-28.1875 l 0.031,0 c 0.01,-0.1043 -0.01,-0.23849 0,-0.34375 0,-0.10511 0.031,-0.20733 0.031,-0.3125 l -0.031,0 c 0.275,-4.68022 0.3633,-10.21921 -1.4063,-16.21875 -1.6128,-5.46789 -5.6186,-11.40935 -11.718704,-15.03125 C 110.28983,79.05558 108.57813,56.15757 93.550926,50.6395 83.076822,45.62854 73.121622,46.96476 66.394622,46.92075 l -0.25,0 z M 49.927419,124.0772 c 0.4736,0.11312 0.7429,0.17483 0.6875,0.1875 -0.1379,-0.0437 -0.3009,-0.0484 -0.4375,-0.0937 l -0.25,-0.0937 z" | ||
| 466 | style="color:#000000;fill:url(#linearGradient4447);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22" /> | ||
| 467 | <path | ||
| 468 | d="M 67.047,59.37761 C 50.7565,60.01346 38.6203,78.63489 42.422,93.97136 a 1.4420115,1.4420115 0 0 1 0,0.0312 c 0.9874,4.52574 3.9833,7.14275 7.9688,8.71875 3.9854,1.576 8.921,1.948 13.1562,1.65625 3.8182,-0.27555 8.4163,0.35581 12.1562,2.34375 3.74,1.98794 6.6157,5.6345 6.125,10.71875 a 1.4420115,1.4420115 0 0 1 -0.062,0.28125 c -0.5618,1.89409 -1.746,3.32797 -3.1876,4.25 -1.4415,0.92203 -3.0867,1.39395 -4.7812,1.65625 -3.3889,0.5246 -7.0334,0.23046 -9.4062,0.34375 -7.4077,0.32104 -14.726,-2.60314 -20.7813,-1.09375 -0.9228,0.69289 -1.3969,1.4625 -1.5625,2.3125 -0.1806,0.92739 -0.017,2.01851 0.4688,3.125 0.9708,2.21298 3.281,4.32492 5.3437,4.90625 a 1.4420115,1.4420115 0 0 1 0.062,0 c 11.2515,3.73156 24.1465,2.93253 35.9062,0.5 7.7821,-1.63499 12.8466,-8.87337 12.875,-16.71875 a 1.4420115,1.4420115 0 0 1 0,-0.0937 c 0.2634,-4.15469 0.2008,-8.71518 -0.9374,-12.5625 -1.1383,-3.84732 -3.227,-6.9152 -7.2813,-8.625 a 1.4420115,1.4420115 0 0 1 -0.1563,-0.0937 c -7.233,-4.1955 -16.6908,-2.33856 -25.375,-4.5 a 1.4420115,1.4420115 0 0 1 -0.375,-0.15625 c -7.593,-4.38022 -5.364,-17.27483 3.5,-18.15625 l 0,-0.0312 c 0.1153,-0.0364 0.2288,-0.0291 0.3438,-0.0625 4.5012,-1.3064 8.8395,-0.37995 12.875,0.59375 4.0804,0.98454 7.88,1.92841 11.4688,1.1875 5.4755,-2.31046 4.4951,-10.8333 -1.1876,-12.40625 a 1.4420115,1.4420115 0 0 1 -0.2812,-0.0937 c -6.5535,-3.28332 -14.4405,-2.57842 -22.1875,-2.625 -0.021,-1.3e-4 -0.042,1.4e-4 -0.062,0 z" | ||
| 469 | id="path4442" | ||
| 470 | style="fill:#484848;fill-opacity:1;stroke:none" /> | ||
| 471 | <path | ||
| 472 | id="path4218" | ||
| 473 | d="m 334.91414,52.45217 -0.5624,0.0312 c -10.692,0.64182 -26.7608,2.35866 -35.4063,16.28126 l -0.375,0.59375 -0.2813,0.625 c -2.6168,5.92672 -0.4865,12.63582 3.8126,16.24999 2.47,2.0766 6.1544,2.97511 9.8124,2.75 -12.1731,7.16212 -18.9579,21.29295 -17.0937,35.5 -0.9321,10.0329 5.7963,19.42583 15.4375,21.90625 l 0,0.0312 c 13.5839,4.67628 27.0449,3.11875 38.7812,0.90625 1.4491,0.98507 3.2876,2.06677 5.5626,3 2.2748,0.93323 5.2583,1.74964 8.75,1.34375 3.4915,-0.40589 7.1195,-2.30283 9.625,-4.875 l 0.375,-0.34375 0.3124,-0.40625 c 5.3642,-6.74967 5.6479,-14.75709 5.2188,-20.5625 -0.4291,-5.80541 -1.211,-10.50221 -1,-12.84375 l 0.062,-0.78125 -0.062,-0.75 c -0.9297,-14.08097 -0.732,-30.77734 -7.9062,-46.62499 -0.4593,-1.65783 -1.3753,-2.43205 -2.625,-3.4999 -10.8288,-9.19166 -23.8588,-8.03267 -31.8438,-8.50001 l -0.5938,-0.0312 z m 22.0626,47.46875 c 0.2983,4.01025 0.663,7.89337 0.9374,12.09375 -0.3619,6.15055 0.7536,11.18085 1.0313,14.9375 0.091,1.23358 -3e-4,1.89681 -0.031,2.71875 -0.7261,-0.49389 -0.8804,-0.56988 -1.7812,-1.1875 l -3.5,-2.40625 -4.1562,0.84375 c -11.8502,2.42474 -23.4896,3.77093 -32.7188,0.59375 l -0.75,-0.25 -0.8125,-0.15625 c -0.7563,-0.12889 -0.7437,-0.008 -0.5937,-0.75 l 0.375,-1.875 -0.3438,-1.875 c -1.3223,-7.37497 4.0726,-16.31882 11.1562,-18.03125 l 0.5626,-0.15625 0.5312,-0.1875 c 1.5591,-0.56829 3.7957,-0.58273 7.6875,-0.125 3.8918,0.45773 9.2275,1.48444 15.6563,0.0312 l 1.4687,-0.34375 1.3125,-0.75 c 1.5458,-0.8862 2.8481,-1.95265 3.9688,-3.125 z" | ||
| 474 | style="color:#000000;fill:url(#linearGradient4445);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22" /> | ||
| 475 | <path | ||
| 476 | d="m 442.8461,65.50261 c -9.9417,-0.25223 -20.0112,1.83054 -27.125,8.78125 a 1.4249747,1.4249747 0 0 1 -0.1876,0.125 c -0.4923,0.34955 -1.0141,0.64308 -1.6874,0.65625 -0.6734,0.0132 -1.3402,-0.39879 -1.6876,-0.8125 -0.6947,-0.82743 -0.7686,-1.5945 -0.9687,-2.34375 -0.2001,-0.74925 -0.4246,-1.47139 -0.6563,-1.84375 -0.2316,-0.37236 -0.2624,-0.39819 -0.6874,-0.40625 a 1.4249747,1.4249747 0 0 1 -0.6563,-0.1875 c -2.1511,-1.16691 -4.3134,-0.58174 -5.9063,0.90625 -1.5928,1.48799 -2.4145,3.81205 -1.5937,6.125 a 1.4249747,1.4249747 0 0 1 0.094,0.46875 c 0.099,20.08519 -1.9054,40.73856 3.75,59.71875 1.2377,1.74956 4.0539,2.66609 6.4063,2.28125 1.2075,-0.19755 2.2216,-0.71247 2.8437,-1.40625 0.6222,-0.69378 0.9615,-1.54589 0.75,-2.96875 a 1.4249747,1.4249747 0 0 1 0,-0.375 c 1.5091,-15.16756 -3.1254,-31.94343 3.25,-47.28125 a 1.4249747,1.4249747 0 0 1 0.031,-0.0625 c 2.3884,-4.77662 7.2847,-8.50018 12.5937,-10.03125 5.3091,-1.53107 11.2689,-0.75156 15.1563,3.84375 a 1.4249747,1.4249747 0 0 1 0.1563,0.1875 c 2.0694,3.60071 1.6918,8.0153 1.9687,11.75 0.1385,1.86735 0.4194,3.54061 1.0313,4.875 0.5916,1.2904 1.4751,2.25734 3.0312,3 1.4606,0.20734 2.5297,-0.051 3.4375,-0.6875 0.9587,-0.67214 1.771,-1.81376 2.375,-3.21875 1.2079,-2.80999 1.508,-6.6831 1.1563,-9.25 -1.6601,-6.82503 -2.269,-14.23556 -6.2813,-19.1875 -2.6943,-2.32961 -6.6692,-2.77567 -10.5313,-2.65625 a 1.4249747,1.4249747 0 0 1 -0.062,0 z" | ||
| 477 | id="path4436" | ||
| 478 | style="fill:#484848;fill-opacity:1;stroke:none" /> | ||
| 479 | <path | ||
| 480 | id="path4224" | ||
| 481 | d="m 548.52594,68.07721 -1.2187,0.25 c -8.6956,1.82574 -14.1425,9.53796 -15.9688,15.68749 -1.8263,6.14954 -1.7462,11.84707 -1.8125,15.71875 l 0,0.125 0,0.125 c 0.1092,10.79916 -0.5536,24.0134 4.9063,37 0.01,0.0225 0.022,0.0401 0.031,0.0625 2.7726,6.62078 9.3817,9.9621 15.5625,9.5625 5.6001,-0.36206 11.8353,-5.2195 13.5,-11.53125 5.3924,-17.21633 5.3013,-35.62075 1.75,-52.53125 l -0.1563,-0.6875 -0.2187,-0.62499 c -0.7814,-2.19128 -1.853,-4.62969 -3.9375,-7.1875 -2.0845,-2.55781 -5.8401,-5.71667 -11.1875,-5.9375 l -1.25,-0.0312 z" | ||
| 482 | style="color:#000000;fill:url(#linearGradient4443);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22" /> | ||
| 483 | <path | ||
| 484 | d="m 550.1139,78.59636 c -4.5226,0.97522 -6.7823,4.26272 -8,8.375 -1.2232,4.13111 -1.3087,9.03503 -1.375,12.90625 0.1123,11.09592 -0.2043,22.90976 4.0938,33.09375 0.9213,2.22841 3.1731,3.32073 5.25,3.1875 2.0769,-0.13323 3.906,-1.39 4.1562,-4.09375 a 0.46475483,0.46475483 0 0 1 0.031,-0.0937 c 4.7332,-15.11164 4.7084,-31.85462 1.4687,-47.28125 -0.4788,-1.32581 -1.2248,-2.85305 -2.1874,-4.03125 -0.9629,-1.17844 -2.1146,-1.98485 -3.4376,-2.0625 z" | ||
| 485 | id="path4438" | ||
| 486 | style="fill:#484848;fill-opacity:1;stroke:none" /> | ||
| 487 | <path | ||
| 488 | id="path4229" | ||
| 489 | d="m 242.87094,52.92092 -0.5938,0.0312 c -10.6919,0.64192 -26.7607,2.35873 -35.4062,16.28131 l -0.375,0.59375 -0.2813,0.65625 c -2.6168,5.92671 -0.4864,12.60456 3.8125,16.21874 2.4771,2.0825 6.1757,2.98309 9.8438,2.75 -12.176,7.14722 -18.9659,21.26849 -17.125,35.46875 -0.9665,10.0609 5.7999,19.48906 15.4687,21.96875 l -0.031,0.0312 c 13.5891,4.67806 27.073,3.12012 38.8125,0.90625 1.4445,0.97996 3.2715,2.07302 5.5313,3 2.2749,0.93323 5.2585,1.71839 8.75,1.3125 3.4915,-0.40589 7.1509,-2.27156 9.6562,-4.84375 l 0.3438,-0.375 0.3125,-0.40625 c 5.3641,-6.74969 5.6478,-14.72585 5.2187,-20.53125 -0.4291,-5.8054 -1.2109,-10.50221 -1,-12.84375 l 0.062,-0.78125 -0.062,-0.78125 c -0.9297,-14.081 -0.7006,-30.74608 -7.875,-46.59374 l -0.9375,-2.0625 -1.7187,-1.4375 c -10.8287,-9.19167 -23.8276,-8.06392 -31.8125,-8.53126 l -0.5938,-0.0312 z m 22.0312,47.5 c 0.2974,4.00059 0.6637,7.87292 0.9375,12.0625 -0.3619,6.15055 0.7536,11.2121 1.0313,14.96875 0.091,1.22812 0,1.86766 -0.031,2.6875 -0.7261,-0.49388 -0.8805,-0.56989 -1.7813,-1.1875 l -3.5,-2.40625 -4.1562,0.875 c -11.8502,2.42475 -23.4582,3.77094 -32.6875,0.59375 l -0.7813,-0.28125 -0.8125,-0.125 c -0.7563,-0.12888 -0.7437,-0.0396 -0.5938,-0.78125 l 0.375,-1.84375 -0.3437,-1.875 c -1.3223,-7.37494 4.0726,-16.35008 11.1562,-18.0625 l 0.5625,-0.125 0.5313,-0.1875 c 1.5591,-0.56828 3.7957,-0.58273 7.6875,-0.125 3.8918,0.45773 9.2275,1.45313 15.6562,0 l 1.4688,-0.3125 1.3125,-0.75 c 1.5458,-0.8862 2.8482,-1.95265 3.9687,-3.125 z" | ||
| 490 | style="color:#000000;fill:url(#linearGradient4441);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22" /> | ||
| 491 | <path | ||
| 492 | d="m 243.6361,64.63031 c -9.6363,0.58398 -20.9336,2.59484 -26.0312,10.625 -0.4035,0.99026 -0.045,1.9107 0.6562,2.5 0.717,0.60234 1.4896,0.85243 2.5626,0 a 1.684398,1.684398 0 0 1 0.625,-0.3125 c 5.775,-1.5733 12.3167,-3.78461 18.9374,-4.625 6.6208,-0.84039 13.4444,-0.25925 19.4063,3.84375 a 1.684398,1.684398 0 0 1 0.375,0.375 c 2.0281,2.75755 2.9112,6.50666 2.5937,10.125 -0.3174,3.61834 -1.9072,7.25777 -5.2187,9.15625 a 1.684398,1.684398 0 0 1 -0.4687,0.1875 c -4.4561,1.00721 -8.7953,0.29068 -12.875,-0.1875 -4.0798,-0.47818 -7.8868,-0.73461 -11.5313,0.59375 a 1.684398,1.684398 0 0 1 -0.1563,0.0312 c -11.7884,2.8498 -19.5228,15.78804 -17.4062,27.59375 a 1.684398,1.684398 0 0 1 0,0.65625 c -1.0407,5.14641 2.2557,9.72666 7.3438,10.59375 a 1.684398,1.684398 0 0 1 0.2812,0.0625 c 11.7498,4.04484 24.8758,2.18109 37.0625,-0.3125 a 1.684398,1.684398 0 0 1 1.2813,0.28125 c 2.0816,1.42722 4.4575,3.29235 6.625,4.1875 1.0837,0.44757 2.0633,0.63094 2.9374,0.53125 0.8627,-0.0984 1.6764,-0.44585 2.5938,-1.375 0.01,-0.0118 0.022,-0.0195 0.031,-0.0312 2.6608,-3.43997 2.9705,-7.61463 2.625,-12.3125 -0.3431,-4.66636 -1.3766,-9.66321 -1,-14.46875 -0.9524,-14.4251 -1.1073,-29.45823 -6.7187,-42.15625 -6.4124,-5.22259 -15.7954,-5.06556 -24.4687,-5.5625 -0.021,-10e-4 -0.042,0.001 -0.063,0 z" | ||
| 493 | id="path4426" | ||
| 494 | style="fill:#484848;fill-opacity:1;stroke:#484848;stroke-width:3;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" /> | ||
| 495 | <path | ||
| 496 | d="m 252.9376,106.30395 c -3.4993,0.0307 -6.9607,-0.0581 -10.375,0.0312 -4.1004,0.36044 -9.0376,1.69024 -12.625,4.09375 -3.614,2.42133 -5.8704,5.68864 -5.2813,10.4375 0.4935,4.61527 3.5645,7.56447 7.6876,9.21875 4.123,1.65428 9.2633,1.8209 13.1562,0.65625 a 1.3611835,1.3611835 0 0 1 0.1562,-0.0312 c 2.8688,-0.49834 6.5939,-1.2529 9.2813,-2.71875 1.3437,-0.73292 2.3836,-1.63683 3.0313,-2.6875 0.6476,-1.05067 0.9604,-2.26047 0.6874,-3.96875 a 1.3611835,1.3611835 0 0 1 0,-0.28125 c 0.1564,-2.76724 0.3451,-6.68524 -0.375,-9.71875 -0.36,-1.51676 -0.9264,-2.77474 -1.75,-3.625 -0.8176,-0.8442 -1.8698,-1.36151 -3.5624,-1.40625 -0.012,-3.2e-4 -0.019,2.7e-4 -0.031,0 z" | ||
| 497 | id="path5306" | ||
| 498 | style="color:#000000;fill:url(#linearGradient4439);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22" /> | ||
| 499 | <path | ||
| 500 | id="text4338" | ||
| 501 | d="m 550.24144,11.97714 c -4.7431,8e-5 -9.3884,1.94508 -12.1562,5.65625 -2.3938,3.20927 -3.2655,7.28209 -3.5,11.84374 -5.2417,0.10768 -9.658,0.71067 -13.2813,2.53125 -3.7519,1.88519 -6.5576,5.75636 -6.9063,9.9375 l -0.062,0 c -0.013,0.1027 0.011,0.20947 0,0.3125 0,0.043 -0.03,0.0819 -0.031,0.125 l 0.031,0 c -0.383,3.94189 0.8037,8.08581 3.625,10.84375 1.7434,1.70445 3.9242,2.79035 6.3124,3.59375 l -0.875,2.4375 -0.062,0.125 -0.031,0.125 c -1.0239,3.32791 -0.9882,7.09444 0.8437,10.15625 1.8322,3.06181 4.9132,4.85334 8.3438,5.90625 l 0.7188,0.21875 0.75,0 2.2812,0 c 4.1038,5e-5 8.0184,-1.11288 11.1562,-3.5 1.388,-1.05587 2.5677,-2.38102 3.5938,-3.8125 2.738,2.5559 6.0541,4.80834 10,6.78125 l 0.5,0.25 0.5312,0.15625 c 3.235,0.79227 6.3972,0.95306 9.4063,-0.1875 2.9956,-1.13542 5.3523,-3.78973 6.4375,-6.71875 l 0.031,0 0,-0.0312 c 1.3188,-3.58119 1.0754,-7.65809 -0.4687,-11.1875 -0.3593,-0.82136 -0.9637,-1.56048 -1.4375,-2.34375 0.7988,-0.35352 1.5774,-0.75006 2.3125,-1.28125 3.1456,-2.2731 4.4669,-6.43958 4.1563,-10.25 l 0.031,0 c 0,-0.12851 -0.061,-0.24691 -0.062,-0.375 -0.017,-0.15367 0.023,-0.31671 0,-0.46875 l -0.062,0 c -0.2506,-3.85862 -2.6242,-7.47641 -5.875,-9.5625 -3.1968,-2.05143 -7.2278,-3.19745 -12.0625,-4.03124 -0.5947,-4.02941 -1.4462,-7.64148 -3.125,-10.53125 -2.2702,-3.9078 -6.5646,-6.71865 -11.0625,-6.71875 z m 18.3125,50.62499 c 0.2654,0.97712 0.2969,1.7705 -0.031,2.65625 l 0,0.0312 c -0.3181,0.86918 -0.3036,0.72198 -0.625,0.84375 -0.2585,0.098 -1.2073,0.14918 -2.5624,-0.0625 0.3313,-0.1475 0.7366,-0.14338 1.0312,-0.34375 l 0.4375,-0.28125 0.375,-0.40625 c 0.5814,-0.62017 0.9776,-1.55372 1.375,-2.4375 z" | ||
| 502 | style="color:#000000;fill:#305f00;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:10" /> | ||
| 503 | <g | ||
| 504 | id="text4342" | ||
| 505 | style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:165.01513672px;line-height:125%;font-family:'comic andy';-inkscape-font-specification:'comic andy';letter-spacing:0px;word-spacing:0px;fill:url(#linearGradient4437);fill-opacity:1;stroke:none"> | ||
| 506 | <path | ||
| 507 | id="path101" | ||
| 508 | style="fill:url(#linearGradient4437);fill-opacity:1" | ||
| 509 | d="m 550.24549,16.984496 q 8.54083,0 9.83001,16.920498 l 2.33664,0 q 15.22844,2.33664 15.0673,9.668855 1.28918,8.621397 -11.03861,7.976806 9.42713,8.299101 6.7682,15.470169 -2.09492,5.72074 -9.99116,3.786969 -8.70197,-4.350985 -12.32779,-9.991151 l -1.5309,0 q -3.3841,9.991151 -13.13353,9.991151 l -2.25606,0 q -8.13796,-2.497788 -5.88189,-9.830003 l 2.82008,-7.815659 -0.80574,0 q -11.92492,-1.692049 -10.79688,-10.555167 0.32229,-8.137954 16.35648,-8.218527 4.43155,-0.483443 3.70639,-2.820083 0,-14.583858 10.87746,-14.583858 z m -4.5927,16.034186 -0.16115,4.512133 q -0.24172,3.384099 -2.17549,3.384099 l -12.73066,0.725164 q -2.98123,0.08057 -2.98123,2.417214 0,2.256067 3.22295,2.417214 11.19976,-0.564016 10.47459,1.530902 l -2.25606,4.834428 q -5.72074,8.621396 -2.82009,10.152299 3.86754,2.33664 10.95804,-12.08607 1.69205,-1.530902 2.82008,0 4.99558,5.317871 8.21853,8.70197 3.30353,3.3841 5.31787,2.014345 2.41721,-2.578361 -1.28918,-5.559592 -3.62582,-3.061804 -8.2991,-8.379675 -0.48344,-1.772623 0.24172,-1.772623 15.79246,1.047459 15.14787,-2.014345 0.48345,-3.3841 -13.69754,-3.3841 -2.17549,0.402869 -3.54525,-1.047459 l 0,-7.896232 q 0,-6.607052 -3.14238,-6.526478 -3.3841,-0.805738 -3.30352,7.976806 z" /> | ||
| 510 | </g> | ||
| 511 | <path | ||
| 512 | style="fill:#484848;fill-opacity:1;stroke:#484848;stroke-width:3;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" | ||
| 513 | id="path4714" | ||
| 514 | d="m 335.7911,64.63031 c -9.6363,0.58398 -20.9336,2.59484 -26.0312,10.625 -0.4035,0.99026 -0.045,1.9107 0.6562,2.5 0.717,0.60234 1.4896,0.85243 2.5626,0 a 1.684398,1.684398 0 0 1 0.625,-0.3125 c 5.775,-1.5733 12.3167,-3.78461 18.9374,-4.625 6.6208,-0.84039 13.4444,-0.25925 19.4063,3.84375 a 1.684398,1.684398 0 0 1 0.375,0.375 c 2.0281,2.75755 2.9112,6.50666 2.5937,10.125 -0.3174,3.61834 -1.9072,7.25777 -5.2187,9.15625 a 1.684398,1.684398 0 0 1 -0.4687,0.1875 c -4.4561,1.00721 -8.7953,0.29068 -12.875,-0.1875 -4.0798,-0.47818 -7.8868,-0.73461 -11.5313,0.59375 a 1.684398,1.684398 0 0 1 -0.1563,0.0312 c -11.7884,2.8498 -19.5228,15.78804 -17.4062,27.59375 a 1.684398,1.684398 0 0 1 0,0.65625 c -1.0407,5.14641 2.2557,9.72666 7.3438,10.59375 a 1.684398,1.684398 0 0 1 0.2812,0.0625 c 11.7498,4.04484 24.8758,2.18109 37.0625,-0.3125 a 1.684398,1.684398 0 0 1 1.2813,0.28125 c 2.0816,1.42722 4.4575,3.29235 6.625,4.1875 1.0837,0.44757 2.0633,0.63094 2.9374,0.53125 0.8627,-0.0984 1.6764,-0.44585 2.5938,-1.375 0.01,-0.0118 0.022,-0.0195 0.031,-0.0312 2.6608,-3.43997 2.9705,-7.61463 2.625,-12.3125 -0.3431,-4.66636 -1.3766,-9.66321 -1,-14.46875 -0.9524,-14.4251 -1.1073,-29.45823 -6.7187,-42.15625 -6.4124,-5.22259 -15.7954,-5.06556 -24.4687,-5.5625 -0.021,-10e-4 -0.042,0.001 -0.063,0 z" /> | ||
| 515 | <path | ||
| 516 | style="color:#000000;fill:url(#linearGradient4435);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22" | ||
| 517 | id="path5310" | ||
| 518 | d="m 345.6192,106.30395 c -3.4993,0.0307 -6.9607,-0.0581 -10.375,0.0312 -4.1004,0.36044 -9.0376,1.69024 -12.625,4.09375 -3.614,2.42133 -5.8704,5.68864 -5.2813,10.4375 0.4935,4.61527 3.5645,7.56447 7.6876,9.21875 4.123,1.65428 9.2633,1.8209 13.1562,0.65625 a 1.3611835,1.3611835 0 0 1 0.1562,-0.0312 c 2.8688,-0.49834 6.5939,-1.2529 9.2813,-2.71875 1.3437,-0.73292 2.3836,-1.63683 3.0313,-2.6875 0.6476,-1.05067 0.9604,-2.26047 0.6874,-3.96875 a 1.3611835,1.3611835 0 0 1 0,-0.28125 c 0.1564,-2.76724 0.3451,-6.68524 -0.375,-9.71875 -0.36,-1.51676 -0.9264,-2.77474 -1.75,-3.625 -0.8176,-0.8442 -1.8698,-1.36151 -3.5624,-1.40625 -0.012,-3.2e-4 -0.019,2.7e-4 -0.031,0 z" /> | ||
| 519 | </g> | ||
| 520 | </g> | ||
| 521 | </g> | ||
| 522 | </svg> | ||
diff --git a/doc/md/images/firefoxshare.png b/doc/md/images/firefoxshare.png new file mode 100644 index 00000000..98c2fdd3 --- /dev/null +++ b/doc/md/images/firefoxshare.png | |||
| Binary files differ | |||
diff --git a/doc/md/images/rss-filter-1.png b/doc/md/images/rss-filter-1.png new file mode 100644 index 00000000..d2a03f67 --- /dev/null +++ b/doc/md/images/rss-filter-1.png | |||
| Binary files differ | |||
diff --git a/doc/md/images/rss-filter-2.png b/doc/md/images/rss-filter-2.png new file mode 100644 index 00000000..538b126e --- /dev/null +++ b/doc/md/images/rss-filter-2.png | |||
| Binary files differ | |||
diff --git a/doc/Home.md b/doc/md/index.md index 38413f24..37a9c1fc 100644 --- a/doc/Home.md +++ b/doc/md/index.md | |||
| @@ -1,14 +1,11 @@ | |||
| 1 | #Home | 1 | Welcome to the [Shaarli](https://github.com/shaarli/Shaarli/) wiki! |
| 2 | # Shaarli wiki | ||
| 3 | |||
| 4 | Welcome to the [Shaarli](https://github.com/shaarli/Shaarli/) wiki | ||
| 5 | 2 | ||
| 6 | Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli. | 3 | Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli. |
| 7 | 4 | ||
| 8 | For general info, read the [README](https://github.com/shaarli/Shaarli/blob/master/README.md).[](.html) | 5 | For general info, read the [README](https://github.com/shaarli/Shaarli/blob/master/README.md). |
| 9 | 6 | ||
| 10 | If you have any questions or ideas, please join the [chat](https://gitter.im/shaarli/Shaarli) (also reachable via [IRC](https://irc.gitter.im/)), post them in our [general discussion](https://github.com/shaarli/Shaarli/issues/308) ([archive](https://github.com/shaarli/Shaarli/issues/44)) or read the current [issues](https://github.com/shaarli/Shaarli/issues). If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new).[](.html) | 7 | If you have any questions or ideas, please join the [chat](https://gitter.im/shaarli/Shaarli) (also reachable via [IRC](https://irc.gitter.im/)), post them in our [general discussion](https://github.com/shaarli/Shaarli/issues/308) ([archive](https://github.com/shaarli/Shaarli/issues/44)) or read the current [issues](https://github.com/shaarli/Shaarli/issues). If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new). |
| 11 | 8 | ||
| 12 | If you would like a feature added to Shaarli, check the issues labeled [`feature`](https://github.com/shaarli/Shaarli/labels/feature), [`enhancement`](https://github.com/shaarli/Shaarli/labels/enhancement), and [`plugin`](https://github.com/shaarli/Shaarli/labels/plugin).[](.html) | 9 | If you would like a feature added to Shaarli, check the issues labeled [`feature`](https://github.com/shaarli/Shaarli/labels/feature), [`enhancement`](https://github.com/shaarli/Shaarli/labels/enhancement), and [`plugin`](https://github.com/shaarli/Shaarli/labels/plugin). |
| 13 | 10 | ||
| 14 | _Note: This documentation is available online at https://github.com/shaarli/Shaarli/wiki, and locally in the `doc/` directory of your Shaarli installation._ | 11 | _Note: This documentation is available online at https://github.com/shaarli/Shaarli/wiki, and locally in the `doc/` directory of your Shaarli installation._ |
diff --git a/doc/sidebar.html b/doc/sidebar.html deleted file mode 100644 index 478840d1..00000000 --- a/doc/sidebar.html +++ /dev/null | |||
| @@ -1,52 +0,0 @@ | |||
| 1 | <div id="local-sidebar"> | ||
| 2 | <ul> | ||
| 3 | <li><a href="Home.html">Home</a></li> | ||
| 4 | <li>Setup | ||
| 5 | <ul> | ||
| 6 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
| 7 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 8 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 9 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 10 | <li><a href="Server-security.html">Server security</a></li> | ||
| 11 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> | ||
| 12 | <li><a href="Plugins.html">Plugins</a></li> | ||
| 13 | </ul></li> | ||
| 14 | <li><a href="Docker.html">Docker</a></li> | ||
| 15 | <li><a href="Usage.html">Usage</a> | ||
| 16 | <ul> | ||
| 17 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> | ||
| 18 | <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li> | ||
| 19 | <li><a href="Firefox-share.html">Firefox share</a></li> | ||
| 20 | <li><a href="RSS-feeds.html">RSS feeds</a></li> | ||
| 21 | <li><a href="REST-API.html">REST API</a></li> | ||
| 22 | </ul></li> | ||
| 23 | <li>How To | ||
| 24 | <ul> | ||
| 25 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | ||
| 26 | <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> | ||
| 27 | <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li> | ||
| 28 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> | ||
| 29 | <li><a href="Datastore-hacks.html">Datastore hacks</a></li> | ||
| 30 | </ul></li> | ||
| 31 | <li><a href="Troubleshooting.html">Troubleshooting</a></li> | ||
| 32 | <li><a href="Development.html">Development</a> | ||
| 33 | <ul> | ||
| 34 | <li><a href="GnuPG-signature.html">GnuPG signature</a></li> | ||
| 35 | <li><a href="Coding-guidelines.html">Coding guidelines</a></li> | ||
| 36 | <li><a href="Directory-structure.html">Directory structure</a></li> | ||
| 37 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> | ||
| 38 | <li><a href="Plugin-System.html">Plugin System</a></li> | ||
| 39 | <li><a href="Release-Shaarli.html">Release Shaarli</a></li> | ||
| 40 | <li><a href="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
| 41 | <li><a href="Security.html">Security</a></li> | ||
| 42 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 43 | <li><a href="Theming.html">Theming</a></li> | ||
| 44 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 45 | </ul></li> | ||
| 46 | <li>About | ||
| 47 | <ul> | ||
| 48 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 49 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 50 | </ul></li> | ||
| 51 | </ul> | ||
| 52 | </div> | ||
diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..f9648a7e --- /dev/null +++ b/mkdocs.yml | |||
| @@ -0,0 +1,53 @@ | |||
| 1 | site_name: Shaarli Documentation | ||
| 2 | repo_url: https://github.com/shaarli/Shaarli | ||
| 3 | site_description: The personal, minimalist, super-fast, database free, bookmarking service | ||
| 4 | theme: readthedocs | ||
| 5 | docs_dir: doc/md | ||
| 6 | site_dir: doc/html | ||
| 7 | |||
| 8 | pages: | ||
| 9 | - Home: index.md | ||
| 10 | - Setup: | ||
| 11 | - Download and Installation: Download-and-Installation.md | ||
| 12 | - Upgrade and migration: Upgrade-and-migration.md | ||
| 13 | - Server requirements: Server-requirements.md | ||
| 14 | - Server configuration: Server-configuration.md | ||
| 15 | - Server security: Server-security.md | ||
| 16 | - Shaarli configuration: Shaarli-configuration.md | ||
| 17 | - Plugins: Plugins.md | ||
| 18 | - Docker: | ||
| 19 | - Docker 101: Docker-101.md | ||
| 20 | - Shaarli images: Shaarli-images.md | ||
| 21 | - Reverse proxy configuration: Reverse-proxy-configuration.md | ||
| 22 | - Docker resources: Docker-resources.md | ||
| 23 | - Usage: | ||
| 24 | - Features: Features.md | ||
| 25 | - Bookmarklet: Bookmarklet.md | ||
| 26 | - Browsing and searching: Browsing-and-searching.md | ||
| 27 | - Firefox share: Firefox-share.md | ||
| 28 | - RSS feeds: RSS-feeds.md | ||
| 29 | - REST API: REST-API.md | ||
| 30 | - How To: | ||
| 31 | - Backup, restore, import and export: Backup,-restore,-import-and-export.md | ||
| 32 | - Copy an existing installation over SSH and serve it locally: Copy-an-existing-installation-over-SSH-and-serve-it-locally.md | ||
| 33 | - Create and serve multiple Shaarlis (farm): Create-and-serve-multiple-Shaarlis-(farm).md | ||
| 34 | - Download CSS styles from an OPML list: Download-CSS-styles-from-an-OPML-list.md | ||
| 35 | - Datastore hacks: Datastore-hacks.md | ||
| 36 | - Troubleshooting: Troubleshooting.md | ||
| 37 | - Development: | ||
| 38 | - Development guidelines: Development-guidelines.md | ||
| 39 | - Continuous integration tools: Continuous-integration-tools.md | ||
| 40 | - GnuPG signature: GnuPG-signature.md | ||
| 41 | - Coding guidelines: Coding-guidelines.md | ||
| 42 | - Directory structure: Directory-structure.md | ||
| 43 | - 3rd party libraries: 3rd-party-libraries.md | ||
| 44 | - Plugin System: Plugin-System.md | ||
| 45 | - Release Shaarli: Release-Shaarli.md | ||
| 46 | - Versioning and Branches: Versioning-and-Branches.md | ||
| 47 | - Security: Security.md | ||
| 48 | - Static analysis: Static-analysis.md | ||
| 49 | - Theming: Theming.md | ||
| 50 | - Unit tests: Unit-tests.md | ||
| 51 | - About: | ||
| 52 | - FAQ: FAQ.md | ||
| 53 | - Community & Related software: Community-&-Related-software.md | ||
diff --git a/tpl/default/page.footer.html b/tpl/default/page.footer.html index 02fc7642..84f13612 100644 --- a/tpl/default/page.footer.html +++ b/tpl/default/page.footer.html | |||
| @@ -1,3 +1,13 @@ | |||
| 1 | <<<<<<< HEAD | ||
| 2 | ======= | ||
| 3 | <div id="footer"> | ||
| 4 | <strong><a href="https://github.com/shaarli/Shaarli">Shaarli</a></strong> | ||
| 5 | - The personal, minimalist, super-fast, database free, bookmarking service by the Shaarli community | ||
| 6 | - <a href="doc/html/index.html" rel="nofollow">Help/documentation</a> | ||
| 7 | {loop="$plugins_footer.text"} | ||
| 8 | {$value} | ||
| 9 | {/loop} | ||
| 10 | >>>>>>> Generate HTML documentation using MkDocs (WIP) | ||
| 1 | </div> | 11 | </div> |
| 2 | 12 | ||
| 3 | <div class="pure-g"> | 13 | <div class="pure-g"> |
