[TitleSettings]
Available since Exponential 6.0.15 (in development, not in a release yet).
Summary
The group [TitleSettings] of settings/exphelp.ini.
File
settings/exphelp.ini; override it in settings/override/exphelp.ini.append.php, in a siteaccess or in an extension.
Settings
| Setting | Default | Description |
|---|---|---|
| Titles[<key>] | doc/eng-us/standards/header.txt=Source file header template (inherited, 4.1); doc/eng-us/bc/5.90/README.md=Upgrade notes for the 5.90 series (2017.08 and later); doc/eng-us/features/5.90/README.md=Features of the 5.90 series (2017.08 and later); doc/eng-us/bc/6.0/love/CHANGELOG.md=LoveStack features: changelog; doc/eng-us/bc/6.0/love/FEATURES.md=LoveStack features: the feature list; ... | A clearer title and summary for pages whose own title is unclear: a raw file name, "README", a bare version, the first line of a source code comment, or the same title as another page. A page's front matter title or summary always wins; this is for files that have none (plain text, the inherited documentation) and must keep their name because other files refer to them. Keys are paths relative to the installation root. Titles[<path>]=<title> |
| Summaries[<key>] | doc/eng-us/standards/header.txt=The copyright and license header that every PHP file of the inherited 4.x code base started with, kept as the historical template; new files use the docblock header described in the coding standards.; doc/eng-us/specifications/trunk/personal_trashcan/functional_requirements.txt=Why restoring folders from the shared trash is hard, and the requirements for a trash ... | Summaries[<path>]=<one sentence for the cards and the search results> |
| TitleRules[] | doc/changelogs/*/CHANGELOG-desc-*;Release {fileversion} summary: {title}; doc/eng-us/features/*/event.*;{title} ({dirversion}) | <pattern>;<template>, first match wins, for pages without a Titles[] entry. Placeholders: {title} (the page's own title), {name} (its file name, humanized), {fileversion} (the version at the end of the file name) and {dirversion} (the nearest version directory) |
See also
Generated example: exphelp.ini [TitleSettings]
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/exphelp.ini.
Contributors
- Graham Brookins Updated
Comments
Add a comment