Initial commit - Typo3 11.5.41

typo3conf/ext/lfeditor/Documentation/Configuration/Index.rst

@@ -0,0 +1,28 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+Configuration
+-------------
+
+================ ========================================================================== ============================
+Name           	 Description                                                                Default value
+================ ========================================================================== ============================
+viewLanguages    List of languages which will be available in the extension                 -
+                 (comma separated short names e.g. da, de, fi).
+                 If field is empty all languages will be used (Warning: very long list!).
+                 Default language is always included.
+defaultLanguage  If 'en' is not default language in TYPO3 BE,                               -
+                 default language must be defined here (e.g. de). If this field is empty,
+                 English is used as default.
+extIgnore        Regular expression which limits the extension key list.                    /^(CVS|.svn|.git|csh_)/
+extWhitelist     Regular expression which restricts the extension key list.                 -
+changeXlfDate    If set to TRUE, LFEditor will change the date in XLF files on each change. 1
+================ ========================================================================== ============================
+
+Administrator can choose which backend users can save localization changes directly to extensions,
+by selecting checkbox "The user can save localization changes directly to extensions?" when editing non-admin BE user.
+The box is located in "Access Rights" tab, just after "Limit to languages" section of non-admin BE user.
+Backend users who don't have this check box selected will be in override mode by default,
+and they can't switch to another mode.

typo3conf/ext/lfeditor/Documentation/EditingModes/Index.rst

