.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 "TeX::Encode 3pm"
.TH TeX::Encode 3pm "2022-10-13" "perl v5.34.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"
TeX::Encode \- Encode/decode Perl utf\-8 strings into TeX
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  use TeX::Encode;
\&  use Encode;
\&
\&  $tex = encode(\*(Aqlatex\*(Aq, "This will encode an e\-acute (".chr(0xe9).") as \e\*(Aqe");
\&  $str = decode(\*(Aqlatex\*(Aq, $tex); # Will decode the \e\*(Aqe too!
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides encoding to LaTeX escapes from utf8 using mapping tables. This covers only a subset of the Unicode character table (undef warnings will occur for non-mapped chars). This module is intentionally vague about what it will handle, see Caveats below.
.PP
Mileage will vary when decoding (converting TeX to utf8), as TeX is in essence a programming language, and this module does not implement TeX.
.PP
I use this module to encode author names in BibTeX and to do a rough job at presenting LaTeX abstracts in \s-1HTML.\s0 Using decode rather than seeing $\esqrt{\eOmega^2\ezeta_n}$ you get something that looks like the formula.
.PP
The next logical step for this module is to integrate some level of TeX grammar to improve the decoding, in particular to handle fractions and font changes (which should probably be dropped).
.SH "METHODS"
.IX Header "METHODS"
.IP "TeX::Encode::encode \s-1STRING\s0 [, \s-1CHECK\s0]" 4
.IX Item "TeX::Encode::encode STRING [, CHECK]"
Encodes a utf8 string into TeX. \s-1CHECK\s0 isn't implemented.
.IP "TeX::Encode::decode \s-1STRING\s0 [, \s-1CHECK\s0]" 4
.IX Item "TeX::Encode::decode STRING [, CHECK]"
Decodes a TeX string into utf8. \s-1CHECK\s0 isn't implemented.
.IP "TeX::Encode::perlio_ok" 4
.IX Item "TeX::Encode::perlio_ok"
Returns 0. PerlIO isn't implemented.
.SH "CAVEATS"
.IX Header "CAVEATS"
Proper Encode checking is not implemented.
.PP
LaTeX comments (% ...) are ignored because chopping a lot of text may not be what you actually want.
.SS "\fBencode()\fP"
.IX Subsection "encode()"
Converts non-ASCII Unicode characters to their equivalent TeX symbols (unTeXable characters will result in undef warnings).
.SS "\fBdecode()\fP"
.IX Subsection "decode()"
Attempts to convert TeX symbols (e.g. \eae) to Unicode characters. As an experimental feature this also handles Math-mode TeX by inserting \s-1HTML\s0 into the resulting string (so you end up with an \s-1HTML\s0 approximation of the maths \- \s-1NOT\s0 MathML).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Encode::Encoding, Pod::LaTeX, Encode
.SH "AUTHOR"
.IX Header "AUTHOR"
.IP "\(bu" 4
Timothy D Brody, <tdb01r@ecs.soton.ac.uk>
.IP "\(bu" 4
Ahmad Fatoum \f(CW\*(C`<athreef@cpan.org>\*(C'\fR, <http://a3f.at>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2005\-2007 by Timothy D Brody
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.7 or,
at your option, any later version of Perl 5 you may have available.