"Extensions" container

Revision as of 00:23, 18 October 2010

Third parties may sometimes wish to include additional tags in an Asset’s config.txt file for the purposes of providing asset-keyed data to custom scripts. It is important that the following mechanism is used to prevent potential conflict with future N3V tags or other content creators.

All third-party tags must be embedded under an extensions container which is placed at the top level in the config.txt file. Tags within the extensions container should have a meaningful name and should end with a hypen and the UserID of the content creator who is responsible for the extension. The responsible content creator should determine any rules and restrictions which apply to his or her tag and should make an effort to provide this information to other creators (outside the scope of the asset itself). While creators are permitted to make use of each other’s extensions, it is not permissable to create a new extension (or change the meaning of an extension) in the namespace belonging to another creator.

Each tag in the extensions container may be either a single value, or a subcontainer. If a subcontainer is used, the contents of the subcontainer should be specified in the extension’s documentation. No restrictions are placed by Auran on the values within a specific extension, beyond the normal config.txt file format guidelines.