Naming Conventions

From XBRLWiki

Revision as of 07:53, 2 October 2012 (edit) Hommes (Talk | contribs) (→Folders) ← Previous diff		Revision as of 08:26, 2 October 2012 (edit) Hommes (Talk | contribs) (→File names) Next diff →
Line 26:		Line 26:
	== File names ==		== File names ==
		+
		+	File names are irrelevant to XML but the XBRL adoption of XPointer that can addresses @id in named files makes it necessary to have rules on the file names:
		+
		+	* File names MUST be in lower case;
		+	* File names MUST NOT be longer than 15 characters;
		+	* File names MUST NOT use spaces (if a seperator is need an underscore is advised);
		+	* File name extension '.xsd' MUST be used for schema files;
		+	* File name extension '.xml' MUST be used for linkbase files;
		+	* Schema file names MUST represent their technical content according to the following table:
		+
		+	{|style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: #000; padding: 0"
		+	|-
		+	! File name
		+	! Content
		+	|-
		+	|tab
		+	|tables
		+	|-
		+	|met
		+	|metrics
		+	|-
		+	|dim
		+	|dimensions
		+	|-
		+	|exp
		+	|explicit domains
		+	|-
		+	|typ
		+	|typed domains
		+	|-
		+	|mem
		+	|explicit domain members
		+	|-
		+	|fam
		+	|families
		+	|-
		+	|pers
		+	|perspectives
		+	|-
		+	|hier
		+	|member hierarchies
		+	|}
		+
	== Namespaces ==		== Namespaces ==
	== Concepts ==		== Concepts ==

---

Revision as of 08:26, 2 October 2012

Contents 1 Folders 2 File names 3 Namespaces 4 Concepts 5 Types 6 Codes and enumeration values 7 Linkroles 8 Resources 9 Specials

Folders

Folders are irrelevant to XML but important to control versioning of released files and ownership of these files.

• Taxonomy files MUST be released as children of a folder.
• The top level folder of any taxonomy MUST represent the owner of the taxonomy files.
• The first level of sub folders MUST represent the reporting framework in which the taxonomy resides.
• The second level of sub folders MUST represent the version and/or release date of the taxonomy files inside.
• If dates are used to name folders, its notation MUST be: CCYYMMDD (no dashes or other characters).
• Folder names MUST be in lower case.
• Folder names MUST NOT use spaces (if a seperator is needed, an underscore is advised)

RH: Do we have a limited list of 'owners' that can be prescribed?

RH: How do we number the rules uniquely?

RH: I would like to emphasize that having reasons for each rule prevents a lot of questions. I.e. The reason for folder names to be lower case is to prevent problems between software running on Unix or Microsoft server.

Example:

• eba
  • finrep
    • 20131201
  • corep
    • 20121201

File names

File names are irrelevant to XML but the XBRL adoption of XPointer that can addresses @id in named files makes it necessary to have rules on the file names:

• File names MUST be in lower case;
• File names MUST NOT be longer than 15 characters;
• File names MUST NOT use spaces (if a seperator is need an underscore is advised);
• File name extension '.xsd' MUST be used for schema files;
• File name extension '.xml' MUST be used for linkbase files;
• Schema file names MUST represent their technical content according to the following table:

File name	Content
tab	tables
met	metrics
dim	dimensions
exp	explicit domains
typ	typed domains
mem	explicit domain members
fam	families
pers	perspectives
hier	member hierarchies

Namespaces

Concepts

Types

Codes and enumeration values

Linkroles

Resources

Specials