Digimer at 03:49, 20 September 2009

2009-09-20T03:49:06Z

← Older revision		Revision as of 03:49, 20 September 2009
Line 7:		Line 7:

	==SYNOPSIS==		==SYNOPSIS==
	<~~code~~>		<source lang="perl">
	use AN::Tools;		use AN::Tools;

Line 16:		Line 16:
	# example, this is how you would read in an XML words file.		# example, this is how you would read in an XML words file.
	$an->String->read_words({file=>"/path/to/program/words.xml"});		$an->String->read_words({file=>"/path/to/program/words.xml"});
	</~~code~~>		</source>
	==DESCRIPTION==		==DESCRIPTION==
	This module provides access to the various "words" processing methods. These include reading in XML words files, inserting variables into strings, processing template files and so forth.		This module provides access to the various "words" processing methods. These include reading in XML words files, inserting variables into strings, processing template files and so forth.
Line 28:		Line 28:
	===force_utf8===		===force_utf8===
	====Example====		====Example====
	<~~code~~>		<source lang="perl">
	# Force 'utf8' mode for an XML words file to be read then turn it back off.		# Force 'utf8' mode for an XML words file to be read then turn it back off.
	$an->String->force_utf8(1);		$an->String->force_utf8(1);
	$an->String->read_words({file=>"/path/to/program/words.xml"});		$an->String->read_words({file=>"/path/to/program/words.xml"});
	$an->String->force_utf8(0);		$an->String->force_utf8(0);
	</~~code~~>		</source>
	====Details====		====Details====
	This returns or sets whether the filehandle used to read files is forced into UTF8 mode. In practice, this should never be needed because all files should already be saved as UTF-8 encoded files. However, if this is not the case, setting this to '1' will tell AN::Tools::String methods to call 'binmode FH, encoding(utf8);'.		This returns or sets whether the filehandle used to read files is forced into UTF8 mode. In practice, this should never be needed because all files should already be saved as UTF-8 encoded files. However, if this is not the case, setting this to '1' will tell AN::Tools::String methods to call 'binmode FH, encoding(utf8);'.
Line 41:		Line 41:
	===read_words===		===read_words===
	====Example====		====Example====
	<~~code~~>		<source lang="perl">
	# Read in your program's XML words file into the '$an->data' hash reference.		# Read in your program's XML words file into the '$an->data' hash reference.
	$an->String->read_words({file=>"/path/to/program/words.xml"});		$an->String->read_words({file=>"/path/to/program/words.xml"});
Line 52:		Line 52:
	hash => $hash		hash => $hash
	});		});
	</~~code~~>		</source>
	====Details====		====Details====
	This reads in an XML words file with your program's words. By default, the data is fed into the '$an->data' hash reference under the 'words' key. This data is meant to be accessed and manipulated by the <tt>get_word</tt> method, but if you have a need to directly access it, it is in the following format:		This reads in an XML words file with your program's words. By default, the data is fed into the '$an->data' hash reference under the 'words' key. This data is meant to be accessed and manipulated by the <tt>get_word</tt> method, but if you have a need to directly access it, it is in the following format:
Line 76:		Line 76:
	The "word" file is structured like this:		The "word" file is structured like this:

	<~~code~~>		<source lang="xml">
	<?xml version="1.0" encoding="UTF-8"?>		<?xml version="1.0" encoding="UTF-8"?>
	<words>		<words>
Line 93:		Line 93:
	</lang>		</lang>
	</words>		</words>
	</~~code~~>		</source>
	All languages are within the 'words' block. The first argument, <tt>langs</tt>, is a comma-seperated list of enabled languages. This allows you to have a work-in-progress language without making it available to users of the program by simply leaving out of this list.		All languages are within the 'words' block. The first argument, <tt>langs</tt>, is a comma-seperated list of enabled languages. This allows you to have a work-in-progress language without making it available to users of the program by simply leaving out of this list.

Digimer at 02:32, 20 September 2009

2009-09-20T02:32:39Z

Show changes

Digimer: Created page with '{{mod_header}} {{footer}}'

2009-09-20T02:21:54Z

Created page with '{{mod_header}} {{footer}}'

Páàjì titun

POD AN::Tools::String - Revision history

Digimer at 03:49, 20 September 2009

Digimer at 02:32, 20 September 2009

Digimer: Created page with '{{mod_header}} {{footer}}'