Suggested and Required Directory Layout and Files - Revision history

Dirk: a few links and minor corrections

2009-05-16T17:42:16Z

a few links and minor corrections

Dirk: cosmetics and some minor additions/corrections

2009-05-04T15:21:58Z

cosmetics and some minor additions/corrections

Dirk: Changed category

2008-05-10T20:14:35Z

Changed category

Tomw at 13:56, 1 July 2004

2004-07-01T13:56:56Z

Tomw at 21:21, 28 June 2004

2004-06-28T21:21:23Z

New page

The file layout for Geeklog Blocks has no specific requirements. Most blocks have no separate files that are included in Geeklogs directory structure. For those that do have external files, we would suggest that you follow the directory structure outlined below for plugins. If you have files that are located outside the webtree, like those located in the plugins/{plugin} directory, then put them in a directory called blocks/{block} at the same level as the plugins directory.

For Plugins it is a different story. There are several required files and directories and specific places your should put your other files. In the examples below we will assume that you are creating a plugin named 'greatplugin'. Each plugin must have three separate directories.

#All files that are not required to be in the webtree (usually include files, templates, config files, documentation, etc) should be placed in a directory named for the plugin under the plugins directory. Thus it would be: {path_to_geeklog}/plugins/greatplugin/
#All files required for the administration of the plugin should be placed in a file named for the plugin under the plugin directory of the admin directory. Thus it would be: {path_to_admin_directory}/plugins/greatplugin/
#All files required for the user interface to your plugin should be in a directory named after your plugin under the public_html directory. Thus it would be: {public_html}/greatplugin/

Files required for a plugin to correctly function:
*Under number 1 above:
**function.inc
*Under number 2 above:
**install.php
**index.php
*Under number 3 above:
**index.php
**images/{plugin}.gif

Note: the gif image is required by the command and control block and must be named after the plugin the same as the directory names.

You can find skeletal versions of all these files and more in the Universal Plugin Toolkit.

The complete directory structure is listed below: once again you must replace {plugin} with the name or your plugin.

*admin/plugins/{plugin}
**install.php
**index.php
*public_html/{plugin}
**index.php
*public_html/{plugin}/images
**{plugin}.gif
*plugins/{plugin}
**functions.inc
**config.php
**README
**INSTALL
*plugins/{plugin}/language
**english.php
**german.php
**etc
*plugins/{plugin}/templates/
**install.thtml
**admin.thtml
**index.thtml
**etc

@@ Line 1: / Line 1: @@
-The file layout for Geeklog Blocks has no specific requirements. Most blocks have no separate files that are included in Geeklogs directory structure. For those that do have external files, we would suggest that you follow the directory structure outlined below for plugins. If you have files that are located outside the webtree, like those located in the plugins/{plugin} directory, then put them in a directory called blocks/{block} at the same level as the plugins directory.
+== Blocks ==
 For Plugins it is a different story. There are several required files and directories and specific places your should put your other files. In the examples below we will assume that you are creating a plugin named 'greatplugin'. Each plugin must have three separate directories.
-# All files that are not required to be in the webtree (usually include files, templates, config files, documentation, etc) should be placed in a directory named for the plugin under the plugins directory. Thus it would be: {path_to_geeklog}/plugins/greatplugin/
+# All files that are not required to be in the webtree (usually include files, templates, config files, documentation, etc) should be placed in a directory named for the plugin under the plugins directory. Thus it would be: <tt>{path_to_geeklog}/plugins/greatplugin/</tt>
-# All files required for the administration of the plugin should be placed in a file named for the plugin under the plugin directory of the admin directory. Thus it would be: {path_to_admin_directory}/plugins/greatplugin/
+# All files required for the administration of the plugin should be placed in a directory named for the plugin under the <tt>plugins</tt> directory of the <tt>admin</tt> directory. Thus it would be: <tt>{path_to_admin_directory}/plugins/greatplugin/</tt>
-# All files required for the user interface to your plugin should be in a directory named after your plugin under the public_html directory. Thus it would be: {public_html}/greatplugin/
+# All files required for the user interface to your plugin should be in a directory named after your plugin under the <tt>public_html</tt> directory. Thus it would be: <tt>{public_html}/greatplugin/</tt>
 Files required for a plugin to correctly function:
