Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
azuline committed May 6, 2024
1 parent 8d9c2c3 commit 1729def
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 10 deletions.
18 changes: 18 additions & 0 deletions docs/TEMPLATES.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 = "..."
```

Expand All @@ -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
Expand Down
22 changes: 12 additions & 10 deletions docs/VIRTUAL_FILESYSTEM.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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

Expand Down

0 comments on commit 1729def

Please sign in to comment.