.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
.\" ========================================================================
.\"
.IX Title "Biber::LaTeX::Recode 3pm"
.TH Biber::LaTeX::Recode 3pm 2023-07-25 "perl v5.38.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
Biber::LaTeX::Recode \- Encode/Decode chars to/from UTF\-8/lacros in LaTeX
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use Biber::LaTeX:Recode
\&
\&    my $string = \*(AqMuḥammad ibn Mūsā al\-Khwārizmī\*(Aq;
\&    my $latex_string = latex_encode($string);
\&        # => \*(AqMu\ed{h}ammad ibn M\e=us\e=a al\-Khw\e=arizm\e={\ei}\*(Aq
\&
\&    my $string = \*(AqMu\ed{h}ammad ibn M\e=us\e=a al\-Khw\e=arizm\e={\ei}\*(Aq;
\&    my $utf8_string   = latex_decode($string);
\&        # => \*(AqMuḥammad ibn Mūsā al\-Khwārizmī\*(Aq
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Allows conversion between Unicode chars and LaTeX macros.
.SH "GLOBAL OPTIONS"
.IX Header "GLOBAL OPTIONS"
Possible values for the encoding/decoding set to use are 'null', 'base' and 'full'; default
value is 'base'.
.PP
null  => No conversion
.PP
base  => Most common macros and diacritics (sufficient for Western languages
         and common symbols)
.PP
full  => Also converts punctuation, larger range of diacritics and macros
         (e.g. for IPA, Latin Extended Additional, etc.), symbols, Greek letters,
         dingbats, negated symbols, and superscript characters and symbols ...
.SS "init_sets(<decode set>, <encode_set>)"
.IX Subsection "init_sets(<decode set>, <encode_set>)"
.Vb 2
\&  Initialise recoding sets. We can\*(Aqt do this on loading the module as we don\*(Aqt have the config
\&  information to do this yet
.Ve
.ie n .SS "latex_decode($text, @options)"
.el .SS "latex_decode($text, \f(CW@options\fP)"
.IX Subsection "latex_decode($text, @options)"
Converts LaTeX macros in the \f(CW$text\fR to Unicode characters.
.PP
The function accepts a number of options:
.PP
.Vb 2
\&    * normalize => $bool (default 1)
\&        whether the output string should be normalized with Unicode::Normalize
\&
\&    * normalization => <normalization form> (default \*(AqNFD\*(Aq)
\&        and if yes, the normalization form to use (see the Unicode::Normalize documentation)
.Ve
.ie n .SS "latex_encode($text, @options)"
.el .SS "latex_encode($text, \f(CW@options\fP)"
.IX Subsection "latex_encode($text, @options)"
Converts UTF\-8 to LaTeX
.SH AUTHOR
.IX Header "AUTHOR"
Philip Kime \f(CW\*(C`<philip at kime.org.uk>\*(C'\fR
.SH BUGS
.IX Header "BUGS"
Please report any bugs or feature requests on our Github tracker at
<https://github.com/plk/biber/issues>.
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2009\-2012 François Charette and Philip Kime, all rights reserved.
Copyright 2012\-2023 Philip Kime, all rights reserved.
.PP
This module is free software.  You can redistribute it and/or
modify it under the terms of the Artistic License 2.0.
.PP
This program is distributed in the hope that it will be useful,
but without any warranty; without even the implied warranty of
merchantability or fitness for a particular purpose.