Changes

{{todo|Beware, this doesn’t fit the current export files and ePub workflow as of January 2015!}} < [[Epub]]| [[XML]] | [[Export]] | [[ePub|New ePub docs]]>

Here I’ll show you my workflow for creating ebooks of my songbooklets (that use [[LilyPond]] via [http[modules://modules.contextgarden.net/t-filter |filter module]] for the notes).

UnfortunatelyBeware, you need a current beta version of ConTeXt has a bug in XML creation , since Hans fixed some export related bugs in this setupthe last few days! --[[User:Hraban|Hraban]] 13 September 2014.

\setupexport[ hyphen=yes,

subtitle={}, version={\expandexpanded\currentdate}] % doesn’t work]

author={Hraban}] \definehighlight[emph][style=italic] % use \emph{something} instead of {\em something}

Make sure to tag all your structural elements with <{{cmd>|start...</cmd>}}-<{{cmd>|stop...</cmd>}}, e.g. <{{cmd>|startchapter</cmd>}}, but even <{{cmd|startparagraph}}! In places where {{cmd>|startparagraph</}} does not work, such as itemizations, where it causes a blank line after the bullet and before the item text, use {{cmd|bpar}} (and closing {{cmd>!|epar}}) to tag paragraphs.

<codepre>

</codepre>

The first creates {{code|export.xml }} and a bunch of other files.The second creates a directory "{{code|ebook.tree" }} with the proper structure for ePub. The ePub file in the tree directory is unusable.

== Fix export.xml ePub structure ==

If you run the epub script on a single file, you’ll get a well-formed and usable export.xml. If you use a project structure, the root node <code>&lt;document&gt;</code> This is missing. Just put it in manually (after the comment lines). You can also move the <code>&lt;metadata&gt;</code> block out of the first directory structure, but that’s merely a cosmetical error.that we need for our ePub:

A proper export<pre>/songbook.tree/├── META-INF│   └── container.xml starts like this:├── OEBPS│   ├── Fonts│   │   └── somefont.otf│   ├── Images│   │   ├── ...│   │   ├── c_farewell-1.png│   │   ├── c_farewell-2.png│   │   ├── c_farewell.png│   │   ├── ...│   │   └── cover.jpg│   ├── Styles│   │   └── style.css│   ├── Text│   │   ├── _intro.html│   │   ├── aut_1.html│   │   ├── ...│   │   └── aut_99.html│   ├── cover.html│   ├── songbook.opf│   └── toc.ncx└── mimetype</pre>

<code>&lt;?We use mimetype and container.xml version="1unchanged from ConTeXt’s epub script and (re)create everything else.0" encoding="UTF-8" standalone="yes" ?&gt; &lt;!-- input filename : solo --&gt;&lt;!-- processing date : Wed Aug 27 13:47:46 2014 --&gt;&lt;!-- context version : 2014.08.21 09:56 --&gt;&lt;!-- exporter version : 0.31 --&gt; &lt;document language=At the end this structure is just zipped with an "enepub" file="solo" date="Wed Aug 27 13:47:46 2014" context="2014.08.21 09:56" version="0.31" xmlns:m="http://www.w3ending.org/1998/Math/MathML"&gt; <metadata> <metavariable name="author">Hraban</metavariable> </metadata> <section detail="chapter" location="aut:1">...</code>

For the records: === {{code|mimetype}} === <pre>application/epub+zip</pre> === {{code|container.xml}} === <xmlcode><?xml version="1.0" encoding="UTF-8"?> <container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container"> <rootfiles> <rootfile full-path="OEBPS/songbook.opf" media-type="application/oebps-package+xml"/> </rootfiles></container></xmlcode> == Transform XML to HTML etc. ==

