4.20. description

4.20.1. Summary

Parameters: code base

Positional parameters in same order.

Pass attribute hash as last to subroutine: no

Must pass named parameter interpolate=1 to cause interpolation.

Invalidates cache: no

Called Routine:

ASP-like Perl call:

         code => VALUE,
         base => VALUE,


    $Tag->description($code, $base);
    [description code base]
Parameters Description Default
Attributes Default
interpolate (reparse) No
Invalidates cache no
Container tag No
Has Subtags No
Nests Yes

Tag expansion example:

    [description code base]
    TODO: (tag result)

ASP-like Perl call:

   $Tag->description(  { base => VALUE_base
                          code => VALUE_code
}, $body  );

or similarly with positional parameters,

    $Tag->description(code,base, $attribute_hash_reference, $body);

4.20.2. Description

Expands into the description of the product identified by code as found in the products database. This is the value of the database field that corresponds to the catalog.cfg directive DescriptionField. If there is more than one products file defined, they will be searched in order unless constrained by the optional argument base.

This tag is especially useful for multi-language catalogs. The DescriptionField directive can be set for each locale and point to a different database field; for example desc_en for English, desc_fr for French, etc. base code