From 781209ec9e3623b1eb9cc113f08537427aacfb77 Mon Sep 17 00:00:00 2001 From: pacien Date: Sun, 16 Feb 2020 11:58:10 +0100 Subject: viewer: add stub manual page (cherry picked from commit 3b8c48d69d3d6b91f46815abde02fc3ca3406693) --- viewer/ldgallery-viewer.7.md | 45 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 viewer/ldgallery-viewer.7.md (limited to 'viewer/ldgallery-viewer.7.md') diff --git a/viewer/ldgallery-viewer.7.md b/viewer/ldgallery-viewer.7.md new file mode 100644 index 0000000..0711496 --- /dev/null +++ b/viewer/ldgallery-viewer.7.md @@ -0,0 +1,45 @@ +--- +pagetitle: Viewer user manual - ldgallery +title: LDGALLERY-VIEWER(7) ldgallery viewer +author: Pacien TRAN-GIRARD, Guillaume FOUET +date: 2020-02-16 (v0.1.0.0-SNAPSHOT) +--- + + +# NAME + +ldgallery viewer - a static web gallery with tags + + +# DESCRIPTION + +TODO + + +# USER INTERFACE + +TODO + + +# SEARCH QUERIES + +TODO + + +# VIEWER CONFIGURATION + +TODO + +key.key +: Details + + +# SEE ALSO + +The ldgallery source code is available on . + +Copyright (C) 2019-2020 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. + +This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details . -- cgit v1.2.3 From 8f041b9f13b4c043acc7720aa4c082583b52ffe1 Mon Sep 17 00:00:00 2001 From: pacien Date: Thu, 27 Feb 2020 20:08:24 +0100 Subject: docs: document viewer GitHub: closes #128 --- viewer/ldgallery-viewer.7.md | 45 ++++++++++++++++++++++++++++++++++++-------- 1 file changed, 37 insertions(+), 8 deletions(-) (limited to 'viewer/ldgallery-viewer.7.md') diff --git a/viewer/ldgallery-viewer.7.md b/viewer/ldgallery-viewer.7.md index 0711496..da3be76 100644 --- a/viewer/ldgallery-viewer.7.md +++ b/viewer/ldgallery-viewer.7.md @@ -1,6 +1,6 @@ --- pagetitle: Viewer user manual - ldgallery -title: LDGALLERY-VIEWER(7) ldgallery viewer +title: LDGALLERY-VIEWER(7) ldgallery author: Pacien TRAN-GIRARD, Guillaume FOUET date: 2020-02-16 (v0.1.0.0-SNAPSHOT) --- @@ -8,30 +8,59 @@ date: 2020-02-16 (v0.1.0.0-SNAPSHOT) # NAME -ldgallery viewer - a static web gallery with tags +ldgallery viewer - a static web gallery viewer with tags # DESCRIPTION -TODO +The ldgallery viewer is a web application that allows users to browse, search through and view items in galleries generated by the ldgallery(1) compiler. + +The web application runs in a JavaScript-enabled web browser and does not require any special software on the server's side. Its responsiveness allows it to be used from either a desktop browser or some mobile device. # USER INTERFACE -TODO +The 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. + +The main view displays the gallery's directories and items as a thumbnail grid. + +The side panel allows the user to interactively enter filtering queries to search through the gallery's content. This panel features a list of relevant tags that can be used to build the search query. + +Picture items can be opened and visualised within the application. Other types of elements are either downloaded or displayed in the same window depending on the user's web browser supported media types. # SEARCH QUERIES -TODO +Items can be filtered based on their tags. +Adding tags to the search query restricts the search results to items having those tags. + +The following modifiers can be used in queries as prefixes of tags: + +`+` +: Include all items having the associated tag, + independently of simple tag restrictions. + +`-` +: Exclude all items having the associated tag, + independently of simple tag restrictions and inclusions. + + + # VIEWER CONFIGURATION -TODO +The viewer itself can be configured through a JSON file named `config.json` and placed in the web viewer's directory. + +galleryRoot +: Absolute or relative path to the root of the gallery to display. + + +# PROGRESSIVE WEB APPLICATION + +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. -key.key -: Details +This feature can be enabled by adding a PWA manifest in the viewer's directory when deployed. An example of such manifest and an associated icon are available in the example folder packaged with the viewer. # SEE ALSO -- cgit v1.2.3 From 54d77dddec39a4864f5a1614d1c76628aae10666 Mon Sep 17 00:00:00 2001 From: pacien Date: Sun, 5 Apr 2020 03:29:16 +0200 Subject: viewer: document tag disambiguation in queries --- viewer/ldgallery-viewer.7.md | 31 ++++++++++++++++++++----------- 1 file changed, 20 insertions(+), 11 deletions(-) (limited to 'viewer/ldgallery-viewer.7.md') diff --git a/viewer/ldgallery-viewer.7.md b/viewer/ldgallery-viewer.7.md index da3be76..59a9f49 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-02-16 (v0.1.0.0-SNAPSHOT) +date: 2020-04-05 (v0.1.0.0-SNAPSHOT) --- @@ -15,24 +15,29 @@ ldgallery viewer - a static web gallery viewer with tags The ldgallery viewer is a web application that allows users to browse, search through and view items in galleries generated by the ldgallery(1) compiler. -The web application runs in a JavaScript-enabled web browser and does not require any special software on the server's side. Its responsiveness allows it to be used from either a desktop browser or some mobile device. +The web application runs in a JavaScript-enabled web browser and does not require any special software on the server's side. +Its responsiveness allows it to be used from either a desktop browser or some mobile device. # USER INTERFACE -The 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. +The 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. The main view displays the gallery's directories and items as a thumbnail grid. -The side panel allows the user to interactively enter filtering queries to search through the gallery's content. This panel features a list of relevant tags that can be used to build the search query. +The side panel allows the user to interactively enter filtering queries to search through the gallery's content. +This panel features a list of relevant tags, grouped by categories, that can be used to build the search query. -Picture items can be opened and visualised within the application. Other types of elements are either downloaded or displayed in the same window depending on the user's web browser supported media types. +Picture items can be opened and visualised within the application. +Other types of elements are either downloaded or displayed in the same window depending on the user's web browser supported media types. # SEARCH QUERIES Items can be filtered based on their tags. Adding tags to the search query restricts the search results to items having those tags. +Tags which belong to multiple categories may be disambiguated by adding their category as a prefix, separated by a colon (":"). The following modifiers can be used in queries as prefixes of tags: @@ -44,13 +49,14 @@ The following modifiers can be used in queries as prefixes of tags: : Exclude all items having the associated tag, independently of simple tag restrictions and inclusions. - - +Autocompletion suggestions are shown as filters are being typed in the query field. +In 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. # VIEWER CONFIGURATION -The viewer itself can be configured through a JSON file named `config.json` and placed in the web viewer's directory. +The viewer itself can be configured through a JSON file named "config.json" and placed in the web viewer's directory. galleryRoot : Absolute or relative path to the root of the gallery to display. @@ -58,9 +64,11 @@ galleryRoot # PROGRESSIVE WEB APPLICATION -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. +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. -This feature can be enabled by adding a PWA manifest in the viewer's directory when deployed. An example of such manifest and an associated icon are available in the example folder packaged with the viewer. +This feature can be enabled by adding a PWA manifest in the viewer's directory when deployed. +An example of such manifest and an associated icon are available in the example folder packaged with the viewer. # SEE ALSO @@ -71,4 +79,5 @@ Copyright (C) 2019-2020 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. -This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details . +This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. +See the GNU Affero General Public License for more details . -- cgit v1.2.3 From 69cd09b4eba999447527819401ff9e23bfa1134e Mon Sep 17 00:00:00 2001 From: pacien Date: Fri, 17 Apr 2020 20:21:47 +0200 Subject: docs: prepare docs for release commenting out references to not yet fully implemented features --- viewer/ldgallery-viewer.7.md | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) (limited to 'viewer/ldgallery-viewer.7.md') diff --git a/viewer/ldgallery-viewer.7.md b/viewer/ldgallery-viewer.7.md index 59a9f49..1cc3cdd 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-04-05 (v0.1.0.0-SNAPSHOT) +date: 2020-04-17 (v1.0-SNAPSHOT) --- @@ -21,8 +21,7 @@ Its responsiveness allows it to be used from either a desktop browser or some mo # USER INTERFACE -The 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. +The 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. The main view displays the gallery's directories and items as a thumbnail grid. @@ -42,16 +41,13 @@ Tags which belong to multiple categories may be disambiguated by adding their ca The following modifiers can be used in queries as prefixes of tags: `+` -: Include all items having the associated tag, - independently of simple tag restrictions. +: Include all items having the associated tag, independently of simple tag restrictions. `-` -: Exclude all items having the associated tag, - independently of simple tag restrictions and inclusions. +: Exclude all items having the associated tag, independently of simple tag restrictions and inclusions. Autocompletion suggestions are shown as filters are being typed in the query field. -In 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. +In 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. # VIEWER CONFIGURATION @@ -64,8 +60,7 @@ galleryRoot # PROGRESSIVE WEB APPLICATION -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. +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. This feature can be enabled by adding a PWA manifest in the viewer's directory when deployed. An example of such manifest and an associated icon are available in the example folder packaged with the viewer. -- cgit v1.2.3 From 13fac8124d74ec2c4582cf8f151585cd6a9c21da Mon Sep 17 00:00:00 2001 From: Zero~Informatique Date: Thu, 30 Apr 2020 01:26:47 +0200 Subject: viewer: prepping for release, version update --- 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 1cc3cdd..6f572fe 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-04-17 (v1.0-SNAPSHOT) +date: 2020-04-30 (v1.0) --- -- cgit v1.2.3 From 0c355f42dbe71d755fb898b146bac41dd5bdefd8 Mon Sep 17 00:00:00 2001 From: pacien Date: Fri, 1 May 2020 23:00:45 +0200 Subject: doc: add quickstart guide GitHub: closes #206 --- viewer/ldgallery-viewer.7.md | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'viewer/ldgallery-viewer.7.md') diff --git a/viewer/ldgallery-viewer.7.md b/viewer/ldgallery-viewer.7.md index 6f572fe..41f5003 100644 --- a/viewer/ldgallery-viewer.7.md +++ b/viewer/ldgallery-viewer.7.md @@ -68,8 +68,13 @@ An example of such manifest and an associated icon are available in the example # SEE ALSO +Related manual pages: __ldgallery__(1), __ldgallery-quickstart__(7) + The ldgallery source code is available on . + +# LICENSE + Copyright (C) 2019-2020 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