I use the free version of [[http://saxon.sourceforge.net Saxon]] and some XSL transformations for the conversion.

The incantation goes like <{{code>|saxon -o:content.xhtml -s:export.xml -xsl:export2html.xsl</code>}}.I installed Saxon on my Mac with MacPorts, then instead of just "saxon" you must call <{{code>|java -jar /opt/local/share/java/saxon9he.jar</code>}}.

This is my **=== {{code|export2html.xsl**:}} ===

<codexmlcode>

<xsl:variable name="within-paragraph">0</xsl:variable ><!-- statusxsl: are we variable name="within a paragraph? -section">0</xsl:variable ><xsl:variable name="previous-section">0</xsl:variable >

<xsl:template match='section'><!-- <xsl:if test="@detail='part'"> <xsl:text disable-output-escaping="yes"><![CDATA[</div></body></html>]]></xsl:text> </xsl:if>--> <xsl:result-document method="xml" href="aut_{@implicit}.html"> <htmlxmlns="http://www.w3.org/1999/xhtml"> <head> <meta charset="utf-8" /> <title><xsl:value-of select='.//metavariable[@name="title"]sectiontitle'/> </title> <xsl:for-each select="//metavariable"> <meta> <xsl:attribute name="name"> <xsl:value-of select="@name"/> </xsl:attribute> <xsl:attribute name="content"> <xsl:apply-templates/> </xsl:attribute> </meta> </xsl:for-each> <link rel="stylesheet" href="../Styles/style.css" type="text/css" ></link> </head> <body> <xsl:attributename="lang"> <xsl:value-of select='//document/@language'/> </xsl:attribute > <!-- <xsl:variable name="contentprevious-section">{$within-section}</xsl:variable > <xsl:variable name="within-section">{@detail}</xsl:variable > -->

</xsl:attribute> </meta> </xsl:for-each> <link rel="stylesheet" href="style.css" type="text/css" ></link> <!-- for testing the html outside the ePub tree --> <link rel="stylesheet" href="Styles/style.css" type="text/css" ></link></head><body lang="de"> <h1 class="booktitle"> <xsl:value-of select='//metavariable[@variable name="titlewithin-section"]'/>{$previous-section}</h1xsl:variable > <h2 class="subtitle"> <xsl:value-of select='//metavariable[@variable name="subtitleprevious-section"]'/>0</h2> <p class="author"><xsl:value-of select='//metavariable[@name="author"]'/></pvariable > <xsl:apply --templates/> </body> </html> </xsl:template> <xsl:template match="metadata"result-document></xsl:template>

<h2h1><xsl:apply-templates/> </h2h1>

<h3h2><xsl:apply-templates/></h2> </xsl:when> <xsl:when test="../@detail='Titel'"> <h2><xsl:apply-templates/></h2> </xsl:when> <xsl:when test="../@detail='TitelKlein'"> <h2><xsl:apply-templates/></h3h2>

<h4h3><xsl:apply-templates/> </h4h3>

<h5h4><xsl:apply-templates/> </h5h4>

<h6 class="../@detail"><xsl:apply-templates/> </h6>

<img src="../Images/{substring-after(@name,'prd_songbookprd_hraban-temp-lilypond-')}.png" id="{@id}" alt="{@name}" />

<a href="#{@location}" title="{@destination}"><xsl:apply-templates/></a></xsl:template> <xsl:template match="register"></xsl:template> <xsl:template match="registerentry"></xsl:template> <xsl:template match="registerpage"></xsl:template>  </xsl:stylesheet> </xmlcode> === {{code|style.css}} === Now you have a (hopefully usable) (X)HTML file, you need a CSS for the styling. A simple example: <pre>body { font-family: TeX Gyre Schola, Century Schoolbook, serif; font-size: 12pt; margin: 0 auto; max-width: 40em; line-height: 1.44; -webkit-hyphens: auto; -moz-hyphens: auto; -ms-hyphens: auto; hyphens: auto;} h1, h2, h3, h4, h4, h6 { font-family: TeX Gyre Heros, Helvetica, Arial, sans-serif; color: #286000; -webkit-hyphens: manual; -moz-hyphens: manual; -ms-hyphens: manual; hyphens: manual;} .Titel, .chapter { margin-top: 1em; border-top: 1px solid #600a00;} img { max-width: 100%; max-height: 100%;} .lilypond { margin: 1em 0;} .lilypond img { width: 100%; margin-bottom: 0.25em;}</pre> == Create a Cover == Create a {{code|cover.xhtml}}: === {{code|export2cover.xsl}} === <xmlcode><?xml version="1.0" encoding="UTF-8" ?><xsl:stylesheet version= "2.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> <xsl:output method="xml" encoding="utf-8" indent="yes" omit-xml-declaration="yes"/> <xsl:template match="/"><html> <head> <title><xsl:value-of select='//metavariable[@name="title"]'/></title> <link rel="stylesheet" href="style.css" type="text/css" ></link> <link rel="stylesheet" href="Styles/style.css" type="text/css" ></link> </head> <body> <div> <img src="Images/cover.jpg"> <xsl:attribute name="alt"> <xsl:value-of select='//metavariable[@name="title"]'/> </xsl:attribute> </img> </div> </body></html>

<ncx xmlns="http://www.daisy.org/z3986/2005/ncx/" version="2005-1">  <head> <meta name="dtb:uid" content="BookId" /> <meta name="dtb:depth" content="1" /> <meta name="dtb:totalPgeCount" > <xsl:attribute name="content"> <xsl:value-of select='count(section[starts-with(@detail,"Titel")])' /> </xsl:attribute> </meta> <meta name="dtb:maxPageNumber"> <xsl:attribute name="content"> <xsl:value-of select='count(section[starts-with(@detail,"Titel")])' /> </xsl:attribute> </meta> </head>  <docTitle> <text><xsl:value-of select='//metavariable[@name="title"]'/></text> </docTitle>  <docAuthor> <text><xsl:value-of select='//metavariable[@name="author"]'/></text> </docAuthor>  <navMap> <navPoint id="aut_0" origin="aut_0" playOrder="0"> <navLabel> <text>Cover</text> </navLabel> <content src="cover.html"/> </navPoint> <navPoint id="aut_1" origin="aut_1" playOrder="1"> <navLabel> <text>Start</text> </navLabel> <content src="Text/_intro.html"/> </navPoint> <xsl:for-each select="//registerentry"> <xsl:variable name="location"> <xsl:value-of select='(./descendant::link/@location)[1]'/> </xsl:variable > <xsl:variable name="origin"> <xsl:value-of select='//registerlocation[@internal=$location]/ancestor::section[starts-with(@detail,"Titel")]/@implicit'/> </xsl:variable >  <navPoint> <xsl:attribute name="id"> <xsl:value-of select='$location'/> </xsl:attribute> <xsl:attribute name="origin"><xsl:value-of select="$origin" /></xsl:attribute> <xsl:attribute name="playOrder"> <xsl:value-of select="2 + count(preceding-sibling::registerentry)" /> </xsl:attribute> <navLabel> <text><xsl:value-of select='./registercontent'/></text> </navLabel> <content> <xsl:attribute name="src">Text/aut_<xsl:value-of select='$origin' />.html</xsl:attribute> </content> </navPoint> </xsl:for-each>  </navMap></ncx></xsl:template> </xsl:stylesheet></xmlcode> The links to a named anchor should work, but don’t in my reader. I must investigate further... == Converting images == In my case, all images are note lines, generated by LilyPond in one temporary directory. Your mileage will vary.ConTeXt’s epub script creates a list of images in {{code|export-images.css}}, you might want to parse that to find all images. <pre>cd $LILYPONDTEMPDIRfor IMG in prd_songbook-temp-lilypond-*.pdf; do NEWIMG=${IMG#prd_songbook-temp-lilypond-} convert -density 196 $IMG'[0]' -trim +repage ../songbook.tree/OEBPS/Images/${NEWIMG%.pdf}.pngdone</pre> == Create ePub == Look at the tree above - are all your files in the right location? Then zip your tree! <pre>cd songbook.treezip -uqr ../songbook.epub *</pre> Now test it with your reader or editor (e.g. Calibre). (Apple iBooks or Adobe Digital Editions don’t work.) == Shell script == Of course I don’t do all these steps above manually. Here’s my little shell script. === {{code|epub.sh}} === <pre>#!/bin/bash# call as "./epub.sh productname" # ConTeXt is not in my usual path (setuptex needs too long to be called with every shell);# probably your installation is at a different locationif [ "$TEXROOT" == "" ]; then source ~/Library/texmf/tex/setuptex ~/Library/texmf/texfi # all my products are named like "prd_something.tex"PRD=$1if [ ! -e prd_${PRD}.tex ]; then echo "Product ${PRD} not found!" exit 1fi # all XSL files are in this WORKDIRWORKDIR=epub-workflow # my ConTeXt wrapper "makeit.sh" script creates PDFs with a dateISODATE=`date +"%Y-%m-%d"`PRDPDF=${PRD}_${ISODATE}.pdf # LilyPond is run in this TEMPDIR and creates its note images thereTEMPDIR=lilytemp EPUBPREFIX=epub_TREE=${PRD}.treeOEBPS=${TREE}/OEBPSSAXON="java -jar /opt/local/share/java/saxon9he.jar"# http://saxonica.com/documentation/html/using-xsl/commandline.html if [ ! -f export.xml ]; then echo "File export.xml not found! Trying to run ConTeXt..." # you should replace this call with your own ./makeit.sh ${PRD} exit 2fi if [ ! -f $PRDPDF ]; then echo Product $PRDPDF not found! echo Please run "makeit.sh $PRD" exit 3fi if [ ! -d $OEBPS ]; then echo Directory $OEBPS missing! echo Creating new ePub ... mtxrun --script epub --make ${PRD}fi if [ -d $OEBPS ]; then echo "Creating directories (might exist) ..." mkdir $OEBPS/Styles mkdir $OEBPS/Images mkdir $OEBPS/Fonts mkdir $OEBPS/Text  echo Creating HTML ... $SAXON -o:$OEBPS/Text/_intro.html -s:export.xml -xsl:$WORKDIR/export2html.xsl echo Creating OPF ... $SAXON -o:$OEBPS/${PRD}.opf -s:export.xml -xsl:$WORKDIR/export2opf.xsl echo Creating ToC NCX ... $SAXON -o:$OEBPS/toc.ncx -s:export.xml -xsl:$WORKDIR/export2ncx.xsl echo Creating Cover ... $SAXON -o:$OEBPS/cover.html -s:export.xml -xsl:$WORKDIR/export2cover.xsl echo Creating cover image from first page of PDF ... convert -density 196 $PRDPDF'[0]' +repage $OEBPS/Images/cover.jpg echo Copying files ... cp style.css $OEBPS/Styles/ # This copies only fonts from your project directory; adapt. cp *.?tf $OEBPS/Fonts/  echo Converting images from PDF to PNG ... cd $TEMPDIR for IMG in prd_${PRD}-temp-lilypond-*.pdf; do NEWIMG=../$OEBPS/Images/${IMG#prd_${PRD}-temp-lilypond-} NEWIMG=${NEWIMG%.pdf}.png if [ ! -f $NEWIMG ]; then convert -density 196 $IMG'[0]' -trim +repage ${NEWIMG} fi done cd .. # delete old epub rm $TREE/${PRD}.epub rm ${EPUBPREFIX}${PRD}.epub echo Creating ePub ${EPUBPREFIX}${PRD}.epub ... cd $TREE zip -uqr ../${EPUBPREFIX}${PRD}.epub * cd ..fiecho Ready.</pre>