latex::encode::encodingtable(3pm) [debian man page]

LaTeX::Encode::EncodingTable(3pm)			User Contributed Perl Documentation			 LaTeX::Encode::EncodingTable(3pm)

NAME

       LaTeX::Encode::EncodingTable - Encoding table for characters for LaTeX formatting

SYNOPSIS

	 use LaTeX::Encode::EncodingTable;

VERSION

       This manual page describes version 0.03 of the "LaTeX::Encode::EncodingTable" module.

DESCRIPTION

       This module provides the encoding table for characters for LaTeX formatting.

DEPENDENCIES

       The "HTML::Entities" and "Pod::LaTeX" modules were used for building the encoding table in "LaTeX::Encode::EncodingTable", but this is not
       rebuilt at installation time.  The "LaTeX::Driver" module is used for formatting the character encodings reference document.

BUGS AND LIMITATIONS

       Not all LaTeX special characters are included in the encoding tables (more may be added when I track down the definitions).

       The "use_textcomp" option is not implemented.

AUTHOR

       Andrew Ford <a.ford@ford-mason.co.uk>

LICENSE AND COPYRIGHT

       Copyright (C) 2007 Andrew Ford.	All Rights Reserved.

       This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

       This software 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.

SEE ALSO

       Template::Plugin::Latex

NOTES ON MANPAGE

       This manual page was written for the Debian GNU/Linux distribution because the original module does not have a manual page.

perl v5.10.0							    2009-06-07					 LaTeX::Encode::EncodingTable(3pm)

TeX::Encode(3pm)					User Contributed Perl Documentation					  TeX::Encode(3pm)

NAME

       TeX::Encode - Encode/decode Perl utf-8 strings into TeX

SYNOPSIS

	 use TeX::Encode;
	 use Encode;

	 $tex = encode('latex', "This will encode an e-acute (".chr(0xe9).") as 'e");
	 $str = decode('latex', $tex); # Will decode the 'e too!

DESCRIPTION

       This module provides encoding to LaTeX escapes from utf8 using mapping tables in Pod::LaTeX and HTML::Entities. 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.

       Mileage will vary when decoding (converting TeX to utf8), as TeX is in essence a programming language, and this module does not implement
       TeX.

       I use this module to encode author names in BibTeX and to do a rough job at presenting LaTeX abstracts in HTML. Using decode rather than
       seeing $sqrt{Omega^2zeta_n}$ you get something that looks like the formula.

       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).

METHODS

       TeX::Encode::encode STRING [, CHECK]
	   Encodes a utf8 string into TeX. CHECK isn't implemented.

       TeX::Encode::decode STRING [, CHECK]
	   Decodes a TeX string into utf8. CHECK isn't implemented.

       TeX::Encode::perlio_ok
	   Returns 0. PerlIO isn't implemented.

CAVEATS

       Proper Encode checking is not implemented.

       LaTeX comments (% ...) are ignored because chopping a lot of text may not be what you actually want.

   encode()
       Converts non-ASCII Unicode characters to their equivalent TeX symbols (unTeXable characters will result in undef warnings).

   decode()
       Attempts to convert TeX symbols (e.g. ae) to Unicode characters. As an experimental feature this also handles Math-mode TeX by inserting
       HTML into the resulting string (so you end up with an HTML approximation of the maths - NOT MathML).

SEE ALSO

       Encode::Encoding, Pod::LaTeX, Encode

AUTHOR

       Timothy D Brody, <tdb01r@ecs.soton.ac.uk>

COPYRIGHT AND LICENSE

       Copyright (C) 2005-2007 by Timothy D Brody

       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.

perl v5.12.4							    2011-09-21							  TeX::Encode(3pm)