User:Simon/Notes on text workflow: Difference between revisions

From XPUB & Lens-Based wiki
No edit summary
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
<pre><code>
<pre>
---
---
title: notes on texts
title: notes on texts
Line 65: Line 65:
* 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
* 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


<pre><code>
 
---
---
title: Annotations on Exercises In Style
title: Annotations on Exercises In Style
Line 71: Line 71:
date: 21/05/20
date: 21/05/20
---
---
</code></pre>
 


* Write your annotations, use markdown* if possible
* Write your annotations, use markdown* if possible
Line 93: Line 93:
and so on...
and so on...


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


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


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


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


**4. export to plain text from etherpad**
**4. export to plain text from etherpad**
Line 113: Line 111:
* Using pandoc*, run this command in the terminal (swap out the file names)
* Using pandoc*, run this command in the terminal (swap out the file names)


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




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


</pre></code>
</pre>

Latest revision as of 17:48, 2 June 2020

---
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>

### 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


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


* 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 *single asterisks*, bold with **double asterisks**

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

# Annotations on *Notation*
    [page 17](https://hub.xpub.nl/bootleglibrary/read/382/pdf#page=17)


**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)

pandoc --from markdown --to epub my_etherpad.txt -o annotations.epub


**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



## 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/>