Skip to the content
Documentation

[ScriptDocumentation]

No ratings yet

Available since Exponential 6.0.15 (in development, not in a release yet).

Summary

The group [ScriptDocumentation] of settings/cronjob.ini.

File

settings/cronjob.ini; override it in settings/override/cronjob.ini.append.php, in a siteaccess or in an extension.

Settings

Setting Default Description
Link[] (empty array) A "Docs" link beside a script at Setup > Cronjobs. A script names its documentation with the @link tag of its header (or of its class file), a URL or a path such as doc/eng-us/guides/sessions.md. An installation can give or replace one per script, by the file name as Scripts[] has it; none removes the link the header gives. Guide: doc/eng-us/features/6.0/cronjobs-console.md Link[session_gc.php]=https://intranet.example.com/operations/sessions Link[sitemap.php]=none
DocumentationBase (empty) Where a path is looked up. Empty: the documentation of Exponential on GitHub. Only http and https links are shown.

See also

Generated example: cronjob.ini [ScriptDocumentation]

Added to the reference for Exponential 6.0.15: the 4.x reference had no page for this group. The descriptions are the comment lines of settings/cronjob.ini.

Contributors

Comments

Add a comment

Comments are read by a moderator before they appear.