Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Biber::LaTeX::Recode(3User Contributed Perl DocumentatiBiber::LaTeX::Recode(3)

NAME
       Biber::LaTeX::Recode - Encode/Decode chars to/from UTF-8/lacros in
       LaTeX

SYNOPSIS
	   use Biber::LaTeX:Recode

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

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

DESCRIPTION
       Allows conversion between Unicode chars and LaTeX macros.

GLOBAL OPTIONS
       Possible	values for the encoding/decoding set to	use are	'null',	'base'
       and 'full'; default value is 'base'.

       null  =>	No conversion

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

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

   init_sets(<decode set>, <encode_set>)
	 Initialise recoding sets. We can't do this on loading the module as we	don't have the config
	 information to	do this	yet

   latex_decode($text, @options)
       Converts	LaTeX macros in	the $text to Unicode characters.

       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 'NFD')
	       and if yes, the normalization form to use (see the Unicode::Normalize documentation)

   latex_encode($text, @options)
       Converts	UTF-8 to LaTeX

AUTHOR
       Francois	Charette, "<firmicus at	ankabut.net>" Philip Kime "<philip at
       kime.org.uk>"

BUGS
       Please report any bugs or feature requests on our Github	tracker	at
       <https://github.com/plk/biber/issues>.

COPYRIGHT & LICENSE
       Copyright 2009-2015 Francois Charette and Philip	Kime, 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.32.0			  2020-08-31	       Biber::LaTeX::Recode(3)

NAME | SYNOPSIS | DESCRIPTION | GLOBAL OPTIONS | AUTHOR | BUGS | COPYRIGHT & LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Biber::LaTeX::Recode&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help