Scripts Class - Revision history

LWC: /* Setting a JavaScript Library */ Fixed line

2013-04-21T13:58:14Z

‎Setting a JavaScript Library: Fixed line

Tom: /* Introduction */

2011-04-10T17:44:00Z

‎Introduction

Tom: /* Setting a CSS File */

2011-04-10T17:43:33Z

‎Setting a CSS File

Tom: /* Setting a JavaScript Library */

2011-04-10T17:43:15Z

‎Setting a JavaScript Library

Tom at 18:04, 1 April 2011

2011-04-01T18:04:04Z

Tom at 15:59, 1 April 2011

2011-04-01T15:59:40Z

Tom: /* Setting JavaScript */

2011-04-01T15:31:12Z

‎Setting JavaScript

Tom: /* Setting JavaScript */

2011-04-01T15:30:51Z

‎Setting JavaScript

Tom: /* Setting JavaScript */

2011-04-01T15:26:42Z

‎Setting JavaScript

Tom: /* Introduction */

2011-04-01T15:22:48Z

‎Introduction

@@ Line 65: / Line 65: @@
 <pre>global $_SCRIPTS;
-$_SCRIPTS->setJavaScriptLibrary('jquery.effects.highligh');</pre>
+$_SCRIPTS->setJavaScriptLibrary('jquery.ui.effects-highlight');</pre>
 When loading an effect or widget you do not need to load the jQuery library first. When loading an effect or widget all the required files will be automatically set to load.

@@ Line 3: / Line 3: @@
 As of version 1.8.0, Geeklog introduced the Scripts class. The Scripts Class has been designed to allow themes and plugins to easily add JavaScript, JavaScript files and CSS files to the header and/or footer of a page. It also allows plugins and themes to enable the use of jQuery and the jQuery UI plugin. By default Geeklog will place all JavaScript in the footer unless told otherwise.
-In previous versions of Geeklog, JavaScript and the CSS files were handled solely by the plugin usually by including the functions plugin_getheadercode_xxxx or plugin_getfootercode_xxxx.
+In previous versions of Geeklog, JavaScript and the CSS files were handled solely by the plugin usually by including the functions plugin_getheadercode_foo or plugin_getfootercode_foo.
 The advantages of using the Scripts class over having a plugin or theme manage things are many. You have easy access to jQuery and the jQuery UI plugin, no more inline scripting, and you can setup things to have files only load when needed. Plus, in the future it will automatically support caching and compression of the CSS and JavaScript files.
 == Usage ==

@@ Line 28: / Line 28: @@
 $_SCRIPTS->setCSSFile('polls', '/polls/style.css', false);</pre>
-As stated before this needs to be done before you run the function COM_SiteHeader or in your plugins plugin_getheadercode_xxxx function. If your plugin has a block or uses Autotags that need the CSS file then you should always make sure it is included since Geeklog has no way of knowing if a block or Autotag will be displayed before the header is written.
+As stated before this needs to be done before you run the function COM_SiteHeader or in your plugins plugin_getheadercode_foo function. If your plugin has a block or uses Autotags that need the CSS file then you should always make sure it is included since Geeklog has no way of knowing if a block or Autotag will be displayed before the header is written.
 === Setting JavaScript ===

← Older revision		Revision as of 17:43, 10 April 2011
Line 71:		Line 71:

	If a jQuery file is missing then the Google CDN-hosted copy will be substituted. There is also an option in the Geeklog Configuration under the Site tab to always use a CDN-hosted version of jQuery.		If a jQuery file is missing then the Google CDN-hosted copy will be substituted. There is also an option in the Geeklog Configuration under the Site tab to always use a CDN-hosted version of jQuery.
		+
		+	When loading one of the widgets or effects for jQuery UI you need to make sure to set it before COM_SiteHeader is executed or in your plugins plugin_getheadercode_foo function. The reason for this is the css files are set in COM_SiteHeader and we need to make sure that the CSS files for the UI plugin get set.

@@ Line 3: / Line 3: @@
 As of version 1.8.0, Geeklog introduced the Scripts class. The Scripts Class has been designed to allow themes and plugins to easily add JavaScript, JavaScript files and CSS files to the header and/or footer of a page. It also allows plugins and themes to enable the use of jQuery and the jQuery UI plugin. By default Geeklog will place all JavaScript in the footer unless told otherwise.
