Naming Conventions
From XBRLWiki
(Difference between revisions)
| Revision as of 07:32, 2 October 2012 (edit) Hommes (Talk | contribs) (→Folders) ← Previous diff |
Revision as of 07:53, 2 October 2012 (edit) Hommes (Talk | contribs) (→Folders) Next diff → |
||
| Line 3: | Line 3: | ||
| Folders are irrelevant to XML but important to control versioning of released files and ownership of these files. | 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. | + | * 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 top level folder of any taxonomy MUST represent the owner of the taxonomy files. |
| - | The first level of sub folders MUST represent the version and/or release date of the taxonomy files. | + | * The first level of sub folders MUST represent the reporting framework in which the taxonomy resides. |
| - | If dates are used to name folders, its notation MUST be: CCYY-MM-DD. | + | * The second level of sub folders MUST represent the version and/or release date of the taxonomy files inside. |
| - | Folder names MUST be in lower case. | + | * 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? | + | <span style="background-color:yellow">RH: Do we have a limited list of 'owners' that can be prescribed?</span> |
| + | |||
| + | <span style="background-color:yellow">RH: How do we number the rules uniquely?</span> | ||
| + | |||
| + | <span style="background-color:yellow">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.</span> | ||
| + | |||
| + | Example: | ||
| + | |||
| + | * eba | ||
| + | ** finrep | ||
| + | *** 20131201 | ||
| + | ** corep | ||
| + | *** 20121201 | ||
| == File names == | == File names == | ||
Revision as of 07:53, 2 October 2012
Contents |
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
- finrep
