Merge branch 'develop': release v1.0v1.0

16 files changed, 78 insertions, 66 deletions

diff --git a/example/.gitignore b/example/.gitignore
index c5ae58b..1fcb152 100644
--- a/example/.gitignore
+++ b/example/.gitignore
@@ -1,3 +1 @@
 out
-items
-thumbnails
\ No newline at end of file
diff --git a/example/Glacier 3000/_DSC5475.jpg.yaml b/example/Glacier 3000/_DSC5475.jpg.yaml
deleted file mode 100644
index 3454a68..0000000
--- a/example/Glacier 3000/_DSC5475.jpg.yaml
+++ /dev/null
@@ -1,15 +0,0 @@
-title: Fog 3000
-
-datetime: 2019-08-10T14:38:47+01:00
-
-description: >
-  © Philippe NGUYEN
-
-tags:
-  - photographer.nphilou
-  - location.switzerland.ormont-dessus
-  - glacier3000
-  - time.day
-  - weather.foggy
-  - forest
-  - trees
diff --git a/example/Glacier 3000/_DSC5542.jpg.yaml b/example/Glacier 3000/_DSC5542.jpg.yaml
deleted file mode 100644
index d174911..0000000
--- a/example/Glacier 3000/_DSC5542.jpg.yaml
+++ /dev/null
@@ -1,15 +0,0 @@
-title: Foggy catwalk
-
-datetime: 2019-08-10T16:00:45+01:00
-
-description: >
-  © Philippe NGUYEN
-
-tags:
-  - photographer.nphilou
-  - location.switzerland.ormont-dessus
-  - glacier3000
-  - time.day
-  - weather.foggy
-  - catwalk
-  - mountain
diff --git a/example/config.json b/example/config.json
new file mode 100644
index 0000000..6483257
--- /dev/null
+++ b/example/config.json
@@ -0,0 +1,3 @@
+{
+    "galleryRoot": "out/"
+}
diff --git a/example/gallery.yaml b/example/gallery.yaml
deleted file mode 100644
index ccdb16b..0000000
--- a/example/gallery.yaml
+++ /dev/null
@@ -1,21 +0,0 @@
-compiler:
-  galleryName: Example gallery
-
-  includeFiles:
-  - "*.jpg"
-
-  #excludeFiles:
-  #- "*.md"
-
-  tagsFromDirectories: 0 # default
-
-  thumbnailMaxResolution:
-    width: 400  # default
-    height: 400 # default
-
-  pictureMaxResolution:
-    width: 1024
-    height: 768
-
-
-viewer: {}
diff --git a/example/readme.md b/example/readme.md
index d5a7563..2c03260 100644
--- a/example/readme.md
+++ b/example/readme.md
@@ -8,15 +8,16 @@ Content
 -------
 
 ```
-./example
-├── _DSC8808-1.jpg           -- a picture
-├── _DSC8808-1.jpg.yaml      -- its associated sidecar metadata file
-├── Glacier 3000             -- a directory grouping gallery items
-│   ├── thumbnail.jpg        -- a thumbnail for the "Glacier 3000" directory
-│   ├── _DSC5475.jpg
-│   ├── _DSC5475.jpg.yaml
-│   ├── _DSC5542.jpg
-│   └── _DSC5542.jpg.yaml
-├── gallery.yaml             -- gallery settings file
-└── readme.md                -- this README
+./example/out ----------- the output directory for the compiled version of the gallery
+./example/src ----------- source directory with pictures, configuration, tags and metadata
+├── DSC0001.jpg --------- a picture
+├── DSC0001.jpg.yaml ---- its associated sidecar metadata file
+├── Ormont-Dessus ------- a directory grouping gallery items
+│   ├── _directory.jpg -- a thumbnail for its parent directory
+│   ├── _directory.yaml - directory sidecar metadata file
+│   ├── DSC0002.jpg
+│   ├── DSC0002.jpg.yaml
+│   ├── DSC0003.jpg
+│   └── DSC0003.jpg.yaml
+└── gallery.yaml -------- gallery settings file
 ```