-In previous versions of Geeklog, JavaScript and the CSS files where handled solely by the plugin usually by including the functions plugin_getheadercode_xxxx or plugin_getfootercode_xxxx.
+In previous versions of Geeklog, JavaScript and the CSS files were handled solely by the plugin usually by including the functions plugin_getheadercode_xxxx or plugin_getfootercode_xxxx.
 The advantages of using the Scripts class over having a plugin or theme manage things are many. You have easy access to jQuery and the jQuery UI plugin, no more inline scripting, and you can setup things to have files only load when needed. Plus, in the future it will automatically support caching and compression of the CSS and JavaScript files.
 == Usage ==
@@ Line 12: / Line 13: @@
 All JavaScript in the footer will also have access to the GeeklogConfig object. This object contains commonly used attributes taken right from Geeklogs configuration array ($_CONF) and uses the same keys.
 === Setting a CSS File ===
@@ Line 29: / Line 29: @@
 As stated before this needs to be done before you run the function COM_SiteHeader or in your plugins plugin_getheadercode_xxxx function. If your plugin has a block or uses Autotags that need the CSS file then you should always make sure it is included since Geeklog has no way of knowing if a block or Autotag will be displayed before the header is written.
 === Setting JavaScript ===
@@ Line 40: / Line 39: @@
 $_SCRIPTS->setJavaScript($js, true);</pre>
-This will automatically wrap the code in the html script tag. If you do not want this to happen just remove the "true" from the function call. There are several other attributes to this function that you may need to use from time to time (i.e. specifying the JavaScript to appear in the header and if it is constant). For more information on these take a look at the Scripts class found in the "/system/classes/" directory of your Geeklog install.
+This will automatically wrap the code in the html script tag. If you want to include your own script tag then just remove the "true" from the function call. There are several other attributes to this function that you may need to use from time to time (i.e. specifying the JavaScript to appear in the header and if it is constant). For more information on these take a look at the Scripts class found in the "/system/classes/" directory of your Geeklog install.
 === Setting a JavaScript File ===
-To set JavaScript file for your plugin or theme you would do the following:
+To set a JavaScript file for your plugin or theme you would do the following:
 <pre>global $_SCRIPTS;
@@ Line 50: / Line 49: @@
 $_SCRIPTS->setJavaScriptFile('pluginname', '/pluginname/javascript/yourfile.js');</pre>
-The first attribute of the function is the internal name of the file. Make sure this is unique as you can overwrite previous entries. To standardize this, the name should be your plugin name. If you have more than one JavaScript file then you could use a name like "pluginname.subname". The second attribute of the function is obviously the location and file name of your JavaScript file. The backslash needs to be included at the beginning of this.
+The first attribute of the function is the internal name of the file. Make sure this is unique as you can overwrite previous entries. To standardize this, the name should be your plugin name (for themes use "theme.themename"). If you have more than one JavaScript file then you could use a name like "pluginname.subname". The second attribute of the function is obviously the location and file name of your JavaScript file. The backslash needs to be included at the beginning of this and you only include the part of the path after the public_html directory.
 === Setting a JavaScript Library ===

← Older revision		Revision as of 15:59, 1 April 2011
Line 44:		Line 44:
	=== Setting a JavaScript File ===		=== Setting a JavaScript File ===

		+	To set JavaScript file for your plugin or theme you would do the following:

		+	<pre>global $_SCRIPTS;
		+
		+	$_SCRIPTS->setJavaScriptFile('pluginname', '/pluginname/javascript/yourfile.js');</pre>
		+
		+	The first attribute of the function is the internal name of the file. Make sure this is unique as you can overwrite previous entries. To standardize this, the name should be your plugin name. If you have more than one JavaScript file then you could use a name like "pluginname.subname". The second attribute of the function is obviously the location and file name of your JavaScript file. The backslash needs to be included at the beginning of this.

	=== Setting a JavaScript Library ===		=== Setting a JavaScript Library ===

← Older revision		Revision as of 15:26, 1 April 2011
Line 40:		Line 40:
	$_SCRIPTS->setJavaScript($js, true);</pre>		$_SCRIPTS->setJavaScript($js, true);</pre>

		+	This will automatically wrap the code in the html script tag. If you do not want this to happen just remove the "true" from the function call.

	=== Setting a JavaScript File ===		=== Setting a JavaScript File ===