Dossier Element (Data) - Revision history

Colen at 16:20, 13 May 2009

2009-05-13T16:20:33Z

← Older revision		Revision as of 16:20, 13 May 2009
Line 7:		Line 7:
	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|id		\|class="leftnormal"\|id
	\|Id – Specifies the unique id of the dossier. This id is used in all references to the dossier.		\|Id – Specifies the unique id of the dossier. This id is used in all references to the dossier. When the dossier is being rendered, a global tag "dossier.<this id>" is added to the portfolio allow you to see which dossier is being rendered.
	\|-		\|-
	\|name		\|name
Line 172:		Line 172:
	</dossier>		</dossier>
	</pre>		</pre>

			When the "standard" dossier is being rendered, the global tag "dossier.standard" is added to the portfolio. When the "statblock" dossier is being synthesized, the global tag "dossier.statblock" is added to the portfolio.

Rob at 23:22, 3 December 2008

2008-12-03T23:22:26Z

← Older revision		Revision as of 23:22, 3 December 2008
Line 54:		Line 54:
	\|}		\|}

	===The "live" Element ~~(of "dossier_sheet")~~{{anchor\|live_sheet}}===		===The "live" Element{{anchor\|live_sheet}}===

	The "live" element defines a [[Live Tag Expression]] for the dossier, which determines whether the dossier is shown to the user as a selection. The tag expression is compared against the tags assigned to the current actor. If the tag expression is satisfied, the dossier can be output, else it is hidden. This is ideal for situations like spellbooks that should only be shown for spellcasters. The complete list of attributes for this element is below.		The "live" element defines a [[Live Tag Expression]] for the dossier, which determines whether the dossier is shown to the user as a selection. The tag expression is compared against the tags assigned to the current actor. If the tag expression is satisfied, the dossier can be output, else it is hidden. This is ideal for situations like spellbooks that should only be shown for spellcasters. The complete list of attributes for this element is below.
Line 64:		Line 64:
	\|}		\|}

	===The "sheetref" Element ~~(of "dossier_sheet")~~{{anchor\|sheetref}}===		===The "sheetref" Element{{anchor\|sheetref}}===

	The "sheetref" element specifies a sheet to be output as part of the dossier. The sequence in which the sheets are specified dictates the order in which they will be processed in the output. The complete list of attributes for this element is below.		The "sheetref" element specifies a sheet to be output as part of the dossier. The sequence in which the sheets are specified dictates the order in which they will be processed in the output. The complete list of attributes for this element is below.
Line 101:		Line 101:
	\|}		\|}

	===The "live" Element ~~(of "dossier_text")~~{{anchor\|live_text}}===		===The "live" Element{{anchor\|live_text}}===

	The "live" element defines a [[Live Tag Expression]] for the dossier, which determines whether the dossier is shown to the user as a selection. The tag expression is compared against the tags assigned to the current actor. If the tag expression is satisfied, the dossier can be output, else it is hidden. This is ideal for situations like spellbooks that should only be shown for spellcasters. The complete list of attributes for this element is below.		The "live" element defines a [[Live Tag Expression]] for the dossier, which determines whether the dossier is shown to the user as a selection. The tag expression is compared against the tags assigned to the current actor. If the tag expression is satisfied, the dossier can be output, else it is hidden. This is ideal for situations like spellbooks that should only be shown for spellcasters. The complete list of attributes for this element is below.
Line 111:		Line 111:
	\|}		\|}

	===The "synthesize" Element ~~(of "dossier_text")~~{{anchor\|synthesize_text}}===		===The "synthesize" Element{{anchor\|synthesize_text}}===

	The "synthesize" element defines a [[Synthesize Script]] for the dossier, which properly generates the text to be output as the dossier. If multiple synthesize scripts are defined, their generated results are appended into one final text stream for output. The complete list of attributes for this element is below.		The "synthesize" element defines a [[Synthesize Script]] for the dossier, which properly generates the text to be output as the dossier. If multiple synthesize scripts are defined, their generated results are appended into one final text stream for output. The complete list of attributes for this element is below.
