debian man page for latex::decode

LaTeX::Decode(3pm)					User Contributed Perl Documentation					LaTeX::Decode(3pm)

NAME
       LaTeX::Decode - Decode from LaTeX to Unicode

VERSION
       Version 0.03

SYNOPSIS
	   use LaTeX::Decode;

	   my $latex_string = 'Mu\d{h}ammad ibn M\=us=a al-Khw\=arizm\={\i}';
	   my $new_string   = latex_decode($latex_string); # => 'MuXammad ibn MXsX al-KhwXrizmX'

DESCRIPTION
EXPORT
FUNCTIONS
   latex_decode($text, %options)
       Decodes the given text from LaTeX to Unicode.

       The function accepts a number of options:

	   * normalize => $bool (default 1)
	       whether the output string should be normalized with Unicode::Normalize

	   * normalization => <normalization form> (default 'NFC')
	       and if yes, the normalization form to use (see the Unicode::Normalize documentation)

	   * strip_outer_braces => $bool (default 0)
	       whether the outer curly braces around letters+combining marks should be
	       stripped off. By default "fut{\'e}" becomes fut{e}, to prevent something
	       like '\textuppercase{\'e}' to become '\textuppercasee'. Setting this option to
	       TRUE can be useful for instance when converting BibTeX files.

GLOBAL OPTIONS
       The decoding scheme can be set with

	   $LaTeX::Decode::DefaultScheme = '<name>';

       Possible values are 'base', 'extra' and 'full'; default value is 'extra'.

       base  => Most common macros and diacritics (sufficient for Western languages
		and common symbols)

       extra => Also converts punctuation, larger range of diacritics and macros
		(e.g. for IPA, Latin Extended Additional, etc.)

       full  => Also converts symbols, Greek letters, dingbats, negated symbols, and
		superscript characters and symbols ...

AUTHOR
       Francois Charette, "<firmicus@cpan.org>"

BUGS
       Please report any bugs or feature requests to "bug-latex-decode at rt.cpan.org", or through the web interface at
       <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=LaTeX-Decode>.  I will be notified, and then you'll automatically be notified of progress
       on your bug as I make changes.

COPYRIGHT &; LICENSE
       Copyright 2009-2010 Francois Charette, all rights reserved.

       This module is free software.  You can redistribute it and/or modify it under the terms of the Artistic License 2.0.

       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.

perl v5.10.1							    2010-11-03							LaTeX::Decode(3pm)