How to Create a HTML Asset

Revision as of 16:17, 25 May 2018

HTML assets in TANE consist of several parts:-

• a config.txt file which is mandatory
• (optionally) one or more HTML formatted text files of type .htm, .html
• one or more graphic files of type .jpg, .tga, .png, .bmp. One of these must be the asset thumbnail.
• (optionally) one or more sound files of type .wav
• (optionally) one or more folders

Config.txt

A standard config.txt file that must include the following tags:-

• kind set to "html-asset"
• username set to the page title
• kuid a unique ID number
• category-class set to "YH"
• thumbnails a 240 by 180 pixel image

While not mandatory, the following tag is useful:-

• category-class set to "YH"

An example (the order of the "tags" is not important):-

kuid                                    <kuid:45176:100207>
username                                "TGR Fingal Line 1955 - Mixed Goods Sessions"
trainz-build                            4.5
kind                                    "html-asset"
description                             "HTML data for TGR Fingal Line 1955 Conara Mixed Goods Sessions - all versions"
category-class                          "YH"
thumbnails
{
  0
  {
    image                               "thumbnail.jpg"
    width                               240
    height                              180
  }
}

• The <kuid> is unique to every asset which is why it is not advisable to select your own. This will be automatically generated by the Content Manager program when a new asset is created.
• The username is your description of the asset and the description that other users will see. It is advisable to make it compact and meaningful.
• The trainz-build identifies the minimum Trainz version for this asset. A list of asset trainz-build numbers and their corresponding Trainz versions can be found at "Trainz-build"_number.
• The kind identifies the type of asset and the types of files that Trainz will expect to find in the asset. It also tells Trainz how to render the asset and how to error check the asset. A list of asset kinds can be found at KIND_TrainzBaseSpec#KIND_Hierarchy
• The category-class identifies the intent of the asset and is important in classifying it for filtering and searching. A list of category classes can be found at Category-class
• The description provides more detail than the username.
• The thumbnails is the preview image of the asset shown by the Content Manager program and the Web version of the DLS. Information on thumbnails can be found at Thumbnails