Courses/Hybrid publishing resources
<slidy theme="a" />
- 1 publicationstation.wdka.hro.nl/wiki
- 2 Focus
- 3 Hybrid Publishing Workflow
- 4 Hybrid Publishing Workflow
- 5 How?
- 6 Structure
- 7 How to achieve explicit structure?
- 8 Markup languages
- 9 Pandoc
- 10 ******************
- 11 mark a text in MS Word/Libre Office
- 12 convert
- 13 convert once more, now toward Markdown
- 14 Why Markdown ?
- 15 *******
- 16 streamlining conversions
- 17 1. Manuscript: .docx
- 18 2. Source: converting the manuscript files to Markdown files
- 19 3. make icmls - ICML files for inDesign
- 20 4. make book.epub
- 21 ICML files
Transforming a source (manuscript) into multiple publishable outputs, within a hybrid publishing workflow
Hybrid Publishing Workflow
- various outcomes from one workflow
- constant connection between source-content and outcome
- avoiding repeating tasks
Hybrid Publishing Workflow
How can we achieve a publishing workflow where we can go from the source (a word document, a wiki page, a webpage) to several outputs (an EPUB, a website, an animated gif, an inDesign project)?
By putting the content into an explicit structure, which can withstand those transformations.
So what is a title (heading) in a format, remains a title when translated to a different format.
How to achieve explicit structure?
An explicit structure is achieved by marking the text with structural information.
marking the text = markup
<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>
= 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
# 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
pandoc: software for converting between markups with
mark a text in MS Word/Libre Office
create a .docx file and mark it up with a few of the following paragraph and characters styles:
- body text
- block quotes: indented blocks of text
- Preformatted text
Save in .docx
Convert your docx file into a an HTML file using Pandoc.
pandoc -f docx -t html5 -s input.docx -o output.html
pandoc - program dedicate to the conversion between different markups.
-f - option standing for “from”, is followed by the input format;
-t - option standing for “to”, is followed by the output format;
-s - option standing for “standalone”, produces output with an appropriate header and footer;
-o - option for file output;
input.docx - docx input filename - you need to replace it by its actual name
convert once more, now toward Markdown
-t markdown Option: toward Markdown
--atx-headeres Option: use nice Markdown headers
Why Markdown ?
- only one way to create a structure
- 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.
This same approach for converting between markups using Pandoc can be automated.
Since computers are good at doing repetitive and boring tasks, we can take advantage from it.
We can store commands in scripts and have them perform the same task on multiple source files, producing multiple outputs (E.G. EPUB, ICML, HTML).
In this process, from several .docx files we'll try to create two outputs:
- an ICML file for inDesign
- an EPUB
And we'll also try to keep a connection between the source and its outcomes.
My proposal involves using a Makefile to automate the conversions between markups.
They are like recipe book, with instructions of how to process stuff and generate other stuff from it.
Read more about Makefiles in the context of hybrid publishing:
- blog post Make Book by Michael Murtaugh
- Report on the Don Marti's presentation at SCALE
- GNU Make official site
Download Hybrid Publishing Resources
- Download the zip from Hybrid Publishing Resources code repository to your computer.
- Move the downloaded .zip to a dedicated folder.
- In terminal change directory
cdto the unzip folder
0. Folder structure
To create folder structure, which will be understood by the scripts from this repository, you need to run:
This script will generate the following folder structure, which you'll use to store the files essentially for the creation of the EPUB.
├── docx ├── epub ├── icml ├── md │ └── imgs └── scripts
1. Manuscript: .docx
This is a preparatory stage. Yet it is important for the series of conversions that will lead to the different publication's outputs.
You need to edit the manuscript, handed by the author, using paragraph styles in MS Word/Libre Office/Open Office
2. Source: converting the manuscript files to Markdown files
make markdowns to start this stage.
This command will convert all the
.docx files inside the
docx/folder into corresponding markdown files inside
The resulting markdown files are the source files, from which all of the publication's outputs will be generated.
2.1 Images in Markdown
At this stage you should insert the images onto the texts, now in markdown format.
First of all, you need to save all the images included in the essays in the folder
md/imgs/ Then place the images on the markdown document:
![My image caption](imgs/myImage.jpg)
Don't forget to include captions, if the image has them. Markdown captions will become visible, and associated to the image in the EPUB output.
3. make icmls - ICML files for inDesign
make icmls to start this stage.
The individual Markdown source files, stored in
md/, can be converted into ICML files which can be imported into inDesign.
Read more on ICML files and inDesign in #working_with_ICML_files section
4. make book.epub
4.0 make book.md
You don't have to perform this step, the makefile does it for you.
It generates a single Markdown file
book.md and save it it inside the
book.md consists of the content from all the individual Markdow files inside the
md/ folder, in alphabetical order (00 to ZZ).
If you want to change the order the publication, you can change the filenames in order to do so.
Markdown filenames should NOT contain spaces or dots, except for the extension
4.1 make book.epub (EPUB)
Produce the epub file:
4.1.1 Essential files for EPUB
To produce an EPUB a few files are needed, namely:
- cover image
- CSS stylesheet
These files will strongly influence the EPUB's outcome, and consequently should be edited for each publication.
4.1.2 Fonts (optional) for EPUB
lib/ is folder for storing custom fonts, that will be used in the EPUB
If you choose to use fonts, make sure to change the makefile to include the use of fonts in the makefile epub rule, such as in the rule bellow, where
--epub-embed-font=lib/UbuntuMono-B.ttf \ is added to allow for the use of the Ubuntu Mono font. Also include the font on the EPUB style-sheet with
4.1.3 EPUB check
The health of the created EPUB can be checked with http://validator.idpf.org/
4.1.5 make book.epub : An iterative process
This work is in many way as cyclical process, where you work in circles: changing the source files (markdown files, the EPUB's stylesheet, the EPUB's metadata) and seeing the results of those changes in Calibre (or other ebook-viwerer)
ICML files are useful, since they ensure that the structural information of the Markdown source files is also present in the inDesign projects, which use them.
With ICML it is also possible to update the content and structure of the inDesign projects, by changing the Markdown source files, converting the once more to ICML. For this to happens is however necessary that inDesign remains linked to its source, and that the designers works with paragraph and chapter styles, instead of directly into the text.
Note: malformatted links in the markdown files will create problems when imported into inDesign.
Open inDesign and ...
Place your output.icml in a inDesign project.
The Place function is in: File > Place (shortcut: Apple+D)
Design with Styles
Style the content using paragraph and character styles.
Paragraph/Characters styles are in: Type > Paragraph/Character Styles
ICML Content updates
Using Sublime Text, edit one ICML file adding some text to it.
See the content being updated in inDesign.
Hands off content
In in inDesgin content shall remain untouched until the last moment
If you change the content of the articles inDesign, the link between the inDesign content and its source ICML file will be lost, and it no longer be able to be updated.
This "disconnection" should only be the last step to be done on your design workflow.
- Shell terminal - a text-based interface to your file system. there are plenty of terminal tutorial online, here are some:
- pandoc - markup converter software
- plain-text editor: Sublime Text or Gedit
- Markdown syntax: http://daringfireball.net/projects/markdown/syntax provides a good overview not only of the syntax, but also the philosophy behind Markdown.