/**
 * MambelFish - Mambos Babelfish
 * Copyright (C) 2003-2005 Think Network GmbH
 * All rights reserved.  The MambelFish project is a extention hack and
 * component for the content management system Mambo. It enables Mambo 
 * to handle multi lingual sites especially in all dynamic contents 
 * which are stored in the database.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.
 *
 * The "GNU General Public License" (GPL) is available at
 * http: *www.gnu.org/copyleft/gpl.html
 * -----------------------------------------------------------------------------
 * $Id: ReadMe,v 1.2 2005/03/15 11:07:01 akede Exp $
 *
 **/

Welcome to the MabelFish - which is no mashine or babel fish based translation!

The MambelFish is an add-on component for Mambo which allows you to maintain
and organize your manual translated content in your Mambo database.

The key features of the fish are:
 * Possibility for an unlimited amount of languages
 * Possibility to MANUAL translate all dynamic content of your Mambo
   installation in ONE database
 * Overview of the changed contents in the Translation list
 * Support for all the core components/modules of Mambo's
 * Frontend component for language selection
 
Introduction
------------
The MambelFish project is maintained and hosted on Mambo's project forge
http://mamboforge.net/projects/mambelfish/. When ever you have questions or
new ideas please visit this page and post your comments there. The project 
has a real good community which is willing to support you. Please understand
that I as a free consultant and Mambo core developer can only support you thru
this forum. I will not answer any direct emails or support requests. Thank's
for your understanding.

Languages
---------

You can download a great variaty of different frontend languages from the net
(e.g. from www.mamboforge.net).
These language files provide the static text information within your templates
or components/modules (e.g. "login", "forgot your password").

By installing the new languages files thru the Language Manager
(Administrator -> Site -> Language Manager) you can use these different adapted
text information. You can upload as many language files as you like there!

After you uploaded these files in the language manager it is possible to use
these languages in the MambelFish for the translation process. Please follow
the installation and configurations instructions below.


Core file patches
-----------------
Due to the fact that the MambelFish is not (yet) a core component some of these
original files must be changed/patched. The core patches provide exactly these
changes. PLEASE BE AWARE THAT EACH PATCH BELONGS EXACTLY TO THE VERSION OF
THE CORE FILES. IT IS NORMALLY NOT POSSIBLE TO JUST USE A PATCH FOR A DIFFERENT
VERSION! THE PATCHES ARE INCLUDED IN YOUR DISTRIBUTION PACKAGE OF MAMBELFISH.


Installation
------------
The basic installation of the MambelFish goes along with the Mambo standards.

1. Install the component thru the Administrator -> Components -> Install
   routine.

2. Now the difference starts: Applying the corresponding patch.
	a) BACKUP YOUR ACTUAL MAMBO INSTALLATION DIRECTORY!
	b) MAKE SURE YOU BACKUP THE DIRECTORY
	c) The patch is a zip file which corresponds with the directory structure
      of the Mambo sources. So please unzip this file to the root of your Mambo
      installation, overwriting all files.

For a simple test please switch to the peeklime template. Within this template
you should see a combobox with the language name "English" in it - next to the
search field (upper right part). Also in the Administrator the Version should
now say something about the MambelFish.


Language configuration
---------------------
As said, the first step is to upload at least a second language to your
Mambo installation. Do this with the help of the Language Manager
(Administrator -> Site -> Language Manager).

After you installed the language go to
Administrator -> Components -> MambelFish -> Component Configuration

Choose the tab "Languages" and activate the new language. Also define the
ISO code and the Name, which is the visible name in the frontend component.
Save the new configuration.

This kind of activation must be done for each language added to the system.


Translation process
-------------------
The translation process is based on the translation overview (Component ->
MambelFish -> Translation). In this overview you have to select the language
you want to translate into and a content element.

The content elements represent the possible dynamic content in your database.
This includes normally all your sections, categories, content items but also
the information from other components, like the web links, polls and so on.

It is possible to add new content elements just by adding new XML files in the
folder /administrator/components/com_mambelfish/contentelements. These files
describe how the table structure is organized and which fields of the
table should be translatable and how.

After you selected one language and one content element you will see all the
items of this filter. Best start with your new language and the content elements
"menues". Click on one item in the list to translate it.

Now you see the details of the translation - go ahead. Second tab publish
the translation of this item and make sure the language is correct - Save.

Now you can go back to the frontend and you should already find your menu
translated (of course after a reload or change to your new language ;-)).

Small hint:
===========
I found out that it is the best to start creating your site in one language and
translate anything to a second, third one. In this way it is most easy for you
to build the structure and finally translate it to the other languages.
Anyhow if you once have a original content in a second language don't worry,
just translate it into your primary language and you are fine.



I hope this more detailed documentation helped a bit for the first steps.

Thanks to the community for all the support in testing, and new ideas

Alex

