Programmer Guide/Command Reference/IREF - Revision history

Jw: spelling

2017-04-19T09:20:44Z

spelling

← Older revision		Revision as of 11:20, 19 April 2017
Line 27:		Line 27:
	== Selecting an element ==		== Selecting an element ==

	The <code>IREF</code> may also be used for positioning in a file, more precisely: for selecting an XML element identified by either an ''iref'', or by a file position. Note that, since ''iref'' strings start with a slash, ~~extraodinary~~ measures are needed not to have {{STX}} misunderstand an ''iref'' as a (possibly invalid) command option (see below).		The <code>IREF</code> may also be used for positioning in a file, more precisely: for selecting an XML element identified by either an ''iref'', or by a file position. Note that, since ''iref'' strings start with a slash, extraordinary measures are needed not to have {{STX}} misunderstand an ''iref'' as a (possibly invalid) command option (see below).

	IREF /Select [ /Nocase ] [ /Attribute=<var>irefAttr</var> ] [ /Baseposition=<var>basePos</var> ]		IREF /Select [ /Nocase ] [ /Attribute=<var>irefAttr</var> ] [ /Baseposition=<var>basePos</var> ]

Jw: /* Iref of an {{STX}} file position */

2016-01-29T09:10:32Z

Iref of an {{STX}} file position

← Older revision		Revision as of 11:10, 29 January 2016
Line 8:		Line 8:
	Note that the <code>/Format</code> option is mandatory.		Note that the <code>/Format</code> option is mandatory.

	== ~~Iref~~ of an {{STX}} file position ==		== IREF of an {{STX}} file position ==
	When you supply an {{STX}} [[Programmer Guide/Concepts/File_position\|file position]], <var>position</var>, the <code>IREF</code> command retrieves the ~~iref~~ of the element whose position you supplied:		When you supply an {{STX}} [[Programmer Guide/Concepts/File_position\|file position]], <var>position</var>, the <code>IREF</code> command retrieves the IREF of the element whose position you supplied:
	<var>var</var> := IREF <var>xmlfile</var> /Format <var>position</var>		<var>var</var> := IREF <var>xmlfile</var> /Format <var>position</var>
	[ /Attribute=<var>irefAttr</var> ] [ /Baseposition=<var>basePos</var> ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Ilent]] ]		[ /Attribute=<var>irefAttr</var> ] [ /Baseposition=<var>basePos</var> ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Ilent]] ]

Jw: /* Iref of the currently selected element */

2016-01-29T09:10:04Z

Iref of the currently selected element

← Older revision		Revision as of 11:10, 29 January 2016
Line 2:		Line 2:
	The <code>IREF</code> command returns the [[Programmer Guide/Concepts/IREF\|internal reference]] (<code>IREF</code>) of the currently selected element of the supplied XML [[Programmer_Guide/Shell_Items/File\|file item]], or, if you provide additional element data, the internal reference for the respective element of the supplied XML file item. If this information is not available, or not applicable, the <code>IREF</code> command will return the empty string.		The <code>IREF</code> command returns the [[Programmer Guide/Concepts/IREF\|internal reference]] (<code>IREF</code>) of the currently selected element of the supplied XML [[Programmer_Guide/Shell_Items/File\|file item]], or, if you provide additional element data, the internal reference for the respective element of the supplied XML file item. If this information is not available, or not applicable, the <code>IREF</code> command will return the empty string.

	== ~~Iref~~ of the currently selected element ==		== IREF of the currently selected element ==
	The basic form of the <code>IREF</code> command retrieves the ~~iref~~ of the currently selected element:		The basic form of the <code>IREF</code> command retrieves the IREF of the currently selected element:
	<var>var</var> := IREF <var>xmlfile</var> /Format		<var>var</var> := IREF <var>xmlfile</var> /Format
	[ /Attribute=<var>irefAttr</var> ] [ /Baseposition=<var>basePos</var> ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Ilent]] ]		[ /Attribute=<var>irefAttr</var> ] [ /Baseposition=<var>basePos</var> ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Ilent]] ]

Christian: /* Iref of a {{STX}} file position */

2014-04-25T14:44:15Z

Iref of a {{STX}} file position

