IPSModuleManager - Adapted Repository and Docu

Author: brownson

IPSLibrary/MainPage.dox

@@ -11,14 +11,15 @@
  * @image html IPSModulLibrary_Overview.png
  *
  * @section modules verf�gbare Module
- * - @link ipsutils IPSUtils@endlink, diverse allgemeine Funktionen, die einem das Leben in IPS leichter machen.
  * - @link ipsmodulemanager IPSModuleManager@endlink, bildet die Basis zur Installation und zum Update aller Module
  * - @link ipscomponent IPSComponent@endlink, IPSComponent bildet einen abstractions Layer zur Hardware, dieser stellt f�r alle Module ein einheitliches Interface zu den unterschiedlichen Hardware Komponenten her.
  * - @link ipsmessagehandler IPSMessageHandler@endlink, in Kombination mit IPSComponent erm�glicht dieses Modul die aktive R�ckmeldung der Hardware zu den Modulen.
  * - @link ipslogger IPSLogger@endlink, Logging Handler, der f�r den Betrieb eines Gro�teils der Module ben�tigt wird.
  * - @link netplayer NetPlayer@endlink, Auswahl und Abspielen von Musik Files und Web Radios
  * - @link entertainment Entertainment Steuerung@endlink, Steuerung von Multimedia Ger�ten, autom. Ein- und Ausschalten von Ger�ten, Fernbedienung der Ger�te �ber die IPS Frontends, Visualisierung von Ger�te und Raum Status.
  * - @link ipsedip IPSEDIP@endlink, bietet die M�glichkeit IPS Strukturen auf einem EDIP Display zu visualisieren (Hersteller ELECTRONIC ASSEMBLY, www.lcd-module.de).
+ * - @link ipstwilight IPSTwilight@endlink, Berechnung der t�glichen D�mmerungszeiten
+ * - @link ipsweatherforcastat IPSWeatherForcastAT@endlink, Wettervorhersage f�r �sterreich
  *
  * @section howto Prinzipielle Vorgehensweise
  * - Download des Modules (Details siehe IPSModuleManager)

IPSLibrary/install/BaseLoader/IPSLibrary_BaseLoader.ips.php

@@ -1,5 +1,5 @@
 <?
