Epub

From ConTeXt wiki
(Redirected from epub)
Jump to: navigation, search

Contents

Minimal example

A minimal example file would be:

\setupbackend[export=yes,xhtml=yes]

\mainlanguage[de]
\language[de]

\setupexport
   [title={A nice book},
    author={John Doe},
    firstpage={huhn.jpg},
   ]

\starttext
Hello world!
\stoptext

Please note, that a cover image is part of a valid epub file, therefore you should provide one even in the most minimal case. It is called huhn.jpg in this case. Make sure it is in the same directory as you tex file. Now you have to call the script to produce the epub

mtxrun --script epub --make test_00.specification

assuming that the minimal example tex file is called test_00.tex

More information

ConTeXt has preliminary epub support starting from current 2011.05.18. Some problems were fixed end of August 2014, don’t use an older version!


In order to make an epub (archive) from your ConTeXt source files, you need to:

  1. enable the export backend in your .tex file or environment file (see Project structure)
  2. call the appropriate mtxrun command (with the epub script) shown in the output of a context run or in the log file


Note: There is no support for graphics yet, that will be included in a later version.

There’s also a more extensive example.

Export

To enable the export backend, depending on your needs, one of the following lines has to be included at the beginning of the document (before \starttext).

\setupbackend[export=yes,xhtml=yes]
\setupbackend[export=yes,xhtml=whatever.xhtml]
\setupbackend[export=yes,css={whatever.css,somemore.css}]

The backend can export into:

For making an epub, you need an xhtml export.

If you are unsure, which one of the three backend options you should use, use the minimal one:

\setupbackend[export=yes,xhtml=yes]

When using a css file, images are supported using an extra css file *-images.css. Images with suffix pdf are remapped to svg but png and jpg are passed on.

You can add metadata using the following command:

\setupexport
   [title={A nice book},
    author={John Doe},
    firstpage={huhn.jpg},
   ]

The example file

You can also hook css into the output, see thread: ntg-context. The distribution has a test file export-example.tex. This file exports conforming:

\setupbackend
   [export=export-example.xml,
    xhtml=export-example.xhtml,
    css=export-example.css]

This file shows some of the possibilities. You will notice that it is a rather normal context file. When the file is processed, you can create an epub file with:

mtxrun --script epub --make export-example

Additional tagging

You can mark sections that don't need to be exported:

\startelement[ignore]

   titlepage makeup 

\stopelement

You can also add data:

\settaggedmetadata[name=Me]

\startchapter[title=...]
   ....
\stopchapter

In this case the data will be injected just after the start of the chapter tag. So, if you want to have document level metadata, you need to put the set command before \starttext.

Document styling

Some style elements are exported to an additional css file and a reference to that file is automatically added. You can exercise some control over the general document rendering:

\setupexport
  [bodyfont=12pt,
   width=600pt,
  %align=flushleft,
   hyphen=yes]

The last option makes sure that the export has enough information to do a reasonable hyohenation. Future versions of the exported might provide some more control.

Mtxrun

The actual generation of the epub can be triggered with the mtxrun command shown in the output.

Example log entry:

...
backend         > export > saving xml data in 'oeps.export
backend         > export > saving css template in 'oeps.template
backend         > export > saving xhtml variant in 'oeps.xhtml
backend         > export > saving specification in 'oeps.specification' (mtxrun --script epub --make oeps.specification)
...

The "oeps" will be replaced with the appropriate name given to the export backend.

Therefore, execute:

mtxrun --script epub --make oeps.specification

This will create an oeps.tree folder with an oeps.epub inside it. When pdf images are used and no suitable svg alternative is present inkscape will be used to create the svg file.

More on this on the mailing list, thread starts at: ntg-context.

Tools

Viewer:

Online:

Editor:

Validation:

Specification:

Current Issues

As of 08:41, 16 June 2011 (CEST):

tool description error
mtx-epub.lua OPF 2.0.1 amazoncover, bookid, id & ncx fix
epubcheck-1.2 OPS 2.0.1 test.xhtml: <document>
elements from namespace "" are not allowed
xhtml DOCTYPE missing, html + body elements
epubreader OPS 2.0.1 This XML file does not appear to have any style information associated with it.
kindlegen OPS 2.0.1 No BODY tag found in content file.


feature description
metadata add author and title to local:package and local:navigation (mtx-epub.lua)
cover add cover element, 600×800 (min. 500) for amazon
toc table of contents is missing
chapter break new title element → new xhtml

Latest news

(This section is to be integrated in the instructions above.)

Now

   \setupbackend
     [export=yes,
      xhtml=yes,
      css=export-example.css]

also exports an html file with all tags being 'div' and the default css has been adapted to support both. The default css still need some work because not all browsers handle these div expressions equally well. The idea is to have a decent looking default as template (one can always overload).

--Hans 27 August 2014

The problem with an invalid export.xml when using project structure is also fixed since 27 August 2014.

C O N T E X T G A R D E N

Personal tools
Namespaces
Variants
Actions
Help
External Help
Installation
Navigation
Toolbox