summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2015-11-12 13:27:41 -0800
committerJohn MacFarlane <jgm@berkeley.edu>2015-11-12 13:27:41 -0800
commitc80c0df1fef118d32118dce222b204ae1f7b7f8b (patch)
treee3bff572fa0f59cf2c9a05160595367955570991 /README
parent83b1aa042d72cdb7790eec1de5d86bf2bded60db (diff)
EPUB writer: don't download linked media when `data-external` attribute set.
By default pandoc downloads all linked media and includes it in the EPUB container. This can be disabled by setting `data-external` on the tags linking to media that should not be downloaded. Example: <audio controls="1"> <source src="http://www.sixbarsjail.it/tmp/bach_toccata.mp3" type="audio/mpeg"></source> </audio> Closes #2473.
Diffstat (limited to 'README')
-rw-r--r--README19
1 files changed, 18 insertions, 1 deletions
diff --git a/README b/README
index d8953ed48..f11412b33 100644
--- a/README
+++ b/README
@@ -3489,8 +3489,11 @@ the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
`shrink`.
+Creating EPUBs with pandoc
+==========================
+
EPUB Metadata
-=============
+-------------
EPUB metadata may be specified using the `--epub-metadata` option, but
if the source document is markdown, it is better to use a [YAML metadata
@@ -3580,6 +3583,20 @@ The following fields are recognized:
[MARC relators]: http://loc.gov/marc/relators/relaterm.html
[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
+Linked media
+------------
+
+By default, pandoc will download linked media (including audio and
+video) and include it in the EPUB container, yielding a completely
+self-contained EPUB. If you want to link to external media resources
+instead, use raw HTML in your source and add `data-external="1"` to the tag
+with the `src` attribute. For example:
+
+ <audio controls="1">
+ <source src="http://www.sixbarsjail.it/tmp/bach_toccata.mp3"
+ data-external="1" type="audio/mpeg"></source>
+ </audio>
+
Literate Haskell support
========================