Line 142:		Line 142:
	\|}		\|}

	===The "synthesize" Element ~~(of "dossier_text")~~{{anchor\|synthesize_export}}===		===The "synthesize" Element{{anchor\|synthesize_export}}===

	The "synthesize" element defines a [[Synthesize Script]] for the dossier, which properly generates the text to be output as the dossier. If multiple synthesize scripts are defined, their generated results are appended into one final text stream for output. The complete list of attributes for this element is below.		The "synthesize" element defines a [[Synthesize Script]] for the dossier, which properly generates the text to be output as the dossier. If multiple synthesize scripts are defined, their generated results are appended into one final text stream for output. The complete list of attributes for this element is below.

Rob at 23:21, 3 December 2008

2008-12-03T23:21:09Z

← Older revision		Revision as of 23:21, 3 December 2008
Line 111:		Line 111:
	\|}		\|}

	==The "synthesize" Element (of "dossier_text"){{anchor\|synthesize_text}}==		===The "synthesize" Element (of "dossier_text"){{anchor\|synthesize_text}}===

	The "synthesize" element defines a [[Synthesize Script]] for the dossier, which properly generates the text to be output as the dossier. If multiple synthesize scripts are defined, their generated results are appended into one final text stream for output. The complete list of attributes for this element is below.		The "synthesize" element defines a [[Synthesize Script]] for the dossier, which properly generates the text to be output as the dossier. If multiple synthesize scripts are defined, their generated results are appended into one final text stream for output. The complete list of attributes for this element is below.
Line 142:		Line 142:
	\|}		\|}

	==The "synthesize" Element (of "dossier_text"){{anchor\|synthesize_export}}==		===The "synthesize" Element (of "dossier_text"){{anchor\|synthesize_export}}===

	The "synthesize" element defines a [[Synthesize Script]] for the dossier, which properly generates the text to be output as the dossier. If multiple synthesize scripts are defined, their generated results are appended into one final text stream for output. The complete list of attributes for this element is below.		The "synthesize" element defines a [[Synthesize Script]] for the dossier, which properly generates the text to be output as the dossier. If multiple synthesize scripts are defined, their generated results are appended into one final text stream for output. The complete list of attributes for this element is below.

Rob at 23:16, 3 December 2008

2008-12-03T23:16:59Z

← Older revision		Revision as of 23:16, 3 December 2008
Line 54:		Line 54:
	\|}		\|}

	===The "live" Element of "dossier_sheet"{{anchor\|live_sheet}}===		===The "live" Element (of "dossier_sheet"){{anchor\|live_sheet}}===

	The "live" element defines a [[Live Tag Expression]] for the dossier, which determines whether the dossier is shown to the user as a selection. The tag expression is compared against the tags assigned to the current actor. If the tag expression is satisfied, the dossier can be output, else it is hidden. This is ideal for situations like spellbooks that should only be shown for spellcasters. The complete list of attributes for this element is below.		The "live" element defines a [[Live Tag Expression]] for the dossier, which determines whether the dossier is shown to the user as a selection. The tag expression is compared against the tags assigned to the current actor. If the tag expression is satisfied, the dossier can be output, else it is hidden. This is ideal for situations like spellbooks that should only be shown for spellcasters. The complete list of attributes for this element is below.
Line 64:		Line 64:
	\|}		\|}

	===The "sheetref" Element of "dossier_sheet"{{anchor\|sheetref}}===		===The "sheetref" Element (of "dossier_sheet"){{anchor\|sheetref}}===

	The "sheetref" element specifies a sheet to be output as part of the dossier. The sequence in which the sheets are specified dictates the order in which they will be processed in the output. The complete list of attributes for this element is below.		The "sheetref" element specifies a sheet to be output as part of the dossier. The sequence in which the sheets are specified dictates the order in which they will be processed in the output. The complete list of attributes for this element is below.
