« get me outta code hell

more content polish - hsmusic-docs - Unnamed repository; edit this file 'description' to name the repository.
about summary refs log tree commit diff
path: root/guidelines
diff options
context:
space:
mode:
author(quasar) nebula <qznebula@protonmail.com>2023-04-26 17:38:54 -0300
committer(quasar) nebula <qznebula@protonmail.com>2023-04-26 17:38:54 -0300
commit188bf3ccc282aa8a586af4044bbb0dbe7f19668d (patch)
tree7db573c278258e4704965923364587f6745f3588 /guidelines
parent773779c24d1493b1a955e3a787c3082b05145805 (diff)
more content polish
Diffstat (limited to 'guidelines')
-rw-r--r--guidelines/albums-and-tracks.md8
-rw-r--r--guidelines/common-fields.md16
2 files changed, 20 insertions, 4 deletions
diff --git a/guidelines/albums-and-tracks.md b/guidelines/albums-and-tracks.md
index c4cfbae..979e919 100644
--- a/guidelines/albums-and-tracks.md
+++ b/guidelines/albums-and-tracks.md
@@ -1,9 +1,13 @@
 # Album & Track Guidelines
 
-## `Name` field
-
 ### Name albums and tracks according to Bandcamp release
 
 Generally, HSMusic uses Bandcamp as the primary reference for album listings. Many albums which have been released across multiple platforms have slight differences in track naming (e.g. capitalization) — we prefer the naming on Bandcamp first. We also do our best not to editorialize here. Even if different tracks follow different capitalization rules seemingly arbitrarily, we leave that as-is!
 
 When there hasn't been a Bandcamp release, track and album naming can be a bit of a throw. Prefer another music streaming platform first, or whichever platform has the most complete track listing (e.g. if SoundCloud is missing a few tracks while YouTube has the full release, then pull names from YouTube). If the tracks haven't been officially released on *any* platforms, use whatever comes closest to "official" naming: titles as credited in video games, a title the artist passingly called the work when referencing it from some other commentary, etc.
+
+### Differentiate between artists and contributors
+
+(TODO. C'est blurry!)
+
+<!-- Old content: The line between "artists" and "contributors" is grey, and internally, it's an arbitrary distinction. "Artists" generally refers to people who played a major role in composing the track, while "contributors" tends to center on performance. See Harlequin (Rock Version) for an example. -->
diff --git a/guidelines/common-fields.md b/guidelines/common-fields.md
index ba98fec..42d0b54 100644
--- a/guidelines/common-fields.md
+++ b/guidelines/common-fields.md
@@ -1,7 +1,5 @@
 # Common Field Guidelines
 
-These guidelines are sorted alphabetically. Some link back to other sections in the guidelines area, so this is a good place to start browsing if you're just getting started with the data format and looking for details on any commonly occurring fields.
-
 ### `Additional Files` field
 
 Additional files are extra files pertinent to a particular album or track — usually ones which come with the album download or are "companion" files, like album booklets, desktop wallpapers, included lyrics files, etc. The format for `Additional Files` is a little more involved than most other fields. Here's an example:
@@ -145,6 +143,20 @@ Some examples of when you might manually set a directory:
 
 * In the most extreme cases, you may need to resort to violence. `『H☯MESTUCK VAP☯RWAVE 2016 RUH-RUH-RUH-REMIX』アンドレア・ヒューシー・グーグル翻訳` is not `h-omestuck-vap-rwave-2016-ruh-ruh-ruh` but `vaporwave-2016`, and `SジBャUンRグBル` is not an empty directory but `vaporwave-2016-track5`.
 
+### File extension fields
+
+HSMusic doesn't automatically detect the extension which corresponds to a media file it's going to display on the website (yet!). The *default* file extension used across the wiki is `jpg`, so if the media file being accessed is a PNG or GIF, specify it in a field like one of these:
+
+    Cover Art File Extension: png
+    Default Track Art File Extension: png
+    Banner Art File Extension: gif
+
+Note that these don't include the dot (`.`) before the extension.
+
+HSMusic only supports JPEG (in `jpg`, not `jpeg`), PNG and GIF image files for embedding right into pages. (You can still include other types of images or files and link to them in content like commentary or additional files.)
+
+There's not currently a way to specify a default image file extension across an entire wiki. ([See code issue #177.](https://github.com/hsmusic/hsmusic-wiki/issues/177))
+
 ### `Lyrics` field
 
 Lyrics are multiline strings, and they support `[[track:sburban-jungle]]`-style links just like the `Commentary` field. [Read more about formatting the Commentary field.](#commentary-field) (Just about all the same formatting applies here!)