Rule Axis 1.0

Public Working Draft 21 December 2011

Copyright ©2011 XBRL International Inc., All Rights Reserved.

This version:
<http://www.xbrl.org/Specification/rule-axis/PWD-2011-12-21/rule-axis-PWD-2011-12-21.html>
Editors:
Herm Fischer, Mark V Systems <fischer@markv.com>
Victor Morilla, Banco de España <victor.morilla@bde.es>
Contributors:
Geoff Shuetrim, Galexy Pty. <geoff@galexy.com>
Masatomo Goto, Fujitsu Ltd. <mg@jp.fujitsu.com>
Roland Hommes, RHOCON <roland@rhocon.nl>
Bartosz Ochocki, BRAG <bartosz.ochocki@br-ag.eu>
Hugh Wallis, Standard Dimensions <hugh@standarddimensions.com>

Status

Circulation of this Public Working Draft is unrestricted. This document is normative. Other documents may supersede this document. Recipients are invited to submit comments to rendering-feedback@xbrl.org, and to submit notification of any relevant patent rights of which they are aware and provide supporting documentation.

Abstract

This document specifies semantics and syntax constraints for rule axes. Rule axes provide an implementation of predefined axes, as defined in the table specification.

Comment

1 Herm Fischer:Note to reviewers: please indicate if there is a use case for labels to be constrained to specific link roles, such as to match the composition of a table.

Table of Contents

1 Introduction
2 Namespaces and namespace prefixes
3 XPath usage
4 Definitions
5 Aspect Rules
6 Headers
7 Syntax

Appendices

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

Table

1 Namespaces and namespace prefixes

Figure

1 Rule Axis Model

Definitions

aspect rule
rule axis


1 Introduction

This document specifies semantics and syntax constraints for rule axes. Aspect rule axes provide an implementation of predefined axes, as defined in the table specification.

2 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 are consistent with Table 1.

The prefix column in Table 1 is non normative. The namespace URI column is normative.

Table 1: Namespaces and namespace prefixes
Prefix Namespace URI
table http://xbrl.org/2011/table
xbrlte http://xbrl.org/2011/table/error
link http://www.xbrl.org/2003/linkbase
xbrli http://www.xbrl.org/2003/instance
xfi http://www.xbrl.org/2005/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
generic http://xbrl.org/2007/generic

3 XPath usage

XPath usage is identical to that in the XBRL Variables Specification [VARIABLES].

4 Definitions

The figure below provides a model of the rule axis.

Figure 1: Rule Axis Model



A rule axis is an implementation of a predefined axis whose set of coordinates is expressed in terms of a subtree of rule axis elements and their rules. The rule axis may have rules representing specific aspects, e.g., concept, explicitDimension, typedDimension, entityIdentifier, and period.

5 Aspect Rules

The rules of a coordinate are defined by formulae aspect rules in the corresponding axis and its subtree. In the context of the Formulae specification, aspect rules specify aspect values that the output fact is required to match. In this specification, aspect rules will be used to specify the aspect values that facts that correspond to that coordinate MUST match.

The aspect rules of a rule axis coordinate represented by a rule axis element use as source aspect values the required aspect rules of its ancestor ruleAxis elements. Where the formula specification makes reference to input instances for SAV and output instances for RAV, in this specification SAV become RAV when a source instance of existing facts is used to populate a table.

6 Headers

As described before, the headers of the axis are represented by the set of rule axis elements, their subtrees, and their rules. As axis rule element is represented using XLink resources in a generic linkbase, they can be associated to generic labels or messages, and generic references. These labels, messages, and references SHOULD be used as labels and references of the headers by a rendering engine. Labels, messages, and references are used in the normal manner of such linkbases, ignoring the link role labels and references. [Herm Fischer: Note to reviewers: please indicate if there is a use case for labels to be constrained to specific link roles, such as to match the composition of a table.]

7 Syntax

A ruleAxis is represented by a <table:ruleAxis> element with an optional subtree of <table:predefinedAxis> elements connected by an axis-subtree relationship.

A <table:ruleAxis> element may contains <formula:aspectRule> elements used to specify aspect and aspect constraints for the coordinate.

A <formula:aspectRule> element specifies an aspect and its value for an axis coordinate in a manner that is usable both to select input fact(s) that match, and to use as an entry form specifying output aspects when storing values of empty cells corresponding to the coordinate aspects.

The following <formula:aspectRule> features are not processed: @source (all rules), @augment (unit rule), and omit sub-elements (dimension rules).

The <table:ruleAxis> may have @value XPath expressions, and the <formula:aspectRule> may have an XPath expression (such as for QNameExpression or period). The context item for each XPath expression is the fact bound to coordinates of each axis, or the <table:selectionAxis> result when applicable (when bound to coordinates of a cell). XPath expressions may refer to parameters and selection axes by name, when in effect.

Appendix A Normative schema

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:

  1. While any schema is the most current RECOMMENDED version and until it is superseded by any additional errata corrections a non-normative version will reside on the web in the directory http://www.xbrl.org/2011/ - 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/2011/rule-axis.xsd.
  2. A non-normative version of each schema as corrected by any update to the RECOMMENDATION will be archived in perpetuity on the web in a directory that will contain a unique identification indicating the date of the update.
<schema
xmlns:formula
="http://xbrl.org/2008/formula"

xmlns
="http://www.w3.org/2001/XMLSchema"

xmlns:table
="http://xbrl.org/2011/table"
targetNamespace="http://xbrl.org/2011/table" elementFormDefault="qualified">
<import namespace="http://xbrl.org/2008/formula" schemaLocation="http://www.xbrl.org/2008/formula.xsd"/>
<complexType name="ruleAxis.type">
<complexContent mixed="true">
<extension base="table:predefinedAxis.type">
<sequence minOccurs="0" maxOccurs="unbounded">
<element ref="formula:abstract.aspect"/>
</sequence>
</extension>
</complexContent>
</complexType>
<element id="xml-rule-axis" name="ruleAxis" substitutionGroup="table:predefinedAxis" type="table:ruleAxis.type"/>
</schema>

Appendix B References

VARIABLES
XBRL International Inc.. "XBRL Variables 1.0"
Phillip Engel
, Herm Fischer, Victor Morilla, Jim Richards, Geoff Shuetrim, David vun Kannon, and Hugh Wallis.
(See http://www.xbrl.org/Specification/variables/REC-2009-06-22/variables-REC-2009-06-22.html)
XML NAMES
W3C (World Wide Web Consortium). "Namespaces in XML 1.0 (Second Edition)"
Tim Bray
, Dave Hollander, Andrew Layman, and Richard Tobin.
(See http://www.w3.org/TR/REC-xml-names/)

Appendix C Intellectual property status (non-normative)

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).

Appendix D Acknowledgements (non-normative)

This document could not have been written without the contributions of many people.

Appendix E Document history (non-normative)

DateAuthorDetails
01 October 2011Herm Fischer

Initial draft

11 October 2011Hugh Wallis

Prepare for DPWD

03 November 2011Herm Fischer

Working group updates: replace predefinedAxis model with subtrees of ruleAxes and compositions of ruleAxes with relationshipAxes. Replace axis-member notion with that of axis subtree composition.

05 December 2011Herm Fischer

Update class diagram, provide schema definitions.

19 December 2011Herm Fischer

Editorial updates suggested by Roland Hommes in WG e-mail of 2011-12-08.

Appendix F Errata corrections in this document

This appendix contains a list of the errata corrections that have been incorporated into this document. This represents all those errata corrections that have been approved by the XBRL International Rendering Working Group up to and including 21 December 2011.

No errata have been incorporated into this document.