Skip to content

Commit 9790afe

Browse files
authored
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
1 parent 6838119 commit 9790afe

File tree

86 files changed

+755
-424
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+755
-424
lines changed

Diff for: README.md

+36-7
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,12 @@ All files are named and contain two sections, YAML front matter first and conten
7171
The front matter is contained by one line with `---` each before and after the section. Possible fields in the front matter are:
7272

7373
- `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)
7580
- `melody`, the melody the song is sung to
7681
- `composer`, the composer of the melody
7782
- `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.
8590
```yml
8691
---
8792
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
8998
melody: Längtan till landet
9099
composer: Otto Lindblad
91100
tags: [gasque, swe]
@@ -164,12 +173,17 @@ Builds files. Can optionally provide a date in the [ISO 8601](https://en.wikiped
164173

165174
#### `yarn script create [title]`
166175

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:
168177

169178
```yaml
170179
---
171180
title: Moder Kista
172-
author: David Larsson, IT00
181+
author:
182+
- name: David Larsson, IT-00
183+
event:
184+
location:
185+
year:
186+
comment:
173187
melody:
174188
composer:
175189
tags: [gasque]
@@ -284,6 +298,12 @@ Fronten har en rad med `---` före och efter sektionen. Möjliga fält i fronten
284298

285299
- `title`, namnet eller titeln på sången **(obligatorisk)**
286300
- `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)
287307
- `melody`, melodin som sången sjungs i
288308
- `composer`, kompositör till melodin
289309
- `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.
297317
```yml
298318
---
299319
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
301325
melody: Längtan till landet
302326
composer: Otto Lindblad
303327
tags: [gasque, swe]
@@ -377,12 +401,17 @@ Kompilerar filer. Man kan valfritt ange ett datum i formatet [ISO 8601](https://
377401

378402
#### `yarn script create [titel]`
379403

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:
381405

382406
```yaml
383407
---
384408
title: Moder Kista
385-
author: David Larsson, IT00
409+
author:
410+
- name: David Larsson, IT-00
411+
event:
412+
location:
413+
year:
414+
comment:
386415
melody:
387416
composer:
388417
tags: [gasque]

0 commit comments

Comments
 (0)