|
<CATDEF> ... </CATDEF>
Full Syntax
<CATDEF>
NAME = { string }
TYPE = STRING | NUMERIC
PREMOD = { string }
POSTMOD = { string }
PRECISION = { number }
MULTIPLE = YES | NO
DISPLAYINTEXT = YES | NO
INTERNAL = YES | NO
SORTED = YES | NO
REGISTEREDONLY = YES | NO
REQUIRED = YES | NO
MAX = { number }
MIN = { number }
VALUES = { string } [,{ string },{ string },... ]
</ CATDEF>
Parameters
NAME
Defines the category name. This can be any string. Can't be empty.
TYPE
This parameter can have only 2 values for now. Either "string" or "numeric". If it is "string", the category is string type. It's values will be treated as strings even if they are numbers. You can assign numeric values to a string type category without being complained by the compiler. But they won't have proper sort order when displayed in the tr3 viewer. If you sort subjects by this category, it won't get proper sort order either.
If the type is "numeric", all the values of this category must be numeric values. If any none- numeric value is assigned, compiler will flag it as a critical error and will cause the compilation to be aborted.
Premod / PostMod
These two keywords define the modifiers that can be used with numeric type categories.
e.g:
Consider the following category with currency values.
<catdef>
Name = "Price"
Premod = "$"
</catdef>
Values for this category will be displayed in the tr3 viewer like
$10
$50
$100
...
Each value is preceded by "$" when displayed.
PostMod does the same thing except that it put the modifier after the value.
e.g
<catdef>
Name = "Weight"
PostMod = "Kg"
</catdef>
This category will be displayed as followed.
10Kg
50Kg
100Kg
Precision
This defines the precision of the values for a numeric category. If the compiler sees any value with higher precision is being assigned to the category, a warning will be issued and the value will be automatically rounded off to the value defined by this parameter.
If the value with lower precision is being assigned, zeros will be appended when the viewer displays the value. Default precision is 0.
Multiple
This defines whether this category can have multiple values for one subject or just one value per subject. If Multiple = yes, this category can have multiple values. Otherwise an error will be flagged when more than one value is being assigned within any single subject.
DisplayInText
This parameter defines whether the value(s) of this category for a given subject should be displayed in the page of that subject when it is viewed. When the page is being displayed, value(s) will be extracted by the category data and appended to the page according to current settings of the viewer.
This may effect page display performance specially in the mobile devices with less processing power since retrieving category values involve decompressing many blocks of data depending on the number of values that particular subject has. But, when it is necessary to display those values in the page, you can save some file space by instructing tr to retrieve them from category data instead of repeating them in the page text again. But this comes with the cost of sacrificing page display performance.
Internal
This property is ignored for now
Sorted
This defines whether the category can be used to sort the subject list or not. This is ignored in the current beta version. But, will be implemented in future versions. Default value is "no"
RegisteredOnly
This category is only available in the registered tr3 file. Effect of this parameter is not yet enforced in the beta version. Default value is "no"
Required
If this parameter has "yes", each and every subject must have at least one value for this category. Otherwise an error will be raised and the compilation will be aborted.
Max / Min
Maximum and Minimum allowed values for the numeric type categories. If the category is being assigned a value above it's maximum or below it's minimum the compiler will flag an error. Minimum value should not exceed the maximum. Maximum or minimum can't be given after the value set for the category has been fixed by "values" parameter. (See below)
Values
This parameter specifies the set of possible values for this category. All possible values can be given as a comma separated list of strings (See the syntax of string below). If this parameter is used in the category definition, it's value set is fixed. Trying to assign a value other than specified in "values" set will cause an error. If this parameter is not used, each new value being assigned is added to the category's value set and it automatically grow as the new subjects are being scanned.
{ string }
As long as the string doesn't have spaces at the middle, it can be given without quotes.
Otherwise, double quotes should be used. If the double quotes occur in the string, the fullowing format should be used.
e.g.
<catdef>
Name="The \"Cat\""
</catdef>
{ number }
Any decimal number is valid. Using double quotes is optional
Remarks
This tag pair defines a category. <catdef> should always be closed by a </catdef>.
It's only valid in the header section before the first new tag in the file. Any <catdef>.</catdef> pair occurred in the page text (i.e. after a new line) along with it's contents will be treated as raw text and thus will not be interpreted.
|
