Skip to content

Add more Author tags for consistent formatting #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Mar 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 36 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,12 @@ All files are named and contain two sections, YAML front matter first and conten
The front matter is contained by one line with `---` each before and after the section. Possible fields in the front matter are:

- `title`, the name or title of the song **(required)**
- `author`, the person or persons who wrote the lyrics of the song
- `author`, information about the person or persons who wrote the lyrics of the song
- `name`, the name of the person or persons who wrote the lyrics of the song
- `event`, the event for which the song was made
- `location`, the city or university where the song is from
- `year`, the year the song was written
- `comment`, a comment about the author (for example, if an author wrote one of the verses)
- `melody`, the melody the song is sung to
- `composer`, the composer of the melody
- `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)**
Expand All @@ -85,7 +90,11 @@ Any field without a value should be omitted.
```yml
---
title: Moder Kista
author: David Larsson, IT00
author:
- name: David Larsson, IT-00
event: IT-nØllningen
location: KTH
year: 2000
melody: Längtan till landet
composer: Otto Lindblad
tags: [gasque, swe]
Expand Down Expand Up @@ -164,12 +173,17 @@ Builds files. Can optionally provide a date in the [ISO 8601](https://en.wikiped

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

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

```yaml
---
title: Moder Kista
author: David Larsson, IT00
author:
- name: David Larsson, IT-00
event:
location:
year:
comment:
melody:
composer:
tags: [gasque]
Expand Down Expand Up @@ -284,6 +298,12 @@ Fronten har en rad med `---` före och efter sektionen. Möjliga fält i fronten

- `title`, namnet eller titeln på sången **(obligatorisk)**
- `author`, personen eller personerna som skrev sångtexten
- `author`, information om personen eller personerna som skrev sångtexten
- `name`, personen eller personerna som skrev sångtexten
- `event`, evenemanget sången skrevs till
- `location`, staden eller universitetet som sången kommer ifrån
- `year`, året sången skrevs
- `comment`, kommentar om skribenten (exempelvis om en skribent har skrivit en av verserna)
- `melody`, melodin som sången sjungs i
- `composer`, kompositör till melodin
- `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)**
Expand All @@ -297,7 +317,11 @@ Alla fält utan värde bör utelämnas.
```yml
---
title: Moder Kista
author: David Larsson, IT00
author:
- name: David Larsson, IT-00
event: IT-nØllningen
location: KTH
year: 2000
melody: Längtan till landet
composer: Otto Lindblad
tags: [gasque, swe]
Expand Down Expand Up @@ -377,12 +401,17 @@ Kompilerar filer. Man kan valfritt ange ett datum i formatet [ISO 8601](https://

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

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

```yaml
---
title: Moder Kista
author: David Larsson, IT00
author:
- name: David Larsson, IT-00
event:
location:
year:
comment:
melody:
composer:
tags: [gasque]
Expand Down
Loading
Loading