DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:overlay

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
plugin:overlay [2018-02-25 18:50]
turnermm [Examples]
plugin:overlay [2019-05-15 17:59]
turnermm [Alternate Templates]
Line 7: Line 7:
 type       : action type       : action
 lastupdate : 2018-02-25 lastupdate : 2018-02-25
-compatible :"​Hrun","​Detritus","​elenor of tsort","​frusterick Manners"​+compatible :"​Hrun","​Detritus","​elenor of tsort","​frusterick Manners"​,Greebo
 depends ​   :  depends ​   : 
 conflicts ​ :  conflicts ​ : 
Line 22: Line 22:
  
 ===== Installation ===== ===== Installation =====
 +Search and install the plugin using the [[plugin:​extension|Extension Manager]] will install the plugin plus the css for several popular navigation plugins. Refer to [[:​Plugins]] on how to install plugins manually.
  
-Installation with the extension manager or from the command line will install the plugin plus the css for several popular navigation plugins. ​  The remainder of the install may require modification of your template as described below.+The remainder of the install may require modification of your template as described below.
  
 ===== Description ===== ===== Description =====
  
-This was initially designed as facilitator for navigation plugins. But, it could be used to insert a floating window on top of your template for any purpose. This window could replace the sidebar.+This was initially designed as facilitator for navigation plugins. But, it could be used to insert a floating window on top of your template for any purpose. This window could replace the sidebar. ​ The overlay window is both draggable and resizable:​ 
 + 
 +{{https://​i.imgur.com/​yQ02YYC.png?​275 |start resize}}{{https://​i.imgur.com/​meB8GvA.png?​290|mid resize}} ​  
 + 
 +To drag, click and hold anywhere inside the window. ​ To resize, click and hold any of the seven square handles; the ''​resize''​ tool tip will pop up.   As the resize is in process, a dotted outline marks out the new size, which is set when you release the mouse button. 
  
  
Line 68: Line 74:
   tpl_toolsevent('​ovltools',​ array());   tpl_toolsevent('​ovltools',​ array());
 </​code>​ </​code>​
-Place this code where you want your link or button to appear. Whether you get a lilnk or a button will depend on the [[#​toggletype|toggletype]] configuration option. ​ You can style the link or button using the css in ''​overlay/​style.css'',​ where you will find two place-holders:​+Place this code where you want your link or button to appear. Whether you get a link or a button will depend on the [[#​toggletype|toggletype]] configuration option. ​ You can style the link or button using the css in ''​overlay/​style.css'',​ where you will find two place-holders:​
 <code css> <code css>
 /* mark  settings here as !important. ​ For instance, ​ color: green !important; */ /* mark  settings here as !important. ​ For instance, ​ color: green !important; */
Line 74: Line 80:
 a.overlaytools {} a.overlaytools {}
 </​code>​ </​code>​
-Post ''​Frusterick Manners'',​ the function ​''​tpl_toolsevent'' ​will probably no longer be supported by Dokuwiki, which will have a new menu interface In this caseyou can use the following instead: +The ''​tpl_toolsevent()'' ​is now deprecatedTherefore,  if you are  using a current template that no longer supports ​the ''​tpl_toolsevent()''​ function, then you cean insert your own link or button into your template. ​  Use one of the following:
-         <?​php ​ (new \dokuwiki\plugin\overlay\OverlayMenu())->​getItems();?>​ +
-==== Alternate Template (pre-Detritus) ==== +
-If you are not using Detritus or later, or if you are not using the default dokuwiki template, then you will have to insert your own link or button into your template. ​  Use one of the following:+
  
 <code html> <code html>
Line 92: Line 95:
 In plugins/​overlay,​ you will find a ''​script.css''​ file.  You can change the initial position of the window on the screen, its size, border, etc.  The size can also be changed using [[#​other_options|Configuration Options]]. In plugins/​overlay,​ you will find a ''​script.css''​ file.  You can change the initial position of the window on the screen, its size, border, etc.  The size can also be changed using [[#​other_options|Configuration Options]].
  
-The overlay window ​is resizable ​by grabbing the resize icon that initially appears in the lower right corner.  ​<​del>​Howeverit scrolls with the window, and may therefore move up or down away form the lower right corner</​del>​. This has been fixed in the lastest version.+The overlay window ​cannot be resized ​by grabbing the Windows handle at the lower right corner. ​Instead you must use  its own resize handles, the boxes at corners and sides. ​  
 +These are defined as follows and can be modified using css: 
 +                handles: { 
 +                    '​nw':​ '#​nwgrip',​ 
 +                    '​ne':​ '#​negrip',​ 
 +                    '​sw':​ '#​swgrip',​ 
 +                    '​se':​ '#​segrip',​ 
 +                    '​n': ​ '#​ngrip',​ 
 +                    '​e': ​ '#​egrip',​  
 +                    '​w': ​ '#​wgrip'​ 
 +                }     
 +                     
 +''​n'',​ ''​e''​, and ''​w''​ are the top and sides, ​the others are the four corners They can be modified using css. If for instance, you don't want the top and sides, you can place the following css in [[devel:​css#​user_styles|conf/​userstyles]]:​  
 +    div#overlay #egrip, #ngrip, #wgrip { 
 +       ​visibility:​ hidden; 
 +    } 
 + 
  
 ==== Indexmenu ==== ==== Indexmenu ====
plugin/overlay.txt · Last modified: 2019-05-15 17:59 by turnermm