diff --git a/example/_DSC8808-1.jpg b/example/src/DSC0001.jpg
index 51b43b0..51b43b0 100644
--- a/example/_DSC8808-1.jpg
+++ b/example/src/DSC0001.jpg
diff --git a/example/_DSC8808-1.jpg.yaml b/example/src/DSC0001.jpg.yaml
index b946ff7..cca1379 100644
--- a/example/_DSC8808-1.jpg.yaml
+++ b/example/src/DSC0001.jpg.yaml
@@ -6,7 +6,7 @@ description: >
   © Philippe NGUYEN
 
 tags:
-  - photographer.nphilou
-  - location.germany.berlin
+  - photographer:nphilou
+  - location:germany:berlin
   - books
   - book-shop
diff --git a/example/Glacier 3000/_DSC5542.jpg b/example/src/Ormont-Dessus/DSC0002.jpg
index 19a716e..19a716e 100644
--- a/example/Glacier 3000/_DSC5542.jpg
+++ b/example/src/Ormont-Dessus/DSC0002.jpg
diff --git a/example/src/Ormont-Dessus/DSC0002.jpg.yaml b/example/src/Ormont-Dessus/DSC0002.jpg.yaml
new file mode 100644
index 0000000..a69deb9
--- /dev/null
+++ b/example/src/Ormont-Dessus/DSC0002.jpg.yaml
@@ -0,0 +1,13 @@
+title: Walking towards the unknown
+
+datetime: 2019-08-10T16:00:45+01:00
+
+description: >
+  © Philippe NGUYEN
+
+tags:
+  - photographer:nphilou
+  - time:day
+  - weather:foggy
+  - catwalk
+  - mountain
diff --git a/example/Glacier 3000/_DSC5475.jpg b/example/src/Ormont-Dessus/DSC0003.jpg
index 9835447..9835447 100644
--- a/example/Glacier 3000/_DSC5475.jpg
+++ b/example/src/Ormont-Dessus/DSC0003.jpg
diff --git a/example/src/Ormont-Dessus/DSC0003.jpg.yaml b/example/src/Ormont-Dessus/DSC0003.jpg.yaml
new file mode 100644
index 0000000..558f921
--- /dev/null
+++ b/example/src/Ormont-Dessus/DSC0003.jpg.yaml
@@ -0,0 +1,13 @@
+title: Diffusion
+
+datetime: 2019-08-10T14:38:47+01:00
+
+description: >
+  © Philippe NGUYEN
+
+tags:
+  - photographer:nphilou
+  - time:day
+  - weather:foggy
+  - forest
+  - trees
diff --git a/example/Glacier 3000/thumbnail.jpg b/example/src/Ormont-Dessus/_directory.jpg
index 19a716e..19a716e 100644
--- a/example/Glacier 3000/thumbnail.jpg
+++ b/example/src/Ormont-Dessus/_directory.jpg
diff --git a/example/src/Ormont-Dessus/_directory.yaml b/example/src/Ormont-Dessus/_directory.yaml
new file mode 100644
index 0000000..5b3e0c7
--- /dev/null
+++ b/example/src/Ormont-Dessus/_directory.yaml
@@ -0,0 +1,3 @@
+# The following tags are applied to all items in the directory
+tags:
+  - location:switzerland:ormont-dessus
diff --git a/example/src/_directory.yaml b/example/src/_directory.yaml
new file mode 100644
index 0000000..ab81bb2
--- /dev/null
+++ b/example/src/_directory.yaml
@@ -0,0 +1 @@
+title: Example gallery
diff --git a/example/src/gallery.yaml b/example/src/gallery.yaml
new file mode 100644
index 0000000..b569910
--- /dev/null
+++ b/example/src/gallery.yaml
@@ -0,0 +1,31 @@
+# ldgallery example gallery configuration file
+
+#galleryTitle: "ldgallery"
+
+#includedDirectories: ["*"]
+#excludedDirectories: []
+
+includedFiles:
+  - '*.jpg'
+
+#excludedFiles:
+#  - "*.md"
+
+#includedTags: ["*"]
+#excludedTags: []
+
+tagCategories:
+  - photographer
+  - location
+
+#tagsFromDirectories:
+#  fromParents: 0
+#  prefix: ''
+
+#thumbnailMaxResolution:
+#  width: 400
+#  height: 300
+
+pictureMaxResolution:
+  width: 1024
+  height: 768