string::dirify(3pm) [debian man page]

String::Dirify(3pm)					User Contributed Perl Documentation				       String::Dirify(3pm)

NAME

       "String::Dirify" - Convert a string into a directory name

Synopsis
	       use String::Dirify;

	       my($dir_1) = String::Dirify -> dirify('frobnitz');

       Or:

	       use String::Dirify ':all';

	       my($dir_2) = dirify('bar baz');

       Or even:

	       use String::Dirify;

	       my($sd)	  = String::Dirify -> new();
	       my($dir_3) = $sd -> dirify('!Q@W#E$R%T^Y');

Description
       "String::Dirify" is a pure Perl module.

       This module allows you to convert a string (possibly containing high ASCII characters, and even HTML) into another, lower-cased, string
       which can be used as a directory name.

       For usage, see the Synopsis.

       This code is derived from similar code in Movable Type.

Method: dirify($string [, $separator])
       Returns a string, which can be used as a directory name.

       The default separator is '_'.

       Each run of spaces in the string is replaced by this separator.

Algorithm
       1: Each high ASCII character is replaced by its normal equivalent
       2: The string is converted to lower case
       3: Any HTML (including HTML entities) in the string is removed
       4: Any characters which are not (Perl) words, spaces or hyphens, are removed
       5: Runs of spaces are converted to the separator character
	   For more details about this character, see the discussion of the dirify() method (above).

Melody 'v' Movable Type
       See http://openmelody.org for details.

Backwards Compatibility with Movable Type
       Unfortunately, Movable Type's usage of dirify() allows a fake separator - '1' - to be used for the second parameter in the call to
       dirify().

       The '1' triggered usage of '_' as the separator, rather than the '1' provided.

       This 'feature' has been preserved in "String::Dirify", but is discouraged. Instead, simply drop the second parameter and let the code
       default to '_'.

Distributions
       This module is available as a Unix-style distro (*.tgz).

       See http://savage.net.au/Perl-modules.html for details.

Authors
       "String::Dirify" started out as part of Movable Type's code.

       Then, Mark Stosberg cut down the original code to provide just the English/ISO/ASCII features.

       Lastly, the code was cleaned up, tests added, and all packaged, by Ron Savage <ron@savage.net.au> in 2009.

       Home page: http://savage.net.au/index.html

       Copyright (c) 2009, Mark Stosberg, Ron Savage.

       Copyright (c) 2010, 2011, Ron Savage.

perl v5.10.1							    2011-01-08						       String::Dirify(3pm)

Check Out this Related Man Page

Class::Meta::Types::String(3pm) 			User Contributed Perl Documentation			   Class::Meta::Types::String(3pm)

NAME

       Class::Meta::Types::String - String data types

SYNOPSIS

	 package MyApp::Thingy;
	 use strict;
	 use Class::Meta;
	 use Class::Meta::Types::String;
	 # OR...
	 # use Class::Meta::Types::String 'affordance';
	 # OR...
	 # use Class::Meta::Types::String 'semi-affordance';

	 BEGIN {
	     # Create a Class::Meta object for this class.
	     my $cm = Class::Meta->new( key => 'thingy' );

	     # Add a string attribute.
	     $cm->add_attribute( name => 'name',
				 type => 'string' );
	     $cm->build;
	 }

DESCRIPTION

       This module provides a string data type for use with Class::Meta attributes.  Simply load it, then pass "string" to the "add_attribute()"
       method of a Class::Meta object to create an attribute of the string data type. See Class::Meta::Type for more information on using and
       creating data types.

SUPPORT

       This module is stored in an open GitHub repository <http://github.com/theory/class-meta/>. Feel free to fork and contribute!

       Please file bug reports via GitHub Issues <http://github.com/theory/class-meta/issues/> or by sending mail to bug-Class-Meta.cpan.org
       <mailto:bug-Class-Meta.cpan.org>.

AUTHOR

       David E. Wheeler <david@justatheory.com>

SEE ALSO

       Other classes of interest within the Class::Meta distribution include:

       Class::Meta
	   This class contains most of the documentation you need to get started with Class::Meta.

       Class::Meta::Type
	   This class manages the creation of data types.

       Class::Meta::Attribute
	   This class manages Class::Meta class attributes, all of which are based on data types.

       Other data type modules:

       Class::Meta::Types::Perl
       Class::Meta::Types::Boolean
       Class::Meta::Types::Numeric

COPYRIGHT AND LICENSE

       Copyright (c) 2002-2011, David E. Wheeler. Some Rights Reserved.

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

perl v5.12.4							    2011-08-06					   Class::Meta::Types::String(3pm)

Linux and UNIX Man Pages

string::dirify(3pm) [debian man page]

Check Out this Related Man Page