Sample Install Documentation - Revision history

Dirk: trying to get rid of the "GL"

2009-05-23T21:32:24Z

trying to get rid of the "GL"

Dirk: Typo

2009-05-05T08:24:25Z

Typo

Dirk: added Category:Plugin Developers Handbook

2009-05-05T08:15:47Z

added Category:Plugin Developers Handbook

Dirk: Changed category

2008-05-10T20:15:52Z

Changed category

Tomw at 13:57, 1 July 2004

2004-07-01T13:57:58Z

Tomw: =4.0 Upgrade from version 2.1 and 2.2=

2004-06-28T21:50:11Z

=4.0 Upgrade from version 2.1 and 2.2=

Tomw: =Step 6. Final Install Notes=

2004-06-28T21:48:37Z

=Step 6. Final Install Notes=

Tomw: =5.0 List of Plugin Files with Descriptions=

2004-06-28T21:47:48Z

=5.0 List of Plugin Files with Descriptions=

Tomw: =4.0 Upgrade from version 2.1 and 2.2=

2004-06-28T21:46:50Z

=4.0 Upgrade from version 2.1 and 2.2=

Tomw: =Step 6. Final Install Notes=

2004-06-28T21:45:51Z

=Step 6. Final Install Notes=

@@ Line 9: / Line 9: @@
 == 1.0  Overview ==
-This is a true Geeklog plugin using the GL Plugin API calls.
+This is a true Geeklog plugin using the Geeklog Plugin API calls.
 This is a complete re-write from my earlier Chatterblock release but I have provided a migration script to convert existing 2.x Chatterblock tables so no data is lost. Many new features have been added and it is now a plugin to ease installation. No files have to be edited - all online install and configuration. Please take a min to review the list of changes
@@ Line 19: / Line 19: @@
 *Create tables, security groups and automatically adds the menu links
 *Block definition automatically created - block will appear upon install completing
-*Able to delete/remove plugin from GL Plugin Admin screen
+*Able to delete/remove plugin from Geeklog Plugin Admin screen
 *Language file for translation support and easy personalization of the block and plugin interface
 *Extensive online configuration control - It can easily be tuned down for basic look and feel

← Older revision		Revision as of 08:24, 5 May 2009
Line 286:		Line 286:


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

@@ Line 221: / Line 221: @@
 ''Core Plugin Files'' – The <geeklog_dir>/plugins/chatterblock directory
-.    FILE: /path/to/geeklog/plugins/chatterblock/config.php
+. FILE: /path/to/geeklog/plugins/chatterblock/config.php
 DESCRIPTION: The plugin database configuration file
-.    FILE: /path/to/geeklog/plugins/chatterblock/functions.inc
+. FILE: /path/to/geeklog/plugins/chatterblock/functions.inc
 DESCRIPTION: Implements the Geeklog Plugin-API functions
-.    FILE: /path/to/geeklog/plugins/chatterblock/cb_style.css
+. FILE: /path/to/geeklog/plugins/chatterblock/cb_style.css
 DESCRIPTION: Plugin CSS styles to be appended to your theme style.css files
@@ Line 233: / Line 233: @@
 DESCRIPTION: HTML help file to be used for block help file
-.    FILE: /path/to/geeklog/plugins/chatterblock/language/english.php
+. FILE: /path/to/geeklog/plugins/chatterblock/language/english.php
 DESCRIPTION: plugin language definitions with the english file provided
-.    FILE: /path/to/geeklog/plugins/chatterblock/templates
+. FILE: /path/to/geeklog/plugins/chatterblock/templates
 DESCRIPTION: plugin Install/De-Install display template files
 ''Plugin Admin Files'' – The geeklog_dir>/public_html/admin/plugins/chatterblock directory
-.    FILE: /path/to/geeklog/public_html/admin/plugins/chatterblock/install.php
+. FILE: /path/to/geeklog/public_html/admin/plugins/chatterblock/install.php
 DESCRIPTION: Chatterblock plugin install and De-Install utility
-.    FILE: /path/to/geeklog/public_html/admin/plugins/chatterblock/index.php
+. FILE: /path/to/geeklog/public_html/admin/plugins/chatterblock/index.php
 DESCRIPTION: Main code for the plugin admin functions
-.    FILE: /path/to/geeklog/public_html/admin/plugins/chatterblock/upgrade_v2.php
+. FILE: /path/to/geeklog/public_html/admin/plugins/chatterblock/upgrade_v2.php
 DESCRIPTION: Program used only to upgrade database tables from v2.2 to v2.3
@@ Line 264: / Line 264: @@
 DESCRIPTION: Program called as the iframe source when this mode is active
-.FILE: /path/to/geeklog/public_html/chatterblock/help.html
+. FILE: /path/to/geeklog/public_html/chatterblock/help.html
 DESCRIPTION: Chatterblock formatted HTML file to display help file for smilies
