Changes between Version 8 and Version 9 of AnotherPluginDevelopmentGuide

Timestamp:

20.07.2012 11:21:40 (12 years ago)

Author:

dgf

Comment:

adapt renderer and style convention

AnotherPluginDevelopmentGuide

@@ -67 +67 @@
 || . . . . . bucket.png                     || of your choice, all of them are accessible via HTTP. ||
 || . . . . [#js script/]                    || Client-side !JavaScipt goes here. ||
-|| . . . . . [#pluginjs plugin.js]          || The JavaScipt plugin "main" file. ||
-|| . . . . style/                           || Another custom folder to separate the styles. ||
+|| . . . . . renderer/                      || All client renderer implementations are separated here by directory. ||
+|| . . . . . . [#canvas canvas_renderers/]  || ||
+|| . . . . . . [#multi multi_renderers/]    || ||
+|| . . . . . . [#page page_renderers/]      || ||
+|| . . . . . . [#simple simple_renderers/]  || ||
+|| . . . . . [#pluginjs plugin.js]          || The !JavaScipt plugin "main" file. ||
+|| . . . . [#style style/]                  || CSS stylesheets located here are picked up automatically. ||
 |||| . . . . . screen.css                   ||
 
@@ -327 +332 @@
 
 Enhancing the web client with !JavaScript based implementations is supported by 
-the unique plugin.js file.
-
-A plugin that loads some type specific renderer and adds a custom command:
+the unique {{{plugin.js}}} file.
+
+A plugin with some custom command callbacks:
 {{{#!js
 dm4c.add_plugin('dm4.example.plugin', function() {
-
-    // load some renderer and a style sheet
-    dm4c.load_field_renderer('/de.deepamehta.dm4-example/script/example_content_field_renderer.js')
-    dm4c.load_page_renderer('/de.deepamehta.dm4-example/script/example_content_page_renderer.js')
-    dm4c.load_stylesheet('/de.deepamehta.dm4-example/style/screen.css')
 
     // calls the alternative REST creation method with customized JSON format
@@ -369 +369 @@
 
 Type specific renderer can be assigned declarative or programmatically in a migration and
-manually in the web client.
+manually by editing the view configuration of a type in the web client.
 
 Declarative renderer assignment:
@@ -382 +382 @@
             type_uri: "dm4.webclient.view_config",
             composite: {
-                dm4.webclient.field_renderer_uri: "dm4.example.content_field_renderer",
+                dm4.webclient.simple_renderer_uri: "dm4.example.content_field_renderer",
                 dm4.webclient.page_renderer_uri: "dm4.example.content_page_renderer"
             }
@@ -391 +391 @@
 
 
-=== !FieldRenderer ===
-
-A simple possibility to enhance the UI is the field renderer. The generic topic renderer
-creates a fresh object for each composite part, so please use the prototype approach.
+=== !SimpleRenderer === #simple
+
+A simple possibility to enhance the UI is the simple renderer.
 
 {{{#!js
-// a simple field renderer that renders an example topic name with an additional CSS class
-dm4c.add_field_renderer("dm4.example.content_field_renderer", {
-
-    render_field: function(field_model, parent_element) {
-        dm4c.render.field_label(field_model, parent_element)
-        parent_element.append($("<span>").addClass('example').text(field_model.value))
+// a simple example that renders a topic name with a additional CSS class
+dm4c.add_simple_renderer('dm4.example.content_field_renderer', {
+
+    render_info: function(model, $parent) {
+        dm4c.render.field_label(model, $parent)
+        $parent.append($("<span>").addClass('example').text(model.value))
     },
 
-    render_form_element: function(field_model, parent_element) {
-        var $content = dm4c.render.input(field_model)
-        parent_element.append($content)
+    render_form: function(model, $parent) {
+        var $content = dm4c.render.input(model)
+        $parent.append($content)
         return function() { // return input value
             return $.trim($content.val())
@@ -416 +415 @@
 
 
-=== !PageRenderer ===
+=== !PageRenderer === #page
 
 The page renderer can replace the whole page content.
@@ -443 +442 @@
 
 
-== !TopicMapRenderer ==
-
-'''TBD''' describe additional topic map handling
+=== !MultiRenderer === #multi
+
+'''TBD''' describe and write a multi renderer implementation
+
+
+=== !CanvasRenderer === #canvas
+
+'''TBD''' describe additional canvas renderer
+
+
+=== Stylesheets === #style
+
+All Stylesheets in the web resource folder are loaded by default.
+
+Loading custom CSS files of a vendor plugin or something else:
+{{{#!js
+dm4c.load_stylesheet('/de.deepamehta.dm4-example/vendor/library/css/screen.css')
+}}}
+
 
 = Java = #java