[ProjectFiles]
Available since Exponential 6.0.15 (in development, not in a release yet).
Summary
The group [ProjectFiles] 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 |
|---|---|---|
| Enabled | enabled | The project files (expHelpProjectFiles; doc/eng-us/features/6.0/help-system.md, "Project files"): the Markdown files of the repository outside doc/ that document the project itself (README.md, INSTALL.md, SECURITY.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, COPYRIGHT.md, LICENSE.md, the README.md of bin/, design/ and kernel/ directories). Each has the id project/<path in the repository> (/exphelp/viewer/project/README.md; /exphelp/viewer/README.md redirects there) and is a page at the top of the page tree, next to the folders, not in a folder of its own. They are English only and not translated, like doc/changelogs/: a reader of another language sees them with the note that the page is not translated. Not to be changed by any setting here or in an override: only files git tracks are shown (the git index, "git ls-files" or the release manifest, never the directory: a private note in the root that is not committed is never shown, searched or linked), never a file in a place .gitignore ignores, only Markdown, never a hidden file or a file in a hidden directory (.github/ included), and never below doc/, extension/ (the extensions' documentation is the category Extensions), a tests/ directory anywhere, var/, vendor/, settings/override/, settings/siteaccess/ or node_modules/. enabled: the help shows them; disabled: none |
| Include[] | *.md; bin/**/README.md; design/*/README.md; kernel/**/README.md | Shell patterns on the path in the repository: "*" stays inside a directory, "**" crosses directories |
| Exclude[] | **/fixtures/**; **/_fixtures/**; **/javascript/**; **/third-party/**; **/thirdparty/** | Left out although Include[] matches: test fixtures and the copies of other projects (a JavaScript library's README) |
| Category | project-files | Their category, page type and audiences ([CategorySettings], [TypeSettings], [AudienceSettings]); a file's own front matter wins. AudienceRules[]: "<pattern>;<audiences>", the first match wins, else Audiences[] |
| Type | project | |
| Audiences[] | developer; admin | |
| AudienceRules[] | README.md;admin,developer,editor,user,partner,hosting; INSTALL.md;admin,developer,hosting; SECURITY.md;admin,developer,hosting; CONTRIBUTING.md;developer,supporter,advocate,partner; CODE_OF_CONDUCT.md;developer,supporter,advocate,partner,trainer,user; COPYRIGHT.md;admin,developer,partner,businesses; LICENSE.md;admin,developer,partner,businesses | |
| LicenseName | GNU General Public License, version 2 (or any later version) | The license of the project files: the notice under each of them names it and links its page (a page id) |
| LicensePage | project/LICENSE.md |
See also
Generated example: exphelp.ini [ProjectFiles]
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