Ihr: /* The format element */

2009-08-23T19:05:58Z

The format element

← Older revision		Revision as of 19:05, 23 August 2009
Line 67:		Line 67:

	This element is used to define exceptions to the default format defined in the '''formatPattern''' element. This element requires the existence of an attribute called ''concept'' whose value is the concept QName for which the format is defined.		This element is used to define exceptions to the default format defined in the '''formatPattern''' element. This element requires the existence of an attribute called ''concept'' whose value is the concept QName for which the format is defined.

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

Ihr: /* The template element */

2009-08-23T11:17:59Z

The template element

← Older revision		Revision as of 11:17, 23 August 2009
Line 38:		Line 38:
	===The '''template''' element===		===The '''template''' element===

	This is the URL of the initial template that will be called for the generation of the HTML report. A template can call another templates and can call templates recursivelly. Refer to the [[XhBtRmL HTML Templates]] section for more information about how to create templates. Only one template element can occur inside a report element.		This is the URL of the initial template that will be called for the generation of the HTML report. A template can call another templates and can call templates recursivelly.

			The URL can be absolute or relative. If relative, the absolute URL will be calculated using the absolute location of the configuration file.

			Refer to the [[XhBtRmL HTML Templates]] section for more information about how to create templates. Only one template element can occur inside a report element.

	===The '''constant''' element===		===The '''constant''' element===

Ihr: Created page with 'During the creation of an http://www.reportingstandard.com/apidoc/com/ihr/xbrl/transform/target/HTMLReportHandler.html HTMLReportHandler instance, the TransforProcessor sets …'

2009-08-23T11:14:46Z

Created page with 'During the creation of an http://www.reportingstandard.com/apidoc/com/ihr/xbrl/transform/target/HTMLReportHandler.html HTMLReportHandler instance, the TransforProcessor sets …'

New page

During the creation of an [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/transform/target/HTMLReportHandler.html HTMLReportHandler]] instance, the TransforProcessor sets the URI of a configuration file. The configuration file is required by the class. The configuration file contains information required by the HTMLReportHandler in order to work properly.

The configuration file must be a valid instance of an XML document according to the schema documented in this section.

==Namespace==

The namespace for the configuration file is '''<nowiki>http://www.reportingstandard.com/HTMLReport/0</nowiki>'''

==Schema location==

The schema location for the configuration file is http://www.reportingstandard.com/taxonomies/versioning/HTMLReport.xsd

==Sample file==

This is the content of a sample configuration file:
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<r:report xmlns:r="http://www.reportingstandard.com/HTMLReport/0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.reportingstandard.com/HTMLReport/0 http://www.reportingstandard.com/taxonomies/versioning/HTMLReport.xsd" xmlns:tx="http://www.reportingstandard.com/samples/transformerTaxonomy">
<r:template>templates/sample/google-header.xhtml</r:template>
<r:constant name="XBRL_YearSeparator">. </r:constant>
<r:langs>en,es</r:langs>
<r:defaultDivideNumericValuesBy>1000</r:defaultDivideNumericValuesBy>
<r:divideNumericValuesBy concept="tx:EarningsPerShare">1</r:divideNumericValuesBy>
<r:divideNumericValuesBy concept="tx:NumberOfShares">1</r:divideNumericValuesBy>
<r:divideNumericValuesBy concept="tx:IntlRevenuesAsPercentageOfTotalRevenues">1</r:divideNumericValuesBy>
<r:formatPattern>#,##0;(#,##0)</r:formatPattern>
<r:format concept="tx:IntlRevenuesAsPercentageOfTotalRevenues" >##0%</r:format>
<r:format concept="tx:EarningsPerShare">$#,##0.00;$(#,##0.00)</r:format>
</r:report>
</syntaxhighlight>

==Configuration file content==

===Root element===

The root element is '''<report ...>'''. The content of the '''<report ...>''' is a sequence of elements defined in the schema.

===The '''template''' element===

This is the URL of the initial template that will be called for the generation of the HTML report. A template can call another templates and can call templates recursivelly. Refer to the [[XhBtRmL HTML Templates]] section for more information about how to create templates. Only one template element can occur inside a report element.

===The '''constant''' element===

Constant elements are used in order to define variables whose values can be used inside XPath expressions inside the XhBtRmL templates.

===The '''langs''' element===

This is a comma separated list of languages. The leftmost language is also the language with highest priority. Labels for concept definitions are selected for languages according to the language priority. If a label exist in the taxonomy for the same role and more than one language, the selected label will be the label for the language that has highest priority.

===The '''defaultDivideNumericValuesBy''' element===

All numeric facts will be divided by the value indicated here by default. See the information about the '''divideNumericValuesBy''' element in order to define exceptions to the default rule.

===The '''divideNumericValuesBy''' element===

This element is used to define exceptions to the default rule indicated in the '''defaultDivideNumericValuesBy''' element. This element requires the existence of an attribute called ''concept'' whose value is the concept QName for which the exception is defined.

===The '''formatPattern''' element===

This element is used to define the default format pattern for numbers. See the information about the '''format''' element in order to define exceptions to the default format.

===The '''format''' element===

This element is used to define exceptions to the default format defined in the '''formatPattern''' element. This element requires the existence of an attribute called ''concept'' whose value is the concept QName for which the format is defined.

XhBtRmL HTMLReportHandler Configuration file - Revision history

Ihr: /* The format element */

Ihr: /* The template element */

Ihr: Created page with 'During the creation of an http://www.reportingstandard.com/apidoc/com/ihr/xbrl/transform/target/HTMLReportHandler.html HTMLReportHandler instance, the TransforProcessor sets …'