summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/ocgx2/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/ocgx2/README.md')
-rw-r--r--macros/latex/contrib/ocgx2/README.md18
1 files changed, 11 insertions, 7 deletions
diff --git a/macros/latex/contrib/ocgx2/README.md b/macros/latex/contrib/ocgx2/README.md
index e8b100e0cd..1f33d755ed 100644
--- a/macros/latex/contrib/ocgx2/README.md
+++ b/macros/latex/contrib/ocgx2/README.md
@@ -162,9 +162,9 @@ directive `\AllOff{...}` is written as `\Not{ \Or{ ... } }`.
These are the available commands:
````latex
-\switchocg[<trigger>]{<OCG ids to toggle, space separated>}{<link text>}
-\showocg[<trigger>]{<OCG ids to switch ON, space separated>}{<link text>}
-\hideocg[<trigger>]{<OCG ids to switch OFF, space separated>}{<link text>}
+\switchocg[<trigger>]{<OCG ids to toggle, comma-separated>}{<link text>}
+\showocg[<trigger>]{<OCG ids to switch ON, comma-separated>}{<link text>}
+\hideocg[<trigger>]{<OCG ids to switch OFF, comma-separated>}{<link text>}
\actionsocg[<trigger>]{<ids to toggle>}{<ids to switch ON>}{<ids to switch OFF>}{<link text>}
````
For details about their usage, read the
@@ -172,18 +172,22 @@ For details about their usage, read the
By default, links are triggered on mouse-click. Other triggers are possible
with `ocgx2`. For this, `ocgx2` provides the optional argument `[<trigger>]` to
-the commands listed above. Choose one of
+the commands listed above. Choose *one* of
````latex
onmousenter, onmouseexit, onmousedown, onmouseup, onmouseall
````
for `<trigger>`. In order to listen to more than one mouse event, use
`onmouseall`. OCG ids in the mandatory argument(s) must then be grouped with
-commas as follows:
+braces and commas as follows:
````latex
- <mouse-enter group>, <mouse-exit group>, <mouse-down group>, <mouse-up group>
+ {<mouse-enter group>}, {<mouse-exit group>}, {<mouse-down group>}, {<mouse-up group>}
````
Any of these groups may be left empty in order to configure only some
-triggers. Inside the groups, OCG ids are separated by spaces.
+triggers. Inside the groups, OCG ids are also separated by commas. Therefore,
+braces must be put around the groups. For example:
+````latex
+\switchocg[onmouseall]{, ,{ocg1, ocg2, ocg3, ocg4},{ocg1, ocg2, ocg3, ocg4}}{Toggle layers on mouse-down and -up}
+````
----