"Fossies" - the Fresh Open Source Software Archive

Member "phpMyAdmin-5.0.1-all-languages/doc/html/themes.html" (7 Jan 2020, 11438 Bytes) of package /linux/www/phpMyAdmin-5.0.1-all-languages.zip:


The requested HTML page contains a <FORM> tag that is unusable on "Fossies" in "automatic" (rendered) mode so that page is shown as HTML source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3 
    4 
    5 <html xmlns="http://www.w3.org/1999/xhtml">
    6   <head>
    7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    8     
    9     <title>Custom Themes &#8212; phpMyAdmin 5.0.1 documentation</title>
   10     
   11     <link rel="stylesheet" href="_static/classic.css" type="text/css" />
   12     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
   13     
   14     <script type="text/javascript">
   15       var DOCUMENTATION_OPTIONS = {
   16         URL_ROOT:    './',
   17         VERSION:     '5.0.1',
   18         COLLAPSE_INDEX: false,
   19         FILE_SUFFIX: '.html',
   20         HAS_SOURCE:  true
   21       };
   22     </script>
   23     <script type="text/javascript" src="_static/jquery.js"></script>
   24     <script type="text/javascript" src="_static/underscore.js"></script>
   25     <script type="text/javascript" src="_static/doctools.js"></script>
   26     <link rel="index" title="Index" href="genindex.html" />
   27     <link rel="search" title="Search" href="search.html" />
   28     <link rel="copyright" title="Copyright" href="copyright.html" />
   29     <link rel="top" title="phpMyAdmin 5.0.1 documentation" href="index.html" />
   30     <link rel="up" title="User Guide" href="user.html" />
   31     <link rel="next" title="Other sources of information" href="other.html" />
   32     <link rel="prev" title="Import and export" href="import_export.html" /> 
   33   </head>
   34   <body role="document">
   35     <div class="related" role="navigation" aria-label="related navigation">
   36       <h3>Navigation</h3>
   37       <ul>
   38         <li class="right" style="margin-right: 10px">
   39           <a href="genindex.html" title="General Index"
   40              accesskey="I">index</a></li>
   41         <li class="right" >
   42           <a href="other.html" title="Other sources of information"
   43              accesskey="N">next</a> |</li>
   44         <li class="right" >
   45           <a href="import_export.html" title="Import and export"
   46              accesskey="P">previous</a> |</li>
   47         <li class="nav-item nav-item-0"><a href="index.html">phpMyAdmin 5.0.1 documentation</a> &#187;</li>
   48           <li class="nav-item nav-item-1"><a href="user.html" accesskey="U">User Guide</a> &#187;</li> 
   49       </ul>
   50     </div>  
   51 
   52     <div class="document">
   53       <div class="documentwrapper">
   54         <div class="bodywrapper">
   55           <div class="body" role="main">
   56             
   57   <div class="section" id="custom-themes">
   58 <span id="themes"></span><h1>Custom Themes<a class="headerlink" href="#custom-themes" title="Permalink to this headline"></a></h1>
   59 <p>phpMyAdmin comes with support for third party themes. You can download
   60 additonal themes from our website at &lt;<a class="reference external" href="https://www.phpmyadmin.net/themes/">https://www.phpmyadmin.net/themes/</a>&gt;.</p>
   61 <div class="section" id="configuration">
   62 <h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline"></a></h2>
   63 <p>Themes are configured with <span class="target" id="index-0"></span><a class="reference internal" href="config.html#cfg_ThemeManager"><code class="xref config config-option docutils literal"><span class="pre">$cfg['ThemeManager']</span></code></a> and
   64 <span class="target" id="index-1"></span><a class="reference internal" href="config.html#cfg_ThemeDefault"><code class="xref config config-option docutils literal"><span class="pre">$cfg['ThemeDefault']</span></code></a>.  Under <code class="file docutils literal"><span class="pre">./themes/</span></code>, you should not
   65 delete the directory <code class="docutils literal"><span class="pre">pmahomme</span></code> or its underlying structure, because this is
   66 the system theme used by phpMyAdmin. <code class="docutils literal"><span class="pre">pmahomme</span></code> contains all images and
   67 styles, for backwards compatibility and for all themes that would not include
   68 images or css-files.  If <span class="target" id="index-2"></span><a class="reference internal" href="config.html#cfg_ThemeManager"><code class="xref config config-option docutils literal"><span class="pre">$cfg['ThemeManager']</span></code></a> is enabled, you
   69 can select your favorite theme on the main page. Your selected theme will be
   70 stored in a cookie.</p>
   71 </div>
   72 <div class="section" id="creating-custom-theme">
   73 <h2>Creating custom theme<a class="headerlink" href="#creating-custom-theme" title="Permalink to this headline"></a></h2>
   74 <p>To create a theme:</p>
   75 <ul class="simple">
   76 <li>make a new subdirectory (for example &#8220;your_theme_name&#8221;) under <code class="file docutils literal"><span class="pre">./themes/</span></code>.</li>
   77 <li>copy the files and directories from <code class="docutils literal"><span class="pre">pmahomme</span></code> to &#8220;your_theme_name&#8221;</li>
   78 <li>edit the css-files in &#8220;your_theme_name/css&#8221;</li>
   79 <li>put your new images in &#8220;your_theme_name/img&#8221;</li>
   80 <li>edit <code class="file docutils literal"><span class="pre">layout.inc.php</span></code> in &#8220;your_theme_name&#8221;</li>
   81 <li>edit <code class="file docutils literal"><span class="pre">theme.json</span></code> in &#8220;your_theme_name&#8221; to contain theme metadata (see below)</li>
   82 <li>make a new screenshot of your theme and save it under
   83 &#8220;your_theme_name/screen.png&#8221;</li>
   84 </ul>
   85 <div class="section" id="theme-metadata">
   86 <h3>Theme metadata<a class="headerlink" href="#theme-metadata" title="Permalink to this headline"></a></h3>
   87 <div class="versionchanged">
   88 <p><span class="versionmodified">Changed in version 4.8.0: </span>Before 4.8.0 the theme metadata was passed in the <code class="file docutils literal"><span class="pre">info.inc.php</span></code> file.
   89 It has been replaced by <code class="file docutils literal"><span class="pre">theme.json</span></code> to allow easier parsing (without
   90 need to handle PHP code) and to support additional features.</p>
   91 </div>
   92 <p>In theme directory there is file <code class="file docutils literal"><span class="pre">theme.json</span></code> which contains theme
   93 metadata. Currently it consists of:</p>
   94 <dl class="describe">
   95 <dt>
   96 <code class="descname">name</code></dt>
   97 <dd><p>Display name of the theme.</p>
   98 <p><strong>This field is required.</strong></p>
   99 </dd></dl>
  100 
  101 <dl class="describe">
  102 <dt>
  103 <code class="descname">version</code></dt>
  104 <dd><p>Theme version, can be quite arbirary and does not have to match phpMyAdmin version.</p>
  105 <p><strong>This field is required.</strong></p>
  106 </dd></dl>
  107 
  108 <dl class="describe">
  109 <dt>
  110 <code class="descname">desciption</code></dt>
  111 <dd><p>Theme description. this will be shown on the website.</p>
  112 <p><strong>This field is required.</strong></p>
  113 </dd></dl>
  114 
  115 <dl class="describe">
  116 <dt>
  117 <code class="descname">author</code></dt>
  118 <dd><p>Theme author name.</p>
  119 <p><strong>This field is required.</strong></p>
  120 </dd></dl>
  121 
  122 <dl class="describe">
  123 <dt>
  124 <code class="descname">url</code></dt>
  125 <dd><p>Link to theme author website. It&#8217;s good idea to have way for getting
  126 support there.</p>
  127 </dd></dl>
  128 
  129 <dl class="describe">
  130 <dt>
  131 <code class="descname">supports</code></dt>
  132 <dd><p>Array of supported phpMyAdmin major versions.</p>
  133 <p><strong>This field is required.</strong></p>
  134 </dd></dl>
  135 
  136 <p>For example, the definition for Original theme shipped with phpMyAdnin 4.8:</p>
  137 <div class="highlight-json"><div class="highlight"><pre><span></span><span class="p">{</span>
  138     <span class="nt">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;Original&quot;</span><span class="p">,</span>
  139     <span class="nt">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;4.8&quot;</span><span class="p">,</span>
  140     <span class="nt">&quot;description&quot;</span><span class="p">:</span> <span class="s2">&quot;Original phpMyAdmin theme&quot;</span><span class="p">,</span>
  141     <span class="nt">&quot;author&quot;</span><span class="p">:</span> <span class="s2">&quot;phpMyAdmin developers&quot;</span><span class="p">,</span>
  142     <span class="nt">&quot;url&quot;</span><span class="p">:</span> <span class="s2">&quot;https://www.phpmyadmin.net/&quot;</span><span class="p">,</span>
  143     <span class="nt">&quot;supports&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;4.8&quot;</span><span class="p">]</span>
  144 <span class="p">}</span>
  145 </pre></div>
  146 </div>
  147 </div>
  148 <div class="section" id="sharing-images">
  149 <h3>Sharing images<a class="headerlink" href="#sharing-images" title="Permalink to this headline"></a></h3>
  150 <p>If you do not want to use your own symbols and buttons, remove the
  151 directory &#8220;img&#8221; in &#8220;your_theme_name&#8221;. phpMyAdmin will use the
  152 default icons and buttons (from the system-theme <code class="docutils literal"><span class="pre">pmahomme</span></code>).</p>
  153 </div>
  154 </div>
  155 </div>
  156 
  157 
  158           </div>
  159         </div>
  160       </div>
  161       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  162         <div class="sphinxsidebarwrapper">
  163   <h3><a href="index.html">Table Of Contents</a></h3>
  164   <ul>
  165 <li><a class="reference internal" href="#">Custom Themes</a><ul>
  166 <li><a class="reference internal" href="#configuration">Configuration</a></li>
  167 <li><a class="reference internal" href="#creating-custom-theme">Creating custom theme</a><ul>
  168 <li><a class="reference internal" href="#theme-metadata">Theme metadata</a></li>
  169 <li><a class="reference internal" href="#sharing-images">Sharing images</a></li>
  170 </ul>
  171 </li>
  172 </ul>
  173 </li>
  174 </ul>
  175 
  176   <h4>Previous topic</h4>
  177   <p class="topless"><a href="import_export.html"
  178                         title="previous chapter">Import and export</a></p>
  179   <h4>Next topic</h4>
  180   <p class="topless"><a href="other.html"
  181                         title="next chapter">Other sources of information</a></p>
  182   <div role="note" aria-label="source link">
  183     <h3>This Page</h3>
  184     <ul class="this-page-menu">
  185       <li><a href="_sources/themes.txt"
  186             rel="nofollow">Show Source</a></li>
  187     </ul>
  188    </div>
  189 <div id="searchbox" style="display: none" role="search">
  190   <h3>Quick search</h3>
  191     <form class="search" action="search.html" method="get">
  192       <div><input type="text" name="q" /></div>
  193       <div><input type="submit" value="Go" /></div>
  194       <input type="hidden" name="check_keywords" value="yes" />
  195       <input type="hidden" name="area" value="default" />
  196     </form>
  197 </div>
  198 <script type="text/javascript">$('#searchbox').show(0);</script>
  199         </div>
  200       </div>
  201       <div class="clearer"></div>
  202     </div>
  203     <div class="related" role="navigation" aria-label="related navigation">
  204       <h3>Navigation</h3>
  205       <ul>
  206         <li class="right" style="margin-right: 10px">
  207           <a href="genindex.html" title="General Index"
  208              >index</a></li>
  209         <li class="right" >
  210           <a href="other.html" title="Other sources of information"
  211              >next</a> |</li>
  212         <li class="right" >
  213           <a href="import_export.html" title="Import and export"
  214              >previous</a> |</li>
  215         <li class="nav-item nav-item-0"><a href="index.html">phpMyAdmin 5.0.1 documentation</a> &#187;</li>
  216           <li class="nav-item nav-item-1"><a href="user.html" >User Guide</a> &#187;</li> 
  217       </ul>
  218     </div>
  219     <div class="footer" role="contentinfo">
  220         &#169; <a href="copyright.html">Copyright</a> 2012 - 2018, The phpMyAdmin devel team.
  221       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.9.
  222     </div>
  223   </body>
  224 </html>