Line 101:		Line 101:
	\|}		\|}

	===The "live" Element of "dossier_text"{{anchor\|live_text}}===		===The "live" Element (of "dossier_text"){{anchor\|live_text}}===

	The "live" element defines a [[Live Tag Expression]] for the dossier, which determines whether the dossier is shown to the user as a selection. The tag expression is compared against the tags assigned to the current actor. If the tag expression is satisfied, the dossier can be output, else it is hidden. This is ideal for situations like spellbooks that should only be shown for spellcasters. The complete list of attributes for this element is below.		The "live" element defines a [[Live Tag Expression]] for the dossier, which determines whether the dossier is shown to the user as a selection. The tag expression is compared against the tags assigned to the current actor. If the tag expression is satisfied, the dossier can be output, else it is hidden. This is ideal for situations like spellbooks that should only be shown for spellcasters. The complete list of attributes for this element is below.
Line 111:		Line 111:
	\|}		\|}

	==The "synthesize" Element of "dossier_text"{{anchor\|synthesize_text}}==		==The "synthesize" Element (of "dossier_text"){{anchor\|synthesize_text}}==

	The "synthesize" element defines a [[Synthesize Script]] for the dossier, which properly generates the text to be output as the dossier. If multiple synthesize scripts are defined, their generated results are appended into one final text stream for output. The complete list of attributes for this element is below.		The "synthesize" element defines a [[Synthesize Script]] for the dossier, which properly generates the text to be output as the dossier. If multiple synthesize scripts are defined, their generated results are appended into one final text stream for output. The complete list of attributes for this element is below.
Line 142:		Line 142:
	\|}		\|}

	==The "synthesize" Element of "dossier_text"{{anchor\|synthesize_export}}==		==The "synthesize" Element (of "dossier_text"){{anchor\|synthesize_export}}==

	The "synthesize" element defines a [[Synthesize Script]] for the dossier, which properly generates the text to be output as the dossier. If multiple synthesize scripts are defined, their generated results are appended into one final text stream for output. The complete list of attributes for this element is below.		The "synthesize" element defines a [[Synthesize Script]] for the dossier, which properly generates the text to be output as the dossier. If multiple synthesize scripts are defined, their generated results are appended into one final text stream for output. The complete list of attributes for this element is below.

Rob at 23:15, 3 December 2008

2008-12-03T23:15:44Z

@@ Line 96: / Line 96: @@
 |An optional "live" element may appear as defined by the given link. This element defines a [[Live Tag Expression]] that determines whether the dossier is made available for selection.
 |-
