Plugin Developers Handbook - Revision history

Rasade: /* Contents */ Added link to page on autoinstall

2010-04-21T19:53:04Z

‎Contents: Added link to page on autoinstall

Dirk: link to Plugin Development page, not back to geeklog.net

2009-06-06T20:17:56Z

link to Plugin Development page, not back to geeklog.net

Dirk: Cosmetics

2009-05-21T18:11:26Z

Cosmetics

Dirk: link to the old plugin docs on geeklog.net

2009-05-21T18:06:57Z

link to the old plugin docs on geeklog.net

Dirk: Minor corrections

2009-05-05T09:16:39Z

Minor corrections

Dirk: added Category:Plugin Developers Handbook

2009-05-04T09:57:04Z

added Category:Plugin Developers Handbook

Dirk: updated links to documented source code

2009-05-01T20:22:07Z

updated links to documented source code

Dirk: Changed category

2008-05-10T20:12:08Z

Changed category

Dirk: Forward -> Foreword

2008-05-10T19:48:30Z

Forward -> Foreword

Tomw at 14:29, 1 July 2004

2004-07-01T14:29:39Z

@@ Line 16: / Line 16: @@
 ## [[Sample Install Documentation]]
 ## [[Sample install.php]]
 # Advanced Integration with Geeklog
 ## [[Extending Site Statistics with your plugin]]
@@ Line 28: / Line 29: @@
 ## [http://project.geeklog.net/src/Geeklog/_system---lib-security.php.html lib-security.php documentation]
 ## [[Plugin Development|Geeklog Plugin Development Documentation]]
 == Introduction and Foreword ==

@@ Line 27: / Line 27: @@
 ## [http://project.geeklog.net/src/Geeklog/_public_html---lib-common.php.html lib-common.php documentation]
 ## [http://project.geeklog.net/src/Geeklog/_system---lib-security.php.html lib-security.php documentation]
-## [http://www.geeklog.net/docs/english/plugin.html Original Plugin Help File by Tony Bibbs]
+## [[Plugin Development|Geeklog Plugin Development Documentation]]

@@ Line 24: / Line 24: @@
 # [[Universal Plugin ToolKit]]
 # [[functions.inc  - Listing of the Plugin Functions]]
-# Other Included Documentation Files
+# Other Documentation Files
 ## [http://project.geeklog.net/src/Geeklog/_public_html---lib-common.php.html lib-common.php documentation]
 ## [http://project.geeklog.net/src/Geeklog/_system---lib-security.php.html lib-security.php documentation]
@@ Line 38: / Line 38: @@
 The following suggestions about Programming Style, the use of Templates and Language Files, and Geeklog's Way of Doing Things are simply that -- suggestions. You can choose not to follow them and have a perfectly valid plugin or block. Following these suggestions will make your job easier in the long run and make your code more usable by others.
-This excerpt from the original Geeklog Plugin Developer Documentation by Tony Bibbs aptly summarizes the place plugins play in the Geeklog project.
+This excerpt from the original Geeklog Plugin Developer Documentation by Tony Bibbs aptly summarizes the place plugins play in the Geeklog project:
 :Geeklog is becoming more and more popular each day and we, the Geeklog developers, are amazed at some of the great hacks people have made to extend their Geeklog installation to fit their own needs.  At the same time, the Geeklog development team is continually adding new features that make Geeklog even better. We have realized the need for Geeklog to support two threads of development: core Geeklog code and plugin code. By building in the infrastructure needed to extend Geeklog's functionality through plugins we can make a clean separation between the Geeklog codebase and plugin code so that we can concentrate on making Geeklog's core code better while others can develop plugins so that Geeklog fits their needs. With that said, Geeklog now has a Plugin application program interface (API).
@@ Line 52: / Line 54: @@
 :* Allow you full flexibility on what your plugin does. Geeklog does not dictate your plugin's power.
 [[Category:Plugin Developers Handbook]] [[Category:Plugin Development]]

@@ Line 27: / Line 27: @@
 ## [http://project.geeklog.net/src/Geeklog/_public_html---lib-common.php.html lib-common.php documentation]
 ## [http://project.geeklog.net/src/Geeklog/_system---lib-security.php.html lib-security.php documentation]
