CINXE.COM

<!DOCTYPE html> <html lang="en" dir="ltr" class="no-js"> <head> <meta charset="utf-8" /> <title>plugin:confmanager [DokuWiki]</title> <meta name="generator" content="DokuWiki"/> <meta name="theme-color" content="#008800"/> <meta name="robots" content="index,follow"/> <meta name="keywords" content="plugin,confmanager"/> <link rel="search" type="application/opensearchdescription+xml" href="/lib/exe/opensearch.php" title="DokuWiki"/> <link rel="start" href="/"/> <link rel="contents" href="/plugin:confmanager?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=plugin"/> <link rel="edit" title="Edit this page" href="/plugin:confmanager?do=edit"/> <link rel="alternate" type="text/html" title="Plain HTML" href="/_export/xhtml/plugin:confmanager"/> <link rel="alternate" type="text/plain" title="Wiki Markup" href="/_export/raw/plugin:confmanager"/> <link rel="canonical" href="https://www.dokuwiki.org/plugin:confmanager"/> <link rel="stylesheet" href="/lib/exe/css.php?t=dokuwiki&tseed=f1005bad3d81fc9c803c7f93d32a390e"/> <script >var NS='plugin';var JSINFO = {"plugins":{"edittable":{"default columnwidth":""}},"id":"plugin:confmanager","namespace":"plugin","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="/plugin:confmanager?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="plugin:confmanager" /><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="plugin:confmanager" /><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="/plugin:confmanager?do=recent" title="Recent Changes [r]" rel="nofollow" accesskey="r">Recent Changes</a></li><li class="action media"><a href="/plugin:confmanager?do=media&ns=plugin" title="Media Manager" rel="nofollow">Media Manager</a></li><li class="action index"><a href="/plugin:confmanager?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="/plugin:confmanager" class="breadcrumbs" title="plugin:confmanager">confmanager</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"> <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>plugin:confmanager</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="#confmanager_plugin">confmanager Plugin</a></div> <ul class="toc"> <li class="level2"><div class="li"><a href="#download_and_installation">Download and Installation</a></div> <ul class="toc"> <li class="level3"><div class="li"><a href="#changes">Changes</a></div></li> </ul> </li> <li class="level2"><div class="li"><a href="#usage">Usage</a></div></li> <li class="level2"><div class="li"><a href="#plugins_that_support_the_confmanager">Plugins that support the confmanager</a></div></li> <li class="level2"><div class="li"><a href="#development_notesuse_the_conf_manager_for_your_plugin">Development notes: Use the conf manager for your plugin</a></div> <ul class="toc"> <li class="level3"><div class="li"><a href="#config_cascade_config_types">Config cascade config types</a></div></li> <li class="level3"><div class="li"><a href="#configmanagertwoline_config_type">ConfigManagerTwoLine config type</a></div></li> </ul></li> </ul></li> </ul> </div> </div>  <h1 class="sectionedit1" id="confmanager_plugin">confmanager Plugin</h1> <div class="level1"> <div class="pluginrepo_entry"><div class="usageInfo"><div class="compatibility"><p class="label">Compatible with DokuWiki</p><div class="versions"><ul><li class="yes">2024-02-06 "Kaos" <strong><span>yes</span></strong></li><li class="yes">2023-04-04 "Jack Jackrum" <strong><span>yes</span></strong></li><li class="yes">2022-07-31 "Igor" <strong><span>yes</span></strong></li><li class="yes">2020-07-29 "Hogfather" <strong><span>yes</span></strong></li></ul></div></div><ul class="actions"><li><a class="download" href="https://github.com/cosmocode/confmanager/zipball/master">Download</a></li><li><a class="bugs" href="https://github.com/cosmocode/confmanager/issues">Report bugs</a></li></ul><div class="clearer"></div></div><div class="mainInfo"><p class="description"><a class="media" href="/plugins"><img alt="plugin" class="medialeft" src="/lib/plugins/pluginrepo/images/dwplugin.png" width="60" height="60" /></a> Plugin to manage various .conf files</p><a href="/_media/plugin:confmanager:confmanager_small.png" class="media screenshot" title="Screenshot of confmanager" rel="lightbox" data-url="/_media/plugin:confmanager:confmanager_small.png"><img src="/_media/plugin:confmanager:confmanager_small.png?w=220&tok=718d1b" alt="" width="220" /></a></div><div class="metaInfo"><dl><dt>Last updated on</dt><dd>2023-07-08</dd><dt>Provides</dt><dd><a href="/plugins?plugintype=2#extension__table" class="wikilink1" title="List all Admin plugins">Admin</a>, <a href="/plugins?plugintype=4#extension__table" class="wikilink1" title="List all Action plugins">Action</a>, <a href="/plugins?plugintype=64#extension__table" class="wikilink1" title="List all Remote plugins">Remote</a></dd><dt>Repository</dt><dd><a class="urlextern" href="https://github.com/cosmocode/confmanager/">Source</a></dd></dl></div><div class="moreInfo"><p class="similar">Similar to <a href="/plugin:acronymedit" class="wikilink1" title="plugin:acronymedit" data-wiki-id="plugin:acronymedit">acronymedit</a>, <a href="/plugin:advanced" class="wikilink1" title="plugin:advanced" data-wiki-id="plugin:advanced">advanced</a>, <a href="/plugin:txtconf" class="wikilink1" title="plugin:txtconf" data-wiki-id="plugin:txtconf">txtconf</a></p><p class="tags">Tagged with <a href="/plugins?plugintag=admin#extension__table" class="wikilink1" title="List all plugins with this tag">admin</a>, <a href="/plugins?plugintag=configuration#extension__table" class="wikilink1" title="List all plugins with this tag">configuration</a></p></div><div class="authorInfo"><strong>By <a href="mailto:dokuwiki%20%5Bat%5D%20cosmocode%20%5Bdot%5D%20de" class="mail" title="dokuwiki [at] cosmocode [dot] de">Dominik Eckelmann, Julian Heise, Michael Große</a></strong><ul><li><a href="/plugin:csv" class="wikilink1" title="plugin:csv" data-wiki-id="plugin:csv">csv</a></li> <li><a href="/plugin:clearhistory" class="wikilink1" title="plugin:clearhistory" data-wiki-id="plugin:clearhistory">clearhistory</a></li> <li><a href="/plugin:preview" class="wikilink1" title="plugin:preview" data-wiki-id="plugin:preview">preview</a></li> <li><a href="/plugin:explain" class="wikilink1" title="plugin:explain" data-wiki-id="plugin:explain">explain</a></li> <li><a href="/plugin:logstats" class="wikilink1" title="plugin:logstats" data-wiki-id="plugin:logstats">logstats</a></li> <li><a href="/plugin:oiddelegate" class="wikilink1" title="plugin:oiddelegate" data-wiki-id="plugin:oiddelegate">oiddelegate</a></li> <li><a href="/plugin:labeled" class="wikilink1" title="plugin:labeled" data-wiki-id="plugin:labeled">labeled</a></li> <li><a href="/plugin:slider" class="wikilink1" title="plugin:slider" data-wiki-id="plugin:slider">slider</a></li> <li><a href="/plugin:groupusers" class="wikilink1" title="plugin:groupusers" data-wiki-id="plugin:groupusers">groupusers</a></li> <li><a href="/plugin:navi" class="wikilink1" title="plugin:navi" data-wiki-id="plugin:navi">navi</a></li> <li>and 126 more</li></ul></div></div> </div> <div class="secedit editbutton_section editbutton_1"><form class="button btn_secedit" method="post" action="/plugin:confmanager"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1722689058" /><input type="hidden" name="summary" value="[confmanager Plugin] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="confmanager_plugin" /><input type="hidden" name="codeblockOffset" value="0" /><input type="hidden" name="range" value="1-684" /><button type="submit" title="confmanager Plugin">Edit</button></div></form></div> <h2 class="sectionedit2" id="download_and_installation">Download and Installation</h2> <div class="level2"> <p> <a href="https://www.cosmocode.de/en/open-source/dokuwiki-plugins/" class="media" title="https://www.cosmocode.de/en/open-source/dokuwiki-plugins/"><img src="/lib/exe/fetch.php?cache=recache&tok=a307b5&media=https%3A%2F%2Fwww.cosmocode.de%2Fstatic%2Fimg%2Fdokuwiki%2Fdwplugins.png" class="mediaright" loading="lazy" title="A CosmoCode Plugin" alt="A CosmoCode Plugin" /></a> </p> <p> Search and install the plugin using the <a href="/plugin:extension" class="wikilink1" title="plugin:extension" data-wiki-id="plugin:extension">Extension Manager</a>. Refer to <a href="/plugins" class="wikilink1" title="plugins" data-wiki-id="plugins">Plugins</a> on how to install plugins manually. </p> </div> <div class="secedit editbutton_section editbutton_2"><form class="button btn_secedit" method="post" action="/plugin:confmanager"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1722689058" /><input type="hidden" name="summary" value="[Download and Installation] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="download_and_installation" /><input type="hidden" name="codeblockOffset" value="0" /><input type="hidden" name="range" value="685-1016" /><button type="submit" title="Download and Installation">Edit</button></div></form></div> <h3 class="sectionedit3" id="changes">Changes</h3> <div class="level3"> <ul class="rss"><li><div class="li"><a href="https://github.com/cosmocode/confmanager/commit/fa9901c4a790ffce47d0c2fff0d04480b74be0c4" class="urlextern" title="https://github.com/cosmocode/confmanager/commit/fa9901c4a790ffce47d0c2fff0d04480b74be0c4">Version upped</a> (2024-07-29 23:50)</div></li><li><div class="li"><a href="https://github.com/cosmocode/confmanager/commit/a609abcdce7fe8337ba5e5d4fb511cb5b7d99ef8" class="urlextern" title="https://github.com/cosmocode/confmanager/commit/a609abcdce7fe8337ba5e5d4fb511cb5b7d99ef8">Merge pull request #59 from Klap-in/icons</a> (2024-07-29 08:20)</div></li><li><div class="li"><a href="https://github.com/cosmocode/confmanager/commit/b70ac31b875d49f613df40475e8045fc13a012f1" class="urlextern" title="https://github.com/cosmocode/confmanager/commit/b70ac31b875d49f613df40475e8045fc13a012f1">Merge pull request #60 from dokuwiki-translate/lang_update_831_170962…</a> (2024-03-05 08:40)</div></li><li><div class="li"><a href="https://github.com/cosmocode/confmanager/commit/e09876b4354bf96ed355f7b01d402afe8635ace0" class="urlextern" title="https://github.com/cosmocode/confmanager/commit/e09876b4354bf96ed355f7b01d402afe8635ace0">translation update</a> (2024-03-05 08:00)</div></li><li><div class="li"><a href="https://github.com/cosmocode/confmanager/commit/2e8a659ef778c0f40ff1f679e9b5174f919e9127" class="urlextern" title="https://github.com/cosmocode/confmanager/commit/2e8a659ef778c0f40ff1f679e9b5174f919e9127">Merge pull request #58 from dokuwiki-translate/lang_update_661_168695…</a> (2023-12-13 14:33)</div></li><li><div class="li"><a href="https://github.com/cosmocode/confmanager/commit/7928ec2919c8a99699f82ac510b02775ab337336" class="urlextern" title="https://github.com/cosmocode/confmanager/commit/7928ec2919c8a99699f82ac510b02775ab337336">some phpdocs and use local variable</a> (2023-07-08 13:39)</div></li><li><div class="li"><a href="https://github.com/cosmocode/confmanager/commit/6953b1a29d4da05a3d3f6ebe185d856e7eff4a34" class="urlextern" title="https://github.com/cosmocode/confmanager/commit/6953b1a29d4da05a3d3f6ebe185d856e7eff4a34">set height of the icons (assumes heights of default dokuwiki template)</a> (2023-07-08 13:38)</div></li><li><div class="li"><a href="https://github.com/cosmocode/confmanager/commit/956724fa1f149c2df85680103a1adb881d750964" class="urlextern" title="https://github.com/cosmocode/confmanager/commit/956724fa1f149c2df85680103a1adb881d750964">translation update</a> (2023-06-17 00:45)</div></li></ul> </div> <div class="secedit editbutton_section editbutton_3"><form class="button btn_secedit" method="post" action="/plugin:confmanager"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1722689058" /><input type="hidden" name="summary" value="[Changes] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="changes" /><input type="hidden" name="codeblockOffset" value="0" /><input type="hidden" name="range" value="1017-1110" /><button type="submit" title="Changes">Edit</button></div></form></div> <h2 class="sectionedit4" id="usage">Usage</h2> <div class="level2"> <p> You can use this plugin to edit several <code><a href="/config#configuration_files" class="wikilink1" title="config" data-wiki-id="config">*.conf</a></code> files from the <code>conf/</code> directory via the DokuWiki admin menu: <a href="/lib/exe/fetch.php?cache=recache&tok=fef75e&media=https%3A%2F%2Fraw.githubusercontent.com%2Fcosmocode%2Fconfmanager%2Fmaster%2Fadmin.svg" class="media" title="https://raw.githubusercontent.com/cosmocode/confmanager/master/admin.svg"><img src="/lib/exe/fetch.php?w=20&cache=recache&tok=8b07ee&media=https%3A%2F%2Fraw.githubusercontent.com%2Fcosmocode%2Fconfmanager%2Fmaster%2Fadmin.svg" class="media" loading="lazy" alt="" width="20" /></a> Configuration File Manager. </p> <p> After selecting a configuration file in the dropdown menu, you can add your own lines, or overwrite or disable the default lines. </p> <p> <a href="/_detail/plugin:confmanager:confmanager.png?id=plugin%3Aconfmanager" class="media" title="plugin:confmanager:confmanager.png"><img src="/_media/plugin:confmanager:confmanager.png?w=500&tok=1cc383" class="media" loading="lazy" alt="" width="500" /></a> </p> </div> <div class="secedit editbutton_section editbutton_4"><form class="button btn_secedit" method="post" action="/plugin:confmanager"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1722689058" /><input type="hidden" name="summary" value="[Usage] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="usage" /><input type="hidden" name="codeblockOffset" value="0" /><input type="hidden" name="range" value="1111-1570" /><button type="submit" title="Usage">Edit</button></div></form></div> <h2 class="sectionedit5" id="plugins_that_support_the_confmanager">Plugins that support the confmanager</h2> <div class="level2"> <ul> <li class="level1"><div class="li"> <a href="/plugin:docsearch" class="wikilink1" title="plugin:docsearch" data-wiki-id="plugin:docsearch">docsearch</a></div> </li> <li class="level1"><div class="li"> <a href="/plugin:tagalerts" class="wikilink1" title="plugin:tagalerts" data-wiki-id="plugin:tagalerts">tagalerts</a></div> </li> <li class="level1"><div class="li"> <a href="/plugin:uncmap" class="wikilink1" title="plugin:uncmap" data-wiki-id="plugin:uncmap">uncmap</a></div> </li> <li class="level1"><div class="li"> <a href="/plugin:elasticsearch" class="wikilink1" title="plugin:elasticsearch" data-wiki-id="plugin:elasticsearch">elasticsearch</a></div> </li> </ul> </div> <div class="secedit editbutton_section editbutton_5"><form class="button btn_secedit" method="post" action="/plugin:confmanager"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1722689058" /><input type="hidden" name="summary" value="[Plugins that support the confmanager] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="plugins_that_support_the_confmanager" /><input type="hidden" name="codeblockOffset" value="0" /><input type="hidden" name="range" value="1571-1722" /><button type="submit" title="Plugins that support the confmanager">Edit</button></div></form></div> <h2 class="sectionedit6" id="development_notesuse_the_conf_manager_for_your_plugin">Development notes: Use the conf manager for your plugin</h2> <div class="level2"> <p> You can use the ConfManager with your very own plugin. The ConfManager plugin supports different types of config files descripted below. To add the config you have to add an <a href="/devel:action_plugins" class="wikilink1" title="devel:action_plugins" data-wiki-id="devel:action_plugins">action</a> component that hooks the <code>CONFMANAGER_CONFIGFILES_REGISTER</code> event. You can add your config file to the <code>$event→data</code> array. </p> <p> The following example shows the usage of the <code>ConfigManagerTwoLine</code> config type. </p> <pre class="code php"><span class="kw2"><?php</span>   <span class="kw2">class</span> action_plugin_docsearch_confmanager <span class="kw2">extends</span> DokuWiki_Action_Plugin <span class="br0">{</span>   <span class="kw2">public</span> <span class="kw2">function</span> register<span class="br0">(</span>Doku_Event_Handler <span class="re0">$controller</span><span class="br0">)</span> <span class="br0">{</span> <span class="re0">$controller</span><span class="sy0">-></span><span class="me1">register_hook</span><span class="br0">(</span><span class="st_h">'CONFMANAGER_CONFIGFILES_REGISTER'</span><span class="sy0">,</span> <span class="st_h">'BEFORE'</span><span class="sy0">,</span> <span class="re0">$this</span><span class="sy0">,</span> <span class="st_h">'addConfigFile'</span><span class="sy0">,</span> <a href="http://www.php.net/array"><span class="kw3">array</span></a><span class="br0">(</span><span class="br0">)</span><span class="br0">)</span><span class="sy0">;</span> <span class="br0">}</span>   <span class="kw2">public</span> <span class="kw2">function</span> addConfigFile<span class="br0">(</span>Doku_Event <span class="re0">$event</span><span class="sy0">,</span> <span class="re0">$params</span><span class="br0">)</span> <span class="br0">{</span> <span class="kw1">if</span> <span class="br0">(</span><a href="http://www.php.net/class_exists"><span class="kw3">class_exists</span></a><span class="br0">(</span><span class="st_h">'ConfigManagerTwoLine'</span><span class="br0">)</span><span class="br0">)</span> <span class="br0">{</span> <span class="re0">$config</span> <span class="sy0">=</span> <span class="kw2">new</span> ConfigManagerTwoLine<span class="br0">(</span><span class="st_h">'My Config'</span><span class="sy0">,</span> <span class="st_h">'Description of my plugin'</span><span class="sy0">,</span> DOKU_INC <span class="sy0">.</span> <span class="st_h">'path to my config'</span><span class="br0">)</span><span class="sy0">;</span> <span class="re0">$event</span><span class="sy0">-></span><span class="me1">data</span><span class="br0">[</span><span class="br0">]</span> <span class="sy0">=</span> <span class="re0">$config</span><span class="sy0">;</span> <span class="br0">}</span> <span class="br0">}</span> <span class="br0">}</span></pre> </div> <div class="secedit editbutton_section editbutton_6"><form class="button btn_secedit" method="post" action="/plugin:confmanager"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1722689058" /><input type="hidden" name="summary" value="[Development notes: Use the conf manager for your plugin] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="development_notesuse_the_conf_manager_for_your_plugin" /><input type="hidden" name="codeblockOffset" value="0" /><input type="hidden" name="range" value="1723-2792" /><button type="submit" title="Development notes: Use the conf manager for your plugin">Edit</button></div></form></div> <h3 class="sectionedit7" id="config_cascade_config_types">Config cascade config types</h3> <div class="level3"> <p> The ConfManager provides support for some config formats used by DokuWiki. DokuWiki use the global $config_cascade array to get the path to the config file. </p> <p> The following config types are available: </p> <div class="table sectionedit8"><table class="inline"> <thead> <tr class="row0"> <th class="col0"> Class name </th><th class="col1"> Description </th> </tr> </thead> <tr class="row1"> <td class="col0"> ConfigManagerSingleLineCoreConfig </td><td class="col1"> Every line is a config option. The config values are basically an array. I.e. the <a href="/blacklist" class="wikilink1" title="blacklist" data-wiki-id="blacklist">blacklist</a> config. </td> </tr> <tr class="row2"> <td class="col0"> ConfigManagerTwoLineCascadeConfig </td><td class="col1"> Every line is a config option. The first word in the line is a config key . The config is a associative array. I.e. the <a href="/abbreviations" class="wikilink1" title="abbreviations" data-wiki-id="abbreviations">abbreviations</a> config </td> </tr> <tr class="row3"> <td class="col0"> ConfigManagerTwoLineLeftImageConfigCascade </td><td class="col1"> Like ConfigManagerTwoLineCascadeConfig but with image support. An image can be assigned for every key. I.e. the <a href="/mime" class="wikilink1" title="mime" data-wiki-id="mime">mime</a> config </td> </tr> </table></div> <div class="secedit editbutton_table editbutton_8"><form class="button btn_secedit" method="post" action="/plugin:confmanager"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1722689058" /><input type="hidden" name="summary" value="[Table] " /><input type="hidden" name="target" value="table" /><input type="hidden" name="hid" value="table" /><input type="hidden" name="range" value="3032-3569" /><button type="submit" title="Table">Edit</button></div></form></div> <p> The following code shows how to create an instance of each config type from the table above. The following placeholder are used: </p> <ul> <li class="level1"><div class="li"> <strong><name></strong> Name of the config in the <code>$config_cascade</code> array.</div> </li> <li class="level1"><div class="li"> <strong><image path></strong> Path starting from DOKU_INC to the image folder.</div> </li> <li class="level1"><div class="li"> <strong><image extension></strong> Extension of the images to use. I.e. mime icons use png.</div> </li> </ul> <pre class="code php"><span class="re0">$scheme</span> <span class="sy0">=</span> <span class="kw2">new</span> ConfigManagerSingleLineCoreConfig<span class="br0">(</span><span class="st_h">'<name>'</span><span class="br0">)</span><span class="sy0">;</span> <span class="re0">$acronyms</span> <span class="sy0">=</span> <span class="kw2">new</span> ConfigManagerTwoLineCascadeConfig<span class="br0">(</span><span class="st_h">'<name>'</span><span class="br0">)</span><span class="sy0">;</span> <span class="re0">$mime</span> <span class="sy0">=</span> <span class="kw2">new</span> ConfigManagerTwoLineLeftImageConfigCascade<span class="br0">(</span><span class="st_h">'<name>'</span><span class="sy0">,</span> <span class="st_h">'<image path>'</span><span class="sy0">,</span> <span class="st_h">'<image extension>'</span><span class="br0">)</span><span class="sy0">;</span></pre> <p> These three config types all have the following methods to provide additional information: </p> <ul> <li class="level1"><div class="li"> <strong>setName</strong> (string): The name of the config file. This is shown in the drop down box and as headline.</div> </li> <li class="level1"><div class="li"> <strong>setDescription</strong> (string): A description text to explain the config file. DokuWiki markup is allowed.</div> </li> </ul> </div> <div class="secedit editbutton_section editbutton_7"><form class="button btn_secedit" method="post" action="/plugin:confmanager"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1722689058" /><input type="hidden" name="summary" value="[Config cascade config types] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="config_cascade_config_types" /><input type="hidden" name="codeblockOffset" value="1" /><input type="hidden" name="range" value="2793-4470" /><button type="submit" title="Config cascade config types">Edit</button></div></form></div> <h3 class="sectionedit9" id="configmanagertwoline_config_type">ConfigManagerTwoLine config type</h3> <div class="level3"> <p> The ConfigManagerTwoLine config type stores an associative array like the <a href="/abbreviations" class="wikilink1" title="abbreviations" data-wiki-id="abbreviations">abbreviations</a> config. </p> <p> The following code shows how to create an instance of the ConfigManagerTwoLine config type. The following placeholder are used: </p> <ul> <li class="level1"><div class="li"> <strong><Title></strong> (string): The name of the config file. This is shown in the drop down box and as headline.</div> </li> <li class="level1"><div class="li"> <strong><Description></strong> (string): A description text to explain the config file. DokuWiki markup is allowed.</div> </li> <li class="level1"><div class="li"> <strong><Config path></strong> (string): Absolute path to the config file. If the file is not present it will be created.</div> </li> </ul> <pre class="code php"><span class="re0">$config</span> <span class="sy0">=</span> <span class="kw2">new</span> ConfigManagerTwoLine<span class="br0">(</span><span class="st_h">'<Title>'</span><span class="sy0">,</span> <span class="st_h">'<Description>'</span><span class="sy0">,</span> <span class="st_h">'<Config path>'</span><span class="br0">)</span><span class="sy0">;</span></pre> </div> <div class="secedit editbutton_section editbutton_9"><form class="button btn_secedit" method="post" action="/plugin:confmanager"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1722689058" /><input type="hidden" name="summary" value="[ConfigManagerTwoLine config type] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="configmanagertwoline_config_type" /><input type="hidden" name="codeblockOffset" value="2" /><input type="hidden" name="range" value="4471-" /><button type="submit" title="ConfigManagerTwoLine config type">Edit</button></div></form></div>  </div> <div class="docInfo"><bdi>plugin/confmanager.txt</bdi> · Last modified: <time datetime="2024-08-03T14:44:18+0200">2024-08-03 14:44</time> by <bdi>Klap-in</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="/plugin:confmanager?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="/plugin:confmanager?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="/plugin:confmanager?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=plugin%3Aconfmanager&1742780283" width="2" height="1" alt="" /></div> <div id="screen__mode" class="no"></div></body> </html>