Skip to content

Commit d4da4b5

Browse files
sentrizsentriz
committed
update readme
1 parent 3d7fa95 commit d4da4b5

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

‎README.md‎

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ To describe the general workflow:
6666
- **Cover fetching** or upgrades from the [Cover Art Archive](https://coverartarchive.org/).
6767
- Care taken to ensure **no orphan** folders are left in the library when moves or copies occur.
6868
- Validation to ensure your library is **always consistent** with no duplicates or unrecognised paths.
69-
- Proper **multi-disc** release handling with correct disc numbers and subtitles.
69+
- Proper **multi-disc/media** release handling with disc/media numbers and subtitles.
7070
- Safe **concurrent** processing with tree-style filesystem locking.
7171
- Addons for fetching lyrics, calculating [ReplayGain](https://wiki.hydrogenaud.io/index.php?title=ReplayGain_2.0_specification), or any user-defined subprocess.
7272
- Rescanning the library and processing it for new changes in MusicBrainz (`wrtag sync`).
@@ -518,7 +518,7 @@ path-format C:\User\John\Music\{{ <some artist format> }}\({{ <some release form
518518
```
519519
520520
> [!NOTE]
521-
> Path formats are validated to ensure that all tracks from a release (including multi-disc releases) are placed in the same directory. If your format uses `.Media` fields in the directory portion (not just the filename), validation will fail.
521+
> Path formats are validated to ensure that all tracks from a release (including multi-disc/media releases) are placed in the same directory. If your format uses `.Media` fields in the directory portion (not just the filename), validation will fail.
522522
523523
## Available template data
524524
@@ -527,13 +527,13 @@ The template has access to the following data:
527527
- `.Release` - The full MusicBrainz release object (see [`type Release struct {`](https://github.com/sentriz/wrtag/blob/master/musicbrainz/musicbrainz.go))
528528
- `.ReleaseDisambiguation` - A string for release and release group disambiguation
529529
- `.IsCompilation` - Boolean indicating if this is a compilation album
530-
- `.Media` - The current media/disc being processed (see [`type Media struct {`](https://github.com/sentriz/wrtag/blob/master/musicbrainz/musicbrainz.go))
531-
- `.Media.Position` - Disc number (1, 2, 3...)
532-
- `.Media.TrackCount` - Total tracks on this disc
533-
- `.Media.Title` - Disc subtitle (if any)
530+
- `.Media` - The current disc/media being processed (see [`type Media struct {`](https://github.com/sentriz/wrtag/blob/master/musicbrainz/musicbrainz.go))
531+
- `.Media.Position` - Media number (1, 2, 3...)
532+
- `.Media.TrackCount` - Total tracks on this media
533+
- `.Media.Title` - Media subtitle (if any)
534534
- `.Media.Format` - Media format (e.g., "CD", "Vinyl")
535535
- `.Track` - The current track being processed (see [`type Track struct {`](https://github.com/sentriz/wrtag/blob/master/musicbrainz/musicbrainz.go))
536-
- `.Track.Position` - Track number on the disc (1, 2, 3...)
536+
- `.Track.Position` - Track number on the media (1, 2, 3...)
537537
- `.Track.Number` - Track number as string (e.g., "1", "A1" for vinyl)
538538
- `.Track.Title` - Track title
539539
- `.Track.Artists` - Track artists
@@ -567,7 +567,7 @@ In addition to what's provided by Go [text/template](https://pkg.go.dev/text/tem
567567
568568
### The recommended format
569569
570-
Including multi-album artist support, release group year, release group and release disambiguations, disc number prefix for multi-disc releases, track numbers, total track numbers, artist names if the release is a compilation album:
570+
Including multi-album artist support, release group year, release group and release disambiguations, disc/media number prefix for multi-media releases, track numbers, total track numbers, artist names if the release is a compilation album:
571571
572572
```
573573
/music/{{ artists .Release.Artists | sort | join "; " | safepath }}/({{ .Release.ReleaseGroup.FirstReleaseDate.Year }}) {{ .Release.Title | safepath }}{{ if not (eq .ReleaseDisambiguation "") }} ({{ .ReleaseDisambiguation | safepath }}){{ end }}/{{ if gt (len .Release.Media) 1 }}d{{ pad0 2 .Media.Position }} {{ end }}{{ pad0 2 .Track.Position }}.{{ .Media.TrackCount | pad0 2 }} {{ if .IsCompilation }}{{ artistsString .Track.Artists | safepath }} - {{ end }}{{ .Track.Title | safepath }}{{ .Ext }}
@@ -597,7 +597,7 @@ Including multi-album artist support, release group year, release group and rele
597597
/music/{{ artists .Release.Artists | sort | join "; " | safepath }}/({{ .Release.ReleaseGroup.FirstReleaseDate.Year }}) {{ .Release.Title | safepath }}/{{ pad0 2 .Track.Position }}.{{ .Media.TrackCount | pad0 2 }} {{ .Track.Title | safepath }}{{ .Ext }}
598598
```
599599
600-
### With disc number for multi-disc releases
600+
### With disc/media number for multi-media releases
601601
602602
```
603603
/music/{{ artists .Release.Artists | sort | join "; " | safepath }}/({{ .Release.ReleaseGroup.FirstReleaseDate.Year }}) {{ .Release.Title | safepath }}/{{ .Media.Position }}-{{ pad0 2 .Track.Position }} {{ .Track.Title | safepath }}{{ .Ext }}
@@ -700,8 +700,10 @@ Example track is [America Is Waiting](https://musicbrainz.org/release/3b28412d-8
700700
| `GENRE` | Primary genre | `ambient` |
701701
| `GENRES` | Genre list as multi-valued tag | `ambient`, `art rock`, `electronic`, `experimental` |
702702
| `TRACKNUMBER` | Track number | `1` |
703-
| `DISCNUMBER` | Disc number | `1` |
704-
| `DISCSUBTITLE` | Disc subtitle (media title) | `Bonus Disc` |
703+
| `TRACKTOTAL` | Total tracks on disc/media | `11` |
704+
| `DISCNUMBER` | Disc/media number | `1` |
705+
| `DISCTOTAL` | Total discs/medias in release | `2` |
706+
| `DISCSUBTITLE` | Disc/media subtitle | `Bonus Disc` |
705707
| `ISRC` | International Standard Recording Code | `GBAAA0500384` |
706708
| `REMIXER` | Concatenated remixers on the recording | `Artist One, Artist Two` |
707709
| `REMIXERS` | multi-valued remixers on the recording | `Artist One`, `Artist Two` |

0 commit comments

Comments
 (0)