Documentation Wiki

glfusion:development:codingstandards - eliminated redundancy of headers

Geiss — Sun, 04 Jan 2009 23:48:13 -0600

1231134493		current
Line 1:		Line 1:
	====== glFusion Coding Standards ======		====== glFusion Coding Standards ======

-	All new code in glFusion will have to follow the following coding standards. The following is about the actual source code formatting, i.e. how to place braces and what and how much whitespace to use.	+	All new code in glFusion will have to follow the following coding standards. The following is about the actual source code formatting, i.e. how to place braces and what and how much whitespace to use, etc.

	===== Coding Guidelines =====		===== Coding Guidelines =====

glfusion:start - enhanced the intro to glFusion

Geiss — Sun, 04 Jan 2009 23:32:33 -0600

1231050365		current
Line 2:		Line 2:
	====== glFusion - Synergy, Stability, & Style ======		====== glFusion - Synergy, Stability, & Style ======

-	glFusion is very well organized and provides an extremely powerful system that is very easy to use. glFusion powers all types of sites from personal blogs to high volume community discussion sites and almost everything in between. glFusion is well suited for both public and private sites. Using the flexible security model, it is possible to protect content from the general public and only allow specific users or groups access to certain content or features. glFusion is an extremely extensible and flexible system.	+	glFusion is an extremely powerful system for creating online content. It powers all types of sites from personal blogs to high volume community discussion sites, intranets, and almost everything in between. It is well suited for both public and private sites. By using the flexible security model, it is possible to protect content from the general public and only allow specific users or groups access to certain content or features. Because of this, glFusion is an extremely extensible and flexible system, with many potential uses.
		+
		+	What makes glFusion different from the vast array of CMS or blog platforms available? The answer is integration. Rather than develop a small core system, and allow others to create plugins, glFusion gives you a majority of the tools you might need, in a single robust package, and allows you to simply de-activate the parts that you don't need. The primary benefit of this development approach is a tight integration between different parts of the system, without having to hunt down 3rd party plugins, make sure they're compatible, going through compatibility pains when one component releases an upgrade, but the other side of the system doesn't and it breaks, etc. We figure you already have enough stress in your life, why should you have more! Welcome to glFusion, where you can have synergy, stability, and style!
	===== Style Guidelines =====		===== Style Guidelines =====
	At certain intervals, the contents of this living wiki are compiled and [[http://www.glfusion.org/filemgmt/index.php?id=220\|published]] in .pdf manual form. To help facilitate this process, please use the following style guidelines when formatting new pages, sections, and sub-sections of content:		At certain intervals, the contents of this living wiki are compiled and [[http://www.glfusion.org/filemgmt/index.php?id=220\|published]] in .pdf manual form. To help facilitate this process, please use the following style guidelines when formatting new pages, sections, and sub-sections of content:

glfusion:development - aligned manual with wiki as far as order is concerned to save Kim from ...

Geiss — Sun, 04 Jan 2009 19:08:36 -0600

1231113799		current
Line 2:		Line 2:

	^glFusion Developer Guide TOC ^^^^		^glFusion Developer Guide TOC ^^^^
-	\|[[glfusion:source\|{{ :glfusion:code.png \|}}]]\|[[glfusion:source\|glFusion Source Code ]] \\ How to access glFusion source code repositories. \|[[glfusion:development:pluginapi\|{{ :glfusion:plugindev.png \|}}]]\|[[glfusion:development:pluginapi\|Create your own plugins]] \\ How to make glFusion plugins. \|	+	\|[[glfusion:source\|{{ :glfusion:code.png \|}}]]\|[[glfusion:source\|glFusion Source Code ]] \\ How to access glFusion source code repositories. \|[[glfusion:development:custom\|{{ :glfusion:disksfilesystems.png \|}}]]\|[[glfusion:development:custom\|Using Lib-custom.php]] \\ How to use lib-custom for minor customization of glFusion. \|
-	\|[[glfusion:development:codingstandards\|{{ :glfusion:code.png \|}}]]\|[[glfusion:development:codingstandards\|glFusion Coding Standards ]] \\ How your code should look and where it should go. \|[[glfusion:development:custom\|{{ :glfusion:disksfilesystems.png \|}}]]\|[[glfusion:development:custom\|Using Lib-custom.php]] \\ How to use lib-custom for minor customization of glFusion. \|	+	\|[[glfusion:development:codingstandards\|{{ :glfusion:code.png \|}}]]\|[[glfusion:development:codingstandards\|glFusion Coding Standards ]] \\ How your code should look and where it should go. \|[[glfusion:development:dbabstraction\|{{ :glfusion:disksfilesystems.png \|}}]]\|[[glfusion:development:dbabstraction\|Database Abstraction Layer]] \\ How to work with the glFusion database abstraction layer. \|
-	\|[[glfusion:development:api:start\|{{ :glfusion:code.png \|}}]]\|[[glfusion:development:api:start\|glFusion Development APIs ]] \\ glFusion Development API Documentation. \|[[glfusion:development:dbabstraction\|{{ :glfusion:disksfilesystems.png \|}}]]\|[[glfusion:development:dbabstraction\|Database Abstraction Layer]] \\ How to work with the glFusion database abstraction layer. \|	+	\|[[glfusion:development:pluginapi\|{{ :glfusion:plugindev.png \|}}]]\|[[glfusion:development:pluginapi\|Create your own plugins]] \\ How to make glFusion plugins. \|[[glfusion:development:configsystem\|{{ :glfusion:configuration2.png \|}}]]\|[[glfusion:development:configsystem\|The Configuration System]] \\ Saving and retrieving config settings in glFusion. \|
-	\|[[glfusion:development:3rdpartytools\|{{ :glfusion:config2.png \|}}]]\|[[glfusion:development:3rdpartytools\|Third Party Development Tools ]] \\ Third party tools for developing glFusion. \|[[glfusion:development:configsystem\|{{ :glfusion:configuration2.png \|}}]]\|[[glfusion:development:configsystem\|The Configuration System]] \\ Saving and retrieving config settings in glFusion. \|	+	\|[[glfusion:development:3rdpartytools\|{{ :glfusion:config2.png \|}}]]\|[[glfusion:development:3rdpartytools\|Third Party Development Tools ]] \\ Third party tools for developing glFusion. \|[[glfusion:development:languagefiles\|{{ :glfusion:babelfish2.png \|}}]]\|[[glfusion:development:languagefiles\|Using Language Files and Translations]] \\ Adding languages and language support to glFusion and plugins. \|
-	\|[[glfusion:development:usingtemplates\|{{ :glfusion:template3.png \|}}]]\|[[glfusion:development:usingtemplates\|Using the Template System (CTL) ]] \\ Working with the Caching Template Library in glFusion. \|[[glfusion:development:languagefiles\|{{ :glfusion:babelfish2.png \|}}]]\|[[glfusion:development:languagefiles\|Using Language Files and Translations]] \\ Adding languages and language support to glFusion and plugins. \|	+	\|[[glfusion:development:usingtemplates\|{{ :glfusion:template3.png \|}}]]\|[[glfusion:development:usingtemplates\|Using the Template System (CTL) ]] \\ Working with the Caching Template Library in glFusion. \|[[glfusion:development:api:start\|{{ :glfusion:code.png \|}}]]\|[[glfusion:development:api:start\|glFusion Development APIs ]] \\ glFusion Development API Documentation. \|

glfusion:upgrade-tip-sheet - this page moved into the documentation proper

Geiss — Sun, 04 Jan 2009 16:09:07 -0600

1231090154		current
Line 1:		Line 1:
-	====== glFusion v1.1.0 Upgrade Tip Sheet ======	+	This information has been moved [[glfusion:install#glfusion_v1.1.0_upgrade_tip_sheet\|here]].
-		+
-	glFusion v1.1.0 brings several enhancements that also required some major modifications to the core code and how themes are handled. As a result of these modifications, we want to ensure you are fully aware of the changes and how they may affect your site.	+
-		+
-	<note important>	+
-	You should always make a database backup before attempting a major upgrade to your site. If you are unsure how to make a database backup, please contact your hosting provider or post in the [[http://www.glfusion.org/forum/index.php?forum=28\|glFusion Support Forum]] for assistance.	+
-	</note>	+
-		+
-	===== Themes =====	+
-		+
-	glFusion and the Nouveau theme are very tightly coupled. This does not mean you cannot use other themes with glFusion, but you may not be able to take full advantage of all the new glFusion features. If you are using an older, table based theme with your glFusion site, be sure to read and understand the required theme modificaitons you will need to make after your upgrade. See [[glfusion:template_changes\|Template Modification in glFusion v1.1.0]].	+
-		+
-	If you use the Chameleon theme / plugin, the glFusion team has released an update that is compatible with glFusion v1.1.0 You should upgrade to [[http://www.glfusion.org/filemgmt/index.php?id=224\|Chameleon v2.1.0]] when you upgrade glFusion.	+
-	===== Customized Theme Files =====	+
-		+
-	glFusion supports the ability for you to create custom versions of the template files and store them in their respective custom/ directories so they will survive the upgrade process. If you have customized the htmlheader.thtml template file, be sure to upgrade your customized version for glFusion v1.1.0. See the htmlheader.thtml file that ships with glFusion and make the necessary changes in your customized version.	+
-		+
-	===== Search Integration =====	+
-		+
-	glFusion ships with a very rich set of plugins which have all been upgraded to support the new search integration available in glFusion v1.1.0. We have also updated the [[http://www.glfusion.org/filemgmt/index.php?id=222\|DokuWiki Integration plugin]] to support the new search integration. If there are other plugins that you use that have not been updated to support the new search integration, please post in the [[http://www.glfusion.org/forum/index.php?forum=28\|glFusion Support Forum]] and we'll see about upgrading the plugin for better integration with glFusion v1.1.0.	+
-	===== File System Reorganization =====	+
-		+
-	glFusion v1.1.0 has moved several files out of the public_html/ directory and into the private/ directory. To assist with removing the older copies after the upgrade, we've included a new utility called FileCheck. Please see the [[glfusion:filecheck\|glFusion Directory Organization]] wiki page for full details.	+
-		+
-	===== Widgets =====	+
-		+
-	glFusion v1.1.0 supports several very cool JavaScript widgets. If you are upgrading, you will not have the default widget examples loaded (we feel making content changes during an upgrade is not a very good idea). To access the code used in the widgets, you can visit the [[http://demo.glfusion.org\|glFusion demo site]] and login as admin and copy the widget code from the staticpage editor.	+
-		+
-	For full details of the new widgets and how to use them, see the [[glfusion:widgets\|glFusion Widgets]] wiki page.	+

glfusion:install - added upgrade tip sheet

Geiss — Sun, 04 Jan 2009 16:06:34 -0600

1226090873		current
Line 308:		Line 308:
	If some of these plugins were not previously installed prior to the upgrade, they were not installed during the upgrade. The files are on your system and are ready to be installed, but you will need to go into the Plugin Editor to manually install them.		If some of these plugins were not previously installed prior to the upgrade, they were not installed during the upgrade. The files are on your system and are ready to be installed, but you will need to go into the Plugin Editor to manually install them.

		+	====== glFusion v1.1.0 Upgrade Tip Sheet ======

		+	glFusion v1.1.0 brings several enhancements that also required some major modifications to the core code and how themes are handled. As a result of these modifications, we want to ensure you are fully aware of the changes and how they may affect your site.
		+
		+	<note important>
		+	You should always make a database backup before attempting a major upgrade to your site. If you are unsure how to make a database backup, please contact your hosting provider or post in the [[http://www.glfusion.org/forum/index.php?forum=28\|glFusion Support Forum]] for assistance.
		+	</note>
		+
		+	===== Themes =====
		+
		+	glFusion and the Nouveau theme are very tightly coupled. This does not mean you cannot use other themes with glFusion, but you may not be able to take full advantage of all the new glFusion features. If you are using an older, table based theme with your glFusion site, be sure to read and understand the required theme modificaitons you will need to make after your upgrade. See [[glfusion:template_changes\|Template Modification in glFusion v1.1.0]].
		+
		+	If you use the Chameleon theme / plugin, the glFusion team has released an update that is compatible with glFusion v1.1.0 You should upgrade to [[http://www.glfusion.org/filemgmt/index.php?id=224\|Chameleon v2.1.0]] when you upgrade glFusion.
		+	===== Customized Theme Files =====
		+
		+	glFusion supports the ability for you to create custom versions of the template files and store them in their respective custom/ directories so they will survive the upgrade process. If you have customized the htmlheader.thtml template file, be sure to upgrade your customized version for glFusion v1.1.0. See the htmlheader.thtml file that ships with glFusion and make the necessary changes in your customized version.
		+
		+	===== Search Integration =====
		+
		+	glFusion ships with a very rich set of plugins which have all been upgraded to support the new search integration available in glFusion v1.1.0. We have also updated the [[http://www.glfusion.org/filemgmt/index.php?id=222\|DokuWiki Integration plugin]] to support the new search integration. If there are other plugins that you use that have not been updated to support the new search integration, please post in the [[http://www.glfusion.org/forum/index.php?forum=28\|glFusion Support Forum]] and we'll see about upgrading the plugin for better integration with glFusion v1.1.0.
		+	===== File System Reorganization =====
		+
		+	glFusion v1.1.0 has moved several files out of the public_html/ directory and into the private/ directory. To assist with removing the older copies after the upgrade, we've included a new utility called FileCheck. Please see the [[glfusion:filecheck\|glFusion Directory Organization]] wiki page for full details.
		+
		+	===== Widgets =====
		+
		+	glFusion v1.1.0 supports several very cool JavaScript widgets. If you are upgrading, you will not have the default widget examples loaded (we feel making content changes during an upgrade is not a very good idea). To access the code used in the widgets, you can visit the [[http://demo.glfusion.org\|glFusion demo site]] and login as admin and copy the widget code from the staticpage editor.
		+
		+	For full details of the new widgets and how to use them, see the [[glfusion:widgets\|glFusion Widgets]] wiki page.

glfusion:development:pluginapi:comment - geeklog to glFusion

Geiss — Sat, 03 Jan 2009 19:24:14 -0600

1231032406		current
Line 89:		Line 89:
	===== plugin_commentsupport_<plugin name> =====		===== plugin_commentsupport_<plugin name> =====

-	This function does not take any parameters but simply returns true if this plugin supports comments. This call is made in glFusiom code (example: article.php) to determine if it should redirect handling to the plugin.	+	This function does not take any parameters but simply returns true if this plugin supports comments. This call is made in glFusion code (example: article.php) to determine if it should redirect handling to the plugin.

	==== Arguments ====		==== Arguments ====

glfusion:development:pluginapi:admin

Geiss — Sat, 03 Jan 2009 19:17:11 -0600

1231031717		current
Line 77:		Line 77:
	===== Introduction =====		===== Introduction =====

-	Traditionally glfusions plugins were configured through configuration files (config.php), which are PHP scripts that define a global array holding all the plugin configuration settings: $_CONF for glFusion's core configuration, $_SP_CONF for the configuration of the Static Pages plugin, and so on.	+	Traditionally glFusion plugins were configured through configuration files (config.php), which are PHP scripts that define a global array holding all the plugin configuration settings: $_CONF for glFusion's core configuration, $_SP_CONF for the configuration of the Static Pages plugin, and so on.

	While these files are easy to maintain and use for developers, they often caused issues for users, typically		While these files are easy to maintain and use for developers, they often caused issues for users, typically

glfusion:overview

Geiss — Sat, 03 Jan 2009 18:38:54 -0600

1231029290		current
Line 54:		Line 54:
	* Jeff Hare		* Jeff Hare
	* Mark Howard		* Mark Howard
		+	* Eric Kingsley
	* Joe Mucchiello		* Joe Mucchiello
	* Eric Warren		* Eric Warren

glfusion:development:api:css_php:themename_themejs

Mark — Sat, 03 Jan 2009 17:25:41 -0600

1230736086		current
Line 26:		Line 26:

	$js = array();		$js = array();
-	$js[] = $_CONF['path_html'] .'javascript/mootools/gl_moochronometer.js';	+	$js[] = $_CONF['path_html']
		+	.'javascript/mootools/gl_moochronometer.js';
	$js[] = $_CONF['path_layout'] .'js/gltips.js';		$js[] = $_CONF['path_layout'] .'js/gltips.js';

glfusion:development:api:css_php:start

Mark — Sat, 03 Jan 2009 17:25:21 -0600

1230736592		current
Line 8:		Line 8:
	<code>		<code>
	<!-- Load Stylesheets -->		<!-- Load Stylesheets -->
-	<link rel="stylesheet" type="text/css" href="{site_url}/css.php?i={cacheid}" title="{theme}"{xhtml}>	+	<link rel="stylesheet" type="text/css"
		+	href="{site_url}/css.php?i={cacheid}" title="{theme}"{xhtml}>

	<!-- Load JavaScript -->		<!-- Load JavaScript -->

glfusion:development:api:sanitize_class:setargnames

Mark — Sat, 03 Jan 2009 17:24:28 -0600

1230674292		current
Line 1:		Line 1:
	~~NOTOC~~		~~NOTOC~~
	====== sanitize::setArgNames ======		====== sanitize::setArgNames ======
-	(glFusion v1.2.0)	+	(glFusion SVN)

	setArgNames – Assigns logical names to query string variables		setArgNames – Assigns logical names to query string variables
Line 32:		Line 32:
	===== Example =====		===== Example =====
	<code>		<code>
-	If URL rewrite is enabled, the URL to an article would look like this:	+	If URL rewrite is enabled, the URL to an article would look
		+	like this:

	http://www.somesite.com/article.php/2008123323233		http://www.somesite.com/article.php/2008123323233
Line 40:		Line 41:
	$inputHandler->setArgNames (array ('story', 'mode'));		$inputHandler->setArgNames (array ('story', 'mode'));

-	Which assigns the first parameter after article.php to story and the second parameter	+	Which assigns the first parameter after article.php to story
-	to mode.	+	and the second parameter to mode.

	To retrieve the value of $_GET['story'] use:		To retrieve the value of $_GET['story'] use:

glfusion:development:api:sanitize_class:filtervar

Mark — Sat, 03 Jan 2009 17:23:34 -0600

1230674250		current
Line 1:		Line 1:
	~~NOTOC~~		~~NOTOC~~
	====== sanitize::filterVar ======		====== sanitize::filterVar ======
-	(glFusion v1.2.0)	+	(glFusion SVN)

	filterVar – Filters and returns a variable.		filterVar – Filters and returns a variable.
Line 52:		Line 52:

	//mode//		//mode//
-	Type of data; post, get, request, env, cookie. Must specify in order of precedence.	+	Type of data; post, get, request, env, cookie. Must specify in
-	This can be an array i.e.; array('get','post') would check $_GET first, if not	+	order of precedence. This can be an array i.e.; array('get','post')
-	found then it would check $_POST.	+	would check $_GET first, if not found then it would check $_POST.

	//default//		//default//

glfusion:development:api:sanitize_class:buttoncheck

Mark — Sat, 03 Jan 2009 17:22:54 -0600

1230674236		current
Line 1:		Line 1:
	~~NOTOC~~		~~NOTOC~~
	====== sanitize::buttonCheck ======		====== sanitize::buttonCheck ======
-	(glFusion v1.2.0)	+	(glFusion SVN)

	buttonCheck - Find which button was pressed on form.		buttonCheck - Find which button was pressed on form.
Line 49:		Line 49:

	Instead of doing this:		Instead of doing this:
-	<input type="submit" value="{lang_save}" name="mode">	+	<input type="submit" value="{lang_save}" name="mode">
-	<input type="submit" value="{lang_cancel}" name="mode">	+	<input type="submit" value="{lang_cancel}" name="mode">

	and checking		and checking
-	if ($_POST['mode'] == $LANG_ADMIN['save']) ...	+	if ($_POST['mode'] == $LANG_ADMIN['save']) ...

	Do this:		Do this:
-	<input type="submit" value="{lang_save}" name="save">	+	<input type="submit" value="{lang_save}" name="save">
-	<input type="submit" value="{lang_cancel}" name="cancel">	+	<input type="submit" value="{lang_cancel}" name="cancel">

	and check this way:		and check this way:
-	$mode = $inputHandler->buttonCheck(array('save','cancel'), $_POST, '');	+	$mode = $inputHandler->buttonCheck(array('save','cancel'), $_POST, '');
-	if ($mode == 'save') ...	+	if ($mode == 'save') ...

	</code>		</code>

glfusion:development:api:sanitize_class:getvar

Mark — Sat, 03 Jan 2009 17:22:11 -0600

1231022044		current
Line 1:		Line 1:
	~~NOTOC~~		~~NOTOC~~
	====== sanitize::getVar ======		====== sanitize::getVar ======
-	(glFusion v1.2.0)	+	(glFusion SVN)

	getVar – Retrieves a $_POST, $_GET, $_REQUEST, $_ENV, or $_COOKIE variable.		getVar – Retrieves a $_POST, $_GET, $_REQUEST, $_ENV, or $_COOKIE variable.
Line 50:		Line 50:

	//mode//		//mode//
-	Type of data; post, get, request, env, cookie. Must specify in order of precedence.	+	Type of data; post, get, request, env, cookie. Must specify in
-	This can be an array i.e.; array('get','post') would check $_GET first, if not	+	order of precedence. This can be an array i.e.; array('get',
-	found then it would check $_POST.	+	'post') would check $_GET first, if not found then it would
		+	check $_POST.

	//default//		//default//

glfusion:development:api:output_class:displayaccesserror

Mark — Sat, 03 Jan 2009 17:20:31 -0600

1230696060		current
Line 1:		Line 1:
	~~NOTOC~~		~~NOTOC~~
	====== outputHandler::displayAccessError ======		====== outputHandler::displayAccessError ======
-	(glFusion v1.2.0)	+	(glFusion SVN)

	displayAccessError – Displays the Permission Denied Message		displayAccessError – Displays the Permission Denied Message
Line 44:		Line 44:

	<code>		<code>
-	$pageHandle->displayAccessError('Access Denied','You do not have permission to be here',	+	$pageHandle->displayAccessError('Access Denied',
-	'a restricted area');	+	'You do not have permission to be here',
		+	'a restricted area');

-	This function will display the You do not have permission to be here message to the	+	This function will display the "You do not have permission to be
-	user and log the following message in the access.log file:	+	here" message to the user and log the following message in the
		+	access.log file:

	User USERNAME tried to illegally access a restricted area		User USERNAME tried to illegally access a restricted area

glfusion:development:api:output_class:setshownavigationblocks

Mark — Sat, 03 Jan 2009 17:19:23 -0600

1230695446		current
Line 1:		Line 1:
	~~NOTOC~~		~~NOTOC~~
	====== outputHandler::setShowNavigationBlocks ======		====== outputHandler::setShowNavigationBlocks ======
-	(glFusion v1.2.0)	+	(glFusion SVN)

	setShowNavigationBlocks – Turns on / off the display of the left navigation blocks		setShowNavigationBlocks – Turns on / off the display of the left navigation blocks
Line 19:		Line 19:

	//bool//		//bool//
-	true enables the display of the extra blocks \\ false disables the display	+	true enables the display of the extra blocks
		+	false disables the display

glfusion:development:api:output_class:setshowextrablocks

Mark — Sat, 03 Jan 2009 17:19:05 -0600

1230695392		current
Line 1:		Line 1:
	~~NOTOC~~		~~NOTOC~~
	====== outputHandler::setShowExtraBlocks ======		====== outputHandler::setShowExtraBlocks ======
-	(glFusion v1.2.0)	+	(glFusion SVN)

	setShowExtraBlocks – Turns on / off the display of the right navigation blocks		setShowExtraBlocks – Turns on / off the display of the right navigation blocks
Line 19:		Line 19:

	//bool//		//bool//
-	true enables the display of the extra blocks \\ false disables the display	+	true enables the display of the extra blocks
		+	false disables the display

glfusion:development:api:output_class:addmessagetext

Mark — Sat, 03 Jan 2009 17:18:43 -0600

1230674056		current
Line 1:		Line 1:
	~~NOTOC~~		~~NOTOC~~
	====== outputHandler::addMessageText ======		====== outputHandler::addMessageText ======
-	(glFusion v1.2.0)	+	(glFusion SVN)

	addMessageText – Add a message block to the top of a page		addMessageText – Add a message block to the top of a page
Line 38:		Line 38:
	$pageHandle->displayPage();		$pageHandle->displayPage();

-	This will display a page with a title of 'Example', the left navigation blocks,	+	This will display a page with a title of 'Example', the left
-	with a body showing the //System Message Box// at the top with the contents:	+	navigation blocks, with a body showing the System Message Box
		+	at the top with the contents:

	Display Message Here		Display Message Here

glfusion:development:api:output_class:addmessage

Mark — Sat, 03 Jan 2009 17:18:08 -0600

1231024674		current
Line 1:		Line 1:
	~~NOTOC~~		~~NOTOC~~
	====== outputHandler::addMessage ======		====== outputHandler::addMessage ======
-	(glFusion v1.2.0)	+	(glFusion SVN)

	addMessage – Add a message block to the top of a page		addMessage – Add a message block to the top of a page
Line 19:		Line 19:
	//msg//		//msg//

-	Message Number - The message number corresponds to a message in	+	Message Number - The message number corresponds to a message in
-	the language files. For core functions, the $MESSAGE array is	+	the language files. For core functions, the $MESSAGE array is
-	used. If the optional //plugin// parameter is passed, then	+	used. If the optional //plugin// parameter is passed, then
-	PLG_pluginname_MESSAGE## will be used from the plugin's language	+	PLG_pluginname_MESSAGE## will be used from the plugin's language
-	file.	+	file.

glfusion:development:api:output_class:addraw

Mark — Sat, 03 Jan 2009 17:16:13 -0600

1230673992		current
Line 1:		Line 1:
	~~NOTOC~~		~~NOTOC~~
	====== outputHandler::addRaw ======		====== outputHandler::addRaw ======
-	(glFusion v1.2.0)	+	(glFusion SVN)

	addRaw – Add a raw header		addRaw – Add a raw header
Line 30:		Line 30:
	* HEADER_PRIO_VERYLOW		* HEADER_PRIO_VERYLOW

-	Items with HEADER_PRIO_VERYHIGH are sent to the browser before those with HEADER_PRIO_HIGH…	+	Items with HEADER_PRIO_VERYHIGH are sent to the browser
		+	before those with HEADER_PRIO_HIGH…

	The default value is HEADER_PRIO_NORMAL.		The default value is HEADER_PRIO_NORMAL.

glfusion:development:api:output_class:addlinkscript

Mark — Sat, 03 Jan 2009 17:15:46 -0600

1231024531		current
Line 1:		Line 1:
	~~NOTOC~~		~~NOTOC~~
	====== outputHandler::addLinkScript ======		====== outputHandler::addLinkScript ======
-	(glFusion v1.2.0)	+	(glFusion SVN)

	addLinkScript – Add a javascript source to a page		addLinkScript – Add a javascript source to a page
Line 19:		Line 19:
	//href//		//href//

-	The URL to the javascript file.	+	The URL to the javascript file.

	//priority//		//priority//

glfusion:development:api:output_class:addlinkstyle

Mark — Sat, 03 Jan 2009 17:15:06 -0600

1230746156		current
Line 1:		Line 1:
	~~NOTOC~~		~~NOTOC~~
	====== outputHandler::addLinkStyle ======		====== outputHandler::addLinkStyle ======
-	(glFusion v1.2.0)	+	(glFusion SVN)

	addLinkStyle – Add a stylesheet to a page		addLinkStyle – Add a stylesheet to a page
Line 31:		Line 31:
	* HEADER_PRIO_VERYLOW		* HEADER_PRIO_VERYLOW

-	Items with HEADER_PRIO_VERYHIGH are sent to the browser before those with HEADER_PRIO_HIGH…	+	Items with HEADER_PRIO_VERYHIGH are sent to the browser
		+	before those with HEADER_PRIO_HIGH…

	The default value is HEADER_PRIO_NORMAL.		The default value is HEADER_PRIO_NORMAL.

	//mime//		//mime//
-	The mime type of the stylesheet, 'text/css' used if no other type passed.	+	The mime type of the stylesheet, 'text/css' used if no
		+	other type passed.

	//attrs//		//attrs//

glfusion:development:api:output_class:addlink

Mark — Sat, 03 Jan 2009 17:14:41 -0600

1231004150		current
Line 1:		Line 1:
	~~NOTOC~~		~~NOTOC~~
	====== outputHandler::addLink ======		====== outputHandler::addLink ======
-	(glFusion v1.2.0)	+	(glFusion SVN)


Line 39:		Line 39:
	* HEADER_PRIO_VERYLOW		* HEADER_PRIO_VERYLOW

-	Items with HEADER_PRIO_VERYHIGH are sent to the browser before those with HEADER_PRIO_HIGH…	+	Items with HEADER_PRIO_VERYHIGH are sent to the browser
		+	before those with HEADER_PRIO_HIGH…

	The default value is HEADER_PRIO_NORMAL.		The default value is HEADER_PRIO_NORMAL.

glfusion:development:api:output_class:addscript

Mark — Sat, 03 Jan 2009 17:14:17 -0600

1231024414		current
Line 2:		Line 2:
	====== outputHandler::addScript ======		====== outputHandler::addScript ======

-	(glFusion v1.2.0)	+	(glFusion SVN)

	addScript – Adds raw JavaScript to page header		addScript – Adds raw JavaScript to page header
Line 8:		Line 8:
	===== Description =====		===== Description =====

-	void addScript($code, $priority = HEADER_PRIO_NORMAL, $mime = 'text/javascript')	+	void addScript($code, $priority, $mime)

	Adds raw JavaScript to the page header. The JavaScript should not be wrapped in <script> tags.		Adds raw JavaScript to the page header. The JavaScript should not be wrapped in <script> tags.

glfusion:development:api:output_class:addstyle

Mark — Sat, 03 Jan 2009 17:12:57 -0600

1231004016		current
Line 1:		Line 1:
	~~NOTOC~~		~~NOTOC~~
	====== outputHandler::addStyle ======		====== outputHandler::addStyle ======
-	(glFusion v1.2.0)	+	(glFusion SVN)

	addStyle – Adds raw CSS to page header		addStyle – Adds raw CSS to page header
Line 19:		Line 19:

	//code//		//code//
-	The CSS code to be sent to the browser. This function will automatically wrap the CSS	+	The CSS code to be sent to the browser. This function will automatically
-	code with the necessary <style> </style> tags.	+	wrap the CSS code with the necessary <style> </style> tags.


Line 32:		Line 32:
	* HEADER_PRIO_VERYLOW		* HEADER_PRIO_VERYLOW

-	Items with HEADER_PRIO_VERYHIGH are sent to the browser before those with HEADER_PRIO_HIGH…	+	Items with HEADER_PRIO_VERYHIGH are sent to the browser before
		+	those with HEADER_PRIO_HIGH…

	The default value is HEADER_PRIO_NORMAL.		The default value is HEADER_PRIO_NORMAL.
Line 38:		Line 39:

	//mime//		//mime//
-	Mime type to use for the code. The default value is ‘text/css’	+	Mime type to use for the code.
		+	The default value is ‘text/css’

glfusion:source

Mark — Sat, 03 Jan 2009 11:54:46 -0600

1218808319		current
Line 18:		Line 18:


-	You can monitor the code changes by subscribing to the [[https://lists.sourceforge.net/lists/listinfo/glfusion-svn\|glFusion SVN mailing list]]. Each time code is checked into the source repository an email documenting the changes will be sent to the mailing list.	+	You can monitor the code changes by subscribing to the [[https://lists.sourceforge.net/lists/listinfo/glfusion-svn-announce\|glFusion SVN mailing list]]. Each time code is checked into the source repository an email documenting the changes will be sent to the mailing list.

1231113799		current
Line 2:		Line 2:

	^glFusion Developer Guide TOC ^^^^		^glFusion Developer Guide TOC ^^^^
-	\|[[glfusion:source\|{{ :glfusion:code.png \|}}]]\|[[glfusion:source\|glFusion Source Code ]] \\ How to access glFusion source code repositories. \|[[glfusion:development:pluginapi\|{{ :glfusion:plugindev.png \|}}]]\|[[glfusion:development:pluginapi\|Create your own plugins]] \\ How to make glFusion plugins. \|	+	\|[[glfusion:source\|{{ :glfusion:code.png \|}}]]\|[[glfusion:source\|glFusion Source Code ]] \\ How to access glFusion source code repositories. \|[[glfusion:development:custom\|{{ :glfusion:disksfilesystems.png \|}}]]\|[[glfusion:development:custom\|Using Lib-custom.php]] \\ How to use lib-custom for minor customization of glFusion. \|
-	\|[[glfusion:development:codingstandards\|{{ :glfusion:code.png \|}}]]\|[[glfusion:development:codingstandards\|glFusion Coding Standards ]] \\ How your code should look and where it should go. \|[[glfusion:development:custom\|{{ :glfusion:disksfilesystems.png \|}}]]\|[[glfusion:development:custom\|Using Lib-custom.php]] \\ How to use lib-custom for minor customization of glFusion. \|	+	\|[[glfusion:development:codingstandards\|{{ :glfusion:code.png \|}}]]\|[[glfusion:development:codingstandards\|glFusion Coding Standards ]] \\ How your code should look and where it should go. \|[[glfusion:development:dbabstraction\|{{ :glfusion:disksfilesystems.png \|}}]]\|[[glfusion:development:dbabstraction\|Database Abstraction Layer]] \\ How to work with the glFusion database abstraction layer. \|
-	\|[[glfusion:development:api:start\|{{ :glfusion:code.png \|}}]]\|[[glfusion:development:api:start\|glFusion Development APIs ]] \\ glFusion Development API Documentation. \|[[glfusion:development:dbabstraction\|{{ :glfusion:disksfilesystems.png \|}}]]\|[[glfusion:development:dbabstraction\|Database Abstraction Layer]] \\ How to work with the glFusion database abstraction layer. \|	+	\|[[glfusion:development:pluginapi\|{{ :glfusion:plugindev.png \|}}]]\|[[glfusion:development:pluginapi\|Create your own plugins]] \\ How to make glFusion plugins. \|[[glfusion:development:configsystem\|{{ :glfusion:configuration2.png \|}}]]\|[[glfusion:development:configsystem\|The Configuration System]] \\ Saving and retrieving config settings in glFusion. \|
-	\|[[glfusion:development:3rdpartytools\|{{ :glfusion:config2.png \|}}]]\|[[glfusion:development:3rdpartytools\|Third Party Development Tools ]] \\ Third party tools for developing glFusion. \|[[glfusion:development:configsystem\|{{ :glfusion:configuration2.png \|}}]]\|[[glfusion:development:configsystem\|The Configuration System]] \\ Saving and retrieving config settings in glFusion. \|	+	\|[[glfusion:development:3rdpartytools\|{{ :glfusion:config2.png \|}}]]\|[[glfusion:development:3rdpartytools\|Third Party Development Tools ]] \\ Third party tools for developing glFusion. \|[[glfusion:development:languagefiles\|{{ :glfusion:babelfish2.png \|}}]]\|[[glfusion:development:languagefiles\|Using Language Files and Translations]] \\ Adding languages and language support to glFusion and plugins. \|
-	\|[[glfusion:development:usingtemplates\|{{ :glfusion:template3.png \|}}]]\|[[glfusion:development:usingtemplates\|Using the Template System (CTL) ]] \\ Working with the Caching Template Library in glFusion. \|[[glfusion:development:languagefiles\|{{ :glfusion:babelfish2.png \|}}]]\|[[glfusion:development:languagefiles\|Using Language Files and Translations]] \\ Adding languages and language support to glFusion and plugins. \|	+	\|[[glfusion:development:usingtemplates\|{{ :glfusion:template3.png \|}}]]\|[[glfusion:development:usingtemplates\|Using the Template System (CTL) ]] \\ Working with the Caching Template Library in glFusion. \|[[glfusion:development:api:start\|{{ :glfusion:code.png \|}}]]\|[[glfusion:development:api:start\|glFusion Development APIs ]] \\ glFusion Development API Documentation. \|