DokuWiki

It's better when it's simple

User Tools

Site Tools


devel:admin_plugins

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
devel:admin_plugins [2017-02-03 12:04]
andi [Table]
devel:admin_plugins [2017-02-03 12:12] (current)
andi [How to Write an Admin Plugin]
Line 38: Line 38:
 See [[common plugin functions]] for inherited functions available to all plugins. e.g. localisation, configuration and introspection. See [[common plugin functions]] for inherited functions available to all plugins. e.g. localisation, configuration and introspection.
  
-\\+=== Icon === 
 + 
 +Since the Frusterick Manners release, admin plugins can provide an icon to be shown next to the plugin's name on the admin screen. By default this icon will be searched at ''lib/plugins/<yourplugin>/admin.svg''. You can override the location with the ''getMenuIcon()'' method. 
 + 
 +There are a few restrictions the icon has to adhere to for it to be displayed: 
 + 
 +  * It has to be in SVG format 
 +  * The file has to be smaller than 2KB 
 +  * It should only contain a single path object 
 + 
 +The fill color of the path will be set by CSS and match the link color (unless your template does something different). 
 + 
 +To match the style of other icons, we recommend to either pick an icon from the huge, free selection at https://materialdesignicons.com/ or adhere to the [[https://material.io/guidelines/style/icons.html|Material Design Guidelines]] when designing your own icon. 
  
 ===== Admin plugin trigger ===== ===== Admin plugin trigger =====
devel/admin_plugins.txt · Last modified: 2017-02-03 12:12 by andi