Docs

git-svn-id: https://svn.argeo.org/slc/trunk@2064 4cfe0d0a-d680-48aa-b62c-e0a02a3f76cc

diff --git a/org.argeo.slc.webapp/doc/Architecture.gif b/org.argeo.slc.webapp/doc/Architecture.gif
new file mode 100644 (file)
index 0000000..50fa8eb
Binary files /dev/null and b/org.argeo.slc.webapp/doc/Architecture.gif differ

diff --git a/org.argeo.slc.webapp/doc/Argeo-RIA-DeveloperDoc.odt b/org.argeo.slc.webapp/doc/Argeo-RIA-DeveloperDoc.odt
new file mode 100644 (file)
index 0000000..2c705ab
Binary files /dev/null and b/org.argeo.slc.webapp/doc/Argeo-RIA-DeveloperDoc.odt differ

diff --git a/org.argeo.slc.webapp/doc/config.json b/org.argeo.slc.webapp/doc/config.json
new file mode 100644 (file)
index 0000000..a58ce32
--- /dev/null
+++ b/org.argeo.slc.webapp/doc/config.json
@@ -0,0 +1,203 @@
+{\r
+  "name"    : "ria",\r
+\r
+  "include" :\r
+  [\r
+    {\r
+      "path" : "src/main/webapp/qooxdoo-0.8-sdk/component/apiviewer/api.json",\r
+      "as"   : "apiconf"\r
+    },\r
+    {\r
+      "path" : "src/main/webapp/qooxdoo-0.8-sdk/component/testrunner/testrunner.json",\r
+      "as"   : "testrunner"\r
+    }    \r
+  ],\r
+\r
+  "let" :\r
+  {\r
+    "APPLICATION"  : "org.argeo.ria",\r
+    "QOOXDOO_PATH" : "src/main/webapp/qooxdoo-0.8-sdk/framework",\r
+    "QOOXDOO_URI"  : "../qooxdoo-0.8-sdk/framework",\r
+    "QXTHEME"      : "qx.theme.Modern",\r
+       "QXICONTHEME"  : ["Tango"],\r
+    "API_EXCLUDE"  : ["qx.legacy.*"],\r
+    "LOCALES"      : [ "en" ],\r
+    "ROOT"         : "src/main/webapp/argeo-ria-src",\r
+       "BUILD_PATH"   : "src/main/webapp/argeo-ria",\r
+       "RIA_LIB_PATH" : "src/main/webapp/argeo-ria-lib",\r
+       "RIA_LIB_URI"  : "../argeo-ria-lib",\r
+       "CACHE"            : "cache" ,\r
+       "CUSTOM_PERSPECTIVE" : "org.argeo.ria.sample.Perspective"\r
+  },\r
+\r
+  "jobs" : \r
+  {\r
+    "common" :\r
+    {\r
+      "library" :\r
+      [\r
+        {\r
+          "manifest" : "${QOOXDOO_PATH}/Manifest.json",\r
+          "uri"      : "${QOOXDOO_URI}"\r
+        },\r
+        {\r
+          "manifest" : "${RIA_LIB_PATH}/sample/Manifest.json",\r
+          "uri"      : "${RIA_LIB_URI}/sample"\r
+        },\r
+        {\r
+          "manifest" : "${ROOT}/Manifest.json",\r
+          "uri"      : ".."\r
+        }\r
+      ],\r
+\r
+      "include" :\r
+      [\r
+        "${APPLICATION}.Application",\r
+        "${CUSTOM_PERSPECTIVE}",\r
+        "${QXTHEME}"\r
+      ],\r
+\r
+      "cache" :\r
+      {\r
+        "compile" :  "${CACHE}"\r
+      },\r
+\r
+      "settings" :\r
+      {\r
+        "qx.version"     : "${QXVERSION}",\r
+        "qx.theme"       : "${QXTHEME}",\r
+        "qx.application" : "${APPLICATION}.Application",\r
+               "ria.Perspective": "${CUSTOM_PERSPECTIVE}"\r
+      }\r
+    },\r
+\r
+    // -- source jobs --------------------------------------------------\r
+\r
+    "source-script" :\r
+    {\r
+      "extend" : ["common"],\r
+\r
+      "compile-source" :\r
+      {\r
+        "file" : "${ROOT}/script/${APPLICATION}.js",\r
+        "locales" : "${LOCALES}",\r
+        "root" : "${ROOT}"\r
+      }\r
+    },\r
+\r
+\r
+    "slc-source" :\r
+    {\r
+      "run" :\r
+      [\r
+        "source-script"\r
+      ]\r
+    },\r
+\r
+    // -- build jobs --------------------------------------------------\r
+\r
+    "build-script" :\r
+    {\r
+      "extend" : ["common"],\r
+\r
+      "variants" :\r
+      {\r
+        "qx.debug" : ["off"]\r
+      },\r
+\r
+      "compile-dist" :\r
+      {\r
+        "target" : "${BUILD_PATH}",\r
+        "file" : "${BUILD_PATH}/script/${APPLICATION}.js",\r
+        "uri"  : "script/${APPLICATION}.js",\r
+        "root" : "${BUILD_PATH}",\r
+        "format" : "on",\r
+        "locales" : "${LOCALES}",\r
+        "optimize" : ["basecalls", "variables", "privates", "strings"]\r
+      }\r
+    },\r
+\r
+\r
+    "build-resources":\r
+    {\r
+      "extend" : ["common"],\r
+\r
+      "copy-resources" :\r
+      {\r
+        "target"          : "${BUILD_PATH}",\r
+        "resource-filter" : true\r
+      }\r
+    },\r
+\r
+    "my-build-files" :\r
+    {\r
+      "extend" : ["common"],\r
+\r
+      "copy-files" :\r
+      {\r
+        "files" :\r
+        [\r
+          "index.html"\r
+        ],\r
+               "source" : "${ROOT}",\r
+        "target" : "${BUILD_PATH}"\r
+      }\r
+    },\r
+       \r
+    "slc-build" :\r
+    {\r
+      "run" :\r
+      [\r
+        "build-resources",\r
+        "build-script",\r
+        "my-build-files"\r
+      ]\r
+    },\r
+    \r
+    "slc-api" :\r
+    {\r
+      "extend" : ["apiconf::build"],\r
+\r
+      "let" :\r
+      {\r
+        "APIVIEWER_ROOT" : "${QOOXDOO_PATH}/../component/apiviewer",\r
+        "BUILD_PATH" : "./target/site/argeo-ria-api/",\r
+        "API_INCLUDE" : ["${APPLICATION}.*", "${CUSTOM_PERSPECTIVE}"]\r
+      },\r
+\r
+      "library" :\r
+      [\r
+        {\r
+          "manifest" : "${ROOT}/Manifest.json",\r
+          "uri"      : ".."\r
+        },\r
+        {\r
+          "manifest" : "${RIA_LIB_PATH}/sample/Manifest.json",\r
+          "uri"      : "${RIA_LIB_URI}/sample"\r
+        }\r
+      ]\r
+    },\r
+    \r
+    "slc-test" :\r
+    {\r
+      "extend" : ["testrunner::build"],\r
+\r
+      "let" :\r
+      {\r
+        "TESTRUNNER_ROOT" : "${QOOXDOO_PATH}/../component/testrunner",\r
+        "TEST_INCLUDE"    : "${APPLICATION}.test.*",\r
+        "BUILD_PATH"      : "./target/site/argeo-ria-test/"\r
+      },\r
+\r
+      "library" :\r
+      [\r
+        {\r
+          "manifest" : "${ROOT}/Manifest.json",\r
+          "uri"      : ".."\r
+        }\r
+      ]\r
+    }\r
+    \r
+       \r
+  }\r
+}\r