****************************************************************************************************
v 1.0.0

Lang settings is a tool for mod Author that allows to manage your mod languages key entries
in separate packs to add to the user board.

It comes with an admin interface, optionnal, that you can add to your mods too, allowing to create or
edit language key entry in the ACP.

****************************************************************************************************

When installed, all the lang_extend*.php of a language directory will be included with each page, 
by the init_userprefs() function in functions.php, invoked at the top of the main phpBB scripts.

If a pack or some lang key entries are missing in a foreign language, the english ones will be used in place.

This will avoid you from adding edits of the lang_main.php and/or lang_admin.php files, and ease the
multi-language distribution (will result in a single new file).

Note : the tool can be installed many times, only one load of the lang_extend*.php will be done while
running the php scripts.

****************************************************************************************************

Sample of a lang_extend_yourmod.php
________________________________________________________________________________

<?php

## don't forget the comment header of the file here, with the version and the language :
## I didn't included it here to keep a small size explanation ;)

## some basic security : are we included by a phpBB script ?
## Tip : you can also filter the load of this file by adding your own constant check, and
##	defining this constants only in the main scripts that will have the use of those
##	lang key entries.
if ( !defined('IN_PHPBB') )
{
	die("Hacking attempt");
}

## In this part you will set all the keys used in an admin context
// admin part
if ( $lang_extend_admin )
{
## Here you give a name for your pack, that will be used by the admin interface
	$lang['Lang_extend_mods_settings'] = 'Mods settings language pack';

## other admin lang key entries
	$lang['Configuration_extend']	= 'Configuration +';
	$lang['Override_user_choices']	= 'Override user choices';
}

## In this part you will set all the keys used in standard and admin context
$lang['Click_return_preferences'] = 'Click %sHere%s to return to preferences';

?>
_________________________________________________________________________________

****************************************************************************************************

Include in your mod description :
--------------------------------

(../..)

## Files To Edit:
##		includes/functions.php

(../..)

## Included Files:
##		mod-lang_settings/lang_extend_mac.php

(../..)

#
#-----[ COPY ]------------------------------------------------
#
# mod-lang_settings
#
copy mod-lang_settings/lang_extend_mac.php to includes/lang_extend_mac.php

(../..)

#
#-----[ OPEN ]------------------------------------------------
#
includes/functions.php
#
#-----[ FIND ]------------------------------------------------
#
<?php
#
#-----[ AFTER, ADD ]------------------------------------------
#
# This part can already be existing : if so, just skip it
#
//-- mod : language settings -----------------------------------------------------------------------
#
#-----[ FIND ]------------------------------------------------
#
	//
	// Set up style
	//
#
#-----[ BEFORE, ADD ]-----------------------------------------
#
# This part can already be existing : if so, just skip it
#
//-- mod : language settings -----------------------------------------------------------------------
//-- add
	include($phpbb_root_path . './includes/lang_extend_mac.' . $phpEx);
//-- fin mod : language settings -------------------------------------------------------------------

#
#-----[ FIND ]------------------------------------------------
#
		}

		if ( empty($template) )
#
#-----[ BEFORE, ADD ]-----------------------------------------
#
# This part can already be existing : if so, just skip it
#
//-- mod : language settings -----------------------------------------------------------------------
//-- add
			include($phpbb_root_path . './includes/lang_extend_mac.' . $phpEx);
//-- fin mod : language settings -------------------------------------------------------------------

(../..)


****************************************************************************************************

Optional : the admin interface
------------------------------

Just mention in your author notes mod header this :
## Author Notes: 
##	o To be able to edit your languages installed on the board, please install the administration
##	language management tool included in the mod-lang_settings directory : MOD-lang_settings.txt


****************************************************************************************************

Resulting package :

	- if you don't plan to provide the admin interface in your mod, just add this file to it :
		o mod-lang_settings/lang_extend_mac.php

	- if you want to deliver the admin interface, add the whole directory, except this readme :).

****************************************************************************************************