perl/charclass/readme.en.html

<!DOCTYPE HTML>
<html lang="en">
<head>
<title>CharClass &mdash; A Perl Regular Expression Character Class 
Library</title>
<link rel=stylesheet href="http://suika.fam.cx/www/style/html/xhtml">
<link rel=license href="#license">
<link rel=author href="http://suika.fam.cx/~wakaba/who?" title="わかば" lang=ja>
<link rel=feed type="application/atom+xml" href=charclass-commit title="CharClass ChangeLog diffs">
</head>
<body>
<h1><i>CharClass</i> &mdash; A Perl Regular Expression Character Class 
Library</h1>

<div class=section id=news>
<h2>What's new?</h2>

<p id=feed>An <a href=charclass-commit rel=feed
type="application/atom+xml">Atom feed for ChangeLog diffs</a> is
available.

<ol>

<li><time>2008-11-24</time> <a
href="#module-char-normalize-fullwidthhalfwidth">A new module for
fullwidth/halfwidth character normalization</a> is added.

<li><time>2008-11-24</time> <a href="#feed">An Atom feed for commit
logs</a> is available.

</ol>

</div>

<div class="section" id="modules">
<h2>Modules</h2>

<p>Modules defining character classes:

<dl>
<dt><a href="lib/Char/Class/Alphabet.html"><code>Char::Class::Alphabet</code></a></dt>
    <dd>Character classes for alphabetical letters.</dd>
<dt><a href="lib/Char/Class/Han.html"><code>Char::Class::Han</code></a></dt>
    <dd>Han character (CJK ideograph) classes.</dd>
<dt><a href="lib/Char/Class/Hiragana.html"><code>Char::Class::Hiragana</code></a></dt>
    <dd>Hiragana classes.</dd>
<dt><a href="lib/Char/Class/JaInput.html"><code>Char::Class::JaInput</code></a></dt>
    <dd>Character classes defined in JIS input method standards.</dd>
<dt><a href="lib/Char/Class/ISOIECTR10176.html"><code>Char::Class::ISOIECTR10176</code></a></dt>
    <dd>ISO/IEC TR 10176 character repertoires.</dd>
<dt><a href="lib/Char/Class/JISX0221.html"><code>Char::Class::JISX0221</code></a></dt>
    <dd>JIS X 0221 character collections.</dd>
<dt><a href="lib/Char/Class/JISX4051.html"><code>Char::Class::JISX4051</code></a></dt>
    <dd>JIS X 4051 character classes.</dd>
<dt><a href="lib/Char/Class/JISX4052.html"><code>Char::Class::JISX4052</code></a></dt>
    <dd>JIS X 4052 character classes.</dd>
<dt><a href="lib/Char/Class/Katakana.html"><code>Char::Class::Katakana</code></a></dt>
    <dd>Katakana classes.</dd>
<dt><a href="lib/Char/Class/Kana.html"><code>Char::Class::Kana</code></a></dt>
    <dd>Kana (hiragana, katakana, and additions) classes.</dd>
<dt><a href="lib/Char/Class/RFC1815.html"><code>Char::Class::RFC1815</code></a></dt>
    <dd><a href="urn:ietf:rfc:1815">RFC 1815</a> character sets.</dd>
<dt><a href="lib/Char/Class/UCS.html"><code>Char::Class::UCS</code></a></dt>
    <dd>UCS (ISO/IEC 10646) character collections.</dd>
<dt><a href="lib/Char/Class/XML.html"><code>Char::Class::XML</code></a></dt>
    <dd>XML-related character classes such as <code>InXML_NameStartChar10</code>
    (XML 1.0 name start characters) and
    <code>InXMLNameChar</code> (XML 1.1 name characters).</dd>
</dl>

<p>A module for normalization:

<dl>

<dt id=module-char-normalize-fullwidthhalfwidth><a
href="lib/Char/Normalize/FullwidthHalfwidth"><code>Char::Normalize::FullwidthHalfwidth</code></a>
(New in 2.0)

<dd>Normalization of ideographic space, fullwidth alphanumeric
characters, and halfwidth Kakatana.

</dl>

</div>

<div class="section" id="install">
<h2>Install</h2>

<ol>
<li>Download the <a href="#download">tarball</a> and extract it.</li>
<li><kbd>perl Makefile.PL</kbd></li>
<li><kbd>make</kbd></li>
<li><kbd>make install</kbd></li>
</ol>

<p>Alternatively, just putting all files in the directory <code>lib</code>
into your directory for Perl modules should work as well.
All Perl modules in this package are written in pure Perl.</p>
</div>

<div class="section" id="example">
<h2>Example</h2>

<div class="fig example">
<pre class="perl"><code>use Char::Class::XML qw/InXML_NameStartChar10 InXMLNameChar10/;

if ($name !~ /\A<strong>\p{InXML_NameStartChar10}</strong><strong>\p{InXMLNameChar10}</strong>*\z/) {
  die "$0: $name: This is not an XML 1.0 Name";
}</code></pre>
</div>
</div>

<div class="section" id="download">
<h2>Distribution</h2>

<ul>
<li><a href="http://suika.fam.cx/www/charclass/release/latest-stable.tar.gz">CharClass Latest Stable Release
(tar + gzip)</a></li>
<li><a href="http://suika.fam.cx/www/charclass/release/charclass-1.0.tar.gz">CharClass Version 1.0, 
<time datetime="2007-07-19">July 19, 2007</time>
(tar + gzip, 244<abbr title="kilooctets">ko</abbr>)</a></li>
</ul>

<p>The development version is available in the 
<a href="http://suika.fam.cx/gate/cvs/perl/charclass/">CVS repository</a>.</p>
</div>

<div class="section" id="todo">
<h2>TODO</h2>

<ul>
<li>Some classes are no longer up-to-date.  Need to update.</li>
<li>Need to improve documentation.</li>
</ul>
</div>

<div class="section" id="license">
<h2>License</h2>

<p>&copy; 2003‐2008 <a href="http://suika.fam.cx/~wakaba/who?"
lang=ja>わかば (Wakaba)</a> <code class="mail">&lt;<a
href="mailto:w@suika.fam.cx">w@suika.fam.cx</a>></code></p>

<p>This library and the library generated by it is free software; you 
can redistribute them and/or modify them under the same terms as Perl itself.</p>
</div>