-## [http://gplugs.sourceforge.net/pluginman/plugin.php Original Plugin Help File by Tony Bibbs]
+## [http://www.geeklog.net/docs/english/plugin.html Original Plugin Help File by Tony Bibbs]

@@ Line 6: / Line 6: @@
 == Contents ==
-#[[Plugin_Developers_Handbook#Introduction and Foreword|Introduction and Foreword]]
+# [[Plugin_Developers_Handbook#Introduction and Foreword|Introduction and Foreword]]
-#[[Programming Style]]
+# [[Programming Style]]
-#[[Using Templates and Language Files]]
+# [[Using Templates and Language Files]]
-#[[Geeklog's way of doing things]]
+# [[Geeklog's way of doing things]]
-#[[Blocks and Plugins]]
+# [[Blocks and Plugins]]
-#[[How to get Started: A Development Overview]]
+# [[How to get Started: A Development Overview]]
-#[[Suggested and Required Directory Layout and Files]]
+# [[Suggested and Required Directory Layout and Files]]
-#[[Plugin Installation]]
+# [[Plugin Installation]]
-##[[Sample Install Documentation]]
+## [[Sample Install Documentation]]
-##[[Sample install.php]]
+## [[Sample install.php]]
-#Advanced Integration with Geeklog:
+# Advanced Integration with Geeklog
-##[[Extending Site Statistics with your plugin]]
+## [[Extending Site Statistics with your plugin]]
-##[[Integrating the Comment Engine]]
+## [[Integrating the Comment Engine]]
-##[[Using Geeklog's Search Engine]]
+## [[Using Geeklog's Search Engine]]
-##[[Adding Moderation Capability]]
+## [[Adding Moderation Capability]]
-#[[Distribution]]
+# [[Distribution]]
-#[[Universal Plugin ToolKit]]
+# [[Universal Plugin ToolKit]]
-#[[functions.inc  - Listing of the Plugin Functions]]
+# [[functions.inc  - Listing of the Plugin Functions]]
-#Other Included Documentation Files:
+# Other Included Documentation Files
-##[http://project.geeklog.net/src/Geeklog/_public_html---lib-common.php.html lib-common.php documentation]
+## [http://project.geeklog.net/src/Geeklog/_public_html---lib-common.php.html lib-common.php documentation]
-##[http://project.geeklog.net/src/Geeklog/_system---lib-security.php.html lib-security.php documentation]
+## [http://project.geeklog.net/src/Geeklog/_system---lib-security.php.html lib-security.php documentation]
-##[http://gplugs.sourceforge.net/pluginman/plugin.php Original Plugin Help File by Tony Bibbs]
+## [http://gplugs.sourceforge.net/pluginman/plugin.php Original Plugin Help File by Tony Bibbs]
 == Introduction and Foreword ==
-This document and accompanying files are intended to make developing plugins and blocks for Geeklog - The Ultimate Weblog System easier. Our work is dependent upon the developers who wrote Geeklog and continue to expand and support it: Tony Bibbs, Dirk Haun, Jeffrey Schoolcraft, Jason Whittenburg, Matt Braafhart, Mark Limburg, Gene Wood, Yanick Bourbeau, and Tane Piper. It is based on the earlier documentation written by Tony Bibbs and the collective knowledge contained in the mailing lists and websites devoted to Geeklog. The Moderation API documentation was provided by Vincent Furia.
+This document and accompanying files are intended to make developing plugins and blocks for Geeklog easier. Our work is dependent upon the developers who wrote Geeklog and continue to expand and support it: Tony Bibbs, Dirk Haun, Jeffrey Schoolcraft, Jason Whittenburg, Matt Braafhart, Mark Limburg, Gene Wood, Yanick Bourbeau, Tane Piper and others. It is based on the earlier documentation written by Tony Bibbs and the collective knowledge contained in the mailing lists and websites devoted to Geeklog. The Moderation API documentation was provided by Vincent Furia.
-This documentation was developed with Geeklog version 1.3.7 in mind, but it should work with minor variations for earlier 1.3 versions and should apply to future versions in the 1.3 series. The next major version of Geeklog (v 2) will have a different plugin interface.
+This documentation was developed with Geeklog version 1.3.7 in mind, but it should work with minor variations for earlier 1.3 versions and should apply to future versions in the 1.x series.
 The following suggestions about Programming Style, the use of Templates and Language Files, and Geeklog's Way of Doing Things are simply that -- suggestions. You can choose not to follow them and have a perfectly valid plugin or block. Following these suggestions will make your job easier in the long run and make your code more usable by others.
