* Introduction

~bibli-paris~ is a Spacemacs layer that adds functionnalities to ~org-mode~ so
as to enable the management of reading lists of documents from Paris' network of
libraries.

* Setup

** Enabling the layer

Clone this repository in your ~.emacs.d/private/layers~ folder and enable the
layer in your ~.spacemacs~ file.

** Creating a reading list file

First, go to https://bibliotheques.paris.fr/ and look up documents you're
interested in. Select them and export your selection as a CSV file ~Export.csv~.

Next, create your reading list file ~my_reading_list.org~ and open it in Emacs.

Finally, call the function ~bibli-paris/import-from-csv~ with argument the path
to ~Export.csv~.

* Commands

The following commands are available.

| Command                         | Shortcut | Description                                                                                                                                                                                                                          |
|---------------------------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ~bibli-paris/mode~              | ~SPC mb~    | Enable the shortcuts described in this table.                                                                                                                                                                                        |
| ~bibli-paris/import-from-csv~   | ~SPC mi~    | Import entries from the CSV file downloaded on https://bibliotheques.paris.fr/. The first argument is the path to the CSV file, and the second and third (optional) arguments are the tags and state to set the imported entries to. |
| ~bibli-paris/sort~              | ~SPC ms~    | Sort the entries by their quotes.                                                                                                                                                                                                    |
| ~bibli-paris/update-entry~      | ~SPC mu~    | Asynchronously update the availability status and quote of the entry at point.                                                                                                                                                       |
| ~bibli-paris/update-entries~    | ~SPC mU~    | Asynchronously update all the availabity status and quotes of all entries in parallel.                                                                                                                                               |
| ~bibli-paris/archive-all-read~  | ~SPC mA~    | Archive all entries in the ~DONE~ state.                                                                                                                                                                                             |
| ~bibli-paris/number-of-entries~ | ~SPC m?~    | Display the number of entries in the current buffer.                                                                                                                                                                        |

* Customization

The following variables may be customized.

| Variable name                            | Type    | Default value                  | Description                                                                                                                                                          |
|------------------------------------------+---------+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ~bibli-paris/default-library~            | string  | ~75013 - Jean-Pierre Melville~ | The library from which to fetch updates.                                                                                                                             |
| ~bibli-paris/max-asynchronous-processes~ | integer | ~500~                          | The maximum number of asynchronous requests that should be launched in parallel. The default value was determined experimentally to be the maximum allowed by Emacs. |