« get me outta code hell

lyrics info + some additional tracks-type cleanup - hsmusic-docs - Unnamed repository; edit this file 'description' to name the repository.
about summary refs log tree commit diff
diff options
context:
space:
mode:
author(quasar) nebula <qznebula@protonmail.com>2023-04-26 16:04:18 -0300
committer(quasar) nebula <qznebula@protonmail.com>2023-04-26 16:04:18 -0300
commit773779c24d1493b1a955e3a787c3082b05145805 (patch)
treeced93d831ca9ea0a8f91bd3b8e051cadd0841a89
parent933e7b8ef37034af784b4a62a2e38c35bb8811e4 (diff)
lyrics info + some additional tracks-type cleanup
-rw-r--r--documents/album.md4
-rw-r--r--documents/track.md18
-rw-r--r--guidelines/common-fields.md26
-rw-r--r--guidelines/lyrics.md54
4 files changed, 91 insertions, 11 deletions
diff --git a/documents/album.md b/documents/album.md
index adf0e0c..ca170b2 100644
--- a/documents/album.md
+++ b/documents/album.md
@@ -48,8 +48,8 @@ Referenced as `album:directory`; extra links: `[[album-commentary:directory]]`,
 ### Content fields
 
 * `Commentary`: album-wide commentary from anyone involved in making it
