Suggest
Warn if a named facility is not present.
Synopsis
Scope
This directive is only available for use in the local
(catalog.cfg) configuration file.
It will not affect any other website in any way.
This directive will not work in the global
(interchange.cfg) configuration file.
Description
This directive makes Interchange check for a named facility
before starting the website and/or interchange itself.
If the named facility is not present then Interchange will show
a warning.
Unlike Require, Interchange will continue to try
to start,
even if a suggested facility is missing.
Facility types
The following facility types can be checked for:
| Type
|
Descrption
|
Versions
|
| executable
|
Check that a file exists and is executable by the user ID that
started the current Interchange instance.
If specified in a global (interchange.cfg)
configuration file then any file on the filesystem may be checked.
If specified in a local (catalog.cfg) configuration
file then only files relative to the website's home directory,
as configured using the Catalog global
configuration directive,
may be checked. |
5.5.0+
|
| file
|
Check that a file exists and is readable by the user ID that
started the current Interchange instance.
If specified in a global (interchange.cfg)
configuration file then any file on the filesystem may be checked.
If specified in a local (catalog.cfg) configuration
file then only files relative to the website's home directory,
as configured using the Catalog global
configuration directive,
may be checked. |
5.5.0+
|
| globalsub
|
Check that the named GlobalSub exists. |
All
|
| include
|
The name parameter will be taken to be a directory name.
If the directory exists then it will be added to Perl's @INC
path.
If the named directory does not exists then this test will fail. |
All
|
| module
|
Check that the named Perl module exists within Perl's @INC path.
If a "path" parameter is specified then it will be added to
Perl's @INC path prior to the test. |
All
|
| sub
|
Check that the named Sub exists. |
All
|
| taggroup
|
Check that the named TagGroup exists. |
All
|
| usertag
|
Check that the named UserTag exists.
If specified in a local (catalog.cfg) configuration
file then the named UserTag will be checked
for in both the local and </i>global</i> namespaces,
otherwise only the global namespace will be checked. |
All
|
|
Availability
"All versions" refers to Interchange 5.0.0 and above,
as 5.0.0 is the baseline for the documentation on
this website.
Most of the facility types marked "All" were available long before
version 5.0.0 was released.
|
Example
Suggest usertag email
Suggest globalsub form_mail
Suggest module Business::UPS
|
See also