# Year in review

> A note that counts what you finished in a year, and progress through the book you are reading.

## What counts

A book counts as finished in a year when its note has a `finished` date in that year. **Reading: Set reading status…** (or the status buttons in the Library panel) stamps `started` when you start a book and `finished` when you finish it, so the review fills itself as you use them. A book you finished before you used the plugin can be given a `finished` property by hand.

## Writing the review

Run **Reading: Year in review…**, choose a year, and the dialog says what it will write. Choose **Write**. The note is `Books/Reading/<year>.md` (change the folder in **Settings → Notes → Reading**).

![A year in review note: the headline, then a table of books by month with bars](img/year-in-review.png)

It holds:

- the headline: books finished, how that compares with the year before, and hours of audiobook;
- **By month**, with text bars;
- **Formats**, **Shelves** and **Authors**: how many finished books each has (a book in two formats counts once in the total and once under each);
- **Pace**: the average days from started to finished, and the quickest and slowest book (a book with no `started` date adds nothing here);
- **Finished**: every book, in order, as a link;
- **Reading now**, with how far through you are.

Run it again any time and the generated part is rewritten. Anything you write above or below it stays. It can be undone from the notice or the Library panel's **Changes you can undo**.

## Progress

How far through a book you are comes from the place the reader saves. The reading list shows a **NN% read** badge on a book you are reading, and the Library panel has a **Reading now** section with a bar and a **Continue** button.

![The Library panel's Reading now section](img/reading-now.png)

A book with no saved place shows no percentage.

## Goals and streaks

Set **Settings → Notes → Reading → Reading goal** to the number of books you want to finish this year (zero for none). The Library panel's **Your reading** section then shows how many you have finished against an even pace through the year ("15 of 24 books: 3 ahead of pace") with a bar, and this year's review note gains a **Goal** line.

The reader also keeps a small log of the days you read: a date and a count of page turns, never a title, kept in the plugin's data on your computer. Opening a book does not count; turning pages does. From it the panel shows your streak (a streak lasts through the day after your last reading day), your longest streak and how many days you have read, and the review says on how many days you read that year. Days read outside the reader are not known to the plugin, so they are not counted.