kaolak : documentation previous | next | table of contents 


4 Modules
Below is a list and description of the kaolak modules developed as of August 1, 2003. For Kaolak core modules and development info see section 3.5 Modules.
 
module [ website ]
 
dependencies : [website], [html_page], [html_template], [html_content], [html_menu]
 
description : The [ website ] module allows a user/group of users to create a website (a set of linked html pages) and :
  • publish it as static html pages under the user/group branch websites/ directory
  • download it as a zip compressed file
  • publish it to a remote ftp server
  • have it accessible to selected branch members only (using kaolak access permissions)
 
definition : A [ website ] is defined by the following properties (added to the standard node properties) :
  • name
  • home page » [ html_page ] module element
 
module [ html_page ]
 
dependencies : [html_template], [html_content]
 
description : An [ html_page ] module element is composed of an [ html_template ] and a [ html_content ] elements.
Optionaly an [html_menu] (graphical output set by html_template) can be added.
 
definition : A [ html_page ] element is defined by the following properties (added to the standard node properties) :
  • name
  • description
  • template » [ html_template ] module element
  • content » [ html_content ] module element
  • menu » [ html_menu ] module element
 
module [ html_content ]
 
dependencies :
 
description : An [ html_content ] module represents some HTML content.
Kaolak uses HtmlArea from interactivetools.com as its WYSIWYG HTML editor.
 
definition : A [ html_content ] element is defined by the following properties (added to the standard node properties) :
  • name
  • description
  • title » used by [ html_page ] to substitute to [ html_template ] <#title#> tag
  • keywords » idem - keywords used in <META> keywords tag
  • html » module element content
 
module [ html_template ]
 
dependencies : [html_template], [html_content]
 
description : An [ html_template ] module element is a frame to create [html_page]s when associated with [html_content].
[ html_template ] uses special kaolak tags parsed by a KaolakScript object to fetch kaolak objects data and substitue it.
As of August 2, 2003 the following tags are subsituted with data:
  • <#title#>
    from [html_content]
  • <#keywords#>
    from [html_content]
  • <#description#>
    from [html_content] and [html_page]
  • <#menu#> commands <#/menu#>
    outputs navigation menu from [html_menu] according to commands. Examples:
    • #offset_width: 20
      GUI horizontal offset between parent and child navigation menu point
    • #group_css: style1
      stylesheet class for parent menu points
    • #element_css: style2
      stylesheet class for menu points pointing to html pages
    • #group_htmlsurround: <tr><td><#group#></td></tr>
      html that surrounds parent menu points name.
      Defines graphical layout - can contain any HTML/javascript code
    • #element_htmlsurround: <tr><td><#element#></td></tr>
      html that surrounds menu points name.
      Defines graphical layout - can contain any HTML/javascript code
  • <#content#>
    from [html_content]
 
definition : A [ html_template ] element is defined by the following properties (added to the standard node properties) :
  • name
  • description
  • html » html template
 
module [ html_menu ]
 
dependencies : [html_template], [html_page]
 
description : An [ html_menu ] module element is a parent node whose children html_page property refers to an [html_page] module element.
 
definition : A [ html_menu ] element is defined by the following properties (added to the standard node properties) :
  • name
  • html_page » [ html_page ] module element
  • hierpos» graphical hierarchical position within parent node
 
 previous | next | table of contents