Commit a828ffa7 authored by Damjan's avatar Damjan

[BUGFIX] Corrections in documentation

parent 0367adb5
......@@ -7,9 +7,10 @@ Editing modes
-------------
There are three editing modes:
- Extension mode
- l10n mode
- Override mode
- Extension mode
- l10n mode
- Override mode
They can be chosen from rightmost select menu on top of the screen (frame).
The select menu is visible only for administrators. If user is not admin, than override mode is chosen by default.
......@@ -35,10 +36,7 @@ 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.
- 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
......@@ -48,12 +46,9 @@ 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'.
- 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).
- 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.
......
......@@ -20,7 +20,6 @@ The extension contains rich text editor “tinyMCE”. Beneath the pure sources
the spellchecker add-on and all available languages, you can find a basic API for the integration in your own extensions.
.. figure:: ../Images/InsertionModes/TinyMCE.png
:width: 500px
:alt: AddConstant
TinyMce can be downloaded `here <http://typo3.org/extensions/repository/view/tinymce/>`_.
\ No newline at end of file
......@@ -15,16 +15,16 @@ making their translations independent of origin extensions and resistant to exte
Features:
"""""""""
* Supported language file formats: XLF, XML and PHP
* Enhanced insert types (resizable text area, TinyMCE)
* Conversion of formats
* Splitting and merging of language files
* Override mode
* Editing L10n folder content
* 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 redactors and administrators with appropriate privileges
* Respects user language permissions
* Supported language file formats: XLF, XML and PHP
* Enhanced insert types (resizable text area, TinyMCE)
* Conversion of formats
* Splitting and merging of language files
* Override mode
* Editing L10n folder content
* 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 redactors and administrators with appropriate privileges
* Respects user language permissions
......@@ -10,5 +10,4 @@ This option serves for adding new constant to language file.
User needs to enter new name and translations for chosen languages can also be entered right away.
.. figure:: ../../Images/MainMenuOptions/AddConstant/AddConstant.png
:width: 500px
:alt: AddConstant
\ No newline at end of file
......@@ -10,5 +10,4 @@ This option allows user to delete selected constant.
The constant will be deleted from all languages.
.. figure:: ../../Images/MainMenuOptions/DeleteConstant/DeleteConstant.png
:width: 500px
:alt: DeleteConstant
\ No newline at end of file
......@@ -12,5 +12,4 @@ This option serves for translating a single constant in several languages.
Available languages depend of user language privileges and of configured view languages.
.. figure:: ../../Images/MainMenuOptions/EditConstant/EditConstant.png
:width: 500px
:alt: EditConstant
\ No newline at end of file
......@@ -3,6 +3,8 @@
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
.. _edit-file-reference:
Edit File
---------
......@@ -17,5 +19,4 @@ It is triggered by selecting languages in both language selection lists.
.. figure:: ../../Images/MainMenuOptions/EditFile/EditFile.png
:width: 500px
:alt: EditFile
\ No newline at end of file
......@@ -14,8 +14,8 @@ because default behavior of LFEditor for administrators is to displays all exist
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 ‘edit file’ option for this language.
Column ‘state ‘ shows the state of translation and contains number of translated, unknown and untranslated language constants.
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.
......@@ -24,5 +24,4 @@ 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
:width: 500px
:alt: General
\ No newline at end of file
......@@ -3,23 +3,22 @@
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
Configuration
-------------
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.
.. figure:: ../Images/MainMenuOptions/MainMenu.png
:width: 500px
:alt: MainMenu
.. toctree::
:maxdepth: 2
:titlesonly:
......
......@@ -19,5 +19,4 @@ and old value of the constant is shown. If restore is executed, that old value w
(which is not visible in difference view of backup).
.. figure:: ../../Images/MainMenuOptions/ManageBackups/ManageBackups.png
:width: 500px
:alt: Manage Backups
\ No newline at end of file
......@@ -10,5 +10,4 @@ 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
:width: 500px
:alt: RenameConstant
\ No newline at end of file
......@@ -16,7 +16,6 @@ This option allows user to search for constants in selected language file.
Clicking on constant key of any search result, redirects to :ref:`Edit Constant <edit-constant-reference>` page.
.. figure:: ../../Images/MainMenuOptions/SearchConstant/SearchConstant.png
:width: 500px
:alt: SearchConstant
Picture illustrates case sensitive search for string 'Cancel'.
......
......@@ -20,5 +20,4 @@ resulting in three states:
Clicking on tree leaf (last segment of constant key) redirects to :ref:`Edit Constant <edit-constant-reference>` page.
.. figure:: ../../Images/MainMenuOptions/ViewTree/ViewTree.png
:width: 500px
:alt: ViewTree
\ No newline at end of file
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