Difference between revisions of "Dossier Element (Data)"

Revision as of 15:35, 3 December 2008

Context: HL Kit … Kit Reference … Data File Reference 

The "dossier" Element

Dossiers represent a logical set of output for a portfolio, such as a character sheet, statblock, or even export data for use with another product. Each dossier is specified through the use of a "dossier" element. The complete list of attributes for this element is below.

id	Id – Specifies the unique id of the dossier. This id is used in all references to the dossier.
name	Text – Public name associated with the dossier. Maximum length of 100 characters.

The "dossier" element also possesses child elements that define various facets of the dossier. The list of these child elements is below and must appear in the order shown. Click on the link to access the details for each element.

IMPORTANT! Exactly one of these child elements may be specified for each dossier. If multiple are given, a compiler error will be reported. The chosen child element dictates the type of dossier that is being defined and its characteristics.

dossier_sheet	An optional "dossier_sheet" element may appear as defined by the given link. This element defines the structure of a printed dossier, such as a character sheet.
dossier_text	Zero or more "dossier_text" elements may appear as defined by the given link. This element specifies text-based output, such as a statblock.
dossier_export	An optional "dossier_export" element may appear as defined by the given link. This element defines output that is tailored for use within another product, such as d20Pro.

The "dossier_sheet" Element

The "layoutref" element identifies a layout used within the sheet and assigns it a logical name for use within the Position script. The complete list of attributes for this element is below.

layout	Id – Unique id of the layout to be utilized within the sheet.
reference	(Optional) Id – Specifies the alternate unique id to be used when referencing this layout within the Position script. This makes it possible to re-use the same layout more than once within the same sheet, giving each instance a different logical id. If empty, the reference id is simply the layout id. Default: Empty.

The "position" Element

The "position" element defines a Position Script for the sheet, which performs all the appropriate sizing and positioning of the contained layouts within the sheet. The complete list of attributes for this element is below.

PCDATA

Script – Specifies the code comprising the Position script.

Example

The following example demonstrates what a "dossier" element might look like. All default values are assumed for optional attributes.

<dossier id="standard" name="Standard Character Sheet">
  <dossier_sheet grouping="AtTop" default="yes">
    <sheetref sheet="standard1"/>
    <sheetref sheet="standard2"/>
    </dossier_sheet>
  </dossier>