Changes between Version 1 and Version 2 of HowToMakeAutomaticUpgradeScriptForModule

Timestamp:

Jul 8, 2013, 11:14:15 AM (12 years ago)

Author:

AntonL

Comment:

--

HowToMakeAutomaticUpgradeScriptForModule

@@ -1 +1 @@
 == How to make automatic upgrade script for module ==
 
-There is a prepared zip package with the simplest update for Dolphin 7 module [here]. Download it, unpack and upload to the '''modules/me/bloggie/updates/''' folder. '''bloggie''' folder is the root folder of Bloggie module which was described [http://www.boonex.com/trac/dolphin/wiki/DolphinTutorialMyFirstModule here], '''updates''' folder is a folder for all updates for Bloggie module, if it doesn't exist then you need to create it.
+There is a prepared zip package with the simplest update for Dolphin 7 module [here]. Download it, unpack and upload to the '''modules/me/bloggie/updates/''' folder. '''bloggie''' folder is the root folder of Bloggie module which was described [http://www.boonex.com/trac/dolphin/wiki/DolphinTutorialMyFirstModule here], '''updates''' folder is a folder for all updates for Bloggie module, if it doesn't exist then you need to create it.[[BR]]
 
+The zip package contains '''update_100_110''' folder. It is up to you how to name the folder but it is a good practice to include "version from" and "version to" into the folder name, it is just more clear. Lets describe each file in the update. This is almost the minimal set of files for the module's update:[[BR]]
 
+'''bloggie/updates/update_100_110/install/'''[[BR]]
+Update installation directory, where all installation files are located, like SQL files and language files.[[BR]]
+'''bloggie/updates/update_100_110/install/config.php'''[[BR]]
+Update installation config file. We will take a closer look at this later.[[BR]]
+'''bloggie/updates/update_100_110/install/installer.php'''[[BR]]
+Update installer class. You can add some custom installation scripts and override default behaviour.[[BR]]
+'''bloggie/updates/update_100_110/install/info'''[[BR]]
+Installation information messages folder. If you need to display information messages upon update install, you will need to place files here - also special instructions are needed to point to in the install config file to display these messages properly.[[BR]]
+'''bloggie/updates/update_100_110/install/langs'''[[BR]]
+Update languages must be located in this dir. The language file must be a php file with the name of two letters of the language code.  We will take a closer look at an example of the language file later.[[BR]]
+'''bloggie/updates/update_100_110/install/langs/en.php'''[[BR]]
+An update for default English language file.[[BR]]
+'''bloggie/updates/update_100_110/install/sql'''[[BR]]
+SQL script for update install is here.[[BR]]
+'''bloggie/updates/update_100_110/install/sql/install.sql'''[[BR]]
+Update installation SQL file.[[BR]]
+'''bloggie/updates/update_100_110/source'''[[BR]]
+A folder with files and folders which should be uploaded in module's folder. So, files and folders structure should match module's one. You may read more about module's file structure [http://www.boonex.com/trac/dolphin/wiki/DolphinTutorialMyFirstModule here].[[BR]]
+