[DocLanguages]
Available since Exponential 6.0.15 (in development, not in a release yet).
Summary
The group [DocLanguages] 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 |
|---|---|---|
| Default | eng-us | The languages of the documentation (expHelpLanguage; doc/eng-us/bc/6.0/translated-documentation.md). Each language has a directory below doc/ named by its Exponential locale code in lower case: doc/eng-us/ (eng-US) is the original, a translation lives in doc/<locale>/ (doc/ger-de/ for ger-DE) with the same relative paths, or with translated file names listed in doc/<locale>/.paths.json ("translated path": "path below doc/eng-us/"). A page id is its path below doc/eng-us/ in every language, so a help address shows the same page in each language. Files directly below doc/ in no language directory (doc/changelogs/) are not translated. The reader's language is the locale of the interface (site.ini [RegionalSettings] Locale, set by the administration's language switch), lower cased: ger-DE reads doc/ger-de/. A locale without a directory of its own uses an alias of Map[], else the first directory of its language (ger-AT -> ger-de), else Default; a page the reader's language does not have yet is shown in Default, with a note. The original language, and the language of a locale that has no directory |
| Directories[] | eng-us; ger-de | The language directories the help reads (the default first); a directory that does not exist yet is fine |
| Map[<key>] | eng-GB=eng-us; ger-AT=ger-de; ger-CH=ger-de | Optional aliases, locale => directory, for a locale that should read another locale's directory |
| Names[<key>] | eng-us=English; ger-de=German | Directory => the language's name in English (translated in kernel/exphelp for the "not translated yet" note) |
| Legacy[<key>] | en/us=eng-us; de=ger-de | The directories of 6.0.14 and before => today's: an old address (exphelp/viewer/en/us/<id>, exphelp/viewer/doc/en/us/<id>, exphelp/viewer/de/<translated path>, /(lang)/en-us) still finds its page. No file is read from an old directory. |
See also
Generated example: exphelp.ini [DocLanguages]
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