aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/html/Browsing-and-searching/index.html
diff options
context:
space:
mode:
authornodiscc <nodiscc@gmail.com>2017-01-26 18:52:54 +0100
committernodiscc <nodiscc@gmail.com>2017-06-18 00:19:49 +0200
commit53ed6d7d1e678d7486337ce67a2f17b30bac21ac (patch)
treef8bef0164a70bd03d2b9781951c01bdd018f1842 /doc/html/Browsing-and-searching/index.html
parentd5d22a6d07917865c44148ad76f43c65a929a890 (diff)
downloadShaarli-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
Diffstat (limited to 'doc/html/Browsing-and-searching/index.html')
-rw-r--r--doc/html/Browsing-and-searching/index.html362
1 files changed, 362 insertions, 0 deletions
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 &nbsp;
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> &raquo;</li>
282
283
284
285 <li>Usage &raquo;</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;">&laquo; Previous</a></span>
353
354
355 <span style="margin-left: 15px"><a href="../Firefox-share/" style="color: #fcfcfc">Next &raquo;</a></span>
356
357 </span>
358</div>
359 <script src="../js/theme.js"></script>
360
361</body>
362</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-10 01:47:45 +0000