summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/ocgx2/README
blob: 1a650cc24baa69939c2fe943cd36edd4db953356 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
==================================
 The `ocgx2' LaTeX Package

 Version 0.6a [2015/06/19]

 (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 Gaborit.

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. Gaborit 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.