"Extensions" container - Revision history

Vvmm: /* "Extensions" container Example */

2016-01-31T18:09:13Z

"Extensions" container Example

← Older revision		Revision as of 18:09, 31 January 2016
Line 23:		Line 23:
	extensions		extensions
	{		{
	~~TBD~~		delayinterval-474195 0.1
			signaltype-474195 "DTV"
	}		}

	[[Category:Config Container\|E]]		[[Category:Config Container\|E]]

Pcas1986: Added sort criterion

2014-02-12T02:56:30Z

Added sort criterion

← Older revision		Revision as of 02:56, 12 February 2014
Line 26:		Line 26:
	}		}

	[[Category:Config Container]]		[[Category:Config Container\|E]]

Windwalkr at 15:06, 17 October 2010

2010-10-17T15:06:32Z

← Older revision		Revision as of 15:06, 17 October 2010
Line 1:		Line 1:
	The [["~~extensions~~" container]] is a top-level [[config.txt file]] entry available to any Asset which derives from [[KIND TrainzBaseSpec]] (in short, all Assets.) This container is intended to allow third-party developers to introduce custom Asset-keyed data which may be processed by custom scripts.		The [["Extensions" container]] is a top-level [[config.txt file]] entry available to any Asset which derives from [[KIND TrainzBaseSpec]] (in short, all Assets.) This container is intended to allow third-party developers to introduce custom Asset-keyed data which may be processed by custom scripts.

	The extensions container is a list of custom tags or subcontainers with a specific naming convention.		The extensions container is a list of custom tags or subcontainers with a specific naming convention.
