User:Simon/Notes on texts workflow

From XPUB & Lens-Based wiki
< User:Simon
Revision as of 15:24, 22 September 2020 by Simon (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

workflow for Notes on Texts, a session that annotates a collection

Documentation in markdown, from a pad. This allows an EPUB to be made from an exported txt by running it through pandoc. Most important is the first four lines - to make an EPUB you need to have metadata for at least the title and author, which was interesting to consider when making annotations on a text. Who retains authorship? Who claims it?

Some screenshots from the session:

---
title: notes on texts
author: collective/Etherpad
---

Notes on *Notes on Texts*, with Simon Browne, contingent librarian* at the bootleg library*

## url to this editable pad
<https://pad.xpub.nl/p/Notes_on_texts>

## bootleg library
+ <https://hub.xpub.nl/bootleglibrary>

### we will use:
* calibre-web, the software the bootleg library runs on
<https://github.com/janeczku/calibre-web>

* Etherpad, a browser-based, realtime collaborative text editor
<https://pad.xpub.nl>

* Markdown, a lightweight markup language
<https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet>
<https://daringfireball.net/projects/markdown/syntax>

* Pandoc, a universal document converter
<https://pandoc.org/>
Installation guide:
<https://pandoc.org/installing.html>

### workflow summary:
    
**1. upload to the bootleg library**<br />
**2. select a PDF, choose a page from that text**<br />
**3. annotate the page in a new etherpad document (use markdown for structure)**<br />
**4. export to plain text from etherpad**<br />
**5. convert .txt to .EPUB**<br />
**6. upload to the bootleg library**<br />
**7. paste URL of the pad you used**<br />

### workflow steps in detail:

**1. upload to the bootleg library**

* Click 'upload'
* Choose a text from your computer
* Enter metadata, or download it
* Click 'submit'


**2. select a PDF, choose a page from that text**

* Click on a catalogue entry to see the book details
* Click on 'read in browser', choose 'pdf'
* Part of what calibre web does is create URLs for each book in the library, for instance, Raymond Queneau, Exercises in Style is now referenceable as....

<https://hub.xpub.nl/bootleglibrary/read/382/pdf>

* Scroll to a page in the browser e-reader
* Add an anchor to the URL with #page=17 (this will load the URL at pg 17)

<https://hub.xpub.nl/bootleglibrary/read/382/pdf#page=17>


**3. annotate the page in a new etherpad document (use markdown for structure)**

* Make a new etherpad document* using <https://pad.xpub.nl>, name it anything you want
* Add details for title and author following the example below. The title and author can be anything you want, but this metadata is required to make an EPUB, so make sure you enter something

<code>
---
title: Annotations on Exercises In Style
author: collaborative/Etherpad
date: 21/05/20
---
</code>

* Write your annotations, use markdown* if possible

Cheatsheet available here: <https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet>

### Quick Markdown guide

* You can add URLs as hyperlinked text, for example with 

    [Label text here](https://hub.xpub.nl/bootleglibrary) 

    or

* You can also add a URL like this

    <https://hub.xpub.nl/bootleglibrary>


* Headings can be added like this:


    # h1

    ## h2

    ### h3


    and so on...


* Emphasis can be added with <code>*single asterisks*</code>, bold with <code>**double asterisks**</code>


* Add a heading, and the URL to the pdf, before exporting, for example

<code>
# Annotations on *Notation*

    [page 17](https://hub.xpub.nl/bootleglibrary/read/382/pdf#page=17)
</code>

**4. export to plain text from etherpad**

* Click on the 'Import/Export from/to different file formats' option
* Export current pad as: 'plain text' (the file will be saved as a .txt, and named after the pad)


**5. convert .txt to .EPUB**

* Using pandoc*, run this command in the terminal (swap out the file names)

<code>
pandoc --from markdown --to epub my_etherpad.txt -o annotations.epub
</code>


**6. upload to the bootleg library**

* Click on the book you annotated to see the book details
* Click on 'Edit metadata'
* Scroll down, click on 'Upload Format'
* Upload the EPUB you made to the same catalogue entry

**7. paste URL of the pad you used:**

https://pad.xpub.nl/p/exercises_in_style_annotations
https://pad.xpub.nl/p/entreprecariat_annotations
https://pad.xpub.nl/p/Annotations_On_The_End_of_Policing



## other tools for annotation
<https://linux.die.net/man/1/pdftk> (tool: stamp)

<https://beepb00p.xyz/annotating.html>  (annotating the web)

<https://hypothes.is/><br />
<https://pzwiki.wdka.nl/mediadesign/User:Angeliki/X-LIB/Annotations><br />
<https://pzwiki.wdka.nl/mediadesign/File:Annotated_stein.jpg><br />


## other references

House of Leaves, Danielewski

<https://www.katjarempel.de/project/ebookdossier.html>

<http://www.kajsadahlberg.com/work/a-room-of-ones-own--a-thousand-libraries/>