[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
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.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
ccontrol_panel.html
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
cdestroy.html
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
ccontrol_panel.html
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
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.
ccontrol_panel.html
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
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.
ccontrol_panel.html
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Record insert form (sinsert_form)
.
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:
ORDER BY
SQL clause that will be used when displaying
the catalogued table entries at one level of the catalog.
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.
catalog_theme_insert.html
.
catalog_alpha_insert.html
.
catalog_date_insert.html
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Record edit form (edit)
.
Here is a list of the modifiable fields:
order by
SQL clause that will be used when displaying
the catalogued table entries at one level of the catalog.
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.
catalog_theme_edit.html
.
catalog_alpha_edit.html
.
catalog_date_edit.html
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
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.
calpha_root.html
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This action is implemented using the Search table action,
See section Search table (search)
.
sqledit_search.html
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
cbrowse_root.html
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
cbrowse.html
.
Edit panel for a category node (cedit)
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
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.
cbrowse_root.html
.
See section cbrowse.html
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
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
.
csearch.html
.
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_.
AltaVista
simple search syntax is used.
If set to advanced, AltaVista
advanced search syntax is used.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
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.
cdate_default.html
.
date_<template>.html |
This is typically used to differentiate templates that display years, months and days.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
The information displayed is:
List of actions that modify the displayed category:
Create and link a catalog entry (centryinsert)
.
Link a catalog entry (centryselect)
.
Insert a category (categoryinsert)
.
Create a symbolic link (categorysymlink)
.
Control panel (ccontrol_panel)
.
The list of actions associated with each sub-category of the current category:
Remove a category (categoryremove)
.
The list of actions associated with each entry in the current category:
Unlink a catalog entry (centryremove)
. The
record itself is not removed from the table associated with the
catalog.
Ask to remove a catalog entry (centryremove_all)
.
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.
cedit.html
.
catalog_category_NAME
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
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.
cedit.html
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
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.
Here is the list of fields that can be filled when creating a category:
cedit.html
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Search table (search)
. The catalogued table is used for the table argument.
cedit.html
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Record insert form (sinsert_form)
.
The catalogued table is used for the table argument.
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.
cedit.html
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Edit panel for a category node (cedit)
.
The catalog used is the catalog named by the name parameter.
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.
cedit.html
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
cedit.html
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
centryremove_all.html
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
cedit.html
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
cdump.html
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
cbrowse_root.html
.
See section cbrowse.html
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
name
parameter) and the file containing an XML representation
of the catalog (file
parameter).
cimport.html
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
file
parameter, See section External representation
.
ccontrol_panel.html
.
External representation
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
name
parameter) and the file that will containi an XML
representation of the catalog (file
parameter).
cexport.html
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
name
parameter in
the file specified by the file
parameter, See section External representation
.
ccontrol_panel.html
.
External representation
.
[ << ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |