Theme Developers Guide - Revision history

Tom: /* Theme API */

2015-12-27T14:56:35Z

‎Theme API

Tom: /* Testing a theme and further information */

2015-12-11T15:54:05Z

‎Testing a theme and further information

Tom: /* Theme Specific Plugin Templates */

2015-10-18T15:12:55Z

‎Theme Specific Plugin Templates

Tom: /* Theme Specific Plugin Templates */

2015-10-18T15:10:04Z

‎Theme Specific Plugin Templates

Tom: /* Theme Specific Plugin Templates */

2015-10-18T15:03:05Z

‎Theme Specific Plugin Templates

Tom: /* Themed Templates for Plugins */

2015-10-18T14:50:47Z

‎Themed Templates for Plugins

Tom at 14:49, 18 October 2015

2015-10-18T14:49:46Z

Tom: /* Geeklog’s theme engine */

2013-02-23T00:02:52Z

‎Geeklog’s theme engine

Tom: /* Geeklog’s theme engine */

2013-02-23T00:01:41Z

‎Geeklog’s theme engine

Tom at 00:00, 23 February 2013

2013-02-23T00:00:06Z

@@ Line 108: / Line 108: @@
 The API is structured similarly to that of the Geeklog plugins. In the file "functions.php" in the theme's folder, the following functions may be declared (replace yourThemeName with the actual theme name):
-* function theme_config_yourThemeName() {}
+* function theme_config_yourThemeName()
-* function theme_css_yourThemeName() {}
+* function theme_css_yourThemeName()
-* function theme_js_libs_yourThemeName() {}
+* function theme_js_libs_yourThemeName()
-* function theme_js_files_yourThemeName() {}
+* function theme_js_files_yourThemeName()
-* function theme_init_yourThemeName() {}
+* function theme_init_yourThemeName()
 For implementation details please see the functions.php file that was shipped with your version of Geeklog.

@@ Line 68: / Line 68: @@
 Finally, you may want to update the logo and other images in your theme's images directory.
-For the template system we are using [http://phplib.sourceforge.net/ PHPLib]'s template class. Read their documentation and, optionally, look at /path/to/geeklog/system/classes/template.class.php to see how it is implemented. Even with this knowledge it may not be clear which templates are used in conjunction with one another (i.e. storybody.thtml and storybodytext.thtml together make up the complete format of a single story). If you have questions join our mailing list at http://lists.geeklog.net/listinfo/geeklog-users or check us out in IRC at irc.freenode.net in #geeklog.
+For the template system we are using [http://phplib.sourceforge.net/ PHPLib]'s template class. Read their documentation and, optionally, look at /path/to/geeklog/system/classes/template.class.php to see how it is implemented. Even with this knowledge it may not be clear which templates are used in conjunction with one another (i.e. storybody.thtml and storybodytext.thtml together make up the complete format of a single story). If you have questions join our mailing list at http://lists.geeklog.net/listinfo/geeklog-users
 == Theme Specific Plugin Templates ==

@@ Line 99: / Line 99: @@
 Plugin Templates that are theme specific can also now have a functions.php file which is similar to theme functions.php. This allows plugin templates to set additional JavaScript files, JavaScript library's and CSS files.
-CSS files also can be found in a similar way by Geeklog except their location is stored in their plugin directory under the Geeklog public_html directory.
+CSS files also can be found in a similar way by Geeklog using the default directory name (required), and theme directory names. Their location is stored in the css directory which is in the root of the plugin directory, which is found under the Geeklog public_html directory.
 All core plugins support this functionality. Please review their code for examples.

@@ Line 72: / Line 72: @@
 == Theme Specific Plugin Templates ==
-As of Geeklog 2.1.1, 2 new functions have been added to the template library that plugins can be use to determine which templates to use when displaying information. This means if the plugin supports it, under it's template directory it can contain directories named after themes. Within these directories the plugin template files for that theme will reside. A new directory called default will also be found and is REQUIRED. It contains all of the template files for the plugin that the plugin will use if no theme specific template directory and files are found. Also, the plugin theme template directories do not need to contain all of the template files. if one is not found the template class will fall back and look in the plugin default template directory for the required file.
+As of Geeklog 2.1.1, 2 new functions have been added to the template library that plugins can use to determine which templates to use when displaying information. This means if the plugin supports it, under it's template directory it can contain directories named after themes. Within these directories the plugin template files for that theme will reside. A new directory called default will also be found and is REQUIRED. It contains all of the template files for the plugin that the plugin will use if no theme specific template directory and files are found. Also, the plugin theme template directories do not need to contain all of the template files. if one is not found the template class will fall back and look in the plugin default template directory for the required file.
 Themes themselves also can contain the plugin template files. These must be located in the root of the theme directory under the layout directory. This is the first spot that the template class will look for the plugin template file.  If it is not found here it will then check for the theme directory in the plugins template directory.
@@ Line 92: / Line 92: @@
 )	It checks for a sub directory of the plugin’s name in the current theme being displayed root directory. If found it is used.
-)	It checks for a sub directory of the theme’s name in the current “plugins/plugin name here/templates/” directory. If found it is used.
+)	It checks for a sub directory of the theme’s name in the current “plugins/myplugin/templates/” directory. If found it is used.
 )	If 1 or 2 is not found then the default template for the plugin is used. It is always located in “plugins/myplugin/templates/default/”
