Template:Sort index table/doc

This is a helper template for the sort index templates that look up a name for a specific property and return the standard sort position. It isn't intended to be directly used in articles.

Instead, it is used in the noinclude section of "index" templates as follows:

Where:
 * should be replaced with the name of the Cargo table that the index will be stored in.
 * should be replaced with the "names" template that contains the, well, names.

See Element index for an example of such a template.

Note that the table needs a definition in the  table in Module:Cargo before this can work.

This will look like the following: PropertyIndex = { { 'position', 'Integer' }, { 'name', 'String' }, },

Again, with  should be replaced with the desired Cargo table name. This needs be inserted between the  line and the line with the unindented   that follows, and not inside any other table definitions in that part of the module.

The "names" templates should look like the following: &lt;noinclude>[Property] names in preferred sort order:

&lt;/noinclude>

See Element names for an example of such a template.