zkaffold 0.0.11

Parameters

More often than not, one will want to specify values for fields in the schema of the object when it is created. To do this, add a params child to the element representing the new object, which itself should contain a param element for each field. The param tag should have the name attribute set to the name of the field in question and the type attribute set to one of text, lipsum, lipsum_html, reference, image, file, boolean, list or reference_list. The param element then contains the value that should be given to that field. One need not specify a param element for each and every field of a content type, the default values will be used where fields are not specified.

param elements with the type attribute set to lipsum or lipsum_html have the optional attribute paras which specifies the number of paragraphs of Lipsum to generate as the value of that field. They also contain no child elements. The lipsum value causes ordinary Lipsum to be generated with newlines, whereas lipsum_html generates Lipsum with paragraph tags as necessary:

<site>
  <my_folder>
    <MyContentType id="my_new_obj">
      <params>
        <param name="title" type="text">My new object</param>
        <param name="text" type="lipsum_html" paras="5" />
        <param name="isNew" type="boolean">True</param>
        <param name="old_obj" type="reference">/my_folder/my_obj</param>
        <param name="thumb" type="image">new_obj_thumb.jpg</param>
      </params>
    </MyContentType>
  </my_folder>
</site>

As in the above example, references are given as path strings to the referenced object. Images & files are given as file names relative to the directory of the XML file.

Multi-valued parameters

For fields which may contain multiple values such as ReferenceList or LinesField, the param element takes the type attribute list or reference_list. It should then contain an items element, which contains zero or more item elements with their type attribute set appropriately, as per the param tag and their value set as their inner XML:

<site>
  <my_folder>
    <MyContentType id="my_new_obj">
      <params>
        <param name="title" type="text">My new object</param>
        <param name="options" type="list">
          <items>
            <item type="text">Option 1</item>
            <item type="text">Option 2</item>
          </items>
        </param>
      </params>
    </MyContentType>
  </my_folder>
</site>

Interfaces

Occasionally one may wish to add interfaces to objects which they do not automatically provide, particularly marker interfaces. This is achieved using the interfaces & interface tags, like so:

<site>
  <my_folder>
    <MyContentType id="my_new_obj">
      <interfaces>
        <interface>identifier.of.IMyMarker</interface>
        <interface>identifier.of.IReplacementObject</interface>
      </interfaces>
      <params>
        <param name="title" type="text">My new object</param>
      </params>
    </MyContentType>
  </my_folder>
</site>

This adds the interfaces specified by the identifiers to the object.

Interfaces that are already applied to objects may be similarly removed by replacing the interface element with a remove element, thus:

<site>
  <my_folder>
    <MyContentType id="my_new_obj">
      <interfaces>
        <remove>IMyMarker</remove>
      </interfaces>
      <params>
        <param name="title" type="text">My new object</param>
      </params>
    </MyContentType>
  </my_folder>
</site>

Setting the default page of folderish objects

To set the default page of a new or existing folderish object, use the modify element with a setDefaultPage attribute:

<site>
  <my_folder>
    <modify setDefaultPage="my_new_obj">
      ...
    </modify>
  </my_folder>
  <FolderishType id="another_folder">
    <modify setDefaultPage="folder_home" />
    <params>
      ...
    </params>
    <ContentType id="folder_home">
      ...
    </ContentType>
  </FolderishType>
</site>