The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

RKITOVER / String-ToIdentifier-EN-0.01 / README 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

              
NAME
    String::ToIdentifier::EN - Convert Strings to English Program
    Identifiers
SYNOPSIS
        use utf8;
        use String::ToIdentifier::EN 'to_identifier';
        to_identifier 'foo-bar';             # fooDashBar
        to_identifier 'foo-bar', '_';        # foo_dash_bar
        to_identifier 'foo.bar', '_';        # foo_dot_bar
        to_identifier "foo\x{4EB0}bar";      # fooJingBar
        to_identifier "foo\x00bar";          # fooNullCharBar
        to_identifier "foo\x00\x00bar";      # foo2NullCharsBar
        to_identifier "foo\x00\x00bar", '_'; # foo_2_null_chars_bar
DESCRIPTION
    This module provides a utility method, "to_identifier" for converting an
    arbitrary string into a readable representation using the ASCII subset
    of "\w" for use as an identifier in a computer program. The intent is to
    make unique identifier names from which the content of the original
    string can be easily inferred by a human just by reading the identifier.
    Currently, this process is one way only, and will likely remain this
    way.
    The default is to create camelCase identifiers, or you may pass in a
    separator char of your choice such as "_".
    Binary char groups will be separated by "_" even in camelCase
    identifiers to make them easier to read, e.g.: "foo_2_0xFF_Bar".
EXPORT
    Optionally exports the "to_identifier" function.
SUBROUTINES
  to_identifier
    Takes the string to be converted to an identifier, and optionally a
    separator char such as "_". If a separator char is not provided, a
    camelCase identifier will be returned.
METHODS
  string_to_identifier
    The class method version of "to_identifier", if you want to use the
    object oriented interface.
SEE ALSO
    String::ToIdentifier::Unicode, Text::Unidecode,
    Lingua::EN::Inflect::Phrase
AUTHOR
    Rafael Kitover, "<rkitover@cpan.org>"
BUGS
    Please report any bugs or feature requests to
    "bug-string-toidentifier-en at rt.cpan.org", or through the web
    interface at
    <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=String-ToIdentifier-EN>.
    I will be notified, and then you'll automatically be notified of
    progress on your bug as I make changes.
SUPPORT
    More information on this module is availableat:
    *   RT: CPAN's request tracker (report bugs here)
        <http://rt.cpan.org/NoAuth/Bugs.html?Dist=String-ToIdentifier-EN>
    *   AnnoCPAN: Annotated CPAN documentation
        <http://annocpan.org/dist/String-ToIdentifier-EN>
    *   CPAN Ratings
        <http://cpanratings.perl.org/d/String-ToIdentifier-EN>
    *   MetaCPAN
        <https://metacpan.org/module/String::ToIdentifier::EN>
    *   Search CPAN
        <http://search.cpan.org/dist/String-ToIdentifier-EN/>
LICENSE AND COPYRIGHT
    Copyright (c) 2011 Rafael Kitover <rkitover@cpan.org>.
    This program is free software; you can redistribute it and/or modify it
    under the terms of either: the GNU General Public License as published
    by the Free Software Foundation; or the Artistic License.
    See http://dev.perl.org/licenses/ for more information.