README.md
1#DokuWiki PopUpViewer
2
3A DokuWiki plugin that allows for simple popups of images or even pages from the wiki.
4
5##Syntax
6
7```
8{{popup>%IMAGE/PAGE%?[%SIZE%]&[keepOpen]|[%TEXT/IMAGE%]}}
9Note: [?%SIZE%] and [%TEXT/IMAGE%] are optional parameters.
10```
11
12 Option | Description
13 :----- | :----------
14```%IMAGE/PAGE%``` | an image or a page as you know it from DokuWiki
15```%SIZE%``` (optional) | Width and height (optional) in px. Example: 200×300
16```keepOpen``` (optional) | All links in a page opened via a popup will also open in a popup.
17```%TEXT/IMAGE%``` (optional) | Here you can set the name or an additional image. This will be displayed to the user as link to click on for the popup
18
19__Hints__:
20
21 * ```?``` is required when using either ```%SIZE%```or ```keepOpen```
22 * ```&```is required in between when using both options.
23 * ```keepOpen``` only has an effect when using a page id, never with an image.
24
25##Extra JavaScript for loaded pages
26
27You can add JavaScript that is being executed for pages that load in a popup. The script has to be placed in the page to load. it will not get executed anywhere else. You have to enable this.
28
29```
30<popupscript>
31/* JavaScript */
32</popupscript>
33```
34