[FEATURE] Add page.addInlineLanguageLabelFiles
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Documentation / Changelog / master / Feature-57632-AddInlineLanguageLabelFilesWithTypoScript.rst
1 =====================================================================
2 Feature: #57632 - Include inline language label files with TypoScript
3 =====================================================================
4
5 Description
6 ===========
7
8 It is now possible to add inline language label files with TypoScript.
9
10 Usage
11 -----
12 If you want to include inline labels from a XLF file, you have to specify that file in your TypoScript with a custom key in the new
13 ``inlineLanguageLabelFiles`` section. In addition to the file you can configure three optional parameters:
14
15 - ``selectionPrefix``: Only label keys that start with this prefix will be included (default: '')
16 - ``stripFromSelectionName``: A string that will be removed from any included label key (default: '')
17 - ``errorMode``: Error mode if the file could not be found: 0 - syslog entry, 1 - do nothing, 2 - throw an exception (default: 0)
18
19 Example
20 -------
21
22 .. code-block:: typoscript
23
24         page = PAGE
25         page.inlineLanguageLabelFiles {
26                 someLabels = EXT:myExt/Resources/Private/Language/locallang.xlf
27                 someLabels.selectionPrefix = idPrefix
28                 someLabels.stripFromSelectionName = strip_me
29                 someLabels.errorMode = 2
30         }
31
32 Output in the HTML head:
33
34 .. code-block:: javascript
35
36         var TYPO3 = TYPO3 || {};
37         TYPO3.lang = {"firstLabel":[{"source":"first Label","target":"erstes Label"}],"secondLabel":[{"source":"second Label","target":"zweites Label"}]};