Skip to the content
Documentation

[TreeSettings]

No ratings yet

Available since Exponential 6.0.15 (in development, not in a release yet).

Summary

The group [TreeSettings] 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
PageOrder[<key>] project/README.md=0; INSTALL.md=10; CONFIGURING.md=11; UPDATE.md=12; EXTENDING.md=13; INTEGRATING.md=14; DISTRIBUTIONS.md=15; SUPPORT.md=16; UNINSTALL.md=18; languages.md=20; HISTORY.md=25; branch-overview.md=30; release-overview=40; project/SECURITY.md=50; COMMUNITY.md=60; project/CONTRIBUTING.md=100; project/CODE_OF_CONDUCT.md=105; project/COPYRIGHT.md=110; README-LICENSE.md=120; ... The place of a page in the page tree (/exphelp/contents and the sidebar of every page), the folder lists and the category lists. Pages are sorted by their order, then by title; a page's order is its front matter "order", else 0 for a folder's README.md/index.md and 1000 for any other page. An entry here wins over the front matter, so the pages that cannot carry front matter (the project files, plain text pages) can be placed too. Folders still come before the pages of their level. Keys are page ids: the path below the language directory (INSTALL.md, glossary.md, release-overview), project/<path> for a project file, ext/<extension>/<path> for an extension's page. The id is the same in every language, so one entry places the page and its translations. PageOrder[] alone (empty) clears this list. The top level of the tree is placed here and only here: its pages carry no front matter order of their own (glossary.md keeps order 9999 in its front matter, the same as here). The same list is the built-in default (expHelpAudience::PAGE_ORDER). PageOrder[<page id>]=<integer>

See also

Generated example: exphelp.ini [TreeSettings]

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

Comments

Add a comment

Comments are read by a moderator before they appear.