151 lines
5.5 KiB
Text
151 lines
5.5 KiB
Text
$Id: README,v 1.4 2005/07/27 18:14:59 sagi Exp $
|
|
|
|
------------------------------------------------
|
|
| smarty-gettext - Gettext support for Smarty |
|
|
| |
|
|
| Author: Sagi Bashari <sagi@boom.org.il> |
|
|
| URL: http://smarty-gettext.sourceforge.net/ |
|
|
------------------------------------------------
|
|
|
|
smarty-gettext provides gettext support for Smarty,
|
|
the popular PHP templating engine (http://smarty.php.net/).
|
|
|
|
This README assumes that you already know what is gettext and how to
|
|
use it with PHP.
|
|
|
|
If you don't, please visit the following websites before trying to
|
|
use this package:
|
|
- http://www.php.net/gettext
|
|
- http://www.onlamp.com/pub/a/php/2002/06/13/php.html
|
|
|
|
If you encounter problems when using the native gettext extension,
|
|
you may want to try the php-gettext module, which emulates the behavior
|
|
of the C extension, but is written in pure PHP:
|
|
http://savannah.nongnu.org/projects/php-gettext/
|
|
|
|
This package has two parts:
|
|
1. block.t.php - The Smarty plugin.
|
|
2. tsmarty2c.php - A command line utility that rips gettext strings
|
|
from smarty source files and converts them to C format.
|
|
|
|
---------------------------------
|
|
| block.t.php - The Smarty plugin |
|
|
---------------------------------
|
|
|
|
Installation
|
|
------------
|
|
|
|
Simply copy block.t.php to your smarty plugins directory.
|
|
|
|
Usage
|
|
------
|
|
|
|
The content of the block function is the string that you want to translate.
|
|
For example, for translating 'Hello World', use: {t}Hello World{/t}.
|
|
|
|
If you have dynamic parameters that should be set inside the string,
|
|
pass them to the block function, and they will be replaced with %n,
|
|
where n is 1 for the 1st parameter and so on.
|
|
|
|
For example, {t name="sagi"}my name is %1{/t} will replace %1 with sagi.
|
|
|
|
The parameter name is ignored, unless it is one of the reserved
|
|
names (see below). Only the parameters order matters.
|
|
|
|
Example for using multiple parameters:
|
|
{t 1='one' 2='two' 3='three'}The 1st parameter is %1, the 2nd is %2
|
|
and the 3nd %3.{/t}
|
|
|
|
NOTE: I decided to use numeric arguments instead of sprintf(),
|
|
mainly because its syntax is simpler for the translators
|
|
(especially when wanting to change the parameter order).
|
|
|
|
You can also use this method in your PHP code, by using the
|
|
smarty_gettext_strarg() function. It is only loaded after block.t.php is
|
|
included, so you probably want to copy it elsewhere.
|
|
I usually name the global version of this function strarg(), and use it like this:
|
|
echo strarg(_('hi %1'), $name [,..]);
|
|
|
|
By default, all the translated strings will be automatically HTML escaped.
|
|
You may control this by setting the 'escape' parameter. Possible values:
|
|
- 'html' for HTML escaping, this is the default.
|
|
- 'js' for javascript escaping.
|
|
- 'url' for url escaping.
|
|
- 'no'/'off'/0 - disables escaping.
|
|
Example:
|
|
{t escape=no url="http://www.php.net/" name="PHP website"}
|
|
<a href="%1">%2</a>
|
|
{/t}
|
|
|
|
Plural support
|
|
--------------
|
|
|
|
The package also provides support for plural forms (see ngettext).
|
|
|
|
To provide a plural form:
|
|
1. Set a parameter named 'plural' with the plural version of the string.
|
|
2. Set a parameter named 'count' with the variable count.
|
|
|
|
Plural and count are special parameters, and therefore, are not available
|
|
as numeric arguments. If you wish to use the count value inside the string,
|
|
you will have to set it again, as a numeric argument.
|
|
|
|
Example:
|
|
{t count=$files|@count 1=$files|@count plural="%1 files"}One file{/t}
|
|
|
|
Modifier support
|
|
----------------
|
|
|
|
A Smarty modifier support is not provided by this package.
|
|
|
|
I believe variables should be trnalsated in the application level
|
|
and provided after translation to the template.
|
|
|
|
If you need it anyway, it is easy to create such modifier, by simply
|
|
registering the PHP gettext command as one.
|
|
|
|
------------------------------------------
|
|
| tsmarty2c.php - the command line utility |
|
|
------------------------------------------
|
|
|
|
This utility will rip the translation strings from the smarty files,
|
|
and convert them to gettext calls in C.
|
|
|
|
The C output may later be used with the standard gettext tools (see xgettext).
|
|
|
|
Usage:
|
|
./tsmarty2c.php <filename or directory> <file2> <..> > smarty.c
|
|
|
|
If a parameter is a directory, the template files within will
|
|
be parsed, recursively.
|
|
|
|
TIP:
|
|
The output also contains comments that point to the location of the file
|
|
that the string has been ripped from.
|
|
|
|
You can use the '--add-comments' parameter of xgettext to make it include
|
|
these comments inside the PO file (suggested by Mike van Lammeren).
|
|
|
|
NOTE:
|
|
You may need to adjust the PHP bin path at the top of the file,
|
|
or use 'php tsmarty2c.php' to run the script.
|
|
|
|
-----------
|
|
| Copyright |
|
|
-----------
|
|
|
|
Copyright (c) 2004-2005 Sagi Bashari
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Lesser General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2.1 of the License, or (at your option) any later version.
|
|
|
|
This library 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
|
|
Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public
|
|
License along with this library; if not, write to the Free Software
|
|
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|