Fixing a few things found whilst setting up demo
[PHPCredLocker.git] / plugins / Blargle / ExternalResources / README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
<h2>Contents</h2>
 
<ul>
  <li><a href="#about">About ExternalResources</a></li>
  <li><a href="#plgConfig">Plugin Configuration</a>
  <li><a href="#SupResources">Supported Resources</a>
</ul>
 
 
<h3><a name="about">About ExternalResources</a></h3>
ExternalResources Plugin is a plugin allowing system admins to store the contents of the resources folder on another server (allowing for faster download)..
<br />
<br />
 
 
 
 
<h3><a name="plgConfig">Plugin Configuration</a></h3>
 
The configuration file contains two key options<br />
 
<ul>
  <li><b><i>active</i></b> - Is the plugin enabled?</li>
  <li><b><i>url</i></b> - The main resources path to use, this allows all files (except info.php) to be automatically redirected to another URL. Each file's path will be appended onto the end</li>
</ul>
<br />
<h4>Additional configuration</h4>
 
It's also possible to override on a per-resource basis:
 
To load JQuery from googlecode, set the following.
 
<pre>$this->js->jquery->url = 'https://ajax.googleapis.com/ajax/libs/jquery/1.8.2/jquery.min.js';</pre>
 
Essentially, the url parameter overrides all other settings (except <i>disabled</i>). You can set any of the following
 
<ul>
<li><b>url</b> - A full url to the resource. Takes precedence over all other settings</li>
<li><b>path</b> - Any directories within the resources dir (for example, bootstrap CSS is bootstrap/css/)</li>
<li><b>fname</b> - The filename to load (.js will be appended automatically)</li>
<li><b>forcemin</b> - Force use of minimal code, takes one of three options - false, ".min","". The first disables the setting, the second forces the fname to be followed by .min and the final ensures that .min will never be added, regardless of the main system config</li>
 
</ul>
 
 
 
<h3><a name="SupResources">Supported Resources</a></h3>
<p>Resources must be specified by internal name, the following are used in PHPCredLocker</p>
<ul>
        <li><em>css-&gt;bootstrap</em></li>
        <li><em>css-&gt;bootstrapresponsive</em></li>
        <li><em>css-&gt;jquerytooltip</em></li>
        <li><em>js-&gt;jquery</em></li>
        <li><em>js-&gt;bootstrap</em></li>
        <li><em>js-&gt;jquerytooltip</em></li>
        <li><em>js-&gt;main</em></li>
        <li><em>js-&gt;base64</em></li>
</ul>
<p>Each can be overriden in the plugin config in the manner specified above</p>