From cec67ef94fa46220e37dce428778b4881a4800a1 Mon Sep 17 00:00:00 2001 From: Dana Conrad Date: Fri, 22 Nov 2024 15:14:09 -0600 Subject: [PATCH 1/3] Update tagging extension documentation --- docs/extensions/tagging.md | 45 +++++++++++++++++++++++++++++++++----- 1 file changed, 39 insertions(+), 6 deletions(-) diff --git a/docs/extensions/tagging.md b/docs/extensions/tagging.md index a557edd..635fc3d 100644 --- a/docs/extensions/tagging.md +++ b/docs/extensions/tagging.md @@ -2,16 +2,49 @@ title: Tag downloaded files using Mutagen --- -Add episode and podcast titles to MP3/OGG tags +Add episode and podcast titles to MP3/OGG tags. + +By default, this extension will: + - Remove existing tags + - Write the Title tag, stripping the album from the beginning of the Title if necessary + - Write the Album tag + - Write the Artist tag (with the same string as the Album tag) + - Write the Genre (to "Podcast", configurable) + - Write the publish date + +Also available are writing the Subtitle tag and the Comments tag (both with the +subtitle field), but the subtitile is often so long that it may cause problems with +certain audio players, such as Rockbox players. These are disabled by default. + +This extension can optionally embed coverart - note that the coverart will not be +standardized in any way, so Rockbox users be wary. This is disabled by default. + +This extension can optionally remove all tags instead of doing any of the above. +This is disabled by default. + +## Dependencies + +This extension requires python module `mutagen`. | setting | value | description | version | |----------------------------------------------|------------|-------------------------------------------------------------------------------------------|-------------------| -| extensions.tagging.always\_remove\_tags | true/false | true = extension removes all tags instead of creating/adding tag information | 3.5.0 | -| extensions.tagging.auto\_embed\_coverart | true/false | true = extension adds existing coverart after download | git master branch | -| extensions.tagging.genre\_tag | Genre | with this setting you can define the genre tag. Default = Podcast | all | -| extensions.tagging.strip\_album\_from\_title | true/false | true = removes the album name from the episode if the episode begins with the album title | all | +| extensions.tagging.strip\_album\_from\_title | **true**/false | true = removes the Album tag from the Title tag if the Title begins with the same string as the Album tag | all | +| extensions.tagging.genre\_tag | Podcast | Sets the Genre tag. Default = Podcast | all | +| extensions.tagging.always\_remove\_tags | true/**false** | true = extension removes all tags instead of creating/adding tag information | 3.5.0 | +| extensions.tagging.auto\_embed\_coverart | true/**false** | true = embed channel cover art in file. | git master branch | +| extensions.tagging.set\_artist\_to\_album | **True**/False | True = set the Artist tag to the same as the existing Album tag. | git master branch | +| extensions.tagging.set\_version | 4 | Sets the id3 version which will be written | git master branch | +| extensions.tagging.modify\_tags | **True**/False | Allow tags to be modified rather than simply added. If set to False, remove\_before\_modify has no effect | git master branch | +| extensions.tagging.remove\_before\_modify | **True**/False | Delete all existing tags prior to writing new tags | git master branch | +| extensions.tagging.write\_title | **True**/False | True = write the title field | git master branch | +| extensions.tagging.write\_album | **True**/False | True = write the album field | git master branch | +| extensions.tagging.write\_subtitle | True/**False** | True = write the subtitle field | git master branch | +| extensions.tagging.write\_comments | True/**False** | True = write the comments field (with the subtitle) | git master branch | +| extensions.tagging.write\_genre | **True**/False | True = write the genre with the genre\_tag setting | git master branch | +| extensions.tagging.write\_pubdate | **True**/False | True = write the published date | git master branch | + + Links: - [Extension Source](https://github.com/gpodder/gpodder/blob/master/share/gpodder/extensions/tagging.py) -- [Flattr the Extension](https://flattr.com/thing/1203533/gPodder-Tagging-Extension) From 0bdf45ab7858df722144bbfdbcb679c54214aa30 Mon Sep 17 00:00:00 2001 From: dconrad5 Date: Tue, 26 Nov 2024 06:17:55 -0700 Subject: [PATCH 2/3] Update docs/extensions/tagging.md Co-authored-by: Thomas Perl --- docs/extensions/tagging.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/extensions/tagging.md b/docs/extensions/tagging.md index 635fc3d..ce3ed8a 100644 --- a/docs/extensions/tagging.md +++ b/docs/extensions/tagging.md @@ -13,7 +13,7 @@ By default, this extension will: - Write the publish date Also available are writing the Subtitle tag and the Comments tag (both with the -subtitle field), but the subtitile is often so long that it may cause problems with +subtitle field), but the subtitle is often so long that it may cause problems with certain audio players, such as Rockbox players. These are disabled by default. This extension can optionally embed coverart - note that the coverart will not be From ac2165c3cffd61e398b21fa9c6ef367c063125f9 Mon Sep 17 00:00:00 2001 From: dconrad5 Date: Tue, 26 Nov 2024 18:45:43 -0700 Subject: [PATCH 3/3] Update docs/extensions/tagging.md tagging.md: more natural language for settings descriptions Co-authored-by: Thomas Perl --- docs/extensions/tagging.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/extensions/tagging.md b/docs/extensions/tagging.md index ce3ed8a..a4aaf6b 100644 --- a/docs/extensions/tagging.md +++ b/docs/extensions/tagging.md @@ -28,20 +28,20 @@ This extension requires python module `mutagen`. | setting | value | description | version | |----------------------------------------------|------------|-------------------------------------------------------------------------------------------|-------------------| -| extensions.tagging.strip\_album\_from\_title | **true**/false | true = removes the Album tag from the Title tag if the Title begins with the same string as the Album tag | all | -| extensions.tagging.genre\_tag | Podcast | Sets the Genre tag. Default = Podcast | all | -| extensions.tagging.always\_remove\_tags | true/**false** | true = extension removes all tags instead of creating/adding tag information | 3.5.0 | -| extensions.tagging.auto\_embed\_coverart | true/**false** | true = embed channel cover art in file. | git master branch | -| extensions.tagging.set\_artist\_to\_album | **True**/False | True = set the Artist tag to the same as the existing Album tag. | git master branch | +| extensions.tagging.strip\_album\_from\_title | **true**/false | Remove the Album tag from the Title tag if the Title begins with the same string as the Album tag | all | +| extensions.tagging.genre\_tag | Podcast | Value for the Genre tag | all | +| extensions.tagging.always\_remove\_tags | true/**false** | Remove all tags instead of creating/adding tag information | 3.5.0 and newer | +| extensions.tagging.auto\_embed\_coverart | true/**false** | Embed channel cover art in file | git master branch | +| extensions.tagging.set\_artist\_to\_album | **True**/False | Set the Artist tag to the same as the existing Album tag | git master branch | | extensions.tagging.set\_version | 4 | Sets the id3 version which will be written | git master branch | | extensions.tagging.modify\_tags | **True**/False | Allow tags to be modified rather than simply added. If set to False, remove\_before\_modify has no effect | git master branch | | extensions.tagging.remove\_before\_modify | **True**/False | Delete all existing tags prior to writing new tags | git master branch | -| extensions.tagging.write\_title | **True**/False | True = write the title field | git master branch | -| extensions.tagging.write\_album | **True**/False | True = write the album field | git master branch | -| extensions.tagging.write\_subtitle | True/**False** | True = write the subtitle field | git master branch | -| extensions.tagging.write\_comments | True/**False** | True = write the comments field (with the subtitle) | git master branch | -| extensions.tagging.write\_genre | **True**/False | True = write the genre with the genre\_tag setting | git master branch | -| extensions.tagging.write\_pubdate | **True**/False | True = write the published date | git master branch | +| extensions.tagging.write\_title | **True**/False | Write the title field | git master branch | +| extensions.tagging.write\_album | **True**/False | Write the album field | git master branch | +| extensions.tagging.write\_subtitle | True/**False** | Write the subtitle field | git master branch | +| extensions.tagging.write\_comments | True/**False** | Write the comments field (with the subtitle) | git master branch | +| extensions.tagging.write\_genre | **True**/False | Write the genre with the genre\_tag setting | git master branch | +| extensions.tagging.write\_pubdate | **True**/False | Write the published date | git master branch |