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.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/viewer/ldgallery-viewer.7.md b/viewer/ldgallery-viewer.7.md
index 96070dc..5012e3b 100644
--- a/viewer/ldgallery-viewer.7.md
+++ b/viewer/ldgallery-viewer.7.md
@@ -96,6 +96,53 @@ An alternative viewer configuration file located in the viewer's directory can b
96without the ".json" extension, as a query parameter given before the page anchor; 96without 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#". 97for example, some alternative configuration named "config_2.json" can be loaded with "http://gallery/?config_2#".
98 98
99splashScreen
100: Displays an information notice before opening the gallery (see below).
101
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
110splashScreen.dontshowagainUID
111: Optional unique ID; when set, the information notice will appear only the first time it is proposed to the user. To display the notice again, change this UID.
112 When left empty, the notice will appear every time.
113
114splashScreen.buttonAcknowledgeLabel
115: Optional label for the acknowledge button shown below the notice.
116 *Defaults to "Acknowledge"*
117
118splashScreen.style
119: Optional CSS attributes for the information notice's container.
120 String or JSON formats are supported.
121
122 [GFM]: https://github.github.com/gfm/
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 "dontshowagainUID": "v001",
137 "buttonAcknowledgeLabel": "I agree",
138 "style": {
139 "max-width": "45em",
140 "font-size": "20px",
141 "padding-top": "20vh"
142 }
143 }
144}
145```
99 146
100# PROGRESSIVE WEB APPLICATION 147# PROGRESSIVE WEB APPLICATION
101 148