CINXE.COM

<!DOCTYPE html> <html lang="en" dir="ltr" class="no-js"> <head> <meta charset="utf-8" /> <title>devel:plugin_file_structure [DokuWiki]</title> <meta name="generator" content="DokuWiki"/> <meta name="theme-color" content="#008800"/> <meta name="robots" content="index,follow"/> <meta name="keywords" content="devel,plugin_file_structure"/> <link rel="search" type="application/opensearchdescription+xml" href="/lib/exe/opensearch.php" title="DokuWiki"/> <link rel="start" href="/"/> <link rel="contents" href="/devel:plugin_file_structure?do=index" title="Sitemap"/> <link rel="manifest" href="/lib/exe/manifest.php"/> <link rel="alternate" type="application/rss+xml" title="Recent Changes" href="/feed.php"/> <link rel="alternate" type="application/rss+xml" title="Current namespace" href="/feed.php?mode=list&ns=devel"/> <link rel="edit" title="Edit this page" href="/devel:plugin_file_structure?do=edit"/> <link rel="alternate" type="text/html" title="Plain HTML" href="/_export/xhtml/devel:plugin_file_structure"/> <link rel="alternate" type="text/plain" title="Wiki Markup" href="/_export/raw/devel:plugin_file_structure"/> <link rel="canonical" href="https://www.dokuwiki.org/devel:plugin_file_structure"/> <link rel="stylesheet" href="/lib/exe/css.php?t=dokuwiki&tseed=f1005bad3d81fc9c803c7f93d32a390e"/> <link rel="alternate" hreflang="ja" href="https://www.dokuwiki.org/ja:devel:plugin_file_structure"/> <link rel="alternate" hreflang="ru" href="https://www.dokuwiki.org/ru:devel:plugin_file_structure"/> <link rel="alternate" hreflang="zh" href="https://www.dokuwiki.org/zh:devel:plugin_file_structure"/> <link rel="alternate" hreflang="x-default" href="https://www.dokuwiki.org/devel:plugin_file_structure"/> <script >var NS='devel';var JSINFO = {"plugins":{"edittable":{"default columnwidth":""}},"id":"devel:plugin_file_structure","namespace":"devel","ACT":"show","useHeadingNavigation":0,"useHeadingContent":0};(function(H){H.className=H.className.replace(/\bno-js\b/,'js')})(document.documentElement);</script> <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.6.4/jquery.min.js" defer="defer"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/jqueryui/1.13.2/jquery-ui.min.js" defer="defer"></script> <script src="/lib/exe/js.php?t=dokuwiki&tseed=f1005bad3d81fc9c803c7f93d32a390e&lang=en" defer="defer"></script> <meta name="viewport" content="width=device-width,initial-scale=1" /> <link rel="shortcut icon" href="/lib/tpl/dokuwiki/images/favicon.ico" /> <link rel="apple-touch-icon" href="/lib/tpl/dokuwiki/images/apple-touch-icon.png" /> <meta name="verify-v1" content="OVxl3gsCv2MhZqh1cBQyl0JytWXSwXMjyvwc+4w3WtA=" /> <meta name="google-site-verification" content="YhTVK69hW94ZXUtc2zSLPxTkZKbZIn0zK67mz5WQB-E" />  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-83791-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-83791-1', { 'anonymize_ip': true }); </script> </head> <body> <div id="dokuwiki__site"><div id="dokuwiki__top" class="site dokuwiki mode_show tpl_dokuwiki showSidebar hasSidebar">  <header id="dokuwiki__header"><div class="pad group"> <div class="headings group"> <ul class="a11y skip"> <li><a href="#dokuwiki__content">skip to content</a></li> </ul> <h1 class="logo"><a href="/start" accesskey="h" title="Home [h]"><img src="/lib/tpl/dokuwiki/images/logo.png" width="64" height="64" alt="" /><span>DokuWiki</span></a></h1> <p class="claim">It's better when it's simple</p> </div> <div class="tools group">  <div id="dokuwiki__usertools"> <h3 class="a11y">User Tools</h3> <ul> <li class="action login"><a href="/devel:plugin_file_structure?do=login&sectok=" title="Log In" rel="nofollow"><span>Log In</span><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M10 17.25V14H3v-4h7V6.75L15.25 12 10 17.25M8 2h9a2 2 0 0 1 2 2v16a2 2 0 0 1-2 2H8a2 2 0 0 1-2-2v-4h2v4h9V4H8v4H6V4a2 2 0 0 1 2-2z"/></svg></a></li> </ul> </div>  <div id="dokuwiki__sitetools"> <h3 class="a11y">Site Tools</h3> <form action="/start" method="get" role="search" class="search doku_form" id="dw__search" accept-charset="utf-8"><input type="hidden" name="do" value="search" /><input type="hidden" name="id" value="devel:plugin_file_structure" /><div class="no"><input name="q" type="text" class="edit" title="[F]" accesskey="f" placeholder="Search" autocomplete="on" id="qsearch__in" value="" /><button value="1" type="submit" title="Search">Search</button><div id="qsearch__out" class="ajax_qsearch JSpopup"></div></div></form> <div class="mobileTools"> <form action="/doku.php" method="get" accept-charset="utf-8"><div class="no"><input type="hidden" name="id" value="devel:plugin_file_structure" /><select name="do" class="edit quickselect" title="Tools"><option value="">Tools</option><optgroup label="Page Tools"><option value="edit">Edit this page</option><option value="revisions">Old revisions</option><option value="backlink">Backlinks</option></optgroup><optgroup label="Site Tools"><option value="recent">Recent Changes</option><option value="media">Media Manager</option><option value="index">Sitemap</option></optgroup><optgroup label="User Tools"><option value="login">Log In</option></optgroup></select><button type="submit">></button></div></form> </div> <ul> <li class="action recent"><a href="/devel:plugin_file_structure?do=recent" title="Recent Changes [r]" rel="nofollow" accesskey="r">Recent Changes</a></li><li class="action media"><a href="/devel:plugin_file_structure?do=media&ns=devel" title="Media Manager" rel="nofollow">Media Manager</a></li><li class="action index"><a href="/devel:plugin_file_structure?do=index" title="Sitemap [x]" rel="nofollow" accesskey="x">Sitemap</a></li> </ul> </div> </div>  <div class="breadcrumbs"> <div class="trace"><span class="bchead">Trace:</span> <span class="bcsep">•</span> <span class="curid"><bdi><a href="/devel:plugin_file_structure" class="breadcrumbs" title="devel:plugin_file_structure">plugin_file_structure</a></bdi></span></div> </div> <hr class="a11y" /> </div></header> <div class="wrapper group">  <nav id="dokuwiki__aside" aria-label="Sidebar"><div class="pad aside include group"> <h3 class="toggle">Sidebar</h3> <div class="content"><div class="group"> <div class="plugin_translation is-dropdown"><span class="title">Translations of this page<sup><a href="/localization" class="wikilink1" title="localization" data-wiki-id="localization">?</a></sup>: </span><ul><li class="span"><span class="wikilink1" title="English">English (en)</span></li><li class="a"><a class="wikilink2" title="|العربية" href="/ar:devel:plugin_file_structure">|العربية (ar)</a></li><li class="a"><a class="wikilink2" title="Català" href="/ca:devel:plugin_file_structure">Català (ca)</a></li><li class="a"><a class="wikilink2" title="Česky" href="/cs:devel:plugin_file_structure">Česky (cs)</a></li><li class="a"><a class="wikilink2" title="Dansk" href="/da:devel:plugin_file_structure">Dansk (da)</a></li><li class="a"><a class="wikilink2" title="Deutsch" href="/de:devel:plugin_file_structure">Deutsch (de)</a></li><li class="a"><a class="wikilink2" title="Ελληνικά" href="/el:devel:plugin_file_structure">Ελληνικά (el)</a></li><li class="a"><a class="wikilink2" title="Esperanto" href="/eo:devel:plugin_file_structure">Esperanto (eo)</a></li><li class="a"><a class="wikilink2" title="Español" href="/es:devel:plugin_file_structure">Español (es)</a></li><li class="a"><a class="wikilink2" title="فارسی" href="/fa:devel:plugin_file_structure">فارسی (fa)</a></li><li class="a"><a class="wikilink2" title="Français" href="/fr:devel:plugin_file_structure">Français (fr)</a></li><li class="a"><a class="wikilink2" title="עברית" href="/he:devel:plugin_file_structure">עברית (he)</a></li><li class="a"><a class="wikilink2" title="Magyar" href="/hu:devel:plugin_file_structure">Magyar (hu)</a></li><li class="a"><a class="wikilink2" title="Italiano" href="/it:devel:plugin_file_structure">Italiano (it)</a></li><li class="a"><a class="wikilink1" title="日本語" href="/ja:devel:plugin_file_structure">日本語 (ja)</a></li><li class="a"><a class="wikilink2" title="한국어" href="/ko:devel:plugin_file_structure">한국어 (ko)</a></li><li class="a"><a class="wikilink2" title="Lietuvių Kalba" href="/lt:devel:plugin_file_structure">Lietuvių Kalba (lt)</a></li><li class="a"><a class="wikilink2" title="Nederlands" href="/nl:devel:plugin_file_structure">Nederlands (nl)</a></li><li class="a"><a class="wikilink2" title="Norsk" href="/no:devel:plugin_file_structure">Norsk (no)</a></li><li class="a"><a class="wikilink2" title="Polski" href="/pl:devel:plugin_file_structure">Polski (pl)</a></li><li class="a"><a class="wikilink2" title="Português" href="/pt-br:devel:plugin_file_structure">Português (pt-br)</a></li><li class="a"><a class="wikilink2" title="Română" href="/ro:devel:plugin_file_structure">Română (ro)</a></li><li class="a"><a class="wikilink1" title="Русский" href="/ru:devel:plugin_file_structure">Русский (ru)</a></li><li class="a"><a class="wikilink2" title="Српски Језик" href="/sr:devel:plugin_file_structure">Српски Језик (sr)</a></li><li class="a"><a class="wikilink2" title="Svenska" href="/sv:devel:plugin_file_structure">Svenska (sv)</a></li><li class="a"><a class="wikilink2" title="ไทย" href="/th:devel:plugin_file_structure">ไทย (th)</a></li><li class="a"><a class="wikilink2" title="Українська" href="/uk:devel:plugin_file_structure">Українська (uk)</a></li><li class="a"><a class="wikilink1" title="中文" href="/zh:devel:plugin_file_structure">中文 (zh)</a></li><li class="a"><a class="wikilink2" title="繁體中文" href="/zh-tw:devel:plugin_file_structure">繁體中文 (zh-tw)</a></li></ul></div> <p> <strong>Learn about DokuWiki</strong> </p> <ul> <li class="level1"><div class="li"> <a href="/features" class="wikilink1" title="features" data-wiki-id="features">Features</a> & <a href="/blogroll" class="wikilink1" title="blogroll" data-wiki-id="blogroll">reviews</a> </div> </li> <li class="level1"><div class="li"> <a href="/install" class="wikilink1" title="install" data-wiki-id="install">Installation guide</a></div> </li> <li class="level1"><div class="li"> <a href="/manual" class="wikilink1" title="manual" data-wiki-id="manual">User manual</a> & <a href="/wiki:syntax" class="wikilink1" title="wiki:syntax" data-wiki-id="wiki:syntax">syntax</a></div> </li> <li class="level1"><div class="li"> <a href="/changes" class="wikilink1" title="changes" data-wiki-id="changes">Release notes</a></div> </li> <li class="level1"><div class="li"> <a href="/faq" class="wikilink1" title="faq" data-wiki-id="faq">FAQ</a></div> </li> </ul> <p> <strong>Advanced Use</strong> </p> <ul> <li class="level1"><div class="li"> <a href="/extensions" class="wikilink1" title="extensions" data-wiki-id="extensions">Extensions</a></div> </li> <li class="level1"><div class="li"> <a href="/development" class="wikilink1" title="development" data-wiki-id="development">Development manual</a></div> </li> </ul> <p> <strong>Corporate Use</strong> </p> <ul> <li class="level1"><div class="li"> <a href="/faq:support" class="wikilink1" title="faq:support" data-wiki-id="faq:support">Get support</a></div> </li> <li class="level1"><div class="li"> <a href="/donate" class="wikilink1" title="donate" data-wiki-id="donate">Donations</a></div> </li> </ul> <p> <strong>Our Community</strong> </p> <ul> <li class="level1"><div class="li"> <a href="/teams:getting_involved" class="wikilink1" title="teams:getting_involved" data-wiki-id="teams:getting_involved">Get involved</a></div> </li> <li class="level1"><div class="li"> <a href="/dokuinstall" class="wikilink1" title="dokuinstall" data-wiki-id="dokuinstall">Users</a></div> </li> <li class="level1"><div class="li"> <a href="http://forum.dokuwiki.org" class="urlextern" title="http://forum.dokuwiki.org">User forum</a></div> </li> <li class="level1"><div class="li"> <a href="/mailinglist" class="wikilink1" title="mailinglist" data-wiki-id="mailinglist">Development mailinglist</a></div> </li> </ul> <hr /> <p> Follow us on <a href="https://phpc.social/@dokuwiki" class="urlextern" title="https://phpc.social/@dokuwiki">Mastodon</a> and other <a href="/social" class="wikilink1" title="social" data-wiki-id="social">social networks</a>. </p> <p> <a href="/privacy" class="wikilink1" title="privacy" data-wiki-id="privacy">Our Privacy Policy</a> </p> </div></div> </div></nav>  <main id="dokuwiki__content"><div class="pad group"> <div class="pageId"><span>devel:plugin_file_structure</span></div> <div class="page group">   <div id="dw__toc" class="dw__toc"> <h3 class="toggle">Table of Contents</h3> <div> <ul class="toc"> <li class="level1"><div class="li"><a href="#plugin_file_structure">Plugin File Structure</a></div> <ul class="toc"> <li class="level2"><div class="li"><a href="#css_styles">CSS Styles</a></div></li> <li class="level2"><div class="li"><a href="#javascript">JavaScript</a></div></li> <li class="level2"><div class="li"><a href="#don_t_include_extension_manager_files">Don't include Extension manager files</a></div></li> <li class="level2"><div class="li"><a href="#see_also">See also</a></div></li> </ul></li> </ul> </div> </div>  <h1 class="sectionedit1" id="plugin_file_structure">Plugin File Structure</h1> <div class="level1"> <p> There are two structures for the files of a DokuWiki plugin class. The structure chosen determines the name for the plugin class(es). </p> <p> Definitions: </p> <ul> <li class="level1"><div class="li"> <code><pluginname></code> – simple and unique name, also name of plugin directory</div> </li> <li class="level1"><div class="li"> <code><plugin type></code> – characterizes the function of plugin e.g. syntax, auth, action…</div> </li> <li class="level1"><div class="li"> <code><plugin component></code> – needed when plugin has more components of one type</div> </li> </ul> <p> Class definition: </p> <ol> <li class="level1"><div class="li"> <strong>Single component</strong> of one plugin type:<br/> <code><dokuwiki>/lib/plugins/<plugin name>/<plugin type>.php</code> <br/> the plugin class name will be <code><plugin type>_plugin_<plugin name></code> <pre class="code">e.g. file name type class <dokuwiki>/lib/plugins/acl/admin.php => admin_plugin_acl</pre> </div> </li> <li class="level1"><div class="li"> <strong>More components</strong> of one plugin type:<br/> <code><dokuwiki>/lib/plugins/<plugin name>/<plugin type>/<filename>.php</code> <br/> This structure allows several plugin classes of one plugin type within one plugin.<br/> The class names will be <code><plugin type>_plugin_<plugin name>_<filename></code>. <pre class="code">e.g. file name type component class <dokuwiki>/lib/plugins/code/syntax/code.php => syntax_plugin_code_code <dokuwiki>/lib/plugins/code/syntax/file.php => syntax_plugin_code_file or <dokuwiki>/lib/plugins/code/auth/file.php => auth_plugin_code_file <dokuwiki>/lib/plugins/code/auth/file.php => auth_plugin_code_file</pre> <p> If you are creating multiple syntax components, their mode name in the <code>connectTo()</code> method must also have <code>_<filename></code> appended, e.g.: <code>plugin_code_code</code> and <code>plugin_code_file</code>. </p> </div> </li> </ol> </div> <h4 id="name_conventions_of_plugin_name">Name conventions of plugin name</h4> <div class="level4"> <ul> <li class="level1"><div class="li"> an _ (underscore) is a reserved character and cannot be used in the <code><pluginname></code></div> </li> <li class="level1"><div class="li"> valid <code><pluginname></code> should only contain the characters a-z and 0-9</div> </li> <li class="level1"><div class="li"> two different plugins with the same name are mutually exclusive and inherently incompatible.</div> </li> </ul> </div> <h4 id="combining_of_plugin_types_and_functions">Combining of plugin types and functions</h4> <div class="level4"> <p> A plugin may contain several different plugins types as well as several different plugin classes(components) of each type. </p> <p> In addition, a plugin can (optionally) take advantage of other built-in facilities to have its styles, JavaScript, localisation, and configuration included in DokuWiki. See also <a href="/devel:common_plugin_functions" class="wikilink1" title="devel:common_plugin_functions" data-wiki-id="devel:common_plugin_functions">common plugin functions</a>. </p> </div> <h4 id="file_structure">File Structure</h4> <div class="level4"> <p> All paths and files are relative to the plugin root directory. </p> <ul> <li class="level1 node"><div class="li"> <code><dokuwiki>/lib/plugins/<pluginname>/</code></div> <ul> <li class="level2"><div class="li"> <code>style.css</code> – <a href="/devel:css" class="wikilink1" title="devel:css" data-wiki-id="devel:css">CSS</a> styles for the plugin</div> </li> <li class="level2"><div class="li"> <code>print.css</code> – print <a href="/devel:css" class="wikilink1" title="devel:css" data-wiki-id="devel:css">CSS</a> styles for the plugin</div> </li> <li class="level2"><div class="li"> <code>script.js</code> – <a href="/devel:javascript" class="wikilink1" title="devel:javascript" data-wiki-id="devel:javascript">JavaScript</a> used by the plugin</div> </li> <li class="level2"><div class="li"> <code>plugin.info.txt</code> – A text file with <a href="/devel:plugin_info" class="wikilink1" title="devel:plugin_info" data-wiki-id="devel:plugin_info">plugin informations</a> <strong>required!</strong></div> </li> <li class="level2"><div class="li"> <code>deleted.files</code>– (optional) A text file that lists <a href="/devel:deleted.files" class="wikilink1" title="devel:deleted.files" data-wiki-id="devel:deleted.files">files that are deleted</a> if the plugin is updated.</div> </li> <li class="level2 node"><div class="li"> <code>lang/</code></div> <ul> <li class="level3"><div class="li"> <code><language>/lang.php</code> – <a href="/devel:localization#plugin_localization" class="wikilink1" title="devel:localization" data-wiki-id="devel:localization">Language strings</a> (accessible via <code>$this->getLang()</code>)</div> </li> <li class="level3"><div class="li"> <code><language>/settings.php</code> – localised strings used in the Configuration Manager</div> </li> <li class="level3"><div class="li"> <code><language>/<filename>.txt</code> – localised text including DokuWiki markup (accessible via <code>$this->locale_xhtml()</code>)</div> </li> </ul> </li> <li class="level2 node"><div class="li"> <code>conf/</code></div> <ul> <li class="level3"><div class="li"> <code>default.php</code> – <a href="/devel:configuration#default_settings" class="wikilink1" title="devel:configuration" data-wiki-id="devel:configuration">Default settings</a> for the <a href="/devel:configuration#plugin_settings" class="wikilink1" title="devel:configuration" data-wiki-id="devel:configuration">plugin settings</a> (accessible via <code>$this->getConf()</code>, saved local settings are stored in DokuWiki's global <code><dokuwiki>/conf/local.php</code>)</div> </li> <li class="level3"><div class="li"> <code>metadata.php</code> – <a href="/devel:configuration#configuration_metadata" class="wikilink1" title="devel:configuration" data-wiki-id="devel:configuration">configuration metadata</a> describing properties of the settings for use by Configuration Manager</div> </li> </ul> </li> </ul> </li> </ul> </div> <h4 id="use_plugin_wizard">Use Plugin Wizard</h4> <div class="level4"> <p> The simplest and recommended way to create the initial file system structure for new plugin is to use the <a href="http://pluginwizard.dokuwiki.org/" class="urlextern" title="http://pluginwizard.dokuwiki.org/">DokuWiki Plugin Wizard</a>. </p> </div> <div class="secedit editbutton_section editbutton_1"><form class="button btn_secedit" method="post" action="/devel:plugin_file_structure"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1681379257" /><input type="hidden" name="summary" value="[Plugin File Structure] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="plugin_file_structure" /><input type="hidden" name="codeblockOffset" value="0" /><input type="hidden" name="range" value="1-3794" /><button type="submit" title="Plugin File Structure">Edit</button></div></form></div> <h2 class="sectionedit2" id="css_styles">CSS Styles</h2> <div class="level2"> <p> Please refer to <a href="/devel:css#plugins_styles" class="wikilink1" title="devel:css" data-wiki-id="devel:css">CSS stylesheets for plugins</a> for more info which style files you can use and how. Only the <abbr title="Cascading Style Sheets">CSS</abbr> style files listed below are available, all your <abbr title="Cascading Style Sheets">CSS</abbr> should be merged into one of these files, including or referring other style files is not available. </p> <p> Possible files, all optional: </p> <ul> <li class="level1 node"><div class="li"> <code><dokuwiki>/lib/plugins/<pluginname>/</code></div> <ul> <li class="level2"><div class="li"> <code>style.css</code> – <a href="/devel:css" class="wikilink1" title="devel:css" data-wiki-id="devel:css">CSS</a> styles for the plugin. Usually only used css file.</div> </li> <li class="level2"><div class="li"> <code>print.css</code> – print <a href="/devel:css" class="wikilink1" title="devel:css" data-wiki-id="devel:css">CSS</a> styles for the plugin</div> </li> <li class="level2"><div class="li"> <code>all.css</code> – Applied in all display modes</div> </li> <li class="level2"><div class="li"> <code>feed.css</code> – Applied when displaying the <a href="/syndication" class="wikilink1" title="syndication" data-wiki-id="syndication">feed</a></div> </li> </ul> </li> </ul> <p> Since Binky, DokuWiki supports LESS parsing, you may use <a href="/devel:less" class="wikilink1" title="devel:less" data-wiki-id="devel:less">*.less</a> files as well. </p> </div> <div class="secedit editbutton_section editbutton_2"><form class="button btn_secedit" method="post" action="/devel:plugin_file_structure"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1681379257" /><input type="hidden" name="summary" value="[CSS Styles] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="css_styles" /><input type="hidden" name="codeblockOffset" value="2" /><input type="hidden" name="range" value="3795-4548" /><button type="submit" title="CSS Styles">Edit</button></div></form></div> <h2 class="sectionedit3" id="javascript">JavaScript</h2> <div class="level2"> <p> Please read <a href="/devel:javascript" class="wikilink1" title="devel:javascript" data-wiki-id="devel:javascript">javascript</a> for javascript loading and coding guidelines. Javascript files can contain DokuWiki specific syntax for <a href="/devel:javascript#include_syntax" class="wikilink1" title="devel:javascript" data-wiki-id="devel:javascript">including other javascript files</a>. </p> <p> Possible files, all optional: </p> <ul> <li class="level1 node"><div class="li"> <code><dokuwiki>/lib/plugins/<pluginname>/</code></div> <ul> <li class="level2"><div class="li"> <code>script.js</code> – <a href="/devel:javascript" class="wikilink1" title="devel:javascript" data-wiki-id="devel:javascript">JavaScript</a> used by the plugin</div> </li> <li class="level2"><div class="li"> <code>scripts/<filename>.js</code> – in script.js can be <a href="/devel:javascript#include_syntax" class="wikilink1" title="devel:javascript" data-wiki-id="devel:javascript">included other script files</a>.</div> </li> </ul> </li> </ul> <p> See also <a href="/devel:jqueryfaq" class="wikilink1" title="devel:jqueryfaq" data-wiki-id="devel:jqueryfaq">FAQ about jQuery</a> </p> </div> <div class="secedit editbutton_section editbutton_3"><form class="button btn_secedit" method="post" action="/devel:plugin_file_structure"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1681379257" /><input type="hidden" name="summary" value="[JavaScript] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="javascript" /><input type="hidden" name="codeblockOffset" value="2" /><input type="hidden" name="range" value="4549-5076" /><button type="submit" title="JavaScript">Edit</button></div></form></div> <h2 class="sectionedit4" id="don_t_include_extension_manager_files">Don't include Extension manager files</h2> <div class="level2"> <p> There can be also auto-generated files around from the extension manager, don't include these in your final plugin download package: </p> <ul> <li class="level1 node"><div class="li"> <code><dokuwiki>/lib/plugins/<pluginname>/</code></div> <ul> <li class="level2"><div class="li"> <code>disabled</code> – This 0 byte file indicates the plugin is disabled.</div> </li> <li class="level2"><div class="li"> <code>manager.dat</code> – Stores extension manager data e.g. download url and installation date</div> </li> </ul> </li> </ul> </div> <div class="secedit editbutton_section editbutton_4"><form class="button btn_secedit" method="post" action="/devel:plugin_file_structure"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1681379257" /><input type="hidden" name="summary" value="[Don't include Extension manager files] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="don_t_include_extension_manager_files" /><input type="hidden" name="codeblockOffset" value="2" /><input type="hidden" name="range" value="5077-5475" /><button type="submit" title="Don't include Extension manager files">Edit</button></div></form></div> <h2 class="sectionedit5" id="see_also">See also</h2> <div class="level2"> <ul> <li class="level1"><div class="li"> <a href="/devel:plugins" class="wikilink1" title="devel:plugins" data-wiki-id="devel:plugins">Plugin Developer documentation</a></div> </li> <li class="level1"><div class="li"> <a href="/devel:common_plugin_functions" class="wikilink1" title="devel:common_plugin_functions" data-wiki-id="devel:common_plugin_functions">Common Plugin Functions</a></div> </li> <li class="level1"><div class="li"> Plugin types: <a href="/devel:action_plugins" class="wikilink1" title="devel:action_plugins" data-wiki-id="devel:action_plugins">Action</a>, <a href="/devel:admin_plugins" class="wikilink1" title="devel:admin_plugins" data-wiki-id="devel:admin_plugins">Admin</a>, <a href="/devel:auth_plugins" class="wikilink1" title="devel:auth_plugins" data-wiki-id="devel:auth_plugins">Auth</a>, <a href="/devel:remote_plugins" class="wikilink1" title="devel:remote_plugins" data-wiki-id="devel:remote_plugins">Remote</a>, <a href="/devel:helper_plugins" class="wikilink1" title="devel:helper_plugins" data-wiki-id="devel:helper_plugins">Helper</a>, <a href="/devel:syntax_plugins" class="wikilink1" title="devel:syntax_plugins" data-wiki-id="devel:syntax_plugins">Syntax</a> and <a href="/devel:renderer_plugins" class="wikilink1" title="devel:renderer_plugins" data-wiki-id="devel:renderer_plugins">Renderer</a></div> </li> <li class="level1"><div class="li"> <a href="/devel:security" class="wikilink1" title="devel:security" data-wiki-id="devel:security">Security Guidelines</a> for plugin developers</div> </li> <li class="level1"><div class="li"> <a href="/devel:plugin_programming_tips" class="wikilink1" title="devel:plugin_programming_tips" data-wiki-id="devel:plugin_programming_tips">Plugin programming tips</a></div> </li> </ul> </div> <div class="secedit editbutton_section editbutton_5"><form class="button btn_secedit" method="post" action="/devel:plugin_file_structure"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1681379257" /><input type="hidden" name="summary" value="[See also] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="see_also" /><input type="hidden" name="codeblockOffset" value="2" /><input type="hidden" name="range" value="5476-" /><button type="submit" title="See also">Edit</button></div></form></div>  </div> <div class="docInfo"><bdi>devel/plugin_file_structure.txt</bdi> · Last modified: <time datetime="2023-04-13T11:47:37+0200">2023-04-13 11:47</time> by <bdi>hsins</bdi></div> <hr class="a11y" /> </div></main>  <nav id="dokuwiki__pagetools" aria-labelledby="dokuwiki__pagetools__heading"> <h3 class="a11y" id="dokuwiki__pagetools__heading">Page Tools</h3> <div class="tools"> <ul> <li class="edit"><a href="/devel:plugin_file_structure?do=edit" title="Edit this page [e]" rel="nofollow" accesskey="e"><span>Edit this page</span><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg></a></li><li class="revs"><a href="/devel:plugin_file_structure?do=revisions" title="Old revisions [o]" rel="nofollow" accesskey="o"><span>Old revisions</span><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M11 7v5.11l4.71 2.79.79-1.28-4-2.37V7m0-5C8.97 2 5.91 3.92 4.27 6.77L2 4.5V11h6.5L5.75 8.25C6.96 5.73 9.5 4 12.5 4a7.5 7.5 0 0 1 7.5 7.5 7.5 7.5 0 0 1-7.5 7.5c-3.27 0-6.03-2.09-7.06-5h-2.1c1.1 4.03 4.77 7 9.16 7 5.24 0 9.5-4.25 9.5-9.5A9.5 9.5 0 0 0 12.5 2z"/></svg></a></li><li class="backlink"><a href="/devel:plugin_file_structure?do=backlink" title="Backlinks" rel="nofollow"><span>Backlinks</span><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M10.59 13.41c.41.39.41 1.03 0 1.42-.39.39-1.03.39-1.42 0a5.003 5.003 0 0 1 0-7.07l3.54-3.54a5.003 5.003 0 0 1 7.07 0 5.003 5.003 0 0 1 0 7.07l-1.49 1.49c.01-.82-.12-1.64-.4-2.42l.47-.48a2.982 2.982 0 0 0 0-4.24 2.982 2.982 0 0 0-4.24 0l-3.53 3.53a2.982 2.982 0 0 0 0 4.24m2.82-4.24c.39-.39 1.03-.39 1.42 0a5.003 5.003 0 0 1 0 7.07l-3.54 3.54a5.003 5.003 0 0 1-7.07 0 5.003 5.003 0 0 1 0-7.07l1.49-1.49c-.01.82.12 1.64.4 2.43l-.47.47a2.982 2.982 0 0 0 0 4.24 2.982 2.982 0 0 0 4.24 0l3.53-3.53a2.982 2.982 0 0 0 0-4.24.973.973 0 0 1 0-1.42z"/></svg></a></li><li class="top"><a href="#dokuwiki__top" title="Back to top [t]" rel="nofollow" accesskey="t"><span>Back to top</span><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"/></svg></a></li> </ul> </div> </nav> </div>  <footer id="dokuwiki__footer"><div class="pad"> <div class="license">Except where otherwise noted, content on this wiki is licensed under the following license: <bdi><a href="https://creativecommons.org/licenses/by-sa/4.0/deed.en" rel="license" class="urlextern">CC Attribution-Share Alike 4.0 International</a></bdi></div> <div class="buttons"> <a href="https://creativecommons.org/licenses/by-sa/4.0/deed.en" rel="license"><img src="/lib/images/license/button/cc-by-sa.png" alt="CC Attribution-Share Alike 4.0 International" /></a> <a href="https://www.dokuwiki.org/donate" title="Donate" ><img src="/lib/tpl/dokuwiki/images/button-donate.gif" width="80" height="15" alt="Donate" /></a> <a href="https://php.net" title="Powered by PHP" ><img src="/lib/tpl/dokuwiki/images/button-php.gif" width="80" height="15" alt="Powered by PHP" /></a> <a href="//validator.w3.org/check/referer" title="Valid HTML5" ><img src="/lib/tpl/dokuwiki/images/button-html5.png" width="80" height="15" alt="Valid HTML5" /></a> <a href="//jigsaw.w3.org/css-validator/check/referer?profile=css3" title="Valid CSS" ><img src="/lib/tpl/dokuwiki/images/button-css.png" width="80" height="15" alt="Valid CSS" /></a> <a href="https://dokuwiki.org/" title="Driven by DokuWiki" ><img src="/lib/tpl/dokuwiki/images/button-dw.png" width="80" height="15" alt="Driven by DokuWiki" /></a> </div> <div style="margin-top: 2em; font-size:90%" class="dokuwiki"><div style="float:right"><a href="http://www.splitbrain.org/personal#imprint" style="float:right; text-decoration: none; color:#333">Imprint</a></div></div> <style type="text/css"> @media screen { body { padding-top: 30px; } #global__header { position: absolute; top: 0; left: 0; text-align: left; vertical-align: middle; line-height: 1.5; background-color: #333; box-shadow: 0 0 8px rgba(0,0,0,0.5); width: 100%; margin: 0; padding: 5px 20px; -moz-box-sizing: border-box; -webkit-box-sizing: border-box; box-sizing: border-box; white-space: nowrap; overflow: hidden; } #global__header h2 { position: absolute; left: -99999em; top: 0; overflow: hidden; display: inline; } #global__header ul, #global__header li { margin: 0; padding: 0; list-style: none; display: inline; line-height: 1.5; } #global__header a { color: #bbb; text-decoration: none; margin-right: 20px; font-size: 14px; font-weight: normal; } #global__header a:hover, #global__header a:active, #global__header a:focus { color: #fff; text-decoration: underline; } #global__header form { float: right; margin: 0 0 0 20px; } #global__header input { background-color: #333; background-image: none; border: 1px solid #bbb; color: #fff; box-shadow: none; border-radius: 2px; margin: 0; line-height: normal; padding: 1px 0 1px 0; height: auto; } #global__header input.button { border: none; color: #bbb; } #global__header input.button:hover, #global__header input.button:active, #global__header input.button:focus { color: #fff; text-decoration: underline; } } /* /@media */ @media only screen and (min-width: 601px) { /* changes specific for www.dokuwiki.org */ #dokuwiki__header { padding-top: 3em; } #dokuwiki__usertools { top: 3em; } /* changes specific for bugs.dokuwiki.org */ div#container div#showtask { top: 40px; } } /* /@media */ @media only screen and (max-width: 600px) { body { padding-top: 0; } #global__header { position: static; white-space: normal; overflow: auto; } #global__header form { float: none; display: block; margin: 0 0 .4em; } } /* /@media */ @media print { #global__header { display: none; } } /* /@media */ </style> <div id="global__header"> <h2>Global DokuWiki Links</h2> <form method="get" action="https://search.dokuwiki.org/" target="_top"> <input type="text" name="q" title="Search all DokuWiki sites at once" class="input" /> <input type="submit" title="Search all DokuWiki sites at once" value="Search" class="button" /> </form> <ul> <li><a href="https://download.dokuwiki.org" title="Download the latest release" target="_top">Download</a></li> <li><a href="https://www.dokuwiki.org" title="Read the DokuWiki documentation" target="_top">Wiki</a></li> <li><a href="https://forum.dokuwiki.org" title="Ask questions in the DokuWiki forum" target="_top">Forum</a></li> <li><a href="https://irc.dokuwiki.org" title="Check IRC chat logs or join the chat" target="_top">IRC</a></li> <li><a href="https://github.com/splitbrain/dokuwiki/issues" title="Report and track bugs" target="_top">Bugs</a></li> <li><a href="https://translate.dokuwiki.org/" title="Help translating the DokuWiki interface" target="_top">Translate</a></li> <li><a href="https://github.com/splitbrain/dokuwiki" title="Access the most recent git commits" target="_top">Git</a></li> <li><a href="https://xref.dokuwiki.org/reference/dokuwiki/" title="Cross-Reference of the DokuWiki source code" target="_top">XRef</a></li> <li><a href="https://codesearch.dokuwiki.org/" title="Search through the sources of DokuWiki, plugins and templates" target="_top">Code Search</a></li> </ul> </div>  </div></footer> </div></div> <div class="no"><img src="/lib/exe/taskrunner.php?id=devel%3Aplugin_file_structure&1733008375" width="2" height="1" alt="" /></div> <div id="screen__mode" class="no"></div></body> </html>