@@ Line 98: / Line 98: @@
 Plugin Templates that are theme specific can also now have a functions.php file which is similar to theme functions.php. This allows plugin templates to set additional JavaScript files, JavaScript library's and CSS files.
 All core plugins support this functionality. Please review their code for examples.

@@ Line 72: / Line 72: @@
 == Theme Specific Plugin Templates ==
-As of Geeklog 2.1.1, 2 new functions where added to the template library that plugins can use to determine which templates to use when displaying information.
+As of Geeklog 2.1.1, 2 new functions have been added to the template library that plugins can be use to determine which templates to use when displaying information. This means if the plugin supports it, under it's template directory it can contain directories named after themes. Within these directories the plugin template files for that theme will reside. A new directory called default will also be found and is REQUIRED. It contains all of the template files for the plugin that the plugin will use if no theme specific template directory and files are found. Also, the plugin theme template directories do not need to contain all of the template files. if one is not found the template class will fall back and look in the plugin default template directory for the required file.
 To keep things consistent with the core plugins and to make theme development easier, other plugins should go ahead and use these functions where possible.
@@ Line 78: / Line 80: @@
 The 2 functions are:
-CTL_plugin_templatePath($plugin, $path = '')
+* CTL_plugin_templatePath($plugin, $path)
+* CTL_plugin_themeFindFile($plugin, $directory, $filename, $return_url)
 The template function returns the physical path directory location of the plugin templates. This should be run at the beginning of your plugins functions.inc and stored in your plugins config variables like so:
@@ Line 97: / Line 98: @@
 Plugin Templates that are theme specific can also now have a functions.php file which is similar to theme functions.php. This allows plugin templates to set additional JavaScript files, JavaScript library's and CSS files.
 == Theme API ==

← Older revision		Revision as of 14:49, 18 October 2015
Line 69:		Line 69:

	For the template system we are using [http://phplib.sourceforge.net/ PHPLib]'s template class. Read their documentation and, optionally, look at /path/to/geeklog/system/classes/template.class.php to see how it is implemented. Even with this knowledge it may not be clear which templates are used in conjunction with one another (i.e. storybody.thtml and storybodytext.thtml together make up the complete format of a single story). If you have questions join our mailing list at http://lists.geeklog.net/listinfo/geeklog-users or check us out in IRC at irc.freenode.net in #geeklog.		For the template system we are using [http://phplib.sourceforge.net/ PHPLib]'s template class. Read their documentation and, optionally, look at /path/to/geeklog/system/classes/template.class.php to see how it is implemented. Even with this knowledge it may not be clear which templates are used in conjunction with one another (i.e. storybody.thtml and storybodytext.thtml together make up the complete format of a single story). If you have questions join our mailing list at http://lists.geeklog.net/listinfo/geeklog-users or check us out in IRC at irc.freenode.net in #geeklog.
		+
		+	== Themed Templates for Plugins ==
		+
		+	As of Geeklog 2.1.1, 2 new functions where added to the template library that plugins can use to determine which templates to use when displaying information.
		+
		+	To keep things consistent with the core plugins and to make theme development easier, other plugins should go ahead and use these functions where possible.
		+
		+	The 2 functions are:
		+
		+	CTL_plugin_templatePath($plugin, $path = '')
		+
		+	CTL_plugin_themeFindFile($plugin, $directory, $filename, $return_url = true)
		+
		+	The template function returns the physical path directory location of the plugin templates. This should be run at the beginning of your plugins functions.inc and stored in your plugins config variables like so:
		+
		+	$CONF_MYPLUGIN['path_layout'] = CTL_plugin_templatePath('myplugin');
		+
		+	The Find File functions returns the HTML path for a plugin file (url or physical file location).
		+
		+	The order of operation for the template function is
		+
		+	1) It checks for a sub directory of the plugin’s name in the current theme being displayed root directory. If found it is used.
		+	2) It checks for a sub directory of the theme’s name in the current “plugins/plugin name here/templates/” directory. If found it is used.
		+	3) If 1 or 2 is not found then the default template for the plugin is used. It is always located in “plugins/myplugin/templates/default/”
		+
		+	This will hopefully make things easier for people when updating plugins to maintain their template changes. It also makes it easier for plugin developers to include plugin templates that support specific themes.
		+
		+	Plugin Templates that are theme specfic can also now have a functions.php file which is similar to theme functions.php. This allows plugin templates to set additional JavaScript files, JavaScript library's and CSS files.

	== Theme API ==		== Theme API ==