@@ -0,0 +1,55 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+Editing modes
+-------------
+
+There are three editing modes:
+
+- Extension mode
+- l10n mode
+- Override mode
+
+They can be chosen from rightmost select menu on top of the screen.
+The select menu is visible only for administrators. If user is not admin, than override mode is chosen by default.
+For administrators, default is extension mode.
+
+Extension mode
+^^^^^^^^^^^^^^
+
+This mode is useful for extension developers because in this mode, LFEditor edits extension files directly.
+
+Even if copies of extension files exist in l10n folder, or extension files are overridden,
+user will still edit extension files only.
+
+l10n mode
+^^^^^^^^^
+
+This mode is similar to extension mode, but only difference is that l10n directory has higher priority than
+extension directory. This means that if there is a copy of the language file in l10n folder (e.g. de.locallang),
+that copy will be edited instead of original extension file. If there is no corresponding file in l10n folder,
+original file will be edited.
+
+Here are some of characteristics of l10n mode:
+
+- Files can't be moved to l10n folder by LFE. They can be edited if they already exist in l10n folder.
+- Merging/splitting is not allowed in l10n mode.
+- Renaming of constant will make renaming in main lang file (e.g. ext/.../locallang) and in all sub-files in l10n (e.g. l10n/.../de.locallang) and in ext folder (if those files from ext folder don't have duplicate in l10n folder( e.g. ext/.../fi.locallang)). Consequence of this is file ext/.../de.locallang having old constant name.
+- Delete and add file work similar like rename in l10n mode.
+
+Override mode
+^^^^^^^^^^^^^
+
+Purpose of this mode is making translations resistant to changes in extension
+(e.g. when extension updates, translations will be preserved). Thus, this mode is useful for translators,
+and it is set as default and only mode for non-admin users.
+
+- Whenever user makes any change in some language file, only changed constants (or meta data) will be saved in corresponding language file in  'typo3conf\LFEditor\OverrideFiles'.
+
+- When reading language file, LFEditor is first reading constants from files in override folder, then it reads rest of constants from l10n folder (if there is corresponding file in l10n folder), and then reads from ext folder (if there was no file in l10n folder).
+
+.. important::
+	All the changes (edit/add/delete/rename constant) to language file will be saved in override files only.
+	Original extension files will stay unchanged.

typo3conf/ext/lfeditor/Documentation/Index.rst

@@ -0,0 +1,60 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. _start:
+
+============
+EXT:lfeditor
+============
+
+.. only:: html
+
+	:Classification:
+		lfeditor
+
+	:Author:
+		Stefan Galinski, Damjan Komlenac
+
+	:Version:
+		|release|
+
+	:Language:
+		en
+
+	:Description:
+		This extension serves several functions for editing of language files (edit/rename/add/delete)
+		and supports XLF, XML, PHP language file formats.
+		The extension differs between editors and administrators with appropriate privileges.
+		Normal users are allowed to edit only languages for which they have permission.
+		Content of l10n folder can be edited and typo3 override feature is supported by this extension.
+
+	:Keywords:
+		localization, translation, language file, locallang, xlf
+
+	:Email:
+		stefan@sgalinski.de
+
+	:License:
+		This document is published under the Open Content License
+		available from http://www.opencontent.org/opl.shtml
+
+	:Rendered:
+		|today|
+
+	The content of this document is related to TYPO3,
+	a GNU/GPL CMS/Framework available from `www.typo3.org <http://www.typo3.org/>`_.
+
+**Table of Contents**
+
+.. toctree::
+	:maxdepth: 2
+	:titlesonly:
+	:glob:
+
+	Introduction/Index
+	MainMenuOptions/Index
+	EditingModes/Index
+	Configuration/Index
+	KnownProblemsAndHints/Index

typo3conf/ext/lfeditor/Documentation/Introduction/Index.rst

@@ -0,0 +1,29 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+Introduction
+------------
+
+LFEditor TYPO3 extension makes editing of language files fast and easy.
+It allows editing, renaming, adding and deleting of language constant and
+gives a good overview of your language files. The TYPO3 language file override feature is supported.
+Users can override existing language files of extensions and even of the TYPO3 environment,
+making their translations independent of the original extensions and resistant to extension updates.
+
+Features:
+"""""""""
+
+* Supported language file formats: XLF (preferred), XML (most stable) and PHP (outdated)
+* Conversion of formats
+* Splitting and merging of language files
+* Override mode
+* Editing of the TYPO3 l10n folder
+* Simple editing of constants and languages (edit/add/rename/delete constants)
+* Flexible search and view of constants and values
+* Tree view of constants
+* Meta information handling
+* Backups, recovering and diff view
+* Differs editors and administrators with appropriate privileges
+* Respects user language permissions

typo3conf/ext/lfeditor/Documentation/KnownProblemsAndHints/Index.rst

@@ -0,0 +1,10 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+Known Problems And Hints
+------------------------
+
+Problems can be viewed and reported on `forge <http://forge.typo3.org/projects/extension-lfeditor/issues>`_. You
+can find the code on our `gitlab <http://gitlab.sgalinski.de/typo3/lfeditor>`_.

typo3conf/ext/lfeditor/Documentation/MainMenuOptions/AddConstant/Index.rst

@@ -0,0 +1,13 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+Add Constant
+------------
+
+This option serves for adding new constants to language files.
+The user needs to enter a new name and translations for chosen languages can also be entered right away.
+
+.. figure:: ../../Images/MainMenuOptions/AddConstant/AddConstant.png
+	:alt: AddConstant

typo3conf/ext/lfeditor/Documentation/MainMenuOptions/DeleteConstant/Index.rst

@@ -0,0 +1,12 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+Delete Constant
+---------------
+
+This option allows user to delete a selected constant. The constant will be deleted from all languages.
+
+.. figure:: ../../Images/MainMenuOptions/DeleteConstant/DeleteConstant.png
+	:alt: DeleteConstant

typo3conf/ext/lfeditor/Documentation/MainMenuOptions/EditConstant/Index.rst

@@ -0,0 +1,15 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. _edit-constant-reference:
+
+Edit Constant
+-------------
+
+This option serves for translating a single constant in several languages.
+Available languages depend of user language privileges and of the configured "view languages".
+
+.. figure:: ../../Images/MainMenuOptions/EditConstant/EditConstant.png
+	:alt: EditConstant

typo3conf/ext/lfeditor/Documentation/MainMenuOptions/EditFile/Index.rst

@@ -0,0 +1,24 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. _edit-file-reference:
+
+Edit File
+---------
+
+This option allows editing of all constants in a language file and a selected language.
+Users can choose between translated, untranslated, unknown or all constants.
+This whole dialog is handled by a session. This means that a user can translate a whole page and doesn't need to
+save the changes before clicking on 'next' button to get the next page with language constants.
+If the translation process is finished or user just wants to make a break, the changes should be saved.
+
+Parallel editing is nice feature which allows editing two languages at the same time.
+It is triggered by selecting languages in both language selection lists in section "Select up to two languages".
+Section "Select reference language" allows user to chose which language will be used as reference for translating.
+Reference language translations are shown beneath each text box.
+
+
+.. figure:: ../../Images/MainMenuOptions/EditFile/EditFile.png
+	:alt: EditFile

typo3conf/ext/lfeditor/Documentation/MainMenuOptions/General/Index.rst

@@ -0,0 +1,27 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. _general-reference:
+
+General
+-------
+
+This option displays general information about several languages.
+Displayed languages should be configured in the configuration section of LFEditor,
+because default behavior of LFEditor for administrators is to displays all existing translation languages of TYPO3.
+While non-admin users see only languages which they have permissions for.
+
+Beside the language shortcut, there is state and origin of the related language file.
+Clicking any language shortcut redirects to :ref:`Edit File <edit-file-reference>` page for this language.
+Column ‘state‘ shows the state of translation and contains number of translated, unknown and untranslated language constants.
+Unknown constants are the ones which exist in the language, and don’t exist in default language.
+
+At the bottom of this page there are options for converting and splitting language files.
+Those options are not displayed in override mode and it is not possible to merge XLF files.
+Splitting of language files increases the performance of backend and frontend.
+There is also a field set which allows editing of meta information of language files.
+
+.. figure:: ../../Images/MainMenuOptions/General/General.png
+	:alt: General

typo3conf/ext/lfeditor/Documentation/MainMenuOptions/Index.rst

@@ -0,0 +1,38 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+Main Menu Options
+-----------------
+
+Main navigation through LFEditor is done by selecting one of the options of drop down menu (main menu)
+on top-left part of the screen (frame).
+Main menu options are described in following sections of this chapter.
+
+.. figure:: ../Images/MainMenuOptions/MainMenu.png
+	:alt: MainMenu
+
+Page of each main menu option (except backup option) contains selection list of all available language files in typo3 CMS,
+sorted by belonging extension. First time opening the extension might take few seconds to find all the language files,
+but after that, the file list is cached and loading goes fast.
+If language files are added or removed (not by LFEditor) from TYPO3 CMS, user should flush general caches,
+to force LFEditor to read new list of language files.
+
+After each "Save" operation, LFEditor will automatically clear language cache, so the changes can be visible immediately
+when user opens the page which uses changed language file.
+
+.. toctree::
+	:maxdepth: 2
+	:titlesonly:
+	:glob:
+
+	General/Index
+	EditFile/Index
+	EditConstant/Index
+	AddConstant/Index
+	DeleteConstant/Index
+	RenameConstant/Index
+	SearchConstant/Index
+	ViewTree/Index
+	ManageBackups/Index

typo3conf/ext/lfeditor/Documentation/MainMenuOptions/ManageBackups/Index.rst

@@ -0,0 +1,22 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+Manage Backups
+--------------
+
+The backup option displays all backups of the selected extension.
+It is possible to recover every backup, delete them or just have a look at the differences.
+User can revert splitting and merging of files too. Conversions of the file format are not revertible.
+If language file was converted to other format, there will be red warning in status of the backup table entry
+and that backup can only be deleted.
+
+All changes since the backup are visible trough 'differences' functionality.
+Green color means that the constant was added and red that it was deleted since the backup was made.
+Example at the bottom of this section shows that user have made changes in value of 'button.cancel' constant,
+and old value of the constant is shown. If restore is executed, that old value will replace current value
+(which is not visible in difference view of backup).
+
+.. figure:: ../../Images/MainMenuOptions/ManageBackups/ManageBackups.png
+	:alt: Manage Backups

typo3conf/ext/lfeditor/Documentation/MainMenuOptions/RenameConstant/Index.rst

@@ -0,0 +1,13 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+Rename Constant
+---------------
+
+This option serves for renaming the key of existing language constant.
+Constant to rename is chosen from select list, and then new name is entered in text field.
+
+.. figure:: ../../Images/MainMenuOptions/RenameConstant/RenameConstant.png
+	:alt: RenameConstant

typo3conf/ext/lfeditor/Documentation/MainMenuOptions/SearchConstant/Index.rst

@@ -0,0 +1,26 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+Search Constant
+---------------
+
+This option allows a user to search for constants in selected language files.
+
+- Finds constants which match the search string within key or value (translation).
+- The matching can be case sensitive or insensitive.
+- Supports regular expressions.
+- Looks only among subset of languages which is defined in LFEditor configuration.
+
+Clicking on constant key of any search result, redirects to :ref:`Edit Constant <edit-constant-reference>` page.
+
+.. figure:: ../../Images/MainMenuOptions/SearchConstant/SearchConstant.png
+	:alt: SearchConstant
+
+Picture illustrates case sensitive search for string 'Cancel'.
+The search has found the string in 2 language constants:
+
+- as value of button.cancel constant in default language,
+- as part of constant key of function.langfile.confirmCancel constant in default and in 'de' languages,
+	since there is no more languages that contain translation for this constant key in this example.

typo3conf/ext/lfeditor/Documentation/MainMenuOptions/ViewTree/Index.rst

@@ -0,0 +1,23 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+View Tree
+---------
+
+This option serves for overview and easier access to constants.
+It displays all constants of language file arranged in a tree.
+Constants are displayed as leafs of the tree, and they are colored in three colors which indicate translation state
+of each constant for selected language (language from first select box).
+The state is calculated in same way like on :ref:`General <general-reference>` page. Constants are compared to language from second select box,
+resulting in three states:
+
+- green - normal constant (translated in both languages)
+- red - untranslated constant (translated only in second language)
+- blue - unknown constant (translated only in first language)
+
+Clicking on tree leaf (last segment of constant key) redirects to :ref:`Edit Constant <edit-constant-reference>` page.
+
+.. figure:: ../../Images/MainMenuOptions/ViewTree/ViewTree.png
+	:alt: ViewTree