diff options
| author | Karl Berry <karl@freefriends.org> | 2020-04-14 21:04:20 +0000 |
|---|---|---|
| committer | Karl Berry <karl@freefriends.org> | 2020-04-14 21:04:20 +0000 |
| commit | 1da71ebcf192a4efb0ced33d228fc4d0ea2c57b5 (patch) | |
| tree | d2204368e4c13ff9c425b519dee197d19acba6a9 /Master/texmf-dist/doc/latex/media4svg | |
| parent | 90a718a9a627aec0f396f31710b608bdc24ebf72 (diff) | |
media4svg (14apr20)
git-svn-id: svn://tug.org/texlive/trunk@54733 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/media4svg')
7 files changed, 207 insertions, 195 deletions
diff --git a/Master/texmf-dist/doc/latex/media4svg/ChangeLog b/Master/texmf-dist/doc/latex/media4svg/ChangeLog index 17962b8f39d..aed1d228266 100644 --- a/Master/texmf-dist/doc/latex/media4svg/ChangeLog +++ b/Master/texmf-dist/doc/latex/media4svg/ChangeLog @@ -1,3 +1,7 @@ +2020-04-14 + * v0.4 + * fix: playback control via keyboard in Firefox + 2020-04-13 * v0.2 * fix: playback control on touch screens; expl3 fix diff --git a/Master/texmf-dist/doc/latex/media4svg/README.md b/Master/texmf-dist/doc/latex/media4svg/README.md deleted file mode 100644 index 8b8f376bde0..00000000000 --- a/Master/texmf-dist/doc/latex/media4svg/README.md +++ /dev/null @@ -1,173 +0,0 @@ -# The `media4svg` LaTeX Package - -Version 0.2, 2020/04/13 - -© 2020--today, Alexander Grahn - -https://gitlab.com/agrahn/media4svg - -## Introduction - -This package implements an interface for embedding video and audio files in SVG -(Scalable Vector Graphics) output. SVG with embedded media is very portable, -as it is supported by all modern Web browsers across a variety of operating -systems and platforms, including portable devices. - -The most portable media formats are as follows: - -**Video** - -| **File extension** | **Codecs** | **MIME-type** | -|:-------------------|:---------------------|:--------------| -| `mp4` | v: h264, a: AAC | `video/mp4` | -| `webm` | v: VP8, a: Vorbis | `video/webm` | -| `ogg` | v: Theora, a: Vorbis | `video/ogg` | - -**Audio** - -| **File extension** | **MIME-type** | -|:-------------------|:--------------| -| `mp3` | `audio/mpeg` | -| `ogg` | `audio/ogg` | -| `wav` | `audio/wav` | - - -In the world of TeX and LaTeX, SVG is produced by means of the -[`dvisvgm`](https://dvisvgm.de/) backend by M. Gieseking, which is included in -TeXLive and MiKTeX. - -Supported workflows are: -* `dvilualatex` ⇒ `dvisvgm` -* `[p|up]latex` ⇒ `dvisvgm` -* `xelatex --no-pdf` ⇒ `dvisvgm` - -All TeX engines that produce DVI/XDV output can be used, but `dvilualatex` is -to be preferred. By default, media data are physically embedded into the SVG -output. For this, they need to be Base64 encoded, which is done by the -built-in Lua interpreter of LuaTeX. The other, non-LuaTeX-based engines call -the Lua script for Base64-encoding as an external program via shell-escape, -which is much slower. - -**Recommended `dvisvgm` commandline options** - -There are a number of `dvisvgm` commandline options that should be used in general: - -````latex -dvisvgm --zoom=-1 --exact --pages=1,- --font-format=woff2 <DVI/XDV file> -```` -For exporting `beamer`-class documents to SVG, option `--box=papersize` -should also be added. Refer to the manual page, `man dvisvgm`, for additional -information. - -## Usage - ----- - -**Usage example** - -Here is an -[example presentation](http://mirrors.ctan.org/macros/latex/contrib/media4svg/example/beamer-example-1.svg) -([source code](http://mirrors.ctan.org/macros/latex/contrib/media4svg/example/beamer-example.tex)) -with an embedded video file and a streamed video. It also explains how to use -the mouse and the keyboard for playback control. - ----- - -Option `dvisvgm` must be set globally by passing it to the document class. -````latex -\documentclass[dvisvgm]{...} -```` - -The package itself is loaded with -````latex -\usepackage[<options>]{media4svg} -```` - -Package options are: `draft`, `final`, `autoplay`, `loop`, `controls`, -`mimetype`, `width`, `height`, `totalheight`, `keepaspectratio`, `scale`, -`url`, `embed`. They have the same meaning as the command options explained -below, but are applied globally. - -Note that `media4svg` is incompatible with package `media9`. - -The command for media inclusion is -````latex -\includemedia[<options>]{<poster text>}{<media file or URL>} -```` -Command options: -````latex -id=<label> -```` -The media is given an ID by which it can be referenced in JavaScript code, as -in `$("myVid").play();`, for example. -````latex -draft -final -```` -These have the usual meaning. If `draft` is set, a box is inserted into the -document instead of the media display. -````latex -autoplay -```` -Media playback is started after the page has been loaded in the web browser. -Depending on their settings, browsers may refuse to autoplay audio and -video with unmuted audio. Option `muted` may need to be set as well to allow -automatically start of video playback. -````latex -loop -```` -Media is played in a loop. -````latex -muted -```` -The audio will be initially silenced. -````latex -time=<time offset> -```` -Playback starts with an offset, specified in seconds. -````latex -controls -```` -Player-specific controls are shown as an overlay in the media display. -````latex -mimetype=<mime type> -```` -Although optional, it may be a good idea to give a hint to the web browser -about the kind of media to be played, such as `audio/mpeg` or `video/mp4`. -````latex -url -```` -The last argument of `\includemedia` is taken as a URL and media data will not -be embedded in the SVG file. -````latex -embed=false -```` -By default, a local media file, given as the last argument of `\includemedia`, is -encoded and embedded as a data blob into the SVG output. Option `embed=false` -suppresses embedding and the media file remains separate. -````latex -width=<h-size> -height=<v-size> | totalheight=<v-size> -keepaspectratio -```` -Resize the media display or set its size if `<poster text>` is left empty. If -provided, `<poster text>` is squeezed or stretched according to the given -options. If only one of `width` or `[total]height` is given, the other -dimension is scaled to maintain the aspect ratio of `<poster text>`. If both -`width` and `[total]height` are given together with `keepaspectratio`, -`<poster text>` is resized to fit within `<h-size>` and `<v-size>` while -maintaining its original aspect ratio. Any valid TeX dimension is acceptable -for `<h-size>` and `<v-size>`. In addition, the length commands `\width`, -`\height`, `\depth` and `\totalheight` can be used to refer to the original -dimensions of `<poster text>`. -````latex -scale=<factor> -```` -Scales the media display by `<factor>`. - ----- - -## License - -This material is subject to the [LaTeX Project Public License](http://mirrors.ctan.org/macros/latex/base/lppl.txt). - diff --git a/Master/texmf-dist/doc/latex/media4svg/README.txt b/Master/texmf-dist/doc/latex/media4svg/README.txt new file mode 100644 index 00000000000..87cb2babd4d --- /dev/null +++ b/Master/texmf-dist/doc/latex/media4svg/README.txt @@ -0,0 +1,181 @@ +===================================== + The `media4svg' LaTeX Package + + Version 0.3, 2020/04/14 + + https://gitlab.com/agrahn/media4svg + + (C) 2020--\today Alexander Grahn +===================================== + + +1. Introduction +=============== + +This package implements an interface for embedding video and audio files in SVG +(Scalable Vector Graphics) output. SVG with embedded media is very portable, +as it is supported by all modern Web browsers across a variety of operating +systems and platforms, including portable devices. + +The most portable media formats are as follows: + +Video: + +| File extension | Codecs | MIME-type | +|----------------|----------------------|------------| +| mp4 | v: h264, a: AAC | video/mp4 | +| webm | v: VP8, a: Vorbis | video/webm | +| ogg | v: Theora, a: Vorbis | video/ogg | + +Audio: + +| File extension | MIME-type | +|----------------|------------| +| mp3 | audio/mpeg | +| ogg | audio/ogg | +| wav | audio/wav | + +In the world of TeX and LaTeX, SVG is produced by means of the `dvisvgm' +(https://dvisvgm.de) backend by M. Gieseking, which is included in TeXLive +and MiKTeX. + +Supported workflows are: + + * dvilualatex --> dvisvgm + * [p|up]latex --> dvisvgm + * xelatex --no-pdf --> dvisvgm + +All TeX engines that produce DVI/XDV output can be used, but `dvilualatex` is +to be preferred. By default, media data are physically embedded into the SVG +output. For this, they need to be Base64 encoded, which is done by the +built-in Lua interpreter of LuaTeX. The other, non-LuaTeX-based engines call +the Lua script for Base64-encoding as an external program via shell-escape, +which is much slower. + +There are a number of `dvisvgm' commandline options that should be used in general: + + dvisvgm --zoom=-1 --exact --pages=1,- --font-format=woff2 <DVI/XDV file> + +For exporting `beamer'-class documents to SVG, option `--box=papersize' +should also be added. Refer to the manual page, `man dvisvgm', for additional +information. + + +2. Example +========== + +An example presentation with an embedded video file and a streamed video can be +found here: + +http://mirrors.ctan.org/macros/latex/contrib/media4svg/example/beamer-example-1.svg + +The source is: + +http://mirrors.ctan.org/macros/latex/contrib/media4svg/example/beamer-example.tex + +It also explains how to use the mouse and the keyboard for playback control. + + +3. Usage +======== + +Option `dvisvgm' must be set globally by passing it to the document class. + + \documentclass[dvisvgm]{...} + +The package itself is loaded with + + \usepackage[<options>]{media4svg} + + +Package options are: `draft', `final', `autoplay', `loop', `controls', +`mimetype', `width', `height', `totalheight', `keepaspectratio', `scale', +`url', `embed'. They have the same meaning as the command options explained +below, but are applied globally. + +Note that `media4svg' is incompatible with package `media9`. + +The command for media inclusion is + + \includemedia[<options>]{<poster text>}{<media file or URL>} + +Command options: + + id=<label> + +The media is given an ID by which it can be referenced in JavaScript code, as +in `$("myVid").play();`, for example. + + draft + final + +These have the usual meaning. If `draft' is set, a box is inserted into the +document instead of the media display. + + autoplay + +Media playback is started after the page has been loaded in the web browser. +Depending on their settings, browsers may refuse to autoplay audio and +video with unmuted audio. Option `muted' may need to be set as well to allow +automatically start of video playback. + + loop + +Media is played in a loop. + + muted + +The audio will be initially silenced. + + time=<time offset> + +Playback starts with an offset, specified in seconds. + + controls + +Player-specific controls are shown as an overlay in the media display. + + mimetype=<mime type> + +Although optional, it may be a good idea to give a hint to the web browser +about the kind of media to be played, such as `audio/mpeg' or `video/mp4`. + + url + +The last argument of `\includemedia' is taken as a URL and media data will not +be embedded in the SVG file. + + embed=false + +By default, a local media file, given as the last argument of `\includemedia', is +encoded and embedded as a data blob into the SVG output. Option `embed=false' +suppresses embedding and the media file remains separate. + + width=<h-size> + height=<v-size> | totalheight=<v-size> + keepaspectratio + +Resize the media display or set its size if <poster text> is left empty. If +provided, <poster text> is squeezed or stretched according to the given +options. If only one of `width' or `[total]height' is given, the other +dimension is scaled to maintain the aspect ratio of <poster text>. If both +`width' and `[total]height' are given together with `keepaspectratio', +<poster text> is resized to fit within <h-size> and <v-size> while +maintaining its original aspect ratio. Any valid TeX dimension is acceptable +for <h-size> and <v-size>. In addition, the length commands `\width', +`\height', `\depth' and `\totalheight' can be used to refer to the original +dimensions of <poster text>. + + scale=<factor> + +Scales the media display by <factor>. + + + * * * + + +This material is subject to the LaTeX Project Public License. See + + http://mirrors.ctan.org/macros/latex/base/lppl.txt + +for the details of that license. diff --git a/Master/texmf-dist/doc/latex/media4svg/example/beamer-example-1.svg b/Master/texmf-dist/doc/latex/media4svg/example/beamer-example-1.svg index 7ec641a0644..729a51b1b9f 100644 --- a/Master/texmf-dist/doc/latex/media4svg/example/beamer-example-1.svg +++ b/Master/texmf-dist/doc/latex/media4svg/example/beamer-example-1.svg @@ -9,12 +9,12 @@ function $(id) {return document.getElementById("msvg@"+id.toString().trim());}; </script> </defs> <style type='text/css'> -<
