diff options
author | Karl Berry <karl@freefriends.org> | 2015-06-19 22:17:58 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2015-06-19 22:17:58 +0000 |
commit | f1c8cff4df0d9ddf41f0d5314a838b8c452e7e8a (patch) | |
tree | c953306312b06f94ae7c4601aa777cd6b39da0f3 /Master/texmf-dist/doc/latex/ocgx2/README | |
parent | 9feded825976326232bba2e1c0a2de50c1f147e9 (diff) |
missed commit
git-svn-id: svn://tug.org/texlive/trunk@37612 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/ocgx2/README')
-rw-r--r-- | Master/texmf-dist/doc/latex/ocgx2/README | 101 |
1 files changed, 101 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/ocgx2/README b/Master/texmf-dist/doc/latex/ocgx2/README new file mode 100644 index 00000000000..b0151acb1c1 --- /dev/null +++ b/Master/texmf-dist/doc/latex/ocgx2/README @@ -0,0 +1,101 @@ +================================== + The `ocgx2' LaTeX Package + + Version 0.6 [2015/06/18] + + (C) 2015--\today Alexander Grahn +================================== + + +1. Introduction +=============== + +The intent of this package is to be a drop-in replacement for the already +existing package `ocgx' by Paul Garborit. + +It re-implements the functionality of the `ocg', `ocgx' and `ocg-p' packages +and adds support for all known engines and back-ends including: + + * LaTeX --> dvips --> ps2pdf/Distiller + * (Xe)LaTeX --> (x)dvipdfmx + * pdfLaTeX, luaLaTeX + +To enable dvipdfmx support, pass `dvipdfmx' globally as a class option. + +Also, it adds some minor improvements, such as package options, +remembering option settings of re-opened ocgs, correct behaviour of ocg +switching links that were themselves placed on layers, compatibility +with the `animate' and `media9' packages. + +`ocgx2' uses code from file `tikzlibraryocgx.code.tex' by P. Garborit to +enable TikZ styles for creating PDF Layers and clickable layer switching +links in the `tikzpicture' context. + +Just say: + + \usepackage[tikz]{ocgx2} + +instead of + + \usepackage{tikz} + \usetikzlibrary{ocgx} + +to enable these TikZ styles and read the `ocgx' documentation about their usage: + + texdoc ocgx + + +2. Usage +======== + +\usepackage[<options>]{ocgx2} + +\begin{ocg}[<options>]{<layer name>}{<layer id>}{<initial visibility>} + ... material to be put on a PDF layer ... +\end{ocg} + +With <options> : viewocg = always | never | ifvisible + printocg = always | never | ifvisible + exportocg = always | never | ifvisible + listintoolbar= always | never | iffirstuse + + tikz (package-only option, see above) + +Package options have global scope. Environment options override package +options locally. `ocg' environments can be nested. + +See the `ocg-p' manual about the environment usage and the meaning of +the available options: + + texdoc ocg-p + +Clickable links for switching PDF layer visibility are created with: + + \switchocg{<layer IDs to toggle, space separated>}{<link text>} + \showocg{<layer IDs to switch ON, space separated>}{<link text>} + \hideocg{<layer IDs to switch OFF, space separated>}{<link text>} + \actionsocg{<IDs to toggle>}{<IDs to switch ON>}{<IDs to switch OFF>}{<link text>} + +For details about their usage, read the `ocgx' package manual: + + texdoc ocgx + +For compatibility with the `ocg-p' package, the following aliases for +the above commands have been provided: + + \toggleocgs + \showocgs + \hideocgs + \setocgs + + + * * * + + +This material is subject to the LaTeX Project Public License version 1.3. + +See + + http://mirrors.ctan.org/help/Catalogue/licenses.lppl.html + +for the details of that license. |