@@ Line 19: / Line 23: @@
 Note: the image is required by the command and control block. Plugins can provide the complete URL of the image with the <code>PLG_getIcon</code> API function.
-You can find skeletal versions of all these files and more in the Universal Plugin Toolkit.
+You can find skeletal versions of all these files and more in the [[Universal Plugin ToolKit]].
-The complete directory structure is listed below: once again you must replace {plugin} with the name or your plugin.
+The complete directory structure is listed below: once again you must replace {plugin} with the name of your plugin.
 * admin/plugins/{plugin}

← Older revision		Revision as of 20:14, 10 May 2008
Line 45:		Line 45:
	**etc		**etc

−	[[Category:~~Plugin_Developers_Handbook~~]]	+	[[Category:Plugin Development]]

← Older revision		Revision as of 13:56, 1 July 2004
Line 44:		Line 44:
	**index.thtml		**index.thtml
	**etc		**etc
		+
		+	[[Category:Plugin_Developers_Handbook]]

@@ Line 3: / Line 3: @@
 For Plugins it is a different story. There are several required files and directories and specific places your should put your other files. In the examples below we will assume that you are creating a plugin named 'greatplugin'. Each plugin must have three separate directories.
-#All files that are not required to be in the webtree (usually include files, templates, config files, documentation, etc) should be placed in a directory named for the plugin under the plugins directory. Thus it would be: {path_to_geeklog}/plugins/greatplugin/
+# All files that are not required to be in the webtree (usually include files, templates, config files, documentation, etc) should be placed in a directory named for the plugin under the plugins directory. Thus it would be: {path_to_geeklog}/plugins/greatplugin/
-#All files required for the administration of the plugin should be placed in a file named for the plugin under the plugin directory of the admin directory. Thus it would be: {path_to_admin_directory}/plugins/greatplugin/
+# All files required for the administration of the plugin should be placed in a file named for the plugin under the plugin directory of the admin directory. Thus it would be: {path_to_admin_directory}/plugins/greatplugin/
-#All files required for the user interface to your plugin should be in a directory named after your plugin under the public_html directory. Thus it would be: {public_html}/greatplugin/
+# All files required for the user interface to your plugin should be in a directory named after your plugin under the public_html directory. Thus it would be: {public_html}/greatplugin/
 Files required for a plugin to correctly function:
-*Under number 1 above:
+* Under number 1 above:
-**function.inc
+** function.inc
-*Under number 2 above:
+* Under number 2 above:
-**install.php
+** install.php
-**index.php
+** index.php
-*Under number 3 above:
+* Under number 3 above:
-**index.php
+** index.php
-**images/{plugin}.gif
+** images/{plugin}.gif
-Note: the gif image is required by the command and control block and must be named after the plugin the same as the directory names.
+Note: the image is required by the command and control block. Plugins can provide the complete URL of the image with the <code>PLG_getIcon</code> API function.
 You can find skeletal versions of all these files and more in the Universal Plugin Toolkit.
@@ Line 23: / Line 23: @@
 The complete directory structure is listed below: once again you must replace {plugin} with the name or your plugin.
-*admin/plugins/{plugin}
+* admin/plugins/{plugin}
-**install.php
+** install.php
-**index.php
+** index.php
-*public_html/{plugin}
+* public_html/{plugin}
-**index.php
+** index.php
-*public_html/{plugin}/images
+* public_html/{plugin}/images
-**{plugin}.gif
+** {plugin}.gif
-*plugins/{plugin}
+* plugins/{plugin}
-**functions.inc
+** functions.inc
-**config.php
+** config.php
-**README
+** README
-**INSTALL
+** INSTALL
-*plugins/{plugin}/language
+* plugins/{plugin}/language
-**english.php
+** english.php
-**german.php
+** german.php
-**etc
+** etc.
-*plugins/{plugin}/templates/
+* plugins/{plugin}/templates/
-**install.thtml
+** install.thtml
-**admin.thtml
+** admin.thtml
-**index.thtml
+** index.thtml
-**etc
+** etc.
-[[Category:Plugin Development]]
+[[Category:Plugin Developers Handbook]] [[Category:Plugin Development]]