@@ Line 16: / Line 16: @@
 You will also need to include a new template variable called {layout_columns} which sets the class of the body tag which is found in header.thtml. This is needed to set the number of Geeklog columns on a given page.
-Geeklog’s updated theme engine also supports plugins that do not yet use the COM_createHTMLDocument function when creating a page. To include this support in your 2.0.0 theme a new Javscript file fix_html.js is required. Javascript code also needs to be added in the footer of the theme that runs the following code
+Geeklog’s updated theme engine also supports plugins that do not yet use the COM_createHTMLDocument function when creating a page. To include this support in your 2.0.0 theme a new Javscript file fix_html.js is required. Javascript code also needs to be added in the footer of the theme that runs the following code:
 ;FixHTML('leftblocks', 'centerblocks', 'rightblocks');

@@ Line 12: / Line 12: @@
 To use the new theme engine you must set in your theme's function.php a config variable:
-CONF['supported_version_theme'] = '2.0.0';
+;CONF['supported_version_theme'] = '2.0.0';
 You will also need to include a new template variable called {layout_columns} which sets the class of the body tag which is found in header.thtml. This is needed to set the number of Geeklog columns on a given page.
-Geeklog’s updated theme engine also supports plugins that do not yet use the COM_createHTMLDocument function when creating a page. To include this support in your 2.0.0 theme a new Javscript file /javascript/fix_html.js is required. Javascript code also needs to be added in the footer of the theme that runs
+Geeklog’s updated theme engine also supports plugins that do not yet use the COM_createHTMLDocument function when creating a page. To include this support in your 2.0.0 theme a new Javscript file fix_html.js is required. Javascript code also needs to be added in the footer of the theme that runs the following code
-FixHTML('leftblocks', 'centerblocks', 'rightblocks');
+;FixHTML('leftblocks', 'centerblocks', 'rightblocks');
 When creating your Geeklog 2.0.0 theme (or upgrading older themes) please use the bundled Denim and Modern Curve themes as examples. They include all of the latest changes.

← Older revision		Revision as of 00:00, 23 February 2013
Line 1:		Line 1:
	Creating a theme for Geeklog is easy and quite fast. If you can manipulate HTML files then you can create a theme! There's no need to learn PHP.		Creating a theme for Geeklog is easy and quite fast. If you can manipulate HTML files then you can create a theme! There's no need to learn PHP.

		+
		+	== Geeklog’s theme engine ==
		+
		+	As of Geeklog 2.0.0, the Geeklog theme engine was updated. There are 2 versions of the theme engine now, 2.0.0 and 1.8.1. Version 1.8.1 of the theme engine works the same as before and will be around for the next couple of versions of Geeklog until most of the popular themes and plugins are updated. The Geeklog community will be given plenty of notice before this version of the theme engine is removed.
		+
		+	So what is difference between the 2 theme engines? The main difference is when the templates are compiled. In Geeklog 1.8.X and lower the average Geeklog page was generated in chunks. Usually the header was generated first, followed by some processing which generated the middle and then finally the footer. The problem with this approach now days is that it doesn't allow for the header to be updated whenever we need to. We were finding more and more that the middle processing part (i.e. displaying the actual articles, plugins, etc.) needed to add something (javascript, css, text, etc.) to the header. For Responsive Web Design we also found that themes needed to know how many columns were going to be displayed right when the html page is created. To get around this an updated theme engine was devised to allow Geeklog to generate the whole page at once.
		+
		+	So, with Geeklog 2.0.0 we have added a new function called COM_createHTMLDocument that will eventually completely replace COM_siteHeader and COM_siteFooter. Geeklog 2.0.0 and all of the core plugins have been converted to use COM_createHTMLDocument but COM_siteHeader and COM_siteFooter have been left in to be backwards compatible for all older plugins. The Geeklog Development Team strongly suggest when plugin developers are upgrading their plugins that they take the time to convert all calls for COM_siteHeader and COM_siteFooter, to COM_createHTMLDocument.
		+
		+	To use the new theme engine you must set in your theme's function.php a config variable:
		+
		+	CONF['supported_version_theme'] = '2.0.0';
		+
		+	You will also need to include a new template variable called {layout_columns} which sets the class of the body tag which is found in header.thtml. This is needed to set the number of Geeklog columns on a given page.
		+
		+	Geeklog’s updated theme engine also supports plugins that do not yet use the COM_createHTMLDocument function when creating a page. To include this support in your 2.0.0 theme a new Javscript file /javascript/fix_html.js is required. Javascript code also needs to be added in the footer of the theme that runs
		+
		+	FixHTML('leftblocks', 'centerblocks', 'rightblocks');
		+
		+	When creating your Geeklog 2.0.0 theme (or upgrading older themes) please use the bundled Denim and Modern Curve themes as examples. They include all of the latest changes.

	== Creating a theme ==		== Creating a theme ==