[CategorySettings]
Available since Exponential 6.0.15 (in development, not in a release yet).
Summary
The group [CategorySettings] 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 |
|---|---|---|
| Categories[] | getting-started; manual; editing; media; publishing; search; languages; account; layouts; build-two-ways; shortcuts; support; leadership; business; partnership; advocacy; theme-design; templates; extension-development; theme-extensions; theme-distribution; theme-sales; theme-lifecycle; hosting; app-creation; website-creation; supporting; sponsorship; customer-success; public-sector; ... | The sections of the help, in dashboard order. A page's category: its front matter (category: editing), else the first PathRules[] that matches, else TypeDefaults[<type>] |
| CategoryNames[<key>] | getting-started=Getting started; manual=User manual; editing=Editing content; media=Images and media; publishing=Publishing; search=Search; languages=Languages; account=Your account; layouts=Layouts; build-two-ways=Two ways to build; shortcuts=Keyboard shortcuts; support=Help and support; leadership=Project leadership; business=Sales and marketing; partnership=Partnership; advocacy=Advocacy and ... | |
| CategoryIcons[<key>] | getting-started=signpost-split; manual=question-circle; editing=pencil-square; media=images; publishing=journal-check; search=search; languages=translate; account=person-lock; layouts=layout-sidebar-inset; build-two-ways=signpost-split; shortcuts=input-cursor-text; support=info-circle; leadership=diagram-3; business=graph-up-arrow; partnership=building; advocacy=people; theme-design=palette; ... | Icon names; each must have an .a4-bi-<name> class in stylesheets/components.css |
| PathRules[] | doc/eng-us/help/manual/*;manual; doc/eng-us/help/migrations/*;migrations; doc/eng-us/guides/migrations*.md;migrations; doc/eng-us/features/6.0/migrations.md;migrations; doc/eng-us/specifications/6.0/migration-file-format.md;migrations; doc/eng-us/help/leadership/*;leadership; doc/eng-us/help/business/*;business; doc/eng-us/help/partners/*;partnership; doc/eng-us/help/advocates/*;advocacy; ... | <pattern>;<category>, first match wins |
| TypeDefaults[<key>] | help=getting-started; guide=administration; feature=features; bc=install-upgrade; install=install-upgrade; changelog=release-notes; specification=development; history=history; example=examples; generated=examples; reference=reference; project=project-files; catalogue=standards; extension=extensions | <type> => <category>, when nothing else says |
See also
Generated example: exphelp.ini [CategorySettings]
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