-This excerpt for the original Geeklog Plugin Developer Documentation by Tony Bibbs aptly summarizes the place plugins play in the Geeklog project.
+This excerpt from the original Geeklog Plugin Developer Documentation by Tony Bibbs aptly summarizes the place plugins play in the Geeklog project.
 :Geeklog is becoming more and more popular each day and we, the Geeklog developers, are amazed at some of the great hacks people have made to extend their Geeklog installation to fit their own needs.  At the same time, the Geeklog development team is continually adding new features that make Geeklog even better. We have realized the need for Geeklog to support two threads of development: core Geeklog code and plugin code. By building in the infrastructure needed to extend Geeklog's functionality through plugins we can make a clean separation between the Geeklog codebase and plugin code so that we can concentrate on making Geeklog's core code better while others can develop plugins so that Geeklog fits their needs. With that said, Geeklog now has a Plugin application program interface (API).
@@ Line 43: / Line 44: @@
 :At the highest level, the Geeklog Plugin API is generic code that is called in strategic places in the Geeklog codebase that allow function of plugins to be called. This will allow your plugin the following features:
-:*Ability for your plugin to be submission-based so that users can submit objects to your plugin.  You can then visit the command and control center in Geeklog to moderate the submissions for your plugin.
+:* Ability for your plugin to be submission-based so that users can submit objects to your plugin.  You can then visit the command and control center in Geeklog to moderate the submissions for your plugin.
-:*Allow your plugin to show up in the Admin block and User block on each Geeklog page.
+:* Allow your plugin to show up in the Admin block and User block on each Geeklog page.
-:*Allow your plugin to be searched via the Geeklog search page.
+:* Allow your plugin to be searched via the Geeklog search page.
-:*Allow stats for your plugin to show up on the site statistics page.
+:* Allow stats for your plugin to show up on the site statistics page.
-:*Allow your plugin the ability to use Geeklog's comment engine.
+:* Allow your plugin the ability to use Geeklog's comment engine.
-:*Allow you to use the power of Geeklog's code library (lib-common.php) in your own plugin code.
+:* Allow you to use the power of Geeklog's code library (lib-common.php) in your own plugin code.
-:*Allow you full flexibility on what your plugin does. Geeklog does not dictate your plugin's power.
+:* Allow you full flexibility on what your plugin does. Geeklog does not dictate your plugin's power.
 [[Category:Plugin Developers Handbook]] [[Category:Plugin Development]]

← Older revision		Revision as of 09:57, 4 May 2009
Line 51:		Line 51:
	:*Allow you full flexibility on what your plugin does. Geeklog does not dictate your plugin's power.		:*Allow you full flexibility on what your plugin does. Geeklog does not dictate your plugin's power.

−	[[Category:Plugin Development]]	+	[[Category:Plugin Developers Handbook]] [[Category:Plugin Development]]

← Older revision		Revision as of 20:12, 10 May 2008
Line 51:		Line 51:
	:*Allow you full flexibility on what your plugin does. Geeklog does not dictate your plugin's power.		:*Allow you full flexibility on what your plugin does. Geeklog does not dictate your plugin's power.

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

← Older revision		Revision as of 14:29, 1 July 2004
Line 1:		Line 1:
	== Geeklog Plugin Developers Handbook ==		== Geeklog Plugin Developers Handbook ==

−	By Blaine Lang and [[User:Tomw\| Tom Willett]] December, 2002	+	By [[User:Blaine\|Blaine Lang]] and [[User:Tomw\| Tom Willett]] December, 2002