Differences

This shows you the differences between two versions of the page.

--- user:skripty:ggi [2010/07/23 12:54] – upraveno mimo DokuWiki
+++ user:skripty:ggi [Unknown date] (current) – external edit (Unknown date) 127.0.0.1
@@ Line 1: / Line 1: @@
 ====== Instalační skripty (GGI) ======
-FIXME Tyto skripty slouží k instalaci skriptů.
+Jedná se o skripty, které slouží k zajištění specializovaných činností při instalaci či odinstalaci doplňku z [[user:skripty:autor:gip|instalačního balíčku]].
-obsahuje následující funkci
+Instalační skripty mohou pomocí příkazu [[user:skripty:preprocessor#vkladani_externich_souboru|příkazu {$INCLUDE}]] bez problémů pracovat i s knihovnami či skripty, které jsou součástí instalovaného balíčku. Mohou rovněž využívat jakékoliv dostupné [[user:skripty:functions|funkce]].
+===== Rozhraní =====
+Skript může obsahovat tyto funkce:
 <code delphi>function InstallWork: string;</code>
-FIXME Během instalace se zpracovábvají dva instalační skripty
+Tato funkce je vykonána během instalace skriptu (po nakopírování obsahu balíčku do složky **DATADIR\script**). Je třeba nastavit její návratovou hodnotu:
-  * ''preinstall.ggi.pas''
+  * v případě, že během jejího provádění nedošlo k chybě, funkce vrací **prázdný string**
-  * ''postinstall.ggi.pas''
+  * v opačném případě obsahuje návratová hodnota text chybové zprávy
+<code delphi>function UninstallWork: string;</code>
+Toto je funkce, která je vykonána během odinstalace skriptu (před smazáním obsahu definovaného v [[user:skripty:autor:gip#metasoubor_pluginmetaini|metasouboru]]). Je třeba nastavit její návratovou hodnotu:
+  * v případě, že má odinstalace po provedení funkce pokračovat, funkce vrací **prázdný string**
+  * v případě, že má být odinstalace předčasně ukončena, musí návratová hodnota funkce nést text chybové zprávy
+===== Pojmenování =====
+Instalační skripty by měly být pojmenovány tímto způsobem: **PLG_JM.ggi.pas**, kde PLG_JM je jméno instalovaného doplňku. Konvence však není povinná, jen doporučená.
+===== Použití =====
+Instalační skript je součástí [[user:skripty:autor:gip|instalačního balíčku]]. Cesta ke skriptu je definována pomocí [[user:skripty:autor:gip#Metasoubor_plugin.meta.ini|meta]] souboru příslušného balíčku.
+Skript je poté v těchto momentech automaticky spouštěn a pokud existuje definovaná patřičná funkce, je provedena
+  * po nakopírování obsahu balíčku do složky **DATADIR\script** - ''InstallWork''
+  * před smazáním obsahu definovaného v [[user:skripty:autor:gip#metasoubor_pluginmetaini|metasouboru]] - ''UninstallWork''