cronjob.ini [ScriptDocumentation] #

The block [ScriptDocumentation] of settings/cronjob.ini, with 2 setting(s).

Never edit settings/cronjob.ini itself: an update replaces it. Put the settings you change in an override, which wins over the shipped file:

• settings/override/cronjob.ini.append.php for every siteaccess,
• settings/siteaccess/<siteaccess>/cronjob.ini.append.php for one siteaccess,
• extension/<extension>/settings/cronjob.ini.append.php in an extension (read when the extension is active).

Link #

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

Default: an empty list.

<?php /* #?ini charset="utf-8"?
# settings/override/cronjob.ini.append.php
[ScriptDocumentation]
# an empty "Link[]" first replaces the shipped list; without it the items are added
Link[]
*/ ?>

DocumentationBase #

Where a path is looked up. Empty: the documentation of Exponential on GitHub.
Only http and https links are shown.

Default: empty.

<?php /* #?ini charset="utf-8"?
# settings/override/cronjob.ini.append.php
[ScriptDocumentation]
DocumentationBase=
*/ ?>

Related #

• All blocks of cronjob.ini
• All INI files
• The settings page

Generated by ./console exp:help:examples from settings/cronjob.ini. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.