-.FILE: /path/to/geeklog/public_html/chatterblock/alert.html
+. FILE: /path/to/geeklog/public_html/chatterblock/alert.html
 DESCRIPTION: Formatted HTML displayed in the alert popup
-.FILE: /path/to/geeklog/public_html/chatterblock/cache/cb_config.php
+. FILE: /path/to/geeklog/public_html/chatterblock/cache/cb_config.php
 DESCRIPTION: Chatterblock default settings config file
-.FILE: /path/to/geeklog/public_html/chatterblock/images/
+. FILE: /path/to/geeklog/public_html/chatterblock/images/
 DESCRIPTION: Directory contains all required image files
-.FILE: /path/to/geeklog/plugins/chatterblock/includes/cb_function.php
+. FILE: /path/to/geeklog/plugins/chatterblock/includes/cb_function.php
 DESCRIPTION: Plugin miscellaneous functions
-.FILE: /path/to/geeklog/plugins/chatterblock/includes/cb_redirect.php
+. FILE: /path/to/geeklog/plugins/chatterblock/includes/cb_redirect.php
 DESCRIPTION: Plugin function that is included to handle redirect message
-.FILE: /path/to/geeklog/plugins/chatterblock/includes/popupbasic.js
+. FILE: /path/to/geeklog/plugins/chatterblock/includes/popupbasic.js
 DESCRIPTION: Plugin Javascript that includes the chatAlert()function to display the popup
 [[Category:Plugin Development]]

@@ Line 2: / Line 2: @@
 Aka: efarmboy<br>
-Email: geeklog@langfamily.ca<br>
+Email: geeklog AT langfamily DOT ca<br>
 Version: Nov 10, 2002    (Release Date for Chatterblock 3.0 as a plugin)<br>
@@ Line 285: / Line 285: @@
 DESCRIPTION: Plugin Javascript that includes the chatAlert()function to display the popup
-[[Category:Plugin_Developers_Handbook]]
+[[Category:Plugin Development]]

← Older revision		Revision as of 13:57, 1 July 2004
Line 284:		Line 284:
	20.FILE: /path/to/geeklog/plugins/chatterblock/includes/popupbasic.js		20.FILE: /path/to/geeklog/plugins/chatterblock/includes/popupbasic.js
	DESCRIPTION: Plugin Javascript that includes the chatAlert()function to display the popup		DESCRIPTION: Plugin Javascript that includes the chatAlert()function to display the popup
		+
		+	[[Category:Plugin_Developers_Handbook]]

@@ Line 159: / Line 159: @@
 Completing this process will not delete any existing messages in your Chatterlog database.
-.  Disable the existing Chatterblock - not delete, just disable it.
+=== 1.  Ensure you make a backup of your database first. Check the backup file and ensure its > 0 bytes in size. ===
-.  Remove the Chatterblock related functions in lib-custom.php
+=== 2.  Disable the existing Chatterblock - not delete, just disable it. ===
 function   phpblock_Chatterblock()
@@ Line 171: / Line 177: @@
 function   cb_getuidbyname($name)
-. Change or modify table names used by the plugin
+=== 5. Install the plugin files as described in this Install step 1 here - but don't execute the plugin install yet ===
 FILE: /path/to/geeklog/plugins/chatterblock/config.php is where the table names are defined
@@ Line 185: / Line 195: @@
    $_TABLES['cb_userprefs']  - Table to store user preferences.
 .  Run the upgrade script to modify the main chatterblock table and create the userprefs table
                 FILE: /path/to/geeklog/public_html/admin/plugins/chatterblock/upgrade_v2.php
 .  *IMPORTANT* Set the option in the install script to not attempt to create new tables
      FILE: /path/to/geeklog/public_html/admin/plugins/chatterblock/install.php
@@ Line 194: / Line 208: @@
 $plugin_createtables = false;             // Set to true if plugin tables should be created
-. Now enable your block again and it should now be upgraded with existing data intact.
+=== 9.  Run the plugin install program and complete the install steps as described from here ===
 All of your chatter history can be seen by accessing the Chatterlog.

@@ Line 143: / Line 143: @@
 === Step 6.        Final Install Notes ===
-.2  The block was automatically created during the install. You may want to edit the Title, location or access rights
+==== 6.1  Modify the alert.html file - to display your site information if you enable pop-up alerts ====
-.4  All Block related titles and text is can easily be changed to personalize the block. Refer the the plugin language file
+==== 6.2  The block was automatically created during the install. You may want to edit the Title, location or access rights ====
 == 4.0  Upgrade from version 2.1 and 2.2 ==

← Older revision		Revision as of 21:45, 28 June 2004
Line 150:		Line 150:

	6.4 All Block related titles and text is can easily be changed to personalize the block. Refer the the plugin language file		6.4 All Block related titles and text is can easily be changed to personalize the block. Refer the the plugin language file
−
−	~~Return to index~~
−
−
−

	== 4.0 Upgrade from version 2.1 and 2.2 ==		== 4.0 Upgrade from version 2.1 and 2.2 ==