err.no Git - sope/blob - Recycler/NGObjDOM/README

   1
   2 NGObjDOM XML Rendering Framework
   3 ================================
   4
   5 Note: while NGObjDOM *is* useful it is more or less deprecated in the places
   6       where it is currently used, which are: OGo forms and OGo publisher.
   7       In both cases the NGObjDOM implementation of the templates should be
   8       replaced using NGObjWeb XML DOM builders for a major speedup and far
   9       better integration into the NGObjWeb server.
  10
  11 NGObjDOM is a framework which works together with NGObjWeb to render
  12 XML content represented as DOM trees.
  13 It can be used to create templates (WODynamicElement's) represented
  14 as XML files instead of .wo components.
  15
  16 To render a DOM tree you can use the WORenderDOM dynamic element, eg:
  17
  18   <#DOMContent />
  19
  20   DOMContent: WORenderDOM {
  21     domDocument = domTree;
  22     factory     = passThroughHTMLRenderer;
  23   }
  24
  25 The DOM is processed using so called 'node renderers', which are roughly
  26 identical to WODynamicElements but differ in that they only perform the
  27 operation and do not represent the template tree (WODynamic elements are
  28 tree nodes with behaviour, this is separated in NGObjDOM: the tree is the
  29 DOM, the behaviour are the renderers).
  30
  31 The superclass for all node renderers is ODNodeRenderer and already provides
  32 some convinience methods for accessing attributes and such. The ODR class
  33 prefix stands in for 'ObjDOM Renderer'.
  34
  35 A bridge to dynamic elements in the other direction (embedding
  36 WODynamicElement's in DOM trees) is the ODRWebObject renderer.
  37
  38 Profiling
  39 =========
  40
  41 You can profile the renderer using the defaults
  42
  43   ODProfileRenderer    - bool
  44 and
  45   ODProfileRendererMin - double
  46
  47 Defaults
  48 ========
  49
  50   ODNodeRendererDebugCursor - bool
  51
  52 ODProfileRenderer - Bool - log render profiling information
  53
  54 ODNodeRenderer Debug Defaults
  55   ODEvalAttrValuesInExceptionHandler - bool
  56   ODDebugJSAttrEval - bool
  57   ODLogAttrValues   - bool
  58
  59 ---
  60 hh, 2001-05-30