XML Attributes in Data Files - Revision history

Rob at 05:09, 4 December 2008

2008-12-04T05:09:41Z

← Older revision		Revision as of 05:09, 4 December 2008
Line 1:		Line 1:
	{{context\|Kit Reference~~\|Conventions Used in Reference Section~~}}		{{context\|Kit Reference}}

	All of the information contained within data files is managed through XML elements, attributes, and PCDATA. Each XML element typically has a number of attributes which dictate the characteristics of that element. Some attributes will be required and some will be optional. When an attribute is optional, it will be clearly designated as such, along with the default value. Unless specified as optional, all attributes are required.		All of the information contained within data files is managed through XML elements, attributes, and PCDATA. Each XML element typically has a number of attributes which dictate the characteristics of that element. Some attributes will be required and some will be optional. When an attribute is optional, it will be clearly designated as such, along with the default value. Unless specified as optional, all attributes are required.

Rob at 09:16, 23 November 2008

2008-11-23T09:16:33Z

← Older revision		Revision as of 09:16, 23 November 2008
Line 6:		Line 6:

	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnarrow"\|~~text~~		\|class="leftnarrow"\|Text
	\|Text attributes must always consist of standard ASCII text characters. Unless specified otherwise in the description of the attribute, text attributes have no additional constraints other than those dictated by the use of the attribute’s contents. For example, a text attribute that specifies a file name needs to comply with the naming rules for files, else attempts to use the file name will fail. Any special constraints are indicated within the attribute description.		\|Text attributes must always consist of standard ASCII text characters. Unless specified otherwise in the description of the attribute, text attributes have no additional constraints other than those dictated by the use of the attribute’s contents. For example, a text attribute that specifies a file name needs to comply with the naming rules for files, else attempts to use the file name will fail. Any special constraints are indicated within the attribute description.
	\|-		\|-
	\|~~integer~~		\|Integer
	\|Integer attributes must specify an integer value. In general, integer attributes will represent positive numbers, although it is valid to specify a negative value when appropriate.		\|Integer attributes must specify an integer value. In general, integer attributes will represent positive numbers, although it is valid to specify a negative value when appropriate.
	\|-		\|-
	\|~~float~~		\|Float
	\|Float attributes must specify a floating point value (e.g. 3.14159). In general, only positive values are used, although negative values are sometimes allowed. The attribute description will specify any restrictions.		\|Float attributes must specify a floating point value (e.g. 3.14159). In general, only positive values are used, although negative values are sometimes allowed. The attribute description will specify any restrictions.
	\|-		\|-
	\|~~boolean~~		\|Boolean
	\|Boolean attributes must specify a value of either “yes” or “no”. The name of the Boolean attribute will typically give a clear indication of the meaning of “yes” or “no”. For example, tag groups have a “visible” attribute, where the meanings of “yes” and “no” are clear.		\|Boolean attributes must specify a value of either “yes” or “no”. The name of the Boolean attribute will typically give a clear indication of the meaning of “yes” or “no”. For example, tag groups have a “visible” attribute, where the meanings of “yes” and “no” are clear.
	\|-		\|-
	\|id		\|Id
	\|Ids represent the unique id of an object. The rules for [[Unique Ids]] are outlined separately.		\|Ids represent the unique id of an object. The rules for [[Unique Ids]] are outlined separately.
	\|-		\|-
	\|~~set~~		\|Set
	\|Set-based attributes must specify one of an explicit set of values. Boolean attributes are an example of a set-based attribute, wherein the value must be specified as one of the two valid choices: “yes” and “no”. Set-based attributes will specify the valid values and their meanings.		\|Set-based attributes must specify one of an explicit set of values. Boolean attributes are an example of a set-based attribute, wherein the value must be specified as one of the two valid choices: “yes” and “no”. Set-based attributes will specify the valid values and their meanings.
	\|-		\|-

Rob at 09:47, 22 November 2008

2008-11-22T09:47:31Z

← Older revision		Revision as of 09:47, 22 November 2008
Line 1:		Line 1:
	{{context\|Kit Reference\|~~XML Files~~}}		{{context\|Kit Reference\|Conventions Used in Reference Section}}

	All of the information contained within data files is managed through XML elements, attributes, and PCDATA. Each XML element typically has a number of attributes which dictate the characteristics of that element. Some attributes will be required and some will be optional. When an attribute is optional, it will be clearly designated as such, along with the default value. Unless specified as optional, all attributes are required.		All of the information contained within data files is managed through XML elements, attributes, and PCDATA. Each XML element typically has a number of attributes which dictate the characteristics of that element. Some attributes will be required and some will be optional. When an attribute is optional, it will be clearly designated as such, along with the default value. Unless specified as optional, all attributes are required.

Rob at 09:38, 22 November 2008

2008-11-22T09:38:11Z

