diff options
Diffstat (limited to 'viewer/ldgallery-viewer.7.md')
-rw-r--r-- | viewer/ldgallery-viewer.7.md | 83 |
1 files changed, 83 insertions, 0 deletions
diff --git a/viewer/ldgallery-viewer.7.md b/viewer/ldgallery-viewer.7.md new file mode 100644 index 0000000..41f5003 --- /dev/null +++ b/viewer/ldgallery-viewer.7.md | |||
@@ -0,0 +1,83 @@ | |||
1 | --- | ||
2 | pagetitle: Viewer user manual - ldgallery | ||
3 | title: LDGALLERY-VIEWER(7) ldgallery | ||
4 | author: Pacien TRAN-GIRARD, Guillaume FOUET | ||
5 | date: 2020-04-30 (v1.0) | ||
6 | --- | ||
7 | |||
8 | |||
9 | # NAME | ||
10 | |||
11 | ldgallery viewer - a static web gallery viewer with tags | ||
12 | |||
13 | |||
14 | # DESCRIPTION | ||
15 | |||
16 | The ldgallery viewer is a web application that allows users to browse, search through and view items in galleries generated by the ldgallery(1) compiler. | ||
17 | |||
18 | The web application runs in a JavaScript-enabled web browser and does not require any special software on the server's side. | ||
19 | Its responsiveness allows it to be used from either a desktop browser or some mobile device. | ||
20 | |||
21 | |||
22 | # USER INTERFACE | ||
23 | |||
24 | The viewer's user interface is split into a main item view and a side search panel, which can be opened by using the appropriate button in the toolbar at the top-left corner. | ||
25 | |||
26 | The main view displays the gallery's directories and items as a thumbnail grid. | ||
27 | |||
28 | The side panel allows the user to interactively enter filtering queries to search through the gallery's content. | ||
29 | This panel features a list of relevant tags, grouped by categories, that can be used to build the search query. | ||
30 | |||
31 | Picture items can be opened and visualised within the application. | ||
32 | Other types of elements are either downloaded or displayed in the same window depending on the user's web browser supported media types. | ||
33 | |||
34 | |||
35 | # SEARCH QUERIES | ||
36 | |||
37 | Items can be filtered based on their tags. | ||
38 | Adding tags to the search query restricts the search results to items having those tags. | ||
39 | Tags which belong to multiple categories may be disambiguated by adding their category as a prefix, separated by a colon (":"). | ||
40 | |||
41 | The following modifiers can be used in queries as prefixes of tags: | ||
42 | |||
43 | `+` | ||
44 | : Include all items having the associated tag, independently of simple tag restrictions. | ||
45 | |||
46 | `-` | ||
47 | : Exclude all items having the associated tag, independently of simple tag restrictions and inclusions. | ||
48 | |||
49 | Autocompletion suggestions are shown as filters are being typed in the query field. | ||
50 | In the case of disambiguated tags, both the category and the tag components are allowed to be partially entered, allowing "loc:fra" to expand into "location:france" for example. | ||
51 | |||
52 | |||
53 | # VIEWER CONFIGURATION | ||
54 | |||
55 | The viewer itself can be configured through a JSON file named "config.json" and placed in the web viewer's directory. | ||
56 | |||
57 | galleryRoot | ||
58 | : Absolute or relative path to the root of the gallery to display. | ||
59 | |||
60 | |||
61 | # PROGRESSIVE WEB APPLICATION | ||
62 | |||
63 | This web application can be "installed" on some user's mobile device as a progressive web application, i.e. a shortcut giving the web page the appearance of a native application. | ||
64 | |||
65 | This feature can be enabled by adding a PWA manifest in the viewer's directory when deployed. | ||
66 | An example of such manifest and an associated icon are available in the example folder packaged with the viewer. | ||
67 | |||
68 | |||
69 | # SEE ALSO | ||
70 | |||
71 | Related manual pages: __ldgallery__(1), __ldgallery-quickstart__(7) | ||
72 | |||
73 | The ldgallery source code is available on <https://ldgallery.pacien.org>. | ||
74 | |||
75 | |||
76 | # LICENSE | ||
77 | |||
78 | Copyright (C) 2019-2020 Pacien TRAN-GIRARD and Guillaume FOUET. | ||
79 | |||
80 | This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. | ||
81 | |||
82 | This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | ||
83 | See the GNU Affero General Public License for more details <https://www.gnu.org/licenses/agpl-3.0.html>. | ||