-  * Learn more
-* `Additional Files`: bonus files associated with the album, e.g. album booklet, sheet music, credits files
+  * [Learn more about formatting the Commentary field.](../guidelines/common-fields.md#commentary-field)
+* `Additional Files`: bonus files associated with the album, e.g. album booklet, desktop wallpapers, credits files
 
 ### Configuration & layout
 
diff --git a/documents/track.md b/documents/track.md
index f4af6a0..bff8078 100644
--- a/documents/track.md
+++ b/documents/track.md
@@ -52,16 +52,16 @@ Referenced as `track:directory`.
 * `Has Cover Art`: disable to inherit from album cover art, or enable for one track with unique art amongst an album mostly without
   * If left unspecified, inherits from the album's `Has Track Art` field, which is true by default.
 
-* `Lyrics`: vocal lyrics
-  * Guideline: Include the whole lyrics verbosely, instead of shorthands like "[2x Chorus]".
-  * Guideline: Insofar as vocal lines can be discerned from instruments, try to transcribe everything, including non-"music" lines, quiet vocals, optionally echo effects, etc
-  * Guideline: Just ask Niklink for decision making on any lyrics, he's to credit for pretty much all lyrics present on the site ATM lol
-
 * `Commentary`: commentary from track artists and others related
-  * See (TODO) Commentary Format
-
-* `Additional Files`: bonus files associated with the track, currently unused
-  * See (TODO) Additional Files Format
+  * [Learn more about formatting the Commentary field.](../guidelines/common-fields.md#commentary-field)
+* `Lyrics`: lyrics for vocals
+  * [Learn more about formatting the Lyrics field.](../guidelines/common-fields.md#lyrics)
+  * [Read detailed guidelines on filling out lyrics for HSMusic.](../guidelines/lyrics.md)
+
+* `Additional Files`: bonus files associated with the track (there aren't any current uses of this field on the wiki)
+* `Sheet Music Files`: PDFs and other files containing sheet music for the track
+* `MIDI Project Files`: MIDI files for the track as well as DAW or tracker/sequencer project files
+  * These three fields share the same structured format - [learn more.](../guidelines/common-fields.md#additional-files-field)
 
 * `Originally Released As`: links track to its earliest release
   * Generally, this should be used instead of `Date Originally Released`, not alongside.
diff --git a/guidelines/common-fields.md b/guidelines/common-fields.md
index 2dce433..ba98fec 100644
--- a/guidelines/common-fields.md
+++ b/guidelines/common-fields.md
@@ -145,6 +145,32 @@ 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`.
 
+### `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!)
+
+The only formatting difference is with how line breaks and empty lines work. Write them the same way most lyrics sites do: an empty line represents the space between two verses, and lines which are "together" will be displayed in the same HTML paragraph, with line breaks preserved. Here's how a `Lyrics` field might look:
+
+```
+Lyrics: |-
+    We're no strangers to love
+    You know the rules and so do I
+    A full commitment's what I'm thinking of
+    You wouldn't get this from any other guy
+
+    I just wanna tell you how I'm feeling
+    Gotta make you understand
+
+    Never gonna give you up
+    Never gonna let you down
+    Never gonna run around and desert you
+    Never gonna make you cry
+    Never gonna say goodbye
+    Never gonna tell a lie and hurt you
+```
+
+There are a bunch of details on how we format lyrics for HSMusic in particular, so [learn more about formatting lyrics](lyrics.md) if you're adding an album to the HSMusic wiki or want to see how we do things!
+
 ### `Name` field
 
 - [Name albums and tracks according to Bandcamp release](./albums-and-tracks.md#name-field)
diff --git a/guidelines/lyrics.md b/guidelines/lyrics.md
new file mode 100644
index 0000000..eb4073f
--- /dev/null
+++ b/guidelines/lyrics.md
@@ -0,0 +1,54 @@
+# Formatting Lyrics for HSMusic
+
+Here are the guidelines we follow for formatting lyrics on the Homestuck Music Wiki! Give these a good look if you're adding an album to HSMusic's data or just want to see how we do it for your own wiki.
+
+If you're filling out data now, [read more about the actual `Lyrics` data field.](common-fields.md#lyrics-field) Also, visit [Tracks - with Lyrics](https://hsmusic.wiki/list/tracks/with-lyrics/) and [References Beyond Homestuck](https://hsmusic.wiki/album/references-beyond-homestuck/) in particular for many examples!
+
+Thanks to Niklink for filling out the vast majority of lyrics on the wiki and for writing this insightful guide.
+
+### Punctuation
+
+- Never use periods or commas to end a line!
+- Question marks and exclamation marks are allowed to end lines, the latter should be used sparingly, and mainly when a line has more emphasis than others in the same song
+ 
+### Line splits
+
+- Keep line splits consistent in the same song!
+- Identify the beat of the song and use it as a guide, although many songs try to be tricky
+- When lyrics stop for longer than normal, even slightly so, consider starting a new paragraph
+- Common example: if a verse has a lead-in at the end of a previous beat, keep that in its own line
+- If you have any sort of full stop in the middle of a line, you should seriously consider splitting the line there, unless you can't reformat other lines for consistency
+
+### Background vocals
+
+- When two vocals are happening at the same time, each set of background vocals should be enclosed in parentheses and moved to the end of the line
+- If it's three, the ordering of the sets of background vocals should correspond to the order that each vocal starts during that line
+- Use your best judgment to determine which is the 'main' vocal line in extremely messy songs
+- Similarly, for highly jumbled songs where following along to the written lyrics is challenging, you can try to intersperse the background vocals throughout the line instead of at the end
+
+### Spoken word
+
+- Content that is not *sung* is spoken word (and yes, rapping counts as singing)
+- Spoken word content should be placed in parentheses, and punctuated normally, disregarding other rules
+- Unless specifically timed to go along with the music, spoken word content should not be split into separate lines
+- Spoken word content SHOULD be split into separate parentheses if the *speaker* changes, and each parentheses should be placed on a separate line
+- Spoken word content that is being used as background vocals can disregard the above rules except for punctuation
+ 
+### Foreign languages
+
+- Non-English words should be accompanied by a translation in *italics*, placed inside a parentheses
+- Can be placed beside each line or as a whole subsequent translated paragraph, depending on what provides more clarity
+- Non-Latin scripts should be romanized
+- Try to find sources for translations before making your own
+- Using sourced translations can conflict with a desire to change how lines are broken up (since you may not know which parts of the translation correspond to which parts of the original lyrics), so be careful
+
+### Miscellaneous
+
+- Don't blindly trust official lyrics! They're slightly inaccurate more often than not!
+- Consider the context of the song itself: many tricky lyrics to decipher can be fandom-specific jargon or in-jokes
+- Vocal isolation can be your friend, there are probably better AI-based tools available right now but I've found https://www.lalal.ai/ to be often helpful. Change Tempo in Audacity helps as well to slow down a song
+- If you're stuck, it helps to put a pin with it and come back later with a fresh mindspace
+- When something is lyrical but you believe it is genuinely indecipherable, leave it as `[Indecipherable]`
+- If you have to give up on lyrics you believe CAN be filled in in the future, leave it as `[??]`
+- Edge case I've run into relatively often: write reversed lyrics normally but add a note saying `[Reversed]`
+- Meme formatting for lyrics is only allowed in the most extremely memey of cases and when official lyrics exist, such as Mayor Maynot. If you're not sure, then don't do it and be accurate instead