← Older revision		Revision as of 09:38, 22 November 2008
Line 1:		Line 1:
	{{context\|~~Basic Concepts and Terminology~~\|XML Files}}		{{context\|Kit Reference\|XML Files}}

	All of the information contained within data files is managed through XML elements, attributes, and PCDATA. Each XML element typically has a number of attributes which dictate the characteristics of that element. Some attributes will be required and some will be optional. When an attribute is optional, it will be clearly designated as such, along with the default value. Unless specified as optional, all attributes are required.		All of the information contained within data files is managed through XML elements, attributes, and PCDATA. Each XML element typically has a number of attributes which dictate the characteristics of that element. Some attributes will be required and some will be optional. When an attribute is optional, it will be clearly designated as such, along with the default value. Unless specified as optional, all attributes are required.

Rob at 07:03, 22 November 2008

2008-11-22T07:03:35Z

← Older revision		Revision as of 07:03, 22 November 2008
Line 1:		Line 1:
	~~[[Category:~~Basic Concepts and Terminology]]		{{context\|Basic Concepts and Terminology\|XML Files}}
	~~[Context: [[Home~~\|~~HL Kit]] [[Basic Concepts and Terminology]] [[~~XML Files~~]]]~~

	All of the information contained within data files is managed through XML elements, attributes, and PCDATA. Each XML element typically has a number of attributes which dictate the characteristics of that element. Some attributes will be required and some will be optional. When an attribute is optional, it will be clearly designated as such, along with the default value. Unless specified as optional, all attributes are required.		All of the information contained within data files is managed through XML elements, attributes, and PCDATA. Each XML element typically has a number of attributes which dictate the characteristics of that element. Some attributes will be required and some will be optional. When an attribute is optional, it will be clearly designated as such, along with the default value. Unless specified as optional, all attributes are required.

Rob at 13:57, 21 November 2008

2008-11-21T13:57:10Z

← Older revision		Revision as of 13:57, 21 November 2008
Line 27:		Line 27:
	\|}		\|}

	~~'''NOTE!'''~~ Many attributes of type "text" will have an appropriate maximum length specified in their description. It is perfectly valid to specify a value that exceeds the indicated maximum within an XML file, since XML imposes no constraints. However, if you exceed the designated maximum length for a text attribute, HL will either report an error or simply truncate the text to the maximum length allowed (depending on the context). This can potentially yield unintended results, so be careful when specifying text attributes. Some text attributes have no maximum length, in which case HL will utilize whatever you specify for the attribute.		{{note}}Many attributes of type "text" will have an appropriate maximum length specified in their description. It is perfectly valid to specify a value that exceeds the indicated maximum within an XML file, since XML imposes no constraints. However, if you exceed the designated maximum length for a text attribute, HL will either report an error or simply truncate the text to the maximum length allowed (depending on the context). This can potentially yield unintended results, so be careful when specifying text attributes. Some text attributes have no maximum length, in which case HL will utilize whatever you specify for the attribute.

Colen at 01:41, 19 November 2008

2008-11-19T01:41:47Z

← Older revision		Revision as of 01:41, 19 November 2008
Line 20:		Line 20:
	\|-		\|-
	\|id		\|id
	\|Ids represent the unique id of an object. The rules for [[~~unique ids~~]] are outlined separately.		\|Ids represent the unique id of an object. The rules for [[Unique Ids]] are outlined separately.
	\|-		\|-
	\|set		\|set

Rob at 23:46, 15 November 2008

2008-11-15T23:46:52Z

