Commit 06b2ce6e authored by Damjan's avatar Damjan

[TASK] Writing documentation.

- Introduction
- General
- Edit file
- Edit constant
- Add constant
- Delete constant
- Rename constant
parent 0047d899
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
.. _start:
============
EXT:lfeditor
============
.. only:: html
:Classification:
lfeditor
:Author:
Stefan Galinski
: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 redactors 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 bu this extension.
:Keywords:
localization, translation, language file, locallang, xlf
:Author:
Stefan Galinski
: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
InsertionModes/Index
EditingModes/Index
Configuration/Index
KnownProblemsAndHints/Index
\ No newline at end of file
.. ==================================================
.. 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 good overview of your language files. Typo3 language file override feature is supported.
Users can override existing language files of extensions and even of Typo3 environment,
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
* 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
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- 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.
.. figure:: ../../Images/MainMenuOptions/AddConstant/AddConstant.png
:width: 500px
:alt: AddConstant
\ No newline at end of file
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
Delete Constant
===============
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
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
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.
.. figure:: ../../Images/MainMenuOptions/EditConstant/EditConstant.png
:width: 500px
:alt: EditConstant
\ No newline at end of file
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- 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.
This whole dialog is handled by a session. This means that 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.
.. figure:: ../../Images/MainMenuOptions/EditFile/EditFile.png
:width: 500px
:alt: EditFile
\ No newline at end of file
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
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 ‘edit file’ option 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
:width: 500px
:alt: General
\ No newline at end of file
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
Configuration
-------------
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.
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:
:glob:
General/Index
EditFile/Index
EditConstant/Index
AddConstant/Index
DeleteConstant/Index
RenameConstant/Index
SearchConstants/Index
ViewTree/Index
ManageBackups/Index
.. ==================================================
.. 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
:width: 500px
:alt: RenameConstant
\ 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