aboutsummaryrefslogtreecommitdiff
path: root/compiler/ldgallery.1.md
diff options
context:
space:
mode:
Diffstat (limited to 'compiler/ldgallery.1.md')
-rw-r--r--compiler/ldgallery.1.md31
1 files changed, 21 insertions, 10 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 @@
2pagetitle: Compiler user manual - ldgallery 2pagetitle: Compiler user manual - ldgallery
3title: LDGALLERY(1) ldgallery 3title: LDGALLERY(1) ldgallery
4author: Pacien TRAN-GIRARD, Guillaume FOUET 4author: Pacien TRAN-GIRARD, Guillaume FOUET
5date: 2020-02-15 (v0.1.0.0-SNAPSHOT) 5date: 2020-04-17 (v1.0-SNAPSHOT)
6--- 6---
7 7
8 8
@@ -15,7 +15,9 @@ ldgallery - a static web gallery generator with tags
15 15
16ldgallery is a static gallery generator which turns a collection of tagged pictures into a searchable web gallery. 16ldgallery is a static gallery generator which turns a collection of tagged pictures into a searchable web gallery.
17 17
18The 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. 18The ldgallery compiler program processes pictures and aggregates metadata from plain text sidecar files to generate an indexed version of the gallery.
19It can optionally output a static web viewer along, which allows the content to be presented and searched through from a JavaScript-enabled web browser.
20This client-side web application does not require any special software on the server's side.
19 21
20 22
21# COMMAND 23# COMMAND
@@ -97,13 +99,17 @@ title
97: Title of the item. 99: Title of the item.
98 Defaults to the name of the file or directory. 100 Defaults to the name of the file or directory.
99 101
102<!-- not used in the viewer yet --
100datetime 103datetime
101: ISO 8601 zoned date and time. 104: ISO 8601 zoned date and time.
102 Defaults to the last modification time of the file itself, 105 Defaults to the last modification time of the file itself,
103 or the most recent modification date of a directory's items. 106 or the most recent modification date of a directory's items.
107-->
104 108
109<!-- not used in the viewer yet --
105description 110description
106: Description for the item. 111: Description for the item.
112-->
107 113
108tags 114tags
109: List of tags for the item. 115: List of tags for the item.
@@ -116,19 +122,24 @@ tags
116The gallery settings reside in a file named "gallery.yaml" located at the root of the gallery's source directory. 122The gallery settings reside in a file named "gallery.yaml" located at the root of the gallery's source directory.
117 123
118galleryTitle 124galleryTitle
119: Title of the gallery. Defaults to "ldgallery". 125: Title of the gallery.
126 Defaults to "ldgallery".
120 127
121includedDirectories[] 128includedDirectories[]
122: Glob patterns of directory names to include in the gallery. Defaults to ["*"] (matches all directory names). 129: Glob patterns of directory names to include in the gallery.
130 Defaults to ["*"] (matches all directory names).
123 131
124excludedDirectories[] 132excludedDirectories[]
125: Glob patterns of directory names to exclude from the gallery. Defaults to [] (none). 133: Glob patterns of directory names to exclude from the gallery.
134 Defaults to [] (none).
126 135
127includedFiles[] 136includedFiles[]
128: Glob patterns of file names to include in the gallery. Defaults to ["*"] (matches all file names). 137: Glob patterns of file names to include in the gallery.
138 Defaults to ["*"] (matches all file names).
129 139
130excludedFiles[] 140excludedFiles[]
131: Glob patterns of file names to exclude from the gallery. Defaults to [] (none). 141: Glob patterns of file names to exclude from the gallery.
142 Defaults to [] (none).
132 143
133includedTags[] 144includedTags[]
134: Glob patterns of tags to include in the gallery. 145: Glob patterns of tags to include in the gallery.
@@ -144,8 +155,7 @@ tagCategories[]
144 Defaults to [] (none). 155 Defaults to [] (none).
145 156
146tagsFromDirectories.fromParents 157tagsFromDirectories.fromParents
147: Automatically generate tags from the name of parent directories, 158: Automatically generate tags from the name of parent directories, looking up in the hierarchy as far as indicated by this parameter.
148 looking up in the hierarchy as far as indicated by this parameter.
149 Defaults to 0 (does not generate tags from parent directories). 159 Defaults to 0 (does not generate tags from parent directories).
150 160
151tagsFromDirectories.prefix 161tagsFromDirectories.prefix
@@ -172,4 +182,5 @@ Copyright (C) 2019-2020 Pacien TRAN-GIRARD and Guillaume FOUET.
172 182
173This 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. 183This 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.
174 184
175This 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>. 185This 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.
186See the GNU Affero General Public License for more details <https://www.gnu.org/licenses/agpl-3.0.html>.