aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorpacien2020-04-05 03:29:16 +0200
committerNotkea2020-04-05 05:48:41 +0200
commit54d77dddec39a4864f5a1614d1c76628aae10666 (patch)
tree6de15cb83dbeb181b83763087a290f574814a67b
parent6a51cbe5bbb166f58cc7961091cc64328d0d2126 (diff)
downloadldgallery-54d77dddec39a4864f5a1614d1c76628aae10666.tar.gz
viewer: document tag disambiguation in queries
-rw-r--r--viewer/ldgallery-viewer.7.md31
1 files changed, 20 insertions, 11 deletions
diff --git a/viewer/ldgallery-viewer.7.md b/viewer/ldgallery-viewer.7.md
index da3be76..59a9f49 100644
--- a/viewer/ldgallery-viewer.7.md
+++ b/viewer/ldgallery-viewer.7.md
@@ -2,7 +2,7 @@
2pagetitle: Viewer user manual - ldgallery 2pagetitle: Viewer user manual - ldgallery
3title: LDGALLERY-VIEWER(7) ldgallery 3title: LDGALLERY-VIEWER(7) ldgallery
4author: Pacien TRAN-GIRARD, Guillaume FOUET 4author: Pacien TRAN-GIRARD, Guillaume FOUET
5date: 2020-02-16 (v0.1.0.0-SNAPSHOT) 5date: 2020-04-05 (v0.1.0.0-SNAPSHOT)
6--- 6---
7 7
8 8
@@ -15,24 +15,29 @@ ldgallery viewer - a static web gallery viewer with tags
15 15
16The ldgallery viewer is a web application that allows users to browse, search through and view items in galleries generated by the ldgallery(1) compiler. 16The 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 17
18The web application runs in a JavaScript-enabled web browser and does not require any special software on the server's side. Its responsiveness allows it to be used from either a desktop browser or some mobile device. 18The web application runs in a JavaScript-enabled web browser and does not require any special software on the server's side.
19Its responsiveness allows it to be used from either a desktop browser or some mobile device.
19 20
20 21
21# USER INTERFACE 22# USER INTERFACE
22 23
23The 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. 24The viewer's user interface is split into a main item view and a side search panel,
25which can be opened by using the appropriate button in the toolbar at the top-left corner.
24 26
25The main view displays the gallery's directories and items as a thumbnail grid. 27The main view displays the gallery's directories and items as a thumbnail grid.
26 28
27The side panel allows the user to interactively enter filtering queries to search through the gallery's content. This panel features a list of relevant tags that can be used to build the search query. 29The side panel allows the user to interactively enter filtering queries to search through the gallery's content.
30This panel features a list of relevant tags, grouped by categories, that can be used to build the search query.
28 31
29Picture items can be opened and visualised within the application. Other types of elements are either downloaded or displayed in the same window depending on the user's web browser supported media types. 32Picture items can be opened and visualised within the application.
33Other types of elements are either downloaded or displayed in the same window depending on the user's web browser supported media types.
30 34
31 35
32# SEARCH QUERIES 36# SEARCH QUERIES
33 37
34Items can be filtered based on their tags. 38Items can be filtered based on their tags.
35Adding tags to the search query restricts the search results to items having those tags. 39Adding tags to the search query restricts the search results to items having those tags.
40Tags which belong to multiple categories may be disambiguated by adding their category as a prefix, separated by a colon (":").
36 41
37The following modifiers can be used in queries as prefixes of tags: 42The following modifiers can be used in queries as prefixes of tags:
38 43
@@ -44,13 +49,14 @@ The following modifiers can be used in queries as prefixes of tags:
44: Exclude all items having the associated tag, 49: Exclude all items having the associated tag,
45 independently of simple tag restrictions and inclusions. 50 independently of simple tag restrictions and inclusions.
46 51
47 52Autocompletion suggestions are shown as filters are being typed in the query field.
48<!-- TODO: document tag groups and disambiguation once they're fully implemented (#29) --> 53In the case of disambiguated tags, both the category and the tag components are allowed to be partially entered,
54allowing "loc:fra" to expand into "location:france" for example.
49 55
50 56
51# VIEWER CONFIGURATION 57# VIEWER CONFIGURATION
52 58
53The viewer itself can be configured through a JSON file named `config.json` and placed in the web viewer's directory. 59The viewer itself can be configured through a JSON file named "config.json" and placed in the web viewer's directory.
54 60
55galleryRoot 61galleryRoot
56: Absolute or relative path to the root of the gallery to display. 62: Absolute or relative path to the root of the gallery to display.
@@ -58,9 +64,11 @@ galleryRoot
58 64
59# PROGRESSIVE WEB APPLICATION 65# PROGRESSIVE WEB APPLICATION
60 66
61This 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. 67This web application can be "installed" on some user's mobile device as a progressive web application,
68i.e. a shortcut giving the web page the appearance of a native application.
62 69
63This feature can be enabled by adding a PWA manifest in the viewer's directory when deployed. An example of such manifest and an associated icon are available in the example folder packaged with the viewer. 70This feature can be enabled by adding a PWA manifest in the viewer's directory when deployed.
71An example of such manifest and an associated icon are available in the example folder packaged with the viewer.
64 72
65 73
66# SEE ALSO 74# SEE ALSO
@@ -71,4 +79,5 @@ Copyright (C) 2019-2020 Pacien TRAN-GIRARD and Guillaume FOUET.
71 79
72This 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. 80This 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.
73 81
74This 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. See the GNU Affero General Public License for more details <https://www.gnu.org/licenses/agpl-3.0.html>. 82This 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.
83See the GNU Affero General Public License for more details <https://www.gnu.org/licenses/agpl-3.0.html>.