diff options
Diffstat (limited to 'viewer/ldgallery-viewer.7.md')
-rw-r--r-- | viewer/ldgallery-viewer.7.md | 63 |
1 files changed, 59 insertions, 4 deletions
diff --git a/viewer/ldgallery-viewer.7.md b/viewer/ldgallery-viewer.7.md index 96070dc..da0839b 100644 --- a/viewer/ldgallery-viewer.7.md +++ b/viewer/ldgallery-viewer.7.md | |||
@@ -2,7 +2,7 @@ | |||
2 | pagetitle: Viewer user manual - ldgallery | 2 | pagetitle: Viewer user manual - ldgallery |
3 | title: LDGALLERY-VIEWER(7) ldgallery | 3 | title: LDGALLERY-VIEWER(7) ldgallery |
4 | author: Pacien TRAN-GIRARD, Guillaume FOUET | 4 | author: Pacien TRAN-GIRARD, Guillaume FOUET |
5 | date: 2020-09-24 (v2.0) | 5 | date: 2023-07-26 (v2.3) |
6 | --- | 6 | --- |
7 | 7 | ||
8 | 8 | ||
@@ -37,10 +37,18 @@ Items of the following formats can be opened and visualised within the web appli | |||
37 | * Pictures (Bitmap, JPEG, PNG, TIFF, HDR, GIF) | 37 | * Pictures (Bitmap, JPEG, PNG, TIFF, HDR, GIF) |
38 | * Videos (OGV, WebM, Matroska, MPEG-4) | 38 | * Videos (OGV, WebM, Matroska, MPEG-4) |
39 | * Audio files (WAV, Opus, FLAC, MP3, MPEG-4) | 39 | * Audio files (WAV, Opus, FLAC, MP3, MPEG-4) |
40 | * Plain text files (`.txt`) | 40 | * Text files (TXT, Markdown) |
41 | * PDFs | 41 | * Ebooks (PDF, EPUB) |
42 | 42 | ||
43 | Formats 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. | 43 | Formats 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. |
44 | The 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. | ||
44 | 52 | ||
45 | 53 | ||
46 | # SEARCH QUERIES | 54 | # SEARCH QUERIES |
@@ -92,11 +100,58 @@ initialTagDisplayLimit | |||
92 | Set to -1 to disable the limit on suggestions. | 100 | Set to -1 to disable the limit on suggestions. |
93 | Defaults to 10. | 101 | Defaults to 10. |
94 | 102 | ||
103 | splashScreen | ||
104 | : Displays an information notice before opening the gallery (see below). | ||
105 | |||
95 | An alternative viewer configuration file located in the viewer's directory can be loaded by specifying its name, | 106 | An alternative viewer configuration file located in the viewer's directory can be loaded by specifying its name, |
96 | without the ".json" extension, as a query parameter given before the page anchor; | 107 | without the ".json" extension, as a query parameter given before the page anchor; |
97 | for example, some alternative configuration named "config_2.json" can be loaded with "http://gallery/?config_2#". | 108 | for example, some alternative configuration named "config_2.json" can be loaded with "http://gallery/?config_2#". |
98 | 109 | ||
99 | 110 | ||
111 | # SPLASH SCREEN CONFIGURATION | ||
112 | |||
113 | splashScreen.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 | |||
119 | splashScreen.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 | |||
123 | splashScreen.buttonAcknowledgeLabel | ||
124 | : Optional label for the acknowledge button shown below the notice. | ||
125 | *Defaults to "Acknowledge"* | ||
126 | |||
127 | splashScreen.style | ||
128 | : Optional CSS attributes for the information notice's container. | ||
129 | String or JSON formats are supported. | ||
130 | |||
131 | |||
132 | # CONFIGURATION EXAMPLE | ||
133 | |||
134 | Viewer __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 | ``` | ||
154 | |||
100 | # PROGRESSIVE WEB APPLICATION | 155 | # PROGRESSIVE WEB APPLICATION |
101 | 156 | ||
102 | 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. | 157 | 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. |
@@ -114,7 +169,7 @@ The ldgallery source code is available on <https://ldgallery.pacien.org>. | |||
114 | 169 | ||
115 | # LICENSE | 170 | # LICENSE |
116 | 171 | ||
117 | Copyright (C) 2019-2020 Pacien TRAN-GIRARD and Guillaume FOUET. | 172 | Copyright (C) 2019-2023 Pacien TRAN-GIRARD and Guillaume FOUET. |
118 | 173 | ||
119 | 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. | 174 | 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. |
120 | 175 | ||