aboutsummaryrefslogtreecommitdiff
path: root/viewer/ldgallery-viewer.7.md
diff options
context:
space:
mode:
Diffstat (limited to 'viewer/ldgallery-viewer.7.md')
-rw-r--r--viewer/ldgallery-viewer.7.md108
1 files changed, 101 insertions, 7 deletions
diff --git a/viewer/ldgallery-viewer.7.md b/viewer/ldgallery-viewer.7.md
index 41f5003..da0839b 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-04-30 (v1.0) 5date: 2023-07-26 (v2.3)
6--- 6---
7 7
8 8
@@ -24,12 +24,31 @@ Its responsiveness allows it to be used from either a desktop browser or some mo
24The 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, which can be opened by using the appropriate button in the toolbar at the top-left corner.
25 25
26The main view displays the gallery's directories and items as a thumbnail grid. 26The main view displays the gallery's directories and items as a thumbnail grid.
27The order in which items are displayed can be chosen from the sort menu at the top-left corner.
27 28
28The side panel allows the user to interactively enter filtering queries to search through the gallery's content. 29The side panel allows the user to interactively enter filtering queries to search through the gallery's content.
29This panel features a list of relevant tags, grouped by categories, that can be used to build the search query. 30This panel features a list of relevant tags, grouped by categories, that can be used to build the search query.
30 31
31Picture items can be opened and visualised within the application. 32The information panel at the bottom of the sidebar displays various metadata about the currently viewed item.
32Other types of elements are either downloaded or displayed in the same window depending on the user's web browser supported media types. 33Those include the title, date and description of the file or directory.
34
35Items of the following formats can be opened and visualised within the web application:
36
37* Pictures (Bitmap, JPEG, PNG, TIFF, HDR, GIF)
38* Videos (OGV, WebM, Matroska, MPEG-4)
39* Audio files (WAV, Opus, FLAC, MP3, MPEG-4)
40* Text files (TXT, Markdown)
41* Ebooks (PDF, EPUB)
42
43Formats which are not listed above or which are not supported by the user's web browser are offered for download instead of being directly displayed in the same window.
44The item being visualised can be downloaded using the download button at the top-left corner.
45
46
47# KEYBOARD SHORTCUTS
48
49`CTRL-K`
50: Moves the focus to the tag search field, opening the side search panel if it is closed.
51 Pressing again while in the search input field sets the focus to the browser's address bar.
33 52
34 53
35# SEARCH QUERIES 54# SEARCH QUERIES
@@ -46,17 +65,92 @@ The following modifiers can be used in queries as prefixes of tags:
46`-` 65`-`
47: Exclude all items having the associated tag, independently of simple tag restrictions and inclusions. 66: Exclude all items having the associated tag, independently of simple tag restrictions and inclusions.
48 67
49Autocompletion suggestions are shown as filters are being typed in the query field. 68Auto-completion suggestions are shown as filters are being typed in the query field.
50In 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. 69In 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 70
52 71
53# VIEWER CONFIGURATION 72# VIEWER CONFIGURATION
54 73
55The viewer itself can be configured through a JSON file named "config.json" and placed in the web viewer's directory. 74The viewer itself can be configured through a JSON file named __config.json__ and placed in the web viewer's directory.
75
76Viewer configuration options are:
56 77
57galleryRoot 78galleryRoot
58: Absolute or relative path to the root of the gallery to display. 79: Absolute or relative path to the root of the gallery to display.
59 80
81galleryIndex
82: Optional index file to use under the value specified for "galleryRoot".
83 Defaults to "index.json".
84
85initialItemSort
86: Order in which gallery items are originally to be displayed.
87 Possible values are "title_asc", "date_asc", "date_desc".
88 Defaults to "date_asc".
89 Titles are sorted using a human-friendly _natural sort order_ which treats multi-digit numbers atomically.
90 The item path is used as a tie-breaker for all the defined orders.
91
92<!-- https://github.com/pacien/ldgallery/issues/27
93initialSearchQuery
94: Optional initial search query to set when opening the gallery.
95-->
96
97initialTagDisplayLimit
98: Limit on the number of tags to suggest in each tag category.
99 Causes only the specified amount of most used tags to be displayed until the user expands the list.
100 Set to -1 to disable the limit on suggestions.
101 Defaults to 10.
102
103splashScreen
104: Displays an information notice before opening the gallery (see below).
105
106An alternative viewer configuration file located in the viewer's directory can be loaded by specifying its name,
107without the ".json" extension, as a query parameter given before the page anchor;
108for example, some alternative configuration named "config_2.json" can be loaded with "http://gallery/?config_2#".
109
110
111# SPLASH SCREEN CONFIGURATION
112
113splashScreen.resource
114: Absolute or relative path to the information notice. The user is prompted to explicitly acknowledge such notice before being allowed to browse the gallery.
115 Rich text formatting is possible through the use of the [GitHub Flavoured Markdown syntax][GFM].
116 Inline HTML and CSS are also supported.
117 [GFM]: https://github.github.com/gfm/
118
119splashScreen.acknowledgmentKey
120: Optional key; when set to an arbitrary string, the information notice will appear only the first time it is proposed to the user. Once the notice acknowledged, the key is saved to the device's local storage. To display the notice again, change this key to another value.
121 When left empty, the notice will appear every time.
122
123splashScreen.buttonAcknowledgeLabel
124: Optional label for the acknowledge button shown below the notice.
125 *Defaults to "Acknowledge"*
126
127splashScreen.style
128: Optional CSS attributes for the information notice's container.
129 String or JSON formats are supported.
130
131
132# CONFIGURATION EXAMPLE
133
134Viewer __config.json__:
135
136```json
137{
138 "galleryRoot": "./gallery/",
139 "galleryIndex": "index.json",
140 "initialItemSort": "date_desc",
141 "initialTagDisplayLimit": 10,
142 "splashScreen": {
143 "resource": "./splashscreen.md",
144 "acknowledgmentKey": "v001",
145 "buttonAcknowledgeLabel": "I agree",
146 "style": {
147 "max-width": "45em",
148 "font-size": "20px",
149 "padding-top": "20vh"
150 }
151 }
152}
153```
60 154
61# PROGRESSIVE WEB APPLICATION 155# PROGRESSIVE WEB APPLICATION
62 156
@@ -68,14 +162,14 @@ An example of such manifest and an associated icon are available in the example
68 162
69# SEE ALSO 163# SEE ALSO
70 164
71Related manual pages: __ldgallery__(1), __ldgallery-quickstart__(7) 165Related manual pages: __ldgallery__(1), __ldgallery-quickstart__(7).
72 166
73The ldgallery source code is available on <https://ldgallery.pacien.org>. 167The ldgallery source code is available on <https://ldgallery.pacien.org>.
74 168
75 169
76# LICENSE 170# LICENSE
77 171
78Copyright (C) 2019-2020 Pacien TRAN-GIRARD and Guillaume FOUET. 172Copyright (C) 2019-2023 Pacien TRAN-GIRARD and Guillaume FOUET.
79 173
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. 174This 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 175