Wiki source code of Data types

Last modified by Administrator on 2011/03/02 17:34
Content · Comments (0) · Attachments (0) · History · Information
{{velocity}}
#if($request.space && $request.name)
  #if($request.name.endsWith("Class"))
    #set($targetClassName="${request.space}.${request.name}")
  #else
    #set($targetClassName="${request.space}.${request.name}Class")
  #end
  #if($xwiki.hasAccessLevel('edit', $context.user, $targetClassName))
    $response.sendRedirect($xwiki.getURL($context.util.noaccents($targetClassName), 'edit', "editor=wiki&template=$!{request.template}&sheet=$!{request.sheet}&parent=$!{request.parent}"))
    ## Stop processing, since we already sent a redirect.
    #stop
  #end
#end
{{/velocity}}
This tool allows to define structured data types (classes) in your wiki. Please consult the [[developer's guide>>http://www.xwiki.org/xwiki/bin/view/DevGuide/WebHome]] to get familiar with the XWiki data model and the public APIs.

= Templates for new data types =

Here are the templates and sheets for creating new classes:

* [[Default code for displaying a class>>ClassSheet]]
* [[Document template for new classes>>ClassTemplate]]
* [[Default code for displaying class instances (objects)>>ObjectSheet]]
* [[Document template for new objects>>ObjectTemplate]]

= Create a new data type =

Choose a simple name, such as //Article//, //Book//, //Employee//. '//Class//' will be appended at the end automatically.

{{velocity}}
#if("$!{targetClassName}" != ''){{warning}}You don't have permission to create that class{{/warning}}#end

{{html}}
<form action="$doc.URL" method="post">
  <div>
    <input type="hidden" name="parent" value="XWiki.XWikiClasses"/>
    <input type="hidden" name="template" value="XWiki.ClassTemplate"/>
    <input type="hidden" name="sheet" value="1"/>
    <label for="space">Space:</label> <input type="text" id="space" name="space" value="XWiki"/>
    <label for="name">Class:</label> <input type="text" id="name" name="name" value="Name of the class" class="withTip"/>
    <span class="buttonwrapper"><input type="submit" value="Create this Class" class="button"/></span>
  </div>
</form>
{{/html}}{{/velocity}}

= Data types defined in this wiki =

{{velocity}}
##
## Existing classes are enumerated, grouped by space name.
## The list is already sorted alphabetically
##
#set($prevSpace = '')
#foreach ($classname in $xwiki.classList)
    #set($classdoc = $xwiki.getDocument($classname))
    #if($classdoc.space != $prevSpace)
      ; [[$classdoc.space>>${classdoc.space}.WebHome]] space:
      #set($prevSpace = $classdoc.space)
    #end
    : [[$classdoc.name>>$classdoc.fullName]]
#end
{{/velocity}}
Wiki source code of Data types

Quick Links
