aboutsummaryrefslogtreecommitdiff
path: root/viewer
diff options
context:
space:
mode:
authorpacien2020-02-27 20:08:24 +0100
committerNotkea2020-02-27 21:11:32 +0100
commit8f041b9f13b4c043acc7720aa4c082583b52ffe1 (patch)
treeea78985860e739ae7c2dfe2652295a488ca9afe2 /viewer
parent4f1315cb9ff4a3dd78b90352bb517861bf2d59b7 (diff)
downloadldgallery-8f041b9f13b4c043acc7720aa4c082583b52ffe1.tar.gz
docs: document viewer
GitHub: closes #128
Diffstat (limited to 'viewer')
-rw-r--r--viewer/ldgallery-viewer.7.md45
1 files changed, 37 insertions, 8 deletions
diff --git a/viewer/ldgallery-viewer.7.md b/viewer/ldgallery-viewer.7.md
index 0711496..da3be76 100644
--- a/viewer/ldgallery-viewer.7.md
+++ b/viewer/ldgallery-viewer.7.md
@@ -1,6 +1,6 @@
1--- 1---
2pagetitle: Viewer user manual - ldgallery 2pagetitle: Viewer user manual - ldgallery
3title: LDGALLERY-VIEWER(7) ldgallery viewer 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-02-16 (v0.1.0.0-SNAPSHOT)
6--- 6---
@@ -8,30 +8,59 @@ date: 2020-02-16 (v0.1.0.0-SNAPSHOT)
8 8
9# NAME 9# NAME
10 10
11ldgallery viewer - a static web gallery with tags 11ldgallery viewer - a static web gallery viewer with tags
12 12
13 13
14# DESCRIPTION 14# DESCRIPTION
15 15
16TODO 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
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.
17 19
18 20
19# USER INTERFACE 21# USER INTERFACE
20 22
21TODO 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.
24
25The main view displays the gallery's directories and items as a thumbnail grid.
26
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.
28
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.
22 30
23 31
24# SEARCH QUERIES 32# SEARCH QUERIES
25 33
26TODO 34Items can be filtered based on their tags.
35Adding tags to the search query restricts the search results to items having those tags.
36
37The following modifiers can be used in queries as prefixes of tags:
38
39`+`
40: Include all items having the associated tag,
41 independently of simple tag restrictions.
42
43`-`
44: Exclude all items having the associated tag,
45 independently of simple tag restrictions and inclusions.
46
47
48<!-- TODO: document tag groups and disambiguation once they're fully implemented (#29) -->
27 49
28 50
29# VIEWER CONFIGURATION 51# VIEWER CONFIGURATION
30 52
31TODO 53The viewer itself can be configured through a JSON file named `config.json` and placed in the web viewer's directory.
54
55galleryRoot
56: Absolute or relative path to the root of the gallery to display.
57
58
59# PROGRESSIVE WEB APPLICATION
60
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.
32 62
33key.key 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.
34: Details
35 64
36 65
37# SEE ALSO 66# SEE ALSO