← Older revision		Revision as of 16:44, 25 April 2014
Line 8:		Line 8:
	Note that the <code>/Format</code> option is mandatory.		Note that the <code>/Format</code> option is mandatory.

	== Iref of a {{STX}} file position ==		== Iref of an {{STX}} file position ==
	When you supply an {{STX}} [[Programmer Guide/Concepts/File_position\|file position]], <var>position</var>, the <code>IREF</code> command retrieves the iref of the element whose position you supplied:		When you supply an {{STX}} [[Programmer Guide/Concepts/File_position\|file position]], <var>position</var>, the <code>IREF</code> command retrieves the iref of the element whose position you supplied:
	<var>var</var> := IREF <var>xmlfile</var> /Format <var>position</var>		<var>var</var> := IREF <var>xmlfile</var> /Format <var>position</var>

Christian: /* Common Options */

2011-04-11T14:13:46Z

Common Options

← Older revision		Revision as of 16:13, 11 April 2011
Line 47:		Line 47:
	;<code>[[Programmer_Guide/Command_Reference_Options/Silent\|/Ilent]]</code>: The [[Programmer_Guide/Command_Reference_Options/Silent\|silent option]] causes mishaps to be reported as warnings, instead of errors.		;<code>[[Programmer_Guide/Command_Reference_Options/Silent\|/Ilent]]</code>: The [[Programmer_Guide/Command_Reference_Options/Silent\|silent option]] causes mishaps to be reported as warnings, instead of errors.
	;<code>[[Programmer_Guide/Command_Reference_Options/-\|/-]]</code>: With the "[[Programmer_Guide/Command_Reference_Options/-\|end of options]]" option, you tell {{STX}} that there are no further options in the respective line of code. This means that any further arguments will be considered, well, plain arguments, even if they should start with a slash.		;<code>[[Programmer_Guide/Command_Reference_Options/-\|/-]]</code>: With the "[[Programmer_Guide/Command_Reference_Options/-\|end of options]]" option, you tell {{STX}} that there are no further options in the respective line of code. This means that any further arguments will be considered, well, plain arguments, even if they should start with a slash.
	;<code>/Attribute=irefAttributeName</~~code~~>: normally, the attribute storing the ''iref'' path components is called <var>ID</var>. With the <code>/Attribute=</code> option, you may specify a different such attribute.		;<code>/Attribute=</code><var>irefAttributeName</var>: normally, the attribute storing the ''iref'' path components is called <var>ID</var>. With the <code>/Attribute=</code> option, you may specify a different such attribute.
	;<code>/Baseposition=positionOfIrefBaseElement</~~code~~>: normally, an ''iref'' is considered absolute, i.e., starting at the root element of the respective XML file. With the <code>/Baseposition=</code> option, you may specify the position of a different element to be considered the root for the ''iref'' path.		;<code>/Baseposition=</code><var>positionOfIrefBaseElement</var>: normally, an ''iref'' is considered absolute, i.e., starting at the root element of the respective XML file. With the <code>/Baseposition=</code> option, you may specify the position of a different element to be considered the root for the ''iref'' path.

193.171.195.62: /* Common Options */

2011-04-08T16:40:41Z

Common Options

← Older revision		Revision as of 18:40, 8 April 2011
Line 45:		Line 45:
	== Common Options ==		== Common Options ==

	;<code>[[Programmer_Guide/Command_Reference_Options/Silent\|/Ilent]]</code>:		;<code>[[Programmer_Guide/Command_Reference_Options/Silent\|/Ilent]]</code>: The [[Programmer_Guide/Command_Reference_Options/Silent\|silent option]] causes mishaps to be reported as warnings, instead of errors.
	;<code>[[Programmer_Guide/Command_Reference_Options/-\|/-]]</code>:		;<code>[[Programmer_Guide/Command_Reference_Options/-\|/-]]</code>: With the "[[Programmer_Guide/Command_Reference_Options/-\|end of options]]" option, you tell {{STX}} that there are no further options in the respective line of code. This means that any further arguments will be considered, well, plain arguments, even if they should start with a slash.
	;<code>/Attribute=irefAttributeName</code>: normally, the attribute storing the ''iref'' path components is called <var>ID</var>. With the <code>/Attribute=</code> option, you may specify a different such attribute.		;<code>/Attribute=irefAttributeName</code>: normally, the attribute storing the ''iref'' path components is called <var>ID</var>. With the <code>/Attribute=</code> option, you may specify a different such attribute.
	;<code>/Baseposition=positionOfIrefBaseElement</code>: normally, an ''iref'' is considered absolute, i.e., starting at the root element of the respective XML file. With the <code>/Baseposition=</code> option, you may specify the position of a different element to be considered the root for the ''iref'' path.		;<code>/Baseposition=positionOfIrefBaseElement</code>: normally, an ''iref'' is considered absolute, i.e., starting at the root element of the respective XML file. With the <code>/Baseposition=</code> option, you may specify the position of a different element to be considered the root for the ''iref'' path.

