From 1729def261944ac6239469345d1b5f303d11aeef Mon Sep 17 00:00:00 2001 From: blissful Date: Mon, 6 May 2024 13:47:46 -0400 Subject: [PATCH] update docs --- docs/TEMPLATES.md | 18 ++++++++++++++++++ docs/VIRTUAL_FILESYSTEM.md | 22 ++++++++++++---------- 2 files changed, 30 insertions(+), 10 deletions(-) diff --git a/docs/TEMPLATES.md b/docs/TEMPLATES.md index 82150cd..715da37 100644 --- a/docs/TEMPLATES.md +++ b/docs/TEMPLATES.md @@ -15,26 +15,37 @@ templates are: [path_templates] default.release = "..." default.track = "..." +default.all_tracks = "..." source.release = "..." source.track = "..." +source.all_tracks = "..." releases.release = "..." releases.track = "..." +releases.all_tracks = "..." releases_new.release = "..." releases_new.track = "..." +releases_new.all_tracks = "..." releases_added_on.release = "..." releases_added_on.track = "..." +releases_added_on.all_tracks = "..." releases_released_on.release = "..." releases_released_on.track = "..." +releases_released_on.all_tracks = "..." artists.release = "..." artists.track = "..." +artists.all_tracks = "..." genres.release = "..." genres.track = "..." +genres.all_tracks = "..." descriptors.release = "..." descriptors.track = "..." +descriptors.all_tracks = "..." labels.release = "..." labels.track = "..." +labels.all_tracks = "..." collages.release = "..." collages.track = "..." +collages.all_tracks = "..." playlists = "..." ``` @@ -55,6 +66,13 @@ If set, the `default.xxx` templates are used as the default values for all other {% if disctotal > 1 %}{{ discnumber.rjust(2, '0') }}-{% endif %}{{ tracknumber.rjust(2, '0') }}. {{ tracktitle }} {% if trackartists.guest %}(feat. {{ trackartists.guest | artistsarrayfmt }}){% endif %} + +{# "Default Default" All Tracks Template #} + +{{ trackartists | artistsfmt }} - +{% if releasedate %}{{ releasedate.year }}.{% endif %} +{{ releasetitle }} - +{{ tracktitle }} ``` # Template Language diff --git a/docs/VIRTUAL_FILESYSTEM.md b/docs/VIRTUAL_FILESYSTEM.md index 0ac800b..d6984be 100644 --- a/docs/VIRTUAL_FILESYSTEM.md +++ b/docs/VIRTUAL_FILESYSTEM.md @@ -16,16 +16,18 @@ if the virtual filesystem is currently in use, unmounting command will fail. # Directory Structure -Rosé has 8 top-level directories, each of which is a different view into the library. They are: +Rosé has 10 top-level directories, each of which is a different view into the library. They are: 1. `Releases` 2. `Releases - New` 3. `Releases - Recently Added` -4. `Artists` -5. `Genres` -6. `Labels` -7. `Collages` -8. `Playlists` +4. `Releases - Added On` +5. `Artists` +6. `Genres` +7. `Descriptors` +8. `Labels` +9. `Collages` +10. `Playlists` Each directory should be fairly intuitive. They are numbered in the filesystem to create an intentional ordering. @@ -45,10 +47,10 @@ source directory. Rosé also exposes the `.rose.{uuid}.toml` datafile in the vir # Hiding Artists, Genres, and Labels -Rosé supports hiding individual artists, genres, and labels in their view directories (`4. Artists`, -`5. Genres`, and `6. Labels`) with the `vfs.x_blacklist` and `vfs.x_whitelist` configuration -parameters. See [Configuration](./CONFIGURATION.md) for additional documentation on configuring the -blacklist or whitelist. +Rosé supports hiding individual artists, genres, and labels in their view directories (`Artists`, +`Genres`, and `Labels`) with the `vfs.x_blacklist` and `vfs.x_whitelist` configuration parameters. +See [Configuration](./CONFIGURATION.md) for additional documentation on configuring the blacklist or +whitelist. # Operations