Line 5:		Line 5:
	==Supported Tags==		==Supported Tags==

	The naming of top-level tags within the [["~~extensions~~" container]] is important. Tag names should be meaningful and must end with a hyphen followed by the [[KUID#User_ID_Number\|User ID]] of the content creator who is introducing the extension. This content creator is solely responsible for determining any rules and restrictions which apply to the tag or subcontainer, and should ideally make an effort to provide this information to other creators via this wiki. While content creators are permitted to make use of each other's extension formats, it is not permissible for a creator to introduce a new extension (or change the meaning of an extension) which exists in a namespace belonging to another content creator.		The naming of top-level tags within the [["Extensions" container]] is important. Tag names should be meaningful and must end with a hyphen followed by the [[KUID#User_ID_Number\|User ID]] of the content creator who is introducing the extension. This content creator is solely responsible for determining any rules and restrictions which apply to the tag or subcontainer, and should ideally make an effort to provide this information to other creators via this wiki. While content creators are permitted to make use of each other's extension formats, it is not permissible for a creator to introduce a new extension (or change the meaning of an extension) which exists in a namespace belonging to another content 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 documentation. No restrictions are placed by N3V on the values within a specific extension.		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 documentation. No restrictions are placed by N3V on the values within a specific extension.
Line 11:		Line 11:
	==Validation==		==Validation==

	At the current time, the contents of the [["~~extensions~~" container]] is not validated. It is expected that future versions of Trainz and the [[Download Station]] will perform validation of the extensions container according to the rules described on this page. Furthermore, it is feasible that N3V will formally adopt specific extensions which have entered common use. In this scenario, N3V may choose to introduce asset validation to the extension creator's formal specification or, where such specification is not available, to a formal specification written by N3V derived from the common usage.		At the current time, the contents of the [["Extensions" container]] is not validated. It is expected that future versions of Trainz and the [[Download Station]] will perform validation of the extensions container according to the rules described on this page. Furthermore, it is feasible that N3V will formally adopt specific extensions which have entered common use. In this scenario, N3V may choose to introduce asset validation to the extension creator's formal specification or, where such specification is not available, to a formal specification written by N3V derived from the common usage.

	==Extension Documentation==		==Extension Documentation==
Line 19:		Line 19:
	* Add your entry here.		* Add your entry here.

	=="~~extensions~~" container Example==		=="Extensions" container Example==

	extensions		extensions

Windwalkr: "extensions" container moved to "Extensions" container

2010-10-17T15:05:23Z

"extensions" container moved to "Extensions" container

← Older revision	Revision as of 15:05, 17 October 2010
(No difference)

Windwalkr at 14:47, 17 October 2010

2010-10-17T14:47:50Z

← Older revision		Revision as of 14:47, 17 October 2010
Line 2:		Line 2:

	The extensions container is a list of custom tags or subcontainers with a specific naming convention.		The extensions container is a list of custom tags or subcontainers with a specific naming convention.


	==Supported Tags==		==Supported Tags==
Line 13:		Line 12:

	At the current time, the contents of the [["extensions" container]] is not validated. It is expected that future versions of Trainz and the [[Download Station]] will perform validation of the extensions container according to the rules described on this page. Furthermore, it is feasible that N3V will formally adopt specific extensions which have entered common use. In this scenario, N3V may choose to introduce asset validation to the extension creator's formal specification or, where such specification is not available, to a formal specification written by N3V derived from the common usage.		At the current time, the contents of the [["extensions" container]] is not validated. It is expected that future versions of Trainz and the [[Download Station]] will perform validation of the extensions container according to the rules described on this page. Furthermore, it is feasible that N3V will formally adopt specific extensions which have entered common use. In this scenario, N3V may choose to introduce asset validation to the extension creator's formal specification or, where such specification is not available, to a formal specification written by N3V derived from the common usage.

			==Extension Documentation==

			If you are a third-party content creator who has created a custom extensions according to these specifications, please document your extension on this wiki and link to your extension page here:

			* Add your entry here.

	=="extensions" container Example==		=="extensions" container Example==

Windwalkr at 14:45, 17 October 2010

2010-10-17T14:45:29Z

← Older revision		Revision as of 14:45, 17 October 2010
Line 6:		Line 6:
	==Supported Tags==		==Supported Tags==

	The naming of top-level tags within the [["extensions" container]] is important. Tag names should be meaningful and must end with a hyphen followed by the [[~~UserID~~]] of the content creator who is introducing the extension. This content creator is solely responsible for determining any rules and restrictions which apply to the tag or subcontainer, and should ideally make an effort to provide this information to other creators via this wiki. While content creators are permitted to make use of each other's extension formats, it is not permissible for a creator to introduce a new extension (or change the meaning of an extension) which exists in a namespace belonging to another content creator.		The naming of top-level tags within the [["extensions" container]] is important. Tag names should be meaningful and must end with a hyphen followed by the [[KUID#User_ID_Number\|User ID]] of the content creator who is introducing the extension. This content creator is solely responsible for determining any rules and restrictions which apply to the tag or subcontainer, and should ideally make an effort to provide this information to other creators via this wiki. While content creators are permitted to make use of each other's extension formats, it is not permissible for a creator to introduce a new extension (or change the meaning of an extension) which exists in a namespace belonging to another content 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 documentation. No restrictions are placed by N3V on the values within a specific extension.		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 documentation. No restrictions are placed by N3V on the values within a specific extension.

Windwalkr at 14:42, 17 October 2010

2010-10-17T14:42:29Z

@@ Line 1: / Line 1: @@
-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.
+The [["extensions" container]] is a top-level [[config.txt file]] entry available to any Asset which derives from [[KIND TrainzBaseSpec]] (in short, all Assets.) This container is intended to allow third-party developers to introduce custom Asset-keyed data which may be processed by custom scripts.
-All third-party tags must be embedded under an extensions container which is placed at the top level in the config.txt file.
+The extensions container is a list of custom tags or subcontainers with a specific naming convention.
-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.
+==Supported Tags==

Windwalkr: import explanatory text from the TCCCG

2010-10-17T14:23:10Z

import explanatory text from the TCCCG

New page

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.