193.171.195.62: /* Common Options */

2011-04-08T16:38:18Z

Common Options

← Older revision		Revision as of 18:38, 8 April 2011
Line 45:		Line 45:
	== Common Options ==		== Common Options ==

	* [[Programmer_Guide/Command_Reference_Options/Silent\|/Ilent]]		;<code>[[Programmer_Guide/Command_Reference_Options/Silent\|/Ilent]]</code>:
	* [[Programmer_Guide/Command_Reference_Options/-\|/-]]		;<code>[[Programmer_Guide/Command_Reference_Options/-\|/-]]</code>:
			;<code>/Attribute=irefAttributeName</code>: normally, the attribute storing the ''iref'' path components is called <var>ID</var>. With the <code>/Attribute=</code> option, you may specify a different such attribute.
			;<code>/Baseposition=positionOfIrefBaseElement</code>: normally, an ''iref'' is considered absolute, i.e., starting at the root element of the respective XML file. With the <code>/Baseposition=</code> option, you may specify the position of a different element to be considered the root for the ''iref'' path.

Christian: /* Iref of a {{STX}} file position */

2011-04-08T15:41:18Z

Iref of a {{STX}} file position

← Older revision		Revision as of 17:41, 8 April 2011
Line 9:		Line 9:

	== Iref of a {{STX}} file position ==		== Iref of a {{STX}} file position ==
	; When you supply an {{STX}} [[Programmer Guide/Concepts/File_position\|file position]], <var>position</var>, the <code>IREF</code> command retrieves the iref of the element whose position you supplied:		When you supply an {{STX}} [[Programmer Guide/Concepts/File_position\|file position]], <var>position</var>, the <code>IREF</code> command retrieves the iref of the element whose position you supplied:
	<var>var</var> := IREF <var>xmlfile</var> /Format <var>position</var>		<var>var</var> := IREF <var>xmlfile</var> /Format <var>position</var>
	[ /Attribute=<var>irefAttr</var> ] [ /Baseposition=<var>basePos</var> ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Ilent]] ]		[ /Attribute=<var>irefAttr</var> ] [ /Baseposition=<var>basePos</var> ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Ilent]] ]

Christian: /* Iref of the currently selected element */

2011-04-08T15:40:55Z

Iref of the currently selected element

← Older revision		Revision as of 17:40, 8 April 2011
Line 4:		Line 4:
	== Iref of the currently selected element ==		== Iref of the currently selected element ==
	The basic form of the <code>IREF</code> command retrieves the iref of the currently selected element:		The basic form of the <code>IREF</code> command retrieves the iref of the currently selected element:
	<var>var</var> := IREF <var>xmlfile</var> /Format [ /Attribute=<var>irefAttr</var> ] [ /Baseposition=<var>basePos</var> ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Ilent]] ]		<var>var</var> := IREF <var>xmlfile</var> /Format
			[ /Attribute=<var>irefAttr</var> ] [ /Baseposition=<var>basePos</var> ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Ilent]] ]
	Note that the <code>/Format</code> option is mandatory.		Note that the <code>/Format</code> option is mandatory.

Christian: /* Iref of a {{STX}} file position */

2011-04-08T15:40:32Z

Iref of a {{STX}} file position

← Older revision		Revision as of 17:40, 8 April 2011
Line 9:		Line 9:
	== Iref of a {{STX}} file position ==		== Iref of a {{STX}} file position ==
	; When you supply an {{STX}} [[Programmer Guide/Concepts/File_position\|file position]], <var>position</var>, the <code>IREF</code> command retrieves the iref of the element whose position you supplied:		; When you supply an {{STX}} [[Programmer Guide/Concepts/File_position\|file position]], <var>position</var>, the <code>IREF</code> command retrieves the iref of the element whose position you supplied:
	<var>var</var> := IREF <var>xmlfile</var> /Format <var>position</var> [ /Attribute=<var>irefAttr</var> ] [ /Baseposition=<var>basePos</var> ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Ilent]] ]		<var>var</var> := IREF <var>xmlfile</var> /Format <var>position</var>
			[ /Attribute=<var>irefAttr</var> ] [ /Baseposition=<var>basePos</var> ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Ilent]] ]
	In this case, the option <code>/Delete</code> will cause the {{STX}} position to be deleted. Note that here, too, the <code>/Format</code> option is mandatory.		In this case, the option <code>/Delete</code> will cause the {{STX}} position to be deleted. Note that here, too, the <code>/Format</code> option is mandatory.