Release Element (Data) - Revision history

Rob at 00:19, 24 November 2008

2008-11-24T00:19:04Z

← Older revision		Revision as of 00:19, 24 November 2008
Line 1:		Line 1:
	{{context\|Kit Reference\|Definition File Reference}}		{{context\|Kit Reference\|Definition File Reference}}

			==The "release" Element==

	All details pertaining to the current release of the data files can be found here. The XML element name used is "release" and the complete list of attributes is below.		All details pertaining to the current release of the data files can be found here. The XML element name used is "release" and the complete list of attributes is below.

Rob at 22:34, 23 November 2008

2008-11-23T22:34:50Z

← Older revision		Revision as of 22:34, 23 November 2008
Line 14:		Line 14:
	\|-		\|-
	\|summary		\|summary
	\|(Optional) Text – Arbitrary text used as release summary notes to display to the user. This summary is used by the HLExport tool when packaging up your data files for distribution to other users. No maximum length. Default: Empty.		\|(Optional) Text – Arbitrary text used as release summary notes to display to the user. This summary is used by the [[Using the HLExport Tool\|HLExport tool]] when packaging up your data files for distribution to other users. No maximum length. Default: Empty.
	\|-		\|-
	\|PCDATA		\|PCDATA

Rob at 22:32, 23 November 2008

2008-11-23T22:32:54Z

← Older revision		Revision as of 22:32, 23 November 2008
Line 5:		Line 5:
	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|major		\|class="leftnormal"\|major
	\|Integer – Major version number assigned to the release. Must be between 0-255.		\|Integer – [[Version Numbers for Data Files\|Major version number]] assigned to the release. Must be between 0-255.
	\|-		\|-
	\|minor		\|minor
	\|Integer – Minor version number assigned to the release. Must be between 0-255.		\|Integer – [[Version Numbers for Data Files\|Minor version number]] assigned to the release. Must be between 0-255.
	\|-		\|-
	\|required		\|required

Rob at 22:31, 23 November 2008

2008-11-23T22:31:57Z

← Older revision		Revision as of 22:31, 23 November 2008
Line 17:		Line 17:
	\|-		\|-
	\|PCDATA		\|PCDATA
	\|(Optional) Text – Detailed release notes for the data files can be specified within the PCDATA block of the element. These release notes will be displayed to the user every time the data files are re-compiled and then loaded. This is an ideal place to inform users about the status of the data files, new capabilities that have been added, and where to get answers to questions about using the data files.		\|(Optional) Text – Detailed [[Importance of Release Notes\|release notes for the data files]] can be specified within the PCDATA block of the element. These release notes will be displayed to the user every time the data files are re-compiled and then loaded. This is an ideal place to inform users about the status of the data files, new capabilities that have been added, and where to get answers to questions about using the data files.
	\|-		\|-
	\|}		\|}

Rob at 22:30, 23 November 2008

2008-11-23T22:30:13Z

← Older revision		Revision as of 22:30, 23 November 2008
Line 11:		Line 11:
	\|-		\|-
	\|required		\|required
	\|(Optional) Text – Specifies the minimum version of ~~Hero Lab~~ required to utilize these data files. The version is given in the exact same format displayed by the product when the "About Hero Lab" option is selected under the "Help" menu (e.g. “2.3a"). In some situations, a set of data files will be designed that assume the availability of specific functionality offered by a particular version of the HL engine. If this occurs, the minimum required product version can be dictated. If empty, no requirements are enforced and the data files are assumed to work with all versions of the product. Default: Empty.		\|(Optional) Text – Specifies the [[Relying on Minimum Product Features\|minimum version of HL required]] to utilize these data files. The version is given in the exact same format displayed by the product when the "About Hero Lab" option is selected under the "Help" menu (e.g. “2.3a"). If empty, no requirements are enforced and the data files are assumed to work with all versions of the product. Default: Empty.
	\|-		\|-
	\|summary		\|summary

Rob at 03:54, 23 November 2008

2008-11-23T03:54:41Z

← Older revision		Revision as of 03:54, 23 November 2008
Line 20:		Line 20:
	\|-		\|-
	\|}		\|}

			==Example==

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

			<pre>
			<release
			major="2"
			minor="1"
			summary="Release summary here"><![CDATA[These are the actual release notes.
			]]></release>
			</pre>

Rob at 01:09, 23 November 2008

2008-11-23T01:09:22Z

← Older revision		Revision as of 01:09, 23 November 2008
Line 14:		Line 14:
	\|-		\|-
	\|summary		\|summary
	\|(Optional) Text – Arbitrary text used as release summary notes to display to the user. No maximum length. Default: Empty.		\|(Optional) Text – Arbitrary text used as release summary notes to display to the user. This summary is used by the HLExport tool when packaging up your data files for distribution to other users. No maximum length. Default: Empty.
			\|-
			\|PCDATA
			\|(Optional) Text – Detailed release notes for the data files can be specified within the PCDATA block of the element. These release notes will be displayed to the user every time the data files are re-compiled and then loaded. This is an ideal place to inform users about the status of the data files, new capabilities that have been added, and where to get answers to questions about using the data files.
	\|-		\|-
	\|}		\|}

	~~In addition to the above~~

Rob: New page: {{context|Kit Reference|Definition File Reference}} All details pertaining to the current release of the data files can be found here. The XML element name used is "release" and the compl...

2008-11-23T00:38:58Z

New page: {{context|Kit Reference|Definition File Reference}} All details pertaining to the current release of the data files can be found here. The XML element name used is "release" and the compl...

New page

{{context|Kit Reference|Definition File Reference}}

All details pertaining to the current release of the data files can be found here. The XML element name used is "release" and the complete list of attributes is below.

:{| class="infotable"
|class="leftnormal"|major
|Integer – Major version number assigned to the release. Must be between 0-255.
|-
|minor
|Integer – Minor version number assigned to the release. Must be between 0-255.
|-
|required
|(Optional) Text – Specifies the minimum version of Hero Lab required to utilize these data files. The version is given in the exact same format displayed by the product when the "About Hero Lab" option is selected under the "Help" menu (e.g. “2.3a"). In some situations, a set of data files will be designed that assume the availability of specific functionality offered by a particular version of the HL engine. If this occurs, the minimum required product version can be dictated. If empty, no requirements are enforced and the data files are assumed to work with all versions of the product. Default: Empty.
|-
|summary
|(Optional) Text – Arbitrary text used as release summary notes to display to the user. No maximum length. Default: Empty.
|-
|}

In addition to the above