Inherited, see Log::Report::Dispatcher::collectStack()
", "id" : "id1188-id1066", "call" : "$any->collectStack( [$maxdepth] )", "extends" : "id1188", "name" : "collectStack" }, "id535-id493" : { "intro" : "Inherited, see Log::Report::Extract::cleanup(keep)
", "type" : "option", "id" : "id535-id493", "params" : "HASH|ARRAY", "extends" : "id535", "name" : "keep" }, "id152" : { "level" : 1, "name" : "SYNOPSIS", "intro" : "use Log::Report::Minimal::Domain;\n my $domain = Log::Report::Minimal::Domain->new(name => $name);\n\n # normal usage\n use Log::Report::Optional; # or Log::Report itself\n my $domain = textdomain $name; # find config\n textdomain $name, %configure; # set config, only once.\n\n", "id" : "id152", "type" : "chapter", "path" : "SYNOPSIS" }, "id1207-id905" : { "name" : "max_params", "intro" : "
Inherited, see Log::Report::Dispatcher::stackTraceLine(max_params)
", "extends" : "id1207", "value" : "8", "id" : "id1207-id905", "type" : "default" }, "id663" : { "options" : [ [ "id664", "id665" ] ], "type" : "i_method", "id" : "id663", "diagnostics" : [ "id666", "id667" ], "call" : "$obj->toString( %options )", "name" : "toString", "intro" : "Format the object into a multi-lined string.
\n" }, "id1041" : { "name" : "exceptions", "intro" : "Returns all collected Log::Report::Exception objects. The last of\nthem may be a fatal one. The other are non-fatal.
\n", "id" : "id1041", "type" : "i_method", "call" : "$obj->exceptions" }, "id363" : { "id" : "id363", "intro" : "See the DETAILS section below for a detailed explenation.
\n", "type" : "option", "params" : "PREDEFINED|CODE", "name" : "pattern" }, "id1208" : { "name" : "abstract", "intro" : "The higher the abstraction value, the less details are given\nabout the caller. The minimum abstraction is specified, and\nthen increased internally to make the line fit within the max_line\nmargin.
\n", "type" : "option", "id" : "id1208", "params" : "INTEGER" }, "id257" : { "name" : "process", "id" : "id257", "intro" : "process() is an eval, but one which expects and understands exceptions\ngenerated by Log::Report. Any messages will be logged as normal in\naccordance with the dispatchers, but any fatal exceptions will be caught\nand handled gracefully. This allows much simpler error handling, rather\nthan needing to test for lots of different scenarios.
In a module, it is enough to simply use the error keyword in the event\nof a fatal error.
The return value will be 1 for success or 0 if a fatal exception occurred.
\n\nSee the DETAILS for an example of how this is expected to be used.
\n\nThis module is configured only once in your application. The other modules\nwhich make your website do not need to require this plugin, instead they\ncan use Log::Report to get useful functions like error and fault.
Add one or more modifier handlers to power of the formatter. They will\nget preference over the predefined modifiers, but lower than the modifiers\npassed to print[ip] itself.
Inherited, see Log::Report::Lexicon::Table::translations()
", "id" : "id750-id561", "type" : "error" }, "id1044" : { "name" : "change the setting of the running block\n", "intro" : " my $parent_try = dispatcher 'active-try';\n $parent_try->hide('ALL');\n\n",
"type" : "example",
"id" : "id1044"
},
"id1246" : {
"name" : "message",
"intro" : "Change the $message of the exception, must be a Log::Report::Message\nobject.
\n\nWhen you use a Log::Report::Message object, you will get a new one\nreturned. Therefore, if you want to modify the message in an exception,\nyou have to re-assign the result of the modification.
Inherited, see Log::Report::Lexicon::Table::new()
", "id" : "id741-id561", "call" : "$class->new( %options )" }, "id458" : { "name" : "lexicon in module tree\n", "intro" : "My module is named Some::Module and installed in\nsome of perl's directories, say ~perl5.8.8. The module is defining\ntextdomain my-domain. The translation is made into nl-NL.utf-8\n(locale for Dutch spoken in The Netherlands, utf-8 encoded text file).
The default location for the translation table is under
\n ~perl5.8.8/Some/Module/messages/\n\n\n
for instance
\n ~perl5.8.8/Some/Module/messages/nl-NL.utf-8/LC_MESSAGES/my-domain.po\n\n\n
There are alternatives, as described in Log::Report::Lexicon::Index,\nfor instance
\n ~perl5.8.8/Some/Module/messages/my-domain/nl-NL.utf-8.po\n ~perl5.8.8/Some/Module/messages/my-domain/nl.po\n\n", "type" : "example", "id" : "id458" }, "id1197-id905" : { "intro" : "
Inherited, see Log::Report::Dispatcher::stackTraceLine(filename)
", "name" : "filename", "id" : "id1197-id905", "type" : "default", "value" : "<required>", "extends" : "id1197" }, "id1287" : { "type" : "subsection", "id" : "id1287", "path" : "DETAILS/Processing the message/Filters", "level" : 3, "name" : "Filters" }, "id755" : { "call" : "$obj->nrPlurals", "intro" : "Returns the number of plurals, when not known then '2'.
\n", "id" : "id755", "type" : "i_method", "name" : "nrPlurals" }, "id1320" : { "path" : "DETAILS", "name" : "DETAILS", "level" : 1, "type" : "chapter", "id" : "id1320", "nest" : [ "id1321", "id1322" ] }, "id1198" : { "name" : "linenr", "id" : "id1198", "type" : "option", "params" : "INTEGER" }, "id990" : { "name" : "tags", "call" : "$obj->tags", "id" : "id990", "intro" : "[1.44] Returns the LIST of tags which are defined for this message; message\ngroup indicators, as often found in exception-based programming.
\n", "type" : "i_method" }, "id1165-id1091" : { "intro" : "Inherited, see Log::Report::Dispatcher::new(accept)
", "type" : "option", "id" : "id1165-id1091", "params" : "$reasons|\\@reasons", "extends" : "id1165", "name" : "accept" }, "id1251" : { "call" : "$obj->inClass( $tag|Regexp )", "id" : "id1251", "intro" : "Deprecated name for taggedWith().
\n", "type" : "i_method", "name" : "inClass" }, "id528" : { "name" : "charset", "call" : "$obj->charset", "type" : "i_method", "intro" : "Returns the character-set used inside the POT files.
\n", "id" : "id528" }, "id940" : { "call" : "overload '\"\"'; stringification", "intro" : "When the object is used in string context, it will get translated.\nImplemented as toString().
\n", "id" : "id940", "type" : "overload", "name" : "'\"\"'" }, "id157" : { "params" : "STRING", "id" : "id157", "intro" : "The name of the textdomain is used in its invocation, but also as (part of) the\ntranslation file names, hence please keep it simple and short.
\n", "type" : "option", "name" : "name" }, "id1166-id1021" : { "name" : "accept", "intro" : "Inherited, see Log::Report::Dispatcher::new(accept)
", "extends" : "id1166", "id" : "id1166-id1021", "type" : "default", "value" : "depend on mode"
},
"id252" : {
"is_pure_pod" : false,
"distribution" : "Dancer2-Plugin-LogReport",
"package" : "Dancer2::Plugin::LogReport",
"id" : "id252",
"inheritance" : {
"extends" : [
"Dancer2::Plugin"
]
},
"title" : "logging, exceptions and translations in Dancer2 via Log::Report",
"chapters" : [
"id253",
"id1354",
"id254",
"id255",
"id256",
"id276"
],
"name" : "Dancer2::Plugin::LogReport",
"version" : "2.03"
},
"id673" : {
"id" : "id673",
"type" : "chapter",
"nest" : [
"id674",
"id709",
"id714"
],
"path" : "METHODS",
"level" : 1,
"name" : "METHODS"
},
"id874" : {
"name" : "message_class",
"params" : "CLASS",
"type" : "option",
"intro" : "[1.08] Use a more powerful message object class, for instance because\nyour messages need extra attributes. The provided CLASS must extend\nLog::Report::Message
\n", "id" : "id874" }, "id373" : { "intro" : "Read the DETAILS section about this.
\n", "id" : "id373", "type" : "option", "params" : "PREDEFINED|CODE", "name" : "pattern" }, "id308" : { "name" : "template_syntax", "params" : "'UNKNOWN'|'HTML'", "intro" : "Linked to String::Print::new(encode_for): the output of the translation\nis HTML encoded unless the inserted value name ends on _html.\nRead Translation into HTML
Inherited, see Log::Report::Extract::write()
", "extends" : "id538", "call" : "$obj->write( [$domain], %options )", "diagnostics" : [ "id539-id354" ], "id" : "id538-id354", "type" : "i_method" }, "id811" : { "name" : "errno", "id" : "id811", "value" : "$! or 1",
"type" : "default"
},
"id608" : {
"type" : "subsection",
"intro" : "Above examples are to be specified per message. You may also\nset a default. The top of your modules set the text-domain (name\nof the translation table) for all strings found in those files.\nIn this case, for instance \"webpages\"
\n\n # Log::Report::textdomain()\n (textdomain 'webpages')->setContext(%context);\n\n\n
This context is used as defaults, the _context attribute used by\nstrings are overruling these.
undef",
"type" : "default"
},
"id1336" : {
"intro" : "Log::Report::Util\n is an Exporter\n\n", "type" : "chapter", "id" : "id1336", "path" : "INHERITANCE", "level" : 1, "name" : "INHERITANCE" }, "id951" : { "value" : "
undef",
"type" : "default",
"id" : "id951",
"name" : "_count"
},
"id1056" : {
"name" : "class",
"intro" : "Deprecated alternative for tag.
Prints the reason and the message. Differently from throw(), this\nonly represents the textual content: it does not re-cast the exceptions to\nhigher levels.
\n", "id" : "id1254", "name" : "toString", "examples" : [ "id1255" ] }, "id78" : { "value" : "undef",
"id" : "id78",
"type" : "default",
"name" : "_count"
},
"id225" : {
"level" : 1,
"name" : "METHODS",
"path" : "METHODS",
"nest" : [
"id226",
"id230",
"id1274",
"id234"
],
"type" : "chapter",
"id" : "id225"
},
"id536-id354" : {
"id" : "id536-id354",
"type" : "default",
"value" : "[]",
"extends" : "id536",
"intro" : "Inherited, see Log::Report::Extract::cleanup(keep)
", "name" : "keep" }, "id104" : { "level" : 3, "name" : "Modifier: '=' (show name)", "type" : "subsection", "intro" : "[0.96] As (always trailing) modifier, this will show the interpolated\nname before the value. It might simplify debugging statements.
\n\n \"visitors: {count=}\", count => 1; # visitors: count=1\n \"v: {count %-8,d =}X\", count => 10000; # v: count=10,000␣␣X\n\n",
"id" : "id104",
"path" : "DETAILS/Interpolation: Modifiers/Modifier: '=' (show name)"
},
"id306" : {
"name" : "processing_errors",
"id" : "id306",
"intro" : "The Template Toolkit infrastructure handles errors carefully: undef is\nreturned and you need to call error() to collect it.
Inherited, see Log::Report::Dispatcher::stackTraceLine(max_line)
", "type" : "option", "id" : "id1204-id780", "params" : "INTEGER", "extends" : "id1204", "name" : "max_line" }, "id606" : { "name" : "Specifying the context per Message", "level" : 3, "path" : "DETAILS/Using context_rules/Specifying the context per Message", "type" : "subsection", "intro" : "You need to specify the context at each message which is influenced by\nthe context. This can be a comma separated list of words, an ARRAY, or\na HASH:
\n\n _context => 'gender=male'\n _context => 'gender=male,agegroup=adult,married=yes'\n _context => [ 'gender=male', 'agegroup=adult', 'married=yes']\n _context => [ qw/gender=male agegroup=adult married=yes/ ]\n\n my @context = (qw/gender=male agegroup=adult married=yes/);\n _context => \\@context;\n\n\n
Probably the
\n my %context = (gender => 'male', agegroup => 'adult', married => 'yes');\n my %context = qw/gender male agegroup adult married yes/;\n _context => \\%context;\n\n\n
Standard gettext only allows a single keyword (=string)\nLog::Report permits you to set-up a context for a whole\ntext-domain, which means that multiple context rules may be active at\nany moment.
Some $text or other $message object which need to be pasted after this\nmessage object.
\n", "id" : "id960", "name" : "_append" }, "id1199-id1021" : { "name" : "linenr", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(linenr)
", "extends" : "id1199", "type" : "default", "id" : "id1199-id1021", "value" : "<required>" }, "id1191-id780" : { "extends" : "id1191", "name" : "skipStack", "type" : "i_method", "intro" : "Inherited, see Log::Report::Dispatcher::skipStack()
", "id" : "id1191-id780", "call" : "$obj->skipStack" }, "id57" : { "id" : "id57", "value" : "<useful defaults>", "type" : "default", "name" : "serializers" }, "id693" : { "name" : "filename", "type" : "default", "value" : "undef",
"id" : "id693"
},
"id894" : {
"level" : 3,
"examples" : [
"id895",
"id896",
"id897"
],
"name" : "Run modes",
"intro" : "The run-mode change which messages are passed to a dispatcher, the verbosity.\nIt takes a different angle than the dispatch filters: the mode changes\nbehavioral aspects of the messages, which are described in detail in\nProcessing the message. However, it should\nbehave as you expect: the DEBUG mode shows more than the VERBOSE mode,\nand both show more than the NORMAL mode.
\n", "type" : "subsection", "id" : "id894", "path" : "DETAILS/Error handling models/Run modes" }, "id1170" : { "name" : "mode", "value" : "'NORMAL'", "type" : "default", "id" : "id1170" }, "id727" : { "distribution" : "Log-Report-Lexicon", "package" : "Log::Report::Lexicon", "is_pure_pod" : false, "title" : "translation component of Log::Report", "id" : "id727", "inheritance" : {}, "chapters" : [ "id728", "id729", "id730", "id731" ], "name" : "Log::Report::Lexicon", "version" : "1.16" }, "id1180-id1217" : { "extends" : "id1180", "name" : "type", "id" : "id1180-id1217", "intro" : "Inherited, see Log::Report::Dispatcher::type()
", "type" : "i_method", "call" : "$obj->type" }, "id1194-id780" : { "name" : "package", "extends" : "id1194", "params" : "CLASS", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(package)
", "type" : "option", "id" : "id1194-id780" }, "id393" : { "value" : "undef",
"type" : "default",
"id" : "id393",
"name" : "only_in_directory"
},
"id526" : {
"level" : 2,
"name" : "Attributes",
"subroutines" : [
"id528",
"id529",
"id531",
"id530",
"id527"
],
"type" : "section",
"id" : "id526",
"path" : "METHODS/Attributes"
},
"id1136" : {
"name" : "native_language",
"intro" : "This is the language which you have used to write the translatable and\nthe non-translatable messages in. In case no translation is needed,\nyou still wish the system error messages to be in the same language\nas the report. Of course, each textdomain can define its own.
\n", "id" : "id1136", "type" : "option", "params" : "CODESET" }, "id831" : { "type" : "example", "intro" : " my $x = try { 3/$x }; # mind the ';' !!\n if($@) { # signals something went wrong\n\n if(try {...}) { # block ended normally, returns bool\n\n try { ... } # no comma!!\n mode => 'DEBUG', accept => 'ERROR-';\n\n try sub { ... }, # with comma, also \\&function\n mode => 'DEBUG', accept => 'ALL';\n\n my $response = try { $ua->request($request) };\n if(my $e = $@->wasFatal) ...\n\n",
"id" : "id831"
},
"id1201-id780" : {
"id" : "id1201-id780",
"type" : "default",
"value" : "<required>",
"extends" : "id1201",
"intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(call)
", "name" : "call" }, "id1209-id1021" : { "extends" : "id1209", "id" : "id1209-id1021", "value" : "1", "type" : "default", "name" : "abstract", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(abstract)
" }, "id1017" : { "id" : "id1017", "type" : "section", "examples" : [ "id1018" ], "nest" : [ "id1019", "id1020" ], "path" : "DETAILS/Automatic parameters", "intro" : "Besides the parameters which you specify yourself, Log::Report will add\na few which can also be interpolated. The all start with an underscore\n(_). These are collected when this Message object is instantiated,\nsee the %options of new(). These parameters have a purpose, but\nyou are also permitted tp interpolate them in your message. This may\nsimplify your coding.
The useful names are:
\n\nIt's always complicated to find the lexicon files, because the perl\npackage can be installed on any weird operating system. Therefore,\nyou may need to specify the lexicon directory or alternative directories\nexplicitly. However, you may also choose to install the lexicon files\nin between the perl modules.
\n", "nest" : [ "id457", "id459", "id460" ], "type" : "chapter", "id" : "id456" }, "id1183-id1066" : { "extends" : "id1183", "name" : "needs", "call" : "$obj->needs( [$reason] )", "type" : "i_method", "intro" : "Inherited, see Log::Report::Dispatcher::needs()
", "id" : "id1183-id1066" }, "id501" : { "path" : "METHODS/Constructors", "id" : "id501", "type" : "section", "subroutines" : [ "id519-id493" ], "name" : "Constructors", "level" : 2 }, "id970" : { "intro" : "Specify the $dispatcher as destination explicitly. Short\nfor report {to => NAME}, ... See to()
Inherited, see Log::Report::Domain::readConfig()
", "name" : "readConfig" }, "id643" : { "name" : "addComment", "call" : "$obj->addComment( @lines|\\@lines|$text )", "id" : "id643", "intro" : "Add multiple lines to the translator's comment block. Returns an\nempty string if there are no comments.
\n", "type" : "i_method" }, "id204" : { "type" : "error", "id" : "id204", "subroutine" : "id203", "name" : "even length parameter list for __x at $where" }, "id1267" : { "call" : "exception_decode( $exception, %options )", "intro" : "[1.23] This function attempts to translate object of other exception frameworks\ninto information to create a Log::Report::Exception. It returns the\nsame list of parameters as die_decode() does.
\n\nCurrently supported:
\nInherited, see Log::Report::Dispatcher::isDisabled()
", "id" : "id1182-id1091", "call" : "$obj->isDisabled" }, "id844" : { "name" : "Messages (optionally translatable)", "level" : 2, "path" : "FUNCTIONS/Messages (optionally translatable)", "subroutines" : [ "id852", "id854", "id845", "id847", "id857", "id855", "id859", "id850" ], "intro" : "Even when you do not support translations (yet) you may want to use\nmessage objects to improve the logging feature. For instance,\nyou get very powerful interpolation from String::Print.
\n\nThe language translations are initiate by limited set of functions\nwhich contain two under-scores (__) in their name. Most\nof them return a Log::Report::Message object.
Be warned(1) that -in general- its considered very bad practice to\ncombine multiple translations into one message: translating may also\naffect the order of the translated components. Besides, when the person\nwhich translates only sees smaller parts of the text, his (or her) job\nbecomes more complex. So:
\n\n print __\"Hello\" . ', ' . __\"World!\"; # works, but to be avoided\n print __\"Hello, World!\"; # preferred, complete sentence\n\n\n
The the former case, tricks with overloading used by the\nLog::Report::Message objects will still make delayed translations\nwork.
\n\nIn normal situations, it is not a problem to translate interpolated\nvalues:
\n\n print __\"the color is {c}\", c => __\"red\";\n\n\nBe warned(2) that using __'Hello' will produce a syntax error like\n\"String found where operator expected at .... Can't find string terminator\n\"'\" anywhere before EOF\". The first quote is the cause of the complaint,\nbut the second generates the error. In the early days of Perl, the single\nquote was used to separate package name from function name, a role which\nwas later replaced by a double-colon. So __'Hello' gets interpreted\nas __::Hello '. Then, there is a trailing single quote which has\nno counterpart.
How to serialize data elements.
\n", "type" : "option", "params" : "HASH|ARRAY" }, "id343" : { "path" : "DETAILS/Textdomains/Integration with Template::Toolkit", "intro" : "Instead of Template, from Template::Toolkit, you use its extension\nLog::Report::Template.
\n\n # during initiation of the webserver, once in your script (before fork)\n my $lexicons = 'some-directory-for-translation-tables';\n my $pots = Log::Report::Translator::POT->new(lexicons => $lexicons);\n\n my $templater = Log::Report::Template->new(...);\n my $domain = $templater->addTextdomain(\n name => $domainname,\n function => 'loc',\n );\n $domain->configure(translator => $pots);\n\n # part of the processing per page\n $vars{translate_to} = 'nl_NL.utf8';\n $templater->process($template, \\%vars, \\$output);\n\n\nWhen you use the same domain for both templates as source code, then be\naware that there is only one place where you can configure the domain.\nThis may be in the code. When you use a separate domain for the templates,\nthen you configure as shown above.
\n", "id" : "id343", "type" : "subsection", "name" : "Integration with Template::Toolkit", "level" : 3 }, "id1000" : { "call" : "$obj->toString( [$locale] )", "id" : "id1000", "intro" : "Translate a message. If not specified, the default locale is used.
\n", "type" : "i_method", "name" : "toString" }, "id1141-id385" : { "id" : "id1141-id385", "type" : "default", "value" : "undef",
"extends" : "id1141",
"intro" : "Inherited, see Log::Report::Domain::configure(config)
", "name" : "config" }, "id1168-id1066" : { "id" : "id1168-id1066", "type" : "default", "value" : "<system locale>", "extends" : "id1168", "intro" : "Inherited, see Log::Report::Dispatcher::new(locale)
", "name" : "locale" }, "id621" : { "value" : "undef",
"id" : "id621",
"type" : "default",
"name" : "msgid_plural"
},
"id1120" : {
"path" : "SYNOPSIS",
"id" : "id1120",
"intro" : " use Log::Report::DBIC::Profiler;\n $schema->storage->debugobj(Log::Report::DBIC::Profiler->new);\n $schema->storage->debug(1);\n\n # And maybe (if no exceptions expected from DBIC)\n $schema->exception_action(sub { panic @_ });\n\n # Log to syslog\n use Log::Report;\n dispatcher SYSLOG => 'myapp',\n identity => 'myapp',\n facility => 'local0',\n flags => \"pid ndelay nowait\",\n mode => 'DEBUG';\n\n",
"type" : "chapter",
"name" : "SYNOPSIS",
"level" : 1
},
"id722" : {
"type" : "error",
"id" : "id722",
"subroutine" : "id721",
"name" : "no header defined in POT for file $fn."
},
"id321" : {
"intro" : "Create a new Log::Report::Template::Textdomain object.\nSee its new() method for the options.
Additional facts about the options: you may specify only_in_directory\nas a path. Those directories must be in the INCLUDE_PATH as well.\nThe (domain) name must be unique, and the function not yet in use.
When the code also uses this textdomain, then that configuration will\nget extended with this configuration.
\n", "name" : "addTextdomain", "id" : "id321", "type" : "i_method", "diagnostics" : [ "id323", "id324" ], "call" : "$obj->addTextdomain( %options )", "examples" : [ "id322" ] }, "id1193" : { "name" : "stackTraceLine", "call" : "$any->stackTraceLine( %options )", "id" : "id1193", "type" : "ci_method", "options" : [ [ "id1208", "id1209" ], [ "id1200", "id1201" ], [ "id1196", "id1197" ], [ "id1198", "id1199" ], [ "id1204", "id1205" ], [ "id1206", "id1207" ], [ "id1194", "id1195" ], [ "id1202", "id1203" ] ] }, "id1151" : { "name" : "updateContext", "call" : "$obj->updateContext( STRING|HASH|ARRAY|PAIRS )", "intro" : "[1.10] Make changes and additions to the active context (see setContext()).
\n", "type" : "i_method", "id" : "id1151" }, "id785" : { "level" : 2, "name" : "Categories", "intro" : "Log::Report uses text-domains for translation tables. These are\nalso used as categories for the Log4perl infrastructure. So, typically\nevery module start with:
\n use Log::Report 'my-text-domain', %more_options;\n\n\n
Now, if there is a logger inside the log4perl configuration which is\nnamed 'my-text-domain', that will be used. Otherwise, the name of the\ndispatcher is used to select the logger.
\n", "path" : "DESCRIPTION/Categories", "nest" : [ "id786" ], "id" : "id785", "type" : "section" }, "id518" : { "path" : "METHODS/Constructors", "subroutines" : [ "id519" ], "id" : "id518", "type" : "section", "name" : "Constructors", "level" : 2 }, "id1189-id1091" : { "id" : "id1189-id1091", "intro" : "Inherited, see Log::Report::Dispatcher::addSkipStack()
", "type" : "ci_method", "call" : "$any->addSkipStack( @CODE )", "name" : "addSkipStack", "extends" : "id1189" }, "id344" : { "path" : "DETAILS/Textdomains/Template::Toolkit in Dancer2", "intro" : "When you use Dancer2, you need to connect the text domain with
\n\n my $domain = (engine 'template')->addTextdomain(\n name => 'isaas',\n function => 'loc',\n );\n\n\n
And in file config.ini:
\n template: \"TTLogReport\"\n engines:\n template:\n TTLogReport:\n\n\n
This \"TTLogReport\" refers to module Dancer2::Template::TTLogReport, which is\npart of distribution Log-Report.
Log::Report::Lexicon::MOTcompact - use translations from an MO file
\n", "id" : "id462", "name" : "NAME", "level" : 1 }, "id1078" : { "call" : "$obj->callback", "intro" : "Returns the code reference which will handle each logged message.
\n", "type" : "i_method", "id" : "id1078", "name" : "callback" }, "id146" : { "path" : "SYNOPSIS", "type" : "chapter", "intro" : "# Use Log::Report when already loaded, otherwise Log::Report::Minimal\n package My::Package;\n use Log::Report::Optional 'my-domain';\n\n", "id" : "id146", "name" : "SYNOPSIS", "level" : 1 }, "id843" : { "call" : "panic( $message )", "type" : "function", "intro" : "
Short for report PANIC => $message
undef",
"type" : "default",
"name" : "max_line",
"intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(max_line)
" }, "id477" : { "subroutine" : "id467", "name" : "cannot seek to $loc in $fn for translations: $!", "type" : "fault", "id" : "id477" }, "id644" : { "call" : "$obj->automatic( [@lines|\\@lines|$text] )", "id" : "id644", "intro" : "Returns a STRING which contains the cleaned paragraph of automatically\nadded comments. If an argument is specified, it will replace the current\ncomment.
\n", "type" : "i_method", "name" : "automatic" }, "id203" : { "diagnostics" : [ "id204" ], "call" : "__x( $msgid, PAIRS )", "type" : "function", "id" : "id203", "name" : "__x" }, "id1206-id1091" : { "extends" : "id1206", "name" : "max_params", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(max_params)
", "type" : "option", "id" : "id1206-id1091", "params" : "INTEGER" }, "id1134-id385" : { "params" : "Log::Report::Translator|\\%config", "id" : "id1134-id385", "intro" : "Inherited, see Log::Report::Domain::configure(translator)
", "type" : "option", "name" : "translator", "extends" : "id1134" }, "id595" : { "id" : "id595", "type" : "i_method", "diagnostics" : [ "id596", "id597", "id598" ], "call" : "$obj->ctxtFor( $message, $lang, [$context] )", "name" : "ctxtFor", "intro" : "Returns a pair of the MSGID stripped from context markup, and the\ncontext evaluated into the msgctxt string. The $message is a\nLog::Report::Message object. The $context is the default context\nfor a certain textdomain.
\n\n my ($msgid, $msgctxt) = $context->ctxtFor($msg, $lang, $context);\n\n" }, "id488" : { "call" : "$obj->filename", "intro" : "
Returns the name of the source file for this data.
\n", "id" : "id488", "type" : "i_method", "name" : "filename" }, "id235" : { "call" : "$obj->FREEZE( $serializer )", "intro" : "JSON (both JSON::XS and JSON::PP) and Sereal should work as\n$serializer: they both support the CBOR::XS interface.
\n", "type" : "i_method", "id" : "id235", "name" : "FREEZE" }, "id287" : { "intro" : "If you use manual DBIx::Class in your application, you can easily integrate\nits logging and exceptions. To log SQL queries:
\n\n # Log all queries and execution time\n $schema->storage->debugobj(new Log::Report::DBIC::Profiler);\n $schema->storage->debug(1);\n\n\n
By default, exceptions from DBIC are classified at the level \"error\". This\nis normally a user level error, and thus may be filtered as normal program\noperation. If you do not expect to receive any DBIC exceptions, then it\nis better to class them at the level \"panic\":
\n\n # panic() DBIC errors\n $schema->exception_action(sub { panic @_ });\n # Optionally get a stracktrace too\n $schema->stacktrace(1);\n\n\nIf you are occasionally running queries where you expect to naturally\nget exceptions (such as not inserting multiple values on a unique constraint),\nthen you can catch these separately:
\n\n try { $self->schema->resultset('Unique')->create() };\n # Log any messages from try block, but only as trace\n $@->reportAll(reason => 'TRACE');\n\n",
"id" : "id287",
"type" : "subsection",
"path" : "DETAILS/In Use/Logging DBIC database queries and errors",
"level" : 3,
"name" : "Logging DBIC database queries and errors"
},
"id821" : {
"subroutine" : "id807",
"name" : "token '$token' not recognized as reason.",
"id" : "id821",
"type" : "error"
},
"id278" : {
"level" : 2,
"name" : "Setup and Configuration",
"intro" : "To make full use of Log::Report, you'll need to use both\nDancer2::Logger::LogReport and Dancer2::Plugin::LogReport.
\n", "path" : "DETAILS/Setup and Configuration", "nest" : [ "id279", "id280", "id281" ], "id" : "id278", "type" : "section" }, "id949" : { "name" : "_domain", "value" : "<from \"use Log::Report\">", "id" : "id949", "type" : "default" }, "id1131-id385" : { "call" : "$obj->translator", "intro" : "Inherited, see Log::Report::Domain::translator()
", "id" : "id1131-id385", "type" : "i_method", "name" : "translator", "extends" : "id1131" }, "id536" : { "type" : "default", "value" : "[]", "id" : "id536", "name" : "keep" }, "id168" : { "params" : "CODE|\\%config|'PRINTI'", "intro" : "Selects the formatter used for the errors messages. The default is the\nstring PRINTI, which will use String::Print::printi(): interpolation\nwith curly braces around the variable names.
# use one of the extensions, for instance:\n my $pot = Log::Report::Lexicon::POT->read('po/nl.po', charset => 'utf-8')\n or panic;\n\n",
"type" : "chapter"
},
"id1195-id1021" : {
"extends" : "id1195",
"type" : "default",
"id" : "id1195-id1021",
"value" : "<required>",
"name" : "package",
"intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(package)
" }, "id1154" : { "name" : "DETAILS", "level" : 1, "path" : "DETAILS", "nest" : [ "id1155" ], "id" : "id1154", "type" : "chapter" }, "id1196-id1091" : { "params" : "STRING", "type" : "option", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(filename)
", "id" : "id1196-id1091", "name" : "filename", "extends" : "id1196" }, "id182" : { "value" : "$! or 1",
"type" : "default",
"id" : "id182",
"name" : "errno"
},
"id75" : {
"type" : "example",
"intro" : " use String::Print; # all\n use String::Print 'sprinti'; # only sprinti\n\n use String::Print 'printi', # only printi\n modifiers => [ EUR => sub {sprintf \"%5.2f e\", $_[0]} ],\n serializers => [ UNDEF => sub {'-'} ],\n defaults => [ DT => { standard => 'ISO' } ];\n\n printi \"price: {p EUR}\", p => 3.1415; # price: ␣␣3.14 e\n printi \"count: {c}\", c => undef; # count: -\n my $s = sprinti \"price: {p EUR}\", p => 7; # output in $s\n\n",
"id" : "id75"
},
"id246" : {
"name" : "addTextDomain",
"examples" : [
"id247"
],
"call" : "$obj->addTextDomain( %options )",
"intro" : "Forwards the %options to Log::Report::Template::addTextdomain().
\n", "type" : "i_method", "id" : "id246" }, "id1303" : { "path" : "METHODS/Managing PO's/Administration", "id" : "id1303", "type" : "subsection", "subroutines" : [ "id751-id669", "id719", "id755-id669", "id753-id669", "id717", "id721" ], "name" : "Administration", "level" : 3 }, "id981" : { "intro" : " my $s = __x \"found {nr} files\", nr => 5;\n my $t = $s->clone(nr => 3);\n my $t = $s->(nr => 3); # equivalent\n print $s; # found 5 files\n print $t; # found 3 files\n\n",
"id" : "id981",
"type" : "example",
"name" : "use of clone()\n"
},
"id1197-id1066" : {
"name" : "filename",
"intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(filename)
", "extends" : "id1197", "value" : "<required>", "id" : "id1197-id1066", "type" : "default" }, "id103" : { "level" : 3, "name" : "Modifier: //word, //\"string\", //'string'", "intro" : "[0.91] By default, an undefined value is shown as text 'undef'. Empty\nstrings are shown as nothing. This may not be nice. You may want to\nbe more specific when a value is missing.
\n \"visitors: {count //0}\"\n \"published: {date DT//'not yet'}\"\n \"copyright: {year//2017 YEAR}\n\n\nModifiers will usually return undef when they are called with an\nundefined or empty value. By the right order of '//', you may product\ndifferent kinds of output:
\n \"price: {price//5 EUR}\"\n \"price: {price EUR//unknown}\"\n\n",
"type" : "subsection",
"id" : "id103",
"path" : "DETAILS/Interpolation: Modifiers/Modifier: //word, //\"string\", //'string'"
},
"id135" : {
"name" : "must_show_stack",
"call" : "must_show_stack( $mode, $reason )",
"id" : "id135",
"type" : "function"
},
"id1192-id1021" : {
"id" : "id1192-id1021",
"intro" : "Inherited, see Log::Report::Dispatcher::collectLocation()
", "type" : "ci_method", "call" : "$any->collectLocation", "extends" : "id1192", "name" : "collectLocation" }, "id806" : { "path" : "FUNCTIONS/Report production and configuration", "subroutines" : [ "id807", "id825", "id830" ], "id" : "id806", "type" : "section", "name" : "Report production and configuration", "level" : 2 }, "id472" : { "type" : "fault", "id" : "id472", "name" : "cannot read magic from $fn: $!", "subroutine" : "id467" }, "id999" : { "call" : "$obj->inClass( $tag|Regexp )", "id" : "id999", "intro" : "Deprecated alternative for taggedWith().
\n", "type" : "i_method", "name" : "inClass" }, "id1108" : { "intro" : "Returns the name of the opened file, or undef in case this dispatcher\nwas started from a file-handle or file-object.
Read the MOT table information from $filename.
\n", "name" : "read", "call" : "$class->read( $filename, %options )", "diagnostics" : [ "id470", "id471", "id472", "id473", "id474", "id475", "id476", "id477", "id478", "id479", "id480", "id481", "id482", "id483", "id484", "id485" ], "id" : "id467", "type" : "c_method", "options" : [ [ "id468", "id469" ] ] }, "id1028" : { "path" : "METHODS", "level" : 1, "name" : "METHODS", "type" : "chapter", "id" : "id1028", "nest" : [ "id1029", "id1039", "id1046", "id1050" ] }, "id268" : { "type" : "i_method", "id" : "id268", "call" : "$obj->mistake", "name" : "mistake" }, "id196" : { "id" : "id196", "type" : "function", "call" : "error( $message )", "name" : "error" }, "id1171-id1091" : { "params" : "'UPPERCASE'|'LOWERCASE'|'UCFIRST'|'IGNORE'|CODE", "type" : "option", "intro" : "Inherited, see Log::Report::Dispatcher::new(format_reason)
", "id" : "id1171-id1091", "name" : "format_reason", "extends" : "id1171" }, "id394" : { "name" : "translation_function", "params" : "STRING", "id" : "id394", "intro" : "The name of the function as used in the template to call for translation.\nSee function(). It must be unique over all text-domains used.
\n", "type" : "option" }, "id1146" : { "subroutine" : "id1144", "name" : "unsupported context file type for $fn", "id" : "id1146", "type" : "error" }, "id893" : { "path" : "DETAILS/Error handling models/The Reason for the report/Report level comparison", "intro" : "Various frameworks used with perl programs define different labels\nto indicate the reason for the message to be produced.
\n\n Perl5 Log::Dispatch Syslog Log4Perl Log::Report\n print 0,debug debug debug trace\n print 0,debug debug debug assert\n print 1,info info info info\n warn\\n 2,notice notice info notice\n warn 3,warning warn warn mistake\n carp 3,warning warn warn warning\n die\\n 4,error err error error\n die 5,critical crit fatal fault\n croak 6,alert alert fatal alert\n croak 7,emergency emerg fatal failure\n confess 7,emergency emerg fatal panic\n\n", "id" : "id893", "type" : "subsubsection", "name" : "Report level comparison", "level" : 4 }, "id1188-id905" : { "call" : "$any->collectStack( [$maxdepth] )", "type" : "ci_method", "intro" : "
Inherited, see Log::Report::Dispatcher::collectStack()
", "id" : "id1188-id905", "extends" : "id1188", "name" : "collectStack" }, "id1207-id1066" : { "extends" : "id1207", "type" : "default", "id" : "id1207-id1066", "value" : "8", "name" : "max_params", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(max_params)
" }, "id694" : { "subroutine" : "id675", "name" : "textdomain parameter is required.", "id" : "id694", "type" : "error" }, "id1202-id1021" : { "name" : "params", "extends" : "id1202", "params" : "ARRAY", "id" : "id1202-id1021", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(params)
", "type" : "option" }, "id282" : { "path" : "DETAILS/In Use", "name" : "In Use", "level" : 2, "id" : "id282", "type" : "section", "nest" : [ "id283", "id284", "id285", "id286", "id287", "id288" ] }, "id545" : { "path" : "DESCRIPTION", "id" : "id545", "intro" : "UNTESTED!!! PLEASE CONTRIBUTE!!!\nTranslate a message using the GNU gettext infrastructure.
\n\nGuido Flohr reports:\nbe aware that Locale::gettext is only a binding for the C library\nlibintl and depends on its features. That means that your module will\neffectively only run on GNU systems and maybe on Solaris (depending\non the exact version), because only these systems provide the plural\nhandling functions ngettext(), dngettext() and dcngettext(). Sooner or\nlater you will probably also need bind_textdomain_codeset() which is\nalso only available on certain systems.
\n", "type" : "chapter", "name" : "DESCRIPTION", "level" : 1 }, "id1177-id1217" : { "subroutine" : "id1164", "name" : "Perl does not support charset $cs", "extends" : "id1177", "intro" : "Inherited, see Log::Report::Dispatcher::new()
", "type" : "error", "id" : "id1177-id1217" }, "id187" : { "call" : "dispatcher( <$type, $name, %options>|<$command, @names> )", "type" : "function", "intro" : "Not supported.
\n", "id" : "id187", "name" : "dispatcher" }, "id1187" : { "name" : "translate", "intro" : "See Processing the message, which describes the actions taken by\nthis method. A string is returned, which ends on a new-line, and\nmay be multi-line (in case a stack trace is produced).
\n", "type" : "i_method", "id" : "id1187", "call" : "$obj->translate( \\%options, $reason, $message )" }, "id331" : { "name" : "write_tables", "type" : "default", "value" : "<true>",
"id" : "id331"
},
"id178" : {
"name" : "textdomain",
"call" : "textdomain( <[$name],$config>|<$name, 'DELETE'|'EXISTS'>|$domain )",
"type" : "function",
"id" : "id178"
},
"id631" : {
"value" : "\"\"",
"id" : "id631",
"type" : "default",
"name" : "automatic"
},
"id995-id221" : {
"call" : "$obj->valueOf( $parameter )",
"intro" : "Inherited, see Log::Report::Message::valueOf()
", "type" : "i_method", "id" : "id995-id221", "name" : "valueOf", "extends" : "id995" }, "id732" : { "id" : "id732", "type" : "section", "subroutines" : [ "id733" ], "path" : "METHODS/Constructors", "level" : 2, "name" : "Constructors" }, "id1298" : { "level" : 2, "name" : "Available back-ends", "id" : "id1298", "type" : "section", "path" : "DETAILS/Available back-ends" }, "id1168-id905" : { "name" : "locale", "intro" : "Inherited, see Log::Report::Dispatcher::new(locale)
", "extends" : "id1168", "value" : "<system locale>", "id" : "id1168-id905", "type" : "default" }, "id1090" : { "call" : "$obj->load( $domain, $locale )", "intro" : "Load the translation information in the text $domain for the indicated $locale.\nMultiple calls to load() should not cost significant performance: the\ndata must be cached.
\n", "id" : "id1090", "type" : "i_method", "name" : "load" }, "id266" : { "type" : "i_method", "id" : "id266", "call" : "$obj->notice", "name" : "notice" }, "id198" : { "name" : "alert", "id" : "id198", "type" : "function", "call" : "alert( $message )" }, "id1308" : { "path" : "DETAILS/Processing the message", "level" : 2, "name" : "Processing the message", "type" : "section", "id" : "id1308", "nest" : [ "id1309", "id1310" ] }, "id975-id221" : { "extends" : "id975", "id" : "id975-id221", "value" : "<from locale>", "type" : "default", "name" : "_lang", "intro" : "Inherited, see Log::Report::Message::new(_lang)
" }, "id1194-id760" : { "params" : "CLASS", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(package)
", "type" : "option", "id" : "id1194-id760", "name" : "package", "extends" : "id1194" }, "id374" : { "name" : "pattern", "id" : "id374", "value" : "<from new(pattern)>", "type" : "default" }, "id176" : { "id" : "id176", "intro" : "This module implements the functions provided by Log::Report, but then\nas simple as possible: no support for translations, no dispatchers, no\nsmart exceptions. The package uses Log::Report in an ::Optional\nway, the main script determines whether it wants the ::Minimal or\nfull-blown feature set.
undef",
"type" : "default"
},
"id1167" : {
"name" : "locale",
"params" : "LOCALE",
"intro" : "Overrules the global locale setting. Can be overruled itself by\nLog::Report::report(locale).
\n", "id" : "id1167", "type" : "option" }, "id1103" : { "params" : "CODE|'LONG'", "intro" : "[1.00] process each printed line. By default, this adds a timestamp,\nbut you may want to add hostname, process number, or more.
\n\n format => sub { '['.localtime().'] '.$_[0] }\n format => sub { shift } # no timestamp\n format => 'LONG'\n\n\nThe first parameter to format is the string to print; it is already\ntranslated and trailed by a newline. The second parameter is the\ntext-domain (if known).
\n\n[1.10] As third parameter, you get the message raw object as well (maybe\nyou want to use the message context?)
\n\n[1.19] After the three positional parameters, there may be a list\nof pairs providing additional facts about the exception. It may\ncontain location information.
The \"LONG\" format is equivalent to:
\n\n my $t = strftime \"%FT%T\", gmtime;\n \"[$t $$] $_[1] $_[0]\"\n\n\n
Use of context:
\n\n format => sub { my ($msgstr, $domain, $msg, %more) = @_;\n my $host = $msg->context->{host};\n \"$host $msgstr\";\n }\n\n",
"id" : "id1103",
"type" : "option",
"name" : "format"
},
"id1201-id760" : {
"extends" : "id1201",
"type" : "default",
"id" : "id1201-id760",
"value" : "<required>",
"name" : "call",
"intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(call)
" }, "id447" : { "name" : "new", "id" : "id447", "intro" : "Create an index for a certain directory. If the directory does not\nexist or is empty, then the object will still be created.
\n\nAll files the $directory tree which are recognized as an translation table\nformat which is understood will be listed. Momentarily, those are:
\n\n[0.99] Files which are in directories which start with a dot (hidden\ndirectories) and files which start with a dot (hidden files) are skipped.
\n", "type" : "c_method", "call" : "$class->new( $directory, %options )" }, "id674" : { "name" : "Constructors", "level" : 2, "path" : "METHODS/Constructors", "subroutines" : [ "id675", "id695", "id703" ], "type" : "section", "id" : "id674" }, "id1010-id221" : { "extends" : "id1010", "name" : "thaw", "id" : "id1010-id221", "intro" : "Inherited, see Log::Report::Message::thaw()
", "type" : "c_method", "call" : "$class->thaw( \\%data, %options )" }, "id1023" : { "intro" : " try { ... }; # mind the ';' !!\n if($@) { # signals something went wrong\n\n if(try {...}) { # block ended normally\n\n my $x = try { read_temperature() };\n my @x = try { read_lines_from_file() };\n\n try { ... } # no comma!!\n mode => 'DEBUG', accept => 'ERROR-';\n\n try sub { ... }, # with comma\n mode => 'DEBUG', accept => 'ALL';\n\n try \\&myhandler, accept => 'ERROR-';\n try { ... } hide => 'TRACE';\n\n print ref $@; # Log::Report::Dispatcher::Try\n\n $@->reportFatal; # re-dispatch result of try block\n $@->reportAll; # ... also warnings etc\n if($@) {...} # if errors\n if($@->failed) { # same # }\n if($@->success) { # no errors # }\n\n try { # something causes an error report, which is caught\n failure 'no network';\n };\n $@->reportFatal(to => 'syslog'); # overrule destination\n\n print $@->exceptions; # no re-cast, just print\n\n",
"type" : "chapter",
"id" : "id1023",
"path" : "SYNOPSIS",
"level" : 1,
"name" : "SYNOPSIS"
},
"id525-id493" : {
"intro" : "Inherited, see Log::Report::Extract::new()
", "type" : "fault", "id" : "id525-id493", "name" : "cannot create lexicon directory $dir: $!", "extends" : "id525", "subroutine" : "id519" }, "id700" : { "subroutine" : "id695", "name" : "cannot detect charset in $fn.", "id" : "id700", "type" : "error" }, "id1220" : { "path" : "DESCRIPTION", "type" : "chapter", "intro" : "Ventilate the problem reports via the standard Perl error mechanisms:\ndie(), warn(), and print(). There can be only one such dispatcher\n(per thread), because once die() is called, we are not able to return.\nTherefore, this dispatcher will always be called last.
In the early releases of Log::Report, it tried to simulate the behavior\nof warn and die using STDERR and exit; however: that is not possible.
\n", "id" : "id1220", "name" : "DESCRIPTION", "level" : 1 }, "id1183-id905" : { "id" : "id1183-id905", "intro" : "Inherited, see Log::Report::Dispatcher::needs()
", "type" : "i_method", "call" : "$obj->needs( [$reason] )", "name" : "needs", "extends" : "id1183" }, "id712" : { "name" : "filename", "intro" : "Returns the filename, as derived from read() or specified during\ninitiation with new(filename).
\n", "id" : "id712", "type" : "i_method", "call" : "$obj->filename" }, "id492" : { "intro" : "Returns the translated string for $msgid. When not specified, $count is 1\n(the singular form).
\n", "type" : "i_method", "id" : "id492", "call" : "$obj->msgstr( $msgid, [$count, $msgctxt] )", "name" : "msgstr" }, "id611" : { "chapters" : [ "id612", "id613", "id614", "id615" ], "name" : "Log::Report::Lexicon::PO", "version" : "1.16", "is_pure_pod" : false, "package" : "Log::Report::Lexicon::PO", "distribution" : "Log-Report-Lexicon", "id" : "id611", "inheritance" : {}, "title" : "one translation definition" }, "id248" : { "call" : "$obj->render( $template, \\%tokens )", "id" : "id248", "intro" : "Renders the template. The first arg is a filename for the template file\nor a reference to a string that contains the template. The second arg\nis a hashref for the tokens that you wish to pass to\nmanual Template::Toolkit for rendering.
\n\nWhen a translation language is set, then this renderer adds the following\nvariables: language (like \"nl\"), language_territory (like \"nl_BE\"),\nand locale (like \"nl_BE.utf8\").
Sent the $message only to the named dispatchers. Ignore unknown @names.\nStill, the dispatcher needs to be enabled and accept the $reason.
\n", "id" : "id808", "type" : "option", "name" : "to" }, "id565" : { "id" : "id565", "type" : "chapter", "nest" : [ "id566", "id576", "id579" ], "path" : "METHODS", "level" : 1, "name" : "METHODS" }, "id979" : { "value" : "undef",
"id" : "id979",
"type" : "default",
"name" : "_msgctxt"
},
"id1204-id760" : {
"extends" : "id1204",
"name" : "max_line",
"id" : "id1204-id760",
"intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(max_line)
", "type" : "option", "params" : "INTEGER" }, "id311" : { "name" : "modifiers", "id" : "id311", "value" : "[]", "type" : "default" }, "id1191-id760" : { "name" : "skipStack", "extends" : "id1191", "call" : "$obj->skipStack", "intro" : "Inherited, see Log::Report::Dispatcher::skipStack()
", "id" : "id1191-id760", "type" : "i_method" }, "id1293" : { "path" : "DETAILS/Available back-ends", "id" : "id1293", "type" : "section", "name" : "Available back-ends", "level" : 2 }, "id1346" : { "level" : 1, "name" : "INHERITANCE", "type" : "chapter", "intro" : "Log::Report::Minimal::Domain is extended by\n Log::Report::Domain\n\n", "id" : "id1346", "path" : "INHERITANCE" }, "id276" : { "level" : 1, "name" : "DETAILS", "intro" : "
This chapter will guide you through the myriad of ways that you can use\nLog::Report in your Dancer2 application.
\n\nWe will set up our application to do the following:
\n\nInherited, see Log::Report::Message::freeze(serializer)
", "id" : "id1007-id221", "params" : "'JSON'|'Serial'|..." }, "id965-id221" : { "intro" : "Inherited, see Log::Report::Message::new(_tags)
", "name" : "_tags", "id" : "id965-id221", "type" : "default", "value" : "[]", "extends" : "id965" }, "id1073" : { "call" : "$class->new( $type, $name, %options )", "diagnostics" : [ "id1076" ], "type" : "c_method", "id" : "id1073", "options" : [ [ "id1165-id1066", "id1166-id1066" ], [ "id1074", "id1075" ], [ "id1173-id1066", "id1174-id1066" ], [ "id1171-id1066", "id1172-id1066" ], [ "id1167-id1066", "id1168-id1066" ], [ "id1169-id1066", "id1170-id1066" ] ], "name" : "new" }, "id863" : { "call" : "__px( $msgctxt, $msgid, PAIRS )", "type" : "function", "id" : "id863", "name" : "__px" }, "id442" : { "level" : 1, "name" : "NAME", "type" : "chapter", "intro" : "Log::Report::Lexicon::Index - search through available translation files
\n", "id" : "id442", "path" : "NAME" }, "id538" : { "name" : "write", "intro" : "Update the information of the files related to $domain, by default all\nprocessed DOMAINS.
\n\nAll information known about the written $domain is removed from the cache.\nThe %options are passed to the write() of the specific lexicon\nmanager.
Specifies the location of the configuration. It is not allowed to\nconfigure a domain on more than one location.
\n", "type" : "option", "params" : "ARRAY" }, "id364" : { "value" : "<undef>",
"type" : "default",
"id" : "id364",
"name" : "pattern"
},
"id1351" : {
"path" : "INHERITANCE",
"intro" : "Dancer2::Logger::LogReport\n is a Moo::Object\n\n", "id" : "id1351", "type" : "chapter", "name" : "INHERITANCE", "level" : 1 }, "id664" : { "name" : "nr_plurals", "id" : "id664", "intro" : "
If the number of plurals is specified, then the plural translation\nlist can be checked for the correct length. Otherwise, no smart\nbehavior is attempted.
\n", "type" : "option", "params" : "INTEGER" }, "id1031" : { "id" : "id1031", "intro" : "ARRAY of Log::Report::Exception objects.
\n", "type" : "option", "params" : "\\@objects", "name" : "exceptions" }, "id1354" : { "path" : "INHERITANCE", "intro" : "Dancer2::Plugin::LogReport\n is a Dancer2::Plugin\n\n", "type" : "chapter", "id" : "id1354", "name" : "INHERITANCE", "level" : 1 }, "id497" : { "nest" : [ "id498", "id499" ], "id" : "id497", "type" : "section", "name" : "The extraction process", "level" : 2, "path" : "DESCRIPTION/The extraction process", "intro" : "
All pm-files need to be processed in one go: no incremental processing!
\n\nThe Perl source is parsed using PPI, which does understand Perl syntax\nquite well, but does not support all features.
\n\nAutomatically, the textdomain of the translations is discovered, as\nfirst parameter of use Log::Report. You may switch textdomain inside\none pm-file.
When all files have been processed, during the write(), all existing\npo-files for all discovered textdomains will get updated. Not only the\n$lexicon/$domain.po template, but also all $lexicon/$domain/$lang.po\nwill be replaced. When a msgid has disappeared, existing translations\nwill get disabled, not removed. New msgids will be added and flagged\n\"fuzzy\".
Inherited, see Log::Report::Dispatcher::new(mode)
", "type" : "option", "params" : "'NORMAL'|'VERBOSE'|'ASSERT'|'DEBUG'|0..3", "extends" : "id1169", "name" : "mode" }, "id717" : { "call" : "$obj->add( $po )", "diagnostics" : [ "id718" ], "type" : "i_method", "id" : "id717", "name" : "add", "intro" : "Add the information from a $po into this POT. If the msgid of the $po\nis already known, that is an error.
\n" }, "id969" : { "name" : "_class", "value" : "undef",
"id" : "id969",
"type" : "default"
},
"id1034" : {
"name" : "died",
"id" : "id1034",
"value" : "undef",
"type" : "default"
},
"id575" : {
"type" : "error",
"id" : "id575",
"name" : "unsupported charset $charset in $fn.",
"subroutine" : "id567"
},
"id516" : {
"path" : "DESCRIPTION",
"intro" : "This module helps maintaining the POT files, updating the list of\nmessage-ids which are kept in them. After initiation, the process()\nmethod needs to be called with all files which changed since last\nprocessing and the existing PO files will get updated accordingly. If no\ntranslations exist yet, one textdomain/xx.po file will be created.
Inherited, see Log::Report::Extract::charset()
", "type" : "i_method", "call" : "$obj->charset", "extends" : "id528", "name" : "charset" }, "id486" : { "level" : 2, "name" : "Attributes", "type" : "section", "id" : "id486", "subroutines" : [ "id489", "id488", "id487" ], "path" : "METHODS/Attributes" }, "id301" : { "path" : "SYNOPSIS", "intro" : " use Log::Report::Template;\n my $templater = Log::Report::Template->new(%config);\n $templater->addTextdomain(name => \"Tic\", lexicons => ...);\n $templater->process('template_file.tt', \\%vars, \\$output);\n\n",
"type" : "chapter",
"id" : "id301",
"name" : "SYNOPSIS",
"level" : 1
},
"id531-id354" : {
"intro" : "Inherited, see Log::Report::Extract::addPot()
", "id" : "id531-id354", "type" : "i_method", "call" : "$obj->addPot( $domain, $pot, %options )", "name" : "addPot", "extends" : "id531" }, "id818" : { "name" : "is_fatal", "params" : "BOOLEAN", "intro" : "Some logged exceptions are fatal, other aren't. The default usually\nis correct. However, you may want an error to be caught (usually with\ntry()), redispatch it to syslog, but without it killing the main\nprogram.
\n", "id" : "id818", "type" : "option" }, "id601" : { "intro" : "Expand the context settings into all possible combinations which need\ntranslations in the PO file. This may depend on the $language.\nThe $msgid is used in error messages.
\n", "name" : "expand", "call" : "$obj->expand( $msgid, $language, %options )", "diagnostics" : [ "id602" ], "type" : "i_method", "id" : "id601" }, "id702" : { "name" : "failed reading from file $fn: $!", "subroutine" : "id695", "type" : "fault", "id" : "id702" }, "id710" : { "name" : "charset", "call" : "$obj->charset", "intro" : "The character-set to be used for reading and writing. You do not need\nto be aware of Perl's internal encoding for the characters.
\n", "id" : "id710", "type" : "i_method" }, "id993-id221" : { "name" : "to", "extends" : "id993", "id" : "id993-id221", "intro" : "Inherited, see Log::Report::Message::to()
", "type" : "i_method", "call" : "$obj->to( [$name] )" }, "id1200" : { "name" : "call", "type" : "option", "id" : "id1200", "params" : "STRING" }, "id490" : { "level" : 2, "name" : "Managing PO's", "path" : "METHODS/Managing PO's", "nest" : [ "id1304", "id1305" ], "type" : "section", "id" : "id490" }, "id895" : { "intro" : "The GetOptions() function will count the number of v options\non the command-line when a + is after the option name.
\n use Log::Report;\n use Getopt::Long qw(:config no_ignore_case bundling);\n\n my $mode; # defaults to NORMAL\n GetOptions 'v+' => \\$mode,\n 'verbose=i' => \\$mode,\n 'mode=s' => \\$mode\n or exit 1;\n\n dispatcher 'PERL', 'default', mode => $mode;\n\n\n
Now, -vv will set $mode to 2, as will --verbose 2 and\n--verbose=2 and --mode=ASSERT. Of course, you do not need to\nprovide all these options to the user: make a choice.
Some $text or other $message object which need to be glued before this\nmessage object.
\n", "type" : "option", "id" : "id958", "name" : "_prepend" }, "id1180-id1066" : { "call" : "$obj->type", "type" : "i_method", "intro" : "Inherited, see Log::Report::Dispatcher::type()
", "id" : "id1180-id1066", "name" : "type", "extends" : "id1180" }, "id66" : { "name" : "addModifiers", "intro" : "The PAIRS are a combination of an selector and a CODE which processes the\nvalue when the modifier matches. The selector is a string or (preferred)\na regular expression. Later modifiers with the same name overrule earlier\ndefinitions. You may also specify an ARRAY of modifiers per printi()\nor printp().
\n\nSee section Interpolation: Modifiers about the details.
\n", "id" : "id66", "type" : "i_method", "call" : "$obj->addModifiers( PAIRS )" }, "id1165-id760" : { "extends" : "id1165", "name" : "accept", "id" : "id1165-id760", "intro" : "Inherited, see Log::Report::Dispatcher::new(accept)
", "type" : "option", "params" : "$reasons|\\@reasons" }, "id543" : { "type" : "chapter", "intro" : "Log::Report::Translator::Gettext - the GNU gettext infrastructure
\n", "id" : "id543", "path" : "NAME", "level" : 1, "name" : "NAME" }, "id1171-id780" : { "params" : "'UPPERCASE'|'LOWERCASE'|'UCFIRST'|'IGNORE'|CODE", "type" : "option", "intro" : "Inherited, see Log::Report::Dispatcher::new(format_reason)
", "id" : "id1171-id780", "name" : "format_reason", "extends" : "id1171" }, "id1179-id1021" : { "id" : "id1179-id1021", "intro" : "Inherited, see Log::Report::Dispatcher::name()
", "type" : "i_method", "call" : "$obj->name", "extends" : "id1179", "name" : "name" }, "id521" : { "name" : "lexicon", "value" : "<required>", "id" : "id521", "type" : "default" }, "id1328" : { "name" : "INHERITANCE", "level" : 1, "path" : "INHERITANCE", "type" : "chapter", "intro" : "Log::Report::Dispatcher::Syslog\n is a Log::Report::Dispatcher\n\n", "id" : "id1328" }, "id1190" : { "id" : "id1190", "intro" : "
By default, all lines in the Log::Report packages are skipped from\ndisplay, with a simple CODE as this:
\n\n sub in_lr { $_[0][0] =~ m/^Log\\:\\:Report(?:\\:\\:|$)/ }\n Log::Report::Dispatcher->addSkipStack(\\&in_lr);\n\n\nThe only parameter to in_lr is the return of caller(). The first\nelement of that ARRAY is the package name of a stack line.
\n", "type" : "example" }, "id1174-id780" : { "extends" : "id1174", "type" : "default", "id" : "id1174-id780", "value" : "undef",
"name" : "charset",
"intro" : "Inherited, see Log::Report::Dispatcher::new(charset)
" }, "id729" : { "level" : 1, "name" : "SYNOPSIS", "id" : "id729", "type" : "chapter", "path" : "SYNOPSIS" }, "id1123" : { "type" : "chapter", "intro" : "Log::Report::Domain - administer one text-domain
\n", "id" : "id1123", "path" : "NAME", "level" : 1, "name" : "NAME" }, "id157-id385" : { "extends" : "id157", "name" : "name", "id" : "id157-id385", "intro" : "Inherited, see Log::Report::Minimal::Domain::new(name)
", "type" : "option", "params" : "STRING" }, "id1003" : { "id" : "id1003", "intro" : "Return the concatenation of the prepend, msgid, and append strings. Variable\nexpansions within the msgid is not performed.
\n", "type" : "i_method", "call" : "$obj->untranslated", "name" : "untranslated" }, "id224" : { "intro" : "[This Dancer2 plugin was contributed by Andrew Beverley]
\n\nThis class is an extension of Log::Report::Message, with functions\nspecifically designed for Dancer applications. Minimal functions are\nprovided (currently only aimed at Bootstrap), but ideas for new ones are\nwelcome.
\n", "type" : "chapter", "id" : "id224", "path" : "DESCRIPTION", "level" : 1, "name" : "DESCRIPTION" }, "id133" : { "name" : "mode_accepts", "call" : "mode_accepts( $mode )", "id" : "id133", "intro" : "Returns something acceptable by expand_reasons()
\n", "type" : "function" }, "id1067" : { "name" : "NAME", "level" : 1, "path" : "NAME", "id" : "id1067", "intro" : "Log::Report::Dispatcher::Callback - call a code-ref for each log-line
\n", "type" : "chapter" }, "id105" : { "level" : 3, "name" : "Modifier: EL or EL($width, [$replace])", "id" : "id105", "intro" : "[1.00] When the string is larger than $width columns, then chop it\nshort and add a 'mid-line ellipsis' character: ⋯ . You may also\npick another replacement string. The comma is optional
Attention: \"columns\" not \"characters\": it is aware of wide fonts, like\nchinese characters (see %S above). The default ellipsis is also two\ncolumns wide.
\n \"Intro: {text EL(10)}\"; # Intro: 12345678⋯ \n \"Intro: {text EL(10,⋮)}\"; # Intro: 123456789⋮ \n \"Intro: {text EL(10⋮)}\"; # Intro: 123456789⋮ \n \"Intro: {text EL(10,XY)}\"; # Intro: 12345678XY \n \"Intro: {text EL(10XY)}\"; # Intro: 12345678XY \n\n\nThe defaults for EL are '20' and '⋯' (mid-dots). You can changes these\nwith setDefaults():
\n\n $sp->setDefaults(EL => { width => 10, replace => '⋮' });\n $sp->printi(\"Intro: {text EL}\"); # Intro: 12345678⋯ \n\n",
"type" : "subsection",
"path" : "DETAILS/Interpolation: Modifiers/Modifier: EL or EL($width, [$replace])"
},
"id836" : {
"name" : "notice",
"id" : "id836",
"intro" : "Short for report NOTICE => $message
Inherited, see Log::Report::Domain::readConfig()
", "type" : "error", "id" : "id1146-id385", "extends" : "id1146", "name" : "unsupported context file type for $fn", "subroutine" : "id1144" }, "id506" : { "id" : "id506", "value" : "'iso-8859-1'", "type" : "default", "name" : "charset" }, "id1134" : { "params" : "Log::Report::Translator|\\%config", "intro" : "Set the object which will do the translations for this domain.
\n", "id" : "id1134", "type" : "option", "name" : "translator" }, "id707" : { "subroutine" : "id703", "name" : "no filename or file-handle specified for PO.", "type" : "error", "id" : "id707" }, "id748-id561" : { "extends" : "id748", "name" : "add", "intro" : "Inherited, see Log::Report::Lexicon::Table::add()
", "type" : "i_method", "id" : "id748-id561", "call" : "$obj->add( $po )" }, "id1196-id780" : { "extends" : "id1196", "name" : "filename", "type" : "option", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(filename)
", "id" : "id1196-id780", "params" : "STRING" }, "id451" : { "call" : "$obj->index", "type" : "i_method", "intro" : "For internal use only.\nForce the creation of the index (if not already done). Returns a hash\nwith key-value pairs, where the key is the lower-cased version of the\nfilename, and the value the case-sensitive version of the filename.
\n", "id" : "id451", "name" : "index" }, "id67" : { "call" : "$obj->encodeFor( \\%settings|undef|($predefined, %overrule) )", "intro" : "[0.91] Enable/define the output encoding. The %settings contain the encoding\nCODE and the tag name patterns to exclude from encoding. Output for HTML\nis $predefined, but you may %overrule its settings.
Read section Output encoding about the details.
\n", "id" : "id67", "type" : "i_method", "name" : "encodeFor" }, "id1217" : { "distribution" : "Log-Report", "package" : "Log::Report::Dispatcher::Perl", "is_pure_pod" : false, "title" : "send messages to die and warn", "inheritance" : { "extends" : [ "Log::Report::Dispatcher" ] }, "id" : "id1217", "chapters" : [ "id1218", "id1344", "id1219", "id1220", "id1221", "id1306" ], "name" : "Log::Report::Dispatcher::Perl", "version" : "1.46" }, "id164-id1122" : { "id" : "id164-id1122", "intro" : "Inherited, see Log::Report::Minimal::Domain::format()
", "type" : "i_method", "call" : "$obj->format", "name" : "format", "extends" : "id164" }, "id1151-id385" : { "extends" : "id1151", "name" : "updateContext", "call" : "$obj->updateContext( STRING|HASH|ARRAY|PAIRS )", "type" : "i_method", "intro" : "Inherited, see Log::Report::Domain::updateContext()
", "id" : "id1151-id385" }, "id1168-id1217" : { "name" : "locale", "intro" : "Inherited, see Log::Report::Dispatcher::new(locale)
", "extends" : "id1168", "type" : "default", "value" : "<system locale>", "id" : "id1168-id1217" }, "id626" : { "name" : "comment", "params" : "\\@text", "id" : "id626", "intro" : "Translator added comments.\nSee addComment().
\n", "type" : "option" }, "id845" : { "name" : "__", "examples" : [ "id846" ], "call" : "__( $msgid )", "id" : "id845", "intro" : "This function (name is two under-score characters) will cause the $msgid\nto be replaced by the translations when doing the actual output. Returned\nis a Log::Report::Message object, which will be used in translation\nlater. Translating is invoked when the object gets stringified. When\nyou have no translation tables, the $msgid will be shown untranslated.
\n\nIf you need options for Log::Report::Message::new() then use __x();\nthe prototype of this function does not permit parameters: it is a\nprefix operator!
\n", "type" : "function" }, "id1206-id780" : { "extends" : "id1206", "name" : "max_params", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(max_params)
", "type" : "option", "id" : "id1206-id780", "params" : "INTEGER" }, "id124" : { "intro" : "WARNING-FAULT # == WARNING,MISTAKE,ERROR,FAULT\n WARNING,INFO # == WARNING,INFO\n -INFO # == TRACE-INFO\n ALERT- # == ALERT,FAILURE,PANIC\n USER # == MISTAKE,ERROR\n ALL # == TRACE-PANIC\n FATAL # == ERROR,FAULT,FAILURE,PANIC [1.07]\n NONE # ==\n\n", "id" : "id124", "type" : "example", "name" : "of expanded REASONS\n" }, "id326" : { "call" : "$obj->domain( $name )", "intro" : "
Returns the textdomain with the specified $name.
\n", "type" : "i_method", "id" : "id326", "name" : "domain" }, "id593" : { "name" : "rules", "id" : "id593", "intro" : "Returns a HASH to the simplified context maps.
\n", "type" : "i_method", "call" : "$obj->rules" }, "id233" : { "intro" : "Deprecated. See bootstrapColor().
\n", "type" : "i_method", "id" : "id233", "call" : "$obj->bootstrap_color", "name" : "bootstrap_color" }, "id205" : { "id" : "id205", "type" : "function", "call" : "__n( $msgid, $plural_msgid, $count, PAIRS )", "name" : "__n" }, "id1189-id780" : { "name" : "addSkipStack", "extends" : "id1189", "intro" : "Inherited, see Log::Report::Dispatcher::addSkipStack()
", "type" : "ci_method", "id" : "id1189-id780", "call" : "$any->addSkipStack( @CODE )" }, "id1181-id1021" : { "extends" : "id1181", "name" : "mode", "type" : "i_method", "intro" : "Inherited, see Log::Report::Dispatcher::mode()
", "id" : "id1181-id1021", "call" : "$obj->mode" }, "id1131" : { "id" : "id1131", "type" : "i_method", "call" : "$obj->translator", "name" : "translator" }, "id440" : { "id" : "id440", "type" : "info", "name" : "read table $file as $class for $dname in $locale.", "subroutine" : "id438" }, "id1183-id1217" : { "extends" : "id1183", "name" : "needs", "intro" : "Inherited, see Log::Report::Dispatcher::needs()
", "type" : "i_method", "id" : "id1183-id1217", "call" : "$obj->needs( [$reason] )" }, "id783" : { "path" : "DESCRIPTION", "intro" : "This dispatchers produces output tot syslog, based on the Sys::Log4perl\nmodule (which will not be automatically installed for you).
Convert the messages in the specified character-set (codeset). By\ndefault, no conversion will take place, because the right choice cannot\nbe determined automatically.
\n", "type" : "option", "name" : "charset" }, "id628" : { "type" : "option", "intro" : "The string is not yet translated, some smart guesses may have been made.\nSee fuzzy().
\n", "id" : "id628", "params" : "BOOLEAN", "name" : "fuzzy" }, "id1182-id760" : { "id" : "id1182-id760", "intro" : "Inherited, see Log::Report::Dispatcher::isDisabled()
", "type" : "i_method", "call" : "$obj->isDisabled", "name" : "isDisabled", "extends" : "id1182" }, "id754" : { "type" : "error", "id" : "id754", "subroutine" : "id753", "name" : "invalid plural-form algorithm '$alg'." }, "id328" : { "id" : "id328", "type" : "option", "params" : "CHARSET", "name" : "charset" }, "id1169-id780" : { "extends" : "id1169", "name" : "mode", "id" : "id1169-id780", "intro" : "Inherited, see Log::Report::Dispatcher::new(mode)
", "type" : "option", "params" : "'NORMAL'|'VERBOSE'|'ASSERT'|'DEBUG'|0..3" }, "id180" : { "call" : "report( [\\%options], $reason, $message|<STRING,$params> )", "diagnostics" : [ "id185", "id186" ], "options" : [ [ "id181", "id182" ], [ "id183", "id184" ] ], "type" : "function", "id" : "id180", "name" : "report", "intro" : "Be warned that %options is a HASH here.
\n" }, "id1054" : { "name" : "tag", "params" : "$tag|REGEX", "intro" : "[1.44] Only return the exception if it was fatal, and in the same time in\nthe specified $tag (as string) or matches the REGEX.\nSee Log::Report::Message::taggedWith()
\n", "id" : "id1054", "type" : "option" }, "id1256" : { "name" : "toHTML", "intro" : "[1.11] Calls toString() and then escapes HTML volatile characters.
\n", "id" : "id1256", "type" : "i_method", "call" : "$obj->toHTML( [$locale] )" }, "id573" : { "subroutine" : "id567", "name" : "header not found for charset in $fn.", "id" : "id573", "type" : "error" }, "id1334" : { "path" : "INHERITANCE", "intro" : "Log::Report::Optional\n is an Exporter\n\n", "id" : "id1334", "type" : "chapter", "name" : "INHERITANCE", "level" : 1 }, "id259" : { "name" : "Error handler based on URL (e.g. API)\n", "id" : "id259", "intro" : "
fatal_handler sub {\n my ($dsl, $msg, $reason) = @_;\n return if $dsl->app->request->uri !~ m!^/api/!;\n status $reason eq 'PANIC' ? 'Internal Server Error' : 'Bad Request';\n $dsl->send_as(JSON => {\n error => 1,\n error_description => $msg->toString,\n }, {\n content_type => 'application/json; charset=UTF-8',\n });\n };\n\n",
"type" : "example"
},
"id69" : {
"name" : "setting defaults\n",
"type" : "example",
"intro" : " $sp->setDefaults(EL => {width => 30}, CHOP => {width => 10});\n\n my %defs = (EL => {width => 30}, CHOP => {width => 10});\n $sp->setDefaults(\\%defs);\n\n",
"id" : "id69"
},
"id865" : {
"id" : "id865",
"type" : "function",
"call" : "__npx( $msgctxt, $msgid, $plural, count, PAIRS )",
"name" : "__npx"
},
"id508" : {
"id" : "id508",
"type" : "info",
"name" : "no Perl in file $filename.",
"subroutine" : "id504"
},
"id1051" : {
"call" : "$obj->failed",
"id" : "id1051",
"intro" : "Returns true if the block was left with an fatal message.
Log::Report::Dispatcher::Callback\n is a Log::Report::Dispatcher\n\n", "type" : "chapter", "id" : "id1331", "name" : "INHERITANCE", "level" : 1 }, "id213" : { "name" : "syntax flag must be either SHORT or REPORT, not `$flag'", "subroutine" : "id212", "id" : "id213", "type" : "error" }, "id963-id221" : { "name" : "_tag", "intro" : "
Inherited, see Log::Report::Message::new(_tag)
", "extends" : "id963", "id" : "id963-id221", "type" : "default", "value" : "[]" }, "id534-id493" : { "extends" : "id534", "name" : "cleanup", "call" : "$obj->cleanup( %options )", "id" : "id534-id493", "intro" : "Inherited, see Log::Report::Extract::cleanup()
", "type" : "i_method", "options" : [ [ "id535-id493", "id536-id493" ] ] }, "id460" : { "level" : 2, "name" : "Example", "intro" : "My module is named Some::Module and installed in some of perl's\ndirectories, say ~perl5. The module is defining textdomain\nmy-domain. The translation is made into nl-NL.utf-8 (locale for\nDutch spoken in The Netherlands, utf-8 encoded text file).
The translation table is taken from the first existing of these files:
\n nl-NL.utf-8/LC_MESSAGES/my-domain.po\n nl-NL.utf-8/LC_MESSAGES/my-domain.po\n nl-NL.utf8/LC_MESSAGES/my-domain.po\n nl-NL/LC_MESSAGES/my-domain.po\n nl/LC_MESSAGES/my-domain.po\n\n\n
Then, attempts are made which are not compatible with gettext. The\nadvantage is that the directory structure is much simpler. The idea\nis that each domain has its own locale installation directory, instead\nof everything merged in one place, what gettext presumes.
\n\nIn order of attempts:
\n nl-NL.utf-8/my-domain.po\n nl-NL.utf8/my-domain.po\n nl-NL/my-domain.po\n nl/my-domain.po\n my-domain/nl-NL.utf8.po\n my-domain/nl-NL.po\n my-domain/nl.po\n\n\n
Filenames may get mutulated by the platform (which we will try to hide\nfrom you [please help improve this]), and are treated case-INsensitive!
\n", "type" : "section", "id" : "id460", "path" : "DETAILS/Example" }, "id1188-id1217" : { "call" : "$any->collectStack( [$maxdepth] )", "id" : "id1188-id1217", "intro" : "Inherited, see Log::Report::Dispatcher::collectStack()
", "type" : "ci_method", "name" : "collectStack", "extends" : "id1188" }, "id1178" : { "path" : "METHODS/Attributes", "subroutines" : [ "id1180", "id1179", "id1183", "id1181", "id1182" ], "type" : "section", "id" : "id1178", "name" : "Attributes", "level" : 2 }, "id280" : { "path" : "DETAILS/Setup and Configuration/Dancer2::Plugin::LogReport", "intro" : "To use the plugin, you simply use it in your application:
\n\n package MyApp;\n use Log::Report (); # use early and minimal once\n use Dancer2;\n use Dancer2::Plugin::LogReport %config;\n\n\n
Dancer2::Plugin::LogReport takes the same %config options as\nLog::Report itself (see Log::Report::import()).
If you want to send messages from your modules/models, there is\nno need to use this specific plugin. Instead, you should simply\nuse Log::Report to negate the need of loading all the Dancer2\nspecific code.
Returns whether this exception has a severity which makes it fatal\nwhen thrown. [1.34] This can have been overruled with the is_fatal\nattribute. See Log::Report::Util::is_fatal().
A good choice is to use Perl's distribution name for the domain name. For instance,\nthe domain name for this module would be set this way:
\n\n use Log::Report 'log-report-optional';\n use Log::Report 'log-report-opt';\n\n", "type" : "example", "name" : "textdomain name choice\n" }, "id64" : { "type" : "example", "intro" : "
my $f = String::Print->new(\n modifiers => [ EUR => sub {sprintf \"%5.2f e\", $_[0]} ],\n serializers => [ UNDEF => sub {'-'} ],\n encode_for => 'HTML',\n );\n\n $f->printi(\"price: {p EUR}\", p => 3.1415); # price: ␣␣3.14 e\n $f->printi(\"count: {c}\", c => undef); # count: -\n\n",
"id" : "id64"
},
"id730" : {
"id" : "id730",
"intro" : "This module is the main extry point for the distribution, but has\ncurrently no further use. This distribution contains all components\nof Log::Report which handle translations.
\n\nIf you do not need translations, you do not need to install this module.\nWhen you use Log::Report and need to add translations, it may be\nvery little work: when you nicely wrote texts in the advised message\nformat like
\n\n print __x\"Greetings to you, {name}\", name => $name;\n fault __x\"cannot open file {filename}\", filename => $fn;\n\n\nthen all is in perfect condition to introduce translations: it requires\nvery little to no additions to the existing code!
\n\nIn this distribution:
\n\nShort for report MISTAKE => $message
Inherited, see Log::Report::Extract::store()
", "id" : "id541-id493" }, "id1087" : { "level" : 2, "name" : "Attributes", "type" : "section", "id" : "id1087", "path" : "METHODS/Attributes" }, "id563" : { "level" : 1, "name" : "SYNOPSIS", "type" : "chapter", "intro" : " # using a PO table efficiently\n my $pot = Log::Report::Lexicon::POTcompact->read('po/nl.po')\n or die;\n\n my $header = $pot->msgid('');\n print $pot->msgstr('msgid', 3);\n\n",
"id" : "id563",
"path" : "SYNOPSIS"
},
"id816" : {
"name" : "locale",
"params" : "$locale",
"id" : "id816",
"intro" : "Use this specific $locale, in stead of the user's preference.
\n", "type" : "option" }, "id875" : { "name" : "message_class", "id" : "id875", "value" : "Log::Report::Message",
"type" : "default"
},
"id113" : {
"id" : "id113",
"intro" : "There are a quite a number of modules on CPAN which extend the functionality\nof printf(). To name a few:\nString::Format,\nString::Errf,\nString::Formatter,\nText::Sprintf::Named,\nAcme::StringFormat,\nText::sprintf,\nLog::Sprintf, and\nString::Sprintf.\nThey are all slightly different.
When the String::Print module was created, none of the modules\nmentioned above handled unicode correctly. Global configuration\nof serializers and modifiers is also usually not possible, sometimes\nprovided per explicit function call. Only String::Print cleanly\nseparates the roles of serializers, modifiers, and conversions.
String::Print is nicely integrated with Log::Report.
Inherited, see Log::Report::Extract::new(charset)
", "extends" : "id523", "id" : "id523-id493", "type" : "default", "value" : "'utf-8'" }, "id1323" : { "name" : "Addition information", "level" : 3, "path" : "DETAILS/Processing the message/Addition information", "type" : "subsection", "id" : "id1323" }, "id1128" : { "intro" : "Create a new Domain object.
\n", "type" : "c_method", "id" : "id1128", "options" : [ [ "id157-id1122", "id158-id1122" ] ], "call" : "$class->new( %options )", "name" : "new" }, "id1008" : { "type" : "default", "value" : "undef",
"id" : "id1008",
"name" : "serializer"
},
"id956" : {
"id" : "id956",
"intro" : "The category when the real gettext library is used, for instance\nLC_MESSAGES.
\n", "type" : "option", "params" : "INTEGER", "name" : "_category" }, "id1185-id760" : { "extends" : "id1185", "name" : "close", "call" : "$obj->close", "intro" : "Inherited, see Log::Report::Dispatcher::close()
", "type" : "i_method", "id" : "id1185-id760" }, "id470" : { "id" : "id470", "type" : "error", "subroutine" : "id467", "name" : "unsupported explicit charset $charset for $fn." }, "id1241" : { "path" : "METHODS/Attributes", "type" : "section", "id" : "id1241", "subroutines" : [ "id1243", "id1244", "id1246", "id1242" ], "name" : "Attributes", "level" : 2 }, "id973-id221" : { "name" : "_join", "intro" : "Inherited, see Log::Report::Message::new(_join)
", "extends" : "id973", "type" : "default", "value" : "$\" $LIST_SEPARATOR",
"id" : "id973-id221"
},
"id261" : {
"subroutine" : "id258",
"name" : "An unexpected error has occurred",
"type" : "error",
"id" : "id261"
},
"id1036" : {
"value" : "'NONE'",
"id" : "id1036",
"type" : "default",
"name" : "hide"
},
"id1234" : {
"call" : "$class->new( %options )",
"options" : [
[
"id1239",
"id1240"
],
[
"id1237",
"id1238"
],
[
"id1235",
"id1236"
]
],
"type" : "c_method",
"intro" : "Create a new exception object, which is basically a message which\nwas produced for a reason.
\n", "id" : "id1234", "name" : "new" }, "id1356" : { "name" : "INHERITANCE", "level" : 1, "path" : "INHERITANCE", "intro" : "Log::Report::Translator::Gettext\n is a Log::Report::Translator\n\n", "id" : "id1356", "type" : "chapter" }, "id1070" : { "intro" : "
sub send_mail($$$)\n { my ($disp, $options, $reason, $message) = @_;\n my $msg = Mail::Send->new(Subject => $reason, To => 'admin@localhost');\n my $fh = $msg->open('sendmail');\n print $fh $disp->translate($reason, $message);\n close $fh;\n }\n\n dispatcher CALLBACK => 'mail', callback => \\&send_mail;\n\n",
"id" : "id1070",
"type" : "example"
},
"id1174-id760" : {
"name" : "charset",
"intro" : "Inherited, see Log::Report::Dispatcher::new(charset)
", "extends" : "id1174", "value" : "undef",
"id" : "id1174-id760",
"type" : "default"
},
"id1117" : {
"call" : "$obj->close",
"intro" : "Only when initiated with a FILENAME, the file will be closed. In any\nother case, nothing will be done.
\n", "id" : "id1117", "type" : "i_method", "name" : "close" }, "id84" : { "name" : "_append", "type" : "default", "value" : "undef",
"id" : "id84"
},
"id564" : {
"level" : 1,
"name" : "DESCRIPTION",
"intro" : "This module is translating, based on PO files. PO files are used to store\ntranslations in humanly readable format for most of existing translation\nframeworks, like GNU gettext and Perl's Maketext.
\n\nInternally, this module tries to be as efficient as possible: high\nspeed and low memory foot-print. You will not be able to sub-class\nthis class cleanly.
\n\nIf you like to change the content of PO files, then use\nLog::Report::Lexicon::POT.
\n", "id" : "id564", "type" : "chapter", "path" : "DESCRIPTION" }, "id338" : { "name" : "Template (Toolkit) base-class", "level" : 2, "path" : "METHODS/Template (Toolkit) base-class", "intro" : "The details of the following functions can be found in the Template\nmanual page. They are included here for reference only.
\n", "id" : "id338", "type" : "section", "subroutines" : [ "id339", "id340" ] }, "id171" : { "name" : "Translating", "level" : 2, "path" : "METHODS/Translating", "subroutines" : [ "id172" ], "type" : "section", "id" : "id171" }, "id638" : { "name" : "msgid", "id" : "id638", "intro" : "Returns the actual msgid, which cannot be undef.
Returns the directory name.
\n", "type" : "i_method", "id" : "id449" }, "id675" : { "options" : [ [ "id676", "id677" ], [ "id690", "id691" ], [ "id692", "id693" ], [ "id688", "id689" ], [ "id682", "id683" ], [ "id684", "id685" ], [ "id686", "id687" ], [ "id678", "id679" ], [ "id680", "id681" ] ], "id" : "id675", "type" : "c_method", "diagnostics" : [ "id694" ], "call" : "$class->new( %options )", "name" : "new", "intro" : "Create a new POT file. The initial header is generated for you, but\nit can be changed using the header() method.
\n" }, "id616" : { "path" : "METHODS/Constructors", "subroutines" : [ "id617" ], "type" : "section", "id" : "id616", "name" : "Constructors", "level" : 2 }, "id962" : { "params" : "$tags|\\@tags", "intro" : "When messages are used for exception based programming, you add a\n_tag parameter to the argument list. Later, with for instance\nLog::Report::Dispatcher::Try::wasFatal(tag), you can check the\ncategory (group, class) of the exception.
\n\nThe $tags is interpreted as comma- and/or blank separated list of class\ntokens (barewords), the ARRAY lists all tags separately. See tags().
\n", "type" : "option", "id" : "id962", "name" : "_tag" }, "id524-id493" : { "subroutine" : "id519", "name" : "extractions require an explicit lexicon directory.", "extends" : "id524", "intro" : "Inherited, see Log::Report::Extract::new()
", "type" : "error", "id" : "id524-id493" }, "id375" : { "id" : "id375", "type" : "info", "name" : "processing file $file in $charset.", "subroutine" : "id370" }, "id316" : { "id" : "id316", "type" : "error", "name" : "illegal value '$value' for 'processing_errors' option.", "subroutine" : "id305" }, "id988" : { "call" : "$obj->context", "type" : "i_method", "intro" : "Returns an HASH if there is a context defined for this message.
\n", "id" : "id988", "name" : "context" }, "id977" : { "name" : "_context", "type" : "default", "value" : "undef",
"id" : "id977"
},
"id1231" : {
"call" : "overload bool; boolean condition",
"intro" : "Always returns true: the exception object exists.
Inherited, see Log::Report::Message::new(_lang)
", "id" : "id974-id221", "params" : "ISO", "extends" : "id974", "name" : "_lang" }, "id1165-id780" : { "name" : "accept", "extends" : "id1165", "params" : "$reasons|\\@reasons", "intro" : "Inherited, see Log::Report::Dispatcher::new(accept)
", "id" : "id1165-id780", "type" : "option" }, "id1171-id760" : { "type" : "option", "intro" : "Inherited, see Log::Report::Dispatcher::new(format_reason)
", "id" : "id1171-id760", "params" : "'UPPERCASE'|'LOWERCASE'|'UCFIRST'|'IGNORE'|CODE", "extends" : "id1171", "name" : "format_reason" }, "id1273" : { "subroutines" : [ "id940-id221", "id942-id221", "id941-id221" ], "type" : "chapter", "id" : "id1273", "path" : "OVERLOADED", "level" : 1, "name" : "OVERLOADED" }, "id828" : { "id" : "id828", "type" : "error", "name" : "the 'needs' sub-command parameter '$need' is not a reason.", "subroutine" : "id825" }, "id753" : { "type" : "i_method", "id" : "id753", "diagnostics" : [ "id754" ], "call" : "$obj->setupPluralAlgorithm", "name" : "setupPluralAlgorithm", "intro" : "This method needs to be called after setting (reading or creating) a new\ntable header, to interpret the plural algorithm as specified in the\nPlural-Forms header field. [1.09] The header field is not required\nwhen not used.
A full list of plural forms per language can be found at\nhttps://docs.translatehouse.org/projects/localization-guide/en/latest/l10n/pluralforms.html
\n" }, "id271" : { "name" : "alert", "call" : "$obj->alert", "id" : "id271", "type" : "i_method" }, "id1206-id760" : { "type" : "option", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(max_params)
", "id" : "id1206-id760", "params" : "INTEGER", "extends" : "id1206", "name" : "max_params" }, "id1020" : { "name" : "Avoiding repetative translations", "level" : 3, "path" : "DETAILS/Automatic parameters/Avoiding repetative translations", "type" : "subsection", "intro" : "This way of translating is somewhat expensive, because an object to\nhandle the Log::Report::__x() is created each time.
\n for my $i (1..100_000)\n { print __x \"Hello World {i}\\n\", i => $i;\n }\n\n\nThe suggestion that Locale::TextDomain makes to improve performance,\nis to get the translation outside the loop, which only works without\ninterpolation:
\n\n use Locale::TextDomain;\n my $i = 42;\n my $s = __x(\"Hello World {i}\\n\", i => $i);\n foreach $i (1..100_000)\n { print $s;\n }\n\n\nOops, not what you mean because the first value of $i is captured\nin the initial message object. With Log::Report, you can do it (except\nwhen you use contexts)
\n use Log::Report;\n my $i;\n my $s = __x(\"Hello World {i}\\n\", i => \\$i);\n foreach $i (1..100_000)\n { print $s;\n }\n\n\nMind you not to write: for my $i in above case!!!!
You can also write an incomplete translation:
\n\n use Log::Report;\n my $s = __x \"Hello World {i}\\n\";\n foreach my $i (1..100_000)\n { print $s->(i => $i);\n }\n\n\nIn either case, the translation will be looked-up only once.
\n", "id" : "id1020" }, "id720" : { "name" : "the only acceptable parameter is 'ACTIVE', not '$p'.", "subroutine" : "id719", "type" : "error", "id" : "id720" }, "id168-id385" : { "name" : "formatter", "extends" : "id168", "params" : "CODE|\\%config|'PRINTI'", "id" : "id168-id385", "intro" : "Inherited, see Log::Report::Minimal::Domain::configure(formatter)
", "type" : "option" }, "id1100" : { "name" : "replace", "params" : "BOOLEAN", "intro" : "Only used in combination with a to filename: throw away the old file\nif it exists. Probably you wish to append to existing information.
\n\nUse the locale setting by default, which is LC_CTYPE or LC_ALL or LANG\n(in that order). If these contain a character-set which Perl understands,\nthen that is used, otherwise silently ignored.
\n", "type" : "option", "id" : "id1100" }, "id1344" : { "level" : 1, "name" : "INHERITANCE", "intro" : "Log::Report::Dispatcher::Perl\n is a Log::Report::Dispatcher\n\n", "id" : "id1344", "type" : "chapter", "path" : "INHERITANCE" }, "id161" : { "name" : "Attributes", "level" : 2, "path" : "METHODS/Attributes", "subroutines" : [ "id162", "id165", "id164", "id163" ], "type" : "section", "id" : "id161" }, "id1189-id760" : { "call" : "$any->addSkipStack( @CODE )", "intro" : "
Inherited, see Log::Report::Dispatcher::addSkipStack()
", "type" : "ci_method", "id" : "id1189-id760", "name" : "addSkipStack", "extends" : "id1189" }, "id1093" : { "level" : 1, "name" : "SYNOPSIS", "type" : "chapter", "intro" : " dispatcher Log::Report::Dispatcher::File => 'stderr',\n to => \\*STDERR, accept => 'NOTICE-';\n\n # close a dispatcher\n dispatcher close => 'stderr';\n\n # let dispatcher open and close the file\n dispatcher FILE => 'mylog', to => '/var/log/mylog', charset => 'utf-8';\n ...\n dispatcher close => 'mylog'; # will close file\n\n # open yourself, then also close yourself\n open OUT, \">:encoding('iso-8859-1')\", '/var/log/mylog'\n or fault \"...\";\n dispatcher FILE => 'mylog', to => \\*OUT;\n ...\n dispatcher close => 'mylog';\n close OUT;\n\n # dispatch into a scalar\n my $output = '';\n open $outfile, '>', \\$output;\n dispatcher FILE => 'into-scalar', to => \\$outfile;\n ...\n dispatcher close => 'into-scalar';\n print $output;\n\n",
"id" : "id1093",
"path" : "SYNOPSIS"
},
"id574" : {
"type" : "error",
"id" : "id574",
"name" : "cannot detect charset in $fn.",
"subroutine" : "id567"
},
"id972" : {
"name" : "_join",
"intro" : "Which $separator string to be used then an ARRAY is being filled-in.
\n", "id" : "id972", "type" : "option", "params" : "$separator" }, "id89" : { "path" : "DETAILS", "intro" : "Your manual-page reader may not support the unicode used\n in some of the examples below.\n\n", "name" : "DETAILS", "level" : 1, "type" : "chapter", "id" : "id89", "nest" : [ "id90", "id91", "id92", "id95", "id96", "id110", "id113" ] }, "id1341" : { "type" : "chapter", "intro" : "
Log::Report::Template\n is a Template\n\n", "id" : "id1341", "path" : "INHERITANCE", "level" : 1, "name" : "INHERITANCE" }, "id665" : { "value" : "
undef",
"id" : "id665",
"type" : "default",
"name" : "nr_plurals"
},
"id1196-id760" : {
"intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(filename)
", "id" : "id1196-id760", "type" : "option", "params" : "STRING", "extends" : "id1196", "name" : "filename" }, "id967" : { "value" : "undef",
"type" : "default",
"id" : "id967",
"name" : "_classes"
},
"id511" : {
"name" : "string is incorrect at line $line: $error",
"subroutine" : "id504",
"id" : "id511",
"type" : "error"
},
"id499" : {
"path" : "DESCRIPTION/The extraction process/What is not extracted?",
"id" : "id499",
"intro" : "Not extracted are the usage of anything above, where the first\nparameter is not a simple string. Not extracted are
\n\n __x($format, @more)\n __x$format, @more\n __x(+$format, _domain => 'other domain', @more)\n __x($first.$second, @more)\n\n\n
In these cases, you have to use N__() functions to declare the possible\nvalues of $format.
Returns a list with all defined Log::Report::Lexicon::PO objects. When\nthe string $active is given as parameter, only objects which have\nreferences are returned.
\n" }, "id1180-id905" : { "extends" : "id1180", "name" : "type", "intro" : "Inherited, see Log::Report::Dispatcher::type()
", "type" : "i_method", "id" : "id1180-id905", "call" : "$obj->type" }, "id1223" : { "name" : "Attributes", "level" : 2, "path" : "METHODS/Attributes", "subroutines" : [ "id1180-id1217", "id1179-id1217", "id1183-id1217", "id1181-id1217", "id1182-id1217" ], "type" : "section", "id" : "id1223" }, "id964-id221" : { "params" : "$tags|\\@tags", "intro" : "Inherited, see Log::Report::Message::new(_tags)
", "type" : "option", "id" : "id964-id221", "name" : "_tags", "extends" : "id964" }, "id481" : { "subroutine" : "id467", "name" : "cannot seek to $loc in $fn for transl strings: $!", "id" : "id481", "type" : "fault" }, "id1144" : { "name" : "readConfig", "intro" : "Helper method, which simply parses the content $filename into a HASH to be\nused as parameters to configure(). The filename must end on '.pl',\nto indicate that it uses perl syntax (can be processed with Perl's do\ncommand) or end on '.json'. See also chapter Configuring below.
Currently, this file can be in Perl native format (when ending on .pl)\nor JSON (when it ends with .json). Various modules may explain parts\nof what can be found in these files, for instance\nLog::Report::Translator::Context.
Where sprinti() uses named parameters --especially useful when the\nstrings need translation-- this function stays close to the standard\nsprintf(). All features of POSIX formats are supported. This\nshould say enough: you can use %3$0#5.*d, if you like.
It may be useful to know that the positional $format is rewritten and\nthen fed into sprinti(). Be careful with the length of the @positionals:\nsuperfluous parameter %options are passed along to sprinti(), and\nshould only contain \"specials\": parameter names which start with '_'.
[1.45] Add zero or more tags to this message.
\n", "id" : "id992", "type" : "i_method", "call" : "$obj->addTags( @tags )" }, "id1098" : { "intro" : "You can either specify a $file by name, which is opened in append mode with\nautoflush on. Or pass any kind of file handle $fh, or some OBJECT which\nimplements a print() method. You probably want to have autoflush\nenabled on your file-handles.
When cleaning-up the dispatcher, the file will only be closed in case\nof a named $file.
\n\n[1.10] When you pass a CODE, then for each log message the function is\ncalled with two arguments: this dispatcher object and the message object.\nIn some way (maybe via the message context) you have to determine the\nlog filename. This means that probably many log-files are open at the\nsame time.
\n\n # configuration time\n dispatcher FILE => 'logfile', to =>\n sub { my ($disp, $msg) = @_; $msg->context->{logfile} };\n\n # whenever you want to change the logfile\n textdomain->updateContext(logfile => '/var/log/app');\n (textdomain 'mydomain')->setContext(logfile => '/var/log/app');\n\n # or\n error __x\"help\", _context => {logfile => '/dev/tty'};\n error __x\"help\", _context => \"logfile=/dev/tty\";\n\n",
"type" : "option",
"id" : "id1098",
"params" : "$file|$fh|OBJECT|CODE",
"name" : "to"
},
"id141" : {
"subroutine" : "id140",
"name" : "unknown locale language in locale '$locale'.",
"id" : "id141",
"type" : "error"
},
"id163-id1122" : {
"intro" : "Inherited, see Log::Report::Minimal::Domain::isConfigured()
", "type" : "i_method", "id" : "id163-id1122", "call" : "$obj->isConfigured", "extends" : "id163", "name" : "isConfigured" }, "id521-id354" : { "name" : "lexicon", "intro" : "Inherited, see Log::Report::Extract::new(lexicon)
", "extends" : "id521", "type" : "default", "id" : "id521-id354", "value" : "<required>" }, "id479" : { "subroutine" : "id467", "name" : "cannot seek to $loc in $fn for msgid strings: $!", "type" : "fault", "id" : "id479" }, "id826" : { "name" : "play with dispatchers\n", "type" : "example", "intro" : "dispatcher Log::Dispatcher::File => mylog =>,\n accept => 'MISTAKE-', # for wrapper\n locale => 'pt_BR', # other language\n filename => 'logfile'; # for back-end\n\n dispatcher close => 'mylog'; # cleanup\n my $obj = dispatcher find => 'mylog';\n my @obj = dispatcher 'list';\n dispatcher disable => 'syslog';\n dispatcher enable => 'mylog', 'syslog'; # more at a time\n dispatcher mode => 'DEBUG', 'mylog';\n dispatcher mode => 'DEBUG', 'ALL';\n my $catcher = dispatcher 'active-try';\n dispatcher 'do-not-reopen';\n\n my @need_info = dispatcher needs => 'INFO';\n if(dispatcher needs => 'INFO') ... # anyone needs INFO\n\n # Getopt::Long integration: see Log::Report::Dispatcher::mode()\n dispatcher PERL => 'default', mode => 'DEBUG', accept => 'ALL'\n if $debug;\n\n", "id" : "id826" }, "id645" : { "call" : "$obj->addAutomatic( @lines|\\@lines|$text )", "type" : "i_method", "intro" : "
Add multiple lines to the translator's comment block. Returns an\nempty string if there are no comments.
\n", "id" : "id645", "name" : "addAutomatic" }, "id289" : { "title" : "reroute Dancer2 logs into Log::Report", "inheritance" : { "extends" : [ "Moo::Object" ] }, "id" : "id289", "distribution" : "Dancer2-Plugin-LogReport", "package" : "Dancer2::Logger::LogReport", "is_pure_pod" : false, "version" : "2.03", "name" : "Dancer2::Logger::LogReport", "chapters" : [ "id290", "id1351", "id291", "id292", "id294" ] }, "id594" : { "path" : "METHODS/Action", "type" : "section", "id" : "id594", "subroutines" : [ "id599", "id601", "id595" ], "name" : "Action", "level" : 2 }, "id234" : { "id" : "id234", "intro" : "[2.03] Log messages are/can be stored in the Session object. The Session\nobject may be cached in a file, in various formats. To be able to save\nand restore these message objects from this session serialization, we\nneed to freeze and thaw the object at the right moment. This happens\ntransparently.
\n\nFor session serialization in the database, put this in your\nconfiguration:
\n\n engines:\n session:\n DBIC:\n serializer: JSON\n serialize_options:\n allow_tags: 1\n deserialize_options:\n allow_tags: 1\n\n", "type" : "section", "subroutines" : [ "id236", "id235" ], "path" : "METHODS/Serialization", "level" : 2, "name" : "Serialization" }, "id1182-id780" : { "name" : "isDisabled", "extends" : "id1182", "intro" : "
Inherited, see Log::Report::Dispatcher::isDisabled()
", "id" : "id1182-id780", "type" : "i_method", "call" : "$obj->isDisabled" }, "id123" : { "name" : "expand_reasons", "intro" : "Returns a sub-set of all existing message reason labels, based on the\ncontent reason patterns. Either use a comma separated list of patterns\nin string $reasons, or an ARRAY of patterns.
\n\nThe following rules apply for the patterns:
\n\n REASONS = BLOCK [ ',' BLOCKS ] | ARRAY-of-REASON\n BLOCK = '-' TO | FROM '-' TO | ONE | SOURCE\n FROM,TO,ONE = 'TRACE' | 'ASSERT' | ,,, | 'PANIC'\n SOURCE = 'USER' | 'PROGRAM' | 'SYSTEM' | 'FATAL' | 'ALL' | 'NONE'\n\n\n
The SOURCE specification group all reasons which are usually related to\nthe problem: report about problems caused by the user, reported by\nthe program, or with system interaction.
\n", "examples" : [ "id124" ], "diagnostics" : [ "id125", "id126", "id127" ], "call" : "expand_reasons( $reasons|\\@reasons )", "type" : "function", "id" : "id123" }, "id345" : { "nest" : [ "id346", "id347", "id348" ], "id" : "id345", "type" : "section", "level" : 2, "name" : "Supported syntax", "path" : "DETAILS/Supported syntax" }, "id166-id385" : { "name" : "where", "extends" : "id166", "params" : "ARRAY", "type" : "option", "intro" : "Inherited, see Log::Report::Minimal::Domain::configure(where)
", "id" : "id166-id385" }, "id150" : { "distribution" : "Log-Report-Optional", "package" : "Log::Report::Minimal::Domain", "is_pure_pod" : false, "title" : "administer one text-domain", "id" : "id150", "inheritance" : { "extended_by" : [ "Log::Report::Domain" ] }, "chapters" : [ "id151", "id1346", "id152", "id153", "id154" ], "name" : "Log::Report::Minimal::Domain", "version" : "1.08" }, "id947" : { "name" : "_expand", "type" : "default", "value" : "false",
"id" : "id947"
},
"id739" : {
"nest" : [
"id740",
"id742",
"id743"
],
"id" : "id739",
"type" : "chapter",
"level" : 1,
"name" : "METHODS",
"path" : "METHODS"
},
"id784" : {
"name" : "Reasons <--> Levels",
"level" : 2,
"path" : "DESCRIPTION/Reasons <--> Levels",
"type" : "section",
"intro" : "The REASONs for a message in Log::Report are names quite similar to\nthe log levels used by Log::Log4perl. The default mapping is list\nbelow. You can change the mapping using new(to_level).
\n\n TRACE => $DEBUG ERROR => $ERROR\n ASSERT => $DEBUG FAULT => $ERROR\n INFO => $INFO ALERT => $FATAL\n NOTICE => $INFO FAILURE => $FATAL\n WARNING => $WARN PANIC => $FATAL\n MISTAKE => $WARN\n\n", "id" : "id784" }, "id1228" : { "intro" : "
In Log::Report, exceptions are not as extended as available in\nlanguages as Java: you do not create classes for them. The only\nthing an exception object does, is capture some information about\nan (untranslated) report.
\n", "id" : "id1228", "type" : "chapter", "path" : "DESCRIPTION", "level" : 1, "name" : "DESCRIPTION" }, "id291" : { "level" : 1, "name" : "SYNOPSIS", "intro" : "# This module is loaded when configured. It does not provide\n # end-user functions or methods.\n\n # See DETAILS\n\n", "id" : "id291", "type" : "chapter", "path" : "SYNOPSIS" }, "id531" : { "type" : "i_method", "id" : "id531", "call" : "$obj->addPot( $domain, $pot, %options )", "name" : "addPot" }, "id752-id561" : { "extends" : "id752", "name" : "there is no Plural-Forms field in the header, but needed.", "subroutine" : "id751", "intro" : "
Inherited, see Log::Report::Lexicon::Table::pluralIndex()
", "type" : "error", "id" : "id752-id561" }, "id1169-id760" : { "params" : "'NORMAL'|'VERBOSE'|'ASSERT'|'DEBUG'|0..3", "id" : "id1169-id760", "intro" : "Inherited, see Log::Report::Dispatcher::new(mode)
", "type" : "option", "name" : "mode", "extends" : "id1169" }, "id1141" : { "type" : "default", "value" : "undef",
"id" : "id1141",
"name" : "config"
},
"id994-id221" : {
"intro" : "Inherited, see Log::Report::Message::errno()
", "type" : "i_method", "id" : "id994-id221", "call" : "$obj->errno( [$errno] )", "name" : "errno", "extends" : "id994" }, "id1201-id1091" : { "value" : "<required>", "type" : "default", "id" : "id1201-id1091", "extends" : "id1201", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(call)
", "name" : "call" }, "id618" : { "id" : "id618", "type" : "option", "params" : "$msgid", "name" : "msgid" }, "id241" : { "nest" : [ "id242", "id243", "id245" ], "id" : "id241", "type" : "chapter", "level" : 1, "name" : "METHODS", "path" : "METHODS" }, "id801" : { "is_pure_pod" : false, "distribution" : "Log-Report", "package" : "Log::Report", "inheritance" : { "extends" : [ "Exporter" ] }, "id" : "id801", "title" : "report a problem, with exceptions and translation support", "chapters" : [ "id802", "id1352", "id803", "id804", "id805", "id887" ], "name" : "Log::Report", "version" : "1.46" }, "id1172-id1021" : { "intro" : "Inherited, see Log::Report::Dispatcher::new(format_reason)
", "name" : "format_reason", "type" : "default", "value" : "'LOWERCASE'", "id" : "id1172-id1021", "extends" : "id1172" }, "id986" : { "call" : "$obj->domain", "intro" : "Returns the domain of the first translatable string in the structure.
\n", "id" : "id986", "type" : "i_method", "name" : "domain" }, "id318" : { "id" : "id318", "intro" : "Get the String::Print object which formats the messages.
Read the POT information from $filename.
\n" }, "id1207-id1217" : { "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(max_params)
", "name" : "max_params", "type" : "default", "value" : "8", "id" : "id1207-id1217", "extends" : "id1207" }, "id86" : { "call" : "printp( [$fh], $format, @positionals, %options )", "intro" : "Calls sprintp() to fill the @positionals in $format, and\nthen sends it to the $fh (by default the selected file handle).
\n", "id" : "id86", "type" : "function", "name" : "printp" }, "id1194-id1091" : { "params" : "CLASS", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(package)
", "type" : "option", "id" : "id1194-id1091", "name" : "package", "extends" : "id1194" }, "id544" : { "name" : "SYNOPSIS", "level" : 1, "path" : "SYNOPSIS", "type" : "chapter", "intro" : "# normal use (end-users view)\n\n textdomain 'my-domain',\n translator => Log::Report::Translator::Gettext->new;\n\n print __\"Hello World\\n\"; # language determined by environment\n\n # internal use\n\n my $msg = Log::Report::Message->new(\n _msgid => \"Hello World\\n\",\n _textdomain => 'my-domain',\n );\n\n print Log::Report::Translator::Gettext->new\n ->translate($msg, 'nl-BE');\n\n", "id" : "id544" }, "id469" : { "id" : "id469", "value" : "<from header>", "type" : "default", "name" : "charset" }, "id395" : { "type" : "default", "value" : "'loc'", "id" : "id395", "name" : "translation_function" }, "id1156" : { "level" : 3, "name" : "configuring your own formatter", "id" : "id1156", "intro" : "
[0.91] The PRINTI is a special constants for configure(formatter), and\nwill use String::Print function printi(), with the standard tricks.
\n textdomain 'some-domain',\n formatter => {\n class => 'String::Print', # default\n method => 'sprinti', # default\n %options, # constructor options for String::Print\n );\n\n\nWhen you want your own formatter, or configuration of String::Print,\nyou need to pass a CODE. Be aware that you may loose magic added by\nLog::Report and other layers, like Log::Report::Template:
\n textdomain 'some-domain', formatter => \\&my_formatter;\n\n", "type" : "subsection", "path" : "DETAILS/Configuring/configuring your own formatter" }, "id997" : { "path" : "METHODS/Processing", "type" : "section", "id" : "id997", "subroutines" : [ "id1010", "id1000", "id1004", "id998", "id1006", "id1003", "id1001", "id999" ], "name" : "Processing", "level" : 2 }, "id1185-id780" : { "name" : "close", "extends" : "id1185", "intro" : "
Inherited, see Log::Report::Dispatcher::close()
", "type" : "i_method", "id" : "id1185-id780", "call" : "$obj->close" }, "id942" : { "type" : "overload", "intro" : "An (accidental) use of concatenation (a dot where a comma should be\nused) would immediately stringify the object. This is avoided by\noverloading that operation.
\n", "id" : "id942", "call" : "overload '.'; concatenation", "name" : "'.'" }, "id191" : { "name" : "assert", "call" : "assert( $message )", "type" : "function", "id" : "id191" }, "id1191-id1091" : { "name" : "skipStack", "extends" : "id1191", "call" : "$obj->skipStack", "intro" : "Inherited, see Log::Report::Dispatcher::skipStack()
", "id" : "id1191-id1091", "type" : "i_method" }, "id1136-id385" : { "params" : "CODESET", "intro" : "Inherited, see Log::Report::Domain::configure(native_language)
", "type" : "option", "id" : "id1136-id385", "name" : "native_language", "extends" : "id1136" }, "id1197-id1217" : { "name" : "filename", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(filename)
", "extends" : "id1197", "id" : "id1197-id1217", "type" : "default", "value" : "<required>" }, "id134" : { "name" : "must_show_location", "id" : "id134", "type" : "function", "call" : "must_show_location( $mode, $reason )" }, "id189" : { "path" : "FUNCTIONS/Abbreviations for report()", "subroutines" : [ "id194", "id193", "id196", "id200", "id199", "id197", "id198", "id190", "id195", "id192", "id191" ], "type" : "section", "id" : "id189", "name" : "Abbreviations for report()", "level" : 2 }, "id223" : { "intro" : "In your template:\n\n [% FOR message IN messages %]\n <div class=\"alert alert-[% message.bootstrapColor %]\">\n [% message.toString | html_entity %]\n </div>\n [% END %]\n\n", "type" : "chapter", "id" : "id223", "path" : "SYNOPSIS", "level" : 1, "name" : "SYNOPSIS" }, "id336" : { "type" : "section", "intro" : "
Some common activities in templates are harder when translation is\nneeded. A few TT filters are provided to easy the process.
\n\nA typical example of an HTML component which needs translation is
\n\n <trE<gt><tdE<gt>Price:</tdE<gt><tdE<gt>20 £</tdE<gt></trE<gt>\n\n\n
Both the price text as value need to be translated. In plain perl\n(with Log::Report) you would write
\n\n __x\"Price: {price £}\", price => $product->price # or\n __x\"Price: {p.price £}\", p => $product;\n\n\nIn HTML, there seems to be the need for two separate translations,\nmay in the program code. This module (actually String::Print)\ncan be trained to convert money during translation, because '£'\nis a modifier. The translation for Dutch (via a PO table) could be
\n\n \"Prijs: {p.price €}\"\n\n\nSO: we want to get both table fields in one translation. Try this:
\n\n <trE<gt>[% loc(\"Price:\\t{p.price £}\" | cols %]</trE<gt>\n\n\nIn the translation table, you have to place the tabs (backslash-t) as\nwell.
\n\nThere are two main forms of cols. The first form is the containerizer:\npass 'cols' a list of container names. The fields in the input string\n(as separated by tabs) are wrapped in the named container. The last\ncontainer name will be reused for all remaining columns. By default,\neverything is wrapped in 'td' containers.
\n \"a\\tb\\tc\" | cols <tdE<gt>aE<lt>/tdE<gt><tdE<gt>bE<lt>/tdE<gt><tdE<gt>cE<lt>/tdE<gt>\n \"a\\tb\\tc\" | cols('td') same\n \"a\\tb\\tc\" | cols('th', 'td') <thE<gt>aE<lt>/thE<gt><tdE<gt>bE<lt>/tdE<gt><tdE<gt>cE<lt>/tdE<gt>\n \"a\" | cols('div') <divE<gt>aE<lt>/divE<gt>\n loc(\"a\") | cols('div') <divE<gt>xxxxE<lt>/divE<gt>\n\n\nThe second form has one pattern, which contains (at least one) $1\nreplacement positions. Missing columns for positional parameters\nwill be left blank.
\n \"a\\tb\\tc\" | cols('#$3#$1#') #c#a#\n \"a\" | cols('#$3#$1#') ##a#\n loc(\"a\") | cols('#$3#$1#') #mies#aap#\n\nSome translations will produce more than one line of text. Add\n'<brE<gt>' after each of them.
\n\n [% loc('intro-text') | br %]\n [% | br %][% intro_text %][% END %]\n [% FILTER br %][% intro_text %][% END %]\n\n\nInherited, see Log::Report::Dispatcher::stackTraceLine(max_line)
", "type" : "option", "params" : "INTEGER" }, "id636" : { "subroutine" : "id617", "name" : "no msgid defined for PO.", "type" : "error", "id" : "id636" }, "id250" : { "level" : 2, "name" : "Dancer2 Configuration", "id" : "id250", "intro" : "Most configuration variables are available when creating a new instance\nof a manual Template::Toolkit object can be declared in your config.yml file.\nFor example:
\n\n template: TTLogReport\n\n engines:\n template:\n TTLogReport:\n start_tag: '<%'\n end_tag: '%>'\n\n\n
(Note: start_tag and end_tag are regexes. If you want to use PHP-style\ntags, you will need to list them as <\\? >> and C<< \\?>.)\nSee manual Template::Manual::Config for the configuration variables.
In addition to the standard configuration variables, the option show_private_variables\nis also available. Template::Toolkit, by default, does not render private variables\n(the ones starting with an underscore). If in your project it gets easier to disable\nthis feature than changing variable names, add this option to your configuration.
\n show_private_variables: true\n\n\n
Warning: Given the way Template::Toolkit implements this option, different Dancer2\napplications running within the same interpreter will share this option!
\n", "type" : "section", "path" : "DETAILS/Dancer2 Configuration" }, "id1278" : { "nest" : [ "id1279" ], "type" : "section", "id" : "id1278", "name" : "Messages with plural forms", "level" : 2, "path" : "DETAILS/Messages with plural forms" }, "id1196-id1021" : { "type" : "option", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(filename)
", "id" : "id1196-id1021", "params" : "STRING", "extends" : "id1196", "name" : "filename" }, "id151" : { "level" : 1, "name" : "NAME", "id" : "id151", "intro" : "Log::Report::Minimal::Domain - administer one text-domain
\n", "type" : "chapter", "path" : "NAME" }, "id1195-id1091" : { "extends" : "id1195", "id" : "id1195-id1091", "value" : "<required>", "type" : "default", "name" : "package", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(package)
" }, "id763" : { "intro" : "This dispatchers produces output to and Log::Dispatch back-end.\n(which will NOT be automatically installed for you).
The REASON for a message often uses names which are quite similar to the\nlog-levels used by Log::Dispatch. However: they have a different\napproach. The REASON of Log::Report limits the responsibility of the\nprogrammer to indicate the cause of the message: whether it was able to\nhandle a certain situation. The Log::Dispatch levels are there for the\nuser's of the program. However: the programmer does not known anything\nabout the application (in the general case). This is cause of much of\nthe trickery in Perl programs.
\n\nThe default translation table is list below. You can change the mapping\nusing new(to_level). See example in SYNOPSIS.
\n", "id" : "id763", "type" : "chapter", "path" : "DESCRIPTION", "level" : 1, "name" : "DESCRIPTION" }, "id290" : { "path" : "NAME", "id" : "id290", "intro" : "Dancer2::Logger::LogReport - reroute Dancer2 logs into Log::Report
\n", "type" : "chapter", "name" : "NAME", "level" : 1 }, "id530" : { "type" : "i_method", "intro" : "Returns the list of Log::Report::Lexicon::POT objects which contain\nthe tables for $domain.
\n", "id" : "id530", "call" : "$obj->pots( $domain )", "name" : "pots" }, "id158-id385" : { "extends" : "id158", "type" : "default", "value" : "<required>", "id" : "id158-id385", "name" : "name", "intro" : "Inherited, see Log::Report::Minimal::Domain::new(name)
" }, "id1206-id1021" : { "params" : "INTEGER", "type" : "option", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(max_params)
", "id" : "id1206-id1021", "name" : "max_params", "extends" : "id1206" }, "id1200-id1217" : { "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(call)
", "id" : "id1200-id1217", "type" : "option", "params" : "STRING", "extends" : "id1200", "name" : "call" }, "id954-id221" : { "extends" : "id954", "name" : "_msgid", "type" : "option", "intro" : "Inherited, see Log::Report::Message::new(_msgid)
", "id" : "id954-id221", "params" : "$msgid" }, "id1008-id221" : { "id" : "id1008-id221", "type" : "default", "value" : "undef",
"extends" : "id1008",
"intro" : "Inherited, see Log::Report::Message::freeze(serializer)
", "name" : "serializer" }, "id1142" : { "name" : "the native_language '$locale' is not a valid locale", "subroutine" : "id1133", "type" : "error", "id" : "id1142" }, "id424" : { "name" : "SYNOPSIS", "level" : 1, "path" : "SYNOPSIS", "id" : "id424", "intro" : "# internal use\n my $msg = Log::Report::Message->new(\n _msgid => \"Hello World\\n\",\n _domain => 'my-domain',\n );\n\n print Log::Report::Translator::POT\n ->new(lexicons => $dir)\n ->translate($msg, 'nl-BE');\n\n # normal use (end-users view in the program's ::main)\n textdomain 'my-domain',\n translator => Log::Report::Translator::POT->new(lexicon => $dir);\n print __\"Hello World\\n\";\n\n", "type" : "chapter" }, "id1205-id1091" : { "name" : "max_line", "intro" : "
Inherited, see Log::Report::Dispatcher::stackTraceLine(max_line)
", "extends" : "id1205", "type" : "default", "id" : "id1205-id1091", "value" : "undef"
},
"id817" : {
"value" : "undef",
"id" : "id817",
"type" : "default",
"name" : "locale"
},
"id1139" : {
"value" : "undef",
"type" : "default",
"id" : "id1139",
"name" : "context_rules"
},
"id655" : {
"subroutine" : "id654",
"name" : "unknown flag $flag ignored",
"type" : "warning",
"id" : "id655"
},
"id1181-id780" : {
"id" : "id1181-id780",
"intro" : "Inherited, see Log::Report::Dispatcher::mode()
", "type" : "i_method", "call" : "$obj->mode", "extends" : "id1181", "name" : "mode" }, "id1189-id1021" : { "extends" : "id1189", "name" : "addSkipStack", "call" : "$any->addSkipStack( @CODE )", "id" : "id1189-id1021", "intro" : "Inherited, see Log::Report::Dispatcher::addSkipStack()
", "type" : "ci_method" }, "id520-id354" : { "extends" : "id520", "name" : "lexicon", "type" : "option", "intro" : "Inherited, see Log::Report::Extract::new(lexicon)
", "id" : "id520-id354", "params" : "$directory" }, "id140" : { "call" : "parse_locale( STRING )", "diagnostics" : [ "id141" ], "id" : "id140", "type" : "function", "name" : "parse_locale", "intro" : "Decompose a locale string.
\n\nFor simplicity of the caller's code, the capatization of the returned\nfields is standardized to the preferred, although the match is case-\ninsensitive as required by the RFC. The territory in returned in capitals\n(ISO3166), the language is lower-case (ISO639), the script as upper-case\nfirst, the character-set as lower-case, and the modifier and variant unchanged.
\n\nIn LIST context, four elements are returned: language, territory,\ncharacter-set (codeset), and modifier. Those four are important for the\nusual unix translationg infrastructure. Only the \"country\" is obligatory,\nthe others can be undef. It may also return C and POSIX.
In SCALAR context, a HASH is returned which can contain more information:\nlanguage, script, territory, variant, codeset, and modifiers. The\nvariant (RFC3066 is probably never used)
\n" }, "id957" : { "value" : "undef",
"id" : "id957",
"type" : "default",
"name" : "_category"
},
"id1170-id1066" : {
"name" : "mode",
"intro" : "Inherited, see Log::Report::Dispatcher::new(mode)
", "extends" : "id1170", "value" : "'NORMAL'", "id" : "id1170-id1066", "type" : "default" }, "id355" : { "intro" : "Log::Report::Template::Extract - collect translatable strings from template files
\n", "id" : "id355", "type" : "chapter", "path" : "NAME", "level" : 1, "name" : "NAME" }, "id1310" : { "name" : "Filters", "level" : 3, "path" : "DETAILS/Processing the message/Filters", "id" : "id1310", "type" : "subsection" }, "id554" : { "name" : "codepage_to_iso", "intro" : "Translate windows $codepage into ISO code. The $codepage is numeric\nor a hex string like '0x0304'.
\n", "type" : "function", "id" : "id554", "call" : "codepage_to_iso( $codepage )" }, "id753-id669" : { "id" : "id753-id669", "type" : "i_method", "call" : "$obj->setupPluralAlgorithm", "diagnostics" : [ "id754-id669" ], "extends" : "id753", "intro" : "Inherited, see Log::Report::Lexicon::Table::setupPluralAlgorithm()
", "name" : "setupPluralAlgorithm" }, "id190" : { "id" : "id190", "type" : "function", "call" : "trace( $message )", "name" : "trace" }, "id93" : { "level" : 3, "name" : "Simple keys", "type" : "subsection", "intro" : "A simple key directly refers to a named parameter of the function or method:
\n\n printi \"Username: {name}\", name => 'John';\n\n\nYou may also pass them as HASH or CODE:
\n\n printi \"Username: {name}\", { name => 'John' };\n printi \"Username: {name}\", name => sub { 'John' };\n printi \"Username: {name}\", { name => sub { 'John' } };\n printi \"Username: {name}\", name => sub { sub {'John'} };\n\n\nThe smartness of pre-processing CODE is part of serialization.
\n", "id" : "id93", "path" : "DETAILS/Interpolation: keys/Simple keys" }, "id1203-id1066" : { "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(params)
", "name" : "params", "value" : "<required>", "id" : "id1203-id1066", "type" : "default", "extends" : "id1203" }, "id773" : { "name" : "callbacks", "intro" : "See Log::Dispatch::Output.
\n", "type" : "option", "id" : "id773", "params" : "CODE|\\@CODE" }, "id251" : { "path" : "DETAILS/Advanced Customization", "intro" : "Module manual Dancer2::Template::TemplateToolkit describes how to extend the Template\nby wrapping the _build_engine method. The instantiation trick is insufficient\nfor a bit more complex modules, like our Log::Report translation feature. You may\nbe able to extend this module with your own templater, however.
\n # in config.yml\n engines:\n template:\n TTLogReport:\n start_tag: '<%'\n end_tag: '%>'\n templater: Log::Report::Template # default\n\n", "id" : "id251", "type" : "section", "name" : "Advanced Customization", "level" : 2 }, "id1202-id1091" : { "extends" : "id1202", "name" : "params", "type" : "option", "intro" : "
Inherited, see Log::Report::Dispatcher::stackTraceLine(params)
", "id" : "id1202-id1091", "params" : "ARRAY" }, "id1145" : { "name" : "cannot open JSON file for context at $fn: $!", "subroutine" : "id1144", "type" : "fault", "id" : "id1145" }, "id1173-id1217" : { "name" : "charset", "extends" : "id1173", "params" : "CHARSET", "id" : "id1173-id1217", "intro" : "Inherited, see Log::Report::Dispatcher::new(charset)
", "type" : "option" }, "id1183" : { "name" : "needs", "intro" : "Returns the list with all REASONS which are needed to fulfill this\ndispatcher's needs. When disabled, the list is empty, but not forgotten.
\n\n[0.999] when only one $reason is specified, it is returned if in the\nlist.
\n", "type" : "i_method", "id" : "id1183", "call" : "$obj->needs( [$reason] )" }, "id1179-id780" : { "id" : "id1179-id780", "intro" : "Inherited, see Log::Report::Dispatcher::name()
", "type" : "i_method", "call" : "$obj->name", "name" : "name", "extends" : "id1179" }, "id1171-id1021" : { "extends" : "id1171", "name" : "format_reason", "intro" : "Inherited, see Log::Report::Dispatcher::new(format_reason)
", "id" : "id1171-id1021", "type" : "option", "params" : "'UPPERCASE'|'LOWERCASE'|'UCFIRST'|'IGNORE'|CODE" }, "id812" : { "name" : "stack", "params" : "\\@trace", "intro" : "When defined, that data is used to display the call stack. Otherwise,\nit is collected via caller() if needed.
Inherited, see Log::Report::Dispatcher::new(locale)
", "type" : "option", "id" : "id1167-id905", "name" : "locale", "extends" : "id1167" }, "id800" : { "intro" : "use Log::Log4perl qw/:levels/;\n\n # by default, ALERTs are output as $FATAL\n dispatcher Log::Log4perl => 'logger',\n to_level => [ ALERT => $ERROR, ],\n ...;\n\n", "type" : "example", "id" : "id800" }, "id240" : { "path" : "DESCRIPTION", "type" : "chapter", "intro" : "
This template engine allows you to use manual Template::Toolkit in manual Dancer2,\nincluding the translation extensions offered by Log::Report::Template.
\n", "id" : "id240", "name" : "DESCRIPTION", "level" : 1 }, "id1174-id1021" : { "intro" : "Inherited, see Log::Report::Dispatcher::new(charset)
", "name" : "charset", "id" : "id1174-id1021", "value" : "undef",
"type" : "default",
"extends" : "id1174"
},
"id708" : {
"subroutine" : "id703",
"name" : "cannot write to file $fn with $layers: $!",
"id" : "id708",
"type" : "fault"
},
"id1193-id1066" : {
"name" : "stackTraceLine",
"extends" : "id1193",
"options" : [
[
"id1208-id1066",
"id1209-id1066"
],
[
"id1200-id1066",
"id1201-id1066"
],
[
"id1196-id1066",
"id1197-id1066"
],
[
"id1198-id1066",
"id1199-id1066"
],
[
"id1204-id1066",
"id1205-id1066"
],
[
"id1206-id1066",
"id1207-id1066"
],
[
"id1194-id1066",
"id1195-id1066"
],
[
"id1202-id1066",
"id1203-id1066"
]
],
"intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine()
", "type" : "ci_method", "id" : "id1193-id1066", "call" : "$any->stackTraceLine( %options )" }, "id1168" : { "name" : "locale", "type" : "default", "value" : "<system locale>", "id" : "id1168" }, "id952" : { "params" : "$msgid", "intro" : "Can be used together with _count. This plural form of the _msgid\ntext is used to simplify the work of translators, and as fallback when\nno translation is possible: therefore, this can best resemble an\nEnglish message.
\n\nWhite-space at the beginning and end of the string are stripped off.\nThe white-space provided by the _msgid will be used.
\n", "id" : "id952", "type" : "option", "name" : "_plural" }, "id1192-id1091" : { "type" : "ci_method", "intro" : "Inherited, see Log::Report::Dispatcher::collectLocation()
", "id" : "id1192-id1091", "call" : "$any->collectLocation", "extends" : "id1192", "name" : "collectLocation" }, "id405" : { "intro" : "The Log::Report::Template object which is using this textdomain.
\n", "id" : "id405", "type" : "i_method", "call" : "$obj->templater", "name" : "templater" }, "id68" : { "name" : "setDefaults", "examples" : [ "id69" ], "id" : "id68", "intro" : "[1.00] Set the defaults for modifiers, either with a HASH where the key modifier name\nmaps to a HASH of settings, or a list of PAIRS.
\n\nWhen using the methods in OO style , you can change the defaults at any time. For\nfunctional style, the object is hidden.
\n", "type" : "i_method", "call" : "$obj->setDefaults( \\%defaults|@defaults )" }, "id433" : { "intro" : "# file xxx/perl5.8.8/My/Module.pm\n use Log::Report 'my-domain',\n translator => Log::Report::Translator::POT->new;\n\n # lexicon now in xxx/perl5.8.8/My/Module/messages/\n\n", "type" : "example", "id" : "id433", "name" : "default lexicon directory\n" }, "id1187-id905" : { "extends" : "id1187", "name" : "translate", "intro" : "
Inherited, see Log::Report::Dispatcher::translate()
", "id" : "id1187-id905", "type" : "i_method", "call" : "$obj->translate( \\%options, $reason, $message )" }, "id85" : { "call" : "printi( [$fh], $format, %data|\\%data )", "type" : "function", "intro" : "Calls sprinti() to fill the %data into $format, and then sends it to\nthe $fh (by default the selected file handle)
\n\n open my $fh, '>:encoding(UTF-8)', $file;\n printi $fh, ...\n\n printi \\*STDERR, ...\n\n", "id" : "id85", "name" : "printi" }, "id706" : { "subroutine" : "id703", "name" : "no filename or file-handle specified for PO", "intro" : "
When a PO file is written, then a filename or file-handle must be\nspecified explicitly, or set beforehand using the filename()\nmethod, or known because the write follows a read() of the file.
\n", "id" : "id706", "type" : "error" }, "id1345" : { "level" : 1, "name" : "INHERITANCE", "intro" : "Log::Report::Extract::PerlPPI\n is a Log::Report::Extract\n\n", "id" : "id1345", "type" : "chapter", "path" : "INHERITANCE" }, "id459" : { "path" : "DETAILS/Locale search", "intro" : "
The exact gettext defined format of the locale is
\n language[_territory[.codeset]][@modifier]\n\nThe modifier will be used in above directory search, but only if provided\nexplicitly.\n\n
The manual info gettext determines the rules. During the search,\ncomponents of the locale get stripped, in the following order:
The normalized codeset (character-set name) is derived by
\nTo speed-up the search for the right table, the full directory tree\nwill be indexed only once when needed the first time. The content of\nall defined lexicon directories will get merged into one tree.
\n", "id" : "id459", "type" : "section", "name" : "Locale search", "level" : 2 }, "id1208-id1066" : { "extends" : "id1208", "name" : "abstract", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(abstract)
", "type" : "option", "id" : "id1208-id1066", "params" : "INTEGER" }, "id507" : { "id" : "id507", "type" : "fault", "name" : "cannot read perl from file $filename: $!", "subroutine" : "id504" }, "id91" : { "level" : 2, "name" : "Four components", "id" : "id91", "intro" : "To fill-in a FORMAT, four clearly separated components play a role:
\n\nundef\nand ARRAYs.\n\n\n%d. One conversion rule\nhas been added 'S', which provides unicode correct behavior.\n\n\nSimplified:
\n\n # sprinti() replaces \"{$key$modifiers$conversion}\" by\n $encode->($format->($serializer->($modifiers->($args{$key}))))\n\n # sprintp() replaces \"%pos{$modifiers}$conversion\" by\n $encode->($format->($serializer->($modifiers->($arg[$pos]))))\n\n\nExample:
\n\n printi \"price: {price € %-10s}\", price => $cost;\n printi \"price: {price € %-10s}\", { price => $cost };\n printp \"price: %-10{€}s\", $cost;\n\n $value = $cost (in €)\n $modifier = convert € to local currency £\n $serializer = show float as string\n $format = column width %-10s\n $encode = £ into £ # when encodingFor('HTML')\n\n",
"type" : "section",
"path" : "DETAILS/Four components"
},
"id1188" : {
"name" : "collectStack",
"id" : "id1188",
"intro" : "Returns an ARRAY of ARRAYs with text, filename, line-number.
\n", "type" : "ci_method", "call" : "$any->collectStack( [$maxdepth] )" }, "id1297" : { "id" : "id1297", "type" : "chapter", "nest" : [ "id1298", "id1299" ], "path" : "DETAILS", "level" : 1, "name" : "DETAILS" }, "id1232" : { "type" : "chapter", "id" : "id1232", "nest" : [ "id1233", "id1241", "id1249" ], "path" : "METHODS", "level" : 1, "name" : "METHODS" }, "id413" : { "subroutine" : "id412", "name" : "no counting positional for '$msgid'", "type" : "error", "id" : "id413" }, "id925" : { "name" : "charset", "params" : "$charset", "intro" : "Translate the text-strings into the specified $charset, otherwise the\nsysadmin may get unreadable text.
\n", "type" : "option", "id" : "id925" }, "id793" : { "id" : "id793", "value" : "<undef>",
"type" : "default",
"name" : "config"
},
"id327" : {
"options" : [
[
"id328",
"id329"
],
[
"id334",
"id335"
],
[
"id332",
"id333"
],
[
"id330",
"id331"
]
],
"intro" : "Extract message ids from the templates, and register them to the lexicon.\nRead section Extracting PO-files how to use this method.
\n\nShow statistics will be show when the Log::Report more is VERBOSE or\nDEBUG.
\n", "type" : "i_method", "id" : "id327", "call" : "$obj->extract( %options )", "name" : "extract" }, "id627" : { "id" : "id627", "value" : "[]", "type" : "default", "name" : "comment" }, "id1172-id760" : { "type" : "default", "value" : "'LOWERCASE'", "id" : "id1172-id760", "extends" : "id1172", "intro" : "Inherited, see Log::Report::Dispatcher::new(format_reason)
", "name" : "format_reason" }, "id1198-id1066" : { "name" : "linenr", "extends" : "id1198", "params" : "INTEGER", "id" : "id1198-id1066", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(linenr)
", "type" : "option" }, "id260" : { "id" : "id260", "intro" : " fatal_handler sub {\n my ($dsl, $msg, $reason, $default) = @_;\n\n (my $ctype = $dsl->request->header('content-type')) =~ s/;.*//;\n return if $ctype ne 'application/json';\n status $reason eq 'PANIC' ? 'Internal Server Error' : 'Bad Request';\n $dsl->send_as(JSON => {\n error => 1,\n description => $msg->toString,\n }, {\n content_type => 'application/json; charset=UTF-8',\n });\n };\n\n",
"type" : "example",
"name" : "Return JSON responses for requests with content-type of application/json\n"
},
"id1090-id542" : {
"extends" : "id1090",
"name" : "load",
"call" : "$obj->load( $domain, $locale )",
"intro" : "Inherited, see Log::Report::Translator::load()
", "id" : "id1090-id542", "type" : "i_method" }, "id1163" : { "name" : "Constructors", "level" : 2, "path" : "METHODS/Constructors", "subroutines" : [ "id1164" ], "type" : "section", "id" : "id1163" }, "id583" : { "version" : "1.16", "chapters" : [ "id584", "id585", "id586", "id587", "id603" ], "name" : "Log::Report::Translator::Context", "inheritance" : {}, "id" : "id583", "title" : "handle translation contexts", "is_pure_pod" : false, "package" : "Log::Report::Translator::Context", "distribution" : "Log-Report-Lexicon" }, "id1027" : { "id" : "id1027", "intro" : "When $@ is used the traditional way, it is checked to have\na string content. In this case, stringify into the fatal error\nor nothing.
The following functions are all wrappers for calls to report(),\nand available when \"syntax is SHORT\" (by default, see import()).\nYou cannot specify additional options to influence the behavior of\nreport(), which are usually not needed anyway.
The gnutext implementation of the context is very simple. This is to\nbe expected from a library written in C. The msgctxt alternatives\nare matched against the context keywords of the message. In all or\nnone of the alternatives match, then just a random translation is\nchosen.
\n\nIn the simplest form, the msgctxt field contains a single keyword\n(not containing a comma).
\n\n msgctxt \"gender=male\"\n\n\n
But you can do more. Be warned that most (all?) existing tools\nwhich smartly edit PO-files do not understand these constructs: they\nsee the msgctxt as dump string without meaning.
\n\n msgctxt \"agegroup=baby,agegroup=grandparent\" # baby OR grandparent\n msgctxt \"gender=male agegroup=adult\" # both male AND adult\n\n\n
So, a comma separated list of alternatives. If any matches, then the\nrule is selected.
\n", "type" : "subsection", "id" : "id609", "path" : "DETAILS/Using context_rules/The msgctxt", "level" : 3, "name" : "The msgctxt" }, "id539-id354" : { "subroutine" : "id538", "extends" : "id539", "name" : "starting new textdomain $domain, template in $filename", "intro" : "Inherited, see Log::Report::Extract::write()
", "id" : "id539-id354", "type" : "info" }, "id885" : { "call" : "$class->needs( $reason, [$reasons] )", "intro" : "Returns true when the reporter needs any of the $reasons, when any of\nthe active dispatchers is collecting messages in the specified level.\nThis is useful when the processing of data for the message is relatively\nexpensive, but for instance only required in debug mode.
Inherited, see Log::Report::Message::prepend()
", "type" : "i_method", "call" : "$obj->prepend" }, "id480" : { "type" : "fault", "id" : "id480", "name" : "cannot read msgids from $fn, need $size at $loc: $!", "subroutine" : "id467" }, "id1169-id1021" : { "intro" : "Inherited, see Log::Report::Dispatcher::new(mode)
", "id" : "id1169-id1021", "type" : "option", "params" : "'NORMAL'|'VERBOSE'|'ASSERT'|'DEBUG'|0..3", "extends" : "id1169", "name" : "mode" }, "id1235" : { "name" : "report_opts", "params" : "\\%opts", "type" : "option", "id" : "id1235" }, "id721" : { "diagnostics" : [ "id722" ], "call" : "$obj->header( [$field, [$content]] )", "id" : "id721", "type" : "i_method", "intro" : "The translation of a blank MSGID is used to store a MIME header, which\ncontains some meta-data. When only a $field is specified, that content is\nlooked-up (case-insensitive) and returned. When a $content is specified,\nthe knowledge will be stored. In latter case, the header structure\nmay get created. When the $content is set to undef, the field will\nbe removed.
Returns the file-handle to write the log lines to. [1.10] This may\ndepend on the $msg (especially message context)
\n", "id" : "id1110", "type" : "i_method", "name" : "output" }, "id622" : { "intro" : "The @translations for the msgid. When msgid_plural is defined, then an\nARRAY must be provided.
\n", "id" : "id622", "type" : "option", "params" : "$translation|\\@translations", "name" : "msgstr" }, "id529" : { "call" : "$obj->domains", "intro" : "Returns a sorted list of all known domain names.
\n", "id" : "id529", "type" : "i_method", "name" : "domains" }, "id1003-id221" : { "name" : "untranslated", "extends" : "id1003", "call" : "$obj->untranslated", "intro" : "Inherited, see Log::Report::Message::untranslated()
", "type" : "i_method", "id" : "id1003-id221" }, "id270" : { "name" : "fault", "type" : "i_method", "id" : "id270", "call" : "$obj->fault" }, "id322" : { "type" : "example", "intro" : "my $domain = $templater->addTextdomain(\n name => 'my-project',\n function => 'loc', # default\n );\n\n", "id" : "id322" }, "id1339" : { "name" : "INHERITANCE", "level" : 1, "path" : "INHERITANCE", "type" : "chapter", "intro" : "
Log::Report::Lexicon::POT\n is a Log::Report::Lexicon::Table\n\n", "id" : "id1339" }, "id1059" : { "version" : "1.46", "chapters" : [ "id1060", "id1327", "id1061", "id1062", "id1063" ], "name" : "MojoX::Log::Report", "id" : "id1059", "inheritance" : { "extends" : [ "Mojo::Log" ] }, "title" : "divert log messages into Log::Report", "is_pure_pod" : false, "distribution" : "Log-Report", "package" : "MojoX::Log::Report" }, "id837" : { "call" : "warning( $message )", "intro" : "
Short for report WARNING => $message
Log::Report::Translator is extended by\n Log::Report::Translator::Gettext\n Log::Report::Translator::POT\n\n", "id" : "id1342", "type" : "chapter", "path" : "INHERITANCE" }, "id904" : { "name" : "Locale::gettext and Locate::TextDomain", "level" : 3, "path" : "DETAILS/Compared to other solutions in Perl/Locale::gettext and Locate::TextDomain", "intro" : "
Both on GNU gettext based implementations can be used as translation\nframeworks. Locale::TextDomain syntax is supported, with quite some\nextensions. Read the excellent documentation of Locale::TextDomain.\nOnly the tried access via $__ and %__ are not supported.
The main difference with these modules is the moment when the translation\ntakes place. In Locale::TextDomain, an __x() will result in an\nimmediate translation request via gettext(). Log::Report's version\nof __x() will only capture what needs to be translated in an object.\nWhen the object is used in a print statement, only then the translation\nwill take place. This is needed to offer ways to send different\ntranslations of the message to different destinations.
To be able to postpone translation, objects are returned which stringify\ninto the translated text.
\n", "type" : "subsection", "id" : "id904" }, "id1077" : { "level" : 2, "name" : "Attributes", "subroutines" : [ "id1180-id1066", "id1179-id1066", "id1183-id1066", "id1181-id1066", "id1182-id1066", "id1078" ], "type" : "section", "id" : "id1077", "path" : "METHODS/Attributes" }, "id160" : { "type" : "error", "id" : "id160", "name" : "translation domain without name.", "subroutine" : "id156" }, "id1167-id1066" : { "name" : "locale", "extends" : "id1167", "params" : "LOCALE", "intro" : "Inherited, see Log::Report::Dispatcher::new(locale)
", "id" : "id1167-id1066", "type" : "option" }, "id987" : { "name" : "count", "type" : "i_method", "intro" : "Returns the count, which is used to select the translation\nalternatives.
\n", "id" : "id987", "call" : "$obj->count" }, "id809" : { "type" : "default", "value" : "undef",
"id" : "id809",
"name" : "to"
},
"id978" : {
"name" : "_msgctxt",
"intro" : "[1.22] Message $context in the translation file, the traditional use. Cannot\nbe combined with _context on the same msgids.
\n", "type" : "option", "id" : "id978", "params" : "$context" }, "id385" : { "version" : "1.05", "chapters" : [ "id386", "id1330", "id387", "id388", "id389", "id1288" ], "name" : "Log::Report::Template::Textdomain", "id" : "id385", "inheritance" : { "extends" : [ "Log::Report::Domain" ] }, "title" : "template translation with one domain", "is_pure_pod" : false, "distribution" : "Log-Report-Template", "package" : "Log::Report::Template::Textdomain" }, "id1193-id905" : { "options" : [ [ "id1208-id905", "id1209-id905" ], [ "id1200-id905", "id1201-id905" ], [ "id1196-id905", "id1197-id905" ], [ "id1198-id905", "id1199-id905" ], [ "id1204-id905", "id1205-id905" ], [ "id1206-id905", "id1207-id905" ], [ "id1194-id905", "id1195-id905" ], [ "id1202-id905", "id1203-id905" ] ], "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine()
", "type" : "ci_method", "id" : "id1193-id905", "call" : "$any->stackTraceLine( %options )", "name" : "stackTraceLine", "extends" : "id1193" }, "id249" : { "nest" : [ "id250", "id251" ], "type" : "chapter", "id" : "id249", "level" : 1, "name" : "DETAILS", "path" : "DETAILS" }, "id685" : { "name" : "plural_alg", "id" : "id685", "value" : "n!=1",
"type" : "default"
},
"id996" : {
"intro" : "When the message was produced with
\n\n my @files = qw/one two three/;\n my $msg = __xn\n \"found one file: {file}\",\n \"found {nrfiles} files: {files}\",\n scalar @files,\n file => $files[0],\n files => \\@files,\n nrfiles => @files+0, # or scalar(@files)\n _tags => [ 'IO', 'files' ],\n _join => ', ';\n\n\nthen the values can be takes from the produced message as
\n\n my $files = $msg->valueOf('files'); # returns ARRAY reference\n print @$files; # 3\n my $count = $msg->count; # 3\n my @tags = $msg->tags; # 'IO', 'files'\n if($msg->taggedWith('files')) # true\n\n\nSimplified, the above example can also be written as:
\n\n local $\" = ', '; # Perl default\n my $msg = __xn\n \"found one file: {files}\",\n \"found {_count} files: {files}\",\n @files, # has scalar context\n files => \\@files,\n _tags => 'IO, files';\n\n",
"type" : "example",
"id" : "id996"
},
"id1181-id760" : {
"call" : "$obj->mode",
"intro" : "Inherited, see Log::Report::Dispatcher::mode()
", "id" : "id1181-id760", "type" : "i_method", "extends" : "id1181", "name" : "mode" }, "id461" : { "id" : "id461", "inheritance" : { "extends" : [ "Log::Report::Lexicon::Table" ] }, "title" : "use translations from an MO file", "is_pure_pod" : false, "package" : "Log::Report::Lexicon::MOTcompact", "distribution" : "Log-Report-Lexicon", "version" : "1.16", "chapters" : [ "id462", "id1340", "id463", "id464", "id465" ], "name" : "Log::Report::Lexicon::MOTcompact" }, "id1283" : { "path" : "DETAILS", "level" : 1, "name" : "DETAILS", "id" : "id1283", "type" : "chapter", "nest" : [ "id1284", "id1285" ] }, "id1245" : { "intro" : " if($ex->isFatal) { $ex->throw(reason => 'ALERT') }\n else { $ex->throw }\n\n",
"id" : "id1245",
"type" : "example"
},
"id744" : {
"path" : "METHODS/Managing PO's/Translation",
"id" : "id744",
"type" : "subsection",
"subroutines" : [
"id746",
"id745"
],
"name" : "Translation",
"level" : 3
},
"id984-id221" : {
"call" : "$obj->msgid",
"intro" : "Inherited, see Log::Report::Message::msgid()
", "id" : "id984-id221", "type" : "i_method", "extends" : "id984", "name" : "msgid" }, "id822" : { "type" : "error", "id" : "id822", "name" : "odd length parameter list with '$msg'.", "subroutine" : "id807" }, "id1349" : { "path" : "INHERITANCE", "type" : "chapter", "intro" : "Log::Report::DBIC::Profiler\n is a DBIx::Class::Storage::Statistics\n\n", "id" : "id1349", "name" : "INHERITANCE", "level" : 1 }, "id199" : { "id" : "id199", "type" : "function", "call" : "failure( $message )", "name" : "failure" }, "id1203-id905" : { "name" : "params", "intro" : "
Inherited, see Log::Report::Dispatcher::stackTraceLine(params)
", "extends" : "id1203", "id" : "id1203-id905", "type" : "default", "value" : "<required>" }, "id162-id385" : { "extends" : "id162", "name" : "name", "intro" : "Inherited, see Log::Report::Minimal::Domain::name()
", "id" : "id162-id385", "type" : "i_method", "call" : "$obj->name" }, "id1080" : { "is_pure_pod" : false, "package" : "Log::Report::Translator", "distribution" : "Log-Report", "inheritance" : { "extended_by" : [ "Log::Report::Translator::Gettext", "Log::Report::Translator::POT" ] }, "id" : "id1080", "title" : "base implementation for translating messages", "chapters" : [ "id1081", "id1342", "id1082", "id1083", "id1084" ], "name" : "Log::Report::Translator", "version" : "1.46" }, "id637" : { "name" : "Attributes", "level" : 2, "path" : "METHODS/Attributes", "subroutines" : [ "id649", "id642", "id651", "id644", "id643", "id648", "id640", "id646", "id641", "id639", "id647", "id654", "id650", "id652", "id638", "id645" ], "type" : "section", "id" : "id637" }, "id1268" : { "name" : "DETAILS", "level" : 1, "path" : "DETAILS", "nest" : [ "id1269", "id1270" ], "id" : "id1268", "type" : "chapter" }, "id756-id561" : { "extends" : "id756", "name" : "header", "call" : "$obj->header( $field )", "intro" : "Inherited, see Log::Report::Lexicon::Table::header()
", "type" : "i_method", "id" : "id756-id561" }, "id181" : { "name" : "errno", "params" : "INTEGER", "id" : "id181", "type" : "option" }, "id903" : { "type" : "subsection", "intro" : "The two major logging frameworks for Perl are Log::Dispatch and\nLog::Log4perl; both provide a pluggable logging interface.
\n\nBoth frameworks do not have (gettext or maketext) language translation\nsupport, which has various consequences. When you wish for to report\nin some other language, it must be translated before the logging\nfunction is called. This may mean that an error message is produced\nin Chinese, and therefore also ends-up in the syslog file in Chinese.\nWhen this is not your language, you have a problem.
\n\nLog::Report translates only in the back-end, which means that the user may\nget the message in Chinese, but you get your report in your beloved Dutch.\nWhen no dispatcher needs to report the message, then no time is lost in\ntranslating.
\n\nWith both logging frameworks, you use terminology comparable to\nsyslog: the module programmer determines the seriousness of the\nerror message, not the application which integrates multiple modules.\nThis is the way perl programs usually work, but often the cause for\ninconsequent user interaction.
\n", "id" : "id903", "path" : "DETAILS/Compared to other solutions in Perl/Log::Dispatch and Log::Log4perl", "level" : 3, "name" : "Log::Dispatch and Log::Log4perl" }, "id337" : { "path" : "METHODS/Formatter value modifiers", "intro" : "Modifiers simplify the display of values. Read the section about\nmodifiers in String::Print. Here, only some examples are shown.
\n\nYou can achieve the same transformation with TT vmethods, or with the\nperl code which drives your website. The advantange is that you can\ntranslate them. And they are quite readible.
\n\n%-10s, %2.4f, etcExactly like format of the perl's internal printf() (which is\nactually being called to do the formatting)
Examples:
\n\n # pi in two decimals\n [% loc(\"π = {pi %.2f}\", pi => 3.14157) %]\n\n # show int, no fraction. filesize is a template variable\n [% loc(\"file size {size %d}\", size => filesize + 0.5) %]\n\nConvert a file size into a nice human readible format.
\n\nExamples:
\n\n # filesize and fn are passed as variables to the templater\n [% loc(\"downloaded {size BYTES} {fn}\\n\", size => fs, fn => fn) %]\n # may produce: \" 0 B\", \"25 MB\", \"1.5 GB\", etc\n\nAccept various time syntaxes as value, and translate them into\nstandard formats: year only, date in YYYY-MM-DD, time as HH::MM::SS,\nand various DateTime formats:
Examples:
\n\n # shows 'Copyright 2017'\n [% loc(\"Copyright {today YEAR}\", today => '2017-06-26') %]\n\n # shows 'Created: 2017-06-26'\n [% loc(\"Created: {now DATE}\", now => '2017-06-26 00:24:15') %]\n\n # shows 'Night: 00:24:15'\n [% loc(\"Night: {now TIME}\", now => '2017-06-26 00:24:15') %]\n\n # shows 'Mon Jun 26 00:28:50 CEST 2017'\n [% loc(\"Stamp: {now DT(ASC)}\", now => 1498429696) %]\n\nWhen a parameter has no value or is an empty string, the word or\nstring will take its place.
\n\n [% loc(\"visitors: {count //0}\", count => 3) %]\n [% loc(\"published: {date DT//'not yet'}\", date => '') %]\n [% loc(\"copyright: {year//2017 YEAR}\", year => '2018') %]\n [% loc(\"price: {price//5 EUR}\", price => product.price %]\n [% loc(\"price: {price EUR//unknown}\", price => 3 %]\n\n\nReturns true if the block exited normally.
Log::Report::Lexicon::Table is extended by\n Log::Report::Lexicon::MOTcompact\n Log::Report::Lexicon::POT\n Log::Report::Lexicon::POTcompact\n\n", "id" : "id1332", "path" : "INHERITANCE" }, "id968" : { "name" : "_class", "type" : "option", "intro" : "
Deprecated alternative for _tag.
\n", "id" : "id968", "params" : "$tags|\\@tags" }, "id1055" : { "name" : "tag", "type" : "default", "value" : "undef",
"id" : "id1055"
},
"id1335" : {
"name" : "INHERITANCE",
"level" : 1,
"path" : "INHERITANCE",
"id" : "id1335",
"intro" : "Log::Report::Translator::POT\n is a Log::Report::Translator\n\n", "type" : "chapter" }, "id65" : { "level" : 2, "name" : "Attributes", "subroutines" : [ "id67", "id68", "id70", "id66" ], "id" : "id65", "type" : "section", "path" : "METHODS/Attributes" }, "id982" : { "level" : 2, "name" : "Attributes", "subroutines" : [ "id989", "id991", "id986", "id984", "id993", "id994", "id985", "id995", "id987", "id992", "id990", "id983", "id988" ], "id" : "id982", "type" : "section", "path" : "METHODS/Attributes" }, "id471" : { "name" : "cannot read mo from file $fn: $!", "subroutine" : "id467", "type" : "fault", "id" : "id471" }, "id529-id354" : { "intro" : "
Inherited, see Log::Report::Extract::domains()
", "id" : "id529-id354", "type" : "i_method", "call" : "$obj->domains", "extends" : "id529", "name" : "domains" }, "id149" : { "id" : "id149", "intro" : "Returns the classes which loaded the optional module.
\n", "type" : "c_method", "call" : "$class->usedBy", "name" : "usedBy" }, "id1170-id905" : { "name" : "mode", "intro" : "Inherited, see Log::Report::Dispatcher::new(mode)
", "extends" : "id1170", "value" : "'NORMAL'", "type" : "default", "id" : "id1170-id905" }, "id1018" : { "id" : "id1018", "intro" : "With Locale::TextDomain, you have to do
\n\n use Locale::TextDomain;\n print __nx(\n \"One file has been deleted.\\n\",\n \"{num} files have been deleted.\\n\",\n $num_files,\n num => $num_files,\n );\n\n\nWith Log::Report, you can do
\n use Log::Report;\n print __nx(\n \"One file has been deleted.\\n\",\n \"{_count} files have been deleted.\\n\",\n $num_files,\n );\n\n\nOf course, you need to be aware that the name used to reference the\ncounter is fixed to _count. The first example works as well, but\nis more verbose.
Indicates whether variables are to be filled-in; whether __x or __ was\nused to define the message.
Inherited, see Log::Report::Minimal::Domain::configure(where)
" }, "id281" : { "name" : "Session serialization", "level" : 3, "path" : "DETAILS/Setup and Configuration/Session serialization", "id" : "id281", "intro" : "The Dancer2 session is used to maintain Log::Report::Message objects.\nHowever, the session is stored in the database in serialized form\n(usually in JSON syntax). To make this work, the message objects\nneed to be frozen.
\n\nAdd this to your config:
\n\n engines:\n session:\n DBIC:\n ...\n serializer: JSON\n serialize_options:\n allow_tags: 1\n deserialize_options:\n allow_tags: 1\n\n", "type" : "subsection" }, "id794" : { "value" : "'ALL'", "type" : "default", "id" : "id794", "name" : "accept" }, "id827" : { "intro" : "
In SCALAR context, only one dispatcher name accepted The dispatcher()\nmethod returns the Log::Report::Dispatcher objects which it has accessed.\nWhen multiple names where given, it wishes to return a LIST of objects,\nnot the count of them.
\n", "id" : "id827", "type" : "error", "subroutine" : "id825", "name" : "only one dispatcher name accepted in SCALAR context." }, "id1242" : { "name" : "report_opts", "call" : "$obj->report_opts", "id" : "id1242", "type" : "i_method" }, "id414" : { "type" : "error", "id" : "id414", "name" : "superfluous positional parameters for '$msgid'", "subroutine" : "id412" }, "id172-id385" : { "extends" : "id172", "name" : "interpolate", "id" : "id172-id385", "intro" : "Inherited, see Log::Report::Minimal::Domain::interpolate()
", "type" : "i_method", "call" : "$obj->interpolate( $msgid, [$args] )" }, "id1166-id1091" : { "extends" : "id1166", "type" : "default", "id" : "id1166-id1091", "value" : "depend on mode",
"name" : "accept",
"intro" : "Inherited, see Log::Report::Dispatcher::new(accept)
" }, "id332" : { "id" : "id332", "intro" : "By default, all filenames from the INCLUDE_PATH directories which match\nthe filename_match are processed, but you may explicitly create a\nsubset by hand.
\n", "type" : "option", "params" : "$file|\\@files", "name" : "filenames" }, "id540-id493" : { "extends" : "id540", "id" : "id540-id493", "type" : "i_method", "call" : "$obj->store( $domain, $filename, $linenr, $context, $msg, [$msg_plural] )", "diagnostics" : [ "id541-id493" ], "name" : "store", "intro" : "Inherited, see Log::Report::Extract::store()
" }, "id755-id461" : { "intro" : "Inherited, see Log::Report::Lexicon::Table::nrPlurals()
", "id" : "id755-id461", "type" : "i_method", "call" : "$obj->nrPlurals", "name" : "nrPlurals", "extends" : "id755" }, "id1239" : { "params" : "Log::Report::Message", "id" : "id1239", "type" : "option", "name" : "message" }, "id584" : { "name" : "NAME", "level" : 1, "path" : "NAME", "intro" : "Log::Report::Translator::Context - handle translation contexts
\n", "id" : "id584", "type" : "chapter" }, "id539" : { "subroutine" : "id538", "name" : "starting new textdomain $domain, template in $filename", "id" : "id539", "type" : "info" }, "id299" : { "id" : "id299", "inheritance" : { "extends" : [ "Template" ] }, "title" : "Template Toolkit with translations", "is_pure_pod" : false, "distribution" : "Log-Report-Template", "package" : "Log::Report::Template", "version" : "1.05", "chapters" : [ "id300", "id1341", "id301", "id302", "id303", "id341" ], "name" : "Log::Report::Template" }, "id1179-id760" : { "extends" : "id1179", "name" : "name", "intro" : "Inherited, see Log::Report::Dispatcher::name()
", "type" : "i_method", "id" : "id1179-id760", "call" : "$obj->name" }, "id731" : { "nest" : [ "id732", "id734" ], "id" : "id731", "type" : "chapter", "level" : 1, "name" : "METHODS", "path" : "METHODS" }, "id1165-id1021" : { "id" : "id1165-id1021", "intro" : "Inherited, see Log::Report::Dispatcher::new(accept)
", "type" : "option", "params" : "$reasons|\\@reasons", "extends" : "id1165", "name" : "accept" }, "id632" : { "intro" : "As SCALAR, this contains a blank separated list of @locations.\nThe @locations are of the form filename:linenumber, for\ninstance lib/Foo.pm:42\nSee addReferences()
Inherited, see Log::Report::Dispatcher::stackTraceLine(abstract)
", "extends" : "id1209", "id" : "id1209-id1091", "type" : "default", "value" : "1" }, "id948" : { "name" : "_domain", "type" : "option", "intro" : "The text-domain (translation table) to which this _msgid belongs.
\n\nWith this parameter, your can \"borrow\" translations from other textdomains.\nBe very careful with this (although there are good use-cases) The xgettext\nmsgid extractor may add the used msgid to this namespace as well. To\navoid that, add a harmless '+':
\n\n print __x(+\"errors\", _domain => 'global');\n\n\n
The extractor will not take the msgid when it is an expression. The '+'\nhas no effect on the string at runtime.
\n", "id" : "id948", "params" : "$name|$object" }, "id520" : { "intro" : "The place where the lexicon is kept. When no lexicon is defined yet,\nthis will be the $directory where an domain/xx.po file will be created.
Inherited, see Log::Report::Lexicon::Table::setupPluralAlgorithm()
", "type" : "error" }, "id279" : { "id" : "id279", "intro" : "Set up Dancer2::Logger::LogReport by adding it to your Dancer2\napplication configuration (see manual Dancer2::Config). By default,\nall messages will go to STDERR.
\n\nTo get all message out \"the Perl way\" (using print, warn and die) just use
\n\n logger: \"LogReport\"\n\n\n
At start, these are handled by a Log::Report::Dispatcher::Perl object,\nnamed 'default'. If you open a new dispatcher with the name 'default',\nthe output via the perl mechanisms will be stopped.
\n\nTo also send messages to your syslog:
\n\n logger: \"LogReport\"\n\n engines:\n logger:\n LogReport:\n log_format: %a%i%m # See Dancer2::Logger::LogReport\n app_name: MyApp\n dispatchers:\n default: # Name\n type: SYSLOG # Log::Reporter::dispatcher() options\n identity: myapp\n facility: local0\n flags: \"pid ndelay nowait\"\n mode: DEBUG\n\n\n
To send messages to a file:
\n\n logger: \"LogReport\"\n\n engines:\n logger:\n LogReport:\n log_format: %a%i%m # See Dancer2::Logger::LogReport\n app_name: MyApp\n dispatchers:\n logfile: # \"default\" dispatcher stays open as well\n type: FILE\n to: /var/log/myapp.log\n charset: utf-8\n mode: DEBUG\n\n\n
See Log::Report::Dispatcher for full details of options.
\n\nFinally: a Dancer2 script may run many applications. Each application\ncan have its own logger configuration. However, Log::Report dispatchers\nare global, so will be shared between Dancer2 applications. Any attempt\nto create a new Log::Report dispatcher by the same name (as will happen\nwhen a new Dancer2 application is started with the same configuration)\nwill be ignored.
\n", "type" : "subsection", "path" : "DETAILS/Setup and Configuration/Dancer2::Logger::LogReport", "level" : 3, "name" : "Dancer2::Logger::LogReport" }, "id553" : { "path" : "FUNCTIONS", "subroutines" : [ "id554", "id558", "id555", "id559", "id556", "id557", "id560" ], "type" : "chapter", "id" : "id553", "name" : "FUNCTIONS", "level" : 1 }, "id1172-id780" : { "name" : "format_reason", "intro" : "Inherited, see Log::Report::Dispatcher::new(format_reason)
", "extends" : "id1172", "type" : "default", "value" : "'LOWERCASE'", "id" : "id1172-id780" }, "id1186-id1091" : { "name" : "log", "extends" : "id1186", "type" : "i_method", "intro" : "Inherited, see Log::Report::Dispatcher::log()
", "id" : "id1186-id1091", "call" : "$obj->log( \\%options, $reason, $message, $domain )" }, "id1185-id1021" : { "call" : "$obj->close", "intro" : "Inherited, see Log::Report::Dispatcher::close()
", "id" : "id1185-id1021", "type" : "i_method", "extends" : "id1185", "name" : "close" }, "id1013" : { "name" : "Why use format strings?", "level" : 2, "path" : "DETAILS/Why use format strings?", "type" : "section", "intro" : "Simple perl scripts will use print() with variables in the string.\nHowever, when the content of the variable gets more unpredictable or\nneeds some pre-processing, then it gets tricky. When you do want to\nintroduce translations (in the far future of your successful project)\nit gets impossible. Let me give you some examples:
\n print \"product: $name\\n\"; # simple perl\n\n # Will not work because \"$name\" is interpolated too early\n print translate(\"product: $name\"), \"\\n\";\n\n # This is the gettext solution, with formats\n printf translate(\"product: %s\\n\"), $name;\n\n # With named in stead of positional parameters\n print translate(\"product: {p}\\n\", p => $name);\n\n # With Log::Report, the translate() is hidden in __x()\n print __x\"product: {p}\\n\", p => $name;\n\n\nBesides making translation possible, interpolation via format strings\nis much cleaner than in the simpelest perl way. For instance, these\ncases:
\n\n # Safety measures while interpolation\n my $name = undef;\n print \"product: $name\\n\"; # uninitialized warning\n print __x\"product: {p}\\n\", p => $name; # --> product: undef\n\n # Interpolation of more complex data\n my @names = qw/a b c/;\n print \"products: \", join(', ', @names), \"\\n\";\n print __x\"products: {p}\\n\", p => \\@names;\n\n # Padded values hard to do without format strings\n print \"padded counter: \", ' ' x (6-length $c), \"$c\\n\";\n printf \"padded counter: %6d\\n\", $counter;\n print __x\"padded counter: {c%6d}\\n\", c => $counter;\n\n\nSo: using formats has many advantages. Advice: use simple perl only in\ntrace and assert messages, maybe also with panics. For serious output\nof your program, use formatted output.
created internally",
"id" : "id1135"
},
"id169" : {
"id" : "id169",
"value" : "PRINTI",
"type" : "default",
"name" : "formatter"
},
"id774" : {
"value" : "[]",
"id" : "id774",
"type" : "default",
"name" : "callbacks"
},
"id612" : {
"name" : "NAME",
"level" : 1,
"path" : "NAME",
"intro" : "Log::Report::Lexicon::PO - one translation definition
\n", "type" : "chapter", "id" : "id612" }, "id491" : { "name" : "msgid", "intro" : "Lookup the translations with the STRING. Returns a SCALAR, when only\none translation is known, and an ARRAY when we have plural forms.\nReturns undef when the translation is not defined.
Returns a HASH of all defined PO objects, organized by msgid. Please try\nto avoid using this: use msgid() for lookup and add() for adding\ntranslations.
\n", "id" : "id711", "type" : "i_method", "name" : "index" }, "id1199-id1091" : { "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(linenr)
", "name" : "linenr", "value" : "<required>", "id" : "id1199-id1091", "type" : "default", "extends" : "id1199" }, "id1210" : { "level" : 1, "name" : "DETAILS", "path" : "DETAILS", "nest" : [ "id1211", "id1212" ], "type" : "chapter", "id" : "id1210" }, "id966" : { "id" : "id966", "intro" : "Deprecated alternative for _tag.
\n", "type" : "option", "params" : "$tags|\\@tags", "name" : "_classes" }, "id600" : { "id" : "id600", "type" : "error", "name" : "tags value must have form `a=b', found `$this' in `$source'", "subroutine" : "id599" }, "id519" : { "name" : "new", "diagnostics" : [ "id524", "id525" ], "call" : "$class->new( %options )", "type" : "c_method", "id" : "id519", "options" : [ [ "id522", "id523" ], [ "id520", "id521" ] ] }, "id530-id354" : { "extends" : "id530", "name" : "pots", "intro" : "Inherited, see Log::Report::Extract::pots()
", "id" : "id530-id354", "type" : "i_method", "call" : "$obj->pots( $domain )" }, "id312" : { "name" : "translate_to", "type" : "option", "intro" : "Globally set the output language of template processing. Usually, this\nis derived from the logged-in user setting or browser setting.\nSee translateTo().
\n", "id" : "id312", "params" : "LANGUAGE" }, "id300" : { "path" : "NAME", "type" : "chapter", "intro" : "Log::Report::Template - Template Toolkit with translations
\n", "id" : "id300", "name" : "NAME", "level" : 1 }, "id434" : { "path" : "METHODS/Attributes", "type" : "section", "id" : "id434", "subroutines" : [ "id435", "id436" ], "name" : "Attributes", "level" : 2 }, "id489" : { "id" : "id489", "intro" : "Returns the character-set as found in the PO-file. The strings are\nconverted into utf8 before you use them in the program.
\n", "type" : "i_method", "call" : "$obj->originalCharset", "name" : "originalCharset" }, "id88" : { "type" : "example", "intro" : " # positional parameters\n my $x = sprintp \"dumpfiles: %s\\n\", \\@dumpfiles, _join => ':';\n\n # is rewritten into, and then processed as\n my $x = sprinti \"dumpfiles: {_1}\\n\", _1 => \\@dumpfiles, _join => ':';\n\n",
"id" : "id88",
"name" : "of the rewrite\n"
},
"id1152-id385" : {
"call" : "$obj->defaultContext",
"intro" : "Inherited, see Log::Report::Domain::defaultContext()
", "id" : "id1152-id385", "type" : "i_method", "extends" : "id1152", "name" : "defaultContext" }, "id1060" : { "level" : 1, "name" : "NAME", "intro" : "MojoX::Log::Report - divert log messages into Log::Report
\n", "type" : "chapter", "id" : "id1060", "path" : "NAME" }, "id1198-id905" : { "params" : "INTEGER", "id" : "id1198-id905", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(linenr)
", "type" : "option", "name" : "linenr", "extends" : "id1198" }, "id269" : { "name" : "error", "type" : "i_method", "id" : "id269", "call" : "$obj->error" }, "id441" : { "version" : "1.16", "chapters" : [ "id442", "id443", "id444", "id445", "id456" ], "name" : "Log::Report::Lexicon::Index", "id" : "id441", "inheritance" : {}, "title" : "search through available translation files", "is_pure_pod" : false, "package" : "Log::Report::Lexicon::Index", "distribution" : "Log-Report-Lexicon" }, "id92" : { "name" : "Interpolation: keys", "level" : 2, "path" : "DETAILS/Interpolation: keys", "intro" : "A key is a bareword (like a variable name) or a list of barewords\nseparated by dots (no blanks!)
\n\nPlease use explanatory key names, to help the translation\nprocess once you need that (in the future).
\n", "nest" : [ "id93", "id94" ], "type" : "section", "id" : "id92" }, "id1288" : { "id" : "id1288", "type" : "chapter", "nest" : [ "id1289" ], "path" : "DETAILS", "level" : 1, "name" : "DETAILS" }, "id764" : { "name" : "METHODS", "level" : 1, "path" : "METHODS", "nest" : [ "id765", "id776", "id778" ], "type" : "chapter", "id" : "id764" }, "id179" : { "type" : "section", "id" : "id179", "subroutines" : [ "id180", "id187", "id188" ], "path" : "FUNCTIONS/Report Production and Configuration", "level" : 2, "name" : "Report Production and Configuration" }, "id1197" : { "value" : "<required>", "id" : "id1197", "type" : "default", "name" : "filename" }, "id1182-id1021" : { "id" : "id1182-id1021", "intro" : "Inherited, see Log::Report::Dispatcher::isDisabled()
", "type" : "i_method", "call" : "$obj->isDisabled", "extends" : "id1182", "name" : "isDisabled" }, "id1132" : { "name" : "contextRules", "type" : "i_method", "id" : "id1132", "call" : "$obj->contextRules" }, "id915" : { "intro" : "Any combination of $flags as defined by Sys::Syslog, as comma-separated\nstring. Examples for flags are: pid, ndelay, and nowait.
Log::Report::Translator::POT - translation based on POT files
\n", "id" : "id423", "path" : "NAME", "level" : 1, "name" : "NAME" }, "id976" : { "id" : "id976", "intro" : "[1.00] Set the @keywords which can be used to select alternatives\nbetween translations. Read the DETAILS section in\nLog::Report::Translator::Context
\n", "type" : "option", "params" : "$keyword|\\@keywords", "name" : "_context" }, "id1187-id1066" : { "extends" : "id1187", "name" : "translate", "intro" : "Inherited, see Log::Report::Dispatcher::translate()
", "type" : "i_method", "id" : "id1187-id1066", "call" : "$obj->translate( \\%options, $reason, $message )" }, "id317" : { "level" : 2, "name" : "Attributes", "type" : "section", "id" : "id317", "subroutines" : [ "id318", "id319" ], "path" : "METHODS/Attributes" }, "id450" : { "name" : "Search", "level" : 2, "path" : "METHODS/Search", "type" : "section", "id" : "id450", "subroutines" : [ "id451", "id452", "id454", "id453" ] }, "id1208-id905" : { "params" : "INTEGER", "type" : "option", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(abstract)
", "id" : "id1208-id905", "name" : "abstract", "extends" : "id1208" }, "id953-id221" : { "intro" : "Inherited, see Log::Report::Message::new(_plural)
", "name" : "_plural", "type" : "default", "value" : "undef",
"id" : "id953-id221",
"extends" : "id953"
},
"id617" : {
"call" : "$class->new( %options )",
"diagnostics" : [
"id636"
],
"options" : [
[
"id630",
"id631"
],
[
"id626",
"id627"
],
[
"id634",
"id635"
],
[
"id628",
"id629"
],
[
"id624",
"id625"
],
[
"id618",
"id619"
],
[
"id620",
"id621"
],
[
"id622",
"id623"
],
[
"id632",
"id633"
]
],
"type" : "c_method",
"id" : "id617",
"name" : "new"
},
"id1263" : {
"level" : 1,
"name" : "FUNCTIONS",
"type" : "chapter",
"id" : "id1263",
"subroutines" : [
"id1267",
"id1264"
],
"path" : "FUNCTIONS"
},
"id998" : {
"name" : "taggedWith",
"type" : "i_method",
"intro" : "[1.44] Returns true if the message carries the specified $tag (string) or\nmatches the Regexp. The trueth value is the (first matching) tag.
Label to indicate that the string is a text which will be translated\nlater. The function itself does nothing. See also N__w().
\n\nThis no-op function is used as label to the xgettext program to build the\ntranslation tables.
\n", "type" : "function", "id" : "id855", "call" : "N__( $msgid )" }, "id1149" : { "id" : "id1149", "intro" : " use Log::Report 'my-domain', context_rules => {};\n\n",
"type" : "example"
},
"id1207" : {
"name" : "max_params",
"value" : "8",
"type" : "default",
"id" : "id1207"
},
"id753-id461" : {
"name" : "setupPluralAlgorithm",
"intro" : "Inherited, see Log::Report::Lexicon::Table::setupPluralAlgorithm()
", "extends" : "id753", "id" : "id753-id461", "type" : "i_method", "diagnostics" : [ "id754-id461" ], "call" : "$obj->setupPluralAlgorithm" }, "id1259" : { "name" : "Log::Report::Die", "chapters" : [ "id1260", "id1355", "id1261", "id1262", "id1263" ], "version" : "1.46", "distribution" : "Log-Report", "package" : "Log::Report::Die", "is_pure_pod" : false, "title" : "compatibility routines with Perl's die/croak/confess", "id" : "id1259", "inheritance" : { "extends" : [ "Exporter" ] } }, "id310" : { "name" : "modifiers", "params" : "\\@modifiers", "intro" : "Add @modifiers to the default set. Modifiers are part of the\nformatting process, when values get inserted in the translated string.\nRead Formatter value modifiers.
\n", "id" : "id310", "type" : "option" }, "id302" : { "level" : 1, "name" : "DESCRIPTION", "intro" : "This module extends Template, which is the core of Template Toolkit.\nThe main addition is support for translations via the translation\nframework offered by Log::Report.
\n\nYou add translations to a template system, by adding calls to some\ntranslation function (by default called loc()) to your template text.\nThat function will perform dark magic to collect the translation from\ntranslation tables, and fill in values. For instance:
\n [% price = 3.14 %]\n <divE<gt>Price: [% price %]</divE<gt> # no translation\n <divE<gt>[% loc(\"Price: {price}\") %]</divE<gt> # translation optional\n\n\nIt's quite a lot of work to make your templates translatable.\nPlease read the DETAILS section before you start using this module.
\n", "id" : "id302", "type" : "chapter", "path" : "DESCRIPTION" }, "id1202-id760" : { "extends" : "id1202", "name" : "params", "id" : "id1202-id760", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(params)
", "type" : "option", "params" : "ARRAY" }, "id610" : { "path" : "DETAILS/Using context_rules/Configuration", "intro" : "The tools which handle translations expect the msgctxt to be static.\nFor instance, contain a filename where the string is used to disambigue\naccidental collissions of the use of the same msgid for different\npurposes.
\n\nNow, we have designed far more flexible contexts. We need to generate all\npossible msgctxt values while extracting msgids to update the PO-files.\nTherefore, we need a map-file.
\n\nThe context maps are included in a configuration file which is passed to\nxgettext-perl and to the program which uses contexts.\nSee Log::Report::Domain::readConfig().
\n\nExample of such configuration file: (JSON syntax and Perl syntax)
\n\n === JSON === ==== Perl == =\n {{\n \"context_rules\" : { context_rules => {\n \"gender\" : [ gender => [\n \"male\", 'male',\n \"female\" 'female'\n ] ]\n } }\n } }\n\n\nor
\n\n { {\n \"context_rules\" : { context_rules => {\n \"gender\" : { gender => {\n \"alternatives\" : [ alternatives => [\n \"male\", 'male',\n \"female\", 'female',\n \"unknown\" 'unknown'\n ] ]\n ... more config for 'gender' ...\n } }\n } }\n } }\n\n\nAs \"alternatives\", we list the alternatives as known by the application\ninternals. Each msgid which contains a {<gender} mark will be\nreplicated three times, in each language table. Each copy will be marked\nwith a different value from \"alternatives\".
However, languages differ. For instance, in some language we may address\nthe unknown gender as being a male person. In other languages, the\ntranslation can express this \"unknown\" personality. To get this to work,\nyou can use the msgctxt construct.
The default msgctxt, as used in the previous example, is simply mapping\nthe alternatives directly on msgctxt values which are the same:
\n { { context_rules =>\n \"context_rules\" : { { gender =>\n \"gender\" : { { default => { qw/\n \"default\" : { female female\n \"female\" : \"female\", male male\n \"male\" : \"male\" unknown male / }\n \"unknown\" : \"male\", , 'nl,de' => { qw/\n }, unknown x / }\n \"nl,de\" : {\n \"unknown\" : \"x\"\n } }\n ... more configuration ...\n }\n ... more context rules ...\n } }\n } }\n\n\nBy default, there will only be two msgid copies in a language file,\nbecause at run-time the \"unknown\" is mapped on \"male\". An exception\nfor the Dutch (nl*) and German (de*) tables, which apparently support\nthe third gender.
\n\nIf you are not interested for a certain tag, then put it on 'IGNORE'\nas default or for your language.
\n\n \"default\" : \"IGNORE\", default => 'IGNORE'\n \"nl\": \"IGNORE\" nl => 'IGNORE'\n\n", "id" : "id610", "type" : "subsection", "name" : "Configuration", "level" : 3 }, "id509" : { "type" : "info", "id" : "id509", "name" : "processing file $fn in $charset.", "subroutine" : "id504" }, "id701" : { "id" : "id701", "type" : "error", "name" : "unsupported charset $charset in $fn.", "subroutine" : "id695" }, "id457" : { "id" : "id457", "intro" : "
By default, the filename which contains the package which contains the\ntextdomain's translator configuration is taken (that can be only one)\nand changed into a directory name. The path is then extended with messages\nto form the root of the lexicon: the top of the index. After this,\nthe locale indication, the lc-category (usually LC_MESSAGES), and\nthe textdomain followed by .po are added. This is exactly as\ngettext(1) does, but then using the PO text file instead of the MO\nbinary file.
Inherited, see Log::Report::Dispatcher::stackTraceLine(linenr)
", "type" : "option" }, "id76" : { "name" : "sprinti", "call" : "sprinti( $format, %data|\\%data|OBJECT, %options )", "options" : [ [ "id83", "id84" ], [ "id77", "id78" ], [ "id79", "id80" ], [ "id81", "id82" ] ], "id" : "id76", "intro" : "The $format refers to some string, maybe the result of a translation.
\n\nThe %data (which may be passed as LIST, HASH, or blessed HASH) contains\na mixture of special and normal variables to be filled in. The names\nof the special variables (the %options) start with an underscore (_).
false",
"type" : "default",
"name" : "include_domain"
},
"id1277" : {
"name" : "Why use format strings?",
"level" : 2,
"path" : "DETAILS/Why use format strings?",
"id" : "id1277",
"type" : "section"
},
"id329" : {
"name" : "charset",
"type" : "default",
"value" : "'UTF-8'",
"id" : "id329"
},
"id629" : {
"id" : "id629",
"value" : "false",
"type" : "default",
"name" : "fuzzy"
},
"id1192-id760" : {
"call" : "$any->collectLocation",
"intro" : "Inherited, see Log::Report::Dispatcher::collectLocation()
", "id" : "id1192-id760", "type" : "ci_method", "name" : "collectLocation", "extends" : "id1192" }, "id1318" : { "path" : "METHODS/Constructors", "subroutines" : [ "id1086-id542" ], "id" : "id1318", "type" : "section", "name" : "Constructors", "level" : 2 }, "id522" : { "params" : "$charset", "intro" : "The character-set used in the PO files.
\n", "type" : "option", "id" : "id522", "name" : "charset" }, "id1208-id1217" : { "extends" : "id1208", "name" : "abstract", "id" : "id1208-id1217", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(abstract)
", "type" : "option", "params" : "INTEGER" }, "id1355" : { "name" : "INHERITANCE", "level" : 1, "path" : "INHERITANCE", "type" : "chapter", "intro" : "Log::Report::Die\n is an Exporter\n\n", "id" : "id1355" }, "id1000-id221" : { "call" : "$obj->toString( [$locale] )", "id" : "id1000-id221", "intro" : "
Inherited, see Log::Report::Message::toString()
", "type" : "i_method", "extends" : "id1000", "name" : "toString" }, "id258" : { "name" : "fatal_handler", "intro" : "fatal_handler() allows alternative handlers to be defined in place of (or in\naddition to) the default redirect handler that is called on a fatal error.
Calls should be made with 1 parameter: the subroutine to call in the case of a\nfatal error. The subroutine is passed 3 parameters: the DSL, the message in\nquestion, and the reason. The subroutine should return true or false depending\non whether it handled the error. If it returns false, the next fatal handler is\ncalled, and if there are no others then the default redirect fatal handler is\ncalled.
[1.09] see hide()
\n", "id" : "id1035", "type" : "option", "name" : "hide" }, "id1113" : { "type" : "error", "id" : "id1113", "name" : "cannot rotate log file which was opened as file-handle", "subroutine" : "id1112" }, "id607" : { "intro" : "You can use contexts to set global interpolation parameters. For instance,\nrunning a pure perl webserver, you may serve multiple domains. Some of\nthe log messages may need to show that domain name. Of course, you can\ncollect (or pass on) the hostname when throwing the error... something\nlike this:
\n\n # can I access $vhost easily?\n error __x\"For {host}, login failed for {user}\",\n host => $vhost->name, user => $user;\n\n\nVia contexts:
\n\n # when you know the vhost: (max once per request)\n textdomain->setContext(host => $vhost->name); # or updateContext\n\n # until you reconfigure the context\n error __x\"For {_context.host}, login failed for {user}\", user => $user;\n\n\nThe context values are always available for interpolation.
\n", "type" : "subsection", "id" : "id607", "path" : "DETAILS/Using context_rules/Global parameters", "level" : 3, "name" : "Global parameters" }, "id452" : { "call" : "$obj->addFile( $basename, [$absolute] )", "intro" : "Add a certain file to the index. This method returns the $absolute\npath to that file, which must be used to access it. When not explicitly\nspecified, the $absolute path will be calculated.
\n", "type" : "i_method", "id" : "id452", "name" : "addFile" }, "id933" : { "name" : "Logging", "level" : 2, "path" : "METHODS/Logging", "subroutines" : [ "id1186-id905", "id1189-id905", "id1188-id905", "id1185-id905", "id1192-id905", "id1191-id905", "id1193-id905", "id1187-id905", "id934" ], "id" : "id933", "type" : "section" }, "id307" : { "name" : "processing_errors", "value" : "'NATIVE'", "id" : "id307", "type" : "default" }, "id1352" : { "name" : "INHERITANCE", "level" : 1, "path" : "INHERITANCE", "type" : "chapter", "intro" : "Log::Report\n is an Exporter\n\n", "id" : "id1352" }, "id905" : { "title" : "send messages to syslog", "inheritance" : { "extends" : [ "Log::Report::Dispatcher" ] }, "id" : "id905", "package" : "Log::Report::Dispatcher::Syslog", "distribution" : "Log-Report", "is_pure_pod" : false, "version" : "1.46", "chapters" : [ "id906", "id1328", "id907", "id908", "id909", "id1283" ], "name" : "Log::Report::Dispatcher::Syslog" }, "id1032" : { "value" : "[]", "id" : "id1032", "type" : "default", "name" : "exceptions" }, "id537-id354" : { "name" : "showStats", "extends" : "id537", "intro" : "
Inherited, see Log::Report::Extract::showStats()
", "type" : "i_method", "id" : "id537-id354", "call" : "$obj->showStats( [$domains] )" }, "id1195-id760" : { "extends" : "id1195", "type" : "default", "id" : "id1195-id760", "value" : "<required>", "name" : "package", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(package)
" }, "id77" : { "params" : "INTEGER", "intro" : "Result of the translation process: when Log::Report::__xn() is\nare used for count-sensitive translation. Those function may add\nmore specials to the parameter list.
\n", "id" : "id77", "type" : "option", "name" : "_count" }, "id1049" : { "call" : "$obj->reportFatal( %options )", "intro" : "Re-cast only the fatal message to the defined dispatchers. If the\nblock was left without problems, then nothing will be done. The %options\nwill end-up as HASH of %options to Log::Report::report(); see\nLog::Report::Exception::throw() which does the job.
\n", "id" : "id1049", "type" : "i_method", "name" : "reportFatal" }, "id1227" : { "level" : 1, "name" : "SYNOPSIS", "type" : "chapter", "intro" : " # created within a try block\n try { error \"help!\" };\n my $exception = $@->wasFatal;\n $exception->throw if $exception;\n\n $@->reportFatal; # combination of above two lines\n\n my $message = $exception->message; # the Log::Report::Message\n\n if($message->taggedWith('die')) ...\n if($exception->taggedWith('die')) ... # same\n if($@->wasFatal(tag => 'die')) ... # same\n\n",
"id" : "id1227",
"path" : "SYNOPSIS"
},
"id527" : {
"name" : "index",
"call" : "$obj->index",
"intro" : "Returns the Log::Report::Lexicon::Index object, which is listing\nthe files in the lexicon directory tree.
\n", "type" : "i_method", "id" : "id527" }, "id158" : { "type" : "default", "value" : "<required>", "id" : "id158", "name" : "name" }, "id726" : { "call" : "$obj->stats", "intro" : "Returns a HASH with some statistics about this POT table.
\n", "id" : "id726", "type" : "i_method", "name" : "stats" }, "id1160" : { "intro" : "use Log::Report;\n\n # The following will be created for you automatically\n dispatcher 'PERL', 'default', accept => 'NOTICE-';\n dispatcher close => 'default'; # after deamonize\n\n dispatcher 'FILE', 'log',\n mode => 'DEBUG', to => '/var/log/mydir/myfile';\n\n # Full package name is used, same as 'FILE'\n dispatcher Log::Report::Dispatch::File => 'stderr',\n to => \\*STDERR, accept => 'NOTICE-';\n\n", "id" : "id1160", "type" : "chapter", "path" : "SYNOPSIS", "level" : 1, "name" : "SYNOPSIS" }, "id383" : { "path" : "DETAILS/Scan Patterns/Predefined for Template-Toolkit", "type" : "subsection", "intro" : "
There is not a single convention for translations in Template-Toolkit\n(see Template), so you need to specify which version TT you use and\nwhich function name you want to use. In extreme cases, you may even build\nseparate translation tables by simply providing using functions.
For instance
\n\n pattern => 'TT2-loc'\n\n\n
will scan for
\n\n [% loc(\"msgid\", key => value, ...) %]\n [% loc('msgid', key => value, ...) %]\n [% loc(\"msgid|plural\", count, key => value, ...) %]\n\n [% INCLUDE\n title = loc('something')\n %]\n\n [% | loc(n => name) %]hi {n}[% END %]\n [% 'hi {n}' | loc(n => name) %]\n\n\nFor TT1, the brackets can either be '[%...%]' or '%%...%%'. The function\nname is treated case-sensitive. Some people prefer 'l()' or 'L()'.
The code needed
\n\n # during initiation of the webserver, once in your script (before fork)\n my $lexicons = 'some-directory-for-translation-tables';\n my $pots = Log::Report::Translator::POT->new(lexicons => $lexicons);\n\n my $templater = Log::Report::Template->new(...);\n my $domain = $templater->addTextdomain(\n name => $domainname,\n function => 'loc',\n );\n $domain->configure(translator => $pots);\n\n # part of the processing per page\n $vars{translate_to} = 'nl_NL.utf8';\n $templater->process($template, \\%vars, \\$output);\n\n\nTo generate the pod tables, run in the shell something like
\n\n xgettext-perl -p $lexicons --template TT2-loc \\\n --domain $textdomain $templates_dir\n\n\n
If you want to implement your own extractor --to avoid xgettext-perl--\nyou need to run something like this:
\n my $extr = Log::Report::Template::Extract->new(\n lexicon => $output,\n charset => 'utf-8',\n domain => $domain,\n pattern => 'TT2-loc',\n );\n $extr->process($_) for @filenames;\n $extr->write;\n\n", "id" : "id383", "name" : "Predefined for Template-Toolkit", "level" : 3 }, "id1205-id760" : { "extends" : "id1205", "type" : "default", "id" : "id1205-id760", "value" : "
undef",
"name" : "max_line",
"intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(max_line)
" }, "id1097" : { "name" : "new", "diagnostics" : [ "id1105", "id1106" ], "call" : "$class->new( $type, $name, %options )", "options" : [ [ "id1165-id1091", "id1166-id1091" ], [ "id1173-id1091", "id1102" ], [ "id1103", "id1104" ], [ "id1171-id1091", "id1172-id1091" ], [ "id1167-id1091", "id1168-id1091" ], [ "id1169-id1091", "id1170-id1091" ], [ "id1100", "id1101" ], [ "id1098", "id1099" ] ], "id" : "id1097", "type" : "c_method" }, "id839" : { "call" : "error( $message )", "intro" : "Short for report ERROR => $message
The dispatcher type, which is usually the same as the class of this\nobject, but not in case of wrappers like for Log::Dispatch.
\n", "type" : "i_method", "id" : "id1180", "call" : "$obj->type", "name" : "type" }, "id728" : { "intro" : "Log::Report::Lexicon - translation component of Log::Report
\n", "id" : "id728", "type" : "chapter", "path" : "NAME", "level" : 1, "name" : "NAME" }, "id853" : { "name" : "how to use__nx()\n",
"intro" : " print __nx \"one file\", \"{_count} files\", $nr_files;\n print __nx \"one file\", \"{_count} files\", @files;\n\n local $\" = ', ';\n print __nx \"one file: {f}\", \"{_count} files: {f}\", @files, f => \\@files;\n\n",
"id" : "id853",
"type" : "example"
},
"id1170-id1217" : {
"intro" : "Inherited, see Log::Report::Dispatcher::new(mode)
", "name" : "mode", "id" : "id1170-id1217", "type" : "default", "value" : "'NORMAL'", "extends" : "id1170" }, "id354" : { "chapters" : [ "id355", "id1360", "id356", "id357", "id358", "id381" ], "name" : "Log::Report::Template::Extract", "version" : "1.05", "distribution" : "Log-Report-Template", "package" : "Log::Report::Template::Extract", "is_pure_pod" : false, "title" : "collect translatable strings from template files", "inheritance" : { "extends" : [ "Log::Report::Extract" ] }, "id" : "id354" }, "id156" : { "examples" : [ "id159" ], "options" : [ [ "id157", "id158" ] ], "type" : "c_method", "id" : "id156", "diagnostics" : [ "id160" ], "call" : "$class->new( %options )", "name" : "new" }, "id820" : { "name" : "for use of report()\n", "id" : "id820", "intro" : " # long syntax example\n report TRACE => \"start processing now\";\n report INFO => '500: ' . __'Internal Server Error';\n\n # explicit dispatcher, no translation\n report {to => 'syslog'}, NOTICE => \"started process $$\";\n notice \"started process $$\", _to => 'syslog'; # same\n\n # short syntax examples\n trace \"start processing now\";\n warning __x'Disk {percent%.2f}% full', percent => $p\n if $p > 97;\n\n # error message, overruled to be printed in Brazilian\n report {locale => 'pt_BR'},\n WARNING => \"do this at home!\";\n\n",
"type" : "example"
},
"id654" : {
"call" : "$obj->addFlags( STRING )",
"diagnostics" : [
"id655"
],
"id" : "id654",
"type" : "i_method",
"name" : "addFlags",
"intro" : "Parse a \"flags\" line.
\n" }, "id1152" : { "name" : "defaultContext", "id" : "id1152", "intro" : "Returns the current default translation context settings as HASH. You should\nnot modify the content of that HASH: change it by called setContext() or\nupdateContext().
\n", "type" : "i_method", "call" : "$obj->defaultContext" }, "id913" : { "params" : "$program", "type" : "option", "id" : "id913", "name" : "identity" }, "id425" : { "path" : "DESCRIPTION", "type" : "chapter", "intro" : "Translate a message by directly accessing POT files. The files will load\nlazily (unless forced). This module accesses the PO's in a compact way,\nusing Log::Report::Lexicon::POTcompact, which is much more efficient\nthan Log::Report::Lexicon::PO.
\n", "id" : "id425", "name" : "DESCRIPTION", "level" : 1 }, "id1200-id1066" : { "extends" : "id1200", "name" : "call", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(call)
", "id" : "id1200-id1066", "type" : "option", "params" : "STRING" }, "id955-id221" : { "name" : "_msgid", "intro" : "Inherited, see Log::Report::Message::new(_msgid)
", "extends" : "id955", "id" : "id955-id221", "type" : "default", "value" : "undef"
},
"id79" : {
"id" : "id79",
"intro" : "Which STRING to use when an ARRAY is being filled-in as parameter.
\n", "type" : "option", "params" : "STRING", "name" : "_join" }, "id819" : { "name" : "is_fatal", "value" : "<depends on reason>", "type" : "default", "id" : "id819" }, "id58" : { "params" : "\\%rules|'HTML'", "type" : "option", "intro" : "[0.91] The format string and the inserted values will get encoded according to\nsome %rules. Function encode_entities() provided by HTML::Entities\nis used when you specify the predefined string HTML. See encodeFor()\nand Output encoding.
Log::Report::Template::Extract\n is a Log::Report::Extract\n\n", "type" : "chapter", "name" : "INHERITANCE", "level" : 1 }, "id1132-id385" : { "call" : "$obj->contextRules", "type" : "i_method", "intro" : "
Inherited, see Log::Report::Domain::contextRules()
", "id" : "id1132-id385", "name" : "contextRules", "extends" : "id1132" }, "id959" : { "name" : "_prepend", "id" : "id959", "value" : "undef",
"type" : "default"
},
"id404" : {
"level" : 2,
"name" : "Attributes",
"subroutines" : [
"id162-id385",
"id1133-id385",
"id164-id385",
"id163-id385",
"id1130-id385",
"id1144-id385",
"id1131-id385",
"id1132-id385",
"id406",
"id405",
"id409",
"id408",
"id407"
],
"type" : "section",
"id" : "id404",
"path" : "METHODS/Attributes"
},
"id1135-id385" : {
"extends" : "id1135",
"id" : "id1135-id385",
"type" : "default",
"value" : "created internally",
"name" : "translator",
"intro" : "Inherited, see Log::Report::Domain::configure(translator)
" }, "id1204-id1021" : { "params" : "INTEGER", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(max_line)
", "type" : "option", "id" : "id1204-id1021", "name" : "max_line", "extends" : "id1204" }, "id1193-id1217" : { "name" : "stackTraceLine", "extends" : "id1193", "options" : [ [ "id1208-id1217", "id1209-id1217" ], [ "id1200-id1217", "id1201-id1217" ], [ "id1196-id1217", "id1197-id1217" ], [ "id1198-id1217", "id1199-id1217" ], [ "id1204-id1217", "id1205-id1217" ], [ "id1206-id1217", "id1207-id1217" ], [ "id1194-id1217", "id1195-id1217" ], [ "id1202-id1217", "id1203-id1217" ] ], "id" : "id1193-id1217", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine()
", "type" : "ci_method", "call" : "$any->stackTraceLine( %options )" }, "id74" : { "name" : "FUNCTIONS", "examples" : [ "id75" ], "level" : 1, "path" : "FUNCTIONS", "subroutines" : [ "id86", "id85", "id76", "id87" ], "id" : "id74", "intro" : "The functional interface creates a hidden String::Print object, which is\nreused in the whole active package. Seperate packages will use different\nhidden objects.
You may import any of these functions explicitly, or all together by\nnot specifying the names.
\n", "type" : "chapter" }, "id630" : { "name" : "automatic", "intro" : "Automatically added comments.\nSee addAutomatic().
\n", "id" : "id630", "type" : "option", "params" : "\\@text" }, "id256" : { "name" : "METHODS", "level" : 1, "path" : "METHODS", "subroutines" : [ "id257", "id258" ], "nest" : [ "id262" ], "id" : "id256", "type" : "chapter" }, "id1199-id780" : { "id" : "id1199-id780", "type" : "default", "value" : "<required>", "extends" : "id1199", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(linenr)
", "name" : "linenr" }, "id330" : { "name" : "write_tables", "params" : "BOOLEAN", "intro" : "When false, the po-files will not get updated.
Inherited, see Log::Report::Dispatcher::skipStack()
", "type" : "i_method", "call" : "$obj->skipStack", "name" : "skipStack", "extends" : "id1191" }, "id980" : { "examples" : [ "id981" ], "name" : "clone", "intro" : "Returns a new object which copies info from original, and updates it\nwith the specified %options and $variables. The advantage is that the\ncached translations are shared between the objects.
\n", "type" : "i_method", "id" : "id980", "call" : "$obj->clone( %options, $variables )" }, "id1186-id780" : { "call" : "$obj->log( \\%options, $reason, $message, $domain )", "intro" : "Inherited, see Log::Report::Dispatcher::log()
", "type" : "i_method", "id" : "id1186-id780", "extends" : "id1186", "name" : "log" }, "id749-id561" : { "extends" : "id749", "call" : "$obj->translations( [$active] )", "diagnostics" : [ "id750-id561" ], "type" : "i_method", "id" : "id749-id561", "name" : "translations", "intro" : "Inherited, see Log::Report::Lexicon::Table::translations()
" }, "id1313" : { "path" : "DETAILS/Processing the message", "name" : "Processing the message", "level" : 2, "type" : "section", "id" : "id1313", "nest" : [ "id1314", "id1315" ] }, "id1173-id1066" : { "intro" : "Inherited, see Log::Report::Dispatcher::new(charset)
", "type" : "option", "id" : "id1173-id1066", "params" : "CHARSET", "extends" : "id1173", "name" : "charset" }, "id1155" : { "nest" : [ "id1156", "id1157" ], "id" : "id1155", "type" : "section", "level" : 2, "name" : "Configuring", "intro" : "Configuration of a domain can happen in many ways: either explicitly or\nimplicitly. The explicit form:
\n\n package My::Package;\n use Log::Report 'my-domain';\n\n textdomain 'my-domain', %configuration;\n textdomain->configure(%configuration);\n textdomain->configure(\\%configuration);\n\n textdomain->configure(conf => $filename);\n\n\n
The implicit form is (no variables possible, only constants!)
\n\n package My::Package;\n use Log::Report 'my-domain', %configuration;\n use Log::Report 'my-domain', conf => '/filename';\n\n\n
You can only configure your domain in one place in your program. The\ntextdomain setup is then used for all packages in the same domain.
\n\nThis also works for Log::Report::Optional, which is a dressed-down\nversion of Log::Report.
\n", "path" : "DETAILS/Configuring" }, "id1194-id1021" : { "params" : "CLASS", "type" : "option", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(package)
", "id" : "id1194-id1021", "name" : "package", "extends" : "id1194" }, "id1172-id1091" : { "name" : "format_reason", "intro" : "Inherited, see Log::Report::Dispatcher::new(format_reason)
", "extends" : "id1172", "value" : "'LOWERCASE'", "id" : "id1172-id1091", "type" : "default" }, "id1203-id1217" : { "name" : "params", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(params)
", "extends" : "id1203", "type" : "default", "id" : "id1203-id1217", "value" : "<required>" }, "id1118" : { "is_pure_pod" : false, "package" : "Log::Report::DBIC::Profiler", "distribution" : "Log-Report", "id" : "id1118", "inheritance" : { "extends" : [ "DBIx::Class::Storage::Statistics" ] }, "title" : "query profiler for DBIx::Class", "chapters" : [ "id1119", "id1349", "id1120", "id1121" ], "name" : "Log::Report::DBIC::Profiler", "version" : "1.46" }, "id555" : { "name" : "iso_to_codepage", "intro" : "Returns the numeric value of the codepage. The $iso may look like\nthis: xx_YY. Then, first the xx_YY is looked-up. If that does\nnot exist, xx is tried.
Inherited, see Log::Report::Dispatcher::stackTraceLine(call)
", "extends" : "id1201", "type" : "default", "value" : "<required>", "id" : "id1201-id1021" }, "id1209-id780" : { "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(abstract)
", "name" : "abstract", "value" : "1", "id" : "id1209-id780", "type" : "default", "extends" : "id1209" }, "id262" : { "path" : "METHODS/Handlers", "type" : "section", "intro" : "All the standard Log::Report functions are available to use. Please see the\nThe Reason for the report for details\nof when each one should be used.
\n\nLog::Report class functionality\nto class messages (which can then be tested later):
\n\n notice __x\"Tag me up\", _tag => 'label';\n ...\n if ($msg->taggedWith('label')) ...\n\n\nDancer2::Plugin::LogReport has a special message class, no_session,\nwhich prevents the message from being saved to the messages session\nvariable. This is useful, for example, if you are writing messages within\nthe session hooks, in which case recursive loops can be experienced.
Returns a list of Log::Report::Lexicon::Index objects, where the\ntranslation files may be located.
\n", "id" : "id435", "type" : "i_method", "call" : "$obj->lexicons" }, "id288" : { "level" : 3, "name" : "Email alerts of exceptions", "id" : "id288", "intro" : "If you have an unexpected exception in your production application,\nthen you probably want to be notified about it. One way to do so is\nconfigure rsyslog to send emails of messages at the panic level. Use\nthe following configuration to do so:
\n\n # Normal logging from LOCAL0\n local0.* -/var/log/myapp.log\n\n # Load the mail module\n $ModLoad ommail\n # Configure sender, receiver and mail server\n $ActionMailSMTPServer localhost\n $ActionMailFrom root\n $ActionMailTo root\n # Set up an email template\n $template mailSubject,\"Critical error on %hostname%\"\n $template mailBody,\"RSYSLOG Alert\\r\\nmsg='%msg%'\\r\\nseverity='%syslogseverity-text%'\"\n $ActionMailSubject mailSubject\n # Send an email no more frequently than every minute\n $ActionExecOnlyOnceEveryInterval 60\n # Configure the level of message to notify via email\n if $syslogfacility-text == 'local0' and $syslogseverity < 3 then :ommail:;mailBody\n $ActionExecOnlyOnceEveryInterval 0\n\n\n
With the above configuration, you will only be emailed of severe errors, but can\nview the full log information in /var/log/myapp.log
\n", "type" : "subsection", "path" : "DETAILS/In Use/Email alerts of exceptions" }, "id1145-id385" : { "intro" : "Inherited, see Log::Report::Domain::readConfig()
", "type" : "fault", "id" : "id1145-id385", "name" : "cannot open JSON file for context at $fn: $!", "extends" : "id1145", "subroutine" : "id1144" }, "id1192-id780" : { "name" : "collectLocation", "extends" : "id1192", "intro" : "Inherited, see Log::Report::Dispatcher::collectLocation()
", "type" : "ci_method", "id" : "id1192-id780", "call" : "$any->collectLocation" }, "id403" : { "name" : "extension to domain '$name' already exists", "subroutine" : "id402", "type" : "error", "id" : "id403" }, "id277" : { "path" : "DETAILS/Larger example", "id" : "id277", "intro" : "In its simplest form, this module can be used for more flexible logging
\n\n get '/route' => sub {\n # Stop execution, redirect, and display an error to the user\n $name or error \"Please enter a name\";\n\n # The same but translated\n $name or error __\"Please enter a name\";\n\n # The same but translated and with variables\n $name or error __x\"{name} is not valid\", name => $name;\n\n # Show the user a warning, but continue execution\n mistake \"Not sure that's what you wanted\";\n\n # Add debug information, can be caught in syslog by adding\n # the (for instance) syslog dispatcher\n trace \"Hello world\";\n };\n\n",
"type" : "section",
"name" : "Larger example",
"level" : 2
},
"id172" : {
"name" : "interpolate",
"call" : "$obj->interpolate( $msgid, [$args] )",
"intro" : "Interpolate the keys used in $msgid from the values in $args.\nThis is handled by the formatter, by default a String::Print\ninstance.
\n", "type" : "i_method", "id" : "id172" }, "id1007" : { "name" : "serializer", "id" : "id1007", "intro" : "In the future, the specific serializer may influence the frozen output.
\n", "type" : "option", "params" : "'JSON'|'Serial'|..." }, "id1127" : { "path" : "METHODS/Constructors", "id" : "id1127", "type" : "section", "subroutines" : [ "id1128" ], "name" : "Constructors", "level" : 2 }, "id830" : { "examples" : [ "id831" ], "name" : "try", "id" : "id830", "intro" : "Execute the CODE while blocking all dispatchers as long as it is running.\nThe exceptions which occur while running the CODE are caught until it\nhas finished. When there where no fatal errors, the result of the CODE\nexecution is returned.
\n\nAfter the CODE was tried, the $@ will contain a\nLog::Report::Dispatcher::Try object, which contains the collected\nmessages. Read that manual page to understand try.
Run-time errors from Perl and die's, croak's and confess's within the\nprogram (which shouldn't appear, but you never know) are collected into an\nLog::Report::Message object, using Log::Report::Die.
\n\nThe %options are passed to the constructor of the try-dispatcher, see\nLog::Report::Dispatcher::Try::new(). For instance, you may like to\nadd mode => 'DEBUG', or accept => 'ERROR-'.
Be warned that the parameter to try is a CODE reference. This means\nthat you shall not use a comma after the block when there are %options\nspecified. On the other hand, you shall use a semi-colon after the\nblock if there are no arguments.
Be warned that the {} are interpreted as subroutine, which\nmeans that --for instance-- it has its own @_ parameter list.\nThe manual-page of Try::Tiny lists a few more side-effects of this.
This base class defines the generic interface for translation tables.
\n\nCurrently, there are three extensions:
\n\nundef",
"id" : "id961"
},
"id517" : {
"nest" : [
"id518",
"id526",
"id532"
],
"id" : "id517",
"type" : "chapter",
"level" : 1,
"name" : "METHODS",
"path" : "METHODS"
},
"id496" : {
"nest" : [
"id497"
],
"id" : "id496",
"type" : "chapter",
"name" : "DESCRIPTION",
"level" : 1,
"path" : "DESCRIPTION",
"intro" : "This module helps maintaining the POT files, updating the list of\nmessage-ids which are kept in them. After initiation, the process()\nmethod needs to be called with all files which changed since last processing\nand the existing PO files will get updated accordingly.
\n\nIf no translations exist yet, one $lexicon/$domain.po file will be\ncreated. If you want to start a translation, copy $lexicon/$domain.po\nto $lexicon/$domain/$lang.po and edit that file. You may use\npoedit to edit po-files. There are many smart translation management\napplications which can hand po-files, for instance Pootle and Weblate.
Do not forget to add the new po-file to your distribution (MANIFEST)
\n" }, "id775" : { "id" : "id775", "type" : "error", "subroutine" : "id766", "name" : "Log::Dispatch level '$level' not understood" }, "id716" : { "call" : "$obj->msgstr( $msgid, [$count, [$msgctxt]] )", "intro" : "Returns the translated string for $msgid. When $count is not specified or\nundef, the translation string related to \"1\" is returned.
Inherited, see Log::Report::Dispatcher::name()
", "id" : "id1179-id1091", "call" : "$obj->name", "extends" : "id1179", "name" : "name" }, "id1260" : { "level" : 1, "name" : "NAME", "intro" : "Log::Report::Die - compatibility routines with Perl's die/croak/confess
\n", "type" : "chapter", "id" : "id1260", "path" : "NAME" }, "id1202-id780" : { "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(params)
", "id" : "id1202-id780", "type" : "option", "params" : "ARRAY", "extends" : "id1202", "name" : "params" }, "id1166-id760" : { "intro" : "Inherited, see Log::Report::Dispatcher::new(accept)
", "name" : "accept", "value" : "depend on mode",
"id" : "id1166-id760",
"type" : "default",
"extends" : "id1166"
},
"id478" : {
"type" : "fault",
"id" : "id478",
"subroutine" : "id467",
"name" : "cannot read translations from $fn, need $size at $loc: $!"
},
"id755-id669" : {
"name" : "nrPlurals",
"extends" : "id755",
"call" : "$obj->nrPlurals",
"intro" : "Inherited, see Log::Report::Lexicon::Table::nrPlurals()
", "type" : "i_method", "id" : "id755-id669" }, "id487" : { "call" : "$obj->index", "intro" : "Returns a HASH of all defined PO objects, organized by msgid. Please try\nto avoid using this: use msgid() for lookup.
\n", "id" : "id487", "type" : "i_method", "name" : "index" }, "id1088" : { "type" : "section", "id" : "id1088", "subroutines" : [ "id1089", "id1090" ], "path" : "METHODS/Translating", "level" : 2, "name" : "Translating" }, "id90" : { "name" : "Why useprinti() to replace printf()?",
"level" : 2,
"path" : "DETAILS/Why use CThe printf() function is provided by Perl's CORE; you do not need\nto install any module to use it. Why would you use consider using\nthis module?
printf() uses positional parameters, where printi() uses names\nto refer to the values to be filled-in. Especially in a set-up with\ntranslations, where the format strings get extracted into PO-files,\nit is much clearer to use names. This is also a disadvantage of\nprintp()\n\n\n\nprinti() supports serialization for specific data-types: how to\ninterpolate undef, HASHes, etc.\n\n\n\nprintf() is broken: it takes your string\nas bytes, not Perl strings (which may be utf8). In unicode, one\n\"character\" may use many bytes. Also, some characters are displayed\ndouble wide, for instance in Chinese. The printi() implementation\nwill use Unicode::GCString for correct behavior.\n\n\n\n # getters\n if($po->format('c')) ...\n unless($po->format('perl-brace')) ...\n if(defined $po->format('java')) ...\n\n # setters\n $po->format(java => 1); # results in 'java-format'\n $po->format(java => 0); # results in 'no-java-format'\n $po->format(java => undef); # results in ''\n\n",
"id" : "id653",
"name" : "use of format()\n"
},
"id320" : {
"level" : 2,
"name" : "Handling text domains",
"subroutines" : [
"id325",
"id321",
"id327",
"id326"
],
"id" : "id320",
"type" : "section",
"path" : "METHODS/Handling text domains"
},
"id272" : {
"id" : "id272",
"type" : "i_method",
"call" : "$obj->failure",
"name" : "failure"
},
"id1159" : {
"name" : "NAME",
"level" : 1,
"path" : "NAME",
"intro" : "Log::Report::Dispatcher - manage message dispatching, display or logging
\n", "type" : "chapter", "id" : "id1159" }, "id1181-id1091" : { "extends" : "id1181", "name" : "mode", "intro" : "Inherited, see Log::Report::Dispatcher::mode()
", "id" : "id1181-id1091", "type" : "i_method", "call" : "$obj->mode" }, "id267" : { "name" : "warning", "call" : "$obj->warning", "id" : "id267", "type" : "i_method" }, "id353" : { "name" : "More performance via MO-files", "level" : 3, "path" : "DETAILS/Extracting PO-files/More performance via MO-files", "type" : "subsection", "intro" : "PO-files are quite large. You can reduce the translation table size by\ncreating a binary \"MO\"-file for each of them. Log::Report::Lexicon\nwill prefer mo files, if it encounters them, but generation is not (yet)\norganized via Log::Report components. Search for \"msgfmt\" as separate\ntool or CPAN module.
\n", "id" : "id353" }, "id620" : { "type" : "option", "id" : "id620", "params" : "$msgid", "name" : "msgid_plural" }, "id1010" : { "name" : "thaw", "call" : "$class->thaw( \\%data, %options )", "type" : "c_method", "id" : "id1010" }, "id854" : { "type" : "function", "intro" : "Same as __nx(), because we have no preferred order for 'x' and 'n'.
\n", "id" : "id854", "call" : "__xn( $single_msgid, $plural_msgid, $count, $paurs )", "name" : "__xn" }, "id1205-id780" : { "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(max_line)
", "name" : "max_line", "type" : "default", "id" : "id1205-id780", "value" : "undef",
"extends" : "id1205"
},
"id162" : {
"id" : "id162",
"type" : "i_method",
"call" : "$obj->name",
"name" : "name"
},
"id446" : {
"level" : 2,
"name" : "Constructors",
"subroutines" : [
"id447"
],
"id" : "id446",
"type" : "section",
"path" : "METHODS/Constructors"
},
"id1187-id1217" : {
"type" : "i_method",
"intro" : "Inherited, see Log::Report::Dispatcher::translate()
", "id" : "id1187-id1217", "call" : "$obj->translate( \\%options, $reason, $message )", "extends" : "id1187", "name" : "translate" }, "id188" : { "name" : "try", "id" : "id188", "type" : "function", "call" : "try( CODE, %options )" }, "id1177" : { "name" : "Perl does not support charset $cs", "subroutine" : "id1164", "type" : "error", "id" : "id1177" }, "id914" : { "value" : "<basename $0>", "id" : "id914", "type" : "default", "name" : "identity" }, "id177" : { "nest" : [ "id179", "id189", "id201", "id211" ], "id" : "id177", "type" : "chapter", "name" : "FUNCTIONS", "level" : 1, "path" : "FUNCTIONS", "subroutines" : [ "id178" ] }, "id765" : { "path" : "METHODS/Constructors", "subroutines" : [ "id766" ], "type" : "section", "id" : "id765", "name" : "Constructors", "level" : 2 }, "id319" : { "call" : "$obj->translateTo( [$language] )", "type" : "i_method", "id" : "id319", "name" : "translateTo" }, "id971" : { "name" : "_to", "type" : "default", "value" : "undef",
"id" : "id971"
},
"id1139-id385" : {
"type" : "default",
"id" : "id1139-id385",
"value" : "undef",
"extends" : "id1139",
"intro" : "Inherited, see Log::Report::Domain::configure(context_rules)
", "name" : "context_rules" }, "id619" : { "id" : "id619", "value" : "<required>", "type" : "default", "name" : "msgid" }, "id500" : { "level" : 1, "name" : "METHODS", "path" : "METHODS", "nest" : [ "id501", "id502", "id503" ], "type" : "chapter", "id" : "id500" }, "id512" : { "subroutine" : "id504", "name" : "count missing in $function in line $line.", "type" : "error", "id" : "id512" }, "id1142-id385" : { "extends" : "id1142", "name" : "the native_language '$locale' is not a valid locale", "subroutine" : "id1133", "type" : "error", "intro" : "Inherited, see Log::Report::Domain::configure()
", "id" : "id1142-id385" }, "id1195-id780" : { "extends" : "id1195", "value" : "<required>", "id" : "id1195-id780", "type" : "default", "name" : "package", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(package)
" }, "id1213" : { "intro" : "The modules which use Log::Report will only specify the base of\nthe message string. The base dispatcher and the back-ends will extend\nthis message with additional information:
$!When the message is a translatable object (Log::Report::Message, for\ninstance created with Log::Report::__()), then the added components\nwill get translated as well. Otherwise, all will be in English.
\n\nExactly what will be added depends on the actual mode of the dispatcher\n(change it with mode(), initiate it with new(mode)).
\n\n mode mode mode mode\n REASON SOURCE TE! NORM VERB ASSE DEBUG\n trace program ... S\n assert program ... SL SL\n info program T.. S S S\n notice program T.. S S S S\n mistake user T.. S S S SL\n warning program T.. S S SL SL\n error user TE. S S SL SC\n fault system TE! S S SL SC\n alert system T.! SL SL SC SC\n failure system TE! SL SL SC SC\n panic program .E. SC SC SC SC\n\n T - usually translated\n E - exception (execution interrupted)\n ! - will include $! text at display\n L - include filename and linenumber\n S - show/print when accepted\n C - stack trace (like Carp::confess())\n\n", "id" : "id1213", "type" : "subsection", "path" : "DETAILS/Processing the message/Addition information", "level" : 3, "name" : "Addition information" }, "id468" : { "name" : "charset", "params" : "STRING", "intro" : "
The character-set which is used for the file. When not specified, it is\ntaken from the \"Content-Type\" field in the PO-file.
\n", "id" : "id468", "type" : "option" }, "id482" : { "id" : "id482", "type" : "fault", "name" : "cannot read translations from $fn, need $size at $loc: $!", "subroutine" : "id467" }, "id807" : { "type" : "function", "id" : "id807", "options" : [ [ "id810", "id811" ], [ "id818", "id819" ], [ "id816", "id817" ], [ "id814", "id815" ], [ "id812", "id813" ], [ "id808", "id809" ] ], "diagnostics" : [ "id821", "id822", "id823", "id824" ], "call" : "report( [\\%options], $reason, $message|<$text,%params>, )", "examples" : [ "id820" ], "intro" : "The report function is sending (for some $reason) a $message to be\ndisplayed or logged (by a `dispatcher'). This function is the core\nfor error(), info() etc functions, which are nicer names for this\nexception throwing: better use those short names.
The optional %options are listed below. Quite differently from other\nfunctions and methods, they have to be passed in a HASH as first parameter.
\n\nThe $reason is a string like 'ERROR' (for function error()).\nThe $message is a Log::Report::Message object (which is created with\nthe special translation syntax like __x()).
The message may also be a plain piece of $text, or a\nLog::Report::Exception object. The %params can be used to influence\nthe dispatchers, like real message objects can.
\n\nThis function returns the LIST of dispatchers which accepted the $message.\nWhen empty, no back-end has accepted it so the $message was \"lost\".\nEven when no back-end needs the message, the program will still exit\nwhen there is a $reason to die().
Check whether the try stops message which were produced for $reason.
\n", "type" : "i_method" }, "id934" : { "call" : "$obj->reasonToPrio( $reason )", "type" : "i_method", "intro" : "Returns a level which is understood by syslog(3), based on a translation\ntable. This can be changed with new(to_prio).
\n", "id" : "id934", "name" : "reasonToPrio" }, "id989" : { "name" : "msgctxt", "id" : "id989", "intro" : "The message context for the translation table lookup.
\n", "type" : "i_method", "call" : "$obj->msgctxt" }, "id55" : { "value" : "[ qr/^%\\S+/ => \\&format_printf]",
"id" : "id55",
"type" : "default",
"name" : "modifiers"
},
"id247" : {
"intro" : "my $lexicon = $directory; # f.i. $directory/<domain>/nl_NL.utf-8.po\n my $tables = Log::Report::Translator::POT->new(lexicon => $lexicon);\n (engine 'template')->addTextdomain(name => 'mydomain')->configure(translator => $tables);\n\n", "id" : "id247", "type" : "example" }, "id142" : { "intro" : "
The domain for the registered $package is returned.
\n\nWith $domain, $filename and $line, this registers a location where\nthe textdomain is specified first. Each $package can only belong to\none $domain.
\n", "name" : "pkg2domain", "call" : "pkg2domain( $package, [$domain, $filename, $line] )", "diagnostics" : [ "id143" ], "id" : "id142", "type" : "function" }, "id466" : { "path" : "METHODS/Constructors", "subroutines" : [ "id741-id461", "id467" ], "type" : "section", "id" : "id466", "name" : "Constructors", "level" : 2 }, "id991" : { "intro" : "Deprecated alternative for tags().
\n", "id" : "id991", "type" : "i_method", "call" : "$obj->classes", "name" : "classes" }, "id1039" : { "level" : 2, "name" : "Attributes", "subroutines" : [ "id1180-id1021", "id1179-id1021", "id1183-id1021", "id1181-id1021", "id1182-id1021", "id1045", "id1041", "id1042", "id1040", "id1043" ], "type" : "section", "id" : "id1039", "path" : "METHODS/Attributes" }, "id1359" : { "level" : 1, "name" : "INHERITANCE", "intro" : "Log::Report::Minimal\n is an Exporter\n\n", "type" : "chapter", "id" : "id1359", "path" : "INHERITANCE" }, "id522-id354" : { "params" : "$charset", "type" : "option", "intro" : "
Inherited, see Log::Report::Extract::new(charset)
", "id" : "id522-id354", "name" : "charset", "extends" : "id522" }, "id745" : { "call" : "$obj->msgid( STRING, [$msgctxt] )", "intro" : "Lookup the Log::Report::Lexicon::PO with the STRING.\nReturns undef when not defined.
Inherited, see Log::Report::Message::append()
", "type" : "i_method", "call" : "$obj->append", "name" : "append", "extends" : "id985" }, "id197" : { "name" : "fault", "id" : "id197", "type" : "function", "call" : "fault( $message )" }, "id1255" : { "type" : "example", "intro" : "print $_->toString for $@->exceptions;\n print $_ for $@->exceptions; # via overloading\n\n", "id" : "id1255", "name" : "printing exceptions\n" }, "id751-id561" : { "extends" : "id751", "type" : "i_method", "id" : "id751-id561", "call" : "$obj->pluralIndex( $count )", "diagnostics" : [ "id752-id561" ], "name" : "pluralIndex", "intro" : "
Inherited, see Log::Report::Lexicon::Table::pluralIndex()
" }, "id448" : { "id" : "id448", "type" : "section", "subroutines" : [ "id449" ], "path" : "METHODS/Attributes", "level" : 2, "name" : "Attributes" }, "id532" : { "subroutines" : [ "id538", "id534", "id533", "id540", "id537" ], "type" : "section", "id" : "id532", "path" : "METHODS/Processors", "level" : 2, "name" : "Processors" }, "id292" : { "nest" : [ "id293" ], "id" : "id292", "type" : "chapter", "name" : "DESCRIPTION", "level" : 1, "path" : "DESCRIPTION", "intro" : "[The Dancer2 plugin was contributed by Andrew Beverley]
\n\nThis logger allows the use of the many logging backends available\nin Log::Report. It will process all of the Dancer2 log messages,\nand also allow any other module to use the same logging facilities. The\nsame log messages can be sent to multiple destinations at the same time\nvia flexible dispatchers.
\n\nIf using this logger, you may also want to use\nDancer2::Plugin::LogReport
\n\nMany log back-ends, like syslog, have more levels of system messages.\nModules who explicitly load this module can use the missing assert,\nnotice, panic, and alert log levels. The trace name is\nprovided as well: when you are debugging, you add a 'trace' to your\nprogram... it's just a better name than 'debug'. You will need to load\nLog::Report in order to use the additional levels; if doing so directly within\na Dancer2 application (not a sub-module), then you will either need to load\nLog::Report with syntax, 'LONG' or use Dancer2::Plugin::LogReport to\nprevent namespace clashes.
The algorithm to be used to calculate which translated msgstr to use.
\n", "type" : "option", "id" : "id684", "params" : "EXPRESSION", "name" : "plural_alg" }, "id639" : { "call" : "$obj->msgctxt", "intro" : "Returns the message context string, if provided.
\n", "id" : "id639", "type" : "i_method", "name" : "msgctxt" }, "id1218" : { "name" : "NAME", "level" : 1, "path" : "NAME", "intro" : "Log::Report::Dispatcher::Perl - send messages to die and warn
\n", "type" : "chapter", "id" : "id1218" }, "id883" : { "name" : "textdomain", "intro" : "[1.00] Without CONFIGuration, this returns the Log::Report::Domain object\nwhich administers the $domain, by default the domain effective in the scope\nof the package.
\n\nA very special case is \"DELETE\", which will remove the domain\nconfiguration. [1.20] \"EXISTS\" will check for existence: when it exists,\nit will be returned, but a domain will not be automagically created.
\n\n[1.20] You may also pass a pre-configured domain.
\n", "type" : "function", "id" : "id883", "call" : "textdomain( <[$name],$config>|<$name, 'DELETE'|'EXISTS'>|$domain )" }, "id186" : { "subroutine" : "id180", "name" : "odd length parameter list with '$msg'", "type" : "error", "id" : "id186" }, "id1167-id1217" : { "params" : "LOCALE", "intro" : "Inherited, see Log::Report::Dispatcher::new(locale)
", "type" : "option", "id" : "id1167-id1217", "name" : "locale", "extends" : "id1167" }, "id339" : { "name" : "process", "call" : "$obj->process( $template, [\\%vars, $output, \\%options] )", "intro" : "Process the $template into $output, filling in the %vars.
\n", "id" : "id339", "type" : "i_method" }, "id384" : { "intro" : "This example extends the previous with using context sensitive translations,\nas implemented by Log::Report::Translator::Context.
\n\nLet's say that the translation of some of the sentences on the website depend\non the gender of the addressed person. An example of the use in a TT2\ntemplate:
\n\n [% loc(\"{name<gender} forgot his key\", name => person.name) %]\n\n\nThe extraction script xgettext-perl will expand this into two records\nin the PO file, respectively with msgctxt attribute 'gender=male' and\n'gender=female'.
\n\nWhen your PO-files are not generated by 'xgettext-perl', you do not need\na separate domain configuration file:
\n\n $domain->configure(\n context_rules => +{gender => ['male','female']},\n translator => $translator,\n );\n\n\nWhen your PO-files are generated by 'xgettext-perl', you need to share\nthe context-rules between that msgid extractor and your runtime code. That\nsame file needs to be passed with the 'domain' parameter to the script.
\n\n # add context_rules either explicit or via 'config' filename\n $domain->configure(\n config => 'my/own/$domain.conf',\n translator => $translator,\n );\n\n\n
Now, when you generate the pages, you need to set-up the right context.\nIn this case, we set-up the gender of the person who gets addressed.\n(The name 'gender' is good for examples, but quite non-descriptive.\nMaybe 'user_gender' is more maintainable)
\n\n $domain->setContext( +{gender => 'male'} ); # or ('gender=male')\n $domain->setContext( \"gender=male\" ); # same\n\n",
"type" : "section",
"id" : "id384",
"path" : "DETAILS/Use in combination with contexts",
"level" : 2,
"name" : "Use in combination with contexts"
},
"id498" : {
"level" : 3,
"name" : "What is extracted?",
"id" : "id498",
"intro" : "This script will extract the msgids used in __(), __x(), __xn(),\nand __n() (implemented by Log::Report) For instance
\n __x\"msgid\", @more\n __x'msgid', @more <--- no! syntax error!\n __x(\"msgid\", @more)\n __x('msgid', @more)\n __x(msgid => @more)\n\n\nBesides, there are some helpers which are no-ops in the code, only to fill\nthe po-tables: N__(), N__n(), N__()
# usually, the context information is in a separate file\n textdomain 'my-domain', config => $filename;\n\n", "id" : "id585", "path" : "SYNOPSIS" }, "id242" : { "intro" : "
Standard Moo with Dancer2::Core::Role::Template extensions.
\n", "type" : "section", "id" : "id242", "path" : "METHODS/Constructors", "level" : 2, "name" : "Constructors" }, "id1280" : { "type" : "section", "id" : "id1280", "nest" : [ "id1281", "id1282" ], "path" : "DETAILS/Automatic parameters", "level" : 2, "name" : "Automatic parameters" }, "id718" : { "type" : "error", "id" : "id718", "subroutine" : "id717", "name" : "translation already exists for '$msgid' with '$ctxt'." }, "id810" : { "name" : "errno", "type" : "option", "intro" : "When the $reason includes the error text (See Run modes), you can\noverrule the error code kept in $!. In other cases, the return code\ndefaults to 1 (historical UNIX behavior). When the message $reason\n(combined with the run-mode) is severe enough to stop the program,\nthis value as return code of the program. The use of this option itself\nwill not trigger an die().
MojoX::Log::Report\n is a Mojo::Log\n\n", "type" : "chapter", "path" : "INHERITANCE", "level" : 1, "name" : "INHERITANCE" }, "id1186-id760" : { "name" : "log", "extends" : "id1186", "call" : "$obj->log( \\%options, $reason, $message, $domain )", "intro" : "
Inherited, see Log::Report::Dispatcher::log()
", "id" : "id1186-id760", "type" : "i_method" }, "id802" : { "id" : "id802", "intro" : "Log::Report - report a problem, with exceptions and translation support
\n", "type" : "chapter", "path" : "NAME", "level" : 1, "name" : "NAME" }, "id754-id461" : { "subroutine" : "id753", "extends" : "id754", "name" : "invalid plural-form algorithm '$alg'.", "intro" : "Inherited, see Log::Report::Lexicon::Table::setupPluralAlgorithm()
", "id" : "id754-id461", "type" : "error" }, "id527-id354" : { "name" : "index", "extends" : "id527", "intro" : "Inherited, see Log::Report::Extract::index()
", "type" : "i_method", "id" : "id527-id354", "call" : "$obj->index" }, "id795" : { "name" : "Log4perl level '$level' must be in 0-5", "subroutine" : "id789", "type" : "error", "id" : "id795" }, "id1252" : { "intro" : "Insert the message contained in the exception into the currently defined\ndispatchers. The throw as method name is commonly known exception\nrelated terminology for report.
The %options overrule the captured options to Log::Report::report().\nThis can be used to overrule a destination. Also, the reason can\nbe changed.
\n\nReturned is the LIST of dispatchers which have accepted the forwarded\nexception.
\n", "type" : "i_method", "id" : "id1252", "call" : "$obj->throw( %options )", "examples" : [ "id1253" ], "name" : "throw" }, "id923" : { "params" : "BOOLEAN", "id" : "id923", "intro" : "[1.00] Include the text-domain of the message in each logged message.
\n", "type" : "option", "name" : "include_domain" }, "id415" : { "id" : "id415", "type" : "error", "subroutine" : "id412", "name" : "message does not contain counting alternatives in '$msgid'" }, "id476" : { "id" : "id476", "type" : "fault", "subroutine" : "id467", "name" : "cannot read originals from $fn, need $size at $loc: $!" }, "id950" : { "intro" : "When defined, the _plural need to be defined as well. When an\nARRAY is provided, the length of the ARRAY is taken. When a HASH\nis given, the number of keys in the HASH is used.
\n", "id" : "id950", "type" : "option", "params" : "INTEGER|ARRAY|HASH", "name" : "_count" }, "id147" : { "type" : "chapter", "intro" : "This module will allow libraries (helper modules) to have a dependency\nto a small module instead of the full Log-Report distribution. The full\npower of Log::Report is only released when the main program uses that\nmodule. In that case, the module using the 'Optional' will also use the\nfull Log::Report, otherwise the dressed-down Log::Report::Minimal\nversion.
For the full documentation:
\n\nThe latter provides the same functions from the former, but is the\nsimpelest possible way.
\n", "id" : "id147", "path" : "DESCRIPTION", "level" : 1, "name" : "DESCRIPTION" }, "id1209-id760" : { "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(abstract)
", "name" : "abstract", "type" : "default", "id" : "id1209-id760", "value" : "1", "extends" : "id1209" }, "id1068" : { "path" : "SYNOPSIS", "intro" : " sub cb($$$)\n { my ($disp, $options, $reason, $message) = @_;\n ...\n }\n\n dispatcher Log::Report::Dispatcher::Callback => 'cb',\n callback => \\&cb;\n\n dispatcher CALLBACK => 'cb', # same\n callback => \\&cb;\n\n",
"type" : "chapter",
"id" : "id1068",
"name" : "SYNOPSIS",
"level" : 1
},
"id192" : {
"name" : "info",
"type" : "function",
"id" : "id192",
"call" : "info( $message )"
},
"id169-id385" : {
"name" : "formatter",
"intro" : "Inherited, see Log::Report::Minimal::Domain::configure(formatter)
", "extends" : "id169", "value" : "PRINTI",
"type" : "default",
"id" : "id169-id385"
},
"id941" : {
"name" : "'&{}'",
"call" : "overload '&{}'; used as function",
"intro" : "When the object is called as function, a new object is created with\nthe data from the original one but updated with the new parameters.\nImplemented in clone().
Sometimes we write a function in a model, and it would be nice to have a\nnice easy way to return from the function with an error message. One\nway of doing this is with a separate error message variable, but that\ncan be messy code. An alternative is to use exceptions, but these\ncan be a pain to deal with in terms of catching them.\nHere's how to do it with Log::Report.
\n\nIn this example, we do use exceptions, but in a neat, easier to use manner.
\n\nFirst, your module/model:
\n\n package MyApp::CD;\n\n sub update {\n my ($self, %values) = @_;\n $values{title} or error \"Please enter a title\";\n $values{description} or warning \"No description entered\";\n }\n\n\nThen, in your controller:
\n\n package MyApp;\n use Dancer2;\n\n post '/cd' => sub {\n my %values = (\n title => param('title');\n description => param('description');\n );\n if (process sub { MyApp::CD->update(%values) } ) {\n success \"CD updated successfully\";\n redirect '/cd';\n }\n\n template 'cd' => { values => \\%values };\n }\n\n\nNow, when update() is called, any exceptions are caught. However, there is\nno need to worry about any error messages. Both the error and warning\nmessages in the above code will have been stored in the messages session\nvariable, where they can be displayed using the code in the previous section.\nThe error will have caused the code to stop running, and process()\nwill have returned false. warning will have simply logged the warning\nand not caused the function to stop running.
A module (or distribution) has a certain way of translating messages,\nusually gettext. The translator is based on some textdomain\nfor the message, which can be specified as option per text element,\nbut usually is package scoped.
This base class does not translate at all: it will use the MSGID\n(and MSGID_PLURAL if available). It's a nice fallback if the\nlanguage packs are not installed.
\n", "type" : "chapter", "id" : "id1083", "path" : "DESCRIPTION" }, "id736" : { "intro" : "Log::Report::Lexicon::Table - generic interface to translation tables
\n", "type" : "chapter", "id" : "id736", "path" : "NAME", "level" : 1, "name" : "NAME" }, "id1045" : { "id" : "id1045", "intro" : "Returns the value of new(on_die).
\n", "type" : "i_method", "call" : "$obj->die2reason", "name" : "die2reason" }, "id537" : { "name" : "showStats", "call" : "$obj->showStats( [$domains] )", "id" : "id537", "intro" : "Show a status about the DOMAIN (by default all domains). At least mode\nverbose is required to see this.
\n\nThe statistics are sent to (Log::Report) dispatchers which accept\nnotice and info. This could be syslog. When you have no explicit\ndispatchers in your program, the level of detail get controlled by\nthe 'mode':
\n\n use Log::Report mode => 'DEBUG'; # or 'VERBOSE'\n\n", "type" : "i_method" }, "id1199-id760" : { "intro" : "
Inherited, see Log::Report::Dispatcher::stackTraceLine(linenr)
", "name" : "linenr", "type" : "default", "value" : "<required>", "id" : "id1199-id760", "extends" : "id1199" }, "id1200-id905" : { "params" : "STRING", "type" : "option", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(call)
", "id" : "id1200-id905", "name" : "call", "extends" : "id1200" }, "id1237" : { "type" : "option", "id" : "id1237", "params" : "$reason", "name" : "reason" }, "id825" : { "name" : "dispatcher", "intro" : "The dispatcher function controls access to dispatchers: the back-ends\nwhich process messages, do the logging. Dispatchers are global entities,\naddressed by a symbolic $name. Please read Log::Report::Dispatcher as\nwell.
The Log::Report suite has its own dispatcher types, but also connects\nto external dispatching frameworks. Each need some (minor) conversions,\nespecially with respect to translation of REASONS of the reports\ninto log-levels as the back-end understands.
[1.10] When you open a dispatcher with a $name which is already in use,\nthat existing dispatcher gets closed. Except when you have given an\n'dispatcher \"do-not-reopen\"' earlier, in which case the first object\nstays alive, and the second attempt ignored. [1.11] The automatically\ncreated default dispatcher will get replaced, even when this option\nis given, by another dispatcher which is named 'default'.
\n\nThe %options are a mixture of parameters needed for the\nLog::Report dispatcher wrapper and the settings of the back-end.\nSee Log::Report::Dispatcher, the documentation for the back-end specific\nwrappers, and the back-ends for more details.
\n\nImplemented COMMANDs are close, find, list, disable,\nenable, mode, filter, needs, active-try, and do-not-reopen.
Most commands are followed by a LIST of dispatcher @names to be addressed.\nFor mode see section Run modes; it requires a MODE argument\nbefore the LIST of NAMEs. Non-existing names will be ignored. When\nALL is specified, then all existing dispatchers will get addressed.\nFor filter see Filters; it requires a CODE\nreference before the @names of the dispatchers which will have the it\napplied (defaults to all).
With needs, you only provide a REASON: it will return the list of\ndispatchers which need to be called in case of a message with the REASON\nis triggered. The active-try [1.09] returns the closest surrounding\nexception catcher, a Log::Report::Dispatcher::Try object.
For both the creation as COMMANDs version of this method, all objects\ninvolved are returned as LIST, non-existing ones skipped. In SCALAR\ncontext with only one name, the one object is returned.
\n", "examples" : [ "id826" ], "type" : "function", "id" : "id825", "diagnostics" : [ "id827", "id828", "id829" ], "call" : "dispatcher( <$type, $name, %options>|<$command, @names> )" }, "id646" : { "name" : "references", "id" : "id646", "intro" : "Returns an unsorted LIST of @locations. When data are specified,\nthen those will be used to replace all currently defined references.
\n", "type" : "i_method", "call" : "$obj->references( [$locations|@locations|\\@locations] )" }, "id346" : { "level" : 3, "name" : "Translation syntax", "id" : "id346", "intro" : "Let say that your translation function is called 'loc', which is the\ndefault name. Then, you can use that name as simple function.
\n\nIn these examples, PAIRS is a list of values to be inserted in the\nmsgid string. When the msgid is specified with a plural alternative,\nthen a COUNTER value is required to indicate which alternative is\nrequired.
\n [% loc(\"msgid\", PAIRS) %]\n [% loc('msgid', PAIRS) %]\n [% loc(\"msgid|plural\", COUNTER, PAIRS) %]\n [% loc(\"msgid|plural\", _count => COUNTER, PAIRS) %]\n\n [% INCLUDE\n title = loc('something')\n %]\n\n\nBut also as filter. Although filters and functions work differently\ninternally in Template Toolkit, it is convenient to permit both syntaxes.
\n\n [% | loc(PAIRS) %]msgid[% END %]\n [% 'msgid' | loc(PAIRS) %]\n [% \"msgid\" | loc(PAIRS) %]\n\n [% \"msgid|plural\" | loc(COUNTER, PAIRS) %]\n [% \"msgid|plural\" | loc(_count => COUNTER, PAIRS) %]\n [% FILTER loc %]msgid[% END %]\n [% FILTER loc(COUNTER, PAIRS) %]msgid|plural[% END %]\n\n\n
As examples
\n\n [% loc(\"hi {n}\", n => name) %]\n [% | loc(n => name) %]hi {n}[% END %]\n [% \"hi {n}\" | loc(n => name) %]\n [% loc(\"one person|{_count} people\", size) %]\n [% | loc(size) %]one person|{_count} people[% END %]\n [% 'one person|{_count} people' | loc(size) %]\n\n\nThese syntaxes work exacly like translations with Log::Report for your\nPerl programs. Compare this with:
\n\n __x\"hi {n}\", n => name; # equivalent to\n __x(\"hi {n}\", n => name); # replace __x() by loc()\n\n",
"type" : "subsection",
"path" : "DETAILS/Supported syntax/Translation syntax"
},
"id1198-id1021" : {
"extends" : "id1198",
"name" : "linenr",
"type" : "option",
"intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(linenr)
", "id" : "id1198-id1021", "params" : "INTEGER" }, "id144" : { "inheritance" : { "extends" : [ "Exporter" ] }, "id" : "id144", "title" : "pick Log::Report or ::Minimal", "is_pure_pod" : false, "distribution" : "Log-Report-Optional", "package" : "Log::Report::Optional", "version" : "1.08", "chapters" : [ "id145", "id1334", "id146", "id147", "id148" ], "name" : "Log::Report::Optional" }, "id453" : { "name" : "find", "intro" : "Lookup the best translation table, according to the rules described\nin chapter DETAILS, below.
\n\nReturned is a filename, or undef if nothing is defined for the\n$locale (there is no default on this level).
Inherited, see Log::Report::Message::new(_count)
", "id" : "id950-id221" }, "id1114" : { "name" : "unable to rotate logfile $fn to $oldfn: $!", "subroutine" : "id1112", "id" : "id1114", "type" : "fault" }, "id1102" : { "name" : "charset", "id" : "id1102", "value" : "LC_CTYPE", "type" : "default" }, "id932" : { "id" : "id932", "intro" : "Returns the CODE ref which formats the syslog line.
\n", "type" : "i_method", "call" : "$obj->format( [CODE] )", "name" : "format" }, "id1022" : { "path" : "NAME", "intro" : "Log::Report::Dispatcher::Try - capture all reports as exceptions
\n", "type" : "chapter", "id" : "id1022", "name" : "NAME", "level" : 1 }, "id95" : { "name" : "Interpolation: Serialization", "level" : 2, "path" : "DETAILS/Interpolation: Serialization", "id" : "id95", "intro" : "The 'interpolation' functions have named VARIABLES to be filled-in, but\nalso additional OPTIONS. To distinguish between the OPTIONS and VARIABLES\n(both a list of key-value pairs), the keys of the OPTIONS start with\nan underscore _. As result of this, please avoid the use of keys\nwhich start with an underscore in variable names. On the other hand,\nyou are allowed to interpolate OPTION values in your strings.
There is no way of checking beforehand whether you have provided all\nvalues to be interpolated in the translated string. When you refer to\nvalue which is missing, it will be interpreted as undef.
,␣ between the elements.\nAlternatively (maybe nicer), you can pass an interpolation parameter\nvia the _join OPTION.\n\n printi \"matching files: {files}\", files => \\@files, _join => ', '\n\n\n\n\n\n $key => $value, $key2 => $value2, ...\n\n\n
There is no quoting on the keys or values (yet). Usually, this will\nproduce an ugly result anyway.
\n\n\n\nserialization parameter, you can overrule the interpolation\nof above defaults, but also add rules for your own objects. By default,\nobjects get stringified.\n\n serialization => [ $myclass => \\&name_in_reverse ]\n\n sub name_in_reverse($$$)\n { my ($formatter, $object, $args) = @_;\n # the $args are all parameters to be filled-in\n scalar reverse $object->name;\n }\n\n\nVarious template systems use different conventions for denoting strings\nto be translated.
\n", "path" : "DETAILS/Scan Patterns", "level" : 2, "name" : "Scan Patterns" }, "id1111" : { "level" : 2, "name" : "File maintenance", "subroutines" : [ "id1112" ], "id" : "id1111", "type" : "section", "path" : "METHODS/File maintenance" }, "id668" : { "call" : "$obj->useless", "id" : "id668", "intro" : "[1.02] The message-id has no references anymore and no translations.
\n", "type" : "i_method", "name" : "useless" }, "id1182-id905" : { "name" : "isDisabled", "extends" : "id1182", "type" : "i_method", "intro" : "Inherited, see Log::Report::Dispatcher::isDisabled()
", "id" : "id1182-id905", "call" : "$obj->isDisabled" }, "id1006-id221" : { "call" : "$obj->freeze( %options )", "id" : "id1006-id221", "intro" : "Inherited, see Log::Report::Message::freeze()
", "type" : "i_method", "options" : [ [ "id1007-id221", "id1008-id221" ] ], "extends" : "id1006", "name" : "freeze" }, "id941-id221" : { "call" : "overload '&{}'; used as function", "intro" : "Inherited, see Log::Report::Message subroutine '&{}'
", "id" : "id941-id221", "type" : "overload", "name" : "'&{}'", "extends" : "id941" }, "id781" : { "intro" : "Log::Report::Dispatcher::Log4perl - send messages to Log::Log4perl back-end
\n", "type" : "chapter", "id" : "id781", "path" : "NAME", "level" : 1, "name" : "NAME" }, "id1075" : { "name" : "callback", "value" : "<required>", "id" : "id1075", "type" : "default" }, "id682" : { "name" : "nr_plurals", "type" : "option", "intro" : "The number of translations each of the translation with plural form\nneed to have.
\n", "id" : "id682", "params" : "INTEGER" }, "id1208-id1021" : { "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(abstract)
", "type" : "option", "id" : "id1208-id1021", "params" : "INTEGER", "extends" : "id1208", "name" : "abstract" }, "id294" : { "name" : "METHODS", "level" : 1, "path" : "METHODS", "subroutines" : [ "id295" ], "type" : "chapter", "id" : "id294" }, "id534" : { "name" : "cleanup", "call" : "$obj->cleanup( %options )", "type" : "i_method", "intro" : "Remove all references.
\n", "id" : "id534", "options" : [ [ "id535", "id536" ] ] }, "id589" : { "call" : "$class->new( %options )", "id" : "id589", "type" : "c_method", "options" : [ [ "id590", "id591" ] ], "name" : "new" }, "id368" : { "name" : "pattern", "type" : "i_method", "id" : "id368", "call" : "$obj->pattern" }, "id81" : { "params" : "STRING|OBJECT", "intro" : "Text as STRING prepended before $format, without interpolation. This\nmay also be an OBJECT which gets stringified, but variables not filled-in.
\n", "type" : "option", "id" : "id81", "name" : "_prepend" }, "id799" : { "call" : "$obj->reasonToLevel( $reason )", "id" : "id799", "intro" : "Returns a level which is understood by Log::Dispatch, based on\na translation table. This can be changed with new(to_level).
\n", "type" : "i_method", "examples" : [ "id800" ], "name" : "reasonToLevel" }, "id1292" : { "nest" : [ "id1293", "id1294" ], "id" : "id1292", "type" : "chapter", "level" : 1, "name" : "DETAILS", "path" : "DETAILS" }, "id231" : { "name" : "reason", "call" : "$obj->reason( [$reason] )", "type" : "i_method", "intro" : "Get or set the reason of a message.
\n", "id" : "id231" }, "id591" : { "name" : "rules", "type" : "default", "value" : "{}", "id" : "id591" }, "id1295" : { "level" : 3, "name" : "Addition information", "id" : "id1295", "type" : "subsection", "path" : "DETAILS/Processing the message/Addition information" }, "id989-id221" : { "name" : "msgctxt", "extends" : "id989", "intro" : "Inherited, see Log::Report::Message::msgctxt()
", "type" : "i_method", "id" : "id989-id221", "call" : "$obj->msgctxt" }, "id749" : { "name" : "translations", "intro" : "Returns a list with all defined Log::Report::Lexicon::PO objects. When\nthe string $active is given as parameter, only objects which have\nreferences are returned.
\n", "diagnostics" : [ "id750" ], "call" : "$obj->translations( [$active] )", "id" : "id749", "type" : "i_method" }, "id541" : { "id" : "id541", "type" : "error", "name" : "no context tags allowed in plural `$msgid'", "subroutine" : "id540" }, "id752-id461" : { "subroutine" : "id751", "name" : "there is no Plural-Forms field in the header, but needed.", "extends" : "id752", "type" : "error", "intro" : "Inherited, see Log::Report::Lexicon::Table::pluralIndex()
", "id" : "id752-id461" }, "id804" : { "id" : "id804", "intro" : "Get messages to users and logs. Log::Report combines three tasks\nwhich are closely related in one:
gettext and Locale::TextDomain)You do not need to use this module for all three reasons: pick what\nyou need now, maybe extend the usage later. Read more about how and\nwhy in the DETAILS section, below. Especially, you should B
Also, you can study this module swiftly via the article published in\nthe German Perl $foo-magazine. English version:\nhttps://perl.overmeer.net/log-report/papers/201306-PerlMagazine-article-en.html
# Objects created by Log::Report's __ functions\n # Full feature description in the DETAILS section\n\n # no interpolation\n __\"Hello, World\";\n\n # with interpolation\n __x\"age {years}\", years => 12;\n\n # interpolation for one or many\n my $nr_files = @files;\n __nx\"one file\", \"{_count} files\", $nr_files;\n __nx\"one file\", \"{_count} files\", \\@files;\n\n # interpolation of arrays\n __x\"price-list: {prices%.2f}\", prices => \\@prices, _join => ', ';\n\n # white-spacing on msgid preserved\n print __\"\\tCongratulations,\\n\";\n print \"\\t\", __(\"Congratulations,\"), \"\\n\"; # same\n\n # Object serialization support\n my $clone = Log::Report::Message->thaw($msg->freeze);\n\n",
"type" : "chapter",
"id" : "id937",
"name" : "SYNOPSIS",
"level" : 1
},
"id303" : {
"type" : "chapter",
"id" : "id303",
"nest" : [
"id304",
"id317",
"id320",
"id336",
"id337",
"id338"
],
"path" : "METHODS",
"name" : "METHODS",
"level" : 1
},
"id1347" : {
"path" : "INHERITANCE",
"intro" : "Log::Report::Dispatcher::Try\n is a Log::Report::Dispatcher\n\n", "id" : "id1347", "type" : "chapter", "name" : "INHERITANCE", "level" : 1 }, "id635" : { "value" : "
[]",
"type" : "default",
"id" : "id635",
"name" : "format"
},
"id991-id221" : {
"call" : "$obj->classes",
"type" : "i_method",
"intro" : "Inherited, see Log::Report::Message::classes()
", "id" : "id991-id221", "name" : "classes", "extends" : "id991" }, "id603" : { "nest" : [ "id604", "id605" ], "id" : "id603", "type" : "chapter", "level" : 1, "name" : "DETAILS", "intro" : "The \"contexts\" concept in (GNU's version of) gettext, has a\nvery restricted purpose: to separate two (accidental) uses of the\nsame message-id, under different circumstances. The same msgid may\ntranslated diffently in one file or the other.
\n\nFor instance, two libraries used in the same application, or two\ncomponentent within a single library both want to used the same\ndefault text (which usually is very short)
\n\n char * t1 = pgettext('interface', 'None');\n char * t2 = pgettext('selections', 'None');\n\n\nSome translation setups use the library name consequently as msgctxt.\nBut, the name \"context\" is pretending much more power than the gettext\nlibraries are capable of: it usually only behaves like a namespace.
\n", "path" : "DETAILS" }, "id1185-id905" : { "name" : "close", "extends" : "id1185", "intro" : "Inherited, see Log::Report::Dispatcher::close()
", "id" : "id1185-id905", "type" : "i_method", "call" : "$obj->close" }, "id244" : { "intro" : "Returns the Log::Report::Template object which is performing the\ntemplate processing. This object gets instantiated based on values\nfound in the Dancer2 configuration file.
\n", "type" : "i_method", "id" : "id244", "call" : "$obj->tt", "name" : "tt" }, "id678" : { "name" : "textdomain", "type" : "option", "intro" : "The package name, used in the directory structure to store the\nPO files.
\n", "id" : "id678", "params" : "STRING" }, "id1105" : { "name" : "dispatcher $name needs parameter 'to'", "subroutine" : "id1097", "type" : "error", "id" : "id1105" }, "id1025" : { "level" : 1, "name" : "OVERLOADED", "id" : "id1025", "type" : "chapter", "subroutines" : [ "id1027", "id1026" ], "path" : "OVERLOADED" }, "id687" : { "id" : "id687", "value" : "<constructed from nr_plurals and plural_alg>", "type" : "default", "name" : "plural_forms" }, "id985" : { "name" : "append", "intro" : "Returns the string or Log::Report::Message object which is appended\nafter this one. Usually undef.
Run-modes are explained in Log::Report::Dispatcher.
\n", "type" : "section", "id" : "id131", "subroutines" : [ "id132", "id133", "id135", "id134" ], "path" : "FUNCTIONS/Modes", "level" : 2, "name" : "Modes" }, "id387" : { "path" : "SYNOPSIS", "intro" : "my $templater = Log::Report::Template->new(...);\n my $domain = $templater->addTextdomain(%options);\n\n", "type" : "chapter", "id" : "id387", "name" : "SYNOPSIS", "level" : 1 }, "id1169-id1066" : { "type" : "option", "intro" : "
Inherited, see Log::Report::Dispatcher::new(mode)
", "id" : "id1169-id1066", "params" : "'NORMAL'|'VERBOSE'|'ASSERT'|'DEBUG'|0..3", "extends" : "id1169", "name" : "mode" }, "id550" : { "level" : 1, "name" : "NAME", "id" : "id550", "intro" : "Log::Report::Win32Locale - unix/windows locales
\n", "type" : "chapter", "path" : "NAME" }, "id696" : { "name" : "charset", "params" : "STRING", "intro" : "The character-set which is used for the file. You must specify\nthis explicitly.
\n", "type" : "option", "id" : "id696" }, "id194" : { "name" : "warning", "type" : "function", "id" : "id194", "call" : "warning( $message )" }, "id396" : { "name" : "lexicon", "params" : "DIRECTORY", "id" : "id396", "type" : "option" }, "id523" : { "value" : "'utf-8'", "id" : "id523", "type" : "default", "name" : "charset" }, "id1166" : { "value" : "depend on mode",
"id" : "id1166",
"type" : "default",
"name" : "accept"
},
"id1206-id1066" : {
"extends" : "id1206",
"name" : "max_params",
"intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(max_params)
", "type" : "option", "id" : "id1206-id1066", "params" : "INTEGER" }, "id615" : { "nest" : [ "id616", "id637", "id656" ], "type" : "chapter", "id" : "id615", "level" : 1, "name" : "METHODS", "path" : "METHODS" }, "id676" : { "params" : "STRING", "intro" : "The charset to be used for the createed file. It is unwise to use anything\nelse than 'UTF-8', but allowed. Before [1.09] this option was required.
\n", "type" : "option", "id" : "id676", "name" : "charset" }, "id1147" : { "level" : 2, "name" : "Translating", "subroutines" : [ "id172-id1122", "id1151", "id1153", "id1152", "id1148" ], "id" : "id1147", "type" : "section", "path" : "METHODS/Translating" }, "id561" : { "chapters" : [ "id562", "id1353", "id563", "id564", "id565" ], "name" : "Log::Report::Lexicon::POTcompact", "version" : "1.16", "is_pure_pod" : false, "distribution" : "Log-Report-Lexicon", "package" : "Log::Report::Lexicon::POTcompact", "id" : "id561", "inheritance" : { "extends" : [ "Log::Report::Lexicon::Table" ] }, "title" : "use translations from a POT file" }, "id917" : { "type" : "option", "intro" : "The possible values for this depend (a little) on the system. POSIX\nonly defines user, and local0 up to local7.
Log::Report::Template::Textdomain",
"id" : "id315"
},
"id376" : {
"name" : "need pattern to scan for, either via new() or process().",
"subroutine" : "id370",
"id" : "id376",
"type" : "error"
},
"id769" : {
"id" : "id769",
"intro" : "Restrict the messages which are passed through based on the $level,\nso after the reason got translated into a Log::Dispatch compatible\nLEVEL. The default will use Log::Report restrictions only.
\n", "type" : "option", "params" : "$level", "name" : "min_level" }, "id1209" : { "id" : "id1209", "value" : "1", "type" : "default", "name" : "abstract" }, "id174" : { "name" : "NAME", "level" : 1, "path" : "NAME", "type" : "chapter", "intro" : "Log::Report::Minimal - simulate Log::Report functions simple
\n", "id" : "id174" }, "id698" : { "name" : "cannot read in $cs from file $fn: $!", "subroutine" : "id695", "id" : "id698", "type" : "fault" }, "id1189-id1066" : { "call" : "$any->addSkipStack( @CODE )", "intro" : "Inherited, see Log::Report::Dispatcher::addSkipStack()
", "id" : "id1189-id1066", "type" : "ci_method", "extends" : "id1189", "name" : "addSkipStack" }, "id50" : { "type" : "chapter", "intro" : "This module inserts values into (format) strings. It provides printf()\nand sprintf() alternatives via both an object oriented and a functional\ninterface.
Read in the DETAILS chapter below, why this module provides a better\nalternative for printf(). Also, some extended examples can be\nfound down there. Take a look at them first, when you start using this\nmodule!
This method is called by Log::Report::report() and should not be called\ndirectly. Internally, it will call translate(), which does most of\nthe work.
\n", "id" : "id1186", "call" : "$obj->log( \\%options, $reason, $message, $domain )", "name" : "log" }, "id398" : { "name" : "templater", "type" : "option", "id" : "id398", "params" : "Log::Report::Template-object" }, "id1176-id1217" : { "type" : "error", "intro" : "Inherited, see Log::Report::Dispatcher::new()
", "id" : "id1176-id1217", "subroutine" : "id1164", "extends" : "id1176", "name" : "illegal format_reason '$format' for dispatcher" }, "id1170-id1021" : { "name" : "mode", "intro" : "Inherited, see Log::Report::Dispatcher::new(mode)
", "extends" : "id1170", "value" : "'NORMAL'", "id" : "id1170-id1021", "type" : "default" }, "id857" : { "name" : "N__n", "examples" : [ "id858" ], "call" : "N__n( $single_msgid, $plural_msgid )", "id" : "id857", "intro" : "Label to indicate that the two MSGIDs are related, the first as\nsingle, the seconds as its plural. Only used to find the text\nfragments to be translated. The function itself does nothing.
\n", "type" : "function" }, "id1196-id1066" : { "params" : "STRING", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(filename)
", "id" : "id1196-id1066", "type" : "option", "name" : "filename", "extends" : "id1196" }, "id971-id221" : { "extends" : "id971", "id" : "id971-id221", "value" : "undef",
"type" : "default",
"name" : "_to",
"intro" : "Inherited, see Log::Report::Message::new(_to)
" }, "id1199" : { "name" : "linenr", "type" : "default", "value" : "<required>", "id" : "id1199" }, "id111" : { "intro" : "In pure Template Toolkit, you would write
\n\n # in your TT-template\n <div>Username: [% username | html %]</div>\n # in your code\n username => $user->name,\n\n\n
With plain String::Print with output encoding enabled, you can do:
\n\n # in your TT-template\n <div>[% show_username %]</div>\n # in your code with encodeFor('HTML')\n show_username => printi(\"Username: {user}\", user => $user->name),\n # or\n show_username => printp(\"Username: %s\", $user->name),\n\n\nThat does not look very efficient, however it changes for the good when\nthis is combined with Log::Report::Lexicon (translations) You can\neither do:
\n\n # in your TT-template\n <div>[% show_username %]</div>\n # in your code with encodeFor('HTML')\n show_username => __x(\"Username: {user}\", user => $user->name),\n\n\nShorter:
\n\n # in your TT-template with encodeFor('HTML')\n <div>[% loc(\"Username: {user}\", user => username) %]</div>\n # in your code\n username => $user->name,\n\n\nEven shorter:
\n\n # in your TT-template with encodeFor('HTML')\n <div>[% loc(\"Username: {user.name}\", user => userobj) %]</div>\n # in your code\n userobj => $user,\n\n\nShortest:
\n\n # in your TT-template with encodeFor('HTML')\n <div>[% loc(\"Username: {user.name}\") %]</div>\n # in your code\n user => $user,\n\n\nShorter that the original, and translations for free!\nMore examples in Log::Report::Template.
\n", "id" : "id111", "type" : "subsection", "path" : "DETAILS/Output encoding/Example with Log::Report::Template", "level" : 3, "name" : "Example with Log::Report::Template" }, "id62" : { "name" : "defaults", "type" : "option", "intro" : "[1.00] change the defaults for some modifiers. This is a %map of\nmodifier name to HASH with modifier specific settings.
\n", "id" : "id62", "params" : "\\%map" }, "id1165-id905" : { "id" : "id1165-id905", "intro" : "Inherited, see Log::Report::Dispatcher::new(accept)
", "type" : "option", "params" : "$reasons|\\@reasons", "extends" : "id1165", "name" : "accept" }, "id1305" : { "subroutines" : [ "id751-id461", "id749-id461", "id755-id461", "id753-id461", "id748-id461", "id756-id461" ], "id" : "id1305", "type" : "subsection", "path" : "METHODS/Managing PO's/Administration", "level" : 3, "name" : "Administration" }, "id521-id493" : { "type" : "default", "id" : "id521-id493", "value" : "<required>", "extends" : "id521", "intro" : "Inherited, see Log::Report::Extract::new(lexicon)
", "name" : "lexicon" }, "id1191-id1217" : { "id" : "id1191-id1217", "intro" : "Inherited, see Log::Report::Dispatcher::skipStack()
", "type" : "i_method", "call" : "$obj->skipStack", "name" : "skipStack", "extends" : "id1191" }, "id666" : { "subroutine" : "id663", "name" : "too many plurals for '$msgid': $got > $expect.", "type" : "warning", "id" : "id666" }, "id900" : { "name" : "Translation", "level" : 3, "path" : "DETAILS/Interpolation via formats/Translation", "intro" : "Translating is optional.
\n\nDistribution Log::Report::Lexicon handles translations. It will help\nyou manage all __x() (and friends) format strings in GNU's PO file\nformat (https://www.gnu.org/software/gettext/manual/html_node/PO-Files.html)
\n\nWith Log::Report::Template, you can use Log::Report with translations\nin various website template systems.
\n\nThen, Dancer2::Plugin::LogReport brings Log::Report with exceptions\nand translations to the Dancer2 web framework.
\n", "id" : "id900", "type" : "subsection" }, "id912" : { "name" : "format_reason", "type" : "default", "value" : "'IGNORE'", "id" : "id912" }, "id1302" : { "level" : 3, "name" : "Translation", "type" : "subsection", "id" : "id1302", "subroutines" : [ "id716", "id715" ], "path" : "METHODS/Managing PO's/Translation" }, "id1314" : { "level" : 3, "name" : "Addition information", "type" : "subsection", "id" : "id1314", "path" : "DETAILS/Processing the message/Addition information" }, "id164" : { "call" : "$obj->format", "type" : "i_method", "intro" : "Returns the CODE which implements the formatting. It needs to be called with a\nmsgid and a HASH with arguments, usually via interpolate().
\n", "id" : "id164", "name" : "format" }, "id366" : { "path" : "METHODS/Attributes", "id" : "id366", "type" : "section", "subroutines" : [ "id528-id354", "id529-id354", "id531-id354", "id530-id354", "id527-id354", "id368", "id367" ], "name" : "Attributes", "level" : 2 }, "id1174-id1066" : { "name" : "charset", "intro" : "Inherited, see Log::Report::Dispatcher::new(charset)
", "extends" : "id1174", "id" : "id1174-id1066", "value" : "undef",
"type" : "default"
},
"id779" : {
"call" : "$obj->reasonToLevel( $reason )",
"intro" : "Returns a level which is understood by Log::Dispatch, based on\na translation table. This can be changed with new(to_level).
\n", "id" : "id779", "type" : "i_method", "name" : "reasonToLevel" }, "id1193-id1021" : { "id" : "id1193-id1021", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine()
", "type" : "ci_method", "options" : [ [ "id1208-id1021", "id1209-id1021" ], [ "id1200-id1021", "id1201-id1021" ], [ "id1196-id1021", "id1197-id1021" ], [ "id1198-id1021", "id1199-id1021" ], [ "id1204-id1021", "id1205-id1021" ], [ "id1206-id1021", "id1207-id1021" ], [ "id1194-id1021", "id1195-id1021" ], [ "id1202-id1021", "id1203-id1021" ] ], "call" : "$any->stackTraceLine( %options )", "extends" : "id1193", "name" : "stackTraceLine" }, "id571" : { "type" : "fault", "id" : "id571", "name" : "cannot read in $charset from file $fn: $!", "subroutine" : "id567" }, "id852" : { "id" : "id852", "intro" : "It depends on the value of $count (and the selected language) which\ntext will be displayed. See details in __n(). After translation,\nthe VARIABLES will be filled-in.
\n\nThe PAIRS are options for Log::Report::Message::new() and variables\nto be filled in.
\n", "type" : "function", "call" : "__nx( $msgid, $plural_msgid, $count, PAIRS )", "examples" : [ "id853" ], "name" : "__nx" }, "id1197-id1091" : { "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(filename)
", "name" : "filename", "id" : "id1197-id1091", "value" : "<required>", "type" : "default", "extends" : "id1197" }, "id1204-id1217" : { "name" : "max_line", "extends" : "id1204", "params" : "INTEGER", "id" : "id1204-id1217", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(max_line)
", "type" : "option" }, "id274" : { "call" : "$obj->success", "id" : "id274", "intro" : "This is a special additional type, equivalent to notice. The difference is\nthat messages using this keyword will have the class success added, which\ncan be used to color the messages differently to the end user. For example,\nmanual Dancer2::Plugin::LogReport::Message#bootstrap_color uses this to display the\nmessage in green.
Inherited, see Log::Report::Dispatcher::stackTraceLine(call)
", "name" : "call" }, "id211" : { "id" : "id211", "type" : "section", "subroutines" : [ "id212" ], "path" : "FUNCTIONS/Configuration", "level" : 2, "name" : "Configuration" }, "id648" : { "call" : "$obj->removeReferencesTo( $filename )", "intro" : "Remove all the references to the indicate $filename from the list. Returns\nthe number of refs left.
\n", "id" : "id648", "type" : "i_method", "name" : "removeReferencesTo" }, "id484" : { "type" : "error", "id" : "id484", "name" : "cannot detect charset in $fn.", "subroutine" : "id467" }, "id439" : { "subroutine" : "id438", "name" : "unknown translation table extension '$ext' in $file.", "type" : "error", "id" : "id439" }, "id348" : { "name" : "Translation into HTML", "level" : 3, "path" : "DETAILS/Supported syntax/Translation into HTML", "intro" : "Usually, when data is passed from the program's internal to the template,\nit should get encoded into HTML to escape some characters. Typical TT\ncode:
\n\n Title: [% title | html %]\n\n\n
When your insert is produced by the localizer, you can do this as well\n(set template_syntax to 'UNKNOWN' first)
\n [% loc(\"Title: {t}\", t => title) | html %]\n\n\nThe default TT syntax is 'HTML', which will circumvent the need to\nuse the html filter. In that default case, you only say:
\n\n [% loc(\"Title: {t}\", t => title) %]\n [% loc(\"Title: {title}\") %] # short form, see previous section\n\n\nWhen the title is already escaped for HTML, you can circumvent that\nby using tags which end on 'html':
\n\n [% loc(\"Title: {t_html}\", t_html => title) %]\n\n [% SET title_html = html(title) %]\n [% loc(\"Title: {title_html}\") %]\n\n",
"type" : "subsection",
"id" : "id348"
},
"id83" : {
"name" : "_append",
"intro" : "Text as STRING appended after $format, without interpolation.
\n", "type" : "option", "id" : "id83", "params" : "STRING|OBJECT" }, "id1203-id1021" : { "id" : "id1203-id1021", "value" : "<required>", "type" : "default", "extends" : "id1203", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(params)
", "name" : "params" }, "id961-id221" : { "name" : "_append", "intro" : "Inherited, see Log::Report::Message::new(_append)
", "extends" : "id961", "id" : "id961-id221", "type" : "default", "value" : "undef"
},
"id1207-id1091" : {
"intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(max_params)
", "name" : "max_params", "type" : "default", "id" : "id1207-id1091", "value" : "8", "extends" : "id1207" }, "id1194-id1217" : { "extends" : "id1194", "name" : "package", "id" : "id1194-id1217", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(package)
", "type" : "option", "params" : "CLASS" }, "id1180-id780" : { "call" : "$obj->type", "intro" : "Inherited, see Log::Report::Dispatcher::type()
", "id" : "id1180-id780", "type" : "i_method", "extends" : "id1180", "name" : "type" }, "id514" : { "level" : 1, "name" : "NAME", "type" : "chapter", "intro" : "Log::Report::Extract - Collect translatable strings
\n", "id" : "id514", "path" : "NAME" }, "id1171-id1066" : { "extends" : "id1171", "name" : "format_reason", "id" : "id1171-id1066", "intro" : "Inherited, see Log::Report::Dispatcher::new(format_reason)
", "type" : "option", "params" : "'UPPERCASE'|'LOWERCASE'|'UCFIRST'|'IGNORE'|CODE" }, "id1311" : { "path" : "DETAILS", "level" : 1, "name" : "DETAILS", "id" : "id1311", "type" : "chapter", "nest" : [ "id1312", "id1313" ] }, "id1195" : { "name" : "package", "type" : "default", "value" : "<required>", "id" : "id1195" }, "id866" : { "path" : "FUNCTIONS/Configuration", "id" : "id866", "type" : "section", "subroutines" : [ "id867", "id883", "id882" ], "name" : "Configuration", "level" : 2 }, "id163" : { "name" : "isConfigured", "type" : "i_method", "id" : "id163", "call" : "$obj->isConfigured" }, "id1061" : { "path" : "SYNOPSIS", "intro" : "use MojoX::Log::Report;\n my $log = MojoX::Log::Report->new(%options);\n $app->log($log); # install logger in the Mojo::App\n\n", "type" : "chapter", "id" : "id1061", "name" : "SYNOPSIS", "level" : 1 }, "id273" : { "call" : "$obj->panic", "type" : "i_method", "id" : "id273", "name" : "panic" }, "id652" : { "call" : "$obj->format( $language | <PAIRS|ARRAY|HASH> )", "intro" : "
When one $language is specified, it looks whether a \"language-format\" or\n\"no-language-format\" is present in the line of FLAGS. This will return\n1 (true) in the first case, 0 (false) in the second case. It will\nreturn undef (also false) in case that both are not present.
You can also specify PAIRS: the key is a language name, and the\nvalue is either 0, 1, or undef.
Directory where the translation tables are kept.
\n", "type" : "i_method", "call" : "$obj->lexicon" }, "id1309" : { "level" : 3, "name" : "Addition information", "id" : "id1309", "type" : "subsection", "path" : "DETAILS/Processing the message/Addition information" }, "id751" : { "intro" : "Returns the msgstr index used to translate a value of $count.
\n", "name" : "pluralIndex", "call" : "$obj->pluralIndex( $count )", "diagnostics" : [ "id752" ], "type" : "i_method", "id" : "id751" }, "id1169-id905" : { "extends" : "id1169", "name" : "mode", "intro" : "Inherited, see Log::Report::Dispatcher::new(mode)
", "type" : "option", "id" : "id1169-id905", "params" : "'NORMAL'|'VERBOSE'|'ASSERT'|'DEBUG'|0..3" }, "id559" : { "name" : "ms_install_codepage_id", "id" : "id559", "intro" : "Returns the numeric language ID for the installed codepage language.\nThis is like ms_codepage_id(), but refers to the codepage that was\nthe default when Windows was first installed.
\n", "type" : "function", "call" : "ms_install_codepage_id" }, "id352" : { "name" : "Keeping translations up to date", "level" : 3, "path" : "DETAILS/Extracting PO-files/Keeping translations up to date", "intro" : "You have to call extract() when msgids have changed or added,\nto have the PO-tables updated. The language specific tables will\nget updated automatically... look for msgids which are 'fuzzy'\n(need update)
\n\nYou may also use the external program xgettext-perl, which is\nshipped with the Log::Report::Lexicon distribution.
The POSIX printf() does not handle unicode strings. Perl does\nunderstand that the 's' modifier may need to insert utf8 so does not\ncount bytes but characters. printi() does not use characters but\n\"grapheme clusters\" via Unicode::GCString. Now, also composed\ncharacters do work correctly.
Additionally, you can use the new 'S' conversion to count in columns.\nIn fixed-width fonts, graphemes can have width 0, 1 or 2. For instance,\nChinese characters have width 2. When printing in fixed-width, this\n'S' is probably the better choice over 's'. When the field does not\nspecify its width, then there is no performance penalty for using 'S'.
\n\n # name right aligned, commas on same position, always\n printp \"name: {name%20S},\\n\", name => $some_chinese;\n\n",
"id" : "id98",
"path" : "DETAILS/Interpolation: Modifiers/Modifier: POSIX format starts with '%'/POSIX modifier extension '%S'"
},
"id1205" : {
"value" : "undef",
"type" : "default",
"id" : "id1205",
"name" : "max_line"
},
"id531-id493" : {
"intro" : "Inherited, see Log::Report::Extract::addPot()
", "type" : "i_method", "id" : "id531-id493", "call" : "$obj->addPot( $domain, $pot, %options )", "name" : "addPot", "extends" : "id531" }, "id848" : { "id" : "id848", "intro" : "This is by far the most used message constructor.
\n\n print __x\"Name {person.name}\", person => $person_obj;\n error __x\"Too many options: max 5, got {count}\", count => $c;\n fault __x\"Cannot open file {f}\", f => $input_filename;\n\n",
"type" : "example",
"name" : "how to use __x()\n"
},
"id740" : {
"level" : 2,
"name" : "Constructors",
"subroutines" : [
"id741"
],
"type" : "section",
"id" : "id740",
"path" : "METHODS/Constructors"
},
"id980-id221" : {
"extends" : "id980",
"name" : "clone",
"intro" : "Inherited, see Log::Report::Message::clone()
", "type" : "i_method", "id" : "id980-id221", "call" : "$obj->clone( %options, $variables )" }, "id483" : { "name" : "the header is not the first entry, needed for charset in $fn.", "subroutine" : "id467", "id" : "id483", "type" : "error" }, "id63" : { "name" : "defaults", "value" : "see modifier docs",
"id" : "id63",
"type" : "default"
},
"id208" : {
"name" : "N__",
"call" : "N__( $msgid )",
"id" : "id208",
"type" : "function"
},
"id1185-id1066" : {
"intro" : "Inherited, see Log::Report::Dispatcher::close()
", "id" : "id1185-id1066", "type" : "i_method", "call" : "$obj->close", "name" : "close", "extends" : "id1185" }, "id1064" : { "level" : 2, "name" : "Constructors", "id" : "id1064", "type" : "section", "subroutines" : [ "id1065" ], "path" : "METHODS/Constructors" }, "id1266" : { "name" : "on_die", "value" : "'ERROR'", "id" : "id1266", "type" : "default" }, "id513" : { "chapters" : [ "id514", "id1338", "id515", "id516", "id517" ], "name" : "Log::Report::Extract", "version" : "1.16", "package" : "Log::Report::Extract", "distribution" : "Log-Report-Lexicon", "is_pure_pod" : false, "title" : "Collect translatable strings", "id" : "id513", "inheritance" : { "extended_by" : [ "Log::Report::Extract::PerlPPI", "Log::Report::Template::Extract" ] } }, "id1182-id1066" : { "name" : "isDisabled", "extends" : "id1182", "intro" : "Inherited, see Log::Report::Dispatcher::isDisabled()
", "id" : "id1182-id1066", "type" : "i_method", "call" : "$obj->isDisabled" }, "id173" : { "chapters" : [ "id174", "id1359", "id175", "id176", "id177" ], "name" : "Log::Report::Minimal", "version" : "1.08", "is_pure_pod" : false, "package" : "Log::Report::Minimal", "distribution" : "Log-Report-Optional", "inheritance" : { "extends" : [ "Exporter" ] }, "id" : "id173", "title" : "simulate Log::Report functions simple" }, "id1187-id1021" : { "extends" : "id1187", "name" : "translate", "intro" : "Inherited, see Log::Report::Dispatcher::translate()
", "id" : "id1187-id1021", "type" : "i_method", "call" : "$obj->translate( \\%options, $reason, $message )" }, "id815" : { "type" : "default", "value" : "undef",
"id" : "id815",
"name" : "location"
},
"id876" : {
"id" : "id876",
"intro" : "use Log::Report mode => 3; # '3' or 'DEBUG', no domain given\n\n use Log::Report 'my-domain'; # in each package producing messages\n\n use Log::Report 'my-domain', # in one package, top of distr\n mode => 'VERBOSE',\n syntax => 'REPORT', # report ERROR, not error()\n translator => Log::Report::Translator::POT->new(\n lexicon => '/home/mine/locale', # translation tables\n ),\n native_language => 'nl_NL'; # untranslated msgs are Dutch\n\n use Log::Report import => 'try'; # or ARRAY of functions\n\n", "type" : "example", "name" : "of import\n" }, "id1137" : { "name" : "native_language", "id" : "id1137", "value" : "'en_US'", "type" : "default" }, "id580" : { "type" : "i_method", "intro" : "
Lookup the translations with the $msgid. Returns a SCALAR, when only\none translation is known, and an ARRAY where there are multiple.\nReturns undef when nothing about the translation is known.
The simple view on live says: you 're dead when you die. However,\nmore complex situations try to revive the dead. Typically, the \"die\"\nis considered a terminating exception, but not terminating the whole\nprogram, but only some logical block. Of course, a wrapper round\nthat block must decide what to do with these emerging problems.
\n\nJava-like languages do not \"die\" but throw exceptions which contain the\ninformation about what went wrong. Perl modules like Exception::Class\nsimulate this. It's a hassle to create exception class objects for each\nemerging problem, and the same amount of work to walk through all the\noptions.
Log::Report follows a simpler scheme. Fatal messages will \"die\", which is\ncaught with \"eval\", just the Perl way (used invisible to you). However,\nthe wrapper gets its hands on the message as the user has specified it:\nuntranslated, with all unprocessed parameters still at hand.
\n\n try { fault __x \"cannot open file {file}\", file => $fn };\n if($@) # is Log::Report::Dispatcher::Try\n { my $cause = $@->wasFatal; # is Log::Report::Exception\n $cause->throw if $cause->message->msgid =~ m/ open /;\n # all other problems ignored\n }\n\n\nSee Log::Report::Dispatcher::Try and Log::Report::Exception.
\n", "id" : "id898", "type" : "subsection", "path" : "DETAILS/Error handling models/Exceptions", "level" : 3, "name" : "Exceptions" }, "id955" : { "id" : "id955", "value" : "undef",
"type" : "default",
"name" : "_msgid"
},
"id1016" : {
"intro" : " # This tries to display the $param as useful and safe as possible,\n # where you have totally no idea what its contents is.\n error __x\"illegal parameter {p UNKNOWN}.\", p => $param;\n # ---> \"illegal parameter 'accidentally passed text'.\"\n # ---> \"illegal parameter Unexpected::Object::Type.\"\n\n # fault() adds \": $!\", with $! translated when configured.\n open my($fh), \"<:encoding(utf-8)\", $filename\n \t or fault __x\"cannot read {file}\", file => $filename;\n\n # Auto-abbreviation\n trace __x\"first lines: '{text EL}'\\n\", text => $t;\n # ---> \"first lines: 'This text is long, we sho⋯'.\\n\"\n\n trace __x\"first lines: {text CHOP}\\n\", text => $t;\n # ---> \"This text is long, we [+3712 chars]\\n\"\n\n info __x\"file {file} size {size BYTES}\\n\", file => $fn, size => -s $fn;\n # --> \"/etc/passwd size 23kB\\n\"\n\n # HASH or object values\n print __x\"Name: {user.first} {user.surname}\\n\", user => $login;\n\n\nThere are more nice standard interpolation modifiers, and you can add\nyour own. Besides, you can add serializers which determine how\nobjects are inlined.
\n", "id" : "id1016", "type" : "example", "name" : "using format features\n" }, "id357" : { "name" : "DESCRIPTION", "level" : 1, "path" : "DESCRIPTION", "intro" : "This module helps maintaining the POT files which list translatable\nstrings from template files (or other flat text files) by updating the\nlist of message-ids which are kept in them.
\n\nAfter initiation, the process() method needs to be called for each file\nin the domain and the existing PO files will get updated accordingly.
\n\nIf no translations exist yet, one $textdomain.po file will be\ncreated as point to start. Copy that file into $textdomain/$lang.po
With a filter, you can block or modify specific messages before\ntranslation. There may be a wish to change the REASON of a report\nor its content. It is not possible to avoid the exit which is\nrelated to the original message, because a module's flow depends\non it to happen.
\n\nWhen there are filters defined, they will be called in order of\ndefinition. For each of the dispatchers which are called for a\ncertain REASON (which accept that REASON), it is checked whether\nits name is listed for the filter (when no names where specified,\nthen the filter is applied to all dispatchers).
When selected, the filter's CODE reference is called with four arguments:\nthe dispatcher object (a Log::Report::Dispatcher), the HASH-of-OPTIONS\npassed as optional first argument to Log::Report::report(), the\nREASON, and the MESSAGE. Returned is the new REASON and MESSAGE.\nWhen the returned REASON is undef, then the message will be ignored\nfor that dispatcher.
Be warned about processing the MESSAGE: it is a Log::Report::Message\nobject which may have a prepend string and append string or\nobject. When the call to Log::Report::report() contained multiple\ncomma-separated components, these will already have been joined together\nusing concatenation (see Log::Report::Message::concat().
See reasonToLevel().
\n", "type" : "option", "params" : "ARRAY-of-PAIRS", "name" : "to_level" }, "id1183-id1091" : { "type" : "i_method", "intro" : "Inherited, see Log::Report::Dispatcher::needs()
", "id" : "id1183-id1091", "call" : "$obj->needs( [$reason] )", "extends" : "id1183", "name" : "needs" }, "id402" : { "intro" : "Upgrade a base class Log::Report::Domain-object into an Template\ndomain.
\n\nThis is a bit akward process, needed when one of the code packages\nuses the same domain as the templating system uses. The generic domain\nconfiguration stays intact.
\n", "name" : "upgrade", "call" : "$class->upgrade( $domain, %options )", "diagnostics" : [ "id403" ], "type" : "c_method", "id" : "id402" }, "id657" : { "name" : "fromText", "intro" : "Parse the STRING into a new PO object. The $where string should explain\nthe location of the STRING, to be used in error messages.
\n", "diagnostics" : [ "id658", "id659", "id660", "id661", "id662" ], "call" : "$class->fromText( STRING, [$where] )", "type" : "c_method", "id" : "id657" }, "id1211" : { "level" : 2, "name" : "Available back-ends", "intro" : "When a dispatcher is created (via new() or Log::Report::dispatcher()),\nyou must specify the TYPE of the dispatcher. This can either be a class\nname, which extends a Log::Report::Dispatcher, or a pre-defined\nabbreviation of a class name.
\n\nImplemented are:
\n\nprint(), warn() and die() to ventilate\nreports. This is the default dispatcher.\n\n\n\nLog::Dispatch::*Log::Log4perlundef",
"name" : "_prepend",
"intro" : "Inherited, see Log::Report::Message::new(_prepend)
" }, "id82" : { "id" : "id82", "value" : "undef",
"type" : "default",
"name" : "_prepend"
},
"id429" : {
"id" : "id429",
"intro" : "The $directory where the translations can be found. See\nLog::Report::Lexicon::Index for the expected structure of such\ndirectory.
\n\nThe default is based on the location of the module which instantiates\nthis translator. The filename of the module is stripped from its .pm\nextension, and used as directory name. Within that directory, there\nmust be a directory named messages, which will be the root directory\nof a Log::Report::Lexicon::Index.
Collect the information to be displayed as line where the error occurred.
\n", "id" : "id1192", "call" : "$any->collectLocation", "name" : "collectLocation" }, "id1168-id1091" : { "intro" : "Inherited, see Log::Report::Dispatcher::new(locale)
", "name" : "locale", "type" : "default", "id" : "id1168-id1091", "value" : "<system locale>", "extends" : "id1168" }, "id108" : { "level" : 3, "name" : "Private modifiers", "type" : "subsection", "intro" : "You may pass your own modifiers. A modifier consists of a selector and\na CODE, which is called when the selector matches. The selector is either\na string or a regular expression.
\n\n # in Object Oriented syntax:\n my $f = String::Print->new(\n modifiers => [ qr/[€₤]/ => \\&money ],\n );\n\n # in function syntax:\n use String::Print 'printi', 'sprinti',\n modifiers => [ qr/[€₤]/ => \\&money ];\n\n # the implementation:\n sub money$$$$)\n { my ($formatter, $modif, $value, $args) = @_;\n\n $modif eq '€' ? sprintf(\"%.2f EUR\", $value+0.0001)\n : $modif eq '₤' ? sprintf(\"%.2f GBP\", $value/1.16+0.0001)\n : 'ERROR';\n }\n\n\nUsing printp() makes it a little shorter, but will become quite\ncomplex when there are more parameter in one string.
\n\n printi \"price: {p€}\", p => $pi; # price: 3.14 EUR\n printi \"price: {p₤}\", p => $pi; # price: 2.71 GBP\n\n printp \"price: %{€}s\", $pi; # price: 3.14 EUR\n printp \"price: %{₤}s\", $pi; # price: 2.71 GBP\n\n\nThis is very useful in the translation context, where the translator can\nspecify abstract formatting rules. As example, see the (GNU) gettext\nfiles, in the translation table for Dutch into English. The translator\ntells us which currency to use in the display.
\n\n msgid \"kostprijs: {p€}\"\n msgstr \"price: {p₤}\"\n\n\nAnother example. Now, we want to add timestamps. In this case, we\ndecide for modifier names in \\w, so we need a blank to separate\nthe parameter from the modifer.
undef",
"id" : "id922",
"name" : "logsocket"
},
"id604" : {
"path" : "DETAILS/Contexts in Log::Report",
"type" : "section",
"intro" : "For Log::Report, the power of \"context\" is extended with selecting\nbetween alternatives for the use of a msgid on the same spot.
\n\nFor instance, the gender of the user of the website determines whether\n`he' or `she' needs to be used in the translation. In this example,\nthe gender is set as context keyword in the message:
\n\n my ($name, $sex) = ('Jack', 'male');\n print __x\"{name<gender} found his key\", name => $name,\n _context => \"gender=$sex\";\n\n\nThis would also be possible in traditional gettext, although probably\nrarely used. A complication is that the scripts to maintain the po\ntables are not too smart; do not understand complex code constructs.\nProbably this would beed needed:
\n\n if(sex==MALE)\n { printf pgettext('male', \"%s found his key\\n\", name);\n }\n else\n { printf pgettext('female', \"%s found her key\\n\", name);\n }\n\n",
"id" : "id604",
"name" : "Contexts in Log::Report",
"level" : 2
},
"id243" : {
"level" : 2,
"name" : "Attributes",
"subroutines" : [
"id244"
],
"type" : "section",
"id" : "id243",
"path" : "METHODS/Attributes"
},
"id106" : {
"level" : 3,
"name" : "Modifier: CHOP or CHOP($width, [$units])",
"intro" : "[1.00] When the string is larger than $width columns (defaults to\n20), then chop it short and add [+42]: the number of character\nchopped off. The $width is the size of the result string.\nThe comma is optional.
\n \"Intro: {text CHOP(10)}\"; # Intro: 12345[+42]\n \"Intro: {text CHOP(19 chars)}\"; # Intro: 1234578[+33 chars]\n \"Intro: {text CHOP(19, chars)}\"; # Intro: 1234578[+33 chars]\n\n\nThe same effect can be reached by setting the defaults
\n\n $sp->setDefaults(CHOP => +{width => 19, units => ' chars'});\n $sp->printi(\"Intro: {text CHOP}\", text => $t); # Intro: 1234578[+33 chars]\n\n\nOther defaults are head ([) and tail (]).
\n $sp->setDefaults(CHOP => +{head => '«', tail => '»'});\n $sp->printi(\"Intro: {text CHOP}\", text => $t); # Intro: 1234578«+12»\n\n",
"type" : "subsection",
"id" : "id106",
"path" : "DETAILS/Interpolation: Modifiers/Modifier: CHOP or CHOP($width, [$units])"
},
"id835" : {
"id" : "id835",
"intro" : "Short for report INFO => $message
Log::Report::Domain\n is a Log::Report::Minimal::Domain\n\n Log::Report::Domain is extended by\n Log::Report::Template::Textdomain\n\n", "id" : "id1337", "name" : "INHERITANCE", "level" : 1 }, "id1188-id1091" : { "intro" : "
Inherited, see Log::Report::Dispatcher::collectStack()
", "id" : "id1188-id1091", "type" : "ci_method", "call" : "$any->collectStack( [$maxdepth] )", "name" : "collectStack", "extends" : "id1188" }, "id304" : { "level" : 2, "name" : "Constructors", "id" : "id304", "type" : "section", "subroutines" : [ "id305" ], "path" : "METHODS/Constructors" }, "id534-id354" : { "call" : "$obj->cleanup( %options )", "intro" : "Inherited, see Log::Report::Extract::cleanup()
", "id" : "id534-id354", "type" : "i_method", "options" : [ [ "id535-id354", "id536-id354" ] ], "extends" : "id534", "name" : "cleanup" }, "id803" : { "name" : "SYNOPSIS", "level" : 1, "path" : "SYNOPSIS", "id" : "id803", "intro" : " # Invocation with 'mode' to get trace and verbose messages\n use Log::Report mode => 'DEBUG';\n\n # Usually invoked with a domain, which groups packages for translation\n use Log::Report 'my-domain', %options;\n\n # Interpolation syntax via String::Print\n # First step to translations, once you need it.\n print __x\"my name is {name}\", name => $n; # print, so no exception\n print __\"Hello World\\n\"; # no interpolation, optional translation\n print __x'Hello World'; # SYNTAX ERROR: quote is alternative for ::\n\n # Functions replacing die/warn/carp, casting exceptions but not message\n # objects and no translation support.\n error \"oops\"; # exception like die(), no translation\n -f $config or panic \"Help!\"; # alert/error/fault/info/...more\n\n # Combined exception, interpolation, and optional translation\n error __x\"Help!\"; # __x() creates ::Message object\n error __x('gettext msgid', param => $value, ...)\n if $condition;\n\n # Also non fatal \"exceptions\" find their way to dispatchers\n info __x\"started {pid}\", pid => $$; # translatable\n debug \"$i was here!\"; # you probably do not want to translate debug\n panic \"arrghhh\"; # like Carp::Confess\n\n # Many destinations for an exception message (may exist in parallel)\n dispatcher PERL => 'default', # see Log::Report::Dispatcher: use die/warn\n reasons => 'NOTICE-'; # this dispatcher is already present at start\n\n dispatcher SYSLOG => 'syslog' # also send to syslog,\n charset => 'iso-8859-1', # explicit character conversions\n locale => 'en_US'; # overrule user's locale\n\n dispatcher close => 'default' # stop default die/warn dispatcher\n\n # Fill-in values, like Locale::TextDomain and gettext\n # See Log::Report::Message section DETAILS\n fault __x\"cannot allocate {size} bytes\", size => $size;\n fault \"cannot allocate $size bytes\"; # no translation, ok\n fault __x\"cannot allocate $size bytes\"; # not translatable, wrong\n\n # Output (optionally with translation) depending on count\n # Leading and trailing whitespace stay magically outside translation\n # tables. @files in scalar context. Special parameter with _\n print __xn\"found one file\\n\", \"found {_count} files\", @files;\n\n # Borrow from an other text-domain (see Log::Report::Message)\n print __x(+\"errors in {line}\", _domain => 'global', line => $line);\n\n # catch errors (implements hidden eval/die)\n try { error };\n if($@) {...} # $@ isa Log::Report::Dispatcher::Try\n if(my $exception = $@->wasFatal) # ::Exception object\n\n # Language translations at the output component\n # Translation management via Log::Report::Lexicon\n use POSIX::1003::Locale qw/setlocale LC_ALL/;\n setlocale(LC_ALL, 'nl_NL');\n info __\"Hello World!\"; # in Dutch, if translation table found\n\n # Exception classes, see Log::Report::Exception\n try { error __x\"something\", _tags => 'parsing,schema' };\n if($@->wasFatal->taggedWith('parsing')) ...\n\n",
"type" : "chapter"
},
"id1171-id905" : {
"intro" : "Inherited, see Log::Report::Dispatcher::new(format_reason)
", "type" : "option", "id" : "id1171-id905", "params" : "'UPPERCASE'|'LOWERCASE'|'UCFIRST'|'IGNORE'|CODE", "extends" : "id1171", "name" : "format_reason" }, "id1057" : { "name" : "class", "value" : "undef",
"id" : "id1057",
"type" : "default"
},
"id1167-id1021" : {
"extends" : "id1167",
"name" : "locale",
"id" : "id1167-id1021",
"intro" : "Inherited, see Log::Report::Dispatcher::new(locale)
", "type" : "option", "params" : "LOCALE" }, "id221" : { "package" : "Dancer2::Plugin::LogReport::Message", "distribution" : "Dancer2-Plugin-LogReport", "is_pure_pod" : false, "title" : "extended Log::Report::Message class", "id" : "id221", "inheritance" : { "extends" : [ "Log::Report::Message" ] }, "chapters" : [ "id222", "id1326", "id223", "id224", "id1273", "id225", "id1275" ], "name" : "Dancer2::Plugin::LogReport::Message", "version" : "2.03" }, "id909" : { "level" : 1, "name" : "METHODS", "path" : "METHODS", "nest" : [ "id910", "id931", "id933" ], "type" : "chapter", "id" : "id909" }, "id748-id461" : { "name" : "add", "extends" : "id748", "call" : "$obj->add( $po )", "intro" : "Inherited, see Log::Report::Lexicon::Table::add()
", "type" : "i_method", "id" : "id748-id461" }, "id878" : { "type" : "error", "id" : "id878", "name" : "message_class $class does not extend $base", "subroutine" : "id867" }, "id887" : { "path" : "DETAILS", "level" : 1, "name" : "DETAILS", "id" : "id887", "type" : "chapter", "nest" : [ "id888", "id891", "id899", "id901" ] }, "id770" : { "value" : "debug",
"id" : "id770",
"type" : "default",
"name" : "min_level"
},
"id524" : {
"id" : "id524",
"type" : "error",
"subroutine" : "id519",
"name" : "extractions require an explicit lexicon directory."
},
"id193" : {
"call" : "notice( $message )",
"id" : "id193",
"type" : "function",
"name" : "notice"
},
"id896" : {
"name" : "the mode of a dispatcher\n",
"type" : "example",
"intro" : "my $mode = dispatcher(find => 'myname')->mode;\n\n", "id" : "id896" }, "id143" : { "type" : "warning", "id" : "id143", "name" : "conflict: package {pkg} in translation domain {domain1} in {file1} line {line1}, but in {domain2} in {file2} line {line2}.", "subroutine" : "id142" }, "id1196-id905" : { "params" : "STRING", "type" : "option", "intro" : "
Inherited, see Log::Report::Dispatcher::stackTraceLine(filename)
", "id" : "id1196-id905", "name" : "filename", "extends" : "id1196" }, "id625" : { "value" : "undef",
"type" : "default",
"id" : "id625",
"name" : "msgctxt"
},
"id846" : {
"name" : "how to use __()\n",
"intro" : " print __\"Hello World\"; # translated into user's language\n print __'Hello World'; # syntax error!\n print __('Hello World'); # ok, translated\n print __\"Hello\", \" World\"; # World not translated\n\n my $s = __\"Hello World\"; # creates object, not yet translated\n print ref $s; # Log::Report::Message\n print $s; # ok, translated\n print $s->toString('fr'); # ok, forced into French\n\n",
"type" : "example",
"id" : "id846"
},
"id927" : {
"intro" : "[1.10] With a CODE reference you get your hands on the text before\nit gets sent to syslog. The three parameters are: the (translated) text,\nthe related text domain object, and the message object. You may want to\nuse context information from the latter.
\n\n[1.19] After the three positional parameters, there may be a list of\npairs (named parameters) with additional info. This may contain a\nlocation with an ARRAY of information produced by caller() about the\norigin of the exception.
$e->message->concat('!!')); # will not work!\n $e->message($e->message->concat('!!'));\n\n $e->message(__x\"some message {xyz}\", xyz => $xyz);\n\n",
"id" : "id1247",
"type" : "example"
},
"id1029" : {
"level" : 2,
"name" : "Constructors",
"subroutines" : [
"id1030"
],
"id" : "id1029",
"type" : "section",
"path" : "METHODS/Constructors"
},
"id1109" : {
"name" : "format",
"type" : "i_method",
"id" : "id1109",
"call" : "$obj->format"
},
"id325" : {
"name" : "domains",
"call" : "$obj->domains",
"intro" : "Returns a LIST with all defined textdomains, unsorted.
\n", "id" : "id325", "type" : "i_method" }, "id523-id354" : { "id" : "id523-id354", "value" : "'utf-8'", "type" : "default", "extends" : "id523", "intro" : "Inherited, see Log::Report::Extract::new(charset)
", "name" : "charset" }, "id1180-id760" : { "name" : "type", "extends" : "id1180", "call" : "$obj->type", "intro" : "Inherited, see Log::Report::Dispatcher::type()
", "id" : "id1180-id760", "type" : "i_method" }, "id1286" : { "level" : 3, "name" : "Addition information", "type" : "subsection", "id" : "id1286", "path" : "DETAILS/Processing the message/Addition information" }, "id1084" : { "nest" : [ "id1085", "id1087", "id1088" ], "id" : "id1084", "type" : "chapter", "level" : 1, "name" : "METHODS", "path" : "METHODS" }, "id1165-id1066" : { "name" : "accept", "extends" : "id1165", "params" : "$reasons|\\@reasons", "intro" : "Inherited, see Log::Report::Dispatcher::new(accept)
", "id" : "id1165-id1066", "type" : "option" }, "id454" : { "examples" : [ "id455" ], "name" : "list", "id" : "id454", "intro" : "Returned is a list of filenames which is used to update the list of\nMSGIDs when source files have changed. All translation files which\nbelong to a certain $domain are listed.
\n\nThe $extension filter can be used to reduce the filenames further, for\ninstance to select only po, mo or gmo files, and ignore readme's.\nUse an string, without dot and interpreted case-insensitive, or a\nregular expression.
If using this module on its own (such as a drop-in replacement for\nDancer2::Logger::Syslog), then the logging format is configured as with any\nother Dancer logger. If using this module with Dancer2::Plugin::LogReport,\nthen log_format is ignored and messages are not formatted, in order to keep the\nmessage format consistent regardless of where the message was generated (be it\nanother module using Log::Report, the plugin, or Dancer itself). In this case,\nthe log format should be configured using the applicable dispatcher (such as\nLog::Report::Dispatcher::Syslog::new(format)).
\n\nIf also using with the Log::Report logging functions, then you probably want\nto set a very simple logger_format, because the dispatchers do already add\nsome of the fields that the default simple format adds. For instance, to\nget the filename/line-number in messages depends on the dispatcher 'mode' (f.i.\n'DEBUG').
You also want to set the Dancer2 log level to debug, because level filtering\nis controlled per dispatcher (as well).
See DETAILS for examples.
\n", "id" : "id293" }, "id533" : { "type" : "i_method", "intro" : "Update the domains mentioned in the $filename. All text-domains defined\nin the file will get updated automatically, but should not written before\nall files are processed.
\n\nReturned is the number of messages found in this particular file.
\n", "id" : "id533", "call" : "$obj->process( $filename, %options )", "name" : "process" }, "id505" : { "id" : "id505", "intro" : "PPI v1.284 still does not support unicode by itself, so you need to help\nit by specifying the character-set which is used in the file.
\n", "type" : "option", "params" : "$charset", "name" : "charset" }, "id868" : { "name" : "syntax", "intro" : "The SHORT syntax will add the report abbreviations (like function\nerror()) to your name-space. Otherwise, each message must be produced\nwith report(). LONG is an alternative to REPORT: both do not\npollute your namespace with the useful abbrev functions.
Inherited, see Log::Report::Dispatcher::stackTraceLine(max_params)
", "id" : "id1206-id905", "name" : "max_params", "extends" : "id1206" }, "id882" : { "name" : "default_dispatcher_mode", "call" : "default_dispatcher_mode", "id" : "id882", "intro" : "[1.46] Returns the default run mode.
\n", "type" : "function" }, "id1081" : { "path" : "NAME", "intro" : "Log::Report::Translator - base implementation for translating messages
\n", "id" : "id1081", "type" : "chapter", "name" : "NAME", "level" : 1 }, "id1299" : { "name" : "Processing the message", "level" : 2, "path" : "DETAILS/Processing the message", "nest" : [ "id1300", "id1301" ], "id" : "id1299", "type" : "section" }, "id760" : { "package" : "Log::Report::Dispatcher::LogDispatch", "distribution" : "Log-Report", "is_pure_pod" : false, "title" : "send messages to Log::Dispatch back-end", "inheritance" : { "extends" : [ "Log::Report::Dispatcher" ] }, "id" : "id760", "chapters" : [ "id761", "id1358", "id762", "id763", "id764", "id1320" ], "name" : "Log::Report::Dispatcher::LogDispatch", "version" : "1.46" }, "id1189-id905" : { "call" : "$any->addSkipStack( @CODE )", "type" : "ci_method", "intro" : "Inherited, see Log::Report::Dispatcher::addSkipStack()
", "id" : "id1189-id905", "name" : "addSkipStack", "extends" : "id1189" }, "id121" : { "path" : "FUNCTIONS", "name" : "FUNCTIONS", "level" : 1, "id" : "id121", "type" : "chapter", "nest" : [ "id122", "id131", "id136" ] }, "id61" : { "name" : "missing_key", "type" : "default", "value" : "<warning>", "id" : "id61" }, "id541-id354" : { "intro" : "Inherited, see Log::Report::Extract::store()
", "type" : "error", "id" : "id541-id354", "subroutine" : "id540", "name" : "no context tags allowed in plural `$msgid'", "extends" : "id541" }, "id772" : { "name" : "max_level", "type" : "default", "value" : "undef",
"id" : "id772"
},
"id671" : {
"name" : "SYNOPSIS",
"level" : 1,
"path" : "SYNOPSIS",
"intro" : " # this is usually not for end-users, See ::Extract::PerlPPI\n # using a PO table\n\n my $pot = Log::Report::Lexicon::POT->read('po/nl.po', charset => 'utf-8')\n or die;\n\n my $po = $pot->msgid('msgid');\n my $po = $pot->msgid($msgid, $msgctxt);\n print $pot->nrPlurals;\n print $pot->msgstr('msgid', 3);\n print $pot->msgstr($msgid, 3, $msgctxt);\n $pot->write; # update the file\n\n # fill the table, by calling the next a lot\n my $po = Log::Report::Lexicon::PO->new(...);\n $pot->add($po);\n\n # creating a PO table\n $pot->write('po/nl.po')\n or die;\n\n",
"id" : "id671",
"type" : "chapter"
},
"id1168-id780" : {
"name" : "locale",
"intro" : "Inherited, see Log::Report::Dispatcher::new(locale)
", "extends" : "id1168", "type" : "default", "id" : "id1168-id780", "value" : "<system locale>" }, "id371" : { "name" : "charset", "intro" : "The character encoding used in this template file.
\n", "id" : "id371", "type" : "option", "params" : "STRING" }, "id767" : { "name" : "to_level", "params" : "\\@PAIRS", "intro" : "See reasonToLevel().
\n", "type" : "option", "id" : "id767" }, "id566" : { "path" : "METHODS/Constructors", "id" : "id566", "type" : "section", "subroutines" : [ "id741-id561", "id567" ], "name" : "Constructors", "level" : 2 }, "id138" : { "name" : "unescape_chars", "id" : "id138", "intro" : "Replace all backslash-something escapes by their escape character.\nFor instance, backslash-t is replaced by a tab character.
\n", "type" : "function", "call" : "unescape_chars( STRING )" }, "id919" : { "name" : "to_prio", "type" : "option", "intro" : "See reasonToPrio().
\n", "id" : "id919", "params" : "\\@PAIRS" }, "id752-id669" : { "subroutine" : "id751", "extends" : "id752", "name" : "there is no Plural-Forms field in the header, but needed.", "type" : "error", "intro" : "Inherited, see Log::Report::Lexicon::Table::pluralIndex()
", "id" : "id752-id669" }, "id1137-id385" : { "extends" : "id1137", "value" : "'en_US'", "id" : "id1137-id385", "type" : "default", "name" : "native_language", "intro" : "Inherited, see Log::Report::Domain::configure(native_language)
" }, "id859" : { "examples" : [ "id860" ], "name" : "N__w", "type" : "function", "intro" : "This extension to the Locale::TextDomain syntax, is a combined\nqw (list of quoted words) and N__() into a list of translatable\nwords.
Inherited, see Log::Report::Dispatcher::stackTraceLine(filename)
", "id" : "id1196-id1217", "type" : "option", "params" : "STRING" }, "id265" : { "name" : "info", "id" : "id265", "type" : "i_method", "call" : "$obj->info" }, "id1183-id780" : { "name" : "needs", "extends" : "id1183", "intro" : "Inherited, see Log::Report::Dispatcher::needs()
", "id" : "id1183-id780", "type" : "i_method", "call" : "$obj->needs( [$reason] )" }, "id1316" : { "path" : "METHODS/Managing PO's/Translation", "subroutines" : [ "id581", "id580" ], "type" : "subsection", "id" : "id1316", "name" : "Translation", "level" : 3 }, "id953" : { "name" : "_plural", "id" : "id953", "value" : "undef",
"type" : "default"
},
"id1179" : {
"name" : "name",
"intro" : "Returns the unique name of this dispatcher.
\n", "type" : "i_method", "id" : "id1179", "call" : "$obj->name" }, "id1189-id1217" : { "name" : "addSkipStack", "extends" : "id1189", "call" : "$any->addSkipStack( @CODE )", "intro" : "Inherited, see Log::Report::Dispatcher::addSkipStack()
", "id" : "id1189-id1217", "type" : "ci_method" }, "id976-id221" : { "name" : "_context", "extends" : "id976", "params" : "$keyword|\\@keywords", "id" : "id976-id221", "intro" : "Inherited, see Log::Report::Message::new(_context)
", "type" : "option" }, "id548" : { "type" : "i_method", "id" : "id548", "call" : "$obj->translate( $msg, $lang, $ctxt )", "name" : "translate" }, "id432" : { "name" : "charset", "id" : "id432", "value" : "<undef>",
"type" : "default"
},
"id920" : {
"type" : "default",
"value" : "[]",
"id" : "id920",
"name" : "to_prio"
},
"id813" : {
"value" : "undef",
"id" : "id813",
"type" : "default",
"name" : "stack"
},
"id1157" : {
"id" : "id1157",
"intro" : "Say, you log for a (Dancer) webserver, where you wish to include the website\nname in some of the log lines. For this, (ab)use the translation context:
\n\n ### first, enable translation contexts\n use Log::Report 'my-domain', context_rules => { ... };\n\n # or\n use Log::Report 'my-domain';\n textdomain->configure(context_rules => { ... });\n\n # or\n textdomain 'my-domain', content_rules => { ... };\n\n ### every time you start working for a different virtual host\n (textdomain 'my-domain')->setContext(host => $host);\n\n ### now you can use that in your code\n package My::Package;\n use Log::Report 'my-domain';\n error __x\"in {_context.host} not logged-in {user}\", user => $username;\n\n",
"type" : "subsection",
"path" : "DETAILS/Configuring/configuring global values",
"level" : 3,
"name" : "configuring global values"
},
"id314" : {
"name" : "textdomain_class",
"params" : "CLASS",
"intro" : "Use your own extension to Log::Report::Template::Textdomain.
\n", "id" : "id314", "type" : "option" }, "id175" : { "intro" : "# See Log::Report, most functions get \"hollow\" behavior\n use Log::Report::Optional mode => 'DEBUG';\n\n", "type" : "chapter", "id" : "id175", "path" : "SYNOPSIS", "level" : 1, "name" : "SYNOPSIS" }, "id1200-id1021" : { "params" : "STRING", "intro" : "
Inherited, see Log::Report::Dispatcher::stackTraceLine(call)
", "id" : "id1200-id1021", "type" : "option", "name" : "call", "extends" : "id1200" }, "id998-id221" : { "extends" : "id998", "name" : "taggedWith", "call" : "$obj->taggedWith( $tag|Regexp )", "intro" : "Inherited, see Log::Report::Message::taggedWith()
", "id" : "id998-id221", "type" : "i_method" }, "id1206-id1217" : { "params" : "INTEGER", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(max_params)
", "id" : "id1206-id1217", "type" : "option", "name" : "max_params", "extends" : "id1206" }, "id614" : { "intro" : "This module is administering one translation object. Sets of PO\nrecords are kept in a POT file, implemented in Log::Report::Lexicon::POT.
\n", "type" : "chapter", "id" : "id614", "path" : "DESCRIPTION", "level" : 1, "name" : "DESCRIPTION" }, "id880" : { "subroutine" : "id867", "name" : "textdomain `$domain' for translator not defined", "type" : "error", "id" : "id880" }, "id1171-id1217" : { "extends" : "id1171", "name" : "format_reason", "intro" : "Inherited, see Log::Report::Dispatcher::new(format_reason)
", "type" : "option", "id" : "id1171-id1217", "params" : "'UPPERCASE'|'LOWERCASE'|'UCFIRST'|'IGNORE'|CODE" }, "id1181" : { "name" : "mode", "call" : "$obj->mode", "type" : "i_method", "intro" : "Returns the mode in use for the dispatcher as number. See new(mode)\nand Run modes.
\n", "id" : "id1181" }, "id661" : { "type" : "warning", "id" : "id661", "name" : "do not understand line at $where:\\n $line", "subroutine" : "id657" }, "id762" : { "name" : "SYNOPSIS", "level" : 1, "path" : "SYNOPSIS", "intro" : "use Log::Dispatch::File;\n dispatcher Log::Dispatch::File => 'logger', accept => 'NOTICE-',\n filename => 'logfile', to_level => [ 'ALERT-' => 'err' ];\n\n # disable default dispatcher\n dispatcher close => 'logger';\n\n", "type" : "chapter", "id" : "id762" }, "id788" : { "name" : "Constructors", "level" : 2, "path" : "METHODS/Constructors", "type" : "section", "id" : "id788", "subroutines" : [ "id789" ] }, "id948-id221" : { "name" : "_domain", "extends" : "id948", "params" : "$name|$object", "type" : "option", "intro" : "
Inherited, see Log::Report::Message::new(_domain)
", "id" : "id948-id221" }, "id1173-id1021" : { "intro" : "Inherited, see Log::Report::Dispatcher::new(charset)
", "id" : "id1173-id1021", "type" : "option", "params" : "CHARSET", "extends" : "id1173", "name" : "charset" }, "id576" : { "id" : "id576", "type" : "section", "subroutines" : [ "id577", "id578" ], "path" : "METHODS/Attributes", "level" : 2, "name" : "Attributes" }, "id515" : { "path" : "SYNOPSIS", "intro" : "# See the extensions\n\n", "type" : "chapter", "id" : "id515", "name" : "SYNOPSIS", "level" : 1 }, "id361" : { "name" : "domain", "intro" : "
There is no syntax for specifying domains in templates (yet), so you\nmust be explicit about the collection we are making now.
\n", "id" : "id361", "type" : "option", "params" : "DOMAIN" }, "id1194-id1066" : { "name" : "package", "extends" : "id1194", "params" : "CLASS", "type" : "option", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(package)
", "id" : "id1194-id1066" }, "id777" : { "name" : "backend", "call" : "$obj->backend", "intro" : "Returns the Log::Dispatch::Output object which is used for logging.
\n", "id" : "id777", "type" : "i_method" }, "id60" : { "intro" : "[0.91] During interpolation, it may be discovered that a key is missing\nfrom the parameter list. In that case, a warning is produced and undef\ninserted. May can overrule that behavior.
Inherited, see Log::Report::Dispatcher::stackTraceLine(call)
", "name" : "call", "value" : "<required>", "id" : "id1201-id1066", "type" : "default", "extends" : "id1201" }, "id238" : { "path" : "NAME", "type" : "chapter", "intro" : "Dancer2::Template::TTLogReport - Template toolkit engine with Log::Report translations for Dancer2
\n", "id" : "id238", "name" : "NAME", "level" : 1 }, "id485" : { "name" : "unsupported charset $charset in $fn.", "subroutine" : "id467", "id" : "id485", "type" : "error" }, "id437" : { "name" : "Translating", "level" : 2, "path" : "METHODS/Translating", "id" : "id437", "type" : "section", "subroutines" : [ "id438", "id1090-id422" ] }, "id1009" : { "intro" : "my $clone = Log::Report::Message->thaw($msg->freeze);\n\n", "id" : "id1009", "type" : "example", "name" : "to thaw a frozen\n" }, "id1129" : { "name" : "Attributes", "level" : 2, "path" : "METHODS/Attributes", "id" : "id1129", "type" : "section", "subroutines" : [ "id162-id1122", "id1133", "id164-id1122", "id163-id1122", "id1130", "id1144", "id1131", "id1132" ] }, "id966-id221" : { "params" : "$tags|\\@tags", "intro" : "
Inherited, see Log::Report::Message::new(_classes)
", "type" : "option", "id" : "id966-id221", "name" : "_classes", "extends" : "id966" }, "id1204-id1066" : { "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(max_line)
", "id" : "id1204-id1066", "type" : "option", "params" : "INTEGER", "extends" : "id1204", "name" : "max_line" }, "id165" : { "id" : "id165", "type" : "i_method", "options" : [ [ "id168", "id169" ], [ "id166", "id167" ] ], "diagnostics" : [ "id170" ], "call" : "$obj->configure( %options )", "intro" : "Collect the settings for this domain.
\n", "name" : "configure" }, "id1184" : { "level" : 2, "name" : "Logging", "subroutines" : [ "id1186", "id1189", "id1188", "id1185", "id1192", "id1191", "id1193", "id1187" ], "id" : "id1184", "type" : "section", "path" : "METHODS/Logging" }, "id1174-id1217" : { "value" : "undef",
"type" : "default",
"id" : "id1174-id1217",
"extends" : "id1174",
"intro" : "Inherited, see Log::Report::Dispatcher::new(charset)
", "name" : "charset" }, "id52" : { "level" : 2, "name" : "Constructors", "intro" : "When you use this package with functions, then you do not call the\nconstructor explicitly. In that case, these new() parameters are\nadded to the use String::Print line.
Inherited, see Log::Report::Dispatcher::skipStack()
", "id" : "id1191-id1066", "type" : "i_method", "name" : "skipStack", "extends" : "id1191" }, "id742" : { "path" : "METHODS/Attributes", "type" : "section", "id" : "id742", "name" : "Attributes", "level" : 2 }, "id218" : { "name" : "NAME", "level" : 1, "path" : "NAME", "intro" : "Dancer::Logger::LogReport - reroute Dancer logs into Log::Report
\n", "type" : "chapter", "id" : "id218" }, "id641" : { "call" : "$obj->msgstr( [$index, [$translation]] )", "intro" : "Returns a $translation, optionally after setting it.\nWhen no plural is defined, the $index is ignored.
\n", "id" : "id641", "type" : "i_method", "name" : "msgstr" }, "id341" : { "level" : 1, "name" : "DETAILS", "path" : "DETAILS", "nest" : [ "id342", "id345", "id349" ], "id" : "id341", "type" : "chapter" }, "id1225" : { "title" : "a single generated event", "inheritance" : {}, "id" : "id1225", "package" : "Log::Report::Exception", "distribution" : "Log-Report", "is_pure_pod" : false, "version" : "1.46", "name" : "Log::Report::Exception", "chapters" : [ "id1226", "id1227", "id1228", "id1229", "id1232" ] }, "id1197-id760" : { "extends" : "id1197", "id" : "id1197-id760", "type" : "default", "value" : "<required>", "name" : "filename", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(filename)
" }, "id968-id221" : { "params" : "$tags|\\@tags", "id" : "id968-id221", "intro" : "Inherited, see Log::Report::Message::new(_class)
", "type" : "option", "name" : "_class", "extends" : "id968" }, "id503" : { "name" : "Processors", "level" : 2, "path" : "METHODS/Processors", "subroutines" : [ "id538-id493", "id534-id493", "id504", "id540-id493", "id537-id493" ], "id" : "id503", "type" : "section" }, "id1164" : { "name" : "new", "intro" : "Create a dispatcher. The $type of back-end to start is required, and listed\nin the DESCRIPTION part of this manual-page. For various external\nback-ends, special wrappers are created.
\n\nThe $name must be uniquely identifying this dispatcher. When a second\ndispatcher is created (via Log::Report::dispatcher()) with the name\nof an existing dispatcher, the existing one will get replaced.
\n\nAll %options which are not consumed by this base constructor are passed\nto the wrapped back-end. Some of them will check whether all %options\nare understood, other ignore unknown %options.
\n", "call" : "$class->new( $type, $name, %options )", "diagnostics" : [ "id1175", "id1176", "id1177" ], "options" : [ [ "id1165", "id1166" ], [ "id1173", "id1174" ], [ "id1171", "id1172" ], [ "id1167", "id1168" ], [ "id1169", "id1170" ] ], "type" : "c_method", "id" : "id1164" }, "id535" : { "id" : "id535", "intro" : "Keep the information about these filename, either specified as ARRAY of\nnames, or a HASH where the keys are the named.
\n", "type" : "option", "params" : "HASH|ARRAY", "name" : "keep" }, "id295" : { "name" : "log", "id" : "id295", "type" : "i_method", "call" : "$obj->log( $level, $params )" }, "id1161" : { "level" : 1, "name" : "DESCRIPTION", "intro" : "In Log::Report, dispatchers are used to handle (exception) messages\nwhich are created somewhere else. Those message were produced (thrown)\nby Log::Report::error() and friends.
\n\nThis base-class handles the creation of dispatchers, plus the common\nfiltering rules. See the DETAILS section, below.
\n", "id" : "id1161", "type" : "chapter", "path" : "DESCRIPTION" }, "id587" : { "path" : "METHODS", "level" : 1, "name" : "METHODS", "id" : "id587", "type" : "chapter", "nest" : [ "id588", "id592", "id594" ] }, "id1207-id760" : { "name" : "max_params", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(max_params)
", "extends" : "id1207", "type" : "default", "value" : "8", "id" : "id1207-id760" }, "id946-id221" : { "params" : "BOOLEAN", "type" : "option", "intro" : "Inherited, see Log::Report::Message::new(_expand)
", "id" : "id946-id221", "name" : "_expand", "extends" : "id946" }, "id786" : { "level" : 3, "name" : "Limitiations", "intro" : "The global $caller_depth concept of Log::Log4perl is broken.\nThat variable is used to find the filename and line number of the logged\nmessages. But these messages may have been caught, rerouted, eval'ed, and\notherwise followed a unpredictable multi-leveled path before it reached\nthe Log::Log4perl dispatcher. This means that layout patterns %F\nand %L are not useful in the generic case, maybe in your specific case.
[1.09] Returns the character-set of the strings found in the file. They will\nget translated into utf8 before being used in Perl.
\n", "type" : "i_method" }, "id1095" : { "id" : "id1095", "type" : "chapter", "nest" : [ "id1096", "id1107", "id1111", "id1116" ], "path" : "METHODS", "level" : 1, "name" : "METHODS" }, "id623" : { "value" : "\"\" or []", "id" : "id623", "type" : "default", "name" : "msgstr" }, "id350" : { "name" : "Setting-up translations", "level" : 3, "path" : "DETAILS/Extracting PO-files/Setting-up translations", "id" : "id350", "intro" : "Start with desiging a domain structure. Probably, you want to create\na separate domain for the templates (external texts in many languages)\nand your Perl program (internal texts with few languages).
\n\nPick a lexicon directory, which is also inside your version control setup,\nfor instance your GIT repository. Some po-editors can work together\nwith various version control systems.
\n\nNow, start using this module. There are two ways: either by creating it\nas object, or by extension.
\n\n ### As object\n # Somewhere in your code\n use Log::Report::Template;\n my $templater = Log::Report::Template->new(%config);\n $templater->addTextdomain(...);\n\n $templater->process('template_file.tt', \\%vars); # runtime\n $templater->extract(...); # rarely, \"off-line\"\n\n\nSome way or another, you want to be able to share the creation of the\ntemplater and configuration of the textdomain between the run-time use\nand the irregular (off-line) extraction of msgids.
\n\nThe alternative is via extension:
\n\n ### By extension\n # Somewhere in your code:\n use My::Template;\n my $templater = My::Template->new;\n $templater->process('template_file.tt', \\%vars);\n\n # File lib/My/Template.pm\n package My::Template;\n use parent 'Log::Report::Template';\n\n sub init($) {\n my ($self, $args) = @_;\n # add %config into %$args\n $self->SUPER::init($args);\n $self->addTextdomain(...);\n $self;\n }\n\n 1;\n\n\nThe second solution requires a little bit of experience with OO, but is\neasier to maintain and to share.
\n", "type" : "subsection" }, "id164-id385" : { "type" : "i_method", "intro" : "Inherited, see Log::Report::Minimal::Domain::format()
", "id" : "id164-id385", "call" : "$obj->format", "name" : "format", "extends" : "id164" }, "id145" : { "name" : "NAME", "level" : 1, "path" : "NAME", "id" : "id145", "intro" : "Log::Report::Optional - pick Log::Report or ::Minimal
\n", "type" : "chapter" }, "id323" : { "subroutine" : "id321", "name" : "directory $dir not in INCLUDE_PATH, used by $option", "type" : "error", "id" : "id323" }, "id650" : { "name" : "isActive", "type" : "i_method", "intro" : "Returns whether the translation has any references, or is the header.
\n", "id" : "id650", "call" : "$obj->isActive" }, "id236" : { "name" : "THAW", "intro" : "=encoding UTF-8
\n", "type" : "c_method", "id" : "id236", "call" : "$class->THAW( $serializer, $msg )" }, "id596" : { "id" : "id596", "type" : "error", "name" : "no context definition for `$tag' in `$msgid'", "subroutine" : "id595" }, "id1329" : { "intro" : "Log::Report::Win32Locale\n is an Exporter\n\n", "type" : "chapter", "id" : "id1329", "path" : "INHERITANCE", "level" : 1, "name" : "INHERITANCE" }, "id824" : { "name" : "odd length parameter list with object '$msg'.", "subroutine" : "id807", "id" : "id824", "type" : "error" }, "id797" : { "name" : "logger", "call" : "$obj->logger( [$domain] )", "id" : "id797", "intro" : "
Returns the Log::Log4perl::Logger object which is used for logging.\nWhen there is no specific logger for this $domain (logger with the exact\nname of the $domain) the default logger is being used, with the name of\nthis dispatcher.
\n", "type" : "i_method" }, "id417" : { "name" : "superfluous positional parameters for '$msgid'", "subroutine" : "id412", "id" : "id417", "type" : "error" }, "id1272" : { "level" : 3, "name" : "Filters", "id" : "id1272", "type" : "subsection", "path" : "DETAILS/Processing the message/Filters" }, "id1004-id221" : { "extends" : "id1004", "name" : "concat", "call" : "$obj->concat( $text|$message, [$prepend] )", "intro" : "Inherited, see Log::Report::Message::concat()
", "type" : "i_method", "id" : "id1004-id221" }, "id195" : { "call" : "mistake( $message )", "type" : "function", "id" : "id195", "name" : "mistake" }, "id1275" : { "nest" : [ "id1276", "id1277", "id1278", "id1280" ], "type" : "chapter", "id" : "id1275", "name" : "DETAILS", "level" : 1, "path" : "DETAILS" }, "id978-id221" : { "name" : "_msgctxt", "extends" : "id978", "params" : "$context", "intro" : "Inherited, see Log::Report::Message::new(_msgctxt)
", "type" : "option", "id" : "id978-id221" }, "id546" : { "nest" : [ "id1318", "id1319", "id547" ], "id" : "id546", "type" : "chapter", "level" : 1, "name" : "METHODS", "path" : "METHODS" }, "id1169-id1217" : { "type" : "option", "intro" : "Inherited, see Log::Report::Dispatcher::new(mode)
", "id" : "id1169-id1217", "params" : "'NORMAL'|'VERBOSE'|'ASSERT'|'DEBUG'|0..3", "extends" : "id1169", "name" : "mode" }, "id987-id221" : { "call" : "$obj->count", "intro" : "Inherited, see Log::Report::Message::count()
", "type" : "i_method", "id" : "id987-id221", "name" : "count", "extends" : "id987" }, "id747" : { "name" : "Administration", "level" : 3, "path" : "METHODS/Managing PO's/Administration", "subroutines" : [ "id751", "id749", "id755", "id753", "id748", "id756" ], "type" : "subsection", "id" : "id747" }, "id984" : { "name" : "msgid", "id" : "id984", "intro" : "Returns the msgid which will later be translated.
\n", "type" : "i_method", "call" : "$obj->msgid" }, "id939" : { "path" : "OVERLOADED", "subroutines" : [ "id940", "id942", "id941" ], "id" : "id939", "type" : "chapter", "name" : "OVERLOADED", "level" : 1 }, "id118" : { "path" : "NAME", "intro" : "Log::Report::Util - helpful routines to Log::Report
\n", "type" : "chapter", "id" : "id118", "name" : "NAME", "level" : 1 }, "id157-id1122" : { "intro" : "Inherited, see Log::Report::Minimal::Domain::new(name)
", "type" : "option", "id" : "id157-id1122", "params" : "STRING", "extends" : "id157", "name" : "name" }, "id1092" : { "path" : "NAME", "intro" : "Log::Report::Dispatcher::File - send messages to a file or file-handle
\n", "type" : "chapter", "id" : "id1092", "name" : "NAME", "level" : 1 }, "id528-id493" : { "call" : "$obj->charset", "intro" : "Inherited, see Log::Report::Extract::charset()
", "id" : "id528-id493", "type" : "i_method", "extends" : "id528", "name" : "charset" }, "id634" : { "name" : "format", "intro" : "See format(). Either an ARRAY with PAIRS or a HASH with that same\ninformation.
\n", "type" : "option", "id" : "id634", "params" : "ARRAY|HASH" }, "id689" : { "name" : "index", "value" : "{}", "id" : "id689", "type" : "default" }, "id245" : { "name" : "Action", "level" : 2, "path" : "METHODS/Action", "id" : "id245", "type" : "section", "subroutines" : [ "id246", "id248" ] }, "id1188-id780" : { "id" : "id1188-id780", "intro" : "Inherited, see Log::Report::Dispatcher::collectStack()
", "type" : "ci_method", "call" : "$any->collectStack( [$maxdepth] )", "extends" : "id1188", "name" : "collectStack" }, "id582" : { "name" : "string '$text' not between quotes at $location", "subroutine" : "id581", "id" : "id582", "type" : "warning" }, "id136" : { "path" : "FUNCTIONS/Other", "type" : "section", "id" : "id136", "subroutines" : [ "id138", "id140", "id137", "id139", "id142" ], "name" : "Other", "level" : 2 }, "id568" : { "id" : "id568", "intro" : "When the charset is not specified, it will be taken from the content-type\nfield in the po-file header.
\n", "type" : "option", "params" : "STRING", "name" : "charset" }, "id1037" : { "name" : "on_die", "intro" : "When code which runs in this block exits with a die(), it will get\ntranslated into a Log::Report::Exception using\nLog::Report::Die::die_decode(). How serious are we about these\nerrors?
\n", "id" : "id1037", "type" : "option", "params" : "'ERROR'|'PANIC'" }, "id805" : { "id" : "id805", "type" : "chapter", "nest" : [ "id806", "id832", "id844", "id861", "id866", "id884" ], "path" : "FUNCTIONS", "level" : 1, "name" : "FUNCTIONS" }, "id389" : { "type" : "chapter", "id" : "id389", "nest" : [ "id390", "id404", "id410" ], "path" : "METHODS", "name" : "METHODS", "level" : 1 }, "id334" : { "name" : "filename_match", "type" : "option", "intro" : "Process all files from the INCLUDE_PATH directories which match this\nregular expression.
\n", "id" : "id334", "params" : "RegEx" }, "id1357" : { "level" : 1, "name" : "INHERITANCE", "type" : "chapter", "intro" : "Log::Report::Message is extended by\n Dancer2::Plugin::LogReport::Message\n\n", "id" : "id1357", "path" : "INHERITANCE" }, "id833" : { "intro" : "
Short for report TRACE => $message
This method returns a CODE which is able to handle a call for\ntranslation by Template Toolkit.
\n", "name" : "translationFunction" }, "id1222" : { "level" : 2, "name" : "Constructors", "subroutines" : [ "id1164-id1217" ], "id" : "id1222", "type" : "section", "path" : "METHODS/Constructors" }, "id691" : { "id" : "id691", "value" : "now", "type" : "default", "name" : "date" }, "id792" : { "params" : "FILENAME|SCALAR", "id" : "id792", "intro" : "When a SCALAR reference is passed in, that must refer to a string which\ncontains the configuration text. Otherwise, specify an existing FILENAME.
\n\nBy default, it is expected that Log::Log4perl has been initialized\nexternally. That module uses global variables to communicate, which\nshould be present before any logging is attempted.
\n", "type" : "option", "name" : "config" }, "id400" : { "name" : "lang", "params" : "LANGUAGES", "intro" : "[1.01] Initial language to translate to. Usually, this language which change\nfor each user connection via translateTo().
\n", "type" : "option", "id" : "id400" }, "id1001-id221" : { "intro" : "Inherited, see Log::Report::Message::toHTML()
", "id" : "id1001-id221", "type" : "i_method", "call" : "$obj->toHTML( [$locale] )", "extends" : "id1001", "name" : "toHTML" }, "id391" : { "type" : "c_method", "id" : "id391", "options" : [ [ "id400", "id401" ], [ "id396", "id397" ], [ "id157-id385", "id158-id385" ], [ "id392", "id393" ], [ "id398", "id399" ], [ "id394", "id395" ] ], "call" : "$class->new( %options )", "name" : "new" }, "id1116" : { "name" : "Logging", "level" : 2, "path" : "METHODS/Logging", "type" : "section", "id" : "id1116", "subroutines" : [ "id1186-id1091", "id1189-id1091", "id1188-id1091", "id1117", "id1192-id1091", "id1191-id1091", "id1193-id1091", "id1187-id1091" ] }, "id1099" : { "name" : "to", "type" : "default", "value" : "<required>", "id" : "id1099" }, "id1281" : { "name" : "Handling white-spaces", "level" : 3, "path" : "DETAILS/Automatic parameters/Handling white-spaces", "type" : "subsection", "id" : "id1281" }, "id1183-id760" : { "call" : "$obj->needs( [$reason] )", "intro" : "Inherited, see Log::Report::Dispatcher::needs()
", "type" : "i_method", "id" : "id1183-id760", "name" : "needs", "extends" : "id1183" }, "id1204-id905" : { "extends" : "id1204", "name" : "max_line", "id" : "id1204-id905", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(max_line)
", "type" : "option", "params" : "INTEGER" }, "id525" : { "type" : "fault", "id" : "id525", "subroutine" : "id519", "name" : "cannot create lexicon directory $dir: $!" }, "id1325" : { "name" : "INHERITANCE", "level" : 1, "path" : "INHERITANCE", "intro" : "Log::Report::Dispatcher::Log4perl\n is a Log::Report::Dispatcher\n\n", "id" : "id1325", "type" : "chapter" }, "id1191-id905" : { "call" : "$obj->skipStack", "intro" : "
Inherited, see Log::Report::Dispatcher::skipStack()
", "id" : "id1191-id905", "type" : "i_method", "name" : "skipStack", "extends" : "id1191" }, "id101" : { "path" : "DETAILS/Interpolation: Modifiers/Modifier: HTML", "intro" : "[0.95] interpolate the parameter with HTML entity encoding.
\n", "id" : "id101", "type" : "subsection", "name" : "Modifier: HTML", "level" : 3 }, "id983" : { "type" : "i_method", "intro" : "Returns the string which is prepended to this one. Usually undef.
Inherited, see Log::Report::Dispatcher::new(locale)
", "extends" : "id1168", "type" : "default", "value" : "<system locale>", "id" : "id1168-id760" }, "id889" : { "name" : "Lightweight Log::Report::Optional", "level" : 3, "path" : "DETAILS/Introduction/Lightweight Log::Report::Optional", "type" : "subsection", "intro" : "When you want to use Log::Report features as cheap as possible, you\nmay use Log::Report::Optional in your module. In this case, your\nmodule can use error() and __x() with very little cost: they\nwill not build internal objects and support translations. It's fast\nand few dependencies.
The beauty is, then when the main program which uses module does\ninitiate the full Log::Report functionality, then your module will\nalso switch to full support mode.
\n", "id" : "id889" }, "id834" : { "name" : "assert", "call" : "assert( $message )", "intro" : "Short for report ASSERT => $message
Create a new translator object. You may pass the %options as HASH or\nPAIRS. By convension, all basic Template Toolkit options are in capitals.\nRead Template::Config about what they mean. Extension options provided\nby this module are all in lower-case.
\n\nIn a web-environment, you want to start this before your webserver starts\nforking.
\n", "name" : "new", "options" : [ [ "id310", "id311" ], [ "id306", "id307" ], [ "id308", "id309" ], [ "id314", "id315" ], [ "id312", "id313" ] ], "id" : "id305", "type" : "c_method", "call" : "$class->new( %options )", "diagnostics" : [ "id316" ] }, "id226" : { "type" : "section", "id" : "id226", "subroutines" : [ "id980-id221", "id227" ], "path" : "METHODS/Constructors", "level" : 2, "name" : "Constructors" }, "id535-id354" : { "id" : "id535-id354", "intro" : "Inherited, see Log::Report::Extract::cleanup(keep)
", "type" : "option", "params" : "HASH|ARRAY", "extends" : "id535", "name" : "keep" }, "id333" : { "name" : "filenames", "value" : "undef",
"type" : "default",
"id" : "id333"
},
"id907" : {
"name" : "SYNOPSIS",
"level" : 1,
"path" : "SYNOPSIS",
"intro" : "# add syslog dispatcher\n dispatcher SYSLOG => 'syslog', accept => 'NOTICE-',\n format_reason => 'IGNORE',\n to_prio => [ 'ALERT-' => 'err' ];\n\n # disable default dispatcher, when daemon\n dispatcher close => 'default';\n\n", "type" : "chapter", "id" : "id907" }, "id1229" : { "level" : 1, "name" : "OVERLOADED", "subroutines" : [ "id1230", "id1231" ], "type" : "chapter", "id" : "id1229", "path" : "OVERLOADED" }, "id1047" : { "name" : "log", "id" : "id1047", "intro" : "
Other dispatchers translate the message here, and make it leave the\nprogram. However, messages in a \"try\" block are only captured in\nan intermediate layer: they may never be presented to an end-users.\nAnd for sure, we do not know the language yet.
\n\nThe $message is either a STRING or a Log::Report::Message.
\n", "type" : "i_method", "call" : "$obj->log( $opts, $reason, $message )" }, "id1194-id905" : { "name" : "package", "extends" : "id1194", "params" : "CLASS", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(package)
", "id" : "id1194-id905", "type" : "option" }, "id605" : { "type" : "section", "id" : "id605", "nest" : [ "id606", "id607", "id608", "id609", "id610" ], "intro" : "In Log::Report's extended concept of \"contexts\", you can select between\nmultiple translations for the same msgid, when they
\n\nIn the standard gettext set-up, some msgid may accidentally collide\nbetween two different uses. For instance, whether you translate the word\n\"Open\" in the menu for \"Files\" to mean \"open a file\", and the word \"Open\"\nin the status display meaning \"the file is open\". In some languages,\nthese translations may differ. Using a msgctxt keyword will cause the\nsame msgid to appear twice in the PO-file.
\n\nBut, there is a much broader need for context sensitive translations,\nwhich is not in the provided by standard gettext: environmental\ninformation or parameters may influence the translation more than simply\nsolvable by inserted parameters.
\n\nFor instance, the gender of the user of the website determines whether\n`he' or `she' needs to be used. In this example, the gender is set as\ncontext keyword in the message:
\n\n $name = 'Jack';\n print __x\"{name} found her key\", name => $name;\n\n\nYou may try to solve this via:
\n\n my ($name, $gender) = ('Jack', 'male');\n print __x\"{name} found {personal} key\", name => $name,\n personal => ($gender eq 'male' ? 'his' : 'her'); # No!\n\n\nThis does not translate! For one, you would need to translate his and\nher to the language as well. But in some languages, the differences\nbetween addressed genders have more impact on the whole sentence.
So, Log::Report translations add extra syntax:
\n\n my ($name, $gender) = ('Jack', 'male');\n print __x\"{name<gender} found her key\", name => $name,\n _context => \"gender=$gender\";\n\n\nThe gender marking tells the translation table builder (xgettext-perl)\nand the translation handler that there is a context active.
Now, the English PO-file has
\n\n # gender alternatives 'male' and 'female'\n\n msgctxt \"gender=male\"\n msgid \"{name} found his key\"\n msgstr \"{name} found his key\"\n\n msgctxt \"gender=female\"\n msgid \"{name} found his key\"\n msgstr \"{name} found her key\"\n\n\nTo make this work, both the application and the xgettext-perl script\nmust share information to understand which genders are available. See\nthe section on \"Configuration\" below.
Another example:
\n\n print __x\"greetings{<style}\";\n # style alternatives 'formal' and 'informal'\n\n msgctxt \"style=formal\"\n msgid \"greetings\"\n msgstr \"Dear Sir/Madam,\"\n\n msgctxt \"style=informal\"\n msgid \"greetings\"\n msgstr \"Hey buddy,\"\n\n\nAs can be seen, the '<style' marking may be added inside the '{}' of\na filled-in parameter, or may appear on its own. These markings are\nremoved from the msgid in the PO file, so that you may freely add them to\nthe strings used in your program without disturbing existing translations.
\n", "path" : "DETAILS/Using context_rules", "level" : 2, "name" : "Using context_rules" }, "id48" : { "path" : "NAME", "type" : "chapter", "intro" : "String::Print - printf alternative
\n", "id" : "id48", "name" : "NAME", "level" : 1 }, "id633" : { "value" : "[]", "type" : "default", "id" : "id633", "name" : "references" }, "id891" : { "name" : "Error handling models", "level" : 2, "path" : "DETAILS/Error handling models", "intro" : "There are two approaches to handling errors and warnings. In the first\napproach, as produced by die, warn and the carp family of\ncommands, the program handles the problem immediately on the location\nwhere the problem appears. In the second approach, an exception\nis thrown on the spot where the problem is created, and then somewhere\nelse in the program the condition is handled.
The implementation of exceptions in Perl5 is done with a eval-die pair:\non the spot where the problem occurs, die is called. But, because of\nthe execution of that routine is placed within an eval, the program\nas a whole will not die, just the execution of a part of the program\nwill seize. However, what if the condition which caused the routine to die\nis solvable on a higher level? Or what if the user of the code doesn't\nbother that a part fails, because it has implemented alternatives for\nthat situation? Exception handling is quite clumsy in Perl5.
The Log::Report set of distributions let modules concentrate on the\nprogram flow, and let the main program decide on the report handling\nmodel. The infrastructure to translate messages into multiple languages,\nwhether to create exceptions or carp/die, to collect longer explanations\nwith the messages, to log to mail or syslog, and so on, is decided in\npluggable back-ends.
See functions printi(), sprinti(), printp(), and sprintp(): you\ncan also call them as method.
\n\n use String::Print 'oo';\n my $f = String::Print->new(%config);\n $f->printi($format, @params);\n\n # exactly the same functionality:\n use String::Print 'printi', %config;\n printi $format, @params;\n\n\n
The Object Oriented interface wins when you need the same configuration\nin multiple source files, or when you need different configurations\nwithin one program. In these cases, the hassle of explicitly using the\nobject has some benefits.
\n", "path" : "METHODS" }, "id1201-id905" : { "name" : "call", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(call)
", "extends" : "id1201", "type" : "default", "id" : "id1201-id905", "value" : "<required>" }, "id841" : { "name" : "alert", "call" : "alert( $message )", "intro" : "Short for report ALERT => $message
Inherited, see Log::Report::Extract::write()
" }, "id166-id1122" : { "id" : "id166-id1122", "intro" : "Inherited, see Log::Report::Minimal::Domain::configure(where)
", "type" : "option", "params" : "ARRAY", "extends" : "id166", "name" : "where" }, "id929" : { "id" : "id929", "type" : "error", "name" : "max one active syslog dispatcher, attempt for $new have $old", "subroutine" : "id911" }, "id201" : { "path" : "FUNCTIONS/Language Translations", "subroutines" : [ "id206", "id207", "id202", "id203", "id209", "id208", "id210", "id205" ], "type" : "section", "intro" : "No translations, no Log::Report::Message objects returned.
\n", "id" : "id201", "name" : "Language Translations", "level" : 2 }, "id504" : { "intro" : "Update the domains mentioned in the $filename. All textdomains defined\nin the file will get updated automatically, but not written before\nall files where processed.
\n", "name" : "process", "diagnostics" : [ "id507", "id508", "id509", "id510", "id511", "id512" ], "call" : "$obj->process( $filename, %options )", "id" : "id504", "type" : "i_method", "options" : [ [ "id505", "id506" ] ] }, "id1165-id1217" : { "name" : "accept", "extends" : "id1165", "params" : "$reasons|\\@reasons", "intro" : "Inherited, see Log::Report::Dispatcher::new(accept)
", "type" : "option", "id" : "id1165-id1217" }, "id455" : { "type" : "example", "intro" : " my @l = $index->list('my-domain');\n my @l = $index->list('my-domain', 'po');\n my @l = $index->list('my-domain', qr/^readme/i);\n\n",
"id" : "id455"
},
"id1279" : {
"level" : 3,
"name" : "Interpolation with String::Print",
"id" : "id1279",
"type" : "subsection",
"path" : "DETAILS/Messages with plural forms/Interpolation with String::Print"
},
"id902" : {
"name" : "die/warn/Carp",
"level" : 3,
"path" : "DETAILS/Compared to other solutions in Perl/die/warn/Carp",
"intro" : "Perl's built-in exception system is very primitive: \"die\" and \"warn\".\nMost programming languages provide a much more detailed exception\nmechanism.
\n\nA typical perl program can look like this:
\n\n my $dir = '/etc';\n\n File::Spec->file_name is_absolute($dir)\n or die \"ERROR: directory name must be absolute.\\n\";\n\n -d $dir\n or die \"ERROR: what platform are you on?\";\n\n until(opendir DIR, $dir)\n { warn \"ERROR: cannot read system directory $dir: $!\";\n sleep 60;\n }\n\n print \"Processing directory $dir\\n\"\n if $verbose;\n\n while(defined(my $file = readdir DIR))\n { if($file =~ m/\\.bak$/)\n { warn \"WARNING: found backup file $dir/$f\\n\";\n next;\n }\n\n die \"ERROR: file $dir/$file is binary\"\n if $debug && -B \"$dir/$file\";\n\n print \"DEBUG: processing file $dir/$file\\n\"\n if $debug;\n\n open my $fh, \"<:encoding(UTF-8)\", \"$dir/$file\"\n or die \"ERROR: cannot read from $dir/$f: $!\";\n\n $fh->close\n or croak \"ERROR: read errors in $dir/$file: $!\";\n }\n\n\nWhere die, warn, and print are used for various tasks. With\nLog::Report, you would write
\n use Log::Report;\n\n # can be left-out when there is no debug/verbose\n dispatcher PERL => 'default', mode => 'DEBUG';\n\n my $dir = '/etc';\n\n File::Spec->file_name is_absolute($dir)\n or mistake \"directory name must be absolute\";\n\n -d $dir\n or panic \"what platform are you on?\";\n\n until(opendir DIR, $dir)\n { alert \"cannot read system directory $dir\";\n sleep 60;\n }\n\n info \"Processing directory $dir\";\n\n while(defined(my $file = readdir DIR))\n { if($file =~ m/\\.bak$/)\n { notice \"found backup file $dir/$f\";\n next;\n }\n\n assert \"file $dir/$file is binary\"\n if -B \"$dir/$file\";\n\n trace \"processing file $dir/$file\";\n\n unless(open my $fh, \"<:encoding(UTF-8)\", \"$dir/$file\")\n { error \"no permission to read from $dir/$f\" if $!==ENOPERM;\n fault \"unable to read from $dir/$f\"; # or better\n }\n\n $fh->close\n or failure \"read errors in $dir/$file\";\n }\n\n\nA lot of things are quite visibly different, and there are a few smaller\nchanges. There is no need for a new-line after the text of the message.\nWhen applicable (error about system problem), then the $! is added\nautomatically.
The default filehandle is STDOUT.
\n", "id" : "id1257", "call" : "$obj->print( [$fh] )" }, "id823" : { "subroutine" : "id807", "name" : "a message object is reported with more parameters.", "type" : "error", "id" : "id823" }, "id126" : { "id" : "id126", "type" : "error", "subroutine" : "id123", "name" : "reason '$begin' more serious than '$end' in '$reasons'." }, "id324" : { "id" : "id324", "type" : "error", "subroutine" : "id321", "name" : "translation function '$func' already in use by textdomain '$name'" }, "id163-id385" : { "name" : "isConfigured", "extends" : "id163", "call" : "$obj->isConfigured", "intro" : "Inherited, see Log::Report::Minimal::Domain::isConfigured()
", "type" : "i_method", "id" : "id163-id385" }, "id850" : { "name" : "__n", "examples" : [ "id851" ], "call" : "__n( $msgid, $plural_msgid, $count, PAIRS )", "id" : "id850", "intro" : "It depends on the value of $count (and the selected language) which\ntext will be displayed. When translations can not be performed, then\n$msgid will be used when $count is 1, and PLURAL_MSGSID in other cases.\nHowever, some languages have more complex schemes than English.
\n\nThe PAIRS are options for Log::Report::Message::new() and variables\nto be filled in.
\n", "type" : "function" }, "id624" : { "name" : "msgctxt", "params" : "$context", "id" : "id624", "intro" : "Context string: specifies where the msgid belongs.
\n", "type" : "option" }, "id680" : { "params" : "STRING", "type" : "option", "id" : "id680", "name" : "version" }, "id1175" : { "type" : "alert", "id" : "id1175", "subroutine" : "id1164", "name" : "cannot use class $backend:\\n$@: $!" }, "id861" : { "name" : "Messages with Context", "level" : 2, "path" : "FUNCTIONS/Messages with Context", "subroutines" : [ "id863", "id865", "id862", "id864" ], "id" : "id861", "intro" : "In Log::Report, the message context (mgsctxt in the PO-files --in the\ntranslation tables) can be used in a very powerful way. Read all about\nit in Log::Report::Translator::Context
The msgctxt versions of the tranditional gettext infrastructure are far\nless useful for Log::Report, because we can easily work with different\ntext domains within the same program. That should avoid most of the\naccidental translation conflicts between components of the code.
\n\nJust for compatibility with Locale::TextDomain and completeness, the\n'p' versions of above methods are supported. See examples for these\nfunctions in Locale::TextDomain.
\n\nWarnings: Functions N__p() and N__np() seem not to be usable in\nreality, hence not implemented. The script xgettext-perl and\nLog::Report::Extract::PerlPPI (both in the Log::Report::Lexicon\ndistribution) do not yet support these functions.
Inherited, see Log::Report::Dispatcher::close()
", "id" : "id1185-id1217", "type" : "i_method", "call" : "$obj->close" }, "id380" : { "name" : "template syntax error, no END in $fn line $line.", "subroutine" : "id370", "id" : "id380", "type" : "error" }, "id1011" : { "nest" : [ "id1012", "id1013", "id1014", "id1017" ], "id" : "id1011", "type" : "chapter", "name" : "DETAILS", "level" : 1, "path" : "DETAILS", "intro" : "The message cast by the Log::Report exception framework can be\nplain strings. This is sufficient for some cases, for instance:\nwhich would you bother much about the content of trace messages?\nMessage which are destined for end-users or log-files however, need\nmore care; require a higher quality. In this case, you can better\nuse cast message objects which support interpolation.
Inherited, see Log::Report::Dispatcher::type()
", "type" : "i_method", "call" : "$obj->type" }, "id1207-id780" : { "extends" : "id1207", "type" : "default", "id" : "id1207-id780", "value" : "8", "name" : "max_params", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(max_params)
" }, "id128" : { "name" : "is_reason", "call" : "is_reason( $name )", "intro" : "Returns true if the STRING is one of the predefined REASONS.
Returns the encoding name (usable with module Encode) based on the current\ncodepage. For example, cp1252 for iso-8859-1 (latin-1) or cp932 for\nShift-JIS Japanese. Returns undef if the encoding cannot be identified.
The language we are going to translate to. Change this with translateTo()\nfor this domain, or better Log::Report::Template::translateTo().
\n", "type" : "i_method", "id" : "id409", "name" : "lang" }, "id756" : { "name" : "header", "call" : "$obj->header( $field )", "intro" : "The translation of a blank MSGID is used to store a MIME header, which\ncontains some meta-data. The $field value is looked-up (case-insensitive)\nand returned.
\n", "type" : "i_method", "id" : "id756" }, "id80" : { "value" : "', '", "id" : "id80", "type" : "default", "name" : "_join" }, "id536-id493" : { "type" : "default", "value" : "[]", "id" : "id536-id493", "extends" : "id536", "intro" : "Inherited, see Log::Report::Extract::cleanup(keep)
", "name" : "keep" }, "id1197-id780" : { "id" : "id1197-id780", "type" : "default", "value" : "<required>", "extends" : "id1197", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(filename)
", "name" : "filename" }, "id168-id1122" : { "extends" : "id168", "name" : "formatter", "type" : "option", "intro" : "Inherited, see Log::Report::Minimal::Domain::configure(formatter)
", "id" : "id168-id1122", "params" : "CODE|\\%config|'PRINTI'" }, "id930" : { "name" : "syslog level '$level' not understood", "subroutine" : "id911", "type" : "error", "id" : "id930" }, "id422" : { "title" : "translation based on POT files", "inheritance" : { "extends" : [ "Log::Report::Translator" ] }, "id" : "id422", "package" : "Log::Report::Translator::POT", "distribution" : "Log-Report-Lexicon", "is_pure_pod" : false, "version" : "1.16", "name" : "Log::Report::Translator::POT", "chapters" : [ "id423", "id1335", "id424", "id425", "id426" ] }, "id1122" : { "is_pure_pod" : false, "distribution" : "Log-Report", "package" : "Log::Report::Domain", "id" : "id1122", "inheritance" : { "extended_by" : [ "Log::Report::Template::Textdomain" ], "extends" : [ "Log::Report::Minimal::Domain" ] }, "title" : "administer one text-domain", "chapters" : [ "id1123", "id1337", "id1124", "id1125", "id1126", "id1154" ], "name" : "Log::Report::Domain", "version" : "1.46" }, "id1002" : { "intro" : " print $msg->toHTML('NL');\n\n",
"id" : "id1002",
"type" : "example"
},
"id1014" : {
"nest" : [
"id1015"
],
"type" : "section",
"id" : "id1014",
"level" : 2,
"name" : "Messages with plural forms",
"intro" : "The Log::Report::__xn() message constructor is used when you need\na different translation based on the count of one of the inserted\nfields.
\n\n fault __x\"cannot read {file}\", file => $fn;\n # --> FAULT: cannot read /etc/shadow: Permission denied\\n\n\n print __xn\"directory {dir} contains one file\",\n \"directory {dir} contains {nr_files} files\",\n scalar(@files), # (1) (2) (3)\n nr_files => scalar @files, # (4)\n dir => $dir;\n\n\n(1) this required third parameter is used to switch between the different\nplural forms. English has only two forms, but some languages have many\nmore.
\n\n(2) the \"scalar\" keyword is not needed, because the third parameter is\nin SCALAR context. You may also pass \\@files there, because ARRAYs\nwill be converted into their length. A HASH will be converted into the\nnumber of keys in the HASH.
(3) you could also simply pass a reference to the ARRAY: it will take\nthe length as counter. With a HASH, it will count the number of keys.
\n\n(4) the scalar keyword is required here, because it is LIST context:\notherwise all filenames will be filled-in as parameters to __xn().\nSee below for the available _count value, to see how the nr_files\nparameter can disappear.
\n print __xn\"directory {dir} contains one file\",\n \"directory {dir} contains {_count} files\",\n \\@files, dir => $dir;\n\n\nSome languages need more than two translations based on the counter.\nThis is solved by the translation table definition. The two msgids\ngive here are simply the fallback, when there is not translation table\nactive.
\n", "path" : "DETAILS/Messages with plural forms" }, "id1216" : { "name" : "take all mistakes and warnings serious\n", "intro" : " dispatch filter => \\&take_warns_seriously;\n sub take_warns_seriously($$$$)\n { my ($disp, $opts, $reason, $message) = @_;\n $reason eq 'MISTAKE' ? (ERROR => $message)\n : $reason eq 'WARNING' ? (FAULT => $message)\n : ($reason => $message);\n }\n\n",
"id" : "id1216",
"type" : "example"
},
"id952-id221" : {
"intro" : "Inherited, see Log::Report::Message::new(_plural)
", "type" : "option", "id" : "id952-id221", "params" : "$msgid", "extends" : "id952", "name" : "_plural" }, "id228" : { "name" : "reason", "params" : "$reason", "id" : "id228", "intro" : "The $reason reflects the exception level which is attached to message,\noften derived from a caught exception.
\n", "type" : "option" }, "id741-id461" : { "name" : "new", "extends" : "id741", "intro" : "Inherited, see Log::Report::Lexicon::Table::new()
", "id" : "id741-id461", "type" : "c_method", "call" : "$class->new( %options )" }, "id871" : { "name" : "mode", "value" : "'NORMAL'", "type" : "default", "id" : "id871" }, "id1188-id760" : { "name" : "collectStack", "extends" : "id1188", "call" : "$any->collectStack( [$maxdepth] )", "intro" : "Inherited, see Log::Report::Dispatcher::collectStack()
", "id" : "id1188-id760", "type" : "ci_method" }, "id1125" : { "name" : "DESCRIPTION", "level" : 1, "path" : "DESCRIPTION", "intro" : "Log::Report can handle multiple sets of packages used by your program at the same\ntime. In the common case, your program consists of more than one imported software\ndistribution, each containing a number of packages. So separate the Log::Report\nconfiguration for each distribution, you should explicitly assign each package\nto a set, to a namespace. This is (in translation lingo) a domain or text domain.\nThe default domain has name default.
For Log::Report, those package sets are selected with the text-domain\nvalue in the use statement:
\n use Log::Report 'my-domain';\n\n\n
There are many things you can configure per (text)domain. This is\nnot only related to translations, but also -for instance- for text\nformatting configuration (String::Print options). The administration\nfor the configuration is managed in this package.
\n\nThis class extends Log::Report::Minimal::Domain, which can be used when your\nprogram does not want any overhead from the powerful Log::Report features.\nIn that case, your program invokes Log::Report::Optional.
\n", "type" : "chapter", "id" : "id1125" }, "id1005" : { "name" : "of concatenation\n", "type" : "example", "intro" : " print __\"Hello\" . ' ' . __\"World!\\n\";\n print __(\"Hello\")->concat(' ')->concat(__\"World!\")->concat(\"\\n\");\n\n",
"id" : "id1005"
},
"id359" : {
"path" : "METHODS/Constructors",
"id" : "id359",
"type" : "section",
"subroutines" : [
"id360"
],
"name" : "Constructors",
"level" : 2
},
"id1066" : {
"is_pure_pod" : false,
"package" : "Log::Report::Dispatcher::Callback",
"distribution" : "Log-Report",
"id" : "id1066",
"inheritance" : {
"extends" : [
"Log::Report::Dispatcher"
]
},
"title" : "call a code-ref for each log-line",
"chapters" : [
"id1067",
"id1331",
"id1068",
"id1069",
"id1071",
"id1292"
],
"name" : "Log::Report::Dispatcher::Callback",
"version" : "1.46"
},
"id1264" : {
"options" : [
[
"id1265",
"id1266"
]
],
"intro" : "The STRING is the content of $@ after an eval() caught a die().\ncroak(), or confess(). This routine tries to convert this into\nparameters for Log::Report::report(). This is done in a very\nsmart way, even trying to find the stringifications of $!.
Returned are four elements: the error string or object which triggered\nthe death originally (the original $@), and the opts, reason, and plain\ntext message. The opts is a HASH which, amongst other things, may contain\na stack trace and location extracted from the death text or object.
\n\nTranslated components will have exception classes perl, and die or\nconfess. On the moment, the croak cannot be distiguished from the\nconfess (when used in package main) or die (otherwise).
The returned reason depends on whether the translation of the current\n$! is found in the STRING, and the presence of a stack trace. The\nfollowing table is used:
\n errstr stack => reason\n no no ERROR (die) application internal problem\n yes no FAULT (die) external problem, think open()\n no yes PANIC (confess) implementation error\n yes yes ALERT (confess) external problem, caught\n\n", "type" : "function", "id" : "id1264", "call" : "die_decode( STRING, %options )", "name" : "die_decode" }, "id659" : { "subroutine" : "id657", "name" : "do not understand command '$cmd' at $where.", "id" : "id659", "type" : "warning" }, "id552" : { "level" : 1, "name" : "DESCRIPTION", "intro" : "
Windows uses different locales to represent languages: codepages. Programs\nwhich are written with Log::Report however, will contain ISO encoded\nlanguage names; this module translates between them.
\n\nThe algorithms in this module are based on Win32::Locale and Win32::Codepage.
\n", "id" : "id552", "type" : "chapter", "path" : "DESCRIPTION" }, "id1261" : { "level" : 1, "name" : "SYNOPSIS", "intro" : "# use internally only\n\n", "id" : "id1261", "type" : "chapter", "path" : "SYNOPSIS" }, "id53" : { "call" : "$class->new( %options )", "intro" : "
The %options of the constructure configure processing options.
\n", "type" : "c_method", "id" : "id53", "options" : [ [ "id62", "id63" ], [ "id58", "id59" ], [ "id60", "id61" ], [ "id54", "id55" ], [ "id56", "id57" ] ], "examples" : [ "id64" ], "name" : "new" }, "id954" : { "params" : "$msgid", "intro" : "The message label, which refers to some translation information.\nUsually a string which is close the English version of the message.\nThis will also be used if there is no translation possible/known.
\n\nLeading white-space \\s will be added to _prepend. Trailing\nwhite-space will be added before _append.
Inherited, see Log::Report::Message::new(_category)
", "extends" : "id957", "id" : "id957-id221", "value" : "undef",
"type" : "default"
},
"id750-id461" : {
"extends" : "id750",
"name" : "only acceptable parameter is 'ACTIVE'",
"subroutine" : "id749",
"id" : "id750-id461",
"intro" : "Inherited, see Log::Report::Lexicon::Table::translations()
", "type" : "error" }, "id313" : { "type" : "default", "value" : "undef",
"id" : "id313",
"name" : "translate_to"
},
"id1182-id1217" : {
"name" : "isDisabled",
"extends" : "id1182",
"call" : "$obj->isDisabled",
"type" : "i_method",
"intro" : "Inherited, see Log::Report::Dispatcher::isDisabled()
", "id" : "id1182-id1217" }, "id427" : { "path" : "METHODS/Constructors", "subroutines" : [ "id428" ], "id" : "id427", "type" : "section", "name" : "Constructors", "level" : 2 }, "id1172" : { "name" : "format_reason", "id" : "id1172", "value" : "'LOWERCASE'", "type" : "default" }, "id814" : { "name" : "location", "id" : "id814", "intro" : "When defined, this location is used in the display. Otherwise, it\nis determined automatically if needed. An empty string will disable\nany attempt to display this line.
\n", "type" : "option", "params" : "$location" }, "id746" : { "call" : "$obj->msgstr( $msgid, [$count, $msgctxt] )", "type" : "i_method", "intro" : "Returns the translated string for $msgid. When not specified, $count is 1.
\n", "id" : "id746", "name" : "msgstr" }, "id1189" : { "call" : "$any->addSkipStack( @CODE )", "type" : "ci_method", "intro" : "[1.13] Add one or more CODE blocks of caller lines which should not be\ncollected for stack-traces or location display. A CODE gets\ncalled with an ARRAY of caller information, and returns true\nwhen that line should get skipped.
Warning: this logic is applied globally: on all dispatchers.
\n", "id" : "id1189", "examples" : [ "id1190" ], "name" : "addSkipStack" }, "id986-id221" : { "call" : "$obj->domain", "type" : "i_method", "intro" : "Inherited, see Log::Report::Message::domain()
", "id" : "id986-id221", "name" : "domain", "extends" : "id986" }, "id1179-id1217" : { "call" : "$obj->name", "intro" : "Inherited, see Log::Report::Dispatcher::name()
", "type" : "i_method", "id" : "id1179-id1217", "extends" : "id1179", "name" : "name" }, "id547" : { "name" : "Translating", "level" : 2, "path" : "METHODS/Translating", "id" : "id547", "type" : "section", "subroutines" : [ "id548", "id1090-id542" ] }, "id1265" : { "params" : "REASON", "id" : "id1265", "type" : "option", "name" : "on_die" }, "id1173-id780" : { "params" : "CHARSET", "id" : "id1173-id780", "intro" : "Inherited, see Log::Report::Dispatcher::new(charset)
", "type" : "option", "name" : "charset", "extends" : "id1173" }, "id994" : { "call" : "$obj->errno( [$errno] )", "intro" : "[1.38] Returns the value of the _errno key, to indicate the error\nnumber (to be returned from your script). Usually, this method will\nreturn undef. For FAILURE, FAULT, and ALERT, the errno is by default\ntaken from $! and $?.
Inherited, see Log::Report::Dispatcher::log()
", "type" : "i_method", "id" : "id1186-id1066", "name" : "log", "extends" : "id1186" }, "id1124" : { "level" : 1, "name" : "SYNOPSIS", "id" : "id1124", "intro" : "# internal usage\n use Log::Report::Domain;\n my $domain = Log::Report::Domain->new(name => $name);\n\n # find a ::Domain object\n use Log::Report 'my-domain';\n my $domain = textdomain 'my-domain'; # find domain config\n my $domain = textdomain; # config of this package\n\n # explicit domain configuration\n package My::Package;\n use Log::Report 'my-domain'; # set textdomain for package\n\n textdomain $name, %configure; # set config, once per program\n (textdomain $name)->configure(%configure); # same\n textdomain->configure(%configure); # same if current package in $name\n\n # implicit domain configuration\n package My::Package;\n use Log::Report 'my-domain', %configure;\n\n # external file for configuration (perl or json format)\n use Log::Report 'my-domain', config => $filename;\n\n use Log::Report 'my-domain';\n textdomain->configure(config => $filename);\n\n", "type" : "chapter", "path" : "SYNOPSIS" }, "id1004" : { "examples" : [ "id1005" ], "name" : "concat", "call" : "$obj->concat( $text|$message, [$prepend] )", "intro" : "
This method implements the overloading of concatenation, which is used\nto delay translations even longer. When $prepend is true, the $text\nor $message (another Log::Report::Message) will be prepended, otherwise\nit is appended in the final display.
Inherited, see Log::Report::Dispatcher::stackTraceLine(abstract)
", "extends" : "id1209", "value" : "1", "id" : "id1209-id1066", "type" : "default" }, "id1012" : { "path" : "DETAILS/Message-IDs", "type" : "section", "intro" : "An exception message as a string is pretty inflexible. It cannot\nbe translated anymore, and it cannot contain related information\nlike an error code. An exception message as an object (as this\nmodule implements) is able to contain additional information.
\n\nThe easiest way to create Log::Report::Message objects, is via the\n__x() (and friends) functions which are exported by Log::Report.\nThese are nearly equivalent:
\n my $msg = Log::Report::Message->new(_msgid => \"Hello, World!\");\n my $msg = __\"Hello, World!\";\n\n\n
The name msgid is used, because this object can do translations.\nIn the GNU gettext library for translations, the term msgid is\nused to describe the string which has to be looked-up in translation\ntables. When there are no tables, or the msgid is not found,\nthen the output string is equivalent to the msgid.
So, without any translation configuration, this happens:
\n\n my $msg = __\"Hello, World!\";\n print \"$msg\\n\"; # Hello, World!⏎\n\n\n
The __() function can be used with a static string, although you\ncould do this:
\n my $msg = __\"Hello $name!\"; #XXX Don't do this!\n print \"$msg\\n\"; # Hello Mark!⏎\n\n\n
With the __x() or __nx(), interpolation will take place on the\n(optionally) translated msgid string. This is how to write above:
\n my $msg = __x\"Hello {name}!\", name => $name;\n\n\nSo: the msgid is usually a format string. Only when you use\nformats correctly, you will be able to introduce translation later.
This profile will log DBIx::Class queries via Log::Report to a\nselected back-end (via a dispatcher, see Log::Report::Dispatcher)
\n", "type" : "chapter", "id" : "id1121", "path" : "DESCRIPTION", "level" : 1, "name" : "DESCRIPTION" }, "id137" : { "intro" : "Replace all escape characters into their readable counterpart. For\ninstance, a new-line is replaced by backslash-n.
\n", "type" : "function", "id" : "id137", "call" : "escape_chars( STRING )", "name" : "escape_chars" }, "id1140-id385" : { "extends" : "id1140", "name" : "config", "intro" : "Inherited, see Log::Report::Domain::configure(config)
", "type" : "option", "id" : "id1140-id385", "params" : "$file" }, "id1001" : { "call" : "$obj->toHTML( [$locale] )", "intro" : "[1.11] Translate the message, and then entity encode HTML volatile characters.
\n\n[1.20] When used in combination with a templating system, you may want to\nuse content_for => 'HTML' in Log::Report::Domain::configure(formatter).
Inherited, see Log::Report::Lexicon::Table::setupPluralAlgorithm()
", "id" : "id754-id561", "type" : "error", "extends" : "id754", "name" : "invalid plural-form algorithm '$alg'.", "subroutine" : "id753" }, "id860" : { "name" : "of N__w()\n", "id" : "id860", "intro" : "my @colors = (N__\"red\", N__\"green\", N__\"blue\");\n my @colors = N__w\"red green blue\"; # same\n print __ $colors[1];\n\n", "type" : "example" }, "id681" : { "name" : "version", "value" : "
undef",
"id" : "id681",
"type" : "default"
},
"id1248" : {
"type" : "error",
"id" : "id1248",
"name" : "message() of exception expects Log::Report::Message, got $what.",
"subroutine" : "id1246"
},
"id782" : {
"level" : 1,
"name" : "SYNOPSIS",
"id" : "id782",
"intro" : " # start using log4perl via a config file\n # The name of the dispatcher is the name of the default category.\n dispatcher LOG4PERL => 'logger',\n accept => 'NOTICE-',\n config => \"$ENV{HOME}/.log.conf\";\n\n # disable default dispatcher\n dispatcher close => 'logger';\n\n # configuration inline, not in file: adapted from the Log4perl manpage\n my $name = 'logger';\n my $outfile = '/tmp/a.log';\n my $config = <<__CONFIG;\n log4perl.category.$name = INFO, Logfile\n log4perl.logger.Logfile = Log::Log4perl::Appender::File\n log4perl.logger.Logfile.filename = $outfn\n log4perl.logger.Logfile.layout = Log::Log4perl::Layout::PatternLayout\n log4perl.logger.Logfile.layout.ConversionPattern = %d %F{1} %L> %m\n __CONFIG\n\n dispatcher LOG4PERL => $name, config => \\$config;\n\n",
"type" : "chapter",
"path" : "SYNOPSIS"
},
"id942-id221" : {
"extends" : "id942",
"name" : "'.'",
"intro" : "Inherited, see Log::Report::Message::'.'()
", "type" : "overload", "id" : "id942-id221", "call" : "overload '.'; concatenation" }, "id465" : { "path" : "METHODS", "name" : "METHODS", "level" : 1, "type" : "chapter", "id" : "id465", "nest" : [ "id466", "id486", "id490" ] }, "id1196" : { "name" : "filename", "type" : "option", "id" : "id1196", "params" : "STRING" }, "id399" : { "name" : "templater", "value" : "<required>", "id" : "id399", "type" : "default" }, "id1199-id1066" : { "extends" : "id1199", "value" : "<required>", "type" : "default", "id" : "id1199-id1066", "name" : "linenr", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(linenr)
" }, "id592" : { "name" : "Attributes", "level" : 2, "path" : "METHODS/Attributes", "type" : "section", "id" : "id592", "subroutines" : [ "id593" ] }, "id232" : { "name" : "bootstrapColor", "call" : "$obj->bootstrapColor", "id" : "id232", "intro" : "[2.03] Get a suitable bootstrap context color for the message. This can be\nused as per the SYNOPSIS.
\n\nCSS class success is used for Dancer2::Plugin::LogReport::success()\nmessages, info colors are used for messages notice and below,\nwarning is used for warning and mistake, danger is used for\nall other messages.
Inherited, see Log::Report::Dispatcher::new(locale)
", "name" : "locale", "value" : "<system locale>", "type" : "default", "id" : "id1168-id1021", "extends" : "id1168" }, "id349" : { "id" : "id349", "type" : "section", "nest" : [ "id350", "id351", "id352", "id353" ], "intro" : "You may define a textdomain without doing any translations (yet) However,\nwhen you start translating, you will need to maintain translation tables\nwhich are in PO-format. PO-files can be maintained with a wide variety\nof tools, for instance poedit, Pootle, virtaal, GTranslator, Lokalize,\nor Webtranslateit.
\n", "path" : "DETAILS/Extracting PO-files", "level" : 2, "name" : "Extracting PO-files" }, "id542" : { "chapters" : [ "id543", "id1356", "id544", "id545", "id546" ], "name" : "Log::Report::Translator::Gettext", "version" : "1.16", "is_pure_pod" : false, "distribution" : "Log-Report-Lexicon", "package" : "Log::Report::Translator::Gettext", "id" : "id542", "inheritance" : { "extends" : [ "Log::Report::Translator" ] }, "title" : "the GNU gettext infrastructure" }, "id285" : { "path" : "DETAILS/In Use/Sending messages to the user", "intro" : "To make it easier to send messages to your users, messages at the following\nlevels are also stored in the user's session: notice, warning, mistake,\nerror, fault, alert, failure and panic.
You can pass these to your template and display them at each page render:
\n\n hook before_template => sub {\n my $tokens = shift;\n $tokens->{messages} = session 'messages';\n session 'messages' => []; # Clear the message queue\n }\n\n\nThen in your template (for example the main layout):
\n\n [% FOR message IN messages %]\n <div class=\"alert alert-[% message.bootstrap_color %]\">\n [% message.toString | html_entity %]\n </div>\n [% END %]\n\n\n
The bootstrap_color of the message is compatible with Bootstrap contextual\ncolors: success, info, warning or danger.
When you use Dancer2::Template::TTLogReport as well, which enables the\ntranslations of your whole templates, then add locale:
\n [% message.toString(locale) | html_entity %]\n\n\n
Now, anywhere in your application that you have used Log::Report, you can
\n\n warning \"Hey user, you should now about this\";\n\n\n
and the message will be sent to the next page the user sees.
\n", "id" : "id285", "type" : "subsection", "name" : "Sending messages to the user", "level" : 3 }, "id438" : { "diagnostics" : [ "id439", "id440" ], "call" : "$obj->translate( $msg, $lang, $context )", "id" : "id438", "type" : "i_method", "name" : "translate" }, "id1153-id385" : { "call" : "$obj->translate( $message, $language )", "intro" : "Inherited, see Log::Report::Domain::translate()
", "id" : "id1153-id385", "type" : "i_method", "name" : "translate", "extends" : "id1153" }, "id649" : { "type" : "i_method", "intro" : "Remove all references which are not found as key in the hash $table.\nReturns the number of references left.
\n", "id" : "id649", "call" : "$obj->keepReferencesTo( $table )", "name" : "keepReferencesTo" }, "id751-id461" : { "extends" : "id751", "type" : "i_method", "id" : "id751-id461", "call" : "$obj->pluralIndex( $count )", "diagnostics" : [ "id752-id461" ], "name" : "pluralIndex", "intro" : "Inherited, see Log::Report::Lexicon::Table::pluralIndex()
" }, "id703" : { "type" : "i_method", "id" : "id703", "options" : [ [ "id704", "id705" ] ], "call" : "$obj->write( [$filename|$fh], %options )", "diagnostics" : [ "id706", "id707", "id708" ], "name" : "write", "intro" : "When you pass an open $fh, you are yourself responsible that\nthe correct character-encoding (binmode) is set. When the write\nfollowed a read() or the filename was explicitly set with filename(),\nthen you may omit the first parameter.
\n" }, "id735" : { "chapters" : [ "id736", "id1332", "id737", "id738", "id739" ], "name" : "Log::Report::Lexicon::Table", "version" : "1.16", "is_pure_pod" : false, "package" : "Log::Report::Lexicon::Table", "distribution" : "Log-Report-Lexicon", "id" : "id735", "inheritance" : { "extended_by" : [ "Log::Report::Lexicon::MOTcompact", "Log::Report::Lexicon::POT", "Log::Report::Lexicon::POTcompact" ] }, "title" : "generic interface to translation tables" }, "id992-id221" : { "name" : "addTags", "extends" : "id992", "type" : "i_method", "intro" : "Inherited, see Log::Report::Message::addTags()
", "id" : "id992-id221", "call" : "$obj->addTags( @tags )" }, "id1174" : { "name" : "charset", "value" : "undef",
"id" : "id1174",
"type" : "default"
},
"id1133" : {
"id" : "id1133",
"type" : "i_method",
"options" : [
[
"id1140",
"id1141"
],
[
"id1138",
"id1139"
],
[
"id168-id1122",
"id169-id1122"
],
[
"id1136",
"id1137"
],
[
"id1134",
"id1135"
],
[
"id166-id1122",
"id167-id1122"
]
],
"diagnostics" : [
"id1142",
"id1143"
],
"call" : "$obj->configure( %options )",
"name" : "configure",
"intro" : "The import is automatically called when the package is compiled. For all\nbut one packages in your distribution, it will only contain the name of\nthe DOMAIN. For one package, it will contain configuration information.\nThese %options are used for all packages which use the same DOMAIN.\nSee chapter Configuring below.
\n" }, "id787" : { "path" : "METHODS", "level" : 1, "name" : "METHODS", "id" : "id787", "type" : "chapter", "nest" : [ "id788", "id796", "id798" ] }, "id947-id221" : { "value" : "false",
"id" : "id947-id221",
"type" : "default",
"extends" : "id947",
"intro" : "Inherited, see Log::Report::Message::new(_expand)
", "name" : "_expand" }, "id1015" : { "path" : "DETAILS/Messages with plural forms/Interpolation with String::Print", "id" : "id1015", "intro" : "There is no way of checking beforehand whether you have provided all\nrequired values, to be interpolated in the translated string.
\n\nThis Log::Report::Message uses String::Print to handle formatted strings.\nOn object of that module is hidden in the logic of __x() and friends.
String::Print is a very capable format string processor, and you should\nreally read its manual page to see how it can help you. It would be\npossible to support an other formatter (pretty simple even), but this is\nnot (yet) supported.
\n", "type" : "subsection", "name" : "Interpolation with String::Print", "examples" : [ "id1016" ], "level" : 3 }, "id1183-id1021" : { "call" : "$obj->needs( [$reason] )", "intro" : "Inherited, see Log::Report::Dispatcher::needs()
", "type" : "i_method", "id" : "id1183-id1021", "extends" : "id1183", "name" : "needs" }, "id586" : { "path" : "DESCRIPTION", "intro" : "[Added in Log::Report v1.00]\nThe \"contexts\" concept in (GNU's version of) gettext, has a\nvery restricted purpose: to separate two (accidental) uses of the\nsame message-id, under different circumstances. The same msgid may\ntranslated diffently in one file or the other.
\n\nFor instance, two libraries used in the same application, or two\ncomponentent within a single library both want to used the same\ndefault text (which usually is very short)
\n\n char * t1 = pgettext('interface', 'None');\n char * t2 = pgettext('selections', 'None');\n\n\nSome translation setups use the library name consequently as msgctxt.\nBut, the name \"context\" is pretending much more power than the gettext\nlibraries are capable of: it usually only behaves like a namespace.
\n\nFor Log::Report, the power of \"context\" is extended with selecting\nbetween alternatives for the use of a msgid on the same spot.
\n\nFor instance, the gender of the user of the website determines whether\n`he' or `she' needs to be used in the translation. In this example,\nthe gender is set as context keyword in the message:
\n\n my ($name, $sex) = ('Jack', 'male');\n print __x\"{name<gender} found his key\", name => $name,\n _context => \"gender=$sex\";\n\n",
"id" : "id586",
"type" : "chapter",
"name" : "DESCRIPTION",
"level" : 1
},
"id778" : {
"level" : 2,
"name" : "Logging",
"subroutines" : [
"id1186-id760",
"id1189-id760",
"id1188-id760",
"id1185-id760",
"id1192-id760",
"id1191-id760",
"id1193-id760",
"id1187-id760",
"id779"
],
"id" : "id778",
"type" : "section",
"path" : "METHODS/Logging"
},
"id132" : {
"name" : "mode_number",
"id" : "id132",
"intro" : "Returns the $mode as number.
\n", "type" : "function", "call" : "mode_number( $name|$mode )" }, "id870" : { "intro" : "This sets the default mode for all created dispatchers. You can\nalso selectively change the output mode, like
\n dispatcher PERL => 'default', mode => 3\n\n", "id" : "id870", "type" : "option", "params" : "LEVEL", "name" : "mode" }, "id1181-id1217" : { "name" : "mode", "extends" : "id1181", "call" : "$obj->mode", "type" : "i_method", "intro" : "
Inherited, see Log::Report::Dispatcher::mode()
", "id" : "id1181-id1217" }, "id1171" : { "name" : "format_reason", "id" : "id1171", "intro" : "How to show the reason text which is printed before the message. When\na CODE is specified, it will be called with a translated text and the\nreturned text is used.
\n", "type" : "option", "params" : "'UPPERCASE'|'LOWERCASE'|'UCFIRST'|'IGNORE'|CODE" }, "id796" : { "subroutines" : [ "id1180-id780", "id1179-id780", "id1183-id780", "id1181-id780", "id1182-id780", "id797" ], "type" : "section", "id" : "id796", "path" : "METHODS/Attributes", "level" : 2, "name" : "Attributes" }, "id1262" : { "name" : "DESCRIPTION", "level" : 1, "path" : "DESCRIPTION", "intro" : "This module is used internally, to translate output of 'die' and Carp\nfunctions into Log::Report::Message objects. Also, it tries to\nconvert other kinds of exception frameworks into our message object.
\n", "id" : "id1262", "type" : "chapter" }, "id416" : { "name" : "no counting positional for '$msgid'", "subroutine" : "id412", "id" : "id416", "type" : "error" }, "id475" : { "name" : "cannot seek to $loc in $fn for originals: $!", "subroutine" : "id467", "type" : "fault", "id" : "id475" }, "id237" : { "version" : "2.03", "chapters" : [ "id238", "id1350", "id239", "id240", "id241", "id249" ], "name" : "Dancer2::Template::TTLogReport", "inheritance" : { "extends" : [ "Moo::Object" ] }, "id" : "id237", "title" : "Template toolkit engine with Log::Report translations for Dancer2", "is_pure_pod" : false, "package" : "Dancer2::Template::TTLogReport", "distribution" : "Dancer2-Plugin-LogReport" }, "id597" : { "id" : "id597", "type" : "warning", "subroutine" : "id595", "name" : "no value for tag `$tag' in the context" }, "id1058" : { "call" : "$obj->showStatus", "intro" : "If this object is kept in $@, and someone uses this as string, we\nwant to show the fatal error message.
The message is not very informative for the good cause: we do not want\npeople to simply print the $@, but wish for a re-cast of the message\nusing reportAll() or reportFatal().
Log::Report::Extract is extended by\n Log::Report::Extract::PerlPPI\n Log::Report::Template::Extract\n\n", "id" : "id1338" }, "id1187-id1091" : { "call" : "$obj->translate( \\%options, $reason, $message )", "id" : "id1187-id1091", "intro" : "
Inherited, see Log::Report::Dispatcher::translate()
", "type" : "i_method", "extends" : "id1187", "name" : "translate" }, "id1200-id780" : { "params" : "STRING", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(call)
", "id" : "id1200-id780", "type" : "option", "name" : "call", "extends" : "id1200" }, "id944" : { "name" : "Constructors", "level" : 2, "path" : "METHODS/Constructors", "type" : "section", "id" : "id944", "subroutines" : [ "id980", "id945" ] }, "id495" : { "intro" : " my $ppi = Log::Report::Extract::PerlPPI->new(\n lexicon => '/usr/share/locale',\n );\n $ppi->process('lib/My/Pkg.pm'); # call for each .pm file\n $ppi->showStats; # optional\n $ppi->write;\n\n # See script xgettext-perl\n bin/xgettext-perl -p $lexdir @source_dirs\n\n",
"id" : "id495",
"type" : "chapter",
"path" : "SYNOPSIS",
"level" : 1,
"name" : "SYNOPSIS"
},
"id588" : {
"name" : "Constructors",
"level" : 2,
"path" : "METHODS/Constructors",
"subroutines" : [
"id589"
],
"id" : "id588",
"type" : "section"
},
"id715" : {
"intro" : "Lookup the Log::Report::Lexicon::PO with the STRING. If you\nwant to add a new translation, use add(). Returns undef\nwhen not defined.
[1.44] Check whether any of the classes listed in the message match $tag\n(string) or the Regexp. This uses Log::Report::Message::taggedWith().
\n", "id" : "id1250", "type" : "i_method" }, "id577" : { "name" : "filename", "intro" : "Returns the name of the source file for this data.
\n", "id" : "id577", "type" : "i_method", "call" : "$obj->filename" }, "id669" : { "version" : "1.16", "chapters" : [ "id670", "id1339", "id671", "id672", "id673" ], "name" : "Log::Report::Lexicon::POT", "title" : "manage PO files", "inheritance" : { "extends" : [ "Log::Report::Lexicon::Table" ] }, "id" : "id669", "distribution" : "Log-Report-Lexicon", "package" : "Log::Report::Lexicon::POT", "is_pure_pod" : false }, "id1192-id905" : { "extends" : "id1192", "name" : "collectLocation", "call" : "$any->collectLocation", "id" : "id1192-id905", "intro" : "Inherited, see Log::Report::Dispatcher::collectLocation()
", "type" : "ci_method" }, "id562" : { "path" : "NAME", "id" : "id562", "intro" : "Log::Report::Lexicon::POTcompact - use translations from a POT file
\n", "type" : "chapter", "name" : "NAME", "level" : 1 }, "id798" : { "level" : 2, "name" : "Logging", "subroutines" : [ "id1186-id780", "id1189-id780", "id1188-id780", "id1185-id780", "id1192-id780", "id1191-id780", "id1193-id780", "id1187-id780", "id799" ], "type" : "section", "id" : "id798", "path" : "METHODS/Logging" }, "id418" : { "subroutine" : "id412", "name" : "Missing key '$key' in format '$format', in $use //template", "type" : "warning", "id" : "id418" }, "id1282" : { "level" : 3, "name" : "Avoiding repetative translations", "type" : "subsection", "id" : "id1282", "path" : "DETAILS/Automatic parameters/Avoiding repetative translations" }, "id1167-id1091" : { "extends" : "id1167", "name" : "locale", "id" : "id1167-id1091", "intro" : "Inherited, see Log::Report::Dispatcher::new(locale)
", "type" : "option", "params" : "LOCALE" }, "id890" : { "path" : "DETAILS/Introduction/Background ideas", "intro" : "The following ideas are the base of this implementation:
\n\ngettext(). However, in the Log::Report infrastructure,\ntranslations are postponed until the text is dispatched to a screen\nor log-file; the same report can be sent to syslog in (for instance)\nEnglish and to the user interface in Dutch.\n\n\n\nInherited, see Log::Report::Dispatcher::collectStack()
", "type" : "ci_method", "id" : "id1188-id1021" }, "id1138" : { "id" : "id1138", "intro" : "When %rules are provided, the translator will use the msgctxt fields\nas provided by PO-files (gettext). This parameter is used to initialize\na Log::Report::Translator::Context helper object.
Inherited, see Log::Report::Message::new(_classes)
", "name" : "_classes", "type" : "default", "value" : "undef",
"id" : "id967-id221",
"extends" : "id967"
},
"id1202-id905" : {
"params" : "ARRAY",
"id" : "id1202-id905",
"intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(params)
", "type" : "option", "name" : "params", "extends" : "id1202" }, "id217" : { "inheritance" : { "extends" : [ "Dancer::Logger::Abstract", "Exporter" ] }, "id" : "id217", "title" : "reroute Dancer logs into Log::Report", "is_pure_pod" : false, "package" : "Dancer::Logger::LogReport", "distribution" : "Dancer2-Plugin-LogReport", "version" : "2.03", "chapters" : [ "id218", "id1343", "id219", "id220" ], "name" : "Dancer::Logger::LogReport" }, "id436" : { "name" : "charset", "call" : "$obj->charset", "intro" : "Returns the default charset, which can be overrule by the locale.
\n", "type" : "i_method", "id" : "id436" }, "id972-id221" : { "extends" : "id972", "name" : "_join", "type" : "option", "intro" : "Inherited, see Log::Report::Message::new(_join)
", "id" : "id972-id221", "params" : "$separator" }, "id100" : { "intro" : "[0.91] Too often, you have to translate a (file) size into humanly readible\nformat. The BYTES modifier simplifies this a lot:
\n printp \"{size BYTES} {fn}\\n\", fn => $fn, size => -s $fn;\n\n\nThe output will always be 5 characters. Examples are \"999 B\", \"1.2kB\",\nand \" 27MB\".
\n", "type" : "subsection", "id" : "id100", "path" : "DETAILS/Interpolation: Modifiers/Modifier: BYTES", "level" : 3, "name" : "Modifier: BYTES" }, "id72" : { "intro" : "The following are provided both as method and as function. The function\nversion is explained further down on this page, because it reads a bit\neasier, but the object version is most flexible.
\n\n my $sp = String::Print->new;\n $sp->printi([$fh], $format, %data|\\%data); # see printi()\n $sp->printp([$fh], $format, @params, %options); # see printp()\n my $s = $sp->sprinti($format, %data|\\%data); # see sprinti()\n my $s = $sp->sprintp($format, @params, %options); # see sprintp()\n\n", "id" : "id72", "type" : "section", "path" : "METHODS/Printing", "level" : 2, "examples" : [ "id73" ], "name" : "Printing" }, "id112" : { "level" : 3, "name" : "Output encoding exclusion", "type" : "subsection", "intro" : "
In some cases, the data which is inserted is already encoded in the\noutput syntax. For instance, you already have HTML to be included.
\n\nThe default exclusion rule for HTML output is qr/html$/i, which\nmeans that all inserted named parameters, where the name ends on html\nwill not get html-entity encoded.
This will work by default:
\n\n # with encodeFor('HTML')\n printp \"Me & Co: {name}, {description_html}\",\n name => 'RenE<eacute>', description_html => $descr;\n\n\nThis may result in:
\n\n Me & Co: RenE<amp>eacute;, <font color=\"red\">new member</font>\n\n\n
Better not to have HTML in your program: leave it to the template. But\nin some cases, you have no choice.
\n", "id" : "id112", "path" : "DETAILS/Output encoding/Output encoding exclusion" }, "id522-id493" : { "extends" : "id522", "name" : "charset", "type" : "option", "intro" : "Inherited, see Log::Report::Extract::new(charset)
", "id" : "id522-id493", "params" : "$charset" }, "id1053" : { "name" : "wasFatal", "call" : "$obj->wasFatal( %options )", "options" : [ [ "id1056", "id1057" ], [ "id1054", "id1055" ] ], "intro" : "Returns the Log::Report::Exception which caused the \"try\" block to\ndie, otherwise an empty LIST (undef).
Alternative name for _tag
\n", "type" : "option", "id" : "id964", "params" : "$tags|\\@tags", "name" : "_tags" }, "id1164-id1217" : { "intro" : "Inherited, see Log::Report::Dispatcher::new()
", "name" : "new", "diagnostics" : [ "id1175-id1217", "id1176-id1217", "id1177-id1217" ], "call" : "$class->new( $type, $name, %options )", "options" : [ [ "id1165-id1217", "id1166-id1217" ], [ "id1173-id1217", "id1174-id1217" ], [ "id1171-id1217", "id1172-id1217" ], [ "id1167-id1217", "id1168-id1217" ], [ "id1169-id1217", "id1170-id1217" ] ], "type" : "c_method", "id" : "id1164-id1217", "extends" : "id1164" }, "id1333" : { "name" : "INHERITANCE", "level" : 1, "path" : "INHERITANCE", "id" : "id1333", "intro" : "Log::Report::Dispatcher::File\n is a Log::Report::Dispatcher\n\n", "type" : "chapter" }, "id567" : { "call" : "$class->read( $filename, %options )", "diagnostics" : [ "id570", "id571", "id572", "id573", "id574", "id575" ], "id" : "id567", "type" : "c_method", "options" : [ [ "id568", "id569" ] ], "name" : "read", "intro" : "
Read the POT table information from $filename, as compact as possible.\nComments, plural-form, and such are lost on purpose: they are not\nneeded for translations.
\n" }, "id911" : { "name" : "new", "intro" : "With syslog, people tend not to include the REASON of the message\nin the logs, because that is already used to determine the destination\nof the message.
\n", "call" : "$class->new( $type, $name, %options )", "diagnostics" : [ "id929", "id930" ], "options" : [ [ "id1165-id905", "id1166-id905" ], [ "id925", "id926" ], [ "id917", "id918" ], [ "id915", "id916" ], [ "id927", "id928" ], [ "id1171-id905", "id912" ], [ "id913", "id914" ], [ "id923", "id924" ], [ "id1167-id905", "id1168-id905" ], [ "id921", "id922" ], [ "id1169-id905", "id1170-id905" ], [ "id919", "id920" ] ], "id" : "id911", "type" : "c_method" }, "id766" : { "options" : [ [ "id1165-id760", "id1166-id760" ], [ "id773", "id774" ], [ "id1173-id760", "id1174-id760" ], [ "id1171-id760", "id1172-id760" ], [ "id1167-id760", "id1168-id760" ], [ "id771", "id772" ], [ "id769", "id770" ], [ "id1169-id760", "id1170-id760" ], [ "id767", "id768" ] ], "type" : "c_method", "id" : "id766", "call" : "$class->new( $type, $name, %options )", "diagnostics" : [ "id775" ], "name" : "new", "intro" : "The Log::Dispatch infrastructure has quite a large number of output\nTYPEs, each extending the Log::Dispatch::Output base-class. You\ndo not create these objects yourself: Log::Report is doing it for you.
\n\nThe Log::Dispatch back-ends are very careful with validating their\nparameters, so you will need to restrict the options to what is supported\nfor the specific back-end. See their respective manual-pages. The errors\nproduced by the back-ends quite horrible and untranslated, sorry.
\n" }, "id379" : { "name" : "msgid '$msgid' contains html escapes, don't do that. File $file line $linenr.", "subroutine" : "id370", "type" : "warning", "id" : "id379" }, "id572" : { "name" : "cannot read from file $fn (unknown charset): $!", "subroutine" : "id567", "type" : "fault", "id" : "id572" }, "id679" : { "name" : "textdomain", "id" : "id679", "value" : "<required>", "type" : "default" }, "id1324" : { "path" : "DETAILS/Processing the message/Filters", "id" : "id1324", "type" : "subsection", "name" : "Filters", "level" : 3 }, "id1205-id905" : { "name" : "max_line", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(max_line)
", "extends" : "id1205", "type" : "default", "id" : "id1205-id905", "value" : "undef"
},
"id1040" : {
"call" : "$obj->died( [$text] )",
"type" : "i_method",
"intro" : "The exit $text or object ($@) of the eval'ed block, in its unprocessed state.\nThey will always return true when they where deadly, and it always stringifies\ninto something useful.
print __n \"one\", \"more\", $a;\n print __n(\"one\", \"more\", $a), \"\\n\";\n print +(__n \"one\", \"more\", $a), \"\\n\";\n\n # new-lines are ignore at lookup, but printed.\n print __n \"one\\n\", \"more\\n\", $a;\n\n # count is in scalar context\n # the value is also available as _count\n print __n \"found one\\n\", \"found {_count}\\n\", @r;\n\n # ARRAYs and HASHes are counted\n print __n \"one\", \"more\", \\@r;\n\n",
"id" : "id851",
"type" : "example",
"name" : "how to use __n()\n"
},
"id977-id221" : {
"name" : "_context",
"intro" : "Inherited, see Log::Report::Message::new(_context)
", "extends" : "id977", "id" : "id977-id221", "type" : "default", "value" : "undef"
},
"id200" : {
"call" : "panic( $message )",
"id" : "id200",
"type" : "function",
"name" : "panic"
},
"id212" : {
"intro" : "\n",
"name" : "import",
"id" : "id212",
"type" : "i_method",
"diagnostics" : [
"id213"
],
"call" : "$obj->import( [$domain], %options )"
},
"id988-id221" : {
"extends" : "id988",
"name" : "context",
"intro" : "Inherited, see Log::Report::Message::context()
", "type" : "i_method", "id" : "id988-id221", "call" : "$obj->context" }, "id748" : { "name" : "add", "type" : "i_method", "intro" : "Add the information from a $po into this POT. If the msgid of the $po\nis already known, that is an error.
\n", "id" : "id748", "call" : "$obj->add( $po )" }, "id1169" : { "params" : "'NORMAL'|'VERBOSE'|'ASSERT'|'DEBUG'|0..3", "id" : "id1169", "intro" : "Possible values are NORMAL (or 0 or undef), which will not show\nINFO or debug messages, VERBOSE (1; shows INFO not debug),\nASSERT (2; only ignores TRACE messages), or DEBUG (3)\nwhich shows everything. See section Run modes.
You are advised to use the symbolic mode names when the mode is\nchanged within your program: the numerical values are available\nfor smooth Getopt::Long integration.
\n", "type" : "option", "name" : "mode" }, "id962-id221" : { "id" : "id962-id221", "intro" : "Inherited, see Log::Report::Message::new(_tag)
", "type" : "option", "params" : "$tags|\\@tags", "extends" : "id962", "name" : "_tag" }, "id1166-id1066" : { "name" : "accept", "intro" : "Inherited, see Log::Report::Dispatcher::new(accept)
", "extends" : "id1166", "id" : "id1166-id1066", "type" : "default", "value" : "depend on mode"
},
"id1243" : {
"id" : "id1243",
"type" : "i_method",
"call" : "$obj->reason( [$reason] )",
"name" : "reason"
},
"id840" : {
"call" : "fault( $message )",
"id" : "id840",
"intro" : "Short for report FAULT => $message
Inherited, see Log::Report::Dispatcher::stackTraceLine(package)
", "extends" : "id1195", "id" : "id1195-id905", "value" : "<required>", "type" : "default" }, "id445" : { "name" : "METHODS", "level" : 1, "path" : "METHODS", "nest" : [ "id446", "id448", "id450" ], "id" : "id445", "type" : "chapter" }, "id527-id493" : { "type" : "i_method", "intro" : "Inherited, see Log::Report::Extract::index()
", "id" : "id527-id493", "call" : "$obj->index", "name" : "index", "extends" : "id527" }, "id117" : { "id" : "id117", "inheritance" : { "extends" : [ "Exporter" ] }, "title" : "helpful routines to Log::Report", "is_pure_pod" : false, "distribution" : "Log-Report-Optional", "package" : "Log::Report::Util", "version" : "1.08", "chapters" : [ "id118", "id1336", "id119", "id120", "id121" ], "name" : "Log::Report::Util" }, "id1321" : { "id" : "id1321", "type" : "section", "path" : "DETAILS/Available back-ends", "level" : 2, "name" : "Available back-ends" }, "id158-id1122" : { "value" : "<required>", "type" : "default", "id" : "id158-id1122", "extends" : "id158", "intro" : "Inherited, see Log::Report::Minimal::Domain::new(name)
", "name" : "name" }, "id974" : { "name" : "_lang", "intro" : "[1.00] Override language setting from locale, for instance because that\nis not configured correctly (yet). This does not extend to prepended\nor appended translated message object.
\n", "id" : "id974", "type" : "option", "params" : "ISO" }, "id47" : { "title" : "printf alternative", "id" : "id47", "inheritance" : {}, "distribution" : "String-Print", "package" : "String::Print", "is_pure_pod" : false, "version" : "1.02", "chapters" : [ "id48", "id49", "id50", "id51", "id74", "id89" ], "name" : "String::Print" }, "id908" : { "name" : "DESCRIPTION", "level" : 1, "path" : "DESCRIPTION", "id" : "id908", "intro" : "This dispatchers produces output to syslog, based on the Sys::Syslog\nmodule (which will NOT be automatically installed for you, because some\nsystems have a problem with this dependency).
\n\nThe REASON for a message often uses names which are quite similar to\nthe log-levels used by syslog. However: they have a different purpose.\nThe REASON is used by the programmer to indicate the cause of the message:\nwhether it was able to handle a certain situation. The syslog levels\nare there for the user's of the program (with syslog usually the\nsystem administrators). It is not unusual to see a \"normal\" error\nor mistake as a very serious situation in a production environment. So,\nyou may wish to translate any message above reason MISTAKE into a LOG_CRIT.
\n\nThe default translation table is list below. You can change the mapping\nusing new(to_prio). See example in SYNOPSIS.
\n\n TRACE => LOG_DEBUG ERROR => LOG_ERR\n ASSERT => LOG_DEBUG FAULT => LOG_ERR\n INFO => LOG_INFO ALERT => LOG_ALERT\n NOTICE => LOG_NOTICE FAILURE => LOG_EMERG\n WARNING => LOG_WARNING PANIC => LOG_CRIT\n MISTAKE => LOG_WARNING\n\n", "type" : "chapter" }, "id749-id461" : { "extends" : "id749", "type" : "i_method", "id" : "id749-id461", "diagnostics" : [ "id750-id461" ], "call" : "$obj->translations( [$active] )", "name" : "translations", "intro" : "
Inherited, see Log::Report::Lexicon::Table::translations()
" }, "id879" : { "type" : "error", "id" : "id879", "name" : "no domain for configuration options in $fn line $line", "subroutine" : "id867" }, "id752" : { "name" : "there is no Plural-Forms field in the header, but needed.", "subroutine" : "id751", "type" : "error", "id" : "id752" }, "id1208-id1091" : { "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(abstract)
", "type" : "option", "id" : "id1208-id1091", "params" : "INTEGER", "extends" : "id1208", "name" : "abstract" }, "id651" : { "id" : "id651", "intro" : "Returns whether the translation needs human inspection.
\n", "type" : "i_method", "call" : "$obj->fuzzy( [BOOLEAN] )", "name" : "fuzzy" }, "id1030" : { "call" : "$class->new( $type, $name, %options )", "id" : "id1030", "type" : "c_method", "options" : [ [ "id1165-id1021", "id1166-id1021" ], [ "id1173-id1021", "id1174-id1021" ], [ "id1033", "id1034" ], [ "id1031", "id1032" ], [ "id1171-id1021", "id1172-id1021" ], [ "id1035", "id1036" ], [ "id1167-id1021", "id1168-id1021" ], [ "id1169-id1021", "id1170-id1021" ], [ "id1037", "id1038" ] ], "name" : "new" }, "id1274" : { "path" : "METHODS/Processing", "id" : "id1274", "type" : "section", "subroutines" : [ "id1010-id221", "id1000-id221", "id1004-id221", "id998-id221", "id1006-id221", "id1003-id221", "id1001-id221", "id999-id221" ], "name" : "Processing", "level" : 2 }, "id1076" : { "type" : "error", "id" : "id1076", "name" : "dispatcher $name needs a 'callback'", "subroutine" : "id1073" }, "id351" : { "name" : "adding a new language", "level" : 3, "path" : "DETAILS/Extracting PO-files/adding a new language", "type" : "subsection", "intro" : "The first time you run extract(), you will see a file being created\nin $lexicon/$textdomain-$charset.po. That file will be left empty:\ncopy it to start a new translation.
There are many ways to structure PO-files. Which structure used, is\ndetected automatically by Log::Report::Lexicon. My personal preference\nis $lexicon/$textdomain/$language-$charset.po. On Unix-like systems,\nyou would do:
\n # Start a new language\n mkdir mylexicon/mydomain\n cp mylexicon/mydomain-utf8.po mylexicon/mydomain/nl_NL-utf8.po\n\n # fill the nl_NL-utf8.po file with the translation\n poedit mylexicon/mydomain/nl_NL-utf8.po\n\n # add the file to your version control system\n git add mylexicon/mydomain/nl_NL-utf8.po\n\n\n\n
Now, when your program sets the locale to 'nl-NL', it should start\ntranslating to Dutch. If it doesn't, it is not always easy to\nfigure-out what is wrong...
\n", "id" : "id351" }, "id1350" : { "level" : 1, "name" : "INHERITANCE", "type" : "chapter", "intro" : "Dancer2::Template::TTLogReport\n is a Moo::Object\n\n", "id" : "id1350", "path" : "INHERITANCE" }, "id1233" : { "path" : "METHODS/Constructors", "type" : "section", "id" : "id1233", "subroutines" : [ "id1234" ], "name" : "Constructors", "level" : 2 }, "id155" : { "level" : 2, "name" : "Constructors", "subroutines" : [ "id156" ], "id" : "id155", "type" : "section", "path" : "METHODS/Constructors" }, "id340" : { "intro" : "
If the 'processing_errors' option is 'NATIVE' (default), you have to\ncollect the error like this:
\n\n $tt->process($template_fn, $vars, ...)\n or die $tt->error;\n\n\n
When the 'procesing_errors' option is set to 'EXCEPTION', the error is\ntranslated into a Log::Report::Exception:
\n\n use Log::Report;\n try { $tt->process($template_fn, $vars, ...) };\n print $@->wasFatal if $@;\n\n\nIn the latter solution, the try() is probably only on the level of the\nhighest level: the request handler which catches all kinds of serious\nerrors at once.
\n", "id" : "id340", "type" : "i_method", "call" : "$obj->error", "name" : "error" }, "id640" : { "intro" : "Returns the actual msgid_plural, which can be undef.
use String::Print 'oo'; # do not import the functions\n\n my $sp = String::Print->new(\n modifiers => [ EUR => sub {sprintf \"%5.2f e\", $_[0]} ],\n serializers => [ UNDEF => sub {'-'} ],\n defaults => [ DT => { standard => 'ISO' } ],\n );\n\n $sp->printi(\"price: {p EUR}\", p => 3.1415); # price: ␣␣3.14 e\n $sp->printi(\"count: {c}\", c => undef); # count: -\n my $s = $sp->sprinti(\"price: {p EUR}\", p => 7); # output in $s\n\n",
"id" : "id73"
},
"id1173-id760" : {
"intro" : "Inherited, see Log::Report::Dispatcher::new(charset)
", "type" : "option", "id" : "id1173-id760", "params" : "CHARSET", "extends" : "id1173", "name" : "charset" }, "id1162" : { "id" : "id1162", "type" : "chapter", "nest" : [ "id1163", "id1178", "id1184" ], "path" : "METHODS", "name" : "METHODS", "level" : 1 }, "id973" : { "value" : "$\" $LIST_SEPARATOR",
"type" : "default",
"id" : "id973",
"name" : "_join"
},
"id426" : {
"id" : "id426",
"type" : "chapter",
"nest" : [
"id427",
"id434",
"id437"
],
"path" : "METHODS",
"name" : "METHODS",
"level" : 1
},
"id1198-id1091" : {
"extends" : "id1198",
"name" : "linenr",
"type" : "option",
"intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(linenr)
", "id" : "id1198-id1091", "params" : "INTEGER" }, "id956-id221" : { "extends" : "id956", "name" : "_category", "intro" : "Inherited, see Log::Report::Message::new(_category)
", "type" : "option", "id" : "id956-id221", "params" : "INTEGER" }, "id1289" : { "path" : "DETAILS/Configuring", "name" : "Configuring", "level" : 2, "id" : "id1289", "type" : "section", "nest" : [ "id1290", "id1291" ] }, "id1091" : { "chapters" : [ "id1092", "id1333", "id1093", "id1094", "id1095", "id1297" ], "name" : "Log::Report::Dispatcher::File", "version" : "1.46", "is_pure_pod" : false, "distribution" : "Log-Report", "package" : "Log::Report::Dispatcher::File", "inheritance" : { "extends" : [ "Log::Report::Dispatcher" ] }, "id" : "id1091", "title" : "send messages to a file or file-handle" }, "id869" : { "name" : "syntax", "id" : "id869", "value" : "'SHORT'", "type" : "default" }, "id1165" : { "name" : "accept", "id" : "id1165", "intro" : "See Log::Report::Util::expand_reasons() for possible values. If\nthe initial mode for this dispatcher does not need verbose or debug\ninformation, then those levels will not be accepted.
\n\nWhen the mode equals \"NORMAL\" (the default) then accept's default\nis NOTICE- . In case of \"VERBOSE\" it will be INFO- , ASSERT\nresults in ASSERT- , and \"DEBUG\" in ALL.
Returns true if the previous try block did produce a terminal\nerror. This \"try\" object is assigned to $@, and the usual\nperl syntax is if($@) {...error-handler...}.
undef",
"type" : "default",
"id" : "id401"
},
"id1199-id905" : {
"intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(linenr)
", "name" : "linenr", "id" : "id1199-id905", "type" : "default", "value" : "<required>", "extends" : "id1199" }, "id1200-id760" : { "params" : "STRING", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(call)
", "type" : "option", "id" : "id1200-id760", "name" : "call", "extends" : "id1200" }, "id556" : { "intro" : "Returns the ISO string for the Microsoft codepage locale. Might return\nundef/false. By default, the actual codepage is used.
Overrule the date which is included in the generated header.
\n", "type" : "option", "id" : "id690" }, "id1221" : { "path" : "METHODS", "level" : 1, "name" : "METHODS", "type" : "chapter", "id" : "id1221", "nest" : [ "id1222", "id1223", "id1224" ] }, "id1186-id905" : { "extends" : "id1186", "name" : "log", "call" : "$obj->log( \\%options, $reason, $message, $domain )", "intro" : "Inherited, see Log::Report::Dispatcher::log()
", "type" : "i_method", "id" : "id1186-id905" }, "id537-id493" : { "name" : "showStats", "extends" : "id537", "call" : "$obj->showStats( [$domains] )", "intro" : "Inherited, see Log::Report::Extract::showStats()
", "type" : "i_method", "id" : "id537-id493" }, "id1148" : { "intro" : "Temporary set the default translation context for messages. This is used\nwhen the message is created without a _context parameter. The context\ncan be retrieved with defaultContext().
Contexts are totally ignored then there are no context_rules. When\nyou do not wish to change settings, you may simply provide an empty HASH.
Dancer::Logger::LogReport\n is a Dancer::Logger::Abstract\n\n Dancer::Logger::LogReport\n is an Exporter\n\n", "type" : "chapter", "id" : "id1343", "name" : "INHERITANCE", "level" : 1 }, "id255" : { "path" : "DESCRIPTION", "type" : "chapter", "intro" : "
[The Dancer2 plugin was contributed by Andrew Beverley]\nWhen you need to translate your templates as well (not only the messages\nin your code) then have a look at Dancer2::Template::TTLogReport.
\n\nThis module provides easy access to the extensive logging facilities\nprovided by Log::Report. Along with Dancer2::Logger::LogReport,\nthis brings together all the internal Dancer2 logging, handling for\nexpected and unexpected exceptions, translations and application logging.
\n\nLogging is extremely flexible using many of the available\ndispatchers. Multiple dispatchers can be\nused, each configured separately to display different messages in different\nformats. By default, messages are logged to a session variable for display on\na webpage, and to STDERR.
\n\nMessages within this plugin use the extended\nmanual Dancer2::Logger::LogReport::Message class rather than the standard\nLog::Report::Message class.
\n\nNote that it is currently recommended to use the plugin in all apps within\na Dancer2 program, not only some. Therefore, wherever you use Dancer2\nyou should also use Dancer2::Plugin::LogReport. This does not apply if\nusing the same app name (use Dancer2 appname, 'Already::Exists'). In\nall other modules, you can just use Log::Report.
Read the DETAILS in below in this manual-page.
\n", "id" : "id255", "name" : "DESCRIPTION", "level" : 1 }, "id1296" : { "path" : "DETAILS/Processing the message/Filters", "type" : "subsection", "id" : "id1296", "name" : "Filters", "level" : 3 }, "id1094" : { "path" : "DESCRIPTION", "intro" : "This basic file logger accepts an file-handle or filename as destination.
\n\n[1.00] writing to the file protected by a lock, so multiple processes\ncan write to the same file.
\n", "id" : "id1094", "type" : "chapter", "name" : "DESCRIPTION", "level" : 1 }, "id963" : { "name" : "_tag", "value" : "[]", "id" : "id963", "type" : "default" }, "id1209-id905" : { "name" : "abstract", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(abstract)
", "extends" : "id1209", "id" : "id1209-id905", "type" : "default", "value" : "1" }, "id209" : { "id" : "id209", "type" : "function", "call" : "N__n( $single_msgid, $plural_msgid )", "name" : "N__n" }, "id921" : { "name" : "logsocket", "id" : "id921", "intro" : "If specified, the log socket type will be initialized to this before\nopenlog() is called. If not specified, the system default is used.
Inherited, see Log::Report::Minimal::Domain::configure(where)
", "name" : "where", "type" : "default", "value" : "<required>", "id" : "id167-id1122", "extends" : "id167" }, "id1306" : { "path" : "DETAILS", "level" : 1, "name" : "DETAILS", "type" : "chapter", "id" : "id1306", "nest" : [ "id1307", "id1308" ] }, "id1166-id905" : { "id" : "id1166-id905", "type" : "default", "value" : "depend on mode",
"extends" : "id1166",
"intro" : "Inherited, see Log::Report::Dispatcher::new(accept)
", "name" : "accept" }, "id849" : { "subroutine" : "id847", "name" : "even length parameter list for __x at $where", "type" : "error", "id" : "id849" }, "id172-id1122" : { "intro" : "Inherited, see Log::Report::Minimal::Domain::interpolate()
", "id" : "id172-id1122", "type" : "i_method", "call" : "$obj->interpolate( $msgid, [$args] )", "name" : "interpolate", "extends" : "id172" }, "id1195-id1066" : { "id" : "id1195-id1066", "value" : "<required>", "type" : "default", "extends" : "id1195", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(package)
", "name" : "package" }, "id704" : { "name" : "only_active", "type" : "option", "intro" : "[1.02] Do not write records which do have a translation, but where the\nmsgid has disappeared from the sources. By default, these records are\ncommented out (marked with '#~') but left in the file.
\n", "id" : "id704", "params" : "BOOLEAN" }, "id1170-id1091" : { "intro" : "Inherited, see Log::Report::Dispatcher::new(mode)
", "name" : "mode", "type" : "default", "value" : "'NORMAL'", "id" : "id1170-id1091", "extends" : "id1170" }, "id1269" : { "level" : 2, "name" : "Available back-ends", "type" : "section", "id" : "id1269", "path" : "DETAILS/Available back-ends" }, "id370" : { "options" : [ [ "id371", "id372" ], [ "id373", "id374" ] ], "id" : "id370", "type" : "i_method", "call" : "$obj->process( $filename, %options )", "diagnostics" : [ "id375", "id376", "id377", "id378", "id379", "id380" ], "intro" : "Update the domains mentioned in the $filename. All textdomains defined\nin the file will get updated automatically, but not written before\nall files where processed.
\n", "name" : "process" }, "id222" : { "level" : 1, "name" : "NAME", "type" : "chapter", "intro" : "Dancer2::Plugin::LogReport::Message - extended Log::Report::Message class
\n", "id" : "id222", "path" : "NAME" }, "id1185" : { "intro" : "Terminate this dispatcher activities. The dispatcher gets disabled,\nto avoid the case it accidentally gets used. Returns undef (false)\nif the dispatcher was already closed.
Inherited, see Log::Report::Dispatcher::new()
", "type" : "alert", "subroutine" : "id1164", "name" : "cannot use class $backend:\\n$@: $!", "extends" : "id1175" }, "id670" : { "name" : "NAME", "level" : 1, "path" : "NAME", "intro" : "Log::Report::Lexicon::POT - manage PO files
\n", "id" : "id670", "type" : "chapter" }, "id1143" : { "id" : "id1143", "type" : "warning", "subroutine" : "id1133", "name" : "Missing key '$key' in format '$format', file $use" }, "id943" : { "name" : "METHODS", "level" : 1, "path" : "METHODS", "nest" : [ "id944", "id982", "id997" ], "id" : "id943", "type" : "chapter" }, "id1348" : { "path" : "INHERITANCE", "id" : "id1348", "intro" : "Log::Report::Dispatcher is extended by\n Log::Report::Dispatcher::Callback\n Log::Report::Dispatcher::File\n Log::Report::Dispatcher::Log4perl\n Log::Report::Dispatcher::LogDispatch\n Log::Report::Dispatcher::Perl\n Log::Report::Dispatcher::Syslog\n Log::Report::Dispatcher::Try\n\n", "type" : "chapter", "name" : "INHERITANCE", "level" : 1 }, "id1205-id1066" : { "name" : "max_line", "intro" : "
Inherited, see Log::Report::Dispatcher::stackTraceLine(max_line)
", "extends" : "id1205", "type" : "default", "id" : "id1205-id1066", "value" : "undef"
},
"id127" : {
"type" : "error",
"id" : "id127",
"name" : "unknown reason $which in '$reasons'.",
"subroutine" : "id123"
},
"id558" : {
"id" : "id558",
"intro" : "Returns the numeric language ID for the current codepage language.\nFor example, the numeric value for 0x0409 for en-US, and 0x0411\nfor ja. Returns false if the codepage cannot be identified.
Remove all references which are not found as key in the hash $table.\nReturns the number of references left.
\n", "type" : "i_method" }, "id1150" : { "type" : "error", "id" : "id1150", "subroutine" : "id1148", "name" : "you need to configure context_rules before setContext" }, "id993" : { "intro" : "Returns the $name of a dispatcher if explicitly specified with\nthe '_to' key. Can also be used to set it. Usually, this will\nreturn undef, because usually all dispatchers get all messages.
Inherited, see Log::Report::Dispatcher::stackTraceLine(max_params)
", "name" : "max_params" }, "id162-id1122" : { "name" : "name", "extends" : "id162", "call" : "$obj->name", "intro" : "Inherited, see Log::Report::Minimal::Domain::name()
", "type" : "i_method", "id" : "id162-id1122" }, "id1019" : { "path" : "DETAILS/Automatic parameters/Handling white-spaces", "intro" : "In above examples, the msgid and plural form have a trailing new-line.\nIn general, it is much easier to write
\n\n print __x\"Hello, World!\\n\";\n\n\n
than
\n\n print __x(\"Hello, World!\") . \"\\n\";\n\n\n
For the translation tables, however, that trailing new-line is \"ignorable\ninformation\"; it is an layout issue, not a translation issue.
\n\nTherefore, the first form will automatically be translated into the\nsecond. All leading and trailing white-space (blanks, new-lines, tabs,\n...) are removed from the msgid before the look-up, and then added to\nthe translated string.
\n\nLeading and trailing white-space on the plural form will also be\nremoved. However, after translation the spacing of the msgid will\nbe used.
\n", "id" : "id1019", "type" : "subsection", "name" : "Handling white-spaces", "level" : 3 }, "id1202-id1066" : { "name" : "params", "extends" : "id1202", "params" : "ARRAY", "type" : "option", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(params)
", "id" : "id1202-id1066" }, "id109" : { "path" : "DETAILS/Interpolation: Modifiers/Stacking modifiers", "id" : "id109", "intro" : "You can add more than one modifier. The modifiers detect the extend of\ntheir own information (via a regular expression), and therefore the\nformatter understands where one ends and the next begins.
\n\nThe modifiers are called in order:
\n\n printi \"price: {p€%9s}\\n\", p => $p; # price: ␣␣␣123.45\n printi \"!{t TIME%10s}!\", t => $now; # !␣␣12:59:17!\n\n printp \"price: %9{€}s\\n\", $p; # price: ␣␣␣123.45\n printp \"!%10{TIME}s!\", $now; # !␣␣12:59:17!\n\n",
"type" : "subsection",
"name" : "Stacking modifiers",
"level" : 3
},
"id428" : {
"name" : "new",
"examples" : [
"id433"
],
"call" : "$class->new( %options )",
"options" : [
[
"id431",
"id432"
],
[
"id429",
"id430"
]
],
"type" : "c_method",
"id" : "id428"
},
"id1172-id1217" : {
"id" : "id1172-id1217",
"type" : "default",
"value" : "'LOWERCASE'",
"extends" : "id1172",
"intro" : "Inherited, see Log::Report::Dispatcher::new(format_reason)
", "name" : "format_reason" }, "id1182" : { "type" : "i_method", "id" : "id1182", "call" : "$obj->isDisabled", "name" : "isDisabled" }, "id1203-id1091" : { "name" : "params", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(params)
", "extends" : "id1203", "id" : "id1203-id1091", "type" : "default", "value" : "<required>" }, "id958-id221" : { "name" : "_prepend", "extends" : "id958", "params" : "$text|$message", "intro" : "Inherited, see Log::Report::Message::new(_prepend)
", "type" : "option", "id" : "id958-id221" }, "id1238" : { "name" : "reason", "value" : "<required>", "id" : "id1238", "type" : "default" }, "id360" : { "name" : "new", "options" : [ [ "id522-id354", "id523-id354" ], [ "id361", "id362" ], [ "id520-id354", "id521-id354" ], [ "id363", "id364" ] ], "id" : "id360", "type" : "c_method", "diagnostics" : [ "id365" ], "call" : "$class->new( %options )" }, "id753-id561" : { "id" : "id753-id561", "type" : "i_method", "call" : "$obj->setupPluralAlgorithm", "diagnostics" : [ "id754-id561" ], "extends" : "id753", "intro" : "Inherited, see Log::Report::Lexicon::Table::setupPluralAlgorithm()
", "name" : "setupPluralAlgorithm" }, "id906" : { "level" : 1, "name" : "NAME", "intro" : "Log::Report::Dispatcher::Syslog - send messages to syslog
\n", "type" : "chapter", "id" : "id906", "path" : "NAME" }, "id1197-id1021" : { "name" : "filename", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(filename)
", "extends" : "id1197", "type" : "default", "id" : "id1197-id1021", "value" : "<required>" }, "id227" : { "name" : "new", "type" : "c_method", "id" : "id227", "options" : [ [ "id960-id221", "id961-id221" ], [ "id956-id221", "id957-id221" ], [ "id968-id221", "id969-id221" ], [ "id966-id221", "id967-id221" ], [ "id976-id221", "id977-id221" ], [ "id950-id221", "id951-id221" ], [ "id948-id221", "id949-id221" ], [ "id946-id221", "id947-id221" ], [ "id972-id221", "id973-id221" ], [ "id974-id221", "id975-id221" ], [ "id978-id221", "id979-id221" ], [ "id954-id221", "id955-id221" ], [ "id952-id221", "id953-id221" ], [ "id958-id221", "id959-id221" ], [ "id962-id221", "id963-id221" ], [ "id964-id221", "id965-id221" ], [ "id970-id221", "id971-id221" ], [ "id228", "id229" ] ], "call" : "$class->new( %options )" }, "id1130-id385" : { "extends" : "id1130", "name" : "nativeLanguage", "call" : "$obj->nativeLanguage", "intro" : "Inherited, see Log::Report::Domain::nativeLanguage()
", "id" : "id1130-id385", "type" : "i_method" }, "id660" : { "subroutine" : "id657", "name" : "quoted line is not a continuation at $where.", "id" : "id660", "type" : "warning" }, "id881" : { "name" : "translator must be a $pkg object for $domain", "subroutine" : "id867", "type" : "error", "id" : "id881" }, "id1192-id1066" : { "extends" : "id1192", "name" : "collectLocation", "call" : "$any->collectLocation", "intro" : "Inherited, see Log::Report::Dispatcher::collectLocation()
", "id" : "id1192-id1066", "type" : "ci_method" }, "id71" : { "intro" : " my $def = $sp->defaults('EL');\n say \"Default max width is \", $def->{width};\n\n",
"id" : "id71",
"type" : "example",
"name" : "getting defaults for a modifier\n"
},
"id49" : {
"type" : "chapter",
"intro" : " ### Functional interface\n\n use String::Print; # simpelest way\n use String::Print qw/printi printp/, %config;\n\n printi 'age {years}', years => 12; # to STDOUT\n my $s = sprinti 'age {years}', years => 12; # in variable\n\n # interpolation of arrays and hashes (serializers)\n printi 'price-list: {prices}', prices => \\@p, _join => \"+\";\n printi 'dump: {c}', c => \\%data;\n\n # same with positional parameters\n printp 'age %d\", 12;\n printp 'price-list: %.2f', \\@prices;\n printp 'dump: %s', \\%settings;\n my $s = sprintp 'age %d\", 12;\n\n # modifiers\n printi 'price: {price%.2f}', price => 3.14 * EURO;\n\n # [0.91] more complex interpolation names\n printi 'filename: {c.filename}', c => \\%data;\n printi 'username: {user.name}', user => $user_object;\n printi 'price: {product.price €}', product => $db->product(3);\n\n ### Object Oriented interface\n\n use String::Print 'oo', %config; # import no functions\n my $f = String::Print->new(%config);\n $f->printi('age {years}', years => 12);\n $f->printp('age %d', 12);\n my $s = $f->sprinti('age {y}', y => 12);\n my $s = $f->sprintp('age %d', 12);\n\n ### via Log::Report's __* functions (optional translation)\n\n use Log::Report; # or Log::Report::Optional\n print __x\"age {years}\", years => 12;\n\n ### via Log::Report::Template (Template Toolkit extension)\n\n [% SET name = 'John Doe' %]\n [% loc(\"Dear {name},\") %] # includes translation\n\n",
"id" : "id49",
"path" : "SYNOPSIS",
"level" : 1,
"name" : "SYNOPSIS"
},
"id122" : {
"subroutines" : [
"id130",
"id128",
"id129",
"id123"
],
"id" : "id122",
"type" : "section",
"path" : "FUNCTIONS/Reasons",
"level" : 2,
"name" : "Reasons"
},
"id1193-id1091" : {
"call" : "$any->stackTraceLine( %options )",
"id" : "id1193-id1091",
"intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine()
", "type" : "ci_method", "options" : [ [ "id1208-id1091", "id1209-id1091" ], [ "id1200-id1091", "id1201-id1091" ], [ "id1196-id1091", "id1197-id1091" ], [ "id1198-id1091", "id1199-id1091" ], [ "id1204-id1091", "id1205-id1091" ], [ "id1206-id1091", "id1207-id1091" ], [ "id1194-id1091", "id1195-id1091" ], [ "id1202-id1091", "id1203-id1091" ] ], "extends" : "id1193", "name" : "stackTraceLine" }, "id899" : { "path" : "DETAILS/Interpolation via formats", "intro" : "Interpolation via formats is optional.
\n\nIn shown examples, you see __x() everywhere. Using that function\nis required when you wish to use translations (later in your project),\nbut also has many other benefits. The functions __x and friends\ncreate a Log::Report::Message object.
Continue reading:
\n[1.09] By default, the try will only catch messages which stop the\nexecution of the block (errors etc, internally a 'die'). Other messages\nare passed to the parent dispatchers.
\n\nThis option gives the opportunity to stop, for instance, trace messages.\nThose messages are still collected inside the try object (unless excluded\nby new(accept)), so may get passed-on later via reportAll() if\nyou like.
\n\nBe warned: Using this method will reset the whole 'hide' configuration:\nit's a set not an add.
\n", "id" : "id1043", "type" : "i_method" }, "id579" : { "nest" : [ "id1316", "id1317" ], "type" : "section", "id" : "id579", "name" : "Managing PO's", "level" : 2, "path" : "METHODS/Managing PO's" }, "id1085" : { "path" : "METHODS/Constructors", "id" : "id1085", "type" : "section", "subroutines" : [ "id1086" ], "name" : "Constructors", "level" : 2 }, "id672" : { "level" : 1, "name" : "DESCRIPTION", "type" : "chapter", "intro" : "This module is reading, extending, and writing POT files. POT files\nare used to store translations in humanly readable format for most of\nexisting translation frameworks, like GNU gettext and Perl's Maketext.\nIf you only wish to access the translation, then you may use the much\nmore efficient Log::Report::Lexicon::POTcompact.
\n\nThe code is loosely based on Locale::PO, by Alan Schwartz. The coding\nstyle is a bit off the rest of Log::Report, and there was a need to\nsincere simplification. Each PO record will be represented by a\nLog::Report::Lexicon::PO.
Dancer2::Plugin::LogReport - logging, exceptions and translations in Dancer2 via Log::Report
\n", "type" : "chapter", "name" : "NAME", "level" : 1 }, "id1086-id542" : { "intro" : "Inherited, see Log::Report::Translator::new()
", "id" : "id1086-id542", "type" : "c_method", "call" : "$class->new( %options )", "name" : "new", "extends" : "id1086" }, "id771" : { "name" : "max_level", "intro" : "Like min_level.
\n", "type" : "option", "id" : "id771", "params" : "$level" }, "id367" : { "call" : "$obj->domain", "type" : "i_method", "id" : "id367", "name" : "domain" }, "id667" : { "id" : "id667", "type" : "warning", "name" : "no plurals expected for '$msgid'.", "subroutine" : "id663" }, "id220" : { "name" : "DESCRIPTION", "level" : 1, "path" : "DESCRIPTION", "intro" : "The Log::Report exception/translation framework defines a large\nnumber of logging back-ends. The same log messages can be sent to\nmultiple destinations at the same time via flexible dispatchers.\nWhen you use this logger in your Dancer application, it will nicely\nintegrate with non-Dancer modules which need logging.
\n\nMany log back-ends, like syslog, have more levels of system messages.\nModules who explicitly load this module can use the missing assert,\nnotice, panic, and alert log levels. The trace name is\nprovided as well: when you are debugging, you add a 'trace' to your\nprogram... its just a better name than 'debug'.
You probably want to set a very simple logger_format, because the\ndispatchers do already add some of the fields that the default\nsimple format adds. For instance, to get the filename/line-number\nin messages depends on the dispatcher 'mode' (f.i. 'DEBUG').
You also want to set the log level to debug, because level filtering\nis controlled per dispatcher (as well)
Inherited, see Log::Report::Lexicon::Table::pluralIndex()
", "name" : "pluralIndex", "diagnostics" : [ "id752-id669" ], "call" : "$obj->pluralIndex( $count )", "type" : "i_method", "id" : "id751-id669", "extends" : "id751" }, "id1187-id760" : { "id" : "id1187-id760", "intro" : "Inherited, see Log::Report::Dispatcher::translate()
", "type" : "i_method", "call" : "$obj->translate( \\%options, $reason, $message )", "extends" : "id1187", "name" : "translate" }, "id969-id221" : { "intro" : "Inherited, see Log::Report::Message::new(_class)
", "name" : "_class", "type" : "default", "id" : "id969-id221", "value" : "undef",
"extends" : "id969"
},
"id1326" : {
"path" : "INHERITANCE",
"type" : "chapter",
"intro" : "Dancer2::Plugin::LogReport::Message\n is a Log::Report::Message\n\n", "id" : "id1326", "name" : "INHERITANCE", "level" : 1 }, "id431" : { "name" : "charset", "id" : "id431", "intro" : "
Enforce character set for files. We default to reading the character-set\nas defined in the header of each PO file.
\n", "type" : "option", "params" : "STRING" }, "id219" : { "name" : "SYNOPSIS", "level" : 1, "path" : "SYNOPSIS", "intro" : "# When your main program is not a Dancer object\n use My::Dancer::App;\n use Log::Report;\n ... start dispatcher ...\n error \"something is wrong\"; # Log::Report::error()\n\n # When your main program is a Dancer object\n use Dancer;\n use Dancer::Logger::LogReport;\n use Log::Report import => 'dispatcher';\n ... start dispatcher ...\n error \"something is wrong\"; # Dancer::error()\n\n # In any case, your main program needs to start log dispatcers\n # Both Dancer and other Log::Report based modules will send\n # their messages here:\n dispatcher FILE => 'default', ...;\n\n # In your config\n logger: log_report\n logger_format: %i%m # keep it simple\n log: debug # filtered by dispatchers\n\n", "type" : "chapter", "id" : "id219" }, "id1148-id385" : { "call" : "$obj->setContext( STRING|HASH|ARRAY|PAIRS )", "diagnostics" : [ "id1150-id385" ], "id" : "id1148-id385", "type" : "i_method", "extends" : "id1148", "intro" : "
Inherited, see Log::Report::Domain::setContext()
", "name" : "setContext" }, "id494" : { "path" : "NAME", "id" : "id494", "intro" : "Log::Report::Extract::PerlPPI - Collect translatable strings from Perl using PPI
\n", "type" : "chapter", "name" : "NAME", "level" : 1 }, "id714" : { "name" : "Managing PO's", "level" : 2, "path" : "METHODS/Managing PO's", "subroutines" : [ "id723", "id724", "id726", "id725" ], "nest" : [ "id1302", "id1303" ], "id" : "id714", "type" : "section" }, "id1240" : { "name" : "message", "type" : "default", "value" : "<required>", "id" : "id1240" }, "id761" : { "name" : "NAME", "level" : 1, "path" : "NAME", "intro" : "Log::Report::Dispatcher::LogDispatch - send messages to Log::Dispatch back-end
\n", "id" : "id761", "type" : "chapter" }, "id377" : { "name" : "cannot read template from $file: $!", "subroutine" : "id370", "type" : "fault", "id" : "id377" }, "id662" : { "subroutine" : "id657", "name" : "no msgid in block $where.", "id" : "id662", "type" : "warning" }, "id569" : { "type" : "default", "value" : "undef",
"id" : "id569",
"name" : "charset"
},
"id388" : {
"level" : 1,
"name" : "DESCRIPTION",
"intro" : "Manage one translation domain for Log::Report::Template.
\n", "type" : "chapter", "id" : "id388", "path" : "DESCRIPTION" }, "id916" : { "id" : "id916", "value" : "'pid,nowait'", "type" : "default", "name" : "flags" }, "id975" : { "name" : "_lang", "type" : "default", "value" : "<from locale>", "id" : "id975" }, "id362" : { "type" : "default", "value" : "<required>", "id" : "id362", "name" : "domain" }, "id677" : { "name" : "charset", "value" : "'UTF-8'", "id" : "id677", "type" : "default" }, "id1198-id780" : { "params" : "INTEGER", "type" : "option", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(linenr)
", "id" : "id1198-id780", "name" : "linenr", "extends" : "id1198" }, "id444" : { "path" : "DESCRIPTION", "intro" : "This module handles the lookup of translation files for a whole\ndirectory tree. It is lazy loading, which means that it will only\nbuild the search tree when addressed, not when the object is\ncreated.
\n", "id" : "id444", "type" : "chapter", "name" : "DESCRIPTION", "level" : 1 }, "id688" : { "name" : "index", "intro" : "A set of translations (Log::Report::Lexicon::PO objects),\nwith msgid as key.
\n", "type" : "option", "id" : "id688", "params" : "HASH" }, "id540-id354" : { "intro" : "Inherited, see Log::Report::Extract::store()
", "name" : "store", "diagnostics" : [ "id541-id354" ], "call" : "$obj->store( $domain, $filename, $linenr, $context, $msg, [$msg_plural] )", "type" : "i_method", "id" : "id540-id354", "extends" : "id540" }, "id856" : { "intro" : "# add three msgids to the translation table\n my @colors = (N__\"red\", N__\"green\", N__\"blue\");\n my @colors = N__w \"red green blue\"; # same\n print __ $colors[1]; # translate green\n\n # using __(), would work as well\n my @colors = (__\"red\", __\"green\", __\"blue\");\n print $colors[1];\n # however: this will always create all Log::Report::Message objects,\n # where maybe only one is used.\n\n", "id" : "id856", "type" : "example", "name" : "how to use
N__()\n"
},
"id1253" : {
"type" : "example",
"intro" : " try { report {to => 'default'}, ERROR => 'oops!' };\n $@->reportFatal(to => 'syslog');\n\n my ($syslog) = $exception->throw(to => 'syslog');\n my @disps = $@->wasFatal->throw(reason => 'WARNING');\n\n",
"id" : "id1253",
"name" : "overrule defaults to report\n"
},
"id153" : {
"level" : 1,
"name" : "DESCRIPTION",
"id" : "id153",
"intro" : "Read Log::Report::Domain.
\n", "type" : "chapter", "path" : "DESCRIPTION" }, "id1166-id1217" : { "extends" : "id1166", "value" : "depend on mode",
"id" : "id1166-id1217",
"type" : "default",
"name" : "accept",
"intro" : "Inherited, see Log::Report::Dispatcher::new(accept)
" }, "id70" : { "name" : "defaults", "examples" : [ "id71" ], "intro" : "[1.00] Returns the current defaults for the $modifier.
\n", "type" : "i_method", "id" : "id70", "call" : "$obj->defaults( $modifier )" }, "id120" : { "name" : "DESCRIPTION", "level" : 1, "path" : "DESCRIPTION", "intro" : "This module collects a few functions and definitions which are shared\nbetween different components in the Log::Report infrastructure.\nThey should not be needed for end-user applications, although this\nman-page may contain some useful background information.
\n", "id" : "id120", "type" : "chapter" }, "id1119" : { "intro" : "Log::Report::DBIC::Profiler - query profiler for DBIx::Class
\n", "type" : "chapter", "id" : "id1119", "path" : "NAME", "level" : 1, "name" : "NAME" }, "id979-id221" : { "intro" : "Inherited, see Log::Report::Message::new(_msgctxt)
", "name" : "_msgctxt", "type" : "default", "id" : "id979-id221", "value" : "undef",
"extends" : "id979"
},
"id1330" : {
"level" : 1,
"name" : "INHERITANCE",
"type" : "chapter",
"intro" : "Log::Report::Template::Textdomain\n is a Log::Report::Domain\n is a Log::Report::Minimal::Domain\n\n", "id" : "id1330", "path" : "INHERITANCE" }, "id1208-id780" : { "extends" : "id1208", "name" : "abstract", "intro" : "
Inherited, see Log::Report::Dispatcher::stackTraceLine(abstract)
", "type" : "option", "id" : "id1208-id780", "params" : "INTEGER" }, "id1050" : { "name" : "Status", "level" : 2, "path" : "METHODS/Status", "subroutines" : [ "id1052", "id1058", "id1051", "id1053" ], "id" : "id1050", "type" : "section" }, "id529-id493" : { "call" : "$obj->domains", "intro" : "Inherited, see Log::Report::Extract::domains()
", "type" : "i_method", "id" : "id529-id493", "extends" : "id529", "name" : "domains" }, "id1082" : { "level" : 1, "name" : "SYNOPSIS", "id" : "id1082", "intro" : "# internal infrastructure\n my $msg = Log::Report::Message->new(_msgid => \"Hello World\\n\");\n print Log::Report::Translator->new(...)->translate($msg);\n\n # normal use\n textdomain 'my-domain',\n translator => Log::Report::Translator->new; # default\n print __\"Hello World\\n\";\n\n", "type" : "chapter", "path" : "SYNOPSIS" }, "id938" : { "name" : "DESCRIPTION", "level" : 1, "path" : "DESCRIPTION", "intro" : "
Any use of a constructor function exported by Log::Report, like\n__() (the function is named underscore-underscore) or __x()\n(underscore-underscore-x) will result in this Message object. It will capture\nsome environmental information as well.
The optional translation is delayed until it is really needed.\nCreating an object first and translating it later, might be slower than\ntranslating it immediately. However (by design decissions of Log::Report)\non the location where the message is produced, we do not yet know in\nwhat language to translate it to: that depends on the actual log dispatcher\nconfigurations in the main program.
\n", "type" : "chapter", "id" : "id938" }, "id119" : { "path" : "SYNOPSIS", "id" : "id119", "intro" : "my ($language, $territory, $charset, $modifier)\n = parse_locale 'nl_BE.utf-8@home';\n\n my @take = expand_reasons 'INFO-ERROR,PANIC';\n\n", "type" : "chapter", "name" : "SYNOPSIS", "level" : 1 }, "id549" : { "inheritance" : { "extends" : [ "Exporter" ] }, "id" : "id549", "title" : "unix/windows locales", "is_pure_pod" : false, "package" : "Log::Report::Win32Locale", "distribution" : "Log-Report-Lexicon", "version" : "1.16", "chapters" : [ "id550", "id1329", "id551", "id552", "id553" ], "name" : "Log::Report::Win32Locale" }, "id642" : { "name" : "comment", "call" : "$obj->comment( [@lines|\\@lines|$text] )", "type" : "i_method", "intro" : "
Returns a STRING which contains the cleaned paragraph of translator's\ncomment. If an argument is specified, it will replace the current\ncomment.
\n", "id" : "id642" }, "id741" : { "call" : "$class->new( %options )", "type" : "c_method", "id" : "id741", "name" : "new" }, "id1199-id1217" : { "name" : "linenr", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(linenr)
", "extends" : "id1199", "type" : "default", "id" : "id1199-id1217", "value" : "<required>" }, "id1193-id780" : { "call" : "$any->stackTraceLine( %options )", "options" : [ [ "id1208-id780", "id1209-id780" ], [ "id1200-id780", "id1201-id780" ], [ "id1196-id780", "id1197-id780" ], [ "id1198-id780", "id1199-id780" ], [ "id1204-id780", "id1205-id780" ], [ "id1206-id780", "id1207-id780" ], [ "id1194-id780", "id1195-id780" ], [ "id1202-id780", "id1203-id780" ] ], "id" : "id1193-id780", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine()
", "type" : "ci_method", "name" : "stackTraceLine", "extends" : "id1193" }, "id530-id493" : { "call" : "$obj->pots( $domain )", "intro" : "Inherited, see Log::Report::Extract::pots()
", "id" : "id530-id493", "type" : "i_method", "name" : "pots", "extends" : "id530" }, "id464" : { "type" : "chapter", "intro" : "This module is translating, based on MO files (binary versions of\nthe PO files, the \"Machine Object\" format)
\n\nActually, this module is not \"compact\" anymore: not trading off\nspeed for memory. That may change again in the future.
\n\nTo get a MO file, you first need a PO file. Then run msgfmt, which\nis part of the gnu gettext package.
\n\n msgfmt -cv -o $domain.mo $domain.po\n\n # -c = --check-format & --check-header & --check-domain\n # -v = --verbose\n # -o = --output-file\n\n", "id" : "id464", "path" : "DESCRIPTION", "level" : 1, "name" : "DESCRIPTION" }, "id1215" : { "name" : "a filter on syslog\n", "intro" : "
dispatcher filter => \\&myfilter, 'syslog';\n\n # ignore all translatable and non-translatable messages containing\n # the word \"skip\"\n sub myfilter($$$$)\n { my ($disp, $opts, $reason, $message) = @_;\n return () if $message->untranslated =~ m/\\bskip\\b/;\n ($reason, $message);\n }\n\n",
"id" : "id1215",
"type" : "example"
},
"id342" : {
"path" : "DETAILS/Textdomains",
"intro" : "This module uses standard gettext PO-translation tables via the\nLog::Report::Lexicon distribution. An important role here is\nfor the 'textdomain': the name of the set of translation tables.
\n\nFor code, you say \"use Log::Report '<textdomain>;\" in each related\nmodule (pm file). We cannot do achieve comparible syntax with\nTemplate Toolkit: you must specify the textdomain before the\ntemplates get processed.
\n\nYour website may contain multiple separate sets of templates. For\ninstance, a standard website implementation with some local extensions.\nThe only way to get that to work, is by using different translation\nfunctions: one textdomain may use 'loc()', where an other uses 'trans()'.
\n", "name" : "Textdomains", "level" : 2, "id" : "id342", "type" : "section", "nest" : [ "id343", "id344" ] }, "id755-id561" : { "extends" : "id755", "name" : "nrPlurals", "call" : "$obj->nrPlurals", "id" : "id755-id561", "intro" : "Inherited, see Log::Report::Lexicon::Table::nrPlurals()
", "type" : "i_method" }, "id1258" : { "id" : "id1258", "intro" : "print $exception; # via overloading\n $exception->print; # OO style\n\n", "type" : "example" }, "id999-id221" : { "intro" : "
Inherited, see Log::Report::Message::inClass()
", "type" : "i_method", "id" : "id999-id221", "call" : "$obj->inClass( $tag|Regexp )", "name" : "inClass", "extends" : "id999" }, "id936" : { "intro" : "Log::Report::Message - a piece of text to be translated
\n", "type" : "chapter", "id" : "id936", "path" : "NAME", "level" : 1, "name" : "NAME" }, "id1150-id385" : { "name" : "you need to configure context_rules before setContext", "extends" : "id1150", "subroutine" : "id1148", "intro" : "Inherited, see Log::Report::Domain::setContext()
", "id" : "id1150-id385", "type" : "error" }, "id1062" : { "path" : "DESCRIPTION", "intro" : "[Included since Log::Report v1.00]\nMojo likes to log messages directly into a file, by default. Log::Report\nconstructs a Log::Report::Exception object first.
\n\nBe aware that this extension does catch the messages to be logged,\nbut that the dispatching of the error follows a different route now.\nFor instance, you cannot use $ENV{MOJO_LOG_LEVEL} to control the output\nlevel, but you need to use Log::Report::dispatcher() action mode.
Mojo defines five \"levels\" of messages, which map onto Log::Report's\nreasons this way:
\n\n debug TRACE\n info INFO\n warn WARNING\n error ERROR\n fatal ALERT\n\n", "id" : "id1062", "type" : "chapter", "name" : "DESCRIPTION", "level" : 1 }, "id184" : { "id" : "id184", "value" : "<depends on reason>", "type" : "default", "name" : "is_fatal" }, "id139" : { "intro" : "
[1.02] Escape HTML volatile characters.
\n", "type" : "function", "id" : "id139", "call" : "to_html( $string )", "name" : "to_html" }, "id918" : { "name" : "facility", "type" : "default", "value" : "'user'", "id" : "id918" }, "id386" : { "path" : "NAME", "intro" : "Log::Report::Template::Textdomain - template translation with one domain
\n", "id" : "id386", "type" : "chapter", "name" : "NAME", "level" : 1 }, "id1209-id1217" : { "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(abstract)
", "name" : "abstract", "id" : "id1209-id1217", "type" : "default", "value" : "1", "extends" : "id1209" }, "id686" : { "name" : "plural_forms", "type" : "option", "intro" : "[0.992] When this option is used, it overrules nr_plurals and\nplural_alg. The RULE should be a full \"Plural-Forms\" field.
\n", "id" : "id686", "params" : "RULE" }, "id1203-id780" : { "id" : "id1203-id780", "type" : "default", "value" : "<required>", "extends" : "id1203", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(params)
", "name" : "params" }, "id1176" : { "id" : "id1176", "type" : "error", "subroutine" : "id1164", "name" : "illegal format_reason '$format' for dispatcher" }, "id397" : { "value" : "undef",
"type" : "default",
"id" : "id397",
"name" : "lexicon"
},
"id1186-id1217" : {
"name" : "log",
"extends" : "id1186",
"call" : "$obj->log( \\%options, $reason, $message, $domain )",
"id" : "id1186-id1217",
"intro" : "Inherited, see Log::Report::Dispatcher::log()
", "type" : "i_method" }, "id1180-id1021" : { "intro" : "Inherited, see Log::Report::Dispatcher::type()
", "id" : "id1180-id1021", "type" : "i_method", "call" : "$obj->type", "name" : "type", "extends" : "id1180" }, "id995" : { "name" : "valueOf", "examples" : [ "id996" ], "call" : "$obj->valueOf( $parameter )", "id" : "id995", "intro" : "Lookup the named $parameter for the message. All pre-defined names\nhave their own method which should be used with preference.
\n", "type" : "i_method" }, "id723" : { "intro" : "Replace the \"PO-Revision-Date\" with the specified $date, or the current\nmoment.
\n", "id" : "id723", "type" : "i_method", "call" : "$obj->updated( [$date] )", "name" : "updated" }, "id858" : { "intro" : "my @save = N__n \"save file\", \"save files\";\n my @save = (N__n \"save file\", \"save files\");\n my @save = N__n(\"save file\", \"save files\");\n\n # be warned about SCALARs in prototype!\n print __n @save, $nr_files; # wrong!\n print __n $save[0], $save[1], @files, %vars;\n\n", "type" : "example", "id" : "id858", "name" : "how to use N__n()\n" }, "id1130" : { "name" : "nativeLanguage", "call" : "$obj->nativeLanguage", "type" : "i_method", "id" : "id1130" }, "id697" : { "value" : "<required>", "type" : "default", "id" : "id697", "name" : "charset" }, "id1319" : { "name" : "Attributes", "level" : 2, "path" : "METHODS/Attributes", "id" : "id1319", "type" : "section" }, "id750" : { "subroutine" : "id749", "name" : "only acceptable parameter is 'ACTIVE'", "id" : "id750", "type" : "error" }, "id1179-id1066" : { "extends" : "id1179", "name" : "name", "call" : "$obj->name", "intro" : "
Inherited, see Log::Report::Dispatcher::name()
", "type" : "i_method", "id" : "id1179-id1066" }, "id347" : { "level" : 3, "name" : "Translation syntax, more magic", "type" : "subsection", "intro" : "With TT, we can add a simplificition which we cannot offer for Perl\ntranslations: TT variables are dynamic and stored in the stash which\nwe can access. Therefore, we can lookup \"accidentally\" missed parameters.
\n\n [% SET name = 'John Doe' %]\n [% loc(\"Hi {name}\", name => name) %] # looks silly\n [% loc(\"Hi {name}\") %] # uses TT stash directly\n\n\nSometimes, computation of objects is expensive: you never know. So, you\nmay try to avoid repeated computation. In the follow example, \"soldOn\"\nis collected/computed twice:
\n\n [% IF product.soldOn %]\n <tdE<gt>[% loc(\"Sold on {product.soldOn DATE}\")</tdE<gt>\n [% END %]\n\n\nThe performance is predictable optimal with:
\n\n [% sold_on = product.soldOn; IF sold_on %]\n <tdE<gt>[% loc(\"Sold on {sold_on DATE}\")</tdE<gt>\n [% END %]\n\n",
"id" : "id347",
"path" : "DETAILS/Supported syntax/Translation syntax, more magic"
},
"id1048" : {
"name" : "reportAll",
"call" : "$obj->reportAll( %options )",
"type" : "i_method",
"intro" : "Re-cast the messages in all collect exceptions into the defined\ndispatchers, which were disabled during the try block. The %options\nwill end-up as HASH of %options to Log::Report::report(); see\nLog::Report::Exception::throw() which does the job.
\n", "id" : "id1048" }, "id1167-id760" : { "intro" : "Inherited, see Log::Report::Dispatcher::new(locale)
", "type" : "option", "id" : "id1167-id760", "params" : "LOCALE", "extends" : "id1167", "name" : "locale" }, "id945" : { "call" : "$class->new( %options )", "options" : [ [ "id960", "id961" ], [ "id956", "id957" ], [ "id968", "id969" ], [ "id966", "id967" ], [ "id976", "id977" ], [ "id950", "id951" ], [ "id948", "id949" ], [ "id946", "id947" ], [ "id972", "id973" ], [ "id974", "id975" ], [ "id978", "id979" ], [ "id954", "id955" ], [ "id952", "id953" ], [ "id958", "id959" ], [ "id962", "id963" ], [ "id964", "id965" ], [ "id970", "id971" ] ], "id" : "id945", "intro" : "End-users: do not use this method directly, but use\nLog::Report::__(), Log::Report::__x() and friends. The %options\nis a mixed list of object initiation parameters (all with a leading\nunderscore) and variables to be filled in into the translated _msgid\nstring.
\n", "type" : "c_method", "name" : "new" }, "id1201" : { "id" : "id1201", "value" : "<required>", "type" : "default", "name" : "call" }, "id647" : { "name" : "addReferences", "type" : "i_method", "intro" : "A single scalar contains a blank separated list of @locations. The LIST\nand ARRAY contain separate @locations. A LOCATION is of the form\nfilename:linenumber. Returns the internal HASH with references.
Inherited, see Log::Report::Dispatcher::mode()
", "id" : "id1181-id1066", "extends" : "id1181", "name" : "mode" }, "id756-id461" : { "extends" : "id756", "name" : "header", "call" : "$obj->header( $field )", "id" : "id756-id461", "intro" : "Inherited, see Log::Report::Lexicon::Table::header()
", "type" : "i_method" }, "id1194" : { "params" : "CLASS", "id" : "id1194", "type" : "option", "name" : "package" }, "id1170-id780" : { "name" : "mode", "intro" : "Inherited, see Log::Report::Dispatcher::new(mode)
", "extends" : "id1170", "value" : "'NORMAL'", "type" : "default", "id" : "id1170-id780" }, "id581" : { "diagnostics" : [ "id582" ], "call" : "$obj->msgstr( $msgid, [$count, [$msgctxt] )", "type" : "i_method", "id" : "id581", "name" : "msgstr", "intro" : "Returns the translated string for $msgid. When not specified, $count is 1\n(the single form).
\n" }, "id789" : { "name" : "new", "intro" : "The Log::Log4perl infrastructure has all settings in a configuration\nfile. In that file, you should find a category with the $name.
\n", "options" : [ [ "id1165-id780", "id794" ], [ "id1173-id780", "id1174-id780" ], [ "id792", "id793" ], [ "id1171-id780", "id1172-id780" ], [ "id1167-id780", "id1168-id780" ], [ "id1169-id780", "id1170-id780" ], [ "id790", "id791" ] ], "type" : "c_method", "id" : "id789", "diagnostics" : [ "id795" ], "call" : "$class->new( $type, $name, %options )" }, "id949-id221" : { "extends" : "id949", "value" : "<from \"use Log::Report\">", "type" : "default", "id" : "id949-id221", "name" : "_domain", "intro" : "Inherited, see Log::Report::Message::new(_domain)
" }, "id734" : { "type" : "section", "id" : "id734", "path" : "METHODS/Attributes", "level" : 2, "name" : "Attributes" }, "id1065" : { "name" : "new", "id" : "id1065", "intro" : "Inherited %options path and level are ignored.
[1.13] Returns the number of nestings in the stack which should be skipped\nto get outside the Log::Report (and related) modules. The end-user\ndoes not want to see those internals in stack-traces.
\n", "id" : "id1191", "type" : "i_method", "name" : "skipStack" }, "id599" : { "name" : "needDecode", "intro" : "Converts the context settings passed with the MSGID, into a HASH which will\nbe matched to the context providers.
\n", "call" : "$any->needDecode( $source, STRING|ARRAY|HASH|PAIRS )", "diagnostics" : [ "id600" ], "type" : "ci_method", "id" : "id599" }, "id239" : { "name" : "SYNOPSIS", "level" : 1, "path" : "SYNOPSIS", "id" : "id239", "intro" : "To use this engine, you may configure manual Dancer2 via config.yaml:
\n template: \"TTLogReport\"\n\n\n
Or you may also change the rendering engine on a per-route basis by\nsetting it manually with set:
\n set template => 'TTLogReport';\n\n\n
Application:
\n\n # In your daemon startup\n my $pot = Log::Report::Translator::POT->new(lexicon => $poddir);\n my $domain = (engine 'template')->addTextdomain(name => $mydomain);\n $domain->configure(translator => $pot);\n\n # Use it:\n get '/' => sub {\n template index => {\n title => 'my webpage',\n\n # The actual language is stored in the user session.\n translate_to => 'nl_NL.utf-8',\n };\n };\n\n",
"type" : "chapter"
},
"id284" : {
"path" : "DETAILS/In Use/Exceptions",
"type" : "subsection",
"intro" : "Log::Report is a combination of a logger and an exception system. Messages\nto be logged are thrown to all listening dispatchers to be handled.
\n\nThis module will also catch any unexpected exceptions:
\n\n # This will be caught, the error will be logged (full stacktrace to STDOUT,\n # short message to the session messages), and the user will be forwarded\n # (default to /). This would also be sent to syslog with the appropriate\n # dispatcher.\n get 'route' => sub {\n my $foo = 1;\n my $bar = $foo->{x}; # whoops\n }\n\n\nFor a production application (show_errors: 1), the message saved in the\nsession will be the generic text \"An unexpected error has occurred\". This\ncan be customised in the configuration file, and will be translated.
Inherited, see Log::Report::Domain::configure()
", "type" : "warning" }, "id791" : { "value" : "[]", "id" : "id791", "type" : "default", "name" : "to_level" }, "id692" : { "name" : "filename", "type" : "option", "intro" : "Specify an output filename. The name can also be specified when\nwrite() is called.
\n", "id" : "id692", "params" : "STRING" }, "id1212" : { "path" : "DETAILS/Processing the message", "name" : "Processing the message", "level" : 2, "type" : "section", "id" : "id1212", "nest" : [ "id1213", "id1214" ] }, "id411" : { "name" : "translateTo", "intro" : "Set the language to translate to for $lang, for this domain only. This may\nbe useful when various text domains do not support the same destination languages.\nBut in general, you can best use Log::Report::Template::translateTo().
\n", "id" : "id411", "type" : "i_method", "call" : "$obj->translateTo( $lang )" }, "id1006" : { "options" : [ [ "id1007", "id1008" ] ], "intro" : "Convert the data of this message into a (nested) HASH which optimally\npreserves its content. Pass this to thaw() to get the object back.
\n\nThe returned HASH can be serialized safely with (for instance) YAML\nor JSON. Then, it can be reconstructed from the de-serialized data.\nAt the moment, all facts can be preserved.
\n", "type" : "i_method", "id" : "id1006", "call" : "$obj->freeze( %options )", "name" : "freeze", "examples" : [ "id1009" ] }, "id1204" : { "params" : "INTEGER", "type" : "option", "id" : "id1204", "name" : "max_line" }, "id1126" : { "nest" : [ "id1127", "id1129", "id1147" ], "id" : "id1126", "type" : "chapter", "name" : "METHODS", "level" : 1, "path" : "METHODS" }, "id392" : { "intro" : "The textdomain can only be used in the indicated directories: if found\nanywhere else, it's an error. When not specified, the function is\nallowed everywhere.
\n", "id" : "id392", "type" : "option", "params" : "DIRECTORY|ARRAY", "name" : "only_in_directory" }, "id1200-id1091" : { "extends" : "id1200", "name" : "call", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(call)
", "id" : "id1200-id1091", "type" : "option", "params" : "STRING" }, "id1187-id780" : { "extends" : "id1187", "name" : "translate", "intro" : "Inherited, see Log::Report::Dispatcher::translate()
", "type" : "i_method", "id" : "id1187-id780", "call" : "$obj->translate( \\%options, $reason, $message )" }, "id169-id1122" : { "type" : "default", "id" : "id169-id1122", "value" : "PRINTI",
"extends" : "id169",
"intro" : "Inherited, see Log::Report::Minimal::Domain::configure(formatter)
", "name" : "formatter" }, "id207" : { "type" : "function", "id" : "id207", "call" : "__xn( $single_msgid, $plural_msgid, $count, PAIRS )", "name" : "__xn" }, "id473" : { "name" : "unsupported file type (magic number is $magic)", "subroutine" : "id467", "type" : "error", "id" : "id473" }, "id926" : { "name" : "charset", "id" : "id926", "value" : "'utf8'", "type" : "default" }, "id970-id221" : { "intro" : "Inherited, see Log::Report::Message::new(_to)
", "id" : "id970-id221", "type" : "option", "params" : "$dispatcher", "extends" : "id970", "name" : "_to" }, "id1205-id1217" : { "name" : "max_line", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(max_line)
", "extends" : "id1205", "value" : "undef",
"id" : "id1205-id1217",
"type" : "default"
},
"id1358" : {
"path" : "INHERITANCE",
"id" : "id1358",
"intro" : "Log::Report::Dispatcher::LogDispatch\n is a Log::Report::Dispatcher\n\n", "type" : "chapter", "name" : "INHERITANCE", "level" : 1 }, "id847" : { "name" : "__x", "intro" : "
Translate the $msgid and then interpolate the VARIABLES in that string.\nOf course, translation and interpolation is delayed as long as possible.\nBoth OPTIONS and VARIABLES are key-value pairs.
\n\nThe PAIRS are options for Log::Report::Message::new() and variables\nto be filled in.
\n", "examples" : [ "id848" ], "id" : "id847", "type" : "function", "diagnostics" : [ "id849" ], "call" : "__x( $msgid, PAIRS )" }, "id1038" : { "id" : "id1038", "value" : "'ERROR'", "type" : "default", "name" : "on_die" }, "id520-id493" : { "extends" : "id520", "name" : "lexicon", "intro" : "Inherited, see Log::Report::Extract::new(lexicon)
", "type" : "option", "id" : "id520-id493", "params" : "$directory" }, "id1315" : { "level" : 3, "name" : "Filters", "id" : "id1315", "type" : "subsection", "path" : "DETAILS/Processing the message/Filters" }, "id1153" : { "name" : "translate", "type" : "i_method", "intro" : "Translate the $message into the $language.
\n", "id" : "id1153", "call" : "$obj->translate( $message, $language )" }, "id102" : { "path" : "DETAILS/Interpolation: Modifiers/Modifiers: YEAR, DATE(), TIME, and DT()", "intro" : "[0.91] A set of modifiers help displaying dates and times. They are a\nlittle flexible in values they accept, but do not expect miracles: when\nit get harder, you will need to process it yourself.
\n\nThe actual treatment of a time value depends on the value. Four\ndifferent situations:
\n\n\n my $now = DateTime->now;\n printi \"{t YEAR}\", t => $now; # works for DateTime, epoch and string\n printi \"{t.year YEAR}\", t => $now; # same effect, DateTime only\n printi \"{t.year}\", t => $now; # will also work, not as nice\n\n\n\n\nBy far not all possible date formats are supported, just a few common\nversions, like
\n\n 2017-06-27 10:04:15 +02:00\n 2017-06-27 17:34:28.571491+02 # psql timestamp with zone\n 20170627100415+2\n 2017-06-27T10:04:15Z # iso 8601\n 20170627 # only for YEAR and DATE\n 2017-6-1 # only for YEAR and DATE\n 12:34 # only for TIME\n\n\n
The meaning of 05-04-2017 is ambiguous, so not supported. Milliseconds\nget ignored.
When the provided value has a timezone indication, it will get\nconverted into the local timezone of the observer.
\n\nThe output of YEAR is in format 'YYYY', where TIME produces 'HH:mm:ss'.\nDT and DATE are configurable.
The DT modifier can produce different formats:
\n\n DT(ASC) : %a %b %e %T %Y asctime output (not on Windows)\n DT(FT) : %F %T YYYY-MM-DD HH:MM:SS (default)\n DT(ISO) : %FT%T%z iso8601\n DT(RFC822) : %a, %d %b %y %T %z email old\n DT(RFC2822) : %a, %d %b %Y %T %z email newer\n DT(RFC5322) : %a, %d %b %Y %T %z email newest [0.96]\n DT(%F-%T) [1.02] any own format\n\n\n
You may suggest additional formats, or add your own modifier. For your own\nformat: be warned that %F and %T are not supported on some Windows\nversions (but the difference is hidden by Perl >5.38).
[1.02] Also, the DATE modifier can produce different formats:
\n\n DATE(-) : %Y-%m-%d\n DATE(/) : %Y/%m/%d\n DATE(%d-%m-%Y) any own pattern\n DATE(%m-%d-%Y) better not use this broken order\n\n\n
Other fields than %Y, %m, and %d are not supported. Other characters\nare left untouched.
The defaults are:
\n\n DATE => { format => '-' },\n DT => { format => 'FT' },\n\n",
"type" : "subsection",
"id" : "id102",
"name" : "Modifiers: YEAR, DATE(), TIME, and DT()",
"level" : 3
},
"id110" : {
"path" : "DETAILS/Output encoding",
"intro" : "[0.91] This module is also used by Log::Report::Template, which is used\nto insert (translated) strings with parameters into HTML templates.\nYou can imagine that some of the parameter may need to be encoded to\nHTML in the template, and other not.
\n", "name" : "Output encoding", "level" : 2, "id" : "id110", "type" : "section", "nest" : [ "id111", "id112" ] }, "id1219" : { "path" : "SYNOPSIS", "intro" : "dispatcher Log::Report::Dispatcher::Perl => 'default',\n accept => 'NOTICE-';\n\n # close the default dispatcher\n dispatcher close => 'default';\n\n", "type" : "chapter", "id" : "id1219", "name" : "SYNOPSIS", "level" : 1 }, "id560" : { "name" : "ms_locale", "id" : "id560", "intro" : "
Returns the locale setting from the control panel.
\n", "type" : "function", "call" : "ms_locale" }, "id1195-id1217" : { "name" : "package", "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(package)
", "extends" : "id1195", "value" : "<required>", "id" : "id1195-id1217", "type" : "default" }, "id733" : { "id" : "id733", "type" : "c_method", "call" : "$class->new( %options )", "name" : "new" }, "id705" : { "type" : "default", "value" : "false",
"id" : "id705",
"name" : "only_active"
},
"id519-id493" : {
"type" : "c_method",
"id" : "id519-id493",
"options" : [
[
"id522-id493",
"id523-id493"
],
[
"id520-id493",
"id521-id493"
]
],
"call" : "$class->new( %options )",
"diagnostics" : [
"id524-id493",
"id525-id493"
],
"extends" : "id519",
"intro" : "Inherited, see Log::Report::Extract::new()
", "name" : "new" }, "id97" : { "name" : "Modifier: POSIX format starts with '%'", "level" : 3, "path" : "DETAILS/Interpolation: Modifiers/Modifier: POSIX format starts with '%'", "intro" : "As shown in the examples above, you can specify a format. This can,\nfor instance, help you with rounding or columns:
\n\n printp \"π = {pi%.3f}\", pi => 3.1415;\n printp \"weight is {kilogram%d}\", kilogram => 127*OUNCE_PER_KILO;\n printp \"{filename%-20.20s}\\n\", filename => $fn;\n\n",
"nest" : [
"id98",
"id99"
],
"id" : "id97",
"type" : "subsection"
},
"id892" : {
"type" : "subsection",
"id" : "id892",
"nest" : [
"id893"
],
"intro" : "Traditionally, perl has a very simple view on error reports: you\neither have a warning or an error. However, it would be much clearer\nfor user's and module-using applications, when a distinction is made\nbetween various causes. For instance, a configuration error is quite\ndifferent from a disk-full situation. In Log::Report, the produced\nreports in the code tell what is wrong. The main application defines\nloggers, which interpret the cause into (syslog) levels.
Defined by Log::Report are
panic.\n\n\n\nverbose flag is given on the command-line.\n\n\n\nDesktop directory in your\nhome directory. Notices should be sparse.\n\n\n\nIt is much nicer to tell someone that he/she made a mistake, than\nto call that an error.
\n\n\n\n$!. The program will be stopped, usually before taken off.\n\n\n\n$! ($ERRNO) variable is set here.\n\n\n\n$! is set. Usually, a system administrator\nneeds to be informed about the problem.\n\n\n\n$! is set, and usually the system administrator wants to be\ninformed. The program will die.\n\nThe difference with fault is subtile and not always clear. A fault\nreports an error returned by an operating system call, where the failure\nwould report an operational problem, like a failing mount.
For instance, in an OO perl module, the base class requires all\nsub-classes to implement a certain method. The base class will produce\na stub method with triggers a panic when called. The non-dieing version\nof this test assert.
Debugging or being verbose are run-time behaviors, and have nothing\ndirectly to do with the type of message which is produced. These two\nare modes which can be set on the dispatchers: one dispatcher may\nbe more verbose that some other.
On purpose, we do not use the terms die or fatal, because the\ndispatcher can be configured what to do in cause of which condition.\nFor instance, it may decide to stop execution on warnings as well.
The terms carp and croak are avoided, because the program cause\nversus user cause distinction (warn vs carp) is reflected in the use\nof different reasons. There is no need for confess and croak\neither, because the dispatcher can be configured to produce stack-trace\ninformation (for a limited sub-set of dispatchers)
Inherited, see Log::Report::Translator::load()
", "type" : "i_method", "extends" : "id1090", "name" : "load" }, "id408" : { "name" : "expectedIn", "intro" : "Return true when the function name which relates to this domain is\nallowed to be used for the indicated file. The msgid extractor will warn\nwhen there is no match.
Inherited, see Log::Report::Domain::configure()
", "extends" : "id1133", "options" : [ [ "id1140-id385", "id1141-id385" ], [ "id1138-id385", "id1139-id385" ], [ "id168-id385", "id169-id385" ], [ "id1136-id385", "id1137-id385" ], [ "id1134-id385", "id1135-id385" ], [ "id166-id385", "id167-id385" ] ], "id" : "id1133-id385", "type" : "i_method", "call" : "$obj->configure( %options )", "diagnostics" : [ "id1142-id385", "id1143-id385" ] }, "id129" : { "name" : "is_fatal", "id" : "id129", "intro" : "Returns true if the $reason is severe enough to cause an exception\n(or program termination).
In its simplest form, you can now use all the\nLog::Report logging functions\nto send messages to your dispatchers (as configured in the Logger\nconfiguration):
\n\n trace \"I'm here\";\n\n warning \"Something dodgy happened\";\n\n panic \"I'm bailing out\";\n\n # Additional, special Dancer2 keyword\n success \"Settings saved successfully\";\n\n", "id" : "id283", "path" : "DETAILS/In Use/Logging debug information", "level" : 3, "name" : "Logging debug information" }, "id960-id221" : { "extends" : "id960", "name" : "_append", "type" : "option", "intro" : "
Inherited, see Log::Report::Message::new(_append)
", "id" : "id960-id221", "params" : "$text|$message" }, "id463" : { "level" : 1, "name" : "SYNOPSIS", "intro" : " # using a MO table efficiently\n my $mot = Log::Report::Lexicon::MOTcompact->read('mo/nl.mo')\n or die;\n\n my $header = $mot->msgid('');\n print $mot->msgstr($msgid, 3);\n\n",
"type" : "chapter",
"id" : "id463",
"path" : "SYNOPSIS"
},
"id842" : {
"name" : "failure",
"type" : "function",
"intro" : "Short for report FAILURE => $message
This basic file logger accepts a callback, which is called for each\nmessage which is to be logged. When you need complex things, you\nmay best make your own extension to Log::Report::Dispatcher, but\nfor simple things this will do.
\n", "id" : "id1069", "path" : "DESCRIPTION" }, "id1208-id760" : { "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(abstract)
", "type" : "option", "id" : "id1208-id760", "params" : "INTEGER", "extends" : "id1208", "name" : "abstract" }, "id202" : { "call" : "__( $msgid )", "type" : "function", "id" : "id202", "name" : "__" }, "id210" : { "call" : "N__w( STRING )", "type" : "function", "id" : "id210", "name" : "N__w" }, "id1192-id1217" : { "extends" : "id1192", "name" : "collectLocation", "intro" : "Inherited, see Log::Report::Dispatcher::collectLocation()
", "type" : "ci_method", "id" : "id1192-id1217", "call" : "$any->collectLocation" }, "id1301" : { "level" : 3, "name" : "Filters", "id" : "id1301", "type" : "subsection", "path" : "DETAILS/Processing the message/Filters" }, "id107" : { "path" : "DETAILS/Interpolation: Modifiers/Modifier: UNKNOWN or UNKNOWN($width)", "type" : "subsection", "intro" : "[1.01] When you need to interpolate a value which is unknown and potentially\nunsafe, then use this. For instance, you produce an internal error message\nto report that a method is used incorrectly:
\n\n sub openFolder\n { my ($self, $folder) = @_;\n\n blessed $folder && $folder->isa('Mail::Box')\n or printi \"ERROR: expected a Mail::Box, got a {t UNKNOWN}.\",\n t => $folder;\n }\n\n\nNow, this $folder parameter is clearly wrong. But what is it? Did we\npass a wrong object type? Did we pass a string? An ARRAY maybe?
The UNKNOWN modifier distibuishes the following:
Care is taken that weird characters are escaped. The shortening uses the\ntrim setting: either 'EL' (default) or 'CHOP'.
Inherited, see Log::Report::Dispatcher::new(format_reason)
", "extends" : "id1172", "type" : "default", "id" : "id1172-id1066", "value" : "'LOWERCASE'" }, "id886" : { "intro" : " if(Log::Report->needs('TRACE'))\n { my @args = ...expensive calculation...;\n trace \"your options are: @args\";\n }\n\n",
"type" : "example",
"id" : "id886"
},
"id1198-id760" : {
"extends" : "id1198",
"name" : "linenr",
"id" : "id1198-id760",
"intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(linenr)
", "type" : "option", "params" : "INTEGER" }, "id1312" : { "name" : "Available back-ends", "level" : 2, "path" : "DETAILS/Available back-ends", "type" : "section", "id" : "id1312" }, "id901" : { "id" : "id901", "type" : "section", "nest" : [ "id902", "id903", "id904" ], "path" : "DETAILS/Compared to other solutions in Perl", "intro" : "Some notes on differences between the Log::Report approach and other\nPerl concepts.
\n", "name" : "Compared to other solutions in Perl", "level" : 2 }, "id229" : { "name" : "reason", "value" : "undef",
"type" : "default",
"id" : "id229"
},
"id183" : {
"name" : "is_fatal",
"id" : "id183",
"type" : "option",
"params" : "BOOLEAN"
},
"id1202-id1217" : {
"params" : "ARRAY",
"intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(params)
", "id" : "id1202-id1217", "type" : "option", "name" : "params", "extends" : "id1202" }, "id1173-id1091" : { "name" : "charset", "extends" : "id1173", "params" : "CHARSET", "intro" : "Inherited, see Log::Report::Dispatcher::new(charset)
", "type" : "option", "id" : "id1173-id1091" }, "id96" : { "nest" : [ "id97", "id100", "id101", "id102", "id103", "id104", "id105", "id106", "id107", "id108", "id109" ], "id" : "id96", "type" : "section", "level" : 2, "name" : "Interpolation: Modifiers", "intro" : "Modifiers are used to change the value to be inserted, before\nthe characters get interpolated in the line. This is a powerful\nsimplification. Some useful modifiers are already provided by default.\nThey are also good examples how to write your own.
\n\nLet's discuss this with an example.\nIn traditional (gnu) gettext, you would write:
\n\n printf(gettext(\"approx pi: %.6f\\n\"), PI);\n\n\n
to get PI printed with six digits in the fragment.\nLocale::TextDomain has two ways to achieve that:
\n\n printf __\"approx pi: %.6f\\n\", PI;\n print __x\"approx pi: {approx}\\n\", approx => sprintf(\"%.6f\", PI);\n\n\nThe first does not respect the wish to be able to reorder the arguments\nduring translation (although there are ways to work around that) The\nsecond version is quite long. The string to be translated differs\nbetween the two examples.
\n\nWith Log::Report, above syntaxes do work as well, but you can also do:
\n # with optional translations\n print __x\"approx pi: {pi%.6f}\\n\", pi => PI;\n\n\nThe base for __x() is the printi() provided by this module. Internally,\nit will call printi to fill-in parameters:
\n printi \"approx pi: {pi%.6f}\\n\", pi => PI;\n\n\nAnother example:
\n\n printi \"{perms} {links%2d} {user%-8s} {size%10d} {fn}\\n\",\n perms => '-rw-r--r--', links => 7, user => 'me',\n size => 12345, fn => $filename;\n\n\nAn additional advantage (when you use translation) is the fact that not\nall languages produce comparable length strings. Now, the translators\ncan change the format, such that the layout of tables is optimal for their\nlanguage.
\n\nAbove example in printp() syntax, shorter but less maintainable:
\n\n printp \"%s %2d %-8s 10d %s\\n\",\n '-rw-r--r--', 7, 'me', 12345, $filename;\n\n", "path" : "DETAILS/Interpolation: Modifiers" }, "id658" : { "id" : "id658", "type" : "warning", "subroutine" : "id657", "name" : "unknown comment type '$cmd' at $where." }, "id724" : { "type" : "i_method", "intro" : "
Remove all the references to the indicate $filename from all defined\ntranslations. Returns the number of refs left.
\n", "id" : "id724", "call" : "$obj->removeReferencesTo( $filename )", "name" : "removeReferencesTo" }, "id897" : { "name" : "run-time change mode of a dispatcher\n", "intro" : "To change the running mode of the dispatcher, you can do
\n\n dispatcher mode => DEBUG => 'myname';\n\n\n
However, be warned that this does not change the types of messages\naccepted by the dispatcher! So: probably you will not receive\nthe trace, assert, and info messages after all. So, probably you\nneed to replace the dispatcher with a new one with the same name:
\n\n dispatcher FILE => 'myname', to => ..., mode => 'DEBUG';\n\n\n
This may reopen connections (depends on the actual dispatcher), which\nmight be not what you wish to happened. In that case, you must take\nthe following approach:
\n\n # at the start of your program, overrule the default 'NOTICE-' !!\n dispatcher FILE => 'myname', to => ..., accept => 'ALL';\n\n # now it works\n dispatcher mode => DEBUG => 'myname'; # debugging on\n ...\n dispatcher mode => NORMAL => 'myname'; # debugging off\n\n\n
Of course, this comes with a small overall performance penalty.
\n", "type" : "example", "id" : "id897" }, "id1140" : { "name" : "config", "intro" : "Read the settings from the $file. The parameters found in the file are\nused as default for the parameters above. This parameter is especially\nuseful for the context_rules, which need to be shared between the\nrunning application and xgettext-perl. See readConfig()
\n", "type" : "option", "id" : "id1140", "params" : "$file" }, "id358" : { "name" : "METHODS", "level" : 1, "path" : "METHODS", "nest" : [ "id359", "id366", "id369" ], "id" : "id358", "type" : "chapter" }, "id862" : { "call" : "__p( $msgctxt, $msgid )", "id" : "id862", "type" : "function", "name" : "__p" }, "id443" : { "path" : "SYNOPSIS", "intro" : " my $index = Log::Report::Lexicon::Index->new($directory);\n my $fn = $index->find('my-domain', 'nl_NL.utf-8');\n\n",
"type" : "chapter",
"id" : "id443",
"name" : "SYNOPSIS",
"level" : 1
},
"id940-id221" : {
"intro" : "Inherited, see Log::Report::Message::'\"\"'()
", "id" : "id940-id221", "type" : "overload", "call" : "overload '\"\"'; stringification", "extends" : "id940", "name" : "'\"\"'" }, "id780" : { "version" : "1.46", "chapters" : [ "id781", "id1325", "id782", "id783", "id787", "id1268" ], "name" : "Log::Report::Dispatcher::Log4perl", "title" : "send messages to Log::Log4perl back-end", "inheritance" : { "extends" : [ "Log::Report::Dispatcher" ] }, "id" : "id780", "distribution" : "Log-Report", "package" : "Log::Report::Dispatcher::Log4perl", "is_pure_pod" : false }, "id1203-id760" : { "intro" : "Inherited, see Log::Report::Dispatcher::stackTraceLine(params)
", "name" : "params", "id" : "id1203-id760", "value" : "<required>", "type" : "default", "extends" : "id1203" }, "id1101" : { "name" : "replace", "value" : "false",
"id" : "id1101",
"type" : "default"
},
"id877" : {
"name" : "syntax flag must be either SHORT or REPORT, not `$flag' in $fn line $line",
"subroutine" : "id867",
"type" : "error",
"id" : "id877"
},
"id888" : {
"path" : "DETAILS/Introduction",
"intro" : "Getting messages to users and logs. The distincting concept of this module,\nis that three tasks which are strongly related are merged into one simple\nsyntax. The three tasks:
\n\nText messages in Perl are produced by commands like print, die,\nwarn, carp, or croak. But where is that output directed to?\nTranslations is hard. There is no clean exception mechanism.
Besides, the print/warn/die together produce only three different\noutput \"levels\" with a message. Think of the variation syslog offers:\nmore than 7 levels. Many people manually implement their own tricks to\nget additional levels, like verbose and debug flags. Log::Report offers\nthat variety.
The (optional) translations use the beautiful syntax defined by\nLocale::TextDomain, with some own extensions (of course). A very\nimportant difference is that translations are delayed till the delivery\nstep: until a dispatcher actually writes your message into a file, sends\nit to syslog, or shows it on the screen. This means that the pop-up in\nthe graphical interface of the user may show the text in the language\nof the user --say Chinese in utf8--, but at the same time syslog may\nwrite the latin1 English version of the same message.
\n", "name" : "Introduction", "level" : 2, "id" : "id888", "type" : "section", "nest" : [ "id889", "id890" ] }, "id1021" : { "chapters" : [ "id1022", "id1347", "id1023", "id1024", "id1025", "id1028", "id1311" ], "name" : "Log::Report::Dispatcher::Try", "version" : "1.46", "is_pure_pod" : false, "package" : "Log::Report::Dispatcher::Try", "distribution" : "Log-Report", "inheritance" : { "extends" : [ "Log::Report::Dispatcher" ] }, "id" : "id1021", "title" : "capture all reports as exceptions" }, "id656" : { "subroutines" : [ "id663", "id657", "id668" ], "id" : "id656", "type" : "section", "path" : "METHODS/Parsing", "level" : 2, "name" : "Parsing" }, "id590" : { "name" : "rules", "params" : "HASH", "type" : "option", "id" : "id590" }, "id230" : { "name" : "Attributes", "level" : 2, "path" : "METHODS/Attributes", "id" : "id230", "type" : "section", "subroutines" : [ "id989-id221", "id991-id221", "id986-id221", "id984-id221", "id993-id221", "id994-id221", "id985-id221", "id995-id221", "id987-id221", "id992-id221", "id990-id221", "id983-id221", "id988-id221", "id232", "id231", "id233" ] }, "id1294" : { "path" : "DETAILS/Processing the message", "name" : "Processing the message", "level" : 2, "id" : "id1294", "type" : "section", "nest" : [ "id1295", "id1296" ] }, "id356" : { "level" : 1, "name" : "SYNOPSIS", "intro" : " # Added Log-Report-Template v0.90\n # First use of this module: extract msgids from various kinds\n # of text-files, usually web templates.\n # See script \"xgettext-perl\" for standard wrapper script\n\n my $extr = Log::Report::Template::Extract->new(\n lexicon => '/usr/share/locale',\n domain => 'my-web-site',\n pattern => 'TT2-loc',\n );\n $extr->process('website/page.html'); # many times\n $extr->showStats;\n $extr->write;\n\n # Second use: connect to Template::Toolkit\n # See DETAILS chapter below\n\n [% loc(\"Greetings {name},\", name => client.name) %]\n [% | loc(name => client.name) %]Greetings {name}[% END %]\n [% 'Greetings {name}' | loc(name => client.name) %]\n\n",
"id" : "id356",
"type" : "chapter",
"path" : "SYNOPSIS"
},
"id1096" : {
"name" : "Constructors",
"level" : 2,
"path" : "METHODS/Constructors",
"subroutines" : [
"id1097"
],
"id" : "id1096",
"type" : "section"
},
"id154" : {
"path" : "METHODS",
"name" : "METHODS",
"level" : 1,
"type" : "chapter",
"id" : "id154",
"nest" : [
"id155",
"id161",
"id171"
]
},
"id1340" : {
"name" : "INHERITANCE",
"level" : 1,
"path" : "INHERITANCE",
"intro" : "Log::Report::Lexicon::MOTcompact\n is a Log::Report::Lexicon::Table\n\n", "id" : "id1340", "type" : "chapter" }, "id1291" : { "level" : 3, "name" : "configuring global values", "id" : "id1291", "type" : "subsection", "path" : "DETAILS/Configuring/configuring global values" }, "id1193-id760" : { "name" : "stackTraceLine", "extends" : "id1193", "options" : [ [ "id1208-id760", "id1209-id760" ], [ "id1200-id760", "id1201-id760" ], [ "id1196-id760", "id1197-id760" ], [ "id1198-id760", "id1199-id760" ], [ "id1204-id760", "id1205-id760" ], [ "id1206-id760", "id1207-id760" ], [ "id1194-id760", "id1195-id760" ], [ "id1202-id760", "id1203-id760" ] ], "intro" : "
Inherited, see Log::Report::Dispatcher::stackTraceLine()
", "type" : "ci_method", "id" : "id1193-id760", "call" : "$any->stackTraceLine( %options )" }, "id1089" : { "call" : "$obj->translate( $message, [$language, $ctxt] )", "id" : "id1089", "intro" : "Returns the translation of the $message, a Log::Report::Message object,\nbased on the current locale.
\n\nTranslators are permitted to peek into the internal HASH of the\nmessage object, for performance reasons.
\n", "type" : "i_method", "name" : "translate" }, "id1112" : { "name" : "rotate", "intro" : "[1.00] Move the current file to $filename, and start a new file.
\n", "call" : "$obj->rotate( $filename|CODE )", "diagnostics" : [ "id1113", "id1114", "id1115" ], "type" : "i_method", "id" : "id1112" }, "id94" : { "name" : "Complex keys", "level" : 3, "path" : "DETAILS/Interpolation: keys/Complex keys", "id" : "id94", "intro" : "[0.91] In the previous section, we kept our addressing it simple: let's\nchange that now. Two alternatives for the same:
\n\n my $user = { name => 'John' };\n printi \"Username: {name}\", name => $user->{name}; # simple key\n printi \"Username: {user.name}\", user => $user; # complex key\n\n\nThe way these complex keys work, is close to the flexibility of\ntemplate toolkit: the only thing you cannot do, is passing parameters\nto called CODE.
\n\nYou can pass a parameter name as HASH, which contains values. This may\neven be nested into multiple levels. You may also pass objects, class\n(package names), and code references.
\n\nIn above case of user.name, when user is a HASH it will take the\nvalue which belongs to the key name. When user is a CODE, it will\nrun code to get a value. When user is an object, the method name\nis called to get a value back. When user is a class name, the name\nrefers to an instance method on that class.
More examples which do work:
\n\n # when name is a column in the database query result\n printi \"Username: {user.name}\", user => $sth->fetchrow_hashref;\n\n # call a sub which does the database query, returning a HASH\n printi \"Username: {user.name}\", user => sub { $db->getUser('John') };\n\n # using an instance method (object)\n { package User;\n sub new { bless { myname => $_[1] }, $_[0] }\n sub name { $_[0]->{myname} }\n }\n my $user = User->new('John');\n printi \"Username: {user.name}\", user => $user;\n\n # using a class method\n sub User::count { 42 }\n printi \"Username: {user.count}\", user => 'User';\n\n # nesting, mixing\n printi \"Complain to {product.factory.address}\", product => $p;\n\n # mixed, here CODE, HASH, and Object\n printi \"Username: {document.author.name}\", document => sub {\n return +{ author => User->new('John') }\n };\n\n\nLimitation: you cannot pass arguments to CODE calls.
\n", "type" : "subsection" }, "id1181-id905" : { "type" : "i_method", "intro" : "Inherited, see Log::Report::Dispatcher::mode()
", "id" : "id1181-id905", "call" : "$obj->mode", "extends" : "id1181", "name" : "mode" }, "id1104" : { "value" : "<adds timestamp>", "id" : "id1104", "type" : "default", "name" : "format" }, "id951-id221" : { "intro" : "Inherited, see Log::Report::Message::new(_count)
", "name" : "_count", "type" : "default", "id" : "id951-id221", "value" : "undef",
"extends" : "id951"
},
"id1226" : {
"path" : "NAME",
"id" : "id1226",
"intro" : "Log::Report::Exception - a single generated event
\n", "type" : "chapter", "name" : "NAME", "level" : 1 }, "id1024" : { "level" : 1, "name" : "DESCRIPTION", "type" : "chapter", "intro" : "The try works like Perl's build-in eval(), but implements\nreal exception handling which Perl core lacks.
The Log::Report::try() function creates this ::Try dispatcher\nobject with name 'try'. After the try() is over, you can find\nthe object in $@. The $@ as ::Try object behaves exactly\nas the $@ produced by eval, but has many added features.
The try() function catches fatal errors happening inside the BLOCK\n(CODE reference which is just following the function name) into the\n::Try object $@. The errors are not automatically progressed to\nactive dispatchers. However, non-fatal exceptions (like info or notice)\nare also collected (unless not accepted, see new(accept), but also\nimmediately passed to the active dispatchers (unless the reason is hidden,\nsee new(hide))
After the try() has run, you can introspect the collected exceptions.\nTypically, you use wasFatal() to get the exception which terminated\nthe run of the BLOCK.
[0.998] When not specified, the syntax option determines the list\nof @functions which are being exported. With this option, the syntax\noption is ignored and only the specified @functions are imported.
\n", "id" : "id872" }, "id99" : { "intro" : "The full pattern is pretty complex: %[+ -0]?[0-9]*[_,.]?d, POSIX\nformat style with a few extra features. The middle (optional) digits tell\nthe minimal size of the integer to be displayed. The optional character\nbefore it says: + will add a '+' sign when positive, 'blank' adds one\nblank before the digits when positive, a 0 pads left with zeros instead\nof blanks. Finally, a C<-> means left-align padding blanks on the right.
[0.96] The last pattern is only useful when you print (big) decimals:\nadd an underscore, comma, or dot on the thousands.
\n\n printi \"{count%_d}\\n\", count => 1e9; # 1_000_000_000\n printi \"{count%,d}\\n\", count => 1e9; # 1,000,000,000\n printi \"{count%.d}\\n\", count => 1e9; # 1.000.000.000\n\n printi \"'{v%10.d}'\", v => 10000; # ' 10.000';\n printi \"'{v%10_d}'\", v => -10000; # ' -10_000';\n printi \"'{v%-10.d}'\", v => 10000; # '10.000 ';\n printi \"'{v%-10.d}'\", v => -10000; # '-10.000 ';\n printi \"'{v%+10,d}'\", v => 10000; # ' +10,000';\n printi \"'{v% ,d}'\", v => 10000; # ' 10,000';\n printi \"'{v% ,d}'\", v => -10000; # '-10,000';\n\n\n[1.00] You can set the default FORMAT separator:
\n use String::Print\n defaults => [ FORMAT => { thousands => ',' } ];\n\n # or\n my $sp = String::Print->new(\n defaults => { FORMAT => { thousands => ',' }},\n );\n\n # or\n $sp->setDefaults(FORMAT => { thousands => ',' });\n\n",
"type" : "subsubsection",
"id" : "id99",
"path" : "DETAILS/Interpolation: Modifiers/Modifier: POSIX format starts with '%'/POSIX modifier extensions '%d'",
"level" : 4,
"name" : "POSIX modifier extensions '%d'"
},
"id1353" : {
"name" : "INHERITANCE",
"level" : 1,
"path" : "INHERITANCE",
"intro" : "Log::Report::Lexicon::POTcompact\n is a Log::Report::Lexicon::Table\n\n", "type" : "chapter", "id" : "id1353" }, "id254" : { "name" : "SYNOPSIS", "level" : 1, "path" : "SYNOPSIS", "type" : "chapter", "intro" : "
# Load the plugin into Dancer2\n # see Log::Report::import() for %options\n use Dancer2::Plugin::LogReport %options;\n\n # Stop execution, redirect, and display an error to the user\n $name or error \"Please enter a name\";\n\n # Add debug information to logger\n trace \"We're here\";\n\n # Handling user errors cleanly\n if (process( sub {MyApp::Model->create_user} )) {\n # Success, redirect user elsewhere\n } else {\n # Failed, continue as if submit hadn't been made.\n # Error message will be in session for display later.\n }\n\n # Send errors to template for display\n hook before_template => sub {\n my $tokens = shift;\n $tokens->{messages} = session 'messages';\n session 'messages' => [];\n }\n\n",
"id" : "id254"
},
"id1115" : {
"type" : "fault",
"id" : "id1115",
"name" : "cannot write log into $file: $!",
"subroutine" : "id1112"
},
"id867" : {
"options" : [
[
"id872",
"id873"
],
[
"id874",
"id875"
],
[
"id870",
"id871"
],
[
"id868",
"id869"
]
],
"id" : "id867",
"type" : "i_method",
"call" : "$obj->import( [$level,][$domain,] %options )",
"diagnostics" : [
"id877",
"id878",
"id879",
"id880",
"id881"
],
"examples" : [
"id876"
],
"intro" : "The import is automatically called when the package is compiled. For all\npackages but one in your distribution, it will only contain the name of\nthe $domain.
\n\nFor one package, the import list may additionally contain textdomain\nconfiguration %options. These %options are used for all packages which\nuse the same $domain. These are alternatives:
\n\n # Do not use variables in the %*config! They are not yet initialized\n # when Log::Report->import is run!!!\n use Log::Report 'my-domain', %config, %domain_config;\n\n use Log::Report 'my-domain', %config;\n textdomain 'my-domain', %domain_config; # vars allowed\n\n\n
The latter syntax has major advantages, when the configuration of the\ndomain is determined at run-time. It is probably also easier to understand.
\n\nSee Log::Report::Domain::configure(), for the list of %options\nfor the domain configuration. Here, we only list the options which are\nrelated to the normal import behavior.
\n\nThe export $level is a plus (+) followed by a number, for instance +1,\nto indicate to on which caller level we need to work. This is used\nin Log::Report::Optional. It defaults to '0': my direct caller.
The exit string or object ($@) of the eval'ed block, in its unprocessed state.
Inherited, see Log::Report::Dispatcher::name()
", "id" : "id1179-id905", "type" : "i_method", "extends" : "id1179", "name" : "name" }, "id551" : { "path" : "SYNOPSIS", "id" : "id551", "intro" : " # Only usable on Windows\n print codepage_to_iso(0x0413); # nl-NL\n print iso_to_codepage('nl_NL'); # 1043\n printf \"%x\", iso_to_codepage('nl_NL'); # 413\n\n my $iso = iso_locale(ms_codepage_id());\n my $iso = iso_locale; # same\n\n print charset_encoding; # cp1252\n print ms_codepage_id; # 1043\n print ms_install_codepage_id; # 1043\n print ms_locale; # Dutch (Netherlands)\n\n",
"type" : "chapter",
"name" : "SYNOPSIS",
"level" : 1
},
"id406" : {
"call" : "$obj->function",
"id" : "id406",
"intro" : "Returns the name of the function which is used for translations.
\n", "type" : "i_method", "name" : "function" }, "id928" : { "value" : "<unchanged>", "type" : "default", "id" : "id928", "name" : "format" }, "id540" : { "type" : "i_method", "id" : "id540", "diagnostics" : [ "id541" ], "call" : "$obj->store( $domain, $filename, $linenr, $context, $msg, [$msg_plural] )", "name" : "store", "intro" : "Register the existence of a ($msg, $msg_plural) in all POTs of\nthe $domain.
\n" }, "id1167-id780" : { "intro" : "Inherited, see Log::Report::Dispatcher::new(locale)
", "id" : "id1167-id780", "type" : "option", "params" : "LOCALE", "extends" : "id1167", "name" : "locale" }, "id539-id493" : { "name" : "starting new textdomain $domain, template in $filename", "extends" : "id539", "subroutine" : "id538", "id" : "id539-id493", "intro" : "Inherited, see Log::Report::Extract::write()
", "type" : "info" }, "id1276" : { "level" : 2, "name" : "Message-IDs", "type" : "section", "id" : "id1276", "path" : "DETAILS/Message-IDs" }, "id1074" : { "name" : "callback", "params" : "CODE", "intro" : "Your callback is called with five parameters: this dispatcher object,\nthe options, a reason and a message. The options are the first\nparameter of Log::Report::report() (read over there). The reason\nis a capitized string like ERROR. Then, the message (is a\nLog::Report::Message). Finally the text-domain of the message.
Returns the language code, which is derived from the filename.
\n", "id" : "id713", "call" : "$obj->language", "name" : "language" }, "id990-id221" : { "type" : "i_method", "intro" : "Inherited, see Log::Report::Message::tags()
", "id" : "id990-id221", "call" : "$obj->tags", "extends" : "id990", "name" : "tags" }, "id1230" : { "call" : "overload \"\"; stringification", "type" : "overload", "intro" : "Produces \"reason: message\" via toString().
\n", "id" : "id1230", "name" : "\"\"" }, "id493" : { "distribution" : "Log-Report-Lexicon", "package" : "Log::Report::Extract::PerlPPI", "is_pure_pod" : false, "title" : "Collect translatable strings from Perl using PPI", "inheritance" : { "extends" : [ "Log::Report::Extract" ] }, "id" : "id493", "chapters" : [ "id494", "id1345", "id495", "id496", "id500" ], "name" : "Log::Report::Extract::PerlPPI", "version" : "1.16" }, "id1170-id760" : { "type" : "default", "value" : "'NORMAL'", "id" : "id1170-id760", "extends" : "id1170", "intro" : "Inherited, see Log::Report::Dispatcher::new(mode)
", "name" : "mode" }, "id1138-id385" : { "intro" : "Inherited, see Log::Report::Domain::configure(context_rules)
", "type" : "option", "id" : "id1138-id385", "params" : "\\%rules|OBJECT", "extends" : "id1138", "name" : "context_rules" } }, "project" : "Log-Report", "meta" : { "main_manual" : "Log::Report" }, "distributions" : { "String-Print" : { "abstract" : "printf extensions", "generated_by" : "ExtUtils::MakeMaker version 7.76, CPAN::Meta::Converter version 2.150010", "name" : "String-Print", "no_index" : { "directory" : [ "t", "inc" ] }, "dynamic_config" : 0, "resources" : { "bugtracker" : { "web" : "https://github.com/markov2/perl5-String-Print/issues" }, "homepage" : "http://perl.overmeer.net/CPAN/", "repository" : { "web" : "https://github.com/markov2/perl5-String-Print", "type" : "git", "url" : "https://github.com/markov2/perl5-String-Print.git" } }, "x_serialization_backend" : "JSON::PP version 4.16", "release_status" : "stable", "version" : "1.02", "prereqs" : { "build" : { "requires" : { "ExtUtils::MakeMaker" : "0" } }, "runtime" : { "x_optional" : { "DateTime" : 1 }, "requires" : { "Date::Parse" : "2.3", "Unicode::GCString" : "0", "Encode" : "0", "HTML::Entities" : "0", "Test::More" : "0.86" } }, "develop" : { "requires" : { "OODoc" : "3.04" } }, "configure" : { "requires" : { "ExtUtils::MakeMaker" : "0" } }, "test" : { "requires" : { "Test::Pod" : "1", "Test::More" : "1" } } }, "x_oodist" : { "use" : [], "include" : [], "generate" : [ { "format" : "pod3", "podtail" : null } ], "email" : "markov@cpan.org", "raw" : { "publish" : "../public_html/string-print/raw" }, "release" : { "publish" : "../public_html/string-print/source" }, "first_year" : 2016, "parser" : { "syntax" : "markov", "skip_links" : [ "Locale::TextDomain" ] }, "oodoc_version" : 3.04, "tests" : {} }, "author" : [ "Mark Overmeer