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
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 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 order in which items are displayed can be chosen
from the sort menu at the top-left corner.
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.
The information panel at the bottom of the sidebar displays
various metadata about the currently viewed item. Those include the
title, date and description of the file or directory.
Items of the following formats can be opened and visualised
within the web application:
- Pictures (Bitmap, JPEG, PNG, TIFF, HDR, GIF)
- Videos (OGV, WebM, Matroska, MPEG-4)
- Audio files (WAV, Opus, FLAC, MP3, MPEG-4)
- Text files (TXT, Markdown)
- Ebooks (PDF, EPUB)
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. The item being visualised can
be downloaded using the download button at the top-left corner.
- Moves the focus to the tag search field, opening the side search
panel if it is closed. Pressing again while in the search input
field sets the focus to the browser’s address bar.
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
- Include all items having the associated tag, independently of simple
- Exclude all items having the associated tag, independently of simple
tag restrictions and inclusions.
Auto-completion 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.
The viewer itself can be configured through a JSON file named
config.json and placed in the web viewer’s
Viewer configuration options are:
- Absolute or relative path to the root of the gallery to display.
- Optional index file to use under the value specified for
“galleryRoot”. Defaults to “index.json”.
- Order in which gallery items are originally to be displayed.
Possible values are “title_asc”, “date_asc”, “date_desc”. Defaults
to “date_asc”. Titles are sorted using a human-friendly natural
sort order which treats multi-digit numbers atomically. The
item path is used as a tie-breaker for all the defined orders.
- Limit on the number of tags to suggest in each tag category. Causes
only the specified amount of most used tags to be displayed until
the user expands the list. Set to -1 to disable the limit on
suggestions. Defaults to 10.
- Displays an information notice before opening the gallery (see
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#”.
- 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/
- 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.
- Optional label for the acknowledge button shown below the notice.
Defaults to “Acknowledge”
- Optional CSS attributes for the information notice’s container.
String or JSON formats are supported.
"buttonAcknowledgeLabel": "I agree",
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
Related manual pages: ldgallery(1),
The ldgallery source code is available on https://ldgallery.pacien.org.
Copyright (C) 2019-2023 Pacien TRAN-GIRARD and Guillaume
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 https://www.gnu.org/licenses/agpl-3.0.html.