[ManualSettings]
Available since Exponential 6.0.15 (in development, not in a release yet).
Summary
The group [ManualSettings] 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 |
|---|---|---|
| Manuals[] | getting-started;help/*.md;Getting started; manual;help/manual; book-learning;help/book-learning; book-building-a-site;help/book-building-a-site; extension-development;help/extension-development; adopters;help/adopters; advocates;help/advocates; ai-agents;help/ai-agents; build-two-ways;help/build-two-ways; bundlers;help/bundlers; business;help/business; businesses;help/businesses; ... | The manuals built from the Markdown help by ./console exp:help:content build-manuals (doc/eng-us/features/6.0/help-content.md, "Manuals from the Markdown help"). The Markdown stays the source: every run makes the manuals, chapters and topics match the pages again, and an edit made only in the admin is overwritten by the next run. Objects the command did not make (remote_id not help-gen-...) are never touched. One line per manual, in the order of the manuals: <key>;<source>[;<title>] key a-z, 0-9 and inner hyphens; the manual's remote_id is help-gen-manual-<key> source a folder below doc/eng-us/: its pages become topics, each subfolder a chapter (and theirs sub-chapters); <folder>/*.md: only the pages directly in the folder, no chapters title default: the title of the folder's README.md, else its start page ("Adopters: start here" gives "Adopters"), else the folder's name Changing the scope is an edit of this list. A line taken out removes its manual, chapters and topics at the next run. |
| Languages[] | ger-DE | The content languages the manuals are translated into, from the help's pages in that language (doc/ger-de/ for ger-DE). A language the installation does not have is left out and reported, never created. |
| TranslatedTitles[] | getting-started;ger-DE;Erste Schritte; contributor-notes;ger-DE;Hinweise für Mitwirkende | The title of a manual whose title Manuals[] gives, in a translation: <key>;<locale>;<title> (the others take the title of the translated README or start page) |
| License | GNU Free Documentation License 1.3 | The license of the manuals (the documentation's license, doc/eng-us/LICENSE-GFDL-1.3.txt) |
| BuildOnInstall | enabled | enabled: the kickstarter and ./console exp:install queue the build of the manuals after an installation ("exp:help:content build-manuals --queue" on the admin siteaccess): the content job helpmanuals installs the help as content and builds the manuals in the background, in about 20 to 30 minutes, while the site is already in use; the installation does not wait for it. disabled: leave it to the administrator |
| JobBatchSize | 10 | The background job (content job helpmanuals): objects per batch, each batch a transaction of its own, and the pause after each batch in milliseconds, so the site's own writes never wait long |
| JobPause | 200 | |
| BatchSize | 50 | Objects created and updated per database transaction: more is faster, a failed object rolls back the whole batch |
See also
Generated example: exphelp.ini [ManualSettings]
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