A photoblog of my adventures. https://odyssey.neophilus.net
If you wish to use something similar, there are a few conventions you need to abide by.
Odyssey assumes all images reside in
dist/gallery under a directory structure that follows
<year>/<month>/<country>/<location>, for example
Places and countries with spaces in their names should be rendered as
Image files can be named however you wish.
Once your files are stored correctly in the gallery structure there is one important file to maintain.
manifester/odyssey.yaml takes care of two lists:
Places requires a list of all countries in the gallery with sub-lists of locations in the gallery. As Odyssey is targeting English, local names can be stored here and will be incorporated into the gallery. The local name for a country should be a sub-list element:
Norway: Local: Norge
Locations can be the value corresponding to the sub-list's key:
So a complete example could be:
places: Sweden: Local: Sverige Are: Åre Gothenburg: Göteborg Stockholm:
The Trips list is a little more involved, but needs to be so that the paths that are traced on the globe look like you'd anticipate.
Here's an example from my trip list to study:
trips: - name: S16 description: Summer 2016 cities: - Gothenburg - Frankfurt - Vienna - Yerevan - Vienna - Frankfurt - Gothenburg - Tallinn - Helsinki - Gothenburg - Stockholm - Gothenburg - Copenhagen - Crete - Athens - Frankfurt - Freiburg - Frankfurt - Gothenburg dates: - 2016/05 - 2016/06 - 2016/07 - 2016/09
nameis an identifier that is used internally to identify each trip. Choose a short but unique ID.
descriptionis the one that shows up in the filter list in the menu, as well as the URL.
citiesis a list of locations visited, in order on your trip. You can easily see that I was living in Gothenburg in 2016, since I start and end there, as well as stopped by multiple times during
Summer 2016. The world map traces this list and puts a line between each pair in the list. It makes sense that my day trip to
Stockholmis sandwiched between two
Gothenburgs—otherwise the world map would show me jumping from
Copenhagen, which didn't happen.
datesis a crude but effective method of filtering trips. Simply list the months your trip was on here, and the gallery will grab all images from the list of cities within the time-frame of the months listed here.
The manifester generates empty
.desc files for each image if one doesn't exist.
If you wish to add a short description to a photo, write it in this file and the manifester will add it next pass.
This file is not escaped, so please use
\" if you need quotations in your description.
If you wish to assign a license to the images in your gallery, use the
Initially, you'll want to rename the
manifester/attribution.example.yaml file to
I've done this so that users just trying this repo out, don't apply my personal attribution to their photos accidentally.
Marked will be set to false, thus skipping this step in the manifest building process.
Switching this value to true will turn on a routine the will inject xmp metadata into each of your images.
It will not alter any other exif data, but will overwrite any licensing data that may exist on your image already.
This is not ideal and will be fixed in the future.
In general though, this allows you to play around with your attribution file and each manifest build will change the agreement metadata in your images.
Choosing a license
I'd recommend a Creative Commons license. Many of which allow copying freely, but also have options for a non-commercial use clause. This is what I choose: Creative Commons Attribution-NonCommercial-Share Alike 4.0 International License
Creative Commons have a great selector on their website with ample information about each choice.
At the moment, the routines herein only support the CC scheme, so if you'd like to include something other than their licenses, please file an issue.
Updating a gallery
Once your files are organised, you can build your manifest by calling
make manifest. This will generate all needed code for the updated
make serve will do this for you.
deploy is a one-command update and upload trigger, so if you've just added images and nothing else, this is the only tool you want.
make debug gives you the Elm time-travelling debugger when live-previewing your changes.
Images in this gallery are licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. Contact me directly if you wish to use an image for commercial purposes.
Code for this gallery is released under the BSD 3-Clause "New" or "Revised" License, in line with most Elm libraries used within.