1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
=encoding utf8
=head1 NAME
Log::Report::Minimal::Domain - administer one text-domain
=head1 SYNOPSIS
use Log::Report::Minimal::Domain;
my $domain = Log::Report::Minimal::Domain->new(name => $name);
# normal usage
use Log::Report::Optional; # or Log::Report itself
my $domain = textdomain $name; # find config
textdomain $name, %configure; # set config, only once.
=head1 DESCRIPTION
Read L<Log::Report::Domain>.
=head1 METHODS
=head2 Constructors
=over 4
=item $class-E<gt>B<new>(%options)
Z<>
-Option--Default
name <required>
=over 2
=item name => STRING
The name of the textdomain is used in its invocation, but also as (part of) the
translation file names, hence please keep it simple and short.
=back
example: textdomain name choice
A good choice is to use Perl's distribution name for the domain name. For instance,
the domain name for this module would be set this way:
use Log::Report 'log-report-optional';
use Log::Report 'log-report-opt';
=back
=head2 Attributes
=over 4
=item $obj-E<gt>B<configure>(%options)
Z<>
-Option--Default
where <required>
=over 2
=item where => ARRAY
Specifies the location of the configuration. It is not allowed to
configure a domain on more than one location.
=back
=item $obj-E<gt>B<isConfigured>()
Z<>
=item $obj-E<gt>B<name>()
Z<>
=back
=head2 Translating
=over 4
=item $obj-E<gt>B<interpolate>( $msgid, [$args] )
Interpolate the keys used in C<$msgid> from the values in C<$args>.
This is handled by the formatter, by default a L<String::Print|String::Print>
instance.
=back
=head1 DIAGNOSTICS
=over 4
=item Error: illegal formatter `$name' at $fn line $line
Cast by configure()
=back
=head1 SEE ALSO
This module is part of Log-Report-Optional version 1.08,
built on September 08, 2025. Website: F<http://perl.overmeer.net/CPAN/>
=head1 LICENSE
For contributors see file ChangeLog.
This software is copyright (c) 2013-2025 by Mark Overmeer.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
|