-|[[#synthesize|synthesize]]
+|[[#synthesize_text|synthesize]]
 |Zero or more "synthesize" elements may appear as defined by the given link. This element defines the [[Synthesize Script]] used to generate the text to be output.
 |-
@@ Line 112: / Line 112: @@
 ==The "synthesize" Element of "dossier_text"{{anchor|synthesize_text}}==
 The "synthesize" element defines a [[Synthesize Script]] for the dossier, which properly generates the text to be output as the dossier. If multiple synthesize scripts are defined, their generated results are appended into one final text stream for output. The complete list of attributes for this element is below.
@@ Line 131: / Line 162: @@
      <sheetref sheet="standard2"/>
      </dossier_sheet>
    </dossier>
 </pre>

Rob at 23:06, 3 December 2008

2008-12-03T23:06:37Z

← Older revision		Revision as of 23:06, 3 December 2008
Line 46:		Line 46:

	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|[[#~~live~~\|live]]		\|class="leftnormal"\|[[#live_sheet\|live]]
	\|An optional "live" element may appear as defined by the given link. This element defines a [[Live Tag Expression]] that determines whether the dossier is made available for selection.		\|An optional "live" element may appear as defined by the given link. This element defines a [[Live Tag Expression]] that determines whether the dossier is made available for selection.
	\|-		\|-
Line 54:		Line 54:
	\|}		\|}

	===The "live" Element of "dossier_sheet"{{anchor\|~~live~~}}===		===The "live" Element of "dossier_sheet"{{anchor\|live_sheet}}===

	The "live" element defines a [[Live Tag Expression]] for the dossier, which determines whether the dossier is shown to the user as a selection. The tag expression is compared against the tags assigned to the current actor. If the tag expression is satisfied, the dossier can be output, else it is hidden. This is ideal for situations like spellbooks that should only be shown for spellcasters. The complete list of attributes for this element is below.		The "live" element defines a [[Live Tag Expression]] for the dossier, which determines whether the dossier is shown to the user as a selection. The tag expression is compared against the tags assigned to the current actor. If the tag expression is satisfied, the dossier can be output, else it is hidden. This is ideal for situations like spellbooks that should only be shown for spellcasters. The complete list of attributes for this element is below.
Line 93:		Line 93:

	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|[[#~~live~~\|live]]		\|class="leftnormal"\|[[#live_text\|live]]
	\|An optional "live" element may appear as defined by the given link. This element defines a [[Live Tag Expression]] that determines whether the dossier is made available for selection.		\|An optional "live" element may appear as defined by the given link. This element defines a [[Live Tag Expression]] that determines whether the dossier is made available for selection.
	\|-		\|-
Line 101:		Line 101:
	\|}		\|}

	===The "live" Element of "~~dossier_sheet~~"{{anchor\|~~live~~}}===		===The "live" Element of "dossier_text"{{anchor\|live_text}}===

	The "live" element defines a [[Live Tag Expression]] for the dossier, which determines whether the dossier is shown to the user as a selection. The tag expression is compared against the tags assigned to the current actor. If the tag expression is satisfied, the dossier can be output, else it is hidden. This is ideal for situations like spellbooks that should only be shown for spellcasters. The complete list of attributes for this element is below.		The "live" element defines a [[Live Tag Expression]] for the dossier, which determines whether the dossier is shown to the user as a selection. The tag expression is compared against the tags assigned to the current actor. If the tag expression is satisfied, the dossier can be output, else it is hidden. This is ideal for situations like spellbooks that should only be shown for spellcasters. The complete list of attributes for this element is below.
Line 111:		Line 111:
	\|}		\|}

	===The "~~sheetref~~" Element of "~~dossier_sheet~~"{{anchor\|~~sheetref}}===~~		==The "synthesize" Element of "dossier_text"{{anchor\|synthesize_text}}==

	The "sheetref" element specifies a sheet to be output as part of the dossier. The sequence in which the sheets are specified dictates the order in which they will be processed in the output. The complete list of attributes for this element is below.

	~~:{\| class="infotable"~~
	~~\|class="leftnormal"\|sheet~~
	~~\|Id – Specifies the unique id of the sheet to be included in the dossier output.~~
	\|-
	\|}


	~~==The "position" Element{{anchor\|position~~}}==

	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.		The "synthesize" element defines a [[Synthesize Script]] for the dossier, which properly generates the text to be output as the dossier. If multiple synthesize scripts are defined, their generated results are appended into one final text stream for output. The complete list of attributes for this element is below.

	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|PCDATA		\|class="leftnormal"\|PCDATA
	\|Script – Specifies the code comprising the ~~Position~~ script.		\|Script – Specifies the code comprising the Synthesize script.
	\|-		\|-
	\|}		\|}

Rob at 23:02, 3 December 2008

2008-12-03T23:02:15Z

@@ Line 39: / Line 39: @@
 |-
 |default
-|(Optional) Boolean – Indicates whether this dossier should be the default dossier that is pre-selected for the user when first outputting a dossier. Default: "no".
+|(Optional) Boolean – Indicates whether this dossier should be the default dossier that is pre-selected for the user when first outputting a printed dossier. Default: "no".
 |-
 |}
@@ Line 54: / Line 54: @@
 |}
-===The "live" Element{{anchor|live}}===
+===The "live" Element of "dossier_sheet"{{anchor|live}}===
 The "live" element defines a [[Live Tag Expression]] for the dossier, which determines whether the dossier is shown to the user as a selection. The tag expression is compared against the tags assigned to the current actor. If the tag expression is satisfied, the dossier can be output, else it is hidden. This is ideal for situations like spellbooks that should only be shown for spellcasters. The complete list of attributes for this element is below.
