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 --- compiler/ldgallery.1.md | 31 +++++++++++++++++++++---------- viewer/ldgallery-viewer.7.md | 17 ++++++----------- 2 files changed, 27 insertions(+), 21 deletions(-) diff --git a/compiler/ldgallery.1.md b/compiler/ldgallery.1.md index 4f9935b..29f0cf3 100644 --- a/compiler/ldgallery.1.md +++ b/compiler/ldgallery.1.md @@ -2,7 +2,7 @@ pagetitle: Compiler user manual - ldgallery title: LDGALLERY(1) ldgallery author: Pacien TRAN-GIRARD, Guillaume FOUET -date: 2020-02-15 (v0.1.0.0-SNAPSHOT) +date: 2020-04-17 (v1.0-SNAPSHOT) --- @@ -15,7 +15,9 @@ ldgallery - a static web gallery generator with tags ldgallery is a static gallery generator which turns a collection of tagged pictures into a searchable web gallery. -The ldgallery compiler program processes pictures and aggregates metadata from plain text sidecar files to generate an indexed version of the gallery. It can optionally output a static web viewer along, which allows the content to be presented and searched through from a JavaScript-enabled web browser. This client-side web application does not require any special software on the server's side. +The ldgallery compiler program processes pictures and aggregates metadata from plain text sidecar files to generate an indexed version of the gallery. +It can optionally output a static web viewer along, which allows the content to be presented and searched through from a JavaScript-enabled web browser. +This client-side web application does not require any special software on the server's side. # COMMAND @@ -97,13 +99,17 @@ title : Title of the item. Defaults to the name of the file or directory. + + tags : List of tags for the item. @@ -116,19 +122,24 @@ tags The gallery settings reside in a file named "gallery.yaml" located at the root of the gallery's source directory. galleryTitle -: Title of the gallery. Defaults to "ldgallery". +: Title of the gallery. + Defaults to "ldgallery". includedDirectories[] -: Glob patterns of directory names to include in the gallery. Defaults to ["*"] (matches all directory names). +: Glob patterns of directory names to include in the gallery. + Defaults to ["*"] (matches all directory names). excludedDirectories[] -: Glob patterns of directory names to exclude from the gallery. Defaults to [] (none). +: Glob patterns of directory names to exclude from the gallery. + Defaults to [] (none). includedFiles[] -: Glob patterns of file names to include in the gallery. Defaults to ["*"] (matches all file names). +: Glob patterns of file names to include in the gallery. + Defaults to ["*"] (matches all file names). excludedFiles[] -: Glob patterns of file names to exclude from the gallery. Defaults to [] (none). +: Glob patterns of file names to exclude from the gallery. + Defaults to [] (none). includedTags[] : Glob patterns of tags to include in the gallery. @@ -144,8 +155,7 @@ tagCategories[] Defaults to [] (none). tagsFromDirectories.fromParents -: Automatically generate tags from the name of parent directories, - looking up in the hierarchy as far as indicated by this parameter. +: Automatically generate tags from the name of parent directories, looking up in the hierarchy as far as indicated by this parameter. Defaults to 0 (does not generate tags from parent directories). tagsFromDirectories.prefix @@ -172,4 +182,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 . 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