From 928c501dda0c3580e3cb0389efc16fc1dde16b68 Mon Sep 17 00:00:00 2001 From: Zero~Informatique Date: Sat, 3 Jul 2021 05:06:44 +0200 Subject: viewer: optional user-defined markdown splash screen GitHub: closes #284 --- viewer/ldgallery-viewer.7.md | 47 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) (limited to 'viewer/ldgallery-viewer.7.md') 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 without the ".json" extension, as a query parameter given before the page anchor; for example, some alternative configuration named "config_2.json" can be loaded with "http://gallery/?config_2#". +splashScreen +: Displays an information notice before opening the gallery (see below). + + +# SPLASH SCREEN CONFIGURATION + +splashScreen.resource +: Absolute or relative path to the information notice. The user is prompted to explicitly acknowledge such notice before being allowed to browse the gallery. + Rich text formatting is possible through the use of the [GitHub Flavoured Markdown syntax][GFM]. + Inline HTML and CSS are also supported. + +splashScreen.dontshowagainUID +: 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. + When left empty, the notice will appear every time. + +splashScreen.buttonAcknowledgeLabel +: Optional label for the acknowledge button shown below the notice. + *Defaults to "Acknowledge"* + +splashScreen.style +: Optional CSS attributes for the information notice's container. + String or JSON formats are supported. + + [GFM]: https://github.github.com/gfm/ + +# CONFIGURATION EXAMPLE + +Viewer __config.json__: + +```json +{ + "galleryRoot": "./gallery/", + "galleryIndex": "index.json", + "initialItemSort": "date_desc", + "initialTagDisplayLimit": 10, + "splashScreen": { + "resource": "./splashscreen.md", + "dontshowagainUID": "v001", + "buttonAcknowledgeLabel": "I agree", + "style": { + "max-width": "45em", + "font-size": "20px", + "padding-top": "20vh" + } + } +} +``` # PROGRESSIVE WEB APPLICATION -- cgit v1.2.3 From c83f44cd69a227f873a026c01653ef434b6ae045 Mon Sep 17 00:00:00 2001 From: Zero~Informatique Date: Mon, 5 Jul 2021 19:10:20 +0200 Subject: viewer: viewer: optional user-defined markdown splash screen Code review changes --- viewer/ldgallery-viewer.7.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'viewer/ldgallery-viewer.7.md') diff --git a/viewer/ldgallery-viewer.7.md b/viewer/ldgallery-viewer.7.md index 5012e3b..1e914ff 100644 --- a/viewer/ldgallery-viewer.7.md +++ b/viewer/ldgallery-viewer.7.md @@ -92,13 +92,13 @@ initialTagDisplayLimit Set to -1 to disable the limit on suggestions. Defaults to 10. +splashScreen +: Displays an information notice before opening the gallery (see below). + An alternative viewer configuration file located in the viewer's directory can be loaded by specifying its name, without the ".json" extension, as a query parameter given before the page anchor; for example, some alternative configuration named "config_2.json" can be loaded with "http://gallery/?config_2#". -splashScreen -: Displays an information notice before opening the gallery (see below). - # SPLASH SCREEN CONFIGURATION @@ -106,9 +106,10 @@ splashScreen.resource : Absolute or relative path to the information notice. The user is prompted to explicitly acknowledge such notice before being allowed to browse the gallery. Rich text formatting is possible through the use of the [GitHub Flavoured Markdown syntax][GFM]. Inline HTML and CSS are also supported. + [GFM]: https://github.github.com/gfm/ -splashScreen.dontshowagainUID -: 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. +splashScreen.acknowledgmentKey +: 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. When left empty, the notice will appear every time. splashScreen.buttonAcknowledgeLabel @@ -119,7 +120,6 @@ splashScreen.style : Optional CSS attributes for the information notice's container. String or JSON formats are supported. - [GFM]: https://github.github.com/gfm/ # CONFIGURATION EXAMPLE @@ -133,7 +133,7 @@ Viewer __config.json__: "initialTagDisplayLimit": 10, "splashScreen": { "resource": "./splashscreen.md", - "dontshowagainUID": "v001", + "acknowledgmentKey": "v001", "buttonAcknowledgeLabel": "I agree", "style": { "max-width": "45em", -- cgit v1.2.3 From 00510820a2794efcadbc83f7f8b54318fe198ecb Mon Sep 17 00:00:00 2001 From: Zéro~Informatique Date: Tue, 26 Jul 2022 08:44:34 +0200 Subject: viewer: migrate to vue 3, general refactoring and cleanup Non-exhaustive list of fixes and improvements done at the same time: - html default background to grey (avoids white flash during init) - unified links behavior - added more theme variables - removed the flex-expand transition (it wasn't working) and replaced it with a slide - fixed LdLoading not centered on the content - title on removable tags - fixed an issue with encoded URI from vue-router - unified Item resource URLs - removed the iframe for PlainTextViewer (it wasn't working properly) and replaced it with a pre - fixed clear and search buttons tabindex - fixed the information panel bumping up during the fade animation of tag's dropdown - fixed some focus outlines not appearing correctly - moved CSS variables to the :root context - Code cleaning GitHub: closes #217 GitHub: closes #300 GitHub: closes #297 GitHub: closes #105 GitHub: closes #267 GitHub: closes #275 GitHub: closes #228 GitHub: closes #215 GitHub: closes #112 --- viewer/ldgallery-viewer.7.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'viewer/ldgallery-viewer.7.md') diff --git a/viewer/ldgallery-viewer.7.md b/viewer/ldgallery-viewer.7.md index 1e914ff..00435bc 100644 --- a/viewer/ldgallery-viewer.7.md +++ b/viewer/ldgallery-viewer.7.md @@ -161,7 +161,7 @@ The ldgallery source code is available on . # LICENSE -Copyright (C) 2019-2020 Pacien TRAN-GIRARD and Guillaume FOUET. +Copyright (C) 2019-2022 Pacien TRAN-GIRARD and Guillaume FOUET. 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. -- cgit v1.2.3 From ce673a4b66c62fb0595c81cb79ba9d30768a9679 Mon Sep 17 00:00:00 2001 From: pacien Date: Sun, 4 Sep 2022 17:12:46 +0200 Subject: project: set new version for release 2.1 --- viewer/ldgallery-viewer.7.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'viewer/ldgallery-viewer.7.md') diff --git a/viewer/ldgallery-viewer.7.md b/viewer/ldgallery-viewer.7.md index 00435bc..c0634b6 100644 --- a/viewer/ldgallery-viewer.7.md +++ b/viewer/ldgallery-viewer.7.md @@ -2,7 +2,7 @@ pagetitle: Viewer user manual - ldgallery title: LDGALLERY-VIEWER(7) ldgallery author: Pacien TRAN-GIRARD, Guillaume FOUET -date: 2020-09-24 (v2.0) +date: 2022-09-04 (v2.1) --- -- cgit v1.2.3