.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "Log::Report::Minimal::Domain 3"
.TH Log::Report::Minimal::Domain 3 2025-12-12 "perl v5.42.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Log::Report::Minimal::Domain \- administer one text\-domain
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&  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.
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Read Log::Report::Domain.
.SH METHODS
.IX Header "METHODS"
.SS Constructors
.IX Subsection "Constructors"
.ie n .IP $class\->\fBnew\fR(%options) 4
.el .IP \f(CW$class\fR\->\fBnew\fR(%options) 4
.IX Item "$class->new(%options)"

.Sp
.Vb 2
\& \-Option\-\-Default
\&  name    <required>
.Ve
.RS 4
.IP "name => STRING" 2
.IX 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.
.RE
.RS 4
.Sp
example: textdomain name choice
.Sp
A good choice is to use Perl\*(Aqs distribution name for the domain name.  For instance,
the domain name for this module would be set this way:
.Sp
.Vb 2
\&  use Log::Report \*(Aqlog\-report\-optional\*(Aq;
\&  use Log::Report \*(Aqlog\-report\-opt\*(Aq;
.Ve
.RE
.SS Attributes
.IX Subsection "Attributes"
.ie n .IP $obj\->\fBconfigure\fR(%options) 4
.el .IP \f(CW$obj\fR\->\fBconfigure\fR(%options) 4
.IX Item "$obj->configure(%options)"

.Sp
.Vb 2
\& \-Option\-\-Default
\&  where   <required>
.Ve
.RS 4
.IP "where => ARRAY" 2
.IX Item "where => ARRAY"
Specifies the location of the configuration.  It is not allowed to
configure a domain on more than one location.
.RE
.RS 4
.RE
.ie n .IP $obj\->\fBisConfigured\fR() 4
.el .IP \f(CW$obj\fR\->\fBisConfigured\fR() 4
.IX Item "$obj->isConfigured()"

.ie n .IP $obj\->\fBname\fR() 4
.el .IP \f(CW$obj\fR\->\fBname\fR() 4
.IX Item "$obj->name()"

.SS Translating
.IX Subsection "Translating"
.ie n .IP "$obj\->\fBinterpolate\fR( $msgid, [$args] )" 4
.el .IP "\f(CW$obj\fR\->\fBinterpolate\fR( \f(CW$msgid\fR, [$args] )" 4
.IX Item "$obj->interpolate( $msgid, [$args] )"
Interpolate the keys used in \f(CW$msgid\fR from the values in \f(CW$args\fR.
This is handled by the formatter, by default a String::Print
instance.
.SH DIAGNOSTICS
.IX Header "DIAGNOSTICS"
.ie n .IP "Error: illegal formatter \`$name\*(Aq at $fn line $line" 4
.el .IP "Error: illegal formatter \`$name\*(Aq at \f(CW$fn\fR line \f(CW$line\fR" 4
.IX Item "Error: illegal formatter `$name' at $fn line $line"
Cast by \fBconfigure()\fR
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module is part of Log\-Report\-Optional version 1.08,
built on September 08, 2025. Website: \fIhttp://perl.overmeer.net/CPAN/\fR
.SH LICENSE
.IX Header "LICENSE"
For contributors see file ChangeLog.
.PP
This software is copyright (c) 2013\-2025 by Mark Overmeer.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.