Commit 148ac496 authored by Torsten Oppermann's avatar Torsten Oppermann
Browse files

[TASK] Update Documentation

parent 943b5d06
......@@ -51,6 +51,110 @@ and they can't switch to another mode.
## Usage
### The Menu
Main navigation through LFEditor is done by selecting one of the options of drop down menu
on top-left part of the screen.
###### General
This option displays general information about all the 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 the **Edit File <edit-file-reference>** page for this language.
The column *state* shows the state of translation and contains the amount 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 the 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 the meta information of language files.
---
###### 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.
---
###### Edit Constant
This option serves for translating a single constant in several languages.
Available languages depend on the user language privileges and on the configured "view languages".
---
###### 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 be entered right away.
---
###### Delete Constant
This option allows the user to delete a selected constant. The constant will be deleted from all languages.
---
###### Rename Constant
This option serves for renaming the key of a existing language constant.
The constant to rename is chosen from a select list and then the new name is entered in text field.
---
###### Search constants
This option allows the user to search for constants in selected language files.
- Finds constants which match the search string within a key or value (translation).
- The matching can be case sensitive or insensitive
- Supports regular expressions
- Looks only among a subset of languages which is defined in the **lfeditor** extension configuration
Clicking on a constant key of any search result, redirects to the **Edit Constant <edit-constant-reference>** page.
---
###### View Tree
This option serves for a better overview and easier access to constants.
It displays all constants of a language file arranged in a tree.
Constants are displayed as leafs of the tree and they are colored in three colors which indicate the translation state
of each constant for a selected language (language from first select box).
Constants are compared to a language from the 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 the **Edit Constant <edit-constant-reference>** page.
---
###### 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 the **differences** functionality.
Green color means that the constant was added and red that it was deleted since the backup was made.
### Insertion modes
**lfeditor** supports two ways of entering language constant values - via resizable text areas and via the tinyMCE extension.
The extension contains the rich text editor [tinyMCE](https://typo3.org/extensions/repository/view/tinymce) that you can use for editing the constants.
### Editing modes
There are three editing modes:
......@@ -59,8 +163,9 @@ There are three editing modes:
- 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, **Override mode** is chosen by default. For administrators the default is the **Extension mode**.
The select menu is visible only for administrators.
If the user is not an admin, **Override mode** is chosen by default. For administrators the default is the **Extension mode**.
###### Extension mode
This mode is useful for extension developers, because in this mode the **lfeditor** edits the extension files directly.
......@@ -90,4 +195,4 @@ The purpose of this mode is making translations unaffected by changes in an exte
- If a user makes any changes in a language file, only the changed constants (or meta data) will be saved in the corresponding language file in **typo3confLFEditorOverrideFiles**
- 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).
\ No newline at end of file
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).
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment