Contents | Parent Topic | Previous Topic | Next Topic
Home | Catalog

# 6.4. catalog Macro

## Interface

The general syntax is:

      !catalog class mask [; params]

The arguments are:

Name | Type | Default | Rule
class | symbol |  |
mask | string |  |
params | rest | _NULL_ |

See Understanding Macro Interfaces, if necessary.

## Description

The catalog macro build a catalog from objects already loaded.

The class parameter specifies the class name. As it is defined as a symbol rather than a string type, the name is given without quotes and it is space-separated from the following parameter.

The mask parameter can be used to filter the objects as shown below:

Mask | Description
empty string | no filtering - display all objects
cited | display just the cited objects
abc.* | display the objects with (short) names matching the pattern, i.e. names beginning with abc
xyz:abc | display the objects where attribute xyz matches the pattern, i.e. xyz is exactly equal to abc

Remaining parameters are passed through to the class filter.

## Examples

Display some interesting attributes of references with a Status of 'Review':

    !catalog references 'Status:Review'; compact; \
      columns="PDF,2:Reference,DOC:Document,Version"