@@ Line 64: / Line 64: @@
 |}
-===The "sheetref" Element{{anchor|sheetref}}===
+===The "sheetref" Element of "dossier_sheet"{{anchor|sheetref}}===
 The "sheetref" element specifies a sheet to be output as part of the dossier. The sequence in which the sheets are specified dictates the order in which they will be processed in the output. The complete list of attributes for this element is below.

Rob at 22:51, 3 December 2008

2008-12-03T22:51:09Z

← Older revision		Revision as of 22:51, 3 December 2008
Line 23:		Line 23:
	\|-		\|-
	\|[[#dossier_text\|dossier_text]]		\|[[#dossier_text\|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.		\|An optional "dossier_text" element may appear as defined by the given link. This element specifies text-based output, such as a statblock.
	\|-		\|-
	\|[[#dossier_export\|dossier_export]]		\|[[#dossier_export\|dossier_export]]
Line 32:		Line 32:
	==The "dossier_sheet" Element{{anchor\|dossier_sheet}}==		==The "dossier_sheet" Element{{anchor\|dossier_sheet}}==

	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.		The "dossier_sheet" element defines the structure of a printed dossier, containing a collection of sheets. The complete list of attributes for this element is below.

	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|~~layout~~		\|class="leftnormal"\|grouping
	\|Id – ~~Unique id~~ of the ~~layout~~ to ~~be utilized within~~ the ~~sheet~~.		\|Text – Specifies the name of the group into which this dossier should be placed for display. The groupings are used to logically organize multiple dossiers for presentation to the user, with the various groupings being sorted alphabetically.
	\|-		\|-
	\|~~reference~~		\|default
	\|(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~~.		\|(Optional) Boolean – Indicates whether this dossier should be the default dossier that is pre-selected for the user when first outputting a dossier. Default: "no".
	\|-		\|-
	\|}		\|}

			The "dossier_sheet" element also possesses child elements that describe its contents. 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.

			:{\| class="infotable"
			\|class="leftnormal"\|[[#live\|live]]
			\|An optional "live" element may appear as defined by the given link. This element defines a [[Live Tag Expression]] that determines whether the dossier is made available for selection.
			\|-
			\|[[#sheetref\|sheetref]]
			\|Zero or more "sheetref" elements may appear as defined by the given link. This element identifies a sheet to be included in the dossier output.
			\|-
			\|}

			===The "live" Element{{anchor\|live}}===

			The "live" element defines a [[Live Tag Expression]] for the dossier, which determines whether the dossier is shown to the user as a selection. The tag expression is compared against the tags assigned to the current actor. If the tag expression is satisfied, the dossier can be output, else it is hidden. This is ideal for situations like spellbooks that should only be shown for spellcasters. The complete list of attributes for this element is below.

			:{\| class="infotable"
			\|class="leftnormal"\|PCDATA
			\|TagExpr – Specifies the code comprising the Live tag expression.
			\|-
			\|}

			===The "sheetref" Element{{anchor\|sheetref}}===

			The "sheetref" element specifies a sheet to be output as part of the dossier. The sequence in which the sheets are specified dictates the order in which they will be processed in the output. The complete list of attributes for this element is below.

			:{\| class="infotable"
			\|class="leftnormal"\|sheet
			\|Id – Specifies the unique id of the sheet to be included in the dossier output.
			\|-
			\|}


	==The "position" Element{{anchor\|position}}==		==The "position" Element{{anchor\|position}}==

Rob: New page: {{context|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 expo...

2008-12-03T22:35:23Z

New page: {{context|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 expo...

New page

{{context|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.

:{| class="infotable"
|class="leftnormal"|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.

:{| class="infotable"
|class="leftnormal"|[[#dossier_sheet|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|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|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{{anchor|dossier_sheet}}==

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.

:{| class="infotable"
|class="leftnormal"|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{{anchor|position}}==

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.

:{| class="infotable"
|class="leftnormal"|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.

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