Thematic-Making It Public/publication workshop: Difference between revisions

From XPUB & Lens-Based wiki
No edit summary
Line 94: Line 94:


* a very messy repository
* a very messy repository
** unnecessary are tracked - not all files are needed. If one is doing experiments is better not to add or push those files to the repository; Instead a new local repository can be created (or a separate branch) 
* difficult to navigate and know what is important and what irrelevant  
* difficult to navigate and know what is important and what irrelevant  
* need more structure
* need more structure
Line 99: Line 101:
*  
*  


Macdown
Markdown cheat-sheet


epub as it is now
epub as it is now


===Sofware===
=Tools=
===Software overview===
* '''ebook reader''':
* '''ebook reader''':
** Calibre - http://calibre-ebook.com/ (Calibre is also useful as an
** Calibre - http://calibre-ebook.com/ (Calibre is also useful as an
Line 113: Line 113:
rendering EPUB 3 publications".
rendering EPUB 3 publications".
** ibooks (if you have Mac)
** ibooks (if you have Mac)
* '''Pandoc''' - Markup (file) converter http://johnmacfarlane.net/pandoc/installing.html
* '''Pandoc''' - Markup (file) converter http://johnmacfarlane.net/pandoc/installing.html
* '''Git'''
* '''Git'''
** (Mac) git is included in [Xcode https://developer.apple.com/xcode/download/], so install XCode.
** (Mac) git is included in [Xcode https://developer.apple.com/xcode/download/], so install XCode.
** Linux- download the package using the package repository
** Linux- download the package using the package repository
* '''Github'''
* '''Github'''
** Create an account on Github https://github.com/  (we might move away
** Create an account on Github https://github.com/  (we might move away
from github, but right now the repository is there)
from github, but right now the repository is there)
* '''epub validator'''
* '''epub validator'''
** online http://validator.idpf.org/
** online http://validator.idpf.org/
** program [https://github.com/IDPF/epubcheck epubcheck]  
** program [https://github.com/IDPF/epubcheck epubcheck]  


* **Markdown Syntax** in http://daringfireball.net/projects/markdown/syntax.


=Git=
* Markdown editor (Not essential. Most plain-text editors provide syntax highlighting for Markdown, yet you might want to use a WYSIWYG editor that renders that Markdown on-the-fly)
==current repository==
** (mac) MacDown - http://macdown.uranusjr.com/
 
 
==A markup language: Markdown==
Suggestion: unify the all content for the book under 1 plain text ''markup format'' - '''Markdown'''.
 
* Marking the text
"In electronic processing of texts, this hierarchical ordering of words into sentences, sentences into paragraphs and so on, as well as additional reading aids such bold or italic text, is made possible by using specific formatting codes. '''This process is called markup and the codes are called markup element'''"
 
* WYSIWYG - visual markup
"'What You See Is What You Get' (WYSIWYG) markup languages used in word processors such as Microsoft Word, WordPerfect or OpenOffice, where text which is marked up in a certain way (such as italic or bold) is immediately displayed that way, so that there is no visible distinction between the conceptual structure and the visual representation."
 
* Different Markup languages use different markup elements
[http://en.wikipedia.org/wiki/HTML HTML]:
 
<source lang="html4strict">
<h1>Revenge of the Text</h1>
<p>There is a room in the <strong>Musée d’Orsay</strong> that I call the <em>room of possibilities</em>.</p>
<p>That room contains:</p>
<ul>
  <li>a snow flake</li>
  <li>the end of a cloud</li>
  <li>a bit of nothing</li>
</ul>
</source>
 
[http://en.wikipedia.org/wiki/Wiki_markup Wiki markup]:
<pre>
= Revenge of the Text =
There is a room in the '''Musée d’Orsay''' that I call the ''room of possibilities''.
 
That room contains:
* a snow flake
* the end of a cloud
* a bit of nothing
</pre>
[http://en.wikipedia.org/wiki/Markdown Markdown]:
<pre>
# Revenge of the Text
There is a room in the **Musée d’Orsay** that I call the *room of possibilities*.
 
That room contains:
* a snow flake
* the end of a cloud
* a bit of nothing
</pre>
 
 
* Why a Markup
** text structure becomes explicitly
** different markups and markup based formats (epub) are mostly equivalent easily translatable:
eg. markdown -> html -> latex(pdf)
 
* Why Markdown ?
** simple
** compatible with HTML, but easier to read and write
** allows the inclusion of HTML tags.
** any plain text editor such as [http://www.sublimetext.com/ Sublime Text] or [https://wiki.gnome.org/Apps/Gedit Gedit] can edit Markdown files.
** there are WYSIWYG Markdown editors such as [http://macdown.uranusjr.com/ MacDown].
 
 
 
**Markdown Syntax** in http://daringfireball.net/projects/markdown/syntax.
 
<span style="background:yellow">Always use plain-text editors or WSIWYG editors to write in Markdown. Using a text-processor like MS Word,Libreoffice or Max text editor will result on binary or rich text formats. We need to work with plain-text files</span>
 
==Pandoc==
[http://johnmacfarlane.net/pandoc '''pandoc''']: software for converting between markups with
 
[[File:pandoc_diagram.png|thumb]]
 
 
<pre>pandoc --from markdown --to html5 --standalone input.md -o output.html</pre>
 
* <code>--from / -f</code> - option standing for “from”, is followed by the input format;
* <code>--to / -t</code> - option standing for “to”, is followed by the output format;
* <code>--standalone / -s</code> - option standing for “standalone”, produces output with an appropriate header and footer;
* <code>-o</code> - option for file output
 
=== converting the Markdown to EPUB. ===
Simple:
<code>pandoc --from markdown --to epub3 --self-contained mymarkdownfile.md --output=mybook.epub</code>
 
Advanced (indicating chapter level, stylesheet, cover image, metadata, TOC depth):
<code>pandoc --from markdown --to epub3 --self-contained --epub-chapter-level=1 --epub-stylesheet=styles.epub.css --epub-cover-image=cover.jpg --epub-metadata=metadata.xml --toc-depth=1 --output=mybook.epub mymarkdownfile.md</code>
 
* <code>--epub-chapter-level</code> - at what heading level will the chapter brakes occur
* <code>--toc-depth</code> - what heading level will be present in the Table of Contents
 
 
 
 
 
 
==Git==
===current repository===
===issues===
===issues===
* unnecessary are track - not all files are needed
** if one is doing experiments is better not to add or push those files to the repository; Instead a new local repository can be created (or a separate branch) 


* a new repository, based on Hybrid Publishing Resources structure
* a new repository, based on Hybrid Publishing Resources structure

Revision as of 16:21, 10 February 2016

Goal: hands-on work session to help develop the publication. We'll work towards getting everyone to integrate their contribution in the publication and see the result from his/her contribution right away.


State of matter

Where are we with the publication:

roles & tasks

    • Natalya: content transformations from videos onto still images ( pixel scan) + code snipets
    • Pleun: design
    • Colm: gathering and preface
    • Samira: write, editor
    • Nadine: coordinator
    • Max: translation onto code
    • Stone: content translation
    • Julia: reflective text (TBA)
    • Sara:

==content== What content will make it to the book?

structure

What is the structure of the book? thinking through its organization

generative & interactivity

"""Will the book contain generative or interactivity elements?""" If so, which and why?

Resources

git repository

https://github.com/pietzwart/making-it-public

.
├── book
│   ├── ashes.epub
│   ├── assets
│   │   ├── epubcover.jpg
│   │   ├── jquery-1.11.3.min.js
│   │   ├── jquery-1.7.0.min.js
│   │   ├── jquery-1.7.0.min.txt
│   │   ├── jquery.js
│   │   ├── script.js
│   │   └── script.txt
│   ├── chapter1.html
│   ├── epubcover.jpg
│   ├── generatebook.sh
│   ├── meta.xml
│   ├── mybook.epub
│   ├── _old
│   │   └── report.html
│   ├── report1.html
│   ├── report.html
│   ├── styles.css
│   └── title.html
├── Index_Sketch.ai
├── intro.md
├── Makingitpublic-report - Media Design- Networked & Lens-Based wiki.pdf
├── README.md
├── report.html
├── report.wiki
├── scans
│   ├── OCR
│   │   ├── archivingbooklet.jpg
│   │   ├── MER_3586.pdf
│   │   └── scanepud.rtf
│   └── wordexchange
│       ├── index.html
│       └── script.js
├── Screen Shot 2016-01-28 at 3.28.22 AM.png
└── test-mip
    ├── iTunesMetadata.plist
    ├── META-INF
    │   ├── com.apple.ibooks.display-options.xml
    │   └── container.xml
    ├── mimetype
    └── OEBPS
        ├── cover.xhtml
        ├── css
        │   └── style.css
        ├── images
        │   ├── book_cover.jpg
        │   ├── img_p01.jpg
        │   ├── img_p02.jpg
        │   ├── img_p03.jpg
        │   ├── img_p04.jpg
        │   └── img_p05.jpg
        ├── p01.html
        ├── p02.html
        ├── package.opf
        ├── report.html
        └── toc.xhtml
11 directories, 47 files
  • a very messy repository
    • unnecessary are tracked - not all files are needed. If one is doing experiments is better not to add or push those files to the repository; Instead a new local repository can be created (or a separate branch)
  • difficult to navigate and know what is important and what irrelevant
  • need more structure
  • need for a common format for text based content (Markdown files would be ideal)


epub as it is now

Tools

Software overview

EPUB editor)

Chrome/Chromium browser that aims to be "a reference system for rendering EPUB 3 publications".

    • ibooks (if you have Mac)

from github, but right now the repository is there)

  • Markdown editor (Not essential. Most plain-text editors provide syntax highlighting for Markdown, yet you might want to use a WYSIWYG editor that renders that Markdown on-the-fly)


A markup language: Markdown

Suggestion: unify the all content for the book under 1 plain text markup format - Markdown.

  • Marking the text

"In electronic processing of texts, this hierarchical ordering of words into sentences, sentences into paragraphs and so on, as well as additional reading aids such bold or italic text, is made possible by using specific formatting codes. This process is called markup and the codes are called markup element"

  • WYSIWYG - visual markup

"'What You See Is What You Get' (WYSIWYG) markup languages used in word processors such as Microsoft Word, WordPerfect or OpenOffice, where text which is marked up in a certain way (such as italic or bold) is immediately displayed that way, so that there is no visible distinction between the conceptual structure and the visual representation."

  • Different Markup languages use different markup elements

HTML:

<h1>Revenge of the Text</h1>
 <p>There is a room in the <strong>Musée d’Orsay</strong> that I call the <em>room of possibilities</em>.</p>
 <p>That room contains:</p>
 <ul>
  <li>a snow flake</li>
  <li>the end of a cloud</li>
  <li>a bit of nothing</li>
 </ul>

Wiki markup:

= Revenge of the Text =
There is a room in the '''Musée d’Orsay''' that I call the ''room of possibilities''.

That room contains:
* a snow flake
* the end of a cloud
* a bit of nothing

Markdown:

# Revenge of the Text
There is a room in the **Musée d’Orsay** that I call the *room of possibilities*.

That room contains:
* a snow flake
* the end of a cloud
* a bit of nothing


  • Why a Markup
    • text structure becomes explicitly
    • different markups and markup based formats (epub) are mostly equivalent easily translatable:
eg. markdown -> html -> latex(pdf)
  • Why Markdown ?
    • simple
    • compatible with HTML, but easier to read and write
    • allows the inclusion of HTML tags.
    • any plain text editor such as Sublime Text or Gedit can edit Markdown files.
    • there are WYSIWYG Markdown editors such as MacDown.


Always use plain-text editors or WSIWYG editors to write in Markdown. Using a text-processor like MS Word,Libreoffice or Max text editor will result on binary or rich text formats. We need to work with plain-text files

Pandoc

pandoc: software for converting between markups with


pandoc --from markdown --to html5 --standalone input.md -o output.html
  • --from / -f - option standing for “from”, is followed by the input format;
  • --to / -t - option standing for “to”, is followed by the output format;
  • --standalone / -s - option standing for “standalone”, produces output with an appropriate header and footer;
  • -o - option for file output

converting the Markdown to EPUB.

Simple: pandoc --from markdown --to epub3 --self-contained mymarkdownfile.md --output=mybook.epub

Advanced (indicating chapter level, stylesheet, cover image, metadata, TOC depth): pandoc --from markdown --to epub3 --self-contained --epub-chapter-level=1 --epub-stylesheet=styles.epub.css --epub-cover-image=cover.jpg --epub-metadata=metadata.xml --toc-depth=1 --output=mybook.epub mymarkdownfile.md

  • --epub-chapter-level - at what heading level will the chapter brakes occur
  • --toc-depth - what heading level will be present in the Table of Contents




Git

current repository

issues

  • a new repository, based on Hybrid Publishing Resources structure

Hybrid Publishing Resources

  • contribute, integrate, make

Future dev

  • what will be done by Open day?
  • wish-list
  • plan