aboutsummaryrefslogtreecommitdiff
path: root/viewer/ldgallery-viewer.7.md
diff options
context:
space:
mode:
authorzeroinformatique2021-07-05 20:19:48 +0200
committerGitHub2021-07-05 20:19:48 +0200
commit89cd6d8aa71870788765db489dd67c4ef237c551 (patch)
tree7250db7e0bcfbae85d5d1732ce887b624e080654 /viewer/ldgallery-viewer.7.md
parentac160f6879f9a2c74ca77c1c34742d24e69bf570 (diff)
parentc83f44cd69a227f873a026c01653ef434b6ae045 (diff)
downloadldgallery-89cd6d8aa71870788765db489dd67c4ef237c551.tar.gz
Merge pull request #304 from ldgallery/oz-splash-screen
viewer: optional user-defined markdown splash screen
Diffstat (limited to 'viewer/ldgallery-viewer.7.md')
-rw-r--r--viewer/ldgallery-viewer.7.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/viewer/ldgallery-viewer.7.md b/viewer/ldgallery-viewer.7.md
index 96070dc..1e914ff 100644
--- a/viewer/ldgallery-viewer.7.md
+++ b/viewer/ldgallery-viewer.7.md
@@ -92,11 +92,58 @@ initialTagDisplayLimit
92 Set to -1 to disable the limit on suggestions. 92 Set to -1 to disable the limit on suggestions.
93 Defaults to 10. 93 Defaults to 10.
94 94
95splashScreen
96: Displays an information notice before opening the gallery (see below).
97
95An alternative viewer configuration file located in the viewer's directory can be loaded by specifying its name, 98An alternative viewer configuration file located in the viewer's directory can be loaded by specifying its name,
96without the ".json" extension, as a query parameter given before the page anchor; 99without the ".json" extension, as a query parameter given before the page anchor;
97for example, some alternative configuration named "config_2.json" can be loaded with "http://gallery/?config_2#". 100for example, some alternative configuration named "config_2.json" can be loaded with "http://gallery/?config_2#".
98 101
99 102
103# SPLASH SCREEN CONFIGURATION
104
105splashScreen.resource
106: Absolute or relative path to the information notice. The user is prompted to explicitly acknowledge such notice before being allowed to browse the gallery.
107 Rich text formatting is possible through the use of the [GitHub Flavoured Markdown syntax][GFM].
108 Inline HTML and CSS are also supported.
109 [GFM]: https://github.github.com/gfm/
110
111splashScreen.acknowledgmentKey
112: 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.
113 When left empty, the notice will appear every time.
114
115splashScreen.buttonAcknowledgeLabel
116: Optional label for the acknowledge button shown below the notice.
117 *Defaults to "Acknowledge"*
118
119splashScreen.style
120: Optional CSS attributes for the information notice's container.
121 String or JSON formats are supported.
122
123
124# CONFIGURATION EXAMPLE
125
126Viewer __config.json__:
127
128```json
129{
130 "galleryRoot": "./gallery/",
131 "galleryIndex": "index.json",
132 "initialItemSort": "date_desc",
133 "initialTagDisplayLimit": 10,
134 "splashScreen": {
135 "resource": "./splashscreen.md",
136 "acknowledgmentKey": "v001",
137 "buttonAcknowledgeLabel": "I agree",
138 "style": {
139 "max-width": "45em",
140 "font-size": "20px",
141 "padding-top": "20vh"
142 }
143 }
144}
145```
146
100# PROGRESSIVE WEB APPLICATION 147# PROGRESSIVE WEB APPLICATION
101 148
102This 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. 149This 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.