diff options
Diffstat (limited to 'compiler')
-rw-r--r-- | compiler/ldgallery.1.md | 34 |
1 files changed, 18 insertions, 16 deletions
diff --git a/compiler/ldgallery.1.md b/compiler/ldgallery.1.md index 2fbddc5..eda6cc2 100644 --- a/compiler/ldgallery.1.md +++ b/compiler/ldgallery.1.md | |||
@@ -2,7 +2,7 @@ | |||
2 | pagetitle: Compiler user manual - ldgallery | 2 | pagetitle: Compiler user manual - ldgallery |
3 | title: LDGALLERY(1) ldgallery | 3 | title: LDGALLERY(1) ldgallery |
4 | author: Pacien TRAN-GIRARD, Guillaume FOUET | 4 | author: Pacien TRAN-GIRARD, Guillaume FOUET |
5 | date: 2020-04-30 (v1.0) | 5 | date: 2020-09-19 (v2.0) |
6 | --- | 6 | --- |
7 | 7 | ||
8 | 8 | ||
@@ -13,7 +13,7 @@ ldgallery - a static web gallery generator with tags | |||
13 | 13 | ||
14 | # DESCRIPTION | 14 | # DESCRIPTION |
15 | 15 | ||
16 | ldgallery is a static gallery generator which turns a collection of tagged pictures into a searchable web gallery. | 16 | ldgallery is a static gallery generator which turns a collection of tagged media files into a searchable web gallery. |
17 | 17 | ||
18 | The ldgallery compiler program processes pictures and aggregates metadata from plain text sidecar files to generate an indexed version of the gallery. | 18 | The ldgallery compiler program processes pictures and aggregates metadata from plain text sidecar files to generate an indexed version of the gallery. |
19 | 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. | 19 | 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. |
@@ -45,6 +45,7 @@ Available options are: | |||
45 | 45 | ||
46 | -r, \--rebuild-all | 46 | -r, \--rebuild-all |
47 | : Invalidate cache and recompile everything. | 47 | : Invalidate cache and recompile everything. |
48 | By default, the compiler skips items which haven't changed based on their modification time. | ||
48 | 49 | ||
49 | -c, \--clean-output | 50 | -c, \--clean-output |
50 | : Remove unnecessary files from the output directory. | 51 | : Remove unnecessary files from the output directory. |
@@ -67,8 +68,8 @@ Available options are: | |||
67 | 68 | ||
68 | A gallery source directory contains the gallery items and their sidecar metadata files, optionally grouped inside sub-directories. | 69 | A gallery source directory contains the gallery items and their sidecar metadata files, optionally grouped inside sub-directories. |
69 | 70 | ||
70 | Thumbnails can be associated to items by suffixing their name with "_thumbnail", followed by an image file extension. | 71 | Thumbnails can be associated to items by suffixing their name with "\_thumbnail", followed by an image file extension. |
71 | Directory thumbnails can be placed within their repsective directories themselves, without any prefix. | 72 | Directory thumbnails can be placed within their respective directories themselves, without any prefix. |
72 | 73 | ||
73 | An example input gallery directory structure could be as follows: | 74 | An example input gallery directory structure could be as follows: |
74 | 75 | ||
@@ -84,7 +85,7 @@ An example input gallery directory structure could be as follows: | |||
84 | │ ├── song.ogg | 85 | │ ├── song.ogg |
85 | │ ├── song.ogg.yaml | 86 | │ ├── song.ogg.yaml |
86 | │ └── song.ogg_thumbnail.jpg -- a thumbnail for song.ogg | 87 | │ └── song.ogg_thumbnail.jpg -- a thumbnail for song.ogg |
87 | └── gallery.yaml -888------------ gallery settings file | 88 | └── gallery.yaml ---------------- gallery settings file |
88 | ``` | 89 | ``` |
89 | 90 | ||
90 | 91 | ||
@@ -93,7 +94,7 @@ An example input gallery directory structure could be as follows: | |||
93 | File metadata are read from sidecar files of the same name, with the ".yaml" extension appended. | 94 | File metadata are read from sidecar files of the same name, with the ".yaml" extension appended. |
94 | Metadata contained within item files themselves (e.g. Exif fields for pictures) are ignored. | 95 | Metadata contained within item files themselves (e.g. Exif fields for pictures) are ignored. |
95 | 96 | ||
96 | Directory metadata are read from sidecar files named "_directory.yaml" located within the directory. | 97 | Directory metadata are read from sidecar files named "\_directory.yaml" located within the directory. |
97 | 98 | ||
98 | When a sidecar file is absent or a particular key omitted, values are set as empty or to their fallback value specified below. | 99 | When a sidecar file is absent or a particular key omitted, values are set as empty or to their fallback value specified below. |
99 | 100 | ||
@@ -101,17 +102,16 @@ title | |||
101 | : Title of the item. | 102 | : Title of the item. |
102 | Defaults to the name of the file or directory. | 103 | Defaults to the name of the file or directory. |
103 | 104 | ||
104 | <!-- not used in the viewer yet -- | ||
105 | datetime | 105 | datetime |
106 | : ISO 8601 zoned date and time. | 106 | : ISO 8601 zoned date and time. |
107 | Defaults to the last modification time of the file itself, | 107 | Defaults to the last modification time of the file itself, |
108 | or the most recent modification date of a directory's items. | 108 | or the most recent modification date of a directory's items. |
109 | --> | ||
110 | 109 | ||
111 | <!-- not used in the viewer yet -- | ||
112 | description | 110 | description |
113 | : Description for the item. | 111 | : Optional description for the item. |
114 | --> | 112 | Rich text formatting is possible through the use of the [GitHub Flavoured Markdown syntax][GFM]. |
113 | |||
114 | [GFM]: https://github.github.com/gfm/ | ||
115 | 115 | ||
116 | tags | 116 | tags |
117 | : List of tags for the item. | 117 | : List of tags for the item. |
@@ -121,7 +121,9 @@ tags | |||
121 | 121 | ||
122 | # GALLERY CONFIGURATION | 122 | # GALLERY CONFIGURATION |
123 | 123 | ||
124 | The gallery settings reside in a file named "gallery.yaml" located at the root of the gallery's source directory. | 124 | The gallery settings reside in a file named __gallery.yaml__ located at the root of the gallery's source directory. |
125 | |||
126 | Gallery configurations options are: | ||
125 | 127 | ||
126 | galleryTitle | 128 | galleryTitle |
127 | : Title of the gallery. | 129 | : Title of the gallery. |
@@ -129,7 +131,7 @@ galleryTitle | |||
129 | 131 | ||
130 | includedDirectories[] | 132 | includedDirectories[] |
131 | : Glob patterns of directory names to include in the gallery. | 133 | : Glob patterns of directory names to include in the gallery. |
132 | Defaults to ["*"] (matches all directory names). | 134 | Defaults to ["\*"] (matches all directory names). |
133 | 135 | ||
134 | excludedDirectories[] | 136 | excludedDirectories[] |
135 | : Glob patterns of directory names to exclude from the gallery. | 137 | : Glob patterns of directory names to exclude from the gallery. |
@@ -137,7 +139,7 @@ excludedDirectories[] | |||
137 | 139 | ||
138 | includedFiles[] | 140 | includedFiles[] |
139 | : Glob patterns of file names to include in the gallery. | 141 | : Glob patterns of file names to include in the gallery. |
140 | Defaults to ["*"] (matches all file names). | 142 | Defaults to ["\*"] (matches all file names). |
141 | 143 | ||
142 | excludedFiles[] | 144 | excludedFiles[] |
143 | : Glob patterns of file names to exclude from the gallery. | 145 | : Glob patterns of file names to exclude from the gallery. |
@@ -146,7 +148,7 @@ excludedFiles[] | |||
146 | includedTags[] | 148 | includedTags[] |
147 | : Glob patterns of tags to include in the gallery. | 149 | : Glob patterns of tags to include in the gallery. |
148 | Items with no tags can be matched with the empty pattern. | 150 | Items with no tags can be matched with the empty pattern. |
149 | Defaults to ["*"] (matches all tags, includes untagged items). | 151 | Defaults to ["\*"] (matches all tags, includes untagged items). |
150 | 152 | ||
151 | excludedTags[] | 153 | excludedTags[] |
152 | : Glob patterns of tags to exclude from the gallery. | 154 | : Glob patterns of tags to exclude from the gallery. |
@@ -178,7 +180,7 @@ pictureMaxResolution.height | |||
178 | 180 | ||
179 | # SEE ALSO | 181 | # SEE ALSO |
180 | 182 | ||
181 | Related manual pages: __ldgallery-quickstart__(7), __ldgallery-viewer__(7) | 183 | Related manual pages: __ldgallery-quickstart__(7), __ldgallery-viewer__(7). |
182 | 184 | ||
183 | The ldgallery source code is available on <https://ldgallery.pacien.org>. | 185 | The ldgallery source code is available on <https://ldgallery.pacien.org>. |
184 | 186 | ||