You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add more Author tags for consistent formatting (#42)
* Add more author metadata tags and update songs with new layout
* Add test for invalid author fields
* Update README with new author metadata tags
* Bump version to 2.0.0
Copy file name to clipboardExpand all lines: README.md
+36-7
Original file line number
Diff line number
Diff line change
@@ -71,7 +71,12 @@ All files are named and contain two sections, YAML front matter first and conten
71
71
The front matter is contained by one line with `---` each before and after the section. Possible fields in the front matter are:
72
72
73
73
-`title`, the name or title of the song **(required)**
74
-
-`author`, the person or persons who wrote the lyrics of the song
74
+
-`author`, information about the person or persons who wrote the lyrics of the song
75
+
-`name`, the name of the person or persons who wrote the lyrics of the song
76
+
-`event`, the event for which the song was made
77
+
-`location`, the city or university where the song is from
78
+
-`year`, the year the song was written
79
+
-`comment`, a comment about the author (for example, if an author wrote one of the verses)
75
80
-`melody`, the melody the song is sung to
76
81
-`composer`, the composer of the melody
77
82
-`tags`, list of categories the songs fall in to and other identifiers (valid tags can be found in [`/src/definitions/tags.ts`](/src/definitions/tags.ts#L1-L12)) **(required)**
@@ -85,7 +90,11 @@ Any field without a value should be omitted.
85
90
```yml
86
91
---
87
92
title: Moder Kista
88
-
author: David Larsson, IT00
93
+
author:
94
+
- name: David Larsson, IT-00
95
+
event: IT-nØllningen
96
+
location: KTH
97
+
year: 2000
89
98
melody: Längtan till landet
90
99
composer: Otto Lindblad
91
100
tags: [gasque, swe]
@@ -164,12 +173,17 @@ Builds files. Can optionally provide a date in the [ISO 8601](https://en.wikiped
164
173
165
174
#### `yarn script create [title]`
166
175
167
-
Creates a new song with the next possible ID and the given title. Front matter becomes populated with empty fields to make it as easy as possible to add them in. Optionally values to fields can be provided when running the script, e.g. `yarn script create "Moder Kista" --author="David Larsson, IT00" --tags=gasque` will have the following front matter:
176
+
Creates a new song with the next possible ID and the given title. Front matter becomes populated with empty fields to make it as easy as possible to add them in. Optionally values to fields can be provided when running the script, e.g. `yarn script create "Moder Kista" --author="David Larsson, IT-00" --tags=gasque` will have the following front matter:
168
177
169
178
```yaml
170
179
---
171
180
title: Moder Kista
172
-
author: David Larsson, IT00
181
+
author:
182
+
- name: David Larsson, IT-00
183
+
event:
184
+
location:
185
+
year:
186
+
comment:
173
187
melody:
174
188
composer:
175
189
tags: [gasque]
@@ -284,6 +298,12 @@ Fronten har en rad med `---` före och efter sektionen. Möjliga fält i fronten
284
298
285
299
-`title`, namnet eller titeln på sången **(obligatorisk)**
286
300
-`author`, personen eller personerna som skrev sångtexten
301
+
-`author`, information om personen eller personerna som skrev sångtexten
302
+
-`name`, personen eller personerna som skrev sångtexten
303
+
-`event`, evenemanget sången skrevs till
304
+
-`location`, staden eller universitetet som sången kommer ifrån
305
+
-`year`, året sången skrevs
306
+
-`comment`, kommentar om skribenten (exempelvis om en skribent har skrivit en av verserna)
287
307
-`melody`, melodin som sången sjungs i
288
308
-`composer`, kompositör till melodin
289
309
-`tags`, lista med kategorier som sångerna tillhör och andra identifierare (giltiga taggar hittas i [`/src/definitions/tags.ts`](/src/definitions/tags.ts#L1-L12)) **(obligatorisk)**
@@ -297,7 +317,11 @@ Alla fält utan värde bör utelämnas.
297
317
```yml
298
318
---
299
319
title: Moder Kista
300
-
author: David Larsson, IT00
320
+
author:
321
+
- name: David Larsson, IT-00
322
+
event: IT-nØllningen
323
+
location: KTH
324
+
year: 2000
301
325
melody: Längtan till landet
302
326
composer: Otto Lindblad
303
327
tags: [gasque, swe]
@@ -377,12 +401,17 @@ Kompilerar filer. Man kan valfritt ange ett datum i formatet [ISO 8601](https://
377
401
378
402
#### `yarn script create [titel]`
379
403
380
-
Skapar en ny sång med nästa möjliga ID och den givna titeln. Fronten fylls med tomma fält för att göra är så enkelt som möjligt att fylla i dem. Valfritt kan värden till fält tillhandahållas när man kör skriptet, t.ex. `yarn script create "Moder Kista" --author="David Larsson, IT00" --tags=gasque` kommer att ha följande front:
404
+
Skapar en ny sång med nästa möjliga ID och den givna titeln. Fronten fylls med tomma fält för att göra är så enkelt som möjligt att fylla i dem. Valfritt kan värden till fält tillhandahållas när man kör skriptet, t.ex. `yarn script create "Moder Kista" --author="David Larsson, IT-00" --tags=gasque` kommer att ha följande front:
0 commit comments