[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14. Catalog CGI

This chapter lists all the invocations of the Catalog package and is a reference for the available parameters, the template used and the functionality provided.

images/fctcatalog

14.1 Control panel (ccontrol_panel)  
14.2 Ask for catalog destruction (cdestroy)  
14.3 Catalog destruction (cdestroy_confirm)  
14.4 Reset count on alpha catalog (calpha_count)  
14.5 Reset count on theme catalog (category_count)  
14.6 Build a new catalog (cbuild)  
14.7 Modify catalog properties (ccatalog_edit)  
14.8 Browse alphabetical catalog root (calpha)  
14.9 Browse alphabetical catalog (calpha)  
14.10 Browse theme catalog root (cbrowse_root)  
14.11 Browse theme catalog (cbrowse)  
14.12 Intuitive navigation (pathcontext)  
14.13 Catalog search (csearch)  
14.14 Browse chronological catalog root (cdate)  
14.15 Edit panel for a category node (cedit)  
14.16 Remove a category (categoryremove)  
14.17 Insert a category (categoryinsert)  
14.18 Link a catalog entry (centryselect)  
14.19 Create and link a catalog entry (centryinsert)  
14.20 Create a symbolic link (categorysymlink)  
14.21 Unlink a catalog entry (centryremove)  
14.22 Ask to remove a catalog entry (centryremove_all)  
14.23 Remove a catalog entry (centryremove_all_confirm)  
14.24 Ask for confirmation before dump (cdump)  
14.25 Dump a thematic catalog (cdump_confirm)  
14.26 Query parameters for load (cimport)  
14.27 Load a thematic catalog from file (cimport_confirm)  
14.28 Query parameters for unload (cexport)  
14.29 Unload a thematic catalog to file (cexport_confirm)  


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.1 Control panel (ccontrol_panel)

images/controlpanel4

`Description'
Display a panel that shows all existing catalogs, allows creation of new catalogs, shows links to edit or browse each catalog and have links to edit the configuration files.

`Template file'
See section ccontrol_panel.html.

`Parameters'

`context (mandatory, ccontrol_panel)'


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.2 Ask for catalog destruction (cdestroy)

images/cdestroy

`Description'
First step of catalog removal. Shows a screen asking for confirmation of the removal.

`Template file'
See section cdestroy.html.

`Parameters'

`context (mandatory, cdestroy)'
`name (mandatory)'
Unique name of the catalog.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.3 Catalog destruction (cdestroy_confirm)

`Description'
Effective destruction of the named catalog.

`Template file'
See section ccontrol_panel.html.

`Parameters'

`context (mandatory, cdestroy_confirm)'
`name (mandatory)'
Unique name of the catalog.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.4 Reset count on alpha catalog (calpha_count)

`Description'
Reset the count of entries for an alphabetically ordered catalog. The values contained in the field name used for ordering are listed. Each alphanumerical character (A thru Z, 0 thru 9) that appear in first position is counted. The result is stored in a table for use by the Browse alphabetical catalog root action.

This operation is not needed in normal operation since it will be automatically calculated every 24 hours. It may be called for immediate update, after a large update operation, for instance.

`Template file'
See section ccontrol_panel.html.

`Parameters'

`context (mandatory, calpha_count)'
`name (mandatory)'
Unique name of the catalog.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.5 Reset count on theme catalog (category_count)

`Description'
Reset the count of entries for an category tree ordered catalog.

Each node of the tree contains the number of entries it contains plus the total number of entries contained in all its sub categories. Thus, the root node contains the total number of entries in the catalog.

The symbolic links are ignored when updating the counts. This is to prevent counting entries twice.

This operation is never needed in normal operation. It may be used after an accidental update of the count using a direct SQL order.

`Template file'
See section ccontrol_panel.html.

`Parameters'

`context (mandatory, category_count)'
`name (mandatory)'
Unique name of the catalog.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.6 Build a new catalog (cbuild)

images/catalogcreate

`Recursion on insertion'
The recursion is done on Record insert form, See section Record insert form (sinsert_form).

`Description'

Create a new catalog. This is done by inserting a new record in the catalog table. The information that should be filled in this record depends on the type of catalog created.

Here is a list of the fields:

`Common to all types'
`name (mandatory)'
The name of the catalog. May contain alphanumerical characters only (A thru Z, 0 thru 9). It must be unique.
`corder (optional)'
The ORDER BY SQL clause that will be used when displaying the catalogued table entries at one level of the catalog.
`cwhere (optional)'
The WHERE SQL clause that will be used to find the entries that will be displayed. This may be used to put in the catalog only part of the records of the table.

`Alphabetical and Chronological catalogs'
`fieldname (mandatory)'
The name of the field from the catalogued table that will be considered for alphabetical or chronological ordering.

`Template files'

`Thematic'
See section catalog_theme_insert.html.

`Alphabetical'
See section catalog_alpha_insert.html.

`Chronological'
See section catalog_date_insert.html.

`Parameters'

`context (mandatory, cbuild)'
`navigation (mandatory)'
`table (mandatory)'
Name of the database table for which the catalog will be created.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.7 Modify catalog properties (ccatalog_edit)

images/ccatalogedit

`Recursion on edition'
The recursion is done on Record edit form, See section Record edit form (edit).

`Description'
Modify the properties of an existing catalog.

Here is a list of the modifiable fields:

`Common to all types of catalog'
`name (mandatory)'
The name of the catalog. May contain alphanumerical characters only (A thru Z, 0 thru 9). Must be unique.
`corder (optional)'
The order by SQL clause that will be used when displaying the catalogued table entries at one level of the catalog.
`cwhere (optional)'
The where SQL clause that will be used to find the entries that will be displayed. This may be used to put in the catalog only part of the records of the table.

`Alphabetical and Chronological catalog'
`fieldname (mandatory)'
The name of the field from the catalogued table that will be considered for alphabetical ordering.

`Template files'

`Thematic'
See section catalog_theme_edit.html.

`Alphabetical'
See section catalog_alpha_edit.html.

`Chronological'
See section catalog_date_edit.html.

`Parameters'

`context (mandatory, ccatalog_edit)'
`name (mandatory)'
Unique name of the catalog.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.8 Browse alphabetical catalog root (calpha)

images/calpharoot

`Description'
Display the root page of the alphabetically ordered catalog. This page contains one entry for each letter and digit. This entry is associated to an hypertext link if there exists records in the catalogued table. The number of records founds for each letter is displayed next next to the letter.

The count associated with each letter is recalculated every 24 hour. There may be differences between the count shown in this page and the actual records shown by the Browse alphabetical catalog action.

`Template file'
See section calpha_root.html.

`Parameters'

`context (mandatory, calpha)'
`name (mandatory)'
Unique name of the catalog.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.9 Browse alphabetical catalog (calpha)

images/calpha

`Description'
Display the records from the catalogued table for which the field value begins with the letter parameter letter. The field name used for this operation is the value of the fieldname field of the record describing the catalog.

This action is implemented using the Search table action, See section Search table (search).

`Template file'
See section sqledit_search.html.

`Parameters'

`context (mandatory, calpha)'
`letter (mandatory)'
The letter used for the search, may be (A thru Z, 0 thru 9).
`name (mandatory)'
Unique name of the catalog.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.10 Browse theme catalog root (cbrowse_root)

`Description'
Provides exactly the same functionality as the Browse theme catalog action. The only difference is the name of the template file used to display the result.

`Template file'
See section cbrowse_root.html.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.11 Browse theme catalog (cbrowse)

`Description'
Provides the same basic functionalities as the Edit panel for a category node action. The differences are listed below:

`Category hiding'
If a category is empty and the hideempty flag of the catalog is set, do not display the category.

`Editing tags'
The tags that allow editing of the catalog are not available.

`context parameter'
Is set to cbrowse instead of cedit

`Template file'
Is cbrowse.html instead of cedit.html.

`Template file'
See section cbrowse.html.

`Parameters'

`context (mandatory, cbrowse)'
`other tags'
Same as cedit, See section Edit panel for a category node (cedit).


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.12 Intuitive navigation (pathcontext)

`Description'
This context is implicitly called when the cgi-bin call has a PATH_INFO component, See section CGI called with PATH_INFO. The PATH_INFO environment variable is available in the pathname parameter. The name of the catalog to browse and other parameters are extracted from the pathcontext_params instruction found in the catalog.conf configuration file, See section Catalog configuration file. The pathname parameter is converted to a category id using the catalog_path_NAME table. Finally, the cbrowse context is called for the category.

It must be noted that the results are not paginated when browsing a catalog in this way. This restriction is meant to simplify the implementation, in particular for dumping the catalog in HTML pages.

The handling of symbolic links is different when browsing with pathcontext. With cbrowse the symbolic links are displayed as normal sub categories. For instance, if /a/b contains a symbolic link to /c, browsing /a/b to go in /c will show the full path name /a/b/c. When browsing with pathcontext, going to /c will show the full path name /c. In other words symbolic links retain their original full path name when browsing with pathcontext.

`Template file'
See section cbrowse_root.html. See section cbrowse.html.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.13 Catalog search (csearch)

images/examplecsearch2

`Description'
Searching a thematic catalog is a two step process, if not specified otherwise by the what parameter. First, the category names are searched with the search criterion (text parameter). If categories are found, they are displayed. If no category matches the search criterion, the records are searched with the same criterion. A new search form is shown on top of the search results, giving the opportunity to the user to change the search criterion or to search in the records instead of the categories.

The search criterion specified in the text parameter is parsed using the same rules than AltaVista simple search. If the querymode parameter is set to advanced, the AltaVista advanced search syntax is used instead.

When searching the categories, the search is done on the name field, See section catalog. The ordering of the categories is ascending alphabetical.

When searching the records, the search is done using all the fields of type char, varchar or text, if not specified otherwise in the catalog.conf configuration file, See section Catalog configuration file. The first order criterion of the records is the name of the category they belong to so that every record in the same category are displayed together. Optional additional order criterion may be specified in the catalog.conf configuration file, See section Catalog configuration file.

`Template file'
See section csearch.html.

`Parameters'

`context (mandatory, csearch)'
`name (mandatory)'
Unique name of the catalog. It must be the name of a thematic catalog.

`text (mandatory)'
The search criterion. Each alphanumerical and dash (-) sequence of character of this parameter is a distinct search criterion.

`what (optional)'
Specifies the domain of the search. If set to categories, only the category names will be searched. If set to records, only the records will be searched. If not set the categories will be searched first and, if no category matches, the records will be searched.

`mode (optional, default cbrowse)'
Specifies the context in which the search is made. It can be either cbrowse, cedit, pathcontext or static. The href links displayed in the result page will use the specified context. The static context allows to include a search form that uses the static dump of a catalog.

When set to static, the _SCRIPT_ tag will be replaced by the dump location stored in the dumplocation field of the record describing the catalog, See section Dump a thematic catalog (cdump_confirm). If you want to include a search form in the results of the search, make sure that the templates contains the explicit location of the cgi-bin script to use instead of _SCRIPT_.

`querymode (optional, default simple)'
Specifies syntax of the search string. If set to simple, AltaVista simple search syntax is used. If set to advanced, AltaVista advanced search syntax is used.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.14 Browse chronological catalog root (cdate)

images/cdate

`Description'
Display the records associated with a date field included in the period specified by the date argument of the cgi-bin. A calendar of the period is displayed for each period that contains at least one record and the number of records is calculated for each period.

The period used to find records to display can be different from the period used to find entries displayed in the calendar. This is achieved by using the index_date and records_date cgi-bin parameters.

To improve performances, the number of entries for each period is cached in a temporary table. The cache is refreshed every 24h. If an immediate refresh is necessary, the cdate_count action may be used to flush the cache.

`Template files'

`cdate_default.html'
See section cdate_default.html.

`cdate_<template>.html'
This template will be used if the template cgi-bin parameter is set. This is typically the case if you want a different display to display all the years of the current period, only one year, only one month or only one day. See the template parameter description below.

`Parameters'

`context (mandatory, cdate)'

`name (mandatory)'
Unique name of the catalog.

`template (optional, default default)'
Modifies the name of the template used to display the results. If omitted it defaults to the string default. The template name used is calculated in the following manner:

 
date_<template>.html

This is typically used to differentiate templates that display years, months and days.

`date (optional)'
Specify the period for both calendar and records displayed. It may have the following forms:

`YYYY'
Defines the period from January 1st 00:00 to December 31 23:59 of the YYYY year.

`YYYYMM'
Defines the period from the first day of YYYYMM month 00:00h to last day of the same month 23:59h.

`YYYYMMDD'
Defines the period of the YYYYMMDD day from 00:00h to 23:59h.

`records_date'
Same syntax as parameter date but only applies to the display of records.

`index_date'
Same syntax as parameter date but only applies to the display of the calendar.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.15 Edit panel for a category node (cedit)

images/entryinsert2

`Description'
Display the sub-categories and entries of a given node in the category tree. Buttons will be displayed to allow modification of each element in the page.

The information displayed is:

List of actions that modify the displayed category:

images/new
Create a new record in the table associated with the catalog and link it to the current category, See section Create and link a catalog entry (centryinsert).

images/link
Display a search form that will allow you to choose a record in the table associated with the catalog and link this record to the current category. In short, add a link to an existing record in this category. This effectively allows you to include a given record in many categories of the category tree, See section Link a catalog entry (centryselect).

images/open
Create a new sub category, See section Insert a category (categoryinsert).

images/plus
A link to create a sub category that is a symbolic link to an existing category, See section Create a symbolic link (categorysymlink).

images/control
A link to go back to the control panel, See section Control panel (ccontrol_panel).

The list of actions associated with each sub-category of the current category:

images/cut
Remove this sub-category. Note that only empty sub-categories can be removed. See section Remove a category (categoryremove).

images/edit
Edit the properties of this sub-category.

The list of actions associated with each entry in the current category:

images/unlink
Destroy the link between the record and the current category, See section Unlink a catalog entry (centryremove). The record itself is not removed from the table associated with the catalog.

images/cut
Remove the record and all links in all categories, See section Ask to remove a catalog entry (centryremove_all).

images/edit
Edit the record, See section Record edit form (edit). When the record is updated the current category is displayed.

The display of the path requires some explanation. The path of a category is the list of category nodes used by the user to reach a given point of the catalog. When the path is displayed, each component is a link that gives direct access to the corresponding category. The last component of the path is the currently displayed category node and is therefore not shown as an hypertext link. The components of the path are separated by a string (by default / ) taken from the catalog configuration file, See section Catalog configuration file. The label displayed to represent the root of the catalog is Root by default or is taken from the catalog configuration file, See section Catalog configuration file.

If the path is omitted (in normal operation it is fully specified in the parameter list of the cgi, see below), it will be rebuilt using the path from the category node designated by the id parameter and the root of the catalog that does not include any symbolic links.

`Template file'
See section cedit.html.

`Parameters'

`context (mandatory, cedit)'
`name (mandatory)'
Unique name of the catalog.
`id (mandatory)'
The rowid of the category node to display. The rowid is relative to the catalog_category_NAME table, See section catalog_category_NAME.
`path (optional, default to shortest path)'
The coma separated list of rowids used to reach the category node or the shortest path from id to root.
`fct_name (optional)'
If set to select, the symlink part of the template is generated. Otherwise the part is omitted.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.16 Remove a category (categoryremove)

`Description'
Remove the category designated by the child parameter.

If the category is indeed a symbolic link to another category, it is remove regardless.

If the category is not as symbolic link and contains entries or sub categories, it is not removed and an error message is displayed.

`Template file'
See section cedit.html.

`Parameters'

`context (mandatory, categoryremove)'
`name (mandatory)'
Unique name of the catalog.
`id (mandatory)'
The rowid of the category containing the child category.
`child (mandatory)'
The rowid of the category to be removed.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.17 Insert a category (categoryinsert)

images/categoryinsert

`Recursion on insertion'
The recursion is done on Record insert form, See section Record insert form (sinsert_form). The table used is catalog.

The name of the new category must not contain a slash (/). It may contain white spaces and accented characters.

`Description'
Insert a new category.

Here is the list of fields that can be filled when creating a category:

`name'
The name of the category

`externalid'
A unique key, imported from an external catalog.

`Template file'
See section cedit.html.

`Parameters'

`context (mandatory, categoryinsert)'
`name (mandatory)'
Unique name of the catalog.
`id (mandatory)'
The rowid of the category that will contain the new category.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.18 Link a catalog entry (centryselect)

images/centryselect

`Recursion on selection'
The recursion is done on Search table, See section Search table (search). The catalogued table is used for the table argument.

`Description'
The selected record of the catalogued table is linked to the current category. When this is done the current category is displayed and shows the newly inserted entry.

`Template file'
See section cedit.html.

`Parameters'

`context (mandatory, centryselect)'
`name (mandatory)'
Unique name of the catalog.
`id (mandatory)'
The rowid of the category that will contain the new entry.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.19 Create and link a catalog entry (centryinsert)

`Recursion on insertion'
The recursion is done on Record insert form, See section Record insert form (sinsert_form). The catalogued table is used for the table argument.

`Description'
The insertion form for the catalogued table is shown. The user may enter values for the various fields of the table. The constraints related to the catalogued table is not defined here and depend on the application.

Once the insertion is done, the inserted record of the catalogued table is linked to the current category and the current category is displayed and shows the newly inserted entry.

`Template file'
See section cedit.html.

`Parameters'

`context (mandatory, centryinsert)'
`name (mandatory)'
Unique name of the catalog.
`id (mandatory)'
The rowid of the category that will contain the new entry.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.20 Create a symbolic link (categorysymlink)

images/categorysymlink

`Recursion on navigation'
The recursion is done on Edit panel, See section Edit panel for a category node (cedit). The catalog used is the catalog named by the name parameter.

`Description'
The objective is to chose a category that will be added as a sub-category of the current category. However, instead of creating a brand new category, we want to select an existing one and create a symbolic link to it.

To select a category, the category editor is called recursively, See section Recursive CGI call. This allows you to browse the catalog hierarchy. Note that you will see an additional link that says Select this category as a symbolic link. If you click on this link you will effectively chose the current category as the end point of the symbolic link to be created.

`Template file'
See section cedit.html.

`Parameters'

`context (mandatory, categorysymlink)'
`name (mandatory)'
Unique name of the catalog.
`id (mandatory)'
The rowid of the category that will contain the new symbolic link to another category.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.21 Unlink a catalog entry (centryremove)

`Description'
The record from the catalogued table designated by the row parameter is unlinked from the current category. The record itself is not removed and the links to this record that appear in other categories of the same catalog are not touched.

`Template file'
See section cedit.html.

`Parameters'

`context (mandatory, centryremove)'
`name (mandatory)'
Unique name of the catalog.
`id (mandatory)'
The rowid of the category that will contain the new symbolic link to another category.
`row (mandatory)'
The primary key of the record from the catalogued table.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.22 Ask to remove a catalog entry (centryremove_all)

`Description'
First step of entry removal.

`Template file'
See section centryremove_all.html.

`Parameters'

`context (mandatory, centryremove_all)'
`name (mandatory)'
Unique name of the catalog.
`id (mandatory)'
The rowid of the category that will contain the new symbolic link to another category.
`row (mandatory)'
The primary key of the record from the catalogued table.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.23 Remove a catalog entry (centryremove_all_confirm)

`Description'
The record from the catalogued table designated by the row parameter is removed from the catalogued table. All the links to this record in the current catalog are removed, including the link in the current category.

`Template file'
See section cedit.html.

`Parameters'

`context (mandatory, centryremove_all_confirm)'
`name (mandatory)'
Unique name of the catalog.
`id (mandatory)'
The rowid of the category that will contain the new symbolic link to another category.
`row (mandatory)'
The primary key of the record from the catalogued table.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.24 Ask for confirmation before dump (cdump)

`Description'
Ask for confirmation before the dump of a thematic catalog. The user has the opportunity to change the path where the pages will be dumped and the HTML location from where they will be read. The initial values of the path and location fields are read from the catalog description (in the catalog table).

`Template files'
See section cdump.html.

`Parameters'

`context (mandatory, cdump)'
`name (mandatory)'
Unique name of the catalog.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.25 Dump a thematic catalog (cdump_confirm)

`Description'
Each page of the thematic catalog is written to disk (starting from the full path name specified with the path location). All the files and sub directories of path will be removed before dump. Make sure it does not contain valuable data. Each category is written in an index.html file located in a sub directory of the path. The sub directory name is the complete category path of the category. In each files the links to other categories are built as if the location parameter was the cgi-bin script. When the operation is finished, the control panel is redisplayed.

`Template files'
See section cbrowse_root.html. See section cbrowse.html.

`Parameters'

`context (mandatory, cdump_confirm)'
`name (mandatory)'
Unique name of the catalog.
`path (mandatory)'
Full path name of an existing directory. Saved in the dump field of the catalog table.
`location (mandatory)'
The HTML location used as base for links in the dumped pages. Saved in the dumplocation field of the catalog table.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.26 Query parameters for load (cimport)

`Description'
Output a form so that user can specify the name of the thematic catalog to load (name parameter) and the file containing an XML representation of the catalog (file parameter).

`Template files'
See section cimport.html.

`Parameters'

`context (mandatory, cimport)'
`name (optional)'
Unique name of the catalog.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.27 Load a thematic catalog from file (cimport_confirm)

`Description'
Build or rebuild a catalog from the external XML representation found in the file specified by the file parameter, See section External representation.

`Template files'
See section ccontrol_panel.html.

`Parameters'

`context (mandatory, cimport)'
`name (mandatory)'
Unique name of the catalog.
`file (mandatory)'
Path name of the file containing the external representation, See section External representation.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.28 Query parameters for unload (cexport)

`Description'
Output a form so that user can specify the name of the thematic catalog to unload (name parameter) and the file that will containi an XML representation of the catalog (file parameter).

`Template files'
See section cexport.html.

`Parameters'

`context (mandatory, cexport)'
`name (optional)'
Unique name of the catalog.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

14.29 Unload a thematic catalog to file (cexport_confirm)

`Description'
Build an external XML representation for the catalog specified by the name parameter in the file specified by the file parameter, See section External representation.

`Template files'
See section ccontrol_panel.html.

`Parameters'

`context (mandatory, cexport)'
`name (mandatory)'
Unique name of the catalog.
`file (mandatory)'
Path name of the file containing the external representation, See section External representation.


[ << ] [ >> ]           [Top] [Contents] [Index] [ ? ]

This document was generated by root on November, 18 2003 using texi2html