1 Introduction
The tuples specification provides the means to produce XBRL output instances containing tuples with nested tuples and items.
1.1 Background
This specification is a member of a suite of similar specifications that define specific types of criteria that can be used to produce output tuples constructed by multiple related formula evaluations [FORMULA].
1.2 Relationship to other work
This specification depends upon the XBRL Specification [XBRL 2.1], and the XBRL Variables Specification [VARIABLES]. In the event of any conflicts between this specification and the specifications upon which it depends, this specification does not prevail.
1.3 Language independence
The official language of XBRL International's own work products is English and the preferred spelling convention is UK English.
1.4 Terminology
This specification is consistent with the definitions of any of the terms defined in specifications that it depends on.
1.5 Document conventions (non-normative)
Documentation conventions follow those set out in the XBRL Variables Specification [VARIABLES].
1.6 Namespaces and namespace prefixes
Namespace prefixes [XML NAMES] will be used
for elements and attributes in
the form ns:name where ns is the
namespace prefix and name is the local name.
Throughout this specification, the mappings
from namespace prefixes to actual namespaces is consistent
with
Table
1.
The prefix column in Table 1 is non normative. The namespace URI column is normative.
| Prefix | Namespace URI |
|---|---|
tuple
|
http://xbrl.org/2010/formula/tuple
|
xbrltuplee
|
http://xbrl.org/2008/filter/variable/instance/error
|
eg
|
http://example.com/
|
fn
|
http://www.w3.org/2005/xpath-functions
|
link
|
http://www.xbrl.org/2003/linkbase
|
xbrli
|
http://www.xbrl.org/2003/instance
|
xfi
|
http://www.xbrl.org/2008/function/instance
|
xbrldi
|
http://xbrl.org/2006/xbrldi
|
xbrldt
|
http://xbrl.org/2005/xbrldt
|
xl
|
http://www.xbrl.org/2003/XLink
|
xlink
|
http://www.w3.org/1999/xlink
|
xs
|
http://www.w3.org/2001/XMLSchema
|
xsi
|
http://www.w3.org/2001/XMLSchema-instance
|
gen
|
http://xbrl.org/2008/generic
|
variable
|
http://xbrl.org/2008/variable
|
iso4217
|
http://www.xbrl.org/2003/iso4217
|
2 Syntax
This specification only provides a textual declaration of syntax constraints when those constraints are not expressed by the normative schema supplied with this specification.
Explanations of elements and attributes are only supplied when explanations are not already provided in other specifications.
Unless explicitly stated otherwise, a reference to a specific element MUST be read as a reference to that element or to any element in its substitution group.
2.1 Tuple production
A tuple is declared by a
<tuple:tuple>
element. This is an equivalent to the
formula
intended to produce output tuples (whereas the formula element produces
output items).
The syntax for the
<tuple:tuple>
element
is defined by the normative schema supplied with this specification.
Tuples are produced in the output instance by a tuple:tuple element with
a source aspect specifying a concept that is a tuple. (The tuple:tuple element
is otherwise the same as the formula:formula element.)
The tuple element has all the behavior, semantics, and error conditions of the formula element (other than that of producing a value for an item).
Facts (items and tuples) are produced in the output instance within a containing element
by a tuple:tuple element with
a location rule specifying a location aspect that is a containing tuple.
In order to access the source tuple, which is in the output instance, a
variables-scope relationship
from the source tuple to the contents producing formula is required.
(The tuple:tuple element producing an item fact inside a tuple
is otherwise the same as the formula:formula element.)
| This example shows use of variable-scope relationships to provide an output location of the produced tuple, to be used as the location aspect for dependent nested items. This (variable-scope) approach is the preferred one, because the tuple which is to be the parent of the nested children is unambiguously specified by the variable-scope relationship |
|
2.2 Location rules
A location rule is an aspect rule that addresses the
location aspect
and that is expressed by the
<tuple:location>
element.
The syntax for the
<tuple:location>
element
is defined by the normative schema supplied with this specification.
A location rule provides specific rules for constructing the fact in the location (as child) of a tuple in the output instance.
The location rule has no child elements, its RAV is its SAV.
If the source contains a QName that is the result
@name on a variable-scope relationship
from a
<tuple:tuple>
element, then the output fact is produced as a child of that tuple.
(Otherwise the fact is produced as root fact as usual.)
| SAV | Location rule | Output location |
|---|---|---|
| t | RAV is the SAV | Output fact item for this formula has location (as child) of the tuple of variable $t. Tuple t is located in an output instance, $t being the result name on a variable-scope relationship. |
When there is no location rule element, the default location aspect rule applies:
the formula source
is not considered, and the output fact is produced as a child element of the
output XBRL instance's
<xbrli:xbrl>
element.