Differences

This shows you the differences between two versions of the page.

--- macros:example:toggletopage1andback [2019/02/07 13:42] – created icke_siegen
+++ macros:example:toggletopage1andback [2019/04/27 19:33] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
 Example
-====== Toggle to page 1 and back ======
+====== Pages - Toggle to page 1 and back ======
 ^ by: | Sebastian Beutel, February 2019 |
@@ Line 54: / Line 54: @@
 This explains the functional steps within the sequence. For all the other XML details please refer to [[:macros:formats_and_syntax#xml_format|Formats and syntax]]
-tbd
+This macro abuses the property ''UserMacros.CurrentUserNumber'' as temporary cache for the current playback page number.
-===== How to use it =====
+  * if the macro is called and ''UserMacros.CurrentUserNumber'' is 1000 then ''UserMacros.CurrentUserNumber'' is set to the current playback page, and playbacks are toggled to page 1
+  * if the macro is called and ''UserMacros.CurrentUserNumber'' is NOT 1000 then playbacks are toggled to what is cached in ''UserMacros.CurrentUserNumber'', and ''UserMacros.CurrentUserNumber'' is then set to 1000
-  - [[:macros:deploying|make this macro available]]
+Side effects:
+  * in a new show, ''UserMacros.CurrentUserNumber'' defaults to 1. At first you have to call the macro twice.
+  * if you change the playback page manually after having toggled to page 1 then you have to call the macro twice.
+  * this interferes with the Macro Usernumber - be aware of this when programming or calling other macros
+===== How to use it =====
-tbd
+  * [[:macros:deploying|make this macro available]]
+  * call this macro to go to Playback Page 1, and to go back to the previously active page
 ~~DISCUSSION~~