[IndexSettings]
Available since Exponential 6.0.15 (in development, not in a release yet).
Summary
The group [IndexSettings] 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 |
|---|---|---|
| Roots[] | doc | The directories (relative to the installation root) whose git-tracked files the help shows. Nothing outside them is ever read or served. |
| ActiveExtensionDocs | enabled | enabled: the documentation of every active extension is shown too, found when the help looks (an extension switched on or off is added or left out at once). Active means ActiveExtensions[] or the ActiveAccessExtensions[] of any siteaccess of AvailableSiteAccessList[], so every siteaccess and the console build the same index: the files of extension/<name>/doc tracked by the extension's own repository (or listed in its share/filelist.md5), and its README, CHANGELOG, LICENSE ... (ExtensionTopFiles[]). Their pages have the id ext/<name>/<path below doc> (ext/<name>/README.md for a top file), in the folder and category "Extensions" and on exphelp/extensions. disabled: only the extensions of ExtensionDocDirs[]. |
| ExtensionDocDirs[] | (empty array) | Extensions whose doc directory is shown whether active or not, as <extension name>. Empty: none. |
| ExtensionTopFiles[] | README*; CHANGELOG*; LICENSE*; INSTALL*; USAGE*; COPYING* | The files at the top of an extension's directory that are shown besides its doc/ (shell patterns, without case); nothing else outside doc/ is ever read. PHP and other source files are never shown: only DocumentSuffixes[] (and text files without a suffix that do not start like a program, #! or <?) are pages. |
| AllowlistSources[] | gitindex; gitcommand; manifest | Where the list of git-tracked files comes from, first one that answers: the .git index (read in PHP, no program is started), `git ls-files`, and share/filelist.md5 for an installation without .git |
| DocumentSuffixes[] | md; markdown; txt; rst | The suffixes of pages |
| PlainTextWithoutSuffix | enabled | enabled: files without a suffix (the old changelogs) are pages too, as plain text |
| AssetSuffixes[] | png; jpg; jpeg; gif; webp | The suffixes of images the asset view serves |
| ExcludePatterns[] | doc/eng-us/doxygen/*; doc/README.md; *.html; *.htm; *.svg; *.php | Never served, even when tracked (shell patterns on the path relative to the installation root; a pattern without "/" also matches the file name): generated documentation, HTML, SVG (it can carry scripts) and PHP, and doc/README.md (the list of the language directories for readers of the repository; the help chooses the language) |
| MaxFileSize | 2097152 | Bytes; larger files are left out |
| StatFiles | enabled | enabled: every request compares the size and time of each listed file with the cached index, so an edited page shows at once. disabled: only the git index, the manifest and the settings are compared (faster on big doc trees; run "./console exp:help index" after changing a page without a commit) |
| StatFilesInterval | 5 | With StatFiles enabled: seconds for which that comparison, once made, is reused by every request and process (it is kept in the help cache directory). Thousands of listed files make it the most expensive part of a help request, about 25 ms behind PHP-FPM (and under Velocity 0.0.4.56 and later, which stats the list in one go; 0.5 s before). An edited page then shows within this many seconds; a page added or removed changes the git index and shows at once, and "./console exp:help index" always looks again. 0: compare on every request |
| GitHistory | enabled | enabled: when git can be run, the index reads the history of the roots once per build, for each page's "last changed" date and the dashboard's recent changes. disabled: the file times are used, no recent changes |
See also
Generated example: exphelp.ini [IndexSettings]
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