XhBtRmL HTML Templates - Revision history

Agil at 10:09, 9 January 2019

2019-01-09T10:09:07Z

← Older revision		Revision as of 10:09, 9 January 2019
Line 242:		Line 242:
	iterator="DimMembers"		iterator="DimMembers"
	dimensionFilterScenario="tx:BasicDilutedDimension"		dimensionFilterScenario="tx:BasicDilutedDimension"
	xmlns:tx="http://www.reportingstandard.com/samples/transformerTaxonomy" />		xmlns:tx="http ://www.reportingstandard.com/samples/transformerTaxonomy" />
	</XBRLThen>		</XBRLThen>
	<XBRLElse>		<XBRLElse>

Ihr at 11:01, 26 August 2009

2009-08-26T11:01:38Z

← Older revision		Revision as of 11:01, 26 August 2009
Line 209:		Line 209:
	==The XBRLIf element==		==The XBRLIf element==

	The XBRLIf statement can be used to drive execution flow and select the content to be represented according to an evaluated criteria. The evaluated criteria is an XPath expression		The XBRLIf statement can be used to drive execution flow and select the content to be represented according to an evaluated criteria. The evaluated criteria is an XPath expression. The evaluation is subject to the existence of a '''contextNode''' attribute.

	~~===Sample XBRLIf statement===~~

	The following piece of code is part of a template that shows the fact value:		The following piece of code is part of a template that shows the fact value:
			<syntaxhighlight lang="html4strict">
	<?xml version="1.0" encoding="UTF-8"?>		<?xml version="1.0" encoding="UTF-8"?>
	<!DOCTYPE template PUBLIC "-//Reporting Estandar S.L.//DTD XHTML 1.0 Transitional + XBRL Transformation Tags//EN" "http://www.reportingstandard.com/taxonomies/transform/HTMLTransformation.dtd">		<!DOCTYPE template PUBLIC "-//Reporting Estandar S.L.//DTD XHTML 1.0 Transitional + XBRL Transformation Tags//EN" "http://www.reportingstandard.com/taxonomies/transform/HTMLTransformation.dtd">
	<template>		<template>
	<td>$XBRL_FactValue<XBRLIf expression="$XBRL_NoteNumber > 0">		<td>$XBRL_FactValue<XBRLIf expression="$XBRL_NoteNumber > 0">
	<XBRLThen>		<XBRLThen>
	<sup>		<sup>
	<font size="-2">$XBRL_NoteNumber</font>		<font size="-2">$XBRL_NoteNumber</font>
	</sup>		</sup>
	</XBRLThen>		</XBRLThen>
	</XBRLIf>		</XBRLIf>
	</td>		</td>
	</template>		</template>
			</syntaxhighlight>

			The output of that template is something like 1.000<sup>1</sup> in a table with 1 being the number of a footnote (the value of the '''XBRL_NoteNumber''' variable, and 1.000 being the value of the '''XBRL_FactValue''' variable.

			'''XBRLIf''' statements must have an XPath expression in the expression attribute that evaluates to a boolean value. If the result is ''true()'' the execution continues including the content of the '''XBRLThen''' statement. If the result is ''false()'' then tha execution continues including the content of the '''XBRLElse''' statement or nothing if the '''XBRLElse''' statement is missing.

			This example contains an '''XBRLElse''' statement:
			<syntaxhighlight lang="html4strict">
			<XBRLIf expression="$XBRL_HasDimensions">
			<XBRLThen>
			<tr>
			<td class="category">$XBRL_TreeCurrentNode</td>
			<td class="label" colspan="$XBRL_NumberOfYears"> </td>
			</tr>
			<XBRLTemplate template="google-fact-data-dim.xhtml"
			iterator="DimMembers"
			dimensionFilterScenario="tx:BasicDilutedDimension"
			xmlns:tx="http://www.reportingstandard.com/samples/transformerTaxonomy" />
			</XBRLThen>
			<XBRLElse>
			<tr>
			<td class="category">$XBRL_TreeCurrentNode</td>
			<XBRLTemplate template="google-fact-data.xhtml"
			iterator="Facts"
			dateStep="Years"/>
			</tr>
			</XBRLElse>
			</XBRLIf>
			</syntaxhighlight>

	==The XBRLEval element==		==The XBRLEval element==

			The '''XBRLEval''' statement can be used to evaluate a dynamically generated XPath expression. It can be used when the output of an XPath expression includes XBRL variable names that requires substitution by the processor.

	==Navigation==		==Navigation==
	[[Main Page]] \| [[XhBtRmL]]		[[Main Page]] \| [[XhBtRmL]]

Ihr: /* The XBRLIf element */

2009-08-26T10:24:23Z

The XBRLIf element

← Older revision		Revision as of 10:24, 26 August 2009
Line 208:		Line 208:

	==The XBRLIf element==		==The XBRLIf element==

			The XBRLIf statement can be used to drive execution flow and select the content to be represented according to an evaluated criteria. The evaluated criteria is an XPath expression

			===Sample XBRLIf statement===

			The following piece of code is part of a template that shows the fact value:
			<?xml version="1.0" encoding="UTF-8"?>
			<!DOCTYPE template PUBLIC "-//Reporting Estandar S.L.//DTD XHTML 1.0 Transitional + XBRL Transformation Tags//EN" "http://www.reportingstandard.com/taxonomies/transform/HTMLTransformation.dtd">
			<template>
			<td>$XBRL_FactValue<XBRLIf expression="$XBRL_NoteNumber > 0">
			<XBRLThen>
			<sup>
			<font size="-2">$XBRL_NoteNumber</font>
			</sup>
			</XBRLThen>
			</XBRLIf>
			</td>
			</template>

	==The XBRLEval element==		==The XBRLEval element==

Ihr: /* The startingNode attribute */

2009-08-26T10:06:51Z

The startingNode attribute

← Older revision		Revision as of 10:06, 26 August 2009
Line 197:		Line 197:
	===The startingNode attribute===		===The startingNode attribute===

	This attribute is used on '''Link''' iterators in order to define the node from which the navigation will start. All previous nodes in the hierarchy will be ignored.		This attribute is optional and can be used on '''Link''' iterators in order to define the node from which the navigation will start. All previous nodes in the hierarchy will be ignored.

	===The dimensionFilterScenario attribute===		===The dimensionFilterScenario attribute===

Ihr: /* The expression attribute */

2009-08-26T10:05:19Z

The expression attribute

← Older revision		Revision as of 10:05, 26 August 2009
Line 159:		Line 159:
	===The expression attribute===		===The expression attribute===

	Is used to indicate an XPath expression that will be used in '''Select''' iterators and the evaluation of XBRLIf expressions or XBRLEval ~~statements~~.		Is used to indicate an XPath expression that will be used in '''Select''' iterators and the evaluation of XBRLIf expressions or XBRLEval statement.

	During the evaluation of the XPath expression a context node can be configured according to the content of the '''contextNode''' attribute.		During the evaluation of the XPath expression a context node can be configured according to the content of the '''contextNode''' attribute.

Ihr: /* The expression attribute */

2009-08-26T10:04:58Z

The expression attribute

← Older revision		Revision as of 10:04, 26 August 2009
Line 159:		Line 159:
	===The expression attribute===		===The expression attribute===

	Is used to indicate an XPath expression that will be used in '''Select''' iterators. During the evaluation of the XPath expression a context node can be configured according to the content of the '''contextNode''' attribute.		Is used to indicate an XPath expression that will be used in '''Select''' iterators and the evaluation of XBRLIf expressions or XBRLEval statements.

			During the evaluation of the XPath expression a context node can be configured according to the content of the '''contextNode''' attribute.

	===The contextNode attribute===		===The contextNode attribute===

Ihr: /* The role attribute */

2009-08-26T10:03:33Z

The role attribute

← Older revision		Revision as of 10:03, 26 August 2009
Line 155:		Line 155:
	===The role attribute===		===The role attribute===

	Is used to indicate the link role where relationships will be taken on '''Link''' iterators.		Is used to indicate the link role where relationships will be taken on '''Link''' iterators. The value must be an URI that corresponds to the role of the extended link. Normally this is the role on the presentationLink element from which presentationArc elements will be used in order to represent the presentation hierarchy. The user can use different hierarchies as XhBtRmL is not limited to presentation trees.

	===The expression attribute===		===The expression attribute===

Ihr: /* The iterator attribute */

2009-08-26T10:00:50Z

The iterator attribute

← Older revision		Revision as of 10:00, 26 August 2009
Line 145:		Line 145:

	This attribute is optional, if it exist the value can be one of the following:		This attribute is optional, if it exist the value can be one of the following:
	* '''Select'''; Indicates that the iterator will iterate through the nodes returned by the XPath expression indicated in the '''expression''' attribute. If the value of the '''iterator''' is '''Select''' then a value on the '''expression''' attribute is required. For each loop iteration, the variable '''XBRL_Node''' will be updated to contain the returned node from the sequence of nodes in the XPath expression. That variable name can be used in other XPath expressions or text nodes in nested templates and the value will be automatically substituted by the processor.		* '''Select'''; Indicates that the iterator will iterate through the nodes returned by the XPath expression indicated in the '''expression''' attribute. If the value of the '''iterator''' is '''Select''' then a value on the '''expression''' attribute is required. For each loop iteration, the variable '''XBRL_Node''' will be updated to contain the returned node from the sequence of nodes in the XPath expression. That variable name can be used in other XPath expressions or text nodes in nested templates and the value will be automatically substituted by the processor. Other variables updated '''XBRL_HasNext'''.
	* '''Dates'''; Indicates that the iterator will iterate through the values of the instance document by columns (a column may contain more than one XBRL context). The column length will be indicated by the value of the '''dateStep''' attribute. If the value of the '''iterator''' is '''Dates''' then a value on the '''dateStep''' attribute is required. Each ~~iteration~~ will update the value of the '''XBRL_CurrentDateStep''' variable so templates using that variable on XPath expressions or texts nodes can use the ~~iterator~~ value for presentation purposes.		* '''Dates'''; Indicates that the iterator will iterate through the values of the instance document by columns (a column may contain more than one XBRL context). The column length will be indicated by the value of the '''dateStep''' attribute. If the value of the '''iterator''' is '''Dates''' then a value on the '''dateStep''' attribute is required. Each cycle will update the value of the '''XBRL_CurrentDateStep''' variable so templates using that variable on XPath expressions or texts nodes can use the variable value for presentation purposes. Other variables updated '''XBRL_HasNext'''.
	* '''Link'''; Indicates that the iterator will iterate through the nodes in a hierarchy defined by relationships in the DTS. If the value of the '''iterator''' is '''Link''' then a value on the '''linkType''' attribute and a value on the '''role''' attribute are required.		* '''Link'''; Indicates that the iterator will iterate through the nodes in a hierarchy defined by relationships in the DTS. If the value of the '''iterator''' is '''Link''' then a value on the '''linkType''' attribute and a value on the '''role''' attribute are required. This iterator is used to traverse trees in the presentation linkbase but can be used to traverse any tree on any linkbase type. The '''Link''' iterator updates the following variables: '''XBRL_TreeRootNode''', '''XBRL_TreeParentNode''', '''XBRL_TreeCurrentNode''', '''XBRL_TreeCurrentNode_IsAbstract''', '''XBRL_HasDimensions''', '''XBRL_HasNext'''.
	* '''Children'''; Indicates that the iterator will iterate through the nodes that are children of the current node.		* '''Children'''; Indicates that the iterator will iterate through the nodes that are children of the current node. This iterator can only exist inside a '''Link''' iterator. The '''Children''' iterator updates the following variables: '''XBRL_DepthLevel''', '''XBRL_TreeParentNode''', '''XBRL_TreeCurrentNode''', '''XBRL_ChildNumber''', '''XBRL_TreeCurrentNode_IsAbstract''', '''XBRL_HasDimensions''', '''XBRL_HasNext'''.
	* '''Facts'''; Indicates that the iterator will iterate through the fact items in the instance that corresponds to the current concept. If the value of the iterator is '''Facts''' then a value on the '''dateStep''' attribute is required in order to return the facts in the right order.		* '''Facts'''; Indicates that the iterator will iterate through the fact items in the instance that corresponds to the current concept. If the value of the iterator is '''Facts''' then a value on the '''dateStep''' attribute is required in order to return the facts in the right order. A '''Facts''' iterator requires the existence of an '''XBRL_TreeCurrentNode''' so it can only exist inside a '''Children''' or a '''Link''' iterator. A '''Facts''' iterator updates the following variables: '''XBRL_CurrentDateStep''', '''XBRL_FactValue''', '''XBRL_NoteNumber''', '''XBRL_FactQName''', '''XBRL_HasNext'''.
	* '''DimMembers'''; Indicates that the iterator will iterate through dimension members of the current node.		* '''DimMembers'''; Indicates that the iterator will iterate through dimension members of the current node. This iterator updates the variable called '''XBRL_TreeCurrentDimNode''' that contains the label of the dimension member.
	* '''Footnotes'''; Indicates that the iterator will iterate through footnotes in the report.		* '''Footnotes'''; Indicates that the iterator will iterate through footnotes in the report. Updates the variables '''XBRL_NoteNumber''' and '''XBRL_NoteContent'''.

	===The role attribute===		===The role attribute===

Ihr: /* The iterator attribute */

2009-08-26T09:15:56Z

The iterator attribute

← Older revision		Revision as of 09:15, 26 August 2009
Line 145:		Line 145:

	This attribute is optional, if it exist the value can be one of the following:		This attribute is optional, if it exist the value can be one of the following:
	* '''Select'''; Indicates that the iterator will iterate through the nodes returned by the XPath expression indicated in the '''expression''' attribute. If the value of the '''iterator''' is '''Select''' then a value on the '''expression''' attribute is required. For each loop iteration the variable '''XBRL_Node''' will be updated to contain the returned node in the XPath expression. ~~that~~ variable name can be used in other XPath expressions or text nodes ~~inside the template~~ and the value will be automatically substituted by the processor.		* '''Select'''; Indicates that the iterator will iterate through the nodes returned by the XPath expression indicated in the '''expression''' attribute. If the value of the '''iterator''' is '''Select''' then a value on the '''expression''' attribute is required. For each loop iteration, the variable '''XBRL_Node''' will be updated to contain the returned node from the sequence of nodes in the XPath expression. That variable name can be used in other XPath expressions or text nodes in nested templates and the value will be automatically substituted by the processor.
	* '''Dates'''; Indicates that the iterator will iterate through the values of the instance document by columns (a column may contain more than one XBRL context). The column length will be indicated by the value of the '''dateStep''' attribute. If the value of the '''iterator''' is '''Dates''' then a value on the '''dateStep''' attribute is required. Each iteration will update the value of the '''XBRL_CurrentDateStep''' variable so templates using that variable on XPath expressions or texts nodes can use the iterator value for presentation purposes.		* '''Dates'''; Indicates that the iterator will iterate through the values of the instance document by columns (a column may contain more than one XBRL context). The column length will be indicated by the value of the '''dateStep''' attribute. If the value of the '''iterator''' is '''Dates''' then a value on the '''dateStep''' attribute is required. Each iteration will update the value of the '''XBRL_CurrentDateStep''' variable so templates using that variable on XPath expressions or texts nodes can use the iterator value for presentation purposes.
	* '''Link'''; Indicates that the iterator will iterate through the nodes in a hierarchy defined by relationships in the DTS. If the value of the '''iterator''' is '''Link''' then a value on the '''linkType''' attribute and a value on the '''role''' attribute are required.		* '''Link'''; Indicates that the iterator will iterate through the nodes in a hierarchy defined by relationships in the DTS. If the value of the '''iterator''' is '''Link''' then a value on the '''linkType''' attribute and a value on the '''role''' attribute are required.

Ihr: /* The XBRLTemplate element */

2009-08-26T09:10:42Z

The XBRLTemplate element

← Older revision		Revision as of 09:10, 26 August 2009
Line 136:		Line 136:
	Iterators are normally nested one inside another; in the most common case there will be one '''Link''' iterator that will contain nested '''Children''' iterators and nested '''Facts''' iterators.		Iterators are normally nested one inside another; in the most common case there will be one '''Link''' iterator that will contain nested '''Children''' iterators and nested '''Facts''' iterators.

	An '''XBRLTemplate''' element ~~has~~ the following attributes:		An '''XBRLTemplate''' element may have a combination of the following attributes:

	===The template attribute===		===The template attribute===

	This attribute is required and contains the absolute or relative URL or a file that contains the template content.		This attribute is always required and contains the absolute or relative URL or a file that contains the template content.

	===The iterator attribute===		===The iterator attribute===