Differences

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

--- igd:root [2015/02/13 09:30] – cr-wiki-admin
+++ igd:root [2024/04/04 08:04] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
+====== Welcome to the intelligentgraphics Dialogs Wiki! ======
+intelligentgraphics Dialogs (IGD) is a concept to implement easy-to-use, intuitive and even emotional custom configuration and planning wizards that can be hosted by (native) Apps, Web shops and traditional desktop planning systems. The IGD wizards are designed to work even off-line.
+===== Terminology =====
+  * A **Module** is an IGD Wizard consisting of a number of Pages, running in a Host that provides the appropriate environment.
+  * A **Page** is part of a Module and is an exclusive full-screen view.
+  * A **Host** is a Module container that starts and supports a Module, and processes the information, such as an order list, created by the Module. A Host can be a native iOS App, a Windows application, a Web shop, for instance.
+===== The Module Structure =====
+A Module consists of (paths relative to MODULE/src):
+  * //Module.json// - [[igd:module_reg|Module Registration]]
+  * //pages/// - Pages (HTML, JS, CSS)
+  * //lib/// - The JS libraries the module requires
+  * //img/// - Images used in the module
+  * //data/// - Optional data files
+  * //resources/// - Optional text resource files for [[igd:localization|Module localization]]
+===== Module Libraries =====
+The following libraries must or may be used by Modules:
+**Standard**
+  * //IGD.Core// - Defines and partially implements the basic types for the wizard-host communication
+  * //IGD.Driver// - This is a polymorphic library to be provided by the Host during deployment of the Module. The driver lib is required to connect to the Host.
+**2D**
+  * //IGD.Planning2D// - An optional library with core 2D planning functionality.
+  * //IG.GFX.Konva (formerly KineticJS)// - A Konva driver lib for the IGX.API, required by IGD.Planning2D.
+  * //IG.GFX.Core// - Basic setup of the IGX.API, required by IG.GFX.KineticJS.
+**3D**
+  * //IG.GFX.ThreeJS// - A ThreeJS driver lib for the IGX.API.
+  * //IG.GFX.Core// - Basic setup of the IGX.API, required by IG.GFX.ThreeJS.
+===== Style Guide =====
+==== Progress ====
+  * In case you don't have intra-page progress control: the current page counts fully for the progress. So if you have 3 pages, display 33% on the first one, 67% on the second one, and 100% on the last.