Copyright ©2009 XBRL International Inc., All Rights Reserved.
Circulation of this Recommendation is unrestricted. This document is normative. Recipients are invited to submit comments to formula-feedback@xbrl.org, and to submit notification of any relevant patent rights of which they are aware and provide supporting documentation.
This specification is an extension to the XBRL Variables Specification [VARIABLES]. It defines XML syntax [XML] for filters that can condition on the content of segments and scenarios.
1 Introduction
1.1 Background
1.2 Relationship to other work
1.3 Language independence
1.4 Terminology
1.5 Document conventions (non-normative)
1.6 Namespaces and namespace prefixes
1.7 XPath usage
2 Syntax
2.1 Segment filter
2.2 Scenario filter
A Normative schema
B References
C Intellectual property status (non-normative)
D Acknowledgements (non-normative)
E Document history (non-normative)
F Errata corrections in this document
1 Namespaces and namespace prefixes
1 Segment filters
2 Scenario filters
This specification is an extension to the XBRL Variables Specification [VARIABLES]. It defines XML syntax [XML] for filters that can condition on the content of segments and scenarios.
Non-XDT content refers to segment and scenario content that is not based upon the explicit or typed dimensions defined in the XBRL Dimensions Specification [DIMENSIONS].
The filters defined in this specification enable filtering of facts based upon segment and scenario content that is not based upon the explicit or typed dimensions defined in the XBRL Dimensions Specification [DIMENSIONS].
Non-XDT content, is not tightly constrained by the XBRL Specification [XBRL 2.1] and so the content of segments and scenarios, and the meaning ascribed to that content, can vary greatly between usages of XBRL. This lack of structure on segment and scenario content forces the segment and scenario filters to be similarly general.
The filters defined in this specification SHOULD NOT be related to variables that are evaluated using the dimensional aspect model.
This specification is a member of a suite of similar specifications that define specific types of criteria that can be used to select facts from XBRL instances. It enhances the fact selection capabilities of the XBRL Variables Specification [VARIABLES].
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.
The official language of XBRL International's own work products is English and the preferred spelling convention is UK English.
This specification is consistent with the definitions of any of the terms defined in specifications that it depends on.
Documentation conventions follow those set out in the XBRL Variables Specification [VARIABLES].
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 |
---|---|
ssf
|
http://xbrl.org/2008/filter/segment-scenario
|
xbrlssfe
|
http://xbrl.org/2008/filter/segment-scenario/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
|
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.
A segment filter is declared by a
<ssf:segment>
element.
The syntax for the
<ssf:segment>
element
is defined by the normative schema supplied with this specification.
The segment filter can be used to match facts that have non-XDT content satisfying specified constraints.
If a segment filter has a
@test
attribute
the XPath expression implied by a segment filter is:
xfi:segment(.)[#test]
where #test
is the value of the
@test
attribute on the segment filter.
Otherwise the XPath expression implied by a segment filter is:
fn:true()
Segment filters can cover the complete segment aspect.
Filter
@test attribute |
Selection criteria |
---|---|
xs:boolean('true')
|
A fact's context must contain a
<xbrli:segment>
element.
|
eg:mining
|
The fact's context must contain a
<xbrli:segment>
element
that has a child
<eg:mining>
element.
|
A scenario filter is declared by a
<ssf:scenario>
element.
The syntax for the
<ssf:scenario>
element
is defined by the normative schema supplied with this specification.
The scenario filter can be used to match facts that have non-XDT content satisfying specified constraints.
If a scenario filter has a
@test
attribute
the XPath expression implied by a scenario filter is:
xfi:scenario(.)[#test]
where #test
is the value of the
@test
attribute on the scenario filter.
Otherwise the XPath expression implied by a segment filter is:
fn:true()
Scenario filters can cover the complete scenario aspect.
Filter
@test attribute |
Selection criteria |
---|---|
xs:boolean('true')
|
A fact's context must contain a
<xbrli:scenario>
element.
|
eg:audited
|
The fact's context must contain a
<xbrli:scenario>
element
that has a child
<eg:audited>
element.
|
The following is the XML schema provided as part of this specification. This is normative. Non-normative versions (which should be identical to these except for appropriate comments indicating their non-normative status) are also provided as separate files for convenience of users of the specification.
NOTE: (non-normative) Following the schema maintenance policy of XBRL International, it is the intent (but is not guaranteed) that the location of non-normative versions of these schemas on the web will be as follows:
http://www.xbrl.org/2008/
- during the drafting process for
this specification this directory should contain a copy of the
most recent published version of the schema at
http://www.xbrl.org/2008/segment-scenario-filter.xsd.
This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to XBRL International or XBRL organizations, except as required to translate it into languages other than English. Members of XBRL International agree to grant certain licenses under the XBRL International Intellectual Property Policy (www.xbrl.org/legal).
This document and the information contained herein is provided on an "AS IS" basis and XBRL INTERNATIONAL DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
The attention of users of this document is directed to the possibility that compliance with or adoption of XBRL International specifications may require use of an invention covered by patent rights. XBRL International shall not be responsible for identifying patents for which a license may be required by any XBRL International specification, or for conducting legal inquiries into the legal validity or scope of those patents that are brought to its attention. XBRL International specifications are prospective and advisory only. Prospective users are responsible for protecting themselves against liability for infringement of patents. XBRL International takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Members of XBRL International agree to grant certain licenses under the XBRL International Intellectual Property Policy (www.xbrl.org/legal).
This document could not have been written without the contributions of many people including the participants in the Formula Working Group.
Date | Author | Details |
---|---|---|
01 May 2007 | Geoff Shuetrim |
First internal working draft created. |
24 July 2007 | Hugh Wallis |
Edited for public working draft publication. |
05 November 2007 | Geoff Shuetrim |
Converted the specification to XML format. Added in the definitions and the hyperlinks to the relevant sections of the normative schema. Made the segment and scenario filters more specific
by incorporating the |
26 November 2007 | Jim Richards |
Reworded the Abstract and Introduction to maintain consistency with other relatedspecifications. Added reference for the Dimensions Specification. Replaced "an" with "a" in some definitions. Reworded the definition for non-XDT content. |
30 November 2007 | Geoff Shuetrim |
Added examples. |
25 January 2008 | Herm Fischer |
Fixed namespace of normative schema to correspond to core-schemas xsd targetNamespace. |
31 January 2008 | Geoff Shuetrim |
Standardised the format of the hyperlinks to the normative schema. Changed the normative schema for the scenario filter to allow a mixed content model, as required for it to be an XLink resource in an XBRL extended link. |
01 February 2008 | Geoff Shuetrim |
Fixed the examples as suggested by Masatomo Goto to use
|
13 February 2008 | Geoff Shuetrim |
Extracted the common content model from the two filters in the normative schema. |
25 February 2008 | Geoff Shuetrim |
As suggested by Herm Fischer, added a sentence to the introduction to clarify that the scenario and segment filters are not appropriate to use with the dimensional aspect model. |
12 August 2008 | Geoff Shuetrim |
Allowed the |
This appendix contains a list of the errata that have been incorporated into this document. This represents all those errata corrections that have been approved by the XBRL International Formula Working Group up to and including 22 June 2009. Hyperlinks to relevant e-mail threads may only be followed by those who have access to the relevant mailing lists. Access to internal XBRL mailing lists is restricted to members of XBRL International Inc.
No errata have been incorporated into this document.