-
Notifications
You must be signed in to change notification settings - Fork 0
Review files
Files are made up of multiple YAML and Markdown files. Sections are divided by a new line with three dashes (i.e. ---).
- The first section of any file contains metadata about the post/author/entity the file describes.
- Any section that follows may either contain YAML syntax, with custom data (such as review information) alongside section content in a
review,contentorbodyproperty, or markdown formatted content or a plain string.
All content files, including reviews, should contain at least two sections: metadata, and at least one content section.
---
created: 2021-04-14T12:00:00.000Z # Can be inferred from the filename
modified: 2021-04-16T12:00:00.000Z # The created date will be used in unspecified
slug: artist-name-album-name # Can be inferred from the filename
type: reviews # Can be inferred from the filename
tags: # Optional
- 2010s # Specify as one per line or ["in", "an", "array"] format
- rock
- queens of the stone age
featuredimage: album-artwork/album-name-artist-name.jpg # Relates to a path from the ./data/images directory
artworkCredit: Lorem ipsum dolor # Details on the album artwork (see 'Artwork details' page for more info)
artworkCreditSource: https://www.source.com/page/ # Link to reputable source. Not needed when we've interviewed the artist ourselves
artist: Some Artist
album: Some Album
essentialtracks: # Tracks chosen by all three reviewers. As with tags, may be one per line...
- Vampires # ...or in array format
- Feel for You
favouritetracks: # As with tags...
- So Good
totalscore: # Currently, the total score must at least specify the given and possible properties
given: 22 # This is a bit verbose and will be easier in future
possible: 30
fraction: 0.7333333333333333
colours: # Set the page's colour scheme
- "#bdaa72"
- "#fefdf9"
- "#fefdf9"
pullquote: Lorem ipsum dolor # A very short, pithy summary of the review
summary: Lorem ipsum dolor # Passge from the main review used for the at-a-glance summary sidebar
week: 267 # The 'serial' number i.e. the nth album we've reviewed
blurb: Lorem ipsum dolor # Used as an SEO description, ideally around 140 characters
artistMBID: 00000000-0000-0000 # MusicBrainz ID for the artist; mainly for reviews; used to pull artist information; optional
artistMBID: # ...this field also accepts a list where multiple artists are involved
- 00000000-0000-0000
- 00000000-0000-0000
albumMBID: 00000000-0000-0000 # MusicBrainz ID for the album; mainly for reviews; used to pull album information; optional
albumMBID: # ...this field also accepts a list where an article focuses on multiple albums
- 00000000-0000-0000
- 00000000-0000-0000
artistLink: https://www.artistwebsite.com/shop/
---
author: andre-dack # Relates to an author file in ./data/authors directory
review: >-
This is a content section. Each section is written by a different person. I can still write across...
...multiple lines, and write in **bold** and _italics_.
Note the single space indentation at the start of each line. YAML is pretty relaxed with this, but
you should _at least_ have this indentation on the **first** line of the content.
tracks: # As with tags, both per line and array format/single line are acceptable
- Track 1
- Track 7
- Track 2
score: # To make scores even stupider, notice that here, a "score" and "max" property are required
score: 7 # This is verbose and inconsistent with the totalscore above and will be better in the future
max: 10
fraction: 0.7
---
author: frederick-obrien
review: >-
Lorem ipsum dolor
tracks:
- Track 3
- Track 6
- Track 5
score:
score: 8
max: 10
fraction: 0.8
---
author: andrew-bridge
review: >-
Lorem ipsum dolor
tracks:
- Track 7
- Track 4
- Track 3
score:
score: 8
max: 10
fraction: 0.8
---
Note also that Markdown allows for HTML tags to be used within it, allowing for more involved styling
to be used in content
The filename of a post file can also contain data about the post. This makes for a handy shorthand method of adding and editing data.
Post filenames should be formatted as [date]-[post type]-[slug].md and these values will be used if no other value is specified in the post metadata section. The post title will also be inferred from the slug if one is not specified, by replacing hyphens with spaces and converting the string to sentence case.
The date should be formatted as YYYYMMDD.
To override any of the data in these values, specify created and/or modified dates, type, slug and title in the post metadata section of the file.
Where post filename = 20200422-reviews-eob-earth.md
The following post metadata will be inferred:
created: 2020-04-22T00:00:00Z # Wednesday 22nd April 2020
modified: 2020-04-22T00:00:00Z # Wednesday 22nd April 2020
type: reviews
slug: eob-earth
title: Eob earth
This feature will likely be phased out as file names were partially due to the migration from WordPress. All reviews have the above metadata inside so we're free to to change file naming conventions without causing too many headaches.