Updated #EDITION and #TAGS to be more explicit

UltraStar-Deluxe · Nov 8, 2024 · 71a8be9 · 71a8be9
1 parent c6ecf81
commit 71a8be9
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 7 deletions.
diff --git a/docs/index.html b/docs/index.html
@@ -1803,7 +1803,7 @@ <h4><a id="genre" href="#genre"></a>GENRE</h4>
                         </div>
                     </details>
                     <h4 class="text-red"><a id="tags" href="#tags"></a>TAGS (new)</h4>
-                    <p>#TAGS allows you to add any reasonable keyword for this song like topic or mood. This helps to <b>categorize songs by keywords</b>. You can add multiple tags and seperate them with comma. Song Editors have an auto complete function in GUI that adds common keywords.</p>
+                    <p>#TAGS allows you to add any reasonable keyword for this song. This helps to <b>categorize songs by keywords</b>. You can add multiple tags and seperate them with comma. You can use #TAGS if #EDITION is not enough.</p>
                     <p>Some common keywords are:
                     <i>Party, Feel-Good, Charts, Cover Songs, Summer, Love Songs, Guilty Pleasure, Disney, Christmas, Halloween, Eurovision Song Contest [YEAR], Club, Dancefloor, Underground, Mainstream, Slow</i></p>
                     <div>
@@ -1877,9 +1877,13 @@ <h4 class="text-red"><a id="tags" href="#tags"></a>TAGS (new)</h4>
                         </div>
                     </details>
                     <h4><a id="edition" href="#edition"></a>EDITION</h4>
-                    <p>This attribute specifices wether a song is used <b>in commercial games or not</b>. It's only for "Editions of games" like SingStar - Pop Hits, GuitarHero Live, Rockband vol.4, Let's Sing 2020. See list of editions here: <a
-                            href="https://github.com/bohning/usdb_syncer/wiki/SingStar-Editions">List of Editions</a>.
-                        This information can be used to categorize songs by their edition. You can add multiple tags and seperate them with comma.</p>
+                    <p>This attribute specifices a value out of a curated list where a song belongs to. Aside from this list certain games can be used like SingStar - Pop Hits, GuitarHero Live, Rockband vol.4, Let's Sing 2020. See list of editions here:
+                        <ul>
+                            <li><a href="https://github.com/bohning/usdb_syncer/wiki/SingStar-Editions">List of SingStar Editions</a></li>
+                            <li><a href="https://github.com/bohning/usdb_syncer/wiki/RockBand-Editions">List of RockBand Editions</a></li>
+                            <li><a href="https://github.com/bohning/usdb_syncer/wiki/GuitarHero-Editions">List of GuitarHero Editions</a></li>
+                        </ul>
+                        This information can be used to categorize songs by their edition. You can add multiple values and seperate them with comma.</p>
                     <div>
                         <pre class="notranslate"><code>#EDITION:SingStar Rocks! [DE]
                     </code></pre>

diff --git a/spec.md b/spec.md
@@ -579,9 +579,45 @@ Multi-Valued: Yes
 Since:        0.2.0
 ```
 
-The `EDITION` indicates what edition of games a song belongs to.
-While this header is intended to hold commercially available editions (e.g. SingStar Pop Hits, GuitarHero Live) implementations MUST NOT reject a file based on the value of this header.
-A list of SingStar editions is available [here](https://github.com/bohning/usdb_syncer/wiki/SingStar-Editions).
+The `EDITION` indicates a curated list of where a song belongs to.
+Implementations MUST NOT reject a file based on the value of this header.
+The curated list contains:
+
+- Charts
+- Christmas
+- Club
+- Cover
+- Disney
+- Duet
+- Eurovision Song Contest
+- Explicit
+- Fan Song
+- Feel-Good
+- Funny
+- Guilty Pleasure
+- Halloween
+- Heartbreak
+- Live
+- Love Song
+- Mainstream
+- Movies
+- Musical
+- Party
+- Pride/LGBTQ
+- Relaxed
+- Slow
+- Song-checked
+- Special interest
+- Summer
+- TV Show
+- Underground
+- Underrated
+- Video Game
+- Viral Hit
+
+A list of eligable SingStar editions is available [here](https://github.com/bohning/usdb_syncer/wiki/SingStar-Editions).
+A list of eligable RockBand editions is available [here](https://github.com/bohning/usdb_syncer/wiki/RockBand-Editions).
+A list of eligable Guitar Hero editions is available [here](https://github.com/bohning/usdb_syncer/wiki/GuitarHero-Editions).
 For arbitrary keywords see the [`TAGS`](#323-the-tags-header) header.
 
 ### 3.23. The `TAGS` Header