← Older revision		Revision as of 23:46, 15 November 2008
Line 7:		Line 7:

	:{\| class="infotable"		:{\| class="infotable"
	\|class="~~leftnormal~~"\|text		\|class="leftnarrow"\|text
	\|Text attributes must always consist of standard ASCII text characters. Unless specified otherwise in the description of the attribute, text attributes have no additional constraints other than those dictated by the use of the attribute’s contents. For example, a text attribute that specifies a file name needs to comply with the naming rules for files, else attempts to use the file name will fail. Any special constraints are indicated within the attribute description.		\|Text attributes must always consist of standard ASCII text characters. Unless specified otherwise in the description of the attribute, text attributes have no additional constraints other than those dictated by the use of the attribute’s contents. For example, a text attribute that specifies a file name needs to comply with the naming rules for files, else attempts to use the file name will fail. Any special constraints are indicated within the attribute description.
	\|-		\|-

Rob at 23:35, 15 November 2008

2008-11-15T23:35:45Z

← Older revision		Revision as of 23:35, 15 November 2008
Line 6:		Line 6:
	The XML specification allows attributes to represent virtually anything with a text value. However, the Kit differentiates between various types of attributes, each of which has various rules associated with the values it can be assigned. Within the [[Kit Reference]], each attribute’s type will be specified in its description. The following types of attributes are utilized, with the indicated constraints being imposed.		The XML specification allows attributes to represent virtually anything with a text value. However, the Kit differentiates between various types of attributes, each of which has various rules associated with the values it can be assigned. Within the [[Kit Reference]], each attribute’s type will be specified in its description. The following types of attributes are utilized, with the indicated constraints being imposed.

	:{\| class="infotable~~" border="1" cellspacing="0~~"		:{\| class="infotable"
	\|class="~~infoleft~~"\|text		\|class="leftnormal"\|text
	~~\|class="infotext"~~\|Text attributes must always consist of standard ASCII text characters. Unless specified otherwise in the description of the attribute, text attributes have no additional constraints other than those dictated by the use of the attribute’s contents. For example, a text attribute that specifies a file name needs to comply with the naming rules for files, else attempts to use the file name will fail. Any special constraints are indicated within the attribute description.		\|Text attributes must always consist of standard ASCII text characters. Unless specified otherwise in the description of the attribute, text attributes have no additional constraints other than those dictated by the use of the attribute’s contents. For example, a text attribute that specifies a file name needs to comply with the naming rules for files, else attempts to use the file name will fail. Any special constraints are indicated within the attribute description.
	\|-		\|-
	~~\|class="infoleft"~~\|integer		\|integer
	~~\|class="infotext"~~\|Integer attributes must specify an integer value. In general, integer attributes will represent positive numbers, although it is valid to specify a negative value when appropriate.		\|Integer attributes must specify an integer value. In general, integer attributes will represent positive numbers, although it is valid to specify a negative value when appropriate.
	\|-		\|-
	~~\|class="infoleft"~~\|float		\|float
	~~\|class="infotext"~~\|Float attributes must specify a floating point value (e.g. 3.14159). In general, only positive values are used, although negative values are sometimes allowed. The attribute description will specify any restrictions.		\|Float attributes must specify a floating point value (e.g. 3.14159). In general, only positive values are used, although negative values are sometimes allowed. The attribute description will specify any restrictions.
	\|-		\|-
	~~\|class="infoleft"~~\|boolean		\|boolean
	~~\|class="infotext"~~\|Boolean attributes must specify a value of either “yes” or “no”. The name of the Boolean attribute will typically give a clear indication of the meaning of “yes” or “no”. For example, tag groups have a “visible” attribute, where the meanings of “yes” and “no” are clear.		\|Boolean attributes must specify a value of either “yes” or “no”. The name of the Boolean attribute will typically give a clear indication of the meaning of “yes” or “no”. For example, tag groups have a “visible” attribute, where the meanings of “yes” and “no” are clear.
	\|-		\|-
	~~\|class="infoleft"~~\|id		\|id
	~~\|class="infotext"~~\|Ids represent the unique id of an object. The rules for [[unique ids]] are outlined separately.		\|Ids represent the unique id of an object. The rules for [[unique ids]] are outlined separately.
	\|-		\|-
	~~\|class="infoleft"~~\|set		\|set
	~~\|class="infotext"~~\|Set-based attributes must specify one of an explicit set of values. Boolean attributes are an example of a set-based attribute, wherein the value must be specified as one of the two valid choices: “yes” and “no”. Set-based attributes will specify the valid values and their meanings.		\|Set-based attributes must specify one of an explicit set of values. Boolean attributes are an example of a set-based attribute, wherein the value must be specified as one of the two valid choices: “yes” and “no”. Set-based attributes will specify the valid values and their meanings.
	\|-		\|-
	\|}		\|}

	'''NOTE!''' Many attributes of type "text" will have an appropriate maximum length specified in their description. It is perfectly valid to specify a value that exceeds the indicated maximum within an XML file, since XML imposes no constraints. However, if you exceed the designated maximum length for a text attribute, HL will either report an error or simply truncate the text to the maximum length allowed (depending on the context). This can potentially yield unintended results, so be careful when specifying text attributes. Some text attributes have no maximum length, in which case HL will utilize whatever you specify for the attribute.		'''NOTE!''' Many attributes of type "text" will have an appropriate maximum length specified in their description. It is perfectly valid to specify a value that exceeds the indicated maximum within an XML file, since XML imposes no constraints. However, if you exceed the designated maximum length for a text attribute, HL will either report an error or simply truncate the text to the maximum length allowed (depending on the context). This can potentially yield unintended results, so be careful when specifying text attributes. Some text attributes have no maximum length, in which case HL will utilize whatever you specify for the attribute.

Rob at 11:05, 15 November 2008

2008-11-15T11:05:17Z

← Older revision		Revision as of 11:05, 15 November 2008
Line 1:		Line 1:
	[[Category:Basic Concepts and Terminology]]		[[Category:Basic Concepts and Terminology]]
	[Context: [[Home\|~~HLKit~~]] [[Basic Concepts and Terminology]] [[XML Files]]]		[Context: [[Home\|HL Kit]] [[Basic Concepts and Terminology]] [[XML Files]]]

	All of the information contained within data files is managed through XML elements, attributes, and PCDATA. Each XML element typically has a number of attributes which dictate the characteristics of that element. Some attributes will be required and some will be optional. When an attribute is optional, it will be clearly designated as such, along with the default value. Unless specified as optional, all attributes are required.		All of the information contained within data files is managed through XML elements, attributes, and PCDATA. Each XML element typically has a number of attributes which dictate the characteristics of that element. Some attributes will be required and some will be optional. When an attribute is optional, it will be clearly designated as such, along with the default value. Unless specified as optional, all attributes are required.