-	$remoteRepository = 'https://raw.github.com/brownson/IPSLibrary/master/';
+	$remoteRepository = 'https://raw.github.com/brownson/IPSLibrary--Test-/master/';
 	$localRepository = IPS_GetKernelDir().'scripts\\';
 
 	$fileList = array(

IPSLibrary/install/IPSModuleManager/IPSModuleManager.class.php

@@ -368,10 +368,10 @@ public function GetLogFileName() {
 		 * Liefert ein Array aller installierten Module
 		 *
 		 * Aufbau:
-		 * array('Module1' => array('<<Version>>', '<<Status>>', '<<Description>>'),
-		 *       'Module2' => array('<<Version>>', '<<Status>>', '<<Description>>'),
+		 * array('Module1' => array('Version', 'Status', 'Description'),
+		 *       'Module2' => array('Version', 'Status', 'Description'),
 		 *       ...
-		 *       'ModuleX' => array('<<Version>>', '<<Status>>', '<<Description>>'))
+		 *       'ModuleX' => array('Version', 'Status', 'Description'))
 		 *
 		 * @return string Array der Installierten Module
 		 */
@@ -399,16 +399,17 @@ public function GetInstalledModules() {
 			}
 			return $resultList;
 		}
+
 		/**
 		 * @public
 		 *
 		 * Liefert ein Array aller verfügbaren Module
 		 *
 		 * Aufbau:
-		 * array('Module1' => array('<<ModulePfad>>', '<<Description>>'),
-		 *       'Module2' => array('<<ModulePfad>>', '<<Description>>'),
+		 * array('Module1' => array('ModulePfad', 'Description'),
+		 *       'Module2' => array('ModulePfad', 'Description'),
 		 *       ...
-		 *       'ModuleX' => array('<<ModulePfad>>', '<<Description>>'))
+		 *       'ModuleX' => array('ModulePfad', 'Description'))
 		 *
 		 * @return string Array der verfügbaren Module
 		 */

IPSLibrary/install/IPSModuleManager/IPSScriptHandler/IPSScriptHandler.class.php

@@ -82,7 +82,7 @@ private function GetScriptExtensionByFileName($script) {
 		 *
 		 * Die Funktion registriert ein ScriptFile anhand des Filenames und Directory Pfades in IPS
 		 *
-		 * @param string $scriptList Liste von Scripts, die registriert werden soll
+		 * @param string $file Name des Script Files
 		 */
 		public function UnregisterScriptByFilename($file) {
 			$scriptPath = $this->GetScriptPathByFileName($file);
@@ -101,7 +101,7 @@ public function UnregisterScriptByFilename($file) {
 		 *
 		 * Die Funktion registriert ein ScriptFile anhand des Filenames und Directory Pfades in IPS
 		 *
-		 * @param string $scriptList Liste von Scripts, die registriert werden soll
+		 * @param string $file Name des Script Files
 		 */
 		public function RegisterScriptByFilename($file) {
 			$scriptPath = $this->GetScriptPathByFileName($file);

IPSLibrary/install/InitializationFiles/Default/IPSModuleManager.ini

@@ -1,4 +1,4 @@
-SourceRepository="https://raw.github.com/brownson/IPSLibrary/master/"
+SourceRepository="https://raw.github.com/brownson/IPSLibrary--Test-/master/"
 
 RegisterDefaultFiles=false
 RegisterExampleFiles=false

IPSLibrary/install/InstallationScripts/IPSModuleManager_Installation.ips.php

@@ -98,22 +98,51 @@
 	 * Teilweise werden Parameter auch in beiden Files gesucht. Zum Beispiel werden die diversen Parameter zur Installation des WebFronts (Enabled,
 	 * Root, WFCId) zuerst im jeweiligen Module Ini File gesucht (zB IPSLogger.ini), ist es dort nicht definiert, wird im File IPSModuleManager.ini gesucht.
 	 *
-	 * Beispiel:
+	 * Beispiel aus INI File IPSModuleManager:
+	 *  @code
+         SourceRepository="https://raw.github.com/brownson/IPSLibrary--Test-/master/"
+
+         RegisterDefaultFiles=false
+         RegisterExampleFiles=false
+         RegisterInstallFiles=false
+
+         [WFC10]
+         Enabled=true
+
+         [Mobile]
+         Enabled=true
+	    @endcode
+	 *
+	 * Beschreibung der wichtigsten Parameter:
+	 *   "SourceRepository" spezifiziert das Default Repository
+	 *   "RegisterDefaultFiles" legt fest, ob "default" Files in IPS registriert werden
+	 *   "RegisterExampleFiles" legt fest, ob "example" Files in IPS registriert werden
+	 *   "RegisterInstallFiles" legt fest, ob "install" Files in IPS registriert werden
+	 *
+	 * Beispiel INI File IPSWeatherForcastAT:
 	 *  @code
          [WFC10]
          Enabled=true
-         Path=Visualization.WebFront.Entertainment
-         ID=
-         TabName=
-         TabIcon=Speaker
+         Path=Visualization.WebFront.IPSWeather.IPSWeatherForcastAT
+         TabPaneItem=TPWeather
+         TabPaneParent=roottp
+         TabPaneName=
+         TabPaneOrder=10
+         TabPaneExclusive=false
+         TabPaneIcon=Cloud
+         TabItem=ForcastAT
+         TabName=Vorhersage
+         TabIcon=Cloud
          TabOrder=20
 
          [Mobile]
          Enabled=true
-         Path=Visualization.Mobile
-         Name=Entertainment
+         Path=Visualization.Mobile.Wetter
+         PathOrder=10
+         PathIcon=Cloud
+         Name=Vorhersage
+         Icon=Cloud
          Order=20
-         Icon=Speaker
 	    @endcode
 	 *
 	 * [] markiert immer eine Gruppe von Einstellungen, In der Gruppe "WFC10” werden die Einstellungen gesucht, die für die WebFront
@@ -125,9 +154,16 @@
 	 * - "Path" bestimmt den Installations Pfad in IP-Symcon
 	 * - "ID" bezeichnet die ID des Webfront Konfigurators der verwendet werden soll, wenn nichts angegeben wird, verwendet die Installations
 	 *   Prozedure den erst Besten der gefunden wird.
-	 * - "TabName" definiert Namen im SplitPane des WebFronts
-	 * - "TabIcon" definiert Icon im SplitPane des WebFronts
-	 * - "TabOrder" definiert Position im SplitPane des WebFronts
+	 * - "TabPaneItem" definiert den Item Namen des TabPane's im WebFronts
+	 * - "TabPaneParent" definiert das Parent Item des TabPane's im WebFronts
+	 * - "TabPaneName" Name des TabPane's
+	 * - "TabPaneIcon" Icon des TabPane's
+	 * - "TabPaneOrder" Position des TabPane's
+	 * - "TabPaneExclusive" Wird das TabPane exklusiv vom Modul verwendet (wichtig für Deinstallation)
+	 * - "TabItem" Item Name der für das Tab verwendet wird
+	 * - "TabName" definiert Namen im Tab des WebFronts
+	 * - "TabIcon" definiert Icon im Tab des WebFronts
+	 * - "TabOrder" definiert Position im Tab des WebFronts
 	 * - "Name" für Mobile Frontend Installation
 	 * - "Order" Position Mobile Frontend
 	 * - "Icon" Icon für Mobile Frontend