hacklab/strudel
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request 'Say that @license should use SPDX identifier' (#1817) from Wuzzy/strudel:clarify_at_license into main

Browse source 
Reviewed-on: https://codeberg.org/uzu/strudel/pulls/1817
This commit is contained in:
froos 2025-12-28 22:58:37 +01:00
commit 7bce739068
1 changed files with 18 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

34
website/src/pages/learn/metadata.mdx
View file

@ -11,9 +11,9 @@ import { JsDoc } from '../../docs/JsDoc';
You can optionally add some music metadata in your Strudel code, by using tags in code comments: You can optionally add some music metadata in your Strudel code, by using tags in code comments:
```js ```js
// @title Hey Hoo // @title My Cool Song
// @by Sam Tagada // @by John Doe
// @license CC BY-NC-SA // @license CC-BY-SA-4.0
``` ```
Like other comments, those are ignored by Strudel, but it can be used by other tools to retrieve some information about the music. Like other comments, those are ignored by Strudel, but it can be used by other tools to retrieve some information about the music.
@ -24,22 +24,22 @@ You can also use comment blocks:
```js ```js
/* /*
@title Hey Hoo @title My Cool Song
@by Sam Tagada @by John Doe
@license CC BY-NC-SA @license CC-BY-SA-4.0
*/ */
``` ```
Or define multiple tags in one line: Or define multiple tags in one line:
```js ```js
// @title Hey Hoo @by Sam Tagada @license CC BY-NC-SA // @title My Cool Song @by John Doe @license CC-BY-SA-4.0
``` ```
The `title` tag has an alternative syntax using quotes (must be defined at the very begining): The `title` tag has an alternative syntax using quotes (must be defined at the very begining):
```js ```js
// "Hey Hoo" @by Sam Tagada // "My Cool Song" @by John Doe
``` ```
## Tags list ## Tags list
@ -48,20 +48,22 @@ Available tags are:
- `@title`: music title - `@title`: music title
- `@by`: music author(s), separated by comma, eventually followed with a link in `<>` (ex: `@by John Doe <https://example.com>`) - `@by`: music author(s), separated by comma, eventually followed with a link in `<>` (ex: `@by John Doe <https://example.com>`)
- `@license`: music license(s), e.g. CC BY-NC-SA. Unsure? [Choose a creative commons license here](https://creativecommons.org/choose/) - `@license`: music license(s), separated by comma. Each license should be specified by using the correct identifier in the [https://spdx.org/licenses/](SPDX License List). Example: CC-BY-SA-4.0. Unsure? [Choose a Creative Commons license here](https://creativecommons.org/choose/).
- `@details`: some additional information about the music - `@details`: some additional information about the music
- `@url`: web page(s) related to the music (git repo, soundcloud link, etc.) - `@url`: web page(s) related to the music (git repository, Soundcloud link, etc.)
- `@genre`: music genre(s) (pop, jazz, etc) - `@genre`: music genre(s) (pop, jazz, etc.)
- `@album`: music album name - `@album`: music album name
Note to tool authors: _Never_ trust that a song has filled those fields with syntactically correct values; make sure your software is robust enough it doesn't break if it encounters bad values
## Multiple values ## Multiple values
Some of them accepts several values, using the comma or new line separator, or duplicating the tag: Some of them accepts several values, using the comma or new line separator, or duplicating the tag:
```js ```js
/* /*
@by Sam Tagada @by John Doe
Jimmy Jane Doe
@genre pop, jazz @genre pop, jazz
@url https://example.com @url https://example.com
@url https://example.org @url https://example.org
@ -72,11 +74,11 @@ You can also add optional prefixes and use tags where you want:
```js ```js
/* /*
song @by Sam Tagada song @by John Doe
samples @by Jimmy samples @by Jane Doe
*/ */
... ...
note("a3 c#4 e4 a4") // @by Sandy note("a3 c#4 e4 a4") // @by Sandy Sue
``` ```
## Multiline ## Multiline