diff Lib/IMPL/Resources/Strings.pm @ 66:f47f93534005

Documentation
author wizard
date Thu, 18 Mar 2010 17:58:33 +0300
parents 521c9c1a3ea1
children 4267a2ac3d46
line wrap: on
line diff
--- a/Lib/IMPL/Resources/Strings.pm	Tue Mar 16 17:36:13 2010 +0300
+++ b/Lib/IMPL/Resources/Strings.pm	Thu Mar 18 17:58:33 2010 +0300
@@ -75,14 +75,21 @@
 sub get {
     my ($this,$msg_name) = @_;
 }
+
 1;
 
 __END__
 
 =pod
 
+=head1 NAME
+
+C<IMPL::Resources::Strings> - Строковые ресурсы
+
 =head1 SYNOPSIS
 
+=begin code
+
 package Foo;
 
 use IMPL::Resources::Strings {
@@ -97,4 +104,38 @@
     
 }
 
+=end code
+
+=head1 DESCRIPTION
+
+Импортирует в целевой модуль функции, которые возвращают локализованные
+параметризованные сообщения.
+
+При импорте ищутся модули по следующему алгоритму:
+
+В каталогах из массива C<@Locations> ищется файл с относительным путем
+C<$Base/$Locale/$ModName>, где C<$Base>, C<$Locale> - глобальные переменные
+модуля C<IMPL::Resourses::Strings>, а переменная C<$ModName> получена
+путем замены 'C<::>' в имени целевого модуля на 'C</>'.
+
+Если файл не был найден, то производится поиск в каталоге, где
+расположен сам модуль, файла с относительным путем C<locale/$Locale/$ShortModName>,
+где C<$ShortModeName> - последняя часть после 'C<::>' из имени целевого модуля.
+
+Если файл не найден, то используются строки, указанные при объявлении
+сообщений в целевом модуле.
+
+=head1 FORMAT
+
+=begin code text
+
+msg_name = any text with named %params%
+msg_hello = hello, %name%!!!
+msg_resolve = this is a value of the property: %user.age%
+
+msg_short_err = %error.Message%
+msg_full_err = %error% 
+
+=end code text 
+
 =cut