Commit 0367adb5 authored by Damjan's avatar Damjan

[TASK] Writing documentation.

- Configuration
- Editing modes
- Insertion modes
- Known Problems And Hints
- Manage Backups
- Search Constant
- View Tree
parent 0db2152d
.. ==================================================
.. 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.
extIgnore Regular expression which limits the extension key list. /^(CVS|.svn|.git|csh_)/
changeXlfDate If set to TRUE, LFEditor will change the date in XLF files on each change. 1
============== ========================================================================== ==============================
\ No newline at end of file
.. ==================================================
.. 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 (frame).
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 copy of 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.
\ No newline at end of file
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
Insertion modes
---------------
LFEditor supports two ways of entering language constant values - via resizable text areas and via tiniMCE extension.
resizable text areas
^^^^^^^^^^^^^^^^^^^^
This is default insertion mode. If tiniMCE extension is not installed, this mode will be used.
TinyMCE
^^^^^^^
The extension contains rich text editor “tinyMCE”. Beneath the pure sources with the php compressor,
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
......@@ -13,6 +13,8 @@ Users can override existing language files of extensions and even of Typo3 envir
making their translations independent of origin extensions and resistant to extensions updates.
Features:
"""""""""
* Supported language file formats: XLF, XML and PHP
* Enhanced insert types (resizable text area, TinyMCE)
* Conversion of formats
......
.. ==================================================
.. 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>`_.
\ No newline at end of file
......@@ -4,7 +4,7 @@
.. -*- coding: utf-8 -*- with BOM.
Add Constant
============
------------
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.
......
......@@ -4,7 +4,7 @@
.. -*- coding: utf-8 -*- with BOM.
Delete Constant
===============
---------------
This option allows user to delete selected constant.
The constant will be deleted from all languages.
......
......@@ -3,8 +3,10 @@
.. --------------------------------------------------
.. -*- 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 configured view languages.
......
......@@ -4,7 +4,7 @@
.. -*- coding: utf-8 -*- with BOM.
Edit File
=========
---------
This option allows editing of all constants in language file in selected language.
User can select between translated, untranslated, unknown or all constants.
......
......@@ -3,8 +3,10 @@
.. --------------------------------------------------
.. -*- 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,
......
.. ==================================================
.. 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
:width: 500px
:alt: Manage Backups
\ No newline at end of file
......@@ -4,7 +4,7 @@
.. -*- 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.
......
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
Search Constant
---------------
This option allows user to search for constants in selected language file.
- Finds constants which match 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
:width: 500px
: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.
\ No newline at end of file
.. ==================================================
.. 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
: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