aboutsummaryrefslogtreecommitdiff
path: root/ldgallery.1.md
diff options
context:
space:
mode:
Diffstat (limited to 'ldgallery.1.md')
-rw-r--r--ldgallery.1.md29
1 files changed, 18 insertions, 11 deletions
diff --git a/ldgallery.1.md b/ldgallery.1.md
index f071344..17056ce 100644
--- a/ldgallery.1.md
+++ b/ldgallery.1.md
@@ -2,7 +2,7 @@
2pagetitle: User manual - ldgallery 2pagetitle: User manual - ldgallery
3title: LDGALLERY(1) ldgallery user manual 3title: LDGALLERY(1) ldgallery user manual
4author: Pacien TRAN-GIRARD, Guillaume FOUET 4author: Pacien TRAN-GIRARD, Guillaume FOUET
5date: 2020-01-05 (v0.1.0.0-SNAPSHOT) 5date: 2020-02-15 (v0.1.0.0-SNAPSHOT)
6--- 6---
7 7
8 8
@@ -55,7 +55,8 @@ Available options are:
55# INPUT GALLERY STRUCTURE 55# INPUT GALLERY STRUCTURE
56 56
57A gallery source directory contains the gallery items and their sidecar metadata files, optionally grouped inside sub-directories. 57A gallery source directory contains the gallery items and their sidecar metadata files, optionally grouped inside sub-directories.
58Directory thumbnails can be set by placing a picture file named "thumbnail", with any image file extension, inside of it. 58
59Directory thumbnails can be set by placing a picture file named "thumbnail", with any image file extension, inside of directories.
59 60
60An example input gallery directory structure could be as follows: 61An example input gallery directory structure could be as follows:
61 62
@@ -65,6 +66,7 @@ An example input gallery directory structure could be as follows:
65├── DSC0001.jpg.yaml ---- its associated sidecar metadata file 66├── DSC0001.jpg.yaml ---- its associated sidecar metadata file
66├── Some directory ------ a directory grouping gallery items 67├── Some directory ------ a directory grouping gallery items
67│ ├── thumbnail.jpg --- a thumbnail for its parent directory 68│ ├── thumbnail.jpg --- a thumbnail for its parent directory
69│ ├── directory.yaml -- directory sidecar metadata file
68│ ├── DSC0002.jpg 70│ ├── DSC0002.jpg
69│ ├── DSC0002.jpg.yaml 71│ ├── DSC0002.jpg.yaml
70│ ├── DSC0003.jpg 72│ ├── DSC0003.jpg
@@ -73,32 +75,37 @@ An example input gallery directory structure could be as follows:
73``` 75```
74 76
75 77
76# ITEM METADATA SIDECAR 78# METADATA SIDECAR
77 79
78Item metadata are read from sidecar files of the same name, with the ".yaml" extension appended. 80File metadata are read from sidecar files of the same name, with the ".yaml" extension appended.
79When a sidecar file is absent or a particular key omitted, values are set as empty or to their fallback value specified below.
80Metadata contained within item files themselves (e.g. Exif fields for pictures) are ignored. 81Metadata contained within item files themselves (e.g. Exif fields for pictures) are ignored.
81 82
83Directory metadata are read from sidecar files named "directory.yaml" located within the directory.
84
85When a sidecar file is absent or a particular key omitted, values are set as empty or to their fallback value specified below.
86
82title 87title
83: Title of the item. Defaults to the name of the file. 88: Title of the item.
89 Defaults to the name of the file or directory.
84 90
85datetime 91datetime
86: ISO 8601 zoned date and time. Defaults to the last modification time of the file. 92: ISO 8601 zoned date and time.
93 Defaults to the last modification time of the file itself,
94 or the most recent modification date of a directory's items.
87 95
88description 96description
89: Description for the item. 97: Description for the item.
90 98
91tags 99tags
92: List of tags for the item. Tag groups can be defined using prefixes separated by "." (dot). 100: List of tags for the item.
101 Tag groups can be defined using prefixes separated by "." (dot).
102 Tags specified in a directory metadata sidecar are applied to all items within that directory.
93 103
94 104
95# GALLERY CONFIGURATION 105# GALLERY CONFIGURATION
96 106
97The gallery settings reside in a file named "gallery.yaml" located at the root of the gallery's source directory. 107The gallery settings reside in a file named "gallery.yaml" located at the root of the gallery's source directory.
98 108
99compiler.galleryName
100: Name of the gallery. Defaults to "Gallery".
101
102compiler.includedDirectories[] 109compiler.includedDirectories[]
103: Glob patterns of directory names to include in the gallery. Defaults to ["*"] (matches all directory names). 110: Glob patterns of directory names to include in the gallery. Defaults to ["*"] (matches all directory names).
104 111