</body>
</html>
1	<!DOCTYPE HTML>
2	<html lang="en">
3	<head>
4	<title>CharClass — A Perl Regular Expression Character Class
5	Library</title>
6	<link rel=stylesheet href="http://suika.fam.cx/www/style/html/xhtml">
7	<link rel=license href="#license">
8	<link rel=author href="http://suika.fam.cx/~wakaba/who?" title="わかば" lang=ja>
9	<link rel=feed type="application/atom+xml" href=charclass-commit title="CharClass ChangeLog diffs">
10	</head>
11	<body>
12	<h1><i>CharClass</i> — A Perl Regular Expression Character Class
13	Library</h1>
14
15	<div class=section id=news>
16	<h2>What's new?</h2>
17
18	<p id=feed>An <a href=charclass-commit rel=feed
19	type="application/atom+xml">Atom feed for ChangeLog diffs</a> is
20	available.
21
22	<ol>
23
24	<li><time>2008-11-24</time> <a
25	href="#module-char-normalize-fullwidthhalfwidth">A new module for
26	fullwidth/halfwidth character normalization</a> is added.
27
28	<li><time>2008-11-24</time> <a href="#feed">An Atom feed for commit
29	logs</a> is available.
30
31	</ol>
32
33	</div>
34
35	<div class="section" id="modules">
36	<h2>Modules</h2>
37
38	<p>Modules defining character classes:
39
40	<dl>
41	<dt><a href="lib/Char/Class/Alphabet.html"><code>Char::Class::Alphabet</code></a></dt>
42	<dd>Character classes for alphabetical letters.</dd>
43	<dt><a href="lib/Char/Class/Han.html"><code>Char::Class::Han</code></a></dt>
44	<dd>Han character (CJK ideograph) classes.</dd>
45	<dt><a href="lib/Char/Class/Hiragana.html"><code>Char::Class::Hiragana</code></a></dt>
46	<dd>Hiragana classes.</dd>
47	<dt><a href="lib/Char/Class/JaInput.html"><code>Char::Class::JaInput</code></a></dt>
48	<dd>Character classes defined in JIS input method standards.</dd>
49	<dt><a href="lib/Char/Class/ISOIECTR10176.html"><code>Char::Class::ISOIECTR10176</code></a></dt>
50	<dd>ISO/IEC TR 10176 character repertoires.</dd>
51	<dt><a href="lib/Char/Class/JISX0221.html"><code>Char::Class::JISX0221</code></a></dt>
52	<dd>JIS X 0221 character collections.</dd>
53	<dt><a href="lib/Char/Class/JISX4051.html"><code>Char::Class::JISX4051</code></a></dt>
54	<dd>JIS X 4051 character classes.</dd>
55	<dt><a href="lib/Char/Class/JISX4052.html"><code>Char::Class::JISX4052</code></a></dt>
56	<dd>JIS X 4052 character classes.</dd>
57	<dt><a href="lib/Char/Class/Katakana.html"><code>Char::Class::Katakana</code></a></dt>
58	<dd>Katakana classes.</dd>
59	<dt><a href="lib/Char/Class/Kana.html"><code>Char::Class::Kana</code></a></dt>
60	<dd>Kana (hiragana, katakana, and additions) classes.</dd>
61	<dt><a href="lib/Char/Class/RFC1815.html"><code>Char::Class::RFC1815</code></a></dt>
62	<dd><a href="urn:ietf:rfc:1815">RFC 1815</a> character sets.</dd>
63	<dt><a href="lib/Char/Class/UCS.html"><code>Char::Class::UCS</code></a></dt>
64	<dd>UCS (ISO/IEC 10646) character collections.</dd>
65	<dt><a href="lib/Char/Class/XML.html"><code>Char::Class::XML</code></a></dt>
66	<dd>XML-related character classes such as <code>InXML_NameStartChar10</code>
67	(XML 1.0 name start characters) and
68	<code>InXMLNameChar</code> (XML 1.1 name characters).</dd>
69	</dl>
70
71	<p>A module for normalization:
72
73	<dl>
74
75	<dt id=module-char-normalize-fullwidthhalfwidth><a
76	href="lib/Char/Normalize/FullwidthHalfwidth"><code>Char::Normalize::FullwidthHalfwidth</code></a>
77	(New in 2.0)
78
79	<dd>Normalization of ideographic space, fullwidth alphanumeric
80	characters, and halfwidth Kakatana.
81
82	</dl>
83
84	</div>
85
86	<div class="section" id="install">
87	<h2>Install</h2>
88
89	<ol>
90	<li>Download the <a href="#download">tarball</a> and extract it.</li>
91	<li><kbd>perl Makefile.PL</kbd></li>
92	<li><kbd>make</kbd></li>
93	<li><kbd>make install</kbd></li>
94	</ol>
95
96	<p>Alternatively, just putting all files in the directory <code>lib</code>
97	into your directory for Perl modules should work as well.
98	All Perl modules in this package are written in pure Perl.</p>
99	</div>
100
101	<div class="section" id="example">
102	<h2>Example</h2>
103
104	<div class="fig example">
105	<pre class="perl"><code>use Char::Class::XML qw/InXML_NameStartChar10 InXMLNameChar10/;
106
107	if ($name !~ /\A<strong>\p{InXML_NameStartChar10}</strong><strong>\p{InXMLNameChar10}</strong>*\z/) {
108	die "$0: $name: This is not an XML 1.0 Name";
109	}</code></pre>
110	</div>
111	</div>
112
113	<div class="section" id="download">
114	<h2>Distribution</h2>
115
116	<ul>
117	<li><a href="http://suika.fam.cx/www/charclass/release/latest-stable.tar.gz">CharClass Latest Stable Release
118	(tar + gzip)</a></li>
119	<li><a href="http://suika.fam.cx/www/charclass/release/charclass-1.0.tar.gz">CharClass Version 1.0,
120	<time datetime="2007-07-19">July 19, 2007</time>
121	(tar + gzip, 244<abbr title="kilooctets">ko</abbr>)</a></li>
122	</ul>
123
124	<p>The development version is available in the
125	<a href="http://suika.fam.cx/gate/cvs/perl/charclass/">CVS repository</a>.</p>
126	</div>
127
128	<div class="section" id="todo">
129	<h2>TODO</h2>
130
131	<ul>
132	<li>Some classes are no longer up-to-date. Need to update.</li>
133	<li>Need to improve documentation.</li>
134	</ul>
135	</div>
136
137	<div class="section" id="license">
138	<h2>License</h2>
139
140	<p>© 2003‐2008 <a href="http://suika.fam.cx/~wakaba/who?"
141	lang=ja>わかば (Wakaba)</a> <code class="mail"><<a
142	href="mailto:w@suika.fam.cx">w@suika.fam.cx</a>></code></p>
143
144	<p>This library and the library generated by it is free software; you
145	can redistribute them and/or modify them under the same terms as Perl itself.</p>
146